Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,73 +1,73 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | IPython -- An enhanced Interactive Python |
|
4 | 4 | |
|
5 | 5 | One of Python's nicest features is its interactive interpreter. This allows |
|
6 | 6 | very fast testing of ideas without the overhead of creating test files as is |
|
7 | 7 | typical in most programming languages. However, the interpreter supplied with |
|
8 | 8 | the standard Python distribution is fairly primitive (and IDLE isn't really |
|
9 | 9 | much better). |
|
10 | 10 | |
|
11 | 11 | IPython tries to: |
|
12 | 12 | |
|
13 | 13 | i - provide an efficient environment for interactive work in Python |
|
14 | 14 | programming. It tries to address what we see as shortcomings of the standard |
|
15 | 15 | Python prompt, and adds many features to make interactive work much more |
|
16 | 16 | efficient. |
|
17 | 17 | |
|
18 | 18 | ii - offer a flexible framework so that it can be used as the base |
|
19 | 19 | environment for other projects and problems where Python can be the |
|
20 | 20 | underlying language. Specifically scientific environments like Mathematica, |
|
21 | 21 | IDL and Mathcad inspired its design, but similar ideas can be useful in many |
|
22 | 22 | fields. Python is a fabulous language for implementing this kind of system |
|
23 | 23 | (due to its dynamic and introspective features), and with suitable libraries |
|
24 | 24 | entire systems could be built leveraging Python's power. |
|
25 | 25 | |
|
26 | 26 | iii - serve as an embeddable, ready to go interpreter for your own programs. |
|
27 | 27 | |
|
28 | 28 | IPython requires Python 2.4 or newer. |
|
29 | 29 | """ |
|
30 | 30 | |
|
31 | 31 | #***************************************************************************** |
|
32 | 32 | # Copyright (C) 2008-2009 The IPython Development Team |
|
33 | 33 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
34 | 34 | # |
|
35 | 35 | # Distributed under the terms of the BSD License. The full license is in |
|
36 | 36 | # the file COPYING, distributed as part of this software. |
|
37 | 37 | #***************************************************************************** |
|
38 | 38 | |
|
39 | 39 | # Enforce proper version requirements |
|
40 | 40 | import sys |
|
41 | 41 | |
|
42 | 42 | if sys.version[0:3] < '2.4': |
|
43 | 43 | raise ImportError('Python Version 2.4 or above is required for IPython.') |
|
44 | 44 | |
|
45 | 45 | # Make it easy to import extensions - they are always directly on pythonpath. |
|
46 |
# Therefore, non-IPython modules can be added to |
|
|
46 | # Therefore, non-IPython modules can be added to extensions directory | |
|
47 | 47 | import os |
|
48 |
sys.path.append(os.path.dirname(__file__) |
|
|
48 | sys.path.append(os.path.join(os.path.dirname(__file__), "extensions")) | |
|
49 | 49 | |
|
50 | 50 | # Define what gets imported with a 'from IPython import *' |
|
51 | 51 | __all__ = ['IPython.core.ipapi','utils.generics','utils.ipstruct', |
|
52 | 52 | 'core.release','core.shell'] |
|
53 | 53 | |
|
54 | 54 | # Load __all__ in IPython namespace so that a simple 'import IPython' gives |
|
55 | 55 | # access to them via IPython.<name> |
|
56 | 56 | glob,loc = globals(),locals() |
|
57 | 57 | for name in __all__: |
|
58 | 58 | #print 'Importing: ',name # dbg |
|
59 | 59 | __import__(name,glob,loc,[]) |
|
60 | 60 | |
|
61 | 61 | from IPython.core import shell |
|
62 | 62 | |
|
63 | 63 | # Release data |
|
64 | 64 | from IPython.core import release # do it explicitly so pydoc can see it - pydoc bug |
|
65 | 65 | __author__ = '%s <%s>\n%s <%s>\n%s <%s>' % \ |
|
66 | 66 | ( release.authors['Fernando'] + release.authors['Janko'] + \ |
|
67 | 67 | release.authors['Nathan'] ) |
|
68 | 68 | __license__ = release.license |
|
69 | 69 | __version__ = release.version |
|
70 | 70 | __revision__ = release.revision |
|
71 | 71 | |
|
72 | 72 | # Namespace cleanup |
|
73 | 73 | del name,glob,loc |
@@ -1,114 +1,114 b'' | |||
|
1 | 1 | """ User configuration file for IPython |
|
2 | 2 | |
|
3 | 3 | This is a more flexible and safe way to configure ipython than *rc files |
|
4 | 4 | (ipythonrc, ipythonrc-pysh etc.) |
|
5 | 5 | |
|
6 | 6 | This file is always imported on ipython startup. You can import the |
|
7 |
ipython extensions you need here (see IPython/ |
|
|
7 | ipython extensions you need here (see IPython/extensions directory). | |
|
8 | 8 | |
|
9 | 9 | Feel free to edit this file to customize your ipython experience. |
|
10 | 10 | |
|
11 | 11 | Note that as such this file does nothing, for backwards compatibility. |
|
12 | 12 | Consult e.g. file 'ipy_profile_sh.py' for an example of the things |
|
13 | 13 | you can do here. |
|
14 | 14 | |
|
15 | 15 | See http://ipython.scipy.org/moin/IpythonExtensionApi for detailed |
|
16 | 16 | description on what you could do here. |
|
17 | 17 | """ |
|
18 | 18 | |
|
19 | 19 | # Most of your config files and extensions will probably start with this import |
|
20 | 20 | |
|
21 | 21 | from IPython.core import ipapi |
|
22 | 22 | ip = ipapi.get() |
|
23 | 23 | |
|
24 | 24 | # You probably want to uncomment this if you did %upgrade -nolegacy |
|
25 | 25 | # import ipy_defaults |
|
26 | 26 | |
|
27 | 27 | import os |
|
28 | 28 | |
|
29 | 29 | def main(): |
|
30 | 30 | |
|
31 | 31 | # uncomment if you want to get ipython -p sh behaviour |
|
32 | 32 | # without having to use command line switches |
|
33 | 33 | # import ipy_profile_sh |
|
34 | 34 | |
|
35 | 35 | # Configure your favourite editor? |
|
36 | 36 | # Good idea e.g. for %edit os.path.isfile |
|
37 | 37 | |
|
38 | 38 | #import ipy_editors |
|
39 | 39 | |
|
40 | 40 | # Choose one of these: |
|
41 | 41 | |
|
42 | 42 | #ipy_editors.scite() |
|
43 | 43 | #ipy_editors.scite('c:/opt/scite/scite.exe') |
|
44 | 44 | #ipy_editors.komodo() |
|
45 | 45 | #ipy_editors.idle() |
|
46 | 46 | # ... or many others, try 'ipy_editors??' after import to see them |
|
47 | 47 | |
|
48 | 48 | # Or roll your own: |
|
49 | 49 | #ipy_editors.install_editor("c:/opt/jed +$line $file") |
|
50 | 50 | |
|
51 | 51 | |
|
52 | 52 | o = ip.options |
|
53 | 53 | # An example on how to set options |
|
54 | 54 | #o.autocall = 1 |
|
55 | 55 | o.system_verbose = 0 |
|
56 | 56 | |
|
57 | 57 | #import_all("os sys") |
|
58 | 58 | #execf('~/_ipython/ns.py') |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | # -- prompt |
|
62 | 62 | # A different, more compact set of prompts from the default ones, that |
|
63 | 63 | # always show your current location in the filesystem: |
|
64 | 64 | |
|
65 | 65 | #o.prompt_in1 = r'\C_LightBlue[\C_LightCyan\Y2\C_LightBlue]\C_Normal\n\C_Green|\#>' |
|
66 | 66 | #o.prompt_in2 = r'.\D: ' |
|
67 | 67 | #o.prompt_out = r'[\#] ' |
|
68 | 68 | |
|
69 | 69 | # Try one of these color settings if you can't read the text easily |
|
70 | 70 | # autoexec is a list of IPython commands to execute on startup |
|
71 | 71 | #o.autoexec.append('%colors LightBG') |
|
72 | 72 | #o.autoexec.append('%colors NoColor') |
|
73 | 73 | #o.autoexec.append('%colors Linux') |
|
74 | 74 | |
|
75 | 75 | # for sane integer division that converts to float (1/2 == 0.5) |
|
76 | 76 | #o.autoexec.append('from __future__ import division') |
|
77 | 77 | |
|
78 | 78 | # For %tasks and %kill |
|
79 | 79 | #import jobctrl |
|
80 | 80 | |
|
81 | 81 | # For autoreloading of modules (%autoreload, %aimport) |
|
82 | 82 | #import ipy_autoreload |
|
83 | 83 | |
|
84 | 84 | # For winpdb support (%wdb) |
|
85 | 85 | #import ipy_winpdb |
|
86 | 86 | |
|
87 | 87 | # For bzr completer, requires bzrlib (the python installation of bzr) |
|
88 | 88 | #ip.load('ipy_bzr') |
|
89 | 89 | |
|
90 | 90 | # Tab completer that is not quite so picky (i.e. |
|
91 | 91 | # "foo".<TAB> and str(2).<TAB> will work). Complete |
|
92 | 92 | # at your own risk! |
|
93 | 93 | #import ipy_greedycompleter |
|
94 | 94 | |
|
95 | 95 | # If you are on Linux, you may be annoyed by |
|
96 | 96 | # "Display all N possibilities? (y or n)" on tab completion, |
|
97 | 97 | # as well as the paging through "more". Uncomment the following |
|
98 | 98 | # lines to disable that behaviour |
|
99 | 99 | #import readline |
|
100 | 100 | #readline.parse_and_bind('set completion-query-items 1000') |
|
101 | 101 | #readline.parse_and_bind('set page-completions no') |
|
102 | 102 | |
|
103 | 103 | |
|
104 | 104 | # some config helper functions you can use |
|
105 | 105 | def import_all(modules): |
|
106 | 106 | """ Usage: import_all("os sys") """ |
|
107 | 107 | for m in modules.split(): |
|
108 | 108 | ip.ex("from %s import *" % m) |
|
109 | 109 | |
|
110 | 110 | def execf(fname): |
|
111 | 111 | """ Execute a file in user namespace """ |
|
112 | 112 | ip.ex('execfile("%s")' % os.path.expanduser(fname)) |
|
113 | 113 | |
|
114 | 114 | main() |
@@ -1,45 +1,45 b'' | |||
|
1 | 1 | # -*- Mode: Shell-Script -*- Not really, but shows comments correctly |
|
2 | 2 | #*************************************************************************** |
|
3 | 3 | # |
|
4 | 4 | # Configuration file for ipython -- ipythonrc format |
|
5 | 5 | # |
|
6 | 6 | # The format of this file is one of 'key value' lines. |
|
7 | 7 | # Lines containing only whitespace at the beginning and then a # are ignored |
|
8 | 8 | # as comments. But comments can NOT be put on lines with data. |
|
9 | 9 | #*************************************************************************** |
|
10 | 10 | |
|
11 | 11 | # If this file is found in the user's ~/.ipython directory as |
|
12 | 12 | # ipythonrc-physics, it can be loaded by calling passing the '-profile |
|
13 | 13 | # physics' (or '-p physics') option to IPython. |
|
14 | 14 | |
|
15 | 15 | # This profile loads modules useful for doing interactive calculations with |
|
16 | 16 | # physical quantities (with units). It relies on modules from Konrad Hinsen's |
|
17 | 17 | # ScientificPython (http://dirac.cnrs-orleans.fr/ScientificPython/) |
|
18 | 18 | |
|
19 | 19 | # First load basic user configuration |
|
20 | 20 | include ipythonrc |
|
21 | 21 | |
|
22 | 22 | # import ... |
|
23 | 23 | # Module with alternate input syntax for PhysicalQuantity objects. |
|
24 |
import_mod IPython. |
|
|
24 | import_mod IPython.extensions.PhysicalQInput | |
|
25 | 25 | |
|
26 | 26 | # from ... import * |
|
27 | 27 | # math CANNOT be imported after PhysicalQInteractive. It will override the |
|
28 | 28 | # functions defined there. |
|
29 |
import_all math IPython. |
|
|
29 | import_all math IPython.extensions.PhysicalQInteractive | |
|
30 | 30 | |
|
31 | 31 | # from ... import ... |
|
32 | 32 | import_some |
|
33 | 33 | |
|
34 | 34 | # code |
|
35 | 35 | execute q = PhysicalQuantityInteractive |
|
36 | 36 | execute g = PhysicalQuantityInteractive('9.8 m/s**2') |
|
37 | 37 | ececute rad = pi/180. |
|
38 | 38 | execute print '*** q is an alias for PhysicalQuantityInteractive' |
|
39 | 39 | execute print '*** g = 9.8 m/s^2 has been defined' |
|
40 | 40 | execute print '*** rad = pi/180 has been defined' |
|
41 | 41 | execute import ipy_constants as C |
|
42 | 42 | execute print '*** C is the physical constants module' |
|
43 | 43 | |
|
44 | 44 | # Files to execute |
|
45 | 45 | execfile |
@@ -1,94 +1,94 b'' | |||
|
1 | 1 | # -*- Mode: Shell-Script -*- Not really, but shows comments correctly |
|
2 | 2 | #*************************************************************************** |
|
3 | 3 | # Configuration file for ipython -- ipythonrc format |
|
4 | 4 | # |
|
5 | 5 | # The format of this file is one of 'key value' lines. |
|
6 | 6 | # Lines containing only whitespace at the beginning and then a # are ignored |
|
7 | 7 | # as comments. But comments can NOT be put on lines with data. |
|
8 | 8 | #*************************************************************************** |
|
9 | 9 | |
|
10 | 10 | # If this file is found in the user's ~/.ipython directory as ipythonrc-pysh, |
|
11 | 11 | # it can be loaded by calling passing the '-profile pysh' (or '-p pysh') |
|
12 | 12 | # option to IPython. |
|
13 | 13 | |
|
14 | 14 | # This profile turns IPython into a lightweight system shell with python |
|
15 | 15 | # syntax. |
|
16 | 16 | |
|
17 | 17 | # We only set a few options here, the rest is done in the companion pysh.py |
|
18 | 18 | # file. In the future _all_ of IPython's configuration will be done via |
|
19 | 19 | # proper python code. |
|
20 | 20 | |
|
21 | 21 | ############################################################################ |
|
22 | 22 | # First load common user configuration |
|
23 | 23 | include ipythonrc |
|
24 | 24 | |
|
25 | 25 | ############################################################################ |
|
26 | 26 | # Load all the actual syntax extensions for shell-like operation, which live |
|
27 | 27 | # in the InterpreterExec standard extension. |
|
28 |
import_all IPython. |
|
|
28 | import_all IPython.extensions.InterpreterExec | |
|
29 | 29 | |
|
30 | 30 | ############################################################################ |
|
31 | 31 | # PROMPTS |
|
32 | 32 | # |
|
33 | 33 | # Configure prompt for more shell-like usage. |
|
34 | 34 | |
|
35 | 35 | # Most bash-like escapes can be used to customize IPython's prompts, as well as |
|
36 | 36 | # a few additional ones which are IPython-specific. All valid prompt escapes |
|
37 | 37 | # are described in detail in the Customization section of the IPython HTML/PDF |
|
38 | 38 | # manual. |
|
39 | 39 | |
|
40 | 40 | prompt_in1 '\C_LightGreen\u@\h\C_LightBlue[\C_LightCyan\Y1\C_LightBlue]\C_Green|\#> ' |
|
41 | 41 | prompt_in2 '\C_Green|\C_LightGreen\D\C_Green> ' |
|
42 | 42 | prompt_out '<\#> ' |
|
43 | 43 | |
|
44 | 44 | # Here's a more complex prompt, showing the hostname and more path depth (\Y3) |
|
45 | 45 | #prompt_in1 '\C_LightRed\u\C_Blue@\C_Red\h\C_LightBlue[\C_LightCyan\Y3\C_LightBlue]\C_LightGreen\#> ' |
|
46 | 46 | |
|
47 | 47 | # Select whether to left-pad the output prompts to match the length of the |
|
48 | 48 | # input ones. This allows you for example to use a simple '>' as an output |
|
49 | 49 | # prompt, and yet have the output line up with the input. If set to false, |
|
50 | 50 | # the output prompts will be unpadded (flush left). |
|
51 | 51 | prompts_pad_left 1 |
|
52 | 52 | |
|
53 | 53 | |
|
54 | 54 | # Remove all blank lines in between prompts, like a normal shell. |
|
55 | 55 | separate_in 0 |
|
56 | 56 | separate_out 0 |
|
57 | 57 | separate_out2 0 |
|
58 | 58 | |
|
59 | 59 | # Allow special syntax (!, magics and aliases) in multiline input |
|
60 | 60 | multi_line_specials 1 |
|
61 | 61 | |
|
62 | 62 | ############################################################################ |
|
63 | 63 | # ALIASES |
|
64 | 64 | |
|
65 | 65 | # Declare some common aliases. Type alias? at an ipython prompt for details on |
|
66 | 66 | # the syntax, use @unalias to delete existing aliases. |
|
67 | 67 | |
|
68 | 68 | # Don't go too crazy here, the file pysh.py called below runs @rehash, which |
|
69 | 69 | # loads ALL of your $PATH as aliases (except for Python keywords and |
|
70 | 70 | # builtins). |
|
71 | 71 | |
|
72 | 72 | # Some examples: |
|
73 | 73 | |
|
74 | 74 | # A simple alias without arguments |
|
75 | 75 | #alias cl clear |
|
76 | 76 | |
|
77 | 77 | # An alias which expands the full line before the end of the alias. This |
|
78 | 78 | # lists only directories: |
|
79 | 79 | #alias ldir pwd;ls -oF --color %l | grep /$ |
|
80 | 80 | |
|
81 | 81 | # An alias with two positional arguments: |
|
82 | 82 | #alias parts echo 'First <%s> Second <%s>' |
|
83 | 83 | |
|
84 | 84 | # In use these two aliases give (note that ldir is already built into IPython |
|
85 | 85 | # for Unix): |
|
86 | 86 | |
|
87 | 87 | #fperez[IPython]16> ldir |
|
88 | 88 | #/usr/local/home/fperez/ipython/ipython/IPython |
|
89 | 89 | #drwxr-xr-x 2 fperez 4096 Jun 21 01:01 CVS/ |
|
90 |
#drwxr-xr-x 3 fperez 4096 Jun 21 01:10 |
|
|
90 | #drwxr-xr-x 3 fperez 4096 Jun 21 01:10 extensions/ | |
|
91 | 91 | #drwxr-xr-x 3 fperez 4096 Jun 21 01:27 UserConfig/ |
|
92 | 92 | |
|
93 | 93 | #fperez[IPython]17> parts Hello world and goodbye |
|
94 | 94 | #First <Hello> Second <world> and goodbye |
@@ -1,37 +1,37 b'' | |||
|
1 | 1 | # -*- Mode: Shell-Script -*- Not really, but shows comments correctly |
|
2 | 2 | #*************************************************************************** |
|
3 | 3 | # |
|
4 | 4 | # Configuration file for ipython -- ipythonrc format |
|
5 | 5 | # |
|
6 | 6 | # The format of this file is one of 'key value' lines. |
|
7 | 7 | # Lines containing only whitespace at the beginning and then a # are ignored |
|
8 | 8 | # as comments. But comments can NOT be put on lines with data. |
|
9 | 9 | #*************************************************************************** |
|
10 | 10 | |
|
11 | 11 | # If this file is found in the user's ~/.ipython directory as |
|
12 | 12 | # ipythonrc-tutorial, it can be loaded by calling passing the '-profile |
|
13 | 13 | # tutorial' (or '-p tutorial') option to IPython. |
|
14 | 14 | |
|
15 | 15 | # This profile loads a special input line filter to allow typing lines which |
|
16 | 16 | # begin with '>>> ' or '... '. These two strings, if present at the start of |
|
17 | 17 | # the input line, are stripped. This allows for direct pasting of code from |
|
18 | 18 | # examples such as those available in the standard Python tutorial. |
|
19 | 19 | |
|
20 | 20 | # First load basic user configuration |
|
21 | 21 | include ipythonrc |
|
22 | 22 | |
|
23 | 23 | # import ... |
|
24 | 24 | # Module with alternate input syntax for pasting python input |
|
25 |
import_mod IPython. |
|
|
25 | import_mod IPython.extensions.InterpreterPasteInput | |
|
26 | 26 | |
|
27 | 27 | # from ... import * |
|
28 | 28 | import_all |
|
29 | 29 | |
|
30 | 30 | # from ... import ... |
|
31 | 31 | import_some |
|
32 | 32 | |
|
33 | 33 | # code |
|
34 | 34 | execute |
|
35 | 35 | |
|
36 | 36 | # Files to execute |
|
37 | 37 | execfile |
@@ -1,2865 +1,2865 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | IPython -- An enhanced Interactive Python |
|
4 | 4 | |
|
5 | 5 | Requires Python 2.4 or newer. |
|
6 | 6 | |
|
7 | 7 | This file contains all the classes and helper functions specific to IPython. |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | #***************************************************************************** |
|
11 | 11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
12 | 12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
13 | 13 | # |
|
14 | 14 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | 15 | # the file COPYING, distributed as part of this software. |
|
16 | 16 | # |
|
17 | 17 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
18 | 18 | # Python standard library. Over time, all of that class has been copied |
|
19 | 19 | # verbatim here for modifications which could not be accomplished by |
|
20 | 20 | # subclassing. At this point, there are no dependencies at all on the code |
|
21 | 21 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
22 | 22 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
23 | 23 | # due. |
|
24 | 24 | #***************************************************************************** |
|
25 | 25 | |
|
26 | 26 | #**************************************************************************** |
|
27 | 27 | # Modules and globals |
|
28 | 28 | |
|
29 | 29 | # Python standard modules |
|
30 | 30 | import __main__ |
|
31 | 31 | import __builtin__ |
|
32 | 32 | import StringIO |
|
33 | 33 | import bdb |
|
34 | 34 | import codeop |
|
35 | 35 | import exceptions |
|
36 | 36 | import glob |
|
37 | 37 | import keyword |
|
38 | 38 | import new |
|
39 | 39 | import os |
|
40 | 40 | import re |
|
41 | 41 | import shutil |
|
42 | 42 | import string |
|
43 | 43 | import sys |
|
44 | 44 | import tempfile |
|
45 | 45 | |
|
46 | 46 | # IPython's own modules |
|
47 | 47 | #import IPython |
|
48 | 48 | from IPython.core import ultratb |
|
49 | 49 | from IPython.utils import PyColorize |
|
50 | 50 | from IPython.core import debugger, oinspect |
|
51 |
from IPython. |
|
|
51 | from IPython.extensions import pickleshare | |
|
52 | 52 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
53 | 53 | from IPython.external.Itpl import ItplNS |
|
54 | 54 | from IPython.core.logger import Logger |
|
55 | 55 | from IPython.core.magic import Magic |
|
56 | 56 | from IPython.core.prompts import CachedOutput |
|
57 | 57 | from IPython.utils.ipstruct import Struct |
|
58 | 58 | from IPython.lib.backgroundjobs import BackgroundJobManager |
|
59 | 59 | from IPython.utils.genutils import * |
|
60 | 60 | from IPython.utils.strdispatch import StrDispatch |
|
61 | 61 | from IPython.core import ipapi |
|
62 | 62 | import IPython.core.history |
|
63 | 63 | import IPython.core.prefilter as prefilter |
|
64 | 64 | from IPython.core import shadowns |
|
65 | 65 | # Globals |
|
66 | 66 | |
|
67 | 67 | # store the builtin raw_input globally, and use this always, in case user code |
|
68 | 68 | # overwrites it (like wx.py.PyShell does) |
|
69 | 69 | raw_input_original = raw_input |
|
70 | 70 | |
|
71 | 71 | # compiled regexps for autoindent management |
|
72 | 72 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
73 | 73 | |
|
74 | 74 | |
|
75 | 75 | #**************************************************************************** |
|
76 | 76 | # Some utility function definitions |
|
77 | 77 | |
|
78 | 78 | ini_spaces_re = re.compile(r'^(\s+)') |
|
79 | 79 | |
|
80 | 80 | def num_ini_spaces(strng): |
|
81 | 81 | """Return the number of initial spaces in a string""" |
|
82 | 82 | |
|
83 | 83 | ini_spaces = ini_spaces_re.match(strng) |
|
84 | 84 | if ini_spaces: |
|
85 | 85 | return ini_spaces.end() |
|
86 | 86 | else: |
|
87 | 87 | return 0 |
|
88 | 88 | |
|
89 | 89 | def softspace(file, newvalue): |
|
90 | 90 | """Copied from code.py, to remove the dependency""" |
|
91 | 91 | |
|
92 | 92 | oldvalue = 0 |
|
93 | 93 | try: |
|
94 | 94 | oldvalue = file.softspace |
|
95 | 95 | except AttributeError: |
|
96 | 96 | pass |
|
97 | 97 | try: |
|
98 | 98 | file.softspace = newvalue |
|
99 | 99 | except (AttributeError, TypeError): |
|
100 | 100 | # "attribute-less object" or "read-only attributes" |
|
101 | 101 | pass |
|
102 | 102 | return oldvalue |
|
103 | 103 | |
|
104 | 104 | |
|
105 | 105 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): |
|
106 | 106 | """Install or upgrade the user configuration directory. |
|
107 | 107 | |
|
108 | 108 | Can be called when running for the first time or to upgrade the user's |
|
109 | 109 | .ipython/ directory. |
|
110 | 110 | |
|
111 | 111 | Parameters |
|
112 | 112 | ---------- |
|
113 | 113 | ipythondir : path |
|
114 | 114 | The directory to be used for installation/upgrade. In 'install' mode, |
|
115 | 115 | if this path already exists, the function exits immediately. |
|
116 | 116 | |
|
117 | 117 | rc_suffix : str |
|
118 | 118 | Extension for the config files. On *nix platforms it is typically the |
|
119 | 119 | empty string, while Windows normally uses '.ini'. |
|
120 | 120 | |
|
121 | 121 | mode : str, optional |
|
122 | 122 | Valid modes are 'install' and 'upgrade'. |
|
123 | 123 | |
|
124 | 124 | interactive : bool, optional |
|
125 | 125 | If False, do not wait for user input on any errors. Normally after |
|
126 | 126 | printing its status information, this function waits for the user to |
|
127 | 127 | hit Return before proceeding. This is because the default use case is |
|
128 | 128 | when first installing the IPython configuration, so we want the user to |
|
129 | 129 | acknowledge the initial message, which contains some useful |
|
130 | 130 | information. |
|
131 | 131 | """ |
|
132 | 132 | |
|
133 | 133 | # For automatic use, deactivate all i/o |
|
134 | 134 | if interactive: |
|
135 | 135 | def wait(): |
|
136 | 136 | try: |
|
137 | 137 | raw_input("Please press <RETURN> to start IPython.") |
|
138 | 138 | except EOFError: |
|
139 | 139 | print >> Term.cout |
|
140 | 140 | print '*'*70 |
|
141 | 141 | |
|
142 | 142 | def printf(s): |
|
143 | 143 | print s |
|
144 | 144 | else: |
|
145 | 145 | wait = lambda : None |
|
146 | 146 | printf = lambda s : None |
|
147 | 147 | |
|
148 | 148 | # Install mode should be re-entrant: if the install dir already exists, |
|
149 | 149 | # bail out cleanly. |
|
150 | 150 | # XXX. This is too hasty to return. We need to check to make sure that |
|
151 | 151 | # all the expected config files and directories are actually there. We |
|
152 | 152 | # currently have a failure mode if someone deletes a needed config file |
|
153 | 153 | # but still has the ipythondir. |
|
154 | 154 | if mode == 'install' and os.path.isdir(ipythondir): |
|
155 | 155 | return |
|
156 | 156 | |
|
157 | 157 | cwd = os.getcwd() # remember where we started |
|
158 | 158 | glb = glob.glob |
|
159 | 159 | |
|
160 | 160 | printf('*'*70) |
|
161 | 161 | if mode == 'install': |
|
162 | 162 | printf( |
|
163 | 163 | """Welcome to IPython. I will try to create a personal configuration directory |
|
164 | 164 | where you can customize many aspects of IPython's functionality in:\n""") |
|
165 | 165 | else: |
|
166 | 166 | printf('I am going to upgrade your configuration in:') |
|
167 | 167 | |
|
168 | 168 | printf(ipythondir) |
|
169 | 169 | |
|
170 | 170 | rcdirend = os.path.join('IPython','config','userconfig') |
|
171 | 171 | cfg = lambda d: os.path.join(d,rcdirend) |
|
172 | 172 | try: |
|
173 | 173 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
174 | 174 | printf("Initializing from configuration: %s" % rcdir) |
|
175 | 175 | except IndexError: |
|
176 | 176 | warning = """ |
|
177 | 177 | Installation error. IPython's directory was not found. |
|
178 | 178 | |
|
179 | 179 | Check the following: |
|
180 | 180 | |
|
181 | 181 | The ipython/IPython directory should be in a directory belonging to your |
|
182 | 182 | PYTHONPATH environment variable (that is, it should be in a directory |
|
183 | 183 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
184 | 184 | |
|
185 | 185 | IPython will create a minimal default configuration for you. |
|
186 | 186 | |
|
187 | 187 | """ |
|
188 | 188 | warn(warning) |
|
189 | 189 | wait() |
|
190 | 190 | |
|
191 | 191 | if sys.platform =='win32': |
|
192 | 192 | inif = 'ipythonrc.ini' |
|
193 | 193 | else: |
|
194 | 194 | inif = 'ipythonrc' |
|
195 | 195 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', |
|
196 | 196 | inif : '# intentionally left blank' } |
|
197 | 197 | os.makedirs(ipythondir, mode = 0777) |
|
198 | 198 | for f, cont in minimal_setup.items(): |
|
199 | 199 | # In 2.5, this can be more cleanly done using 'with' |
|
200 | 200 | fobj = file(ipythondir + '/' + f,'w') |
|
201 | 201 | fobj.write(cont) |
|
202 | 202 | fobj.close() |
|
203 | 203 | |
|
204 | 204 | return |
|
205 | 205 | |
|
206 | 206 | if mode == 'install': |
|
207 | 207 | try: |
|
208 | 208 | shutil.copytree(rcdir,ipythondir) |
|
209 | 209 | os.chdir(ipythondir) |
|
210 | 210 | rc_files = glb("ipythonrc*") |
|
211 | 211 | for rc_file in rc_files: |
|
212 | 212 | os.rename(rc_file,rc_file+rc_suffix) |
|
213 | 213 | except: |
|
214 | 214 | warning = """ |
|
215 | 215 | |
|
216 | 216 | There was a problem with the installation: |
|
217 | 217 | %s |
|
218 | 218 | Try to correct it or contact the developers if you think it's a bug. |
|
219 | 219 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
220 | 220 | warn(warning) |
|
221 | 221 | wait() |
|
222 | 222 | return |
|
223 | 223 | |
|
224 | 224 | elif mode == 'upgrade': |
|
225 | 225 | try: |
|
226 | 226 | os.chdir(ipythondir) |
|
227 | 227 | except: |
|
228 | 228 | printf(""" |
|
229 | 229 | Can not upgrade: changing to directory %s failed. Details: |
|
230 | 230 | %s |
|
231 | 231 | """ % (ipythondir,sys.exc_info()[1]) ) |
|
232 | 232 | wait() |
|
233 | 233 | return |
|
234 | 234 | else: |
|
235 | 235 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
236 | 236 | for new_full_path in sources: |
|
237 | 237 | new_filename = os.path.basename(new_full_path) |
|
238 | 238 | if new_filename.startswith('ipythonrc'): |
|
239 | 239 | new_filename = new_filename + rc_suffix |
|
240 | 240 | # The config directory should only contain files, skip any |
|
241 | 241 | # directories which may be there (like CVS) |
|
242 | 242 | if os.path.isdir(new_full_path): |
|
243 | 243 | continue |
|
244 | 244 | if os.path.exists(new_filename): |
|
245 | 245 | old_file = new_filename+'.old' |
|
246 | 246 | if os.path.exists(old_file): |
|
247 | 247 | os.remove(old_file) |
|
248 | 248 | os.rename(new_filename,old_file) |
|
249 | 249 | shutil.copy(new_full_path,new_filename) |
|
250 | 250 | else: |
|
251 | 251 | raise ValueError('unrecognized mode for install: %r' % mode) |
|
252 | 252 | |
|
253 | 253 | # Fix line-endings to those native to each platform in the config |
|
254 | 254 | # directory. |
|
255 | 255 | try: |
|
256 | 256 | os.chdir(ipythondir) |
|
257 | 257 | except: |
|
258 | 258 | printf(""" |
|
259 | 259 | Problem: changing to directory %s failed. |
|
260 | 260 | Details: |
|
261 | 261 | %s |
|
262 | 262 | |
|
263 | 263 | Some configuration files may have incorrect line endings. This should not |
|
264 | 264 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) |
|
265 | 265 | wait() |
|
266 | 266 | else: |
|
267 | 267 | for fname in glb('ipythonrc*'): |
|
268 | 268 | try: |
|
269 | 269 | native_line_ends(fname,backup=0) |
|
270 | 270 | except IOError: |
|
271 | 271 | pass |
|
272 | 272 | |
|
273 | 273 | if mode == 'install': |
|
274 | 274 | printf(""" |
|
275 | 275 | Successful installation! |
|
276 | 276 | |
|
277 | 277 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
278 | 278 | IPython manual (there are both HTML and PDF versions supplied with the |
|
279 | 279 | distribution) to make sure that your system environment is properly configured |
|
280 | 280 | to take advantage of IPython's features. |
|
281 | 281 | |
|
282 | 282 | Important note: the configuration system has changed! The old system is |
|
283 | 283 | still in place, but its setting may be partly overridden by the settings in |
|
284 | 284 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
285 | 285 | if some of the new settings bother you. |
|
286 | 286 | |
|
287 | 287 | """) |
|
288 | 288 | else: |
|
289 | 289 | printf(""" |
|
290 | 290 | Successful upgrade! |
|
291 | 291 | |
|
292 | 292 | All files in your directory: |
|
293 | 293 | %(ipythondir)s |
|
294 | 294 | which would have been overwritten by the upgrade were backed up with a .old |
|
295 | 295 | extension. If you had made particular customizations in those files you may |
|
296 | 296 | want to merge them back into the new files.""" % locals() ) |
|
297 | 297 | wait() |
|
298 | 298 | os.chdir(cwd) |
|
299 | 299 | |
|
300 | 300 | #**************************************************************************** |
|
301 | 301 | # Local use exceptions |
|
302 | 302 | class SpaceInInput(exceptions.Exception): pass |
|
303 | 303 | |
|
304 | 304 | |
|
305 | 305 | #**************************************************************************** |
|
306 | 306 | # Local use classes |
|
307 | 307 | class Bunch: pass |
|
308 | 308 | |
|
309 | 309 | class Undefined: pass |
|
310 | 310 | |
|
311 | 311 | class Quitter(object): |
|
312 | 312 | """Simple class to handle exit, similar to Python 2.5's. |
|
313 | 313 | |
|
314 | 314 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
315 | 315 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
316 | 316 | |
|
317 | 317 | def __init__(self,shell,name): |
|
318 | 318 | self.shell = shell |
|
319 | 319 | self.name = name |
|
320 | 320 | |
|
321 | 321 | def __repr__(self): |
|
322 | 322 | return 'Type %s() to exit.' % self.name |
|
323 | 323 | __str__ = __repr__ |
|
324 | 324 | |
|
325 | 325 | def __call__(self): |
|
326 | 326 | self.shell.exit() |
|
327 | 327 | |
|
328 | 328 | class InputList(list): |
|
329 | 329 | """Class to store user input. |
|
330 | 330 | |
|
331 | 331 | It's basically a list, but slices return a string instead of a list, thus |
|
332 | 332 | allowing things like (assuming 'In' is an instance): |
|
333 | 333 | |
|
334 | 334 | exec In[4:7] |
|
335 | 335 | |
|
336 | 336 | or |
|
337 | 337 | |
|
338 | 338 | exec In[5:9] + In[14] + In[21:25]""" |
|
339 | 339 | |
|
340 | 340 | def __getslice__(self,i,j): |
|
341 | 341 | return ''.join(list.__getslice__(self,i,j)) |
|
342 | 342 | |
|
343 | 343 | class SyntaxTB(ultratb.ListTB): |
|
344 | 344 | """Extension which holds some state: the last exception value""" |
|
345 | 345 | |
|
346 | 346 | def __init__(self,color_scheme = 'NoColor'): |
|
347 | 347 | ultratb.ListTB.__init__(self,color_scheme) |
|
348 | 348 | self.last_syntax_error = None |
|
349 | 349 | |
|
350 | 350 | def __call__(self, etype, value, elist): |
|
351 | 351 | self.last_syntax_error = value |
|
352 | 352 | ultratb.ListTB.__call__(self,etype,value,elist) |
|
353 | 353 | |
|
354 | 354 | def clear_err_state(self): |
|
355 | 355 | """Return the current error state and clear it""" |
|
356 | 356 | e = self.last_syntax_error |
|
357 | 357 | self.last_syntax_error = None |
|
358 | 358 | return e |
|
359 | 359 | |
|
360 | 360 | #**************************************************************************** |
|
361 | 361 | # Main IPython class |
|
362 | 362 | |
|
363 | 363 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
364 | 364 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
365 | 365 | # attributes and methods, but too much user code out there relies on the |
|
366 | 366 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
367 | 367 | # |
|
368 | 368 | # But at least now, all the pieces have been separated and we could, in |
|
369 | 369 | # principle, stop using the mixin. This will ease the transition to the |
|
370 | 370 | # chainsaw branch. |
|
371 | 371 | |
|
372 | 372 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
373 | 373 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
374 | 374 | # class, to prevent clashes. |
|
375 | 375 | |
|
376 | 376 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
377 | 377 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
378 | 378 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
379 | 379 | # 'self.value'] |
|
380 | 380 | |
|
381 | 381 | class InteractiveShell(object,Magic): |
|
382 | 382 | """An enhanced console for Python.""" |
|
383 | 383 | |
|
384 | 384 | # class attribute to indicate whether the class supports threads or not. |
|
385 | 385 | # Subclasses with thread support should override this as needed. |
|
386 | 386 | isthreaded = False |
|
387 | 387 | |
|
388 | 388 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
389 | 389 | user_ns=None,user_global_ns=None,banner2='', |
|
390 | 390 | custom_exceptions=((),None),embedded=False): |
|
391 | 391 | |
|
392 | 392 | # log system |
|
393 | 393 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
394 | 394 | |
|
395 | 395 | # Job manager (for jobs run as background threads) |
|
396 | 396 | self.jobs = BackgroundJobManager() |
|
397 | 397 | |
|
398 | 398 | # Store the actual shell's name |
|
399 | 399 | self.name = name |
|
400 | 400 | self.more = False |
|
401 | 401 | |
|
402 | 402 | # We need to know whether the instance is meant for embedding, since |
|
403 | 403 | # global/local namespaces need to be handled differently in that case |
|
404 | 404 | self.embedded = embedded |
|
405 | 405 | if embedded: |
|
406 | 406 | # Control variable so users can, from within the embedded instance, |
|
407 | 407 | # permanently deactivate it. |
|
408 | 408 | self.embedded_active = True |
|
409 | 409 | |
|
410 | 410 | # command compiler |
|
411 | 411 | self.compile = codeop.CommandCompiler() |
|
412 | 412 | |
|
413 | 413 | # User input buffer |
|
414 | 414 | self.buffer = [] |
|
415 | 415 | |
|
416 | 416 | # Default name given in compilation of code |
|
417 | 417 | self.filename = '<ipython console>' |
|
418 | 418 | |
|
419 | 419 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
420 | 420 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
421 | 421 | __builtin__.exit = Quitter(self,'exit') |
|
422 | 422 | __builtin__.quit = Quitter(self,'quit') |
|
423 | 423 | |
|
424 | 424 | # Make an empty namespace, which extension writers can rely on both |
|
425 | 425 | # existing and NEVER being used by ipython itself. This gives them a |
|
426 | 426 | # convenient location for storing additional information and state |
|
427 | 427 | # their extensions may require, without fear of collisions with other |
|
428 | 428 | # ipython names that may develop later. |
|
429 | 429 | self.meta = Struct() |
|
430 | 430 | |
|
431 | 431 | # Create the namespace where the user will operate. user_ns is |
|
432 | 432 | # normally the only one used, and it is passed to the exec calls as |
|
433 | 433 | # the locals argument. But we do carry a user_global_ns namespace |
|
434 | 434 | # given as the exec 'globals' argument, This is useful in embedding |
|
435 | 435 | # situations where the ipython shell opens in a context where the |
|
436 | 436 | # distinction between locals and globals is meaningful. For |
|
437 | 437 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
438 | 438 | |
|
439 | 439 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
440 | 440 | # level as a dict instead of a module. This is a manual fix, but I |
|
441 | 441 | # should really track down where the problem is coming from. Alex |
|
442 | 442 | # Schmolck reported this problem first. |
|
443 | 443 | |
|
444 | 444 | # A useful post by Alex Martelli on this topic: |
|
445 | 445 | # Re: inconsistent value from __builtins__ |
|
446 | 446 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
447 | 447 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
448 | 448 | # Gruppen: comp.lang.python |
|
449 | 449 | |
|
450 | 450 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
451 | 451 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
452 | 452 | # > <type 'dict'> |
|
453 | 453 | # > >>> print type(__builtins__) |
|
454 | 454 | # > <type 'module'> |
|
455 | 455 | # > Is this difference in return value intentional? |
|
456 | 456 | |
|
457 | 457 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
458 | 458 | # or a module, and it's been that way for a long time. Whether it's |
|
459 | 459 | # intentional (or sensible), I don't know. In any case, the idea is |
|
460 | 460 | # that if you need to access the built-in namespace directly, you |
|
461 | 461 | # should start with "import __builtin__" (note, no 's') which will |
|
462 | 462 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
463 | 463 | |
|
464 | 464 | # These routines return properly built dicts as needed by the rest of |
|
465 | 465 | # the code, and can also be used by extension writers to generate |
|
466 | 466 | # properly initialized namespaces. |
|
467 | 467 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, |
|
468 | 468 | user_global_ns) |
|
469 | 469 | |
|
470 | 470 | # Assign namespaces |
|
471 | 471 | # This is the namespace where all normal user variables live |
|
472 | 472 | self.user_ns = user_ns |
|
473 | 473 | self.user_global_ns = user_global_ns |
|
474 | 474 | |
|
475 | 475 | # An auxiliary namespace that checks what parts of the user_ns were |
|
476 | 476 | # loaded at startup, so we can list later only variables defined in |
|
477 | 477 | # actual interactive use. Since it is always a subset of user_ns, it |
|
478 | 478 | # doesn't need to be seaparately tracked in the ns_table |
|
479 | 479 | self.user_config_ns = {} |
|
480 | 480 | |
|
481 | 481 | # A namespace to keep track of internal data structures to prevent |
|
482 | 482 | # them from cluttering user-visible stuff. Will be updated later |
|
483 | 483 | self.internal_ns = {} |
|
484 | 484 | |
|
485 | 485 | # Namespace of system aliases. Each entry in the alias |
|
486 | 486 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
487 | 487 | # of positional arguments of the alias. |
|
488 | 488 | self.alias_table = {} |
|
489 | 489 | |
|
490 | 490 | # Now that FakeModule produces a real module, we've run into a nasty |
|
491 | 491 | # problem: after script execution (via %run), the module where the user |
|
492 | 492 | # code ran is deleted. Now that this object is a true module (needed |
|
493 | 493 | # so docetst and other tools work correctly), the Python module |
|
494 | 494 | # teardown mechanism runs over it, and sets to None every variable |
|
495 | 495 | # present in that module. Top-level references to objects from the |
|
496 | 496 | # script survive, because the user_ns is updated with them. However, |
|
497 | 497 | # calling functions defined in the script that use other things from |
|
498 | 498 | # the script will fail, because the function's closure had references |
|
499 | 499 | # to the original objects, which are now all None. So we must protect |
|
500 | 500 | # these modules from deletion by keeping a cache. |
|
501 | 501 | # |
|
502 | 502 | # To avoid keeping stale modules around (we only need the one from the |
|
503 | 503 | # last run), we use a dict keyed with the full path to the script, so |
|
504 | 504 | # only the last version of the module is held in the cache. Note, |
|
505 | 505 | # however, that we must cache the module *namespace contents* (their |
|
506 | 506 | # __dict__). Because if we try to cache the actual modules, old ones |
|
507 | 507 | # (uncached) could be destroyed while still holding references (such as |
|
508 | 508 | # those held by GUI objects that tend to be long-lived)> |
|
509 | 509 | # |
|
510 | 510 | # The %reset command will flush this cache. See the cache_main_mod() |
|
511 | 511 | # and clear_main_mod_cache() methods for details on use. |
|
512 | 512 | |
|
513 | 513 | # This is the cache used for 'main' namespaces |
|
514 | 514 | self._main_ns_cache = {} |
|
515 | 515 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
516 | 516 | # copying and clearing for reuse on each %run |
|
517 | 517 | self._user_main_module = FakeModule() |
|
518 | 518 | |
|
519 | 519 | # A table holding all the namespaces IPython deals with, so that |
|
520 | 520 | # introspection facilities can search easily. |
|
521 | 521 | self.ns_table = {'user':user_ns, |
|
522 | 522 | 'user_global':user_global_ns, |
|
523 | 523 | 'alias':self.alias_table, |
|
524 | 524 | 'internal':self.internal_ns, |
|
525 | 525 | 'builtin':__builtin__.__dict__ |
|
526 | 526 | } |
|
527 | 527 | |
|
528 | 528 | # Similarly, track all namespaces where references can be held and that |
|
529 | 529 | # we can safely clear (so it can NOT include builtin). This one can be |
|
530 | 530 | # a simple list. |
|
531 | 531 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, |
|
532 | 532 | self.alias_table, self.internal_ns, |
|
533 | 533 | self._main_ns_cache ] |
|
534 | 534 | |
|
535 | 535 | # We need to insert into sys.modules something that looks like a |
|
536 | 536 | # module but which accesses the IPython namespace, for shelve and |
|
537 | 537 | # pickle to work interactively. Normally they rely on getting |
|
538 | 538 | # everything out of __main__, but for embedding purposes each IPython |
|
539 | 539 | # instance has its own private namespace, so we can't go shoving |
|
540 | 540 | # everything into __main__. |
|
541 | 541 | |
|
542 | 542 | # note, however, that we should only do this for non-embedded |
|
543 | 543 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
544 | 544 | # namespace. Embedded instances, on the other hand, should not do |
|
545 | 545 | # this because they need to manage the user local/global namespaces |
|
546 | 546 | # only, but they live within a 'normal' __main__ (meaning, they |
|
547 | 547 | # shouldn't overtake the execution environment of the script they're |
|
548 | 548 | # embedded in). |
|
549 | 549 | |
|
550 | 550 | if not embedded: |
|
551 | 551 | try: |
|
552 | 552 | main_name = self.user_ns['__name__'] |
|
553 | 553 | except KeyError: |
|
554 | 554 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
555 | 555 | else: |
|
556 | 556 | #print "pickle hack in place" # dbg |
|
557 | 557 | #print 'main_name:',main_name # dbg |
|
558 | 558 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
559 | 559 | |
|
560 | 560 | # List of input with multi-line handling. |
|
561 | 561 | self.input_hist = InputList() |
|
562 | 562 | # This one will hold the 'raw' input history, without any |
|
563 | 563 | # pre-processing. This will allow users to retrieve the input just as |
|
564 | 564 | # it was exactly typed in by the user, with %hist -r. |
|
565 | 565 | self.input_hist_raw = InputList() |
|
566 | 566 | |
|
567 | 567 | # list of visited directories |
|
568 | 568 | try: |
|
569 | 569 | self.dir_hist = [os.getcwd()] |
|
570 | 570 | except OSError: |
|
571 | 571 | self.dir_hist = [] |
|
572 | 572 | |
|
573 | 573 | # dict of output history |
|
574 | 574 | self.output_hist = {} |
|
575 | 575 | |
|
576 | 576 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
577 | 577 | # under Win32 have it set to None, and we need to have a known valid |
|
578 | 578 | # encoding to use in the raw_input() method |
|
579 | 579 | try: |
|
580 | 580 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
581 | 581 | except AttributeError: |
|
582 | 582 | self.stdin_encoding = 'ascii' |
|
583 | 583 | |
|
584 | 584 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
585 | 585 | no_alias = {} |
|
586 | 586 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
587 | 587 | for key in keyword.kwlist + no_alias_magics: |
|
588 | 588 | no_alias[key] = 1 |
|
589 | 589 | no_alias.update(__builtin__.__dict__) |
|
590 | 590 | self.no_alias = no_alias |
|
591 | 591 | |
|
592 | 592 | # Object variable to store code object waiting execution. This is |
|
593 | 593 | # used mainly by the multithreaded shells, but it can come in handy in |
|
594 | 594 | # other situations. No need to use a Queue here, since it's a single |
|
595 | 595 | # item which gets cleared once run. |
|
596 | 596 | self.code_to_run = None |
|
597 | 597 | |
|
598 | 598 | # escapes for automatic behavior on the command line |
|
599 | 599 | self.ESC_SHELL = '!' |
|
600 | 600 | self.ESC_SH_CAP = '!!' |
|
601 | 601 | self.ESC_HELP = '?' |
|
602 | 602 | self.ESC_MAGIC = '%' |
|
603 | 603 | self.ESC_QUOTE = ',' |
|
604 | 604 | self.ESC_QUOTE2 = ';' |
|
605 | 605 | self.ESC_PAREN = '/' |
|
606 | 606 | |
|
607 | 607 | # And their associated handlers |
|
608 | 608 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
609 | 609 | self.ESC_QUOTE : self.handle_auto, |
|
610 | 610 | self.ESC_QUOTE2 : self.handle_auto, |
|
611 | 611 | self.ESC_MAGIC : self.handle_magic, |
|
612 | 612 | self.ESC_HELP : self.handle_help, |
|
613 | 613 | self.ESC_SHELL : self.handle_shell_escape, |
|
614 | 614 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
615 | 615 | } |
|
616 | 616 | |
|
617 | 617 | # class initializations |
|
618 | 618 | Magic.__init__(self,self) |
|
619 | 619 | |
|
620 | 620 | # Python source parser/formatter for syntax highlighting |
|
621 | 621 | pyformat = PyColorize.Parser().format |
|
622 | 622 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
623 | 623 | |
|
624 | 624 | # hooks holds pointers used for user-side customizations |
|
625 | 625 | self.hooks = Struct() |
|
626 | 626 | |
|
627 | 627 | self.strdispatchers = {} |
|
628 | 628 | |
|
629 | 629 | # Set all default hooks, defined in the IPython.hooks module. |
|
630 | 630 | import IPython.core.hooks |
|
631 | 631 | hooks = IPython.core.hooks |
|
632 | 632 | for hook_name in hooks.__all__: |
|
633 | 633 | # default hooks have priority 100, i.e. low; user hooks should have |
|
634 | 634 | # 0-100 priority |
|
635 | 635 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
636 | 636 | #print "bound hook",hook_name |
|
637 | 637 | |
|
638 | 638 | # Flag to mark unconditional exit |
|
639 | 639 | self.exit_now = False |
|
640 | 640 | |
|
641 | 641 | self.usage_min = """\ |
|
642 | 642 | An enhanced console for Python. |
|
643 | 643 | Some of its features are: |
|
644 | 644 | - Readline support if the readline library is present. |
|
645 | 645 | - Tab completion in the local namespace. |
|
646 | 646 | - Logging of input, see command-line options. |
|
647 | 647 | - System shell escape via ! , eg !ls. |
|
648 | 648 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
649 | 649 | - Keeps track of locally defined variables via %who, %whos. |
|
650 | 650 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
651 | 651 | """ |
|
652 | 652 | if usage: self.usage = usage |
|
653 | 653 | else: self.usage = self.usage_min |
|
654 | 654 | |
|
655 | 655 | # Storage |
|
656 | 656 | self.rc = rc # This will hold all configuration information |
|
657 | 657 | self.pager = 'less' |
|
658 | 658 | # temporary files used for various purposes. Deleted at exit. |
|
659 | 659 | self.tempfiles = [] |
|
660 | 660 | |
|
661 | 661 | # Keep track of readline usage (later set by init_readline) |
|
662 | 662 | self.has_readline = False |
|
663 | 663 | |
|
664 | 664 | # template for logfile headers. It gets resolved at runtime by the |
|
665 | 665 | # logstart method. |
|
666 | 666 | self.loghead_tpl = \ |
|
667 | 667 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
668 | 668 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
669 | 669 | #log# opts = %s |
|
670 | 670 | #log# args = %s |
|
671 | 671 | #log# It is safe to make manual edits below here. |
|
672 | 672 | #log#----------------------------------------------------------------------- |
|
673 | 673 | """ |
|
674 | 674 | # for pushd/popd management |
|
675 | 675 | try: |
|
676 | 676 | self.home_dir = get_home_dir() |
|
677 | 677 | except HomeDirError,msg: |
|
678 | 678 | fatal(msg) |
|
679 | 679 | |
|
680 | 680 | self.dir_stack = [] |
|
681 | 681 | |
|
682 | 682 | # Functions to call the underlying shell. |
|
683 | 683 | |
|
684 | 684 | # The first is similar to os.system, but it doesn't return a value, |
|
685 | 685 | # and it allows interpolation of variables in the user's namespace. |
|
686 | 686 | self.system = lambda cmd: \ |
|
687 | 687 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) |
|
688 | 688 | |
|
689 | 689 | # These are for getoutput and getoutputerror: |
|
690 | 690 | self.getoutput = lambda cmd: \ |
|
691 | 691 | getoutput(self.var_expand(cmd,depth=2), |
|
692 | 692 | header=self.rc.system_header, |
|
693 | 693 | verbose=self.rc.system_verbose) |
|
694 | 694 | |
|
695 | 695 | self.getoutputerror = lambda cmd: \ |
|
696 | 696 | getoutputerror(self.var_expand(cmd,depth=2), |
|
697 | 697 | header=self.rc.system_header, |
|
698 | 698 | verbose=self.rc.system_verbose) |
|
699 | 699 | |
|
700 | 700 | |
|
701 | 701 | # keep track of where we started running (mainly for crash post-mortem) |
|
702 | 702 | self.starting_dir = os.getcwd() |
|
703 | 703 | |
|
704 | 704 | # Various switches which can be set |
|
705 | 705 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
706 | 706 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
707 | 707 | self.banner2 = banner2 |
|
708 | 708 | |
|
709 | 709 | # TraceBack handlers: |
|
710 | 710 | |
|
711 | 711 | # Syntax error handler. |
|
712 | 712 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
713 | 713 | |
|
714 | 714 | # The interactive one is initialized with an offset, meaning we always |
|
715 | 715 | # want to remove the topmost item in the traceback, which is our own |
|
716 | 716 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
717 | 717 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
718 | 718 | color_scheme='NoColor', |
|
719 | 719 | tb_offset = 1) |
|
720 | 720 | |
|
721 | 721 | # IPython itself shouldn't crash. This will produce a detailed |
|
722 | 722 | # post-mortem if it does. But we only install the crash handler for |
|
723 | 723 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
724 | 724 | # and lose the crash handler. This is because exceptions in the main |
|
725 | 725 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
726 | 726 | # and there's no point in printing crash dumps for every user exception. |
|
727 | 727 | if self.isthreaded: |
|
728 | 728 | ipCrashHandler = ultratb.FormattedTB() |
|
729 | 729 | else: |
|
730 | 730 | from IPython.core import crashhandler |
|
731 | 731 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) |
|
732 | 732 | self.set_crash_handler(ipCrashHandler) |
|
733 | 733 | |
|
734 | 734 | # and add any custom exception handlers the user may have specified |
|
735 | 735 | self.set_custom_exc(*custom_exceptions) |
|
736 | 736 | |
|
737 | 737 | # indentation management |
|
738 | 738 | self.autoindent = False |
|
739 | 739 | self.indent_current_nsp = 0 |
|
740 | 740 | |
|
741 | 741 | # Make some aliases automatically |
|
742 | 742 | # Prepare list of shell aliases to auto-define |
|
743 | 743 | if os.name == 'posix': |
|
744 | 744 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
745 | 745 | 'mv mv -i','rm rm -i','cp cp -i', |
|
746 | 746 | 'cat cat','less less','clear clear', |
|
747 | 747 | # a better ls |
|
748 | 748 | 'ls ls -F', |
|
749 | 749 | # long ls |
|
750 | 750 | 'll ls -lF') |
|
751 | 751 | # Extra ls aliases with color, which need special treatment on BSD |
|
752 | 752 | # variants |
|
753 | 753 | ls_extra = ( # color ls |
|
754 | 754 | 'lc ls -F -o --color', |
|
755 | 755 | # ls normal files only |
|
756 | 756 | 'lf ls -F -o --color %l | grep ^-', |
|
757 | 757 | # ls symbolic links |
|
758 | 758 | 'lk ls -F -o --color %l | grep ^l', |
|
759 | 759 | # directories or links to directories, |
|
760 | 760 | 'ldir ls -F -o --color %l | grep /$', |
|
761 | 761 | # things which are executable |
|
762 | 762 | 'lx ls -F -o --color %l | grep ^-..x', |
|
763 | 763 | ) |
|
764 | 764 | # The BSDs don't ship GNU ls, so they don't understand the |
|
765 | 765 | # --color switch out of the box |
|
766 | 766 | if 'bsd' in sys.platform: |
|
767 | 767 | ls_extra = ( # ls normal files only |
|
768 | 768 | 'lf ls -lF | grep ^-', |
|
769 | 769 | # ls symbolic links |
|
770 | 770 | 'lk ls -lF | grep ^l', |
|
771 | 771 | # directories or links to directories, |
|
772 | 772 | 'ldir ls -lF | grep /$', |
|
773 | 773 | # things which are executable |
|
774 | 774 | 'lx ls -lF | grep ^-..x', |
|
775 | 775 | ) |
|
776 | 776 | auto_alias = auto_alias + ls_extra |
|
777 | 777 | elif os.name in ['nt','dos']: |
|
778 | 778 | auto_alias = ('ls dir /on', |
|
779 | 779 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
780 | 780 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
781 | 781 | 'ren ren','cls cls','copy copy') |
|
782 | 782 | else: |
|
783 | 783 | auto_alias = () |
|
784 | 784 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
785 | 785 | |
|
786 | 786 | # Produce a public API instance |
|
787 | 787 | self.api = ipapi.IPApi(self) |
|
788 | 788 | |
|
789 | 789 | # Initialize all user-visible namespaces |
|
790 | 790 | self.init_namespaces() |
|
791 | 791 | |
|
792 | 792 | # Call the actual (public) initializer |
|
793 | 793 | self.init_auto_alias() |
|
794 | 794 | |
|
795 | 795 | # track which builtins we add, so we can clean up later |
|
796 | 796 | self.builtins_added = {} |
|
797 | 797 | # This method will add the necessary builtins for operation, but |
|
798 | 798 | # tracking what it did via the builtins_added dict. |
|
799 | 799 | |
|
800 | 800 | #TODO: remove this, redundant |
|
801 | 801 | self.add_builtins() |
|
802 | 802 | # end __init__ |
|
803 | 803 | |
|
804 | 804 | def var_expand(self,cmd,depth=0): |
|
805 | 805 | """Expand python variables in a string. |
|
806 | 806 | |
|
807 | 807 | The depth argument indicates how many frames above the caller should |
|
808 | 808 | be walked to look for the local namespace where to expand variables. |
|
809 | 809 | |
|
810 | 810 | The global namespace for expansion is always the user's interactive |
|
811 | 811 | namespace. |
|
812 | 812 | """ |
|
813 | 813 | |
|
814 | 814 | return str(ItplNS(cmd, |
|
815 | 815 | self.user_ns, # globals |
|
816 | 816 | # Skip our own frame in searching for locals: |
|
817 | 817 | sys._getframe(depth+1).f_locals # locals |
|
818 | 818 | )) |
|
819 | 819 | |
|
820 | 820 | def pre_config_initialization(self): |
|
821 | 821 | """Pre-configuration init method |
|
822 | 822 | |
|
823 | 823 | This is called before the configuration files are processed to |
|
824 | 824 | prepare the services the config files might need. |
|
825 | 825 | |
|
826 | 826 | self.rc already has reasonable default values at this point. |
|
827 | 827 | """ |
|
828 | 828 | rc = self.rc |
|
829 | 829 | try: |
|
830 | 830 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
831 | 831 | except exceptions.UnicodeDecodeError: |
|
832 | 832 | print "Your ipythondir can't be decoded to unicode!" |
|
833 | 833 | print "Please set HOME environment variable to something that" |
|
834 | 834 | print r"only has ASCII characters, e.g. c:\home" |
|
835 | 835 | print "Now it is",rc.ipythondir |
|
836 | 836 | sys.exit() |
|
837 | 837 | self.shadowhist = IPython.core.history.ShadowHist(self.db) |
|
838 | 838 | |
|
839 | 839 | def post_config_initialization(self): |
|
840 | 840 | """Post configuration init method |
|
841 | 841 | |
|
842 | 842 | This is called after the configuration files have been processed to |
|
843 | 843 | 'finalize' the initialization.""" |
|
844 | 844 | |
|
845 | 845 | rc = self.rc |
|
846 | 846 | |
|
847 | 847 | # Object inspector |
|
848 | 848 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
849 | 849 | PyColorize.ANSICodeColors, |
|
850 | 850 | 'NoColor', |
|
851 | 851 | rc.object_info_string_level) |
|
852 | 852 | |
|
853 | 853 | self.rl_next_input = None |
|
854 | 854 | self.rl_do_indent = False |
|
855 | 855 | # Load readline proper |
|
856 | 856 | if rc.readline: |
|
857 | 857 | self.init_readline() |
|
858 | 858 | |
|
859 | 859 | # local shortcut, this is used a LOT |
|
860 | 860 | self.log = self.logger.log |
|
861 | 861 | |
|
862 | 862 | # Initialize cache, set in/out prompts and printing system |
|
863 | 863 | self.outputcache = CachedOutput(self, |
|
864 | 864 | rc.cache_size, |
|
865 | 865 | rc.pprint, |
|
866 | 866 | input_sep = rc.separate_in, |
|
867 | 867 | output_sep = rc.separate_out, |
|
868 | 868 | output_sep2 = rc.separate_out2, |
|
869 | 869 | ps1 = rc.prompt_in1, |
|
870 | 870 | ps2 = rc.prompt_in2, |
|
871 | 871 | ps_out = rc.prompt_out, |
|
872 | 872 | pad_left = rc.prompts_pad_left) |
|
873 | 873 | |
|
874 | 874 | # user may have over-ridden the default print hook: |
|
875 | 875 | try: |
|
876 | 876 | self.outputcache.__class__.display = self.hooks.display |
|
877 | 877 | except AttributeError: |
|
878 | 878 | pass |
|
879 | 879 | |
|
880 | 880 | # I don't like assigning globally to sys, because it means when |
|
881 | 881 | # embedding instances, each embedded instance overrides the previous |
|
882 | 882 | # choice. But sys.displayhook seems to be called internally by exec, |
|
883 | 883 | # so I don't see a way around it. We first save the original and then |
|
884 | 884 | # overwrite it. |
|
885 | 885 | self.sys_displayhook = sys.displayhook |
|
886 | 886 | sys.displayhook = self.outputcache |
|
887 | 887 | |
|
888 | 888 | # Do a proper resetting of doctest, including the necessary displayhook |
|
889 | 889 | # monkeypatching |
|
890 | 890 | try: |
|
891 | 891 | doctest_reload() |
|
892 | 892 | except ImportError: |
|
893 | 893 | warn("doctest module does not exist.") |
|
894 | 894 | |
|
895 | 895 | # Set user colors (don't do it in the constructor above so that it |
|
896 | 896 | # doesn't crash if colors option is invalid) |
|
897 | 897 | self.magic_colors(rc.colors) |
|
898 | 898 | |
|
899 | 899 | # Set calling of pdb on exceptions |
|
900 | 900 | self.call_pdb = rc.pdb |
|
901 | 901 | |
|
902 | 902 | # Load user aliases |
|
903 | 903 | for alias in rc.alias: |
|
904 | 904 | self.magic_alias(alias) |
|
905 | 905 | |
|
906 | 906 | self.hooks.late_startup_hook() |
|
907 | 907 | |
|
908 | 908 | for cmd in self.rc.autoexec: |
|
909 | 909 | #print "autoexec>",cmd #dbg |
|
910 | 910 | self.api.runlines(cmd) |
|
911 | 911 | |
|
912 | 912 | batchrun = False |
|
913 | 913 | for batchfile in [path(arg) for arg in self.rc.args |
|
914 | 914 | if arg.lower().endswith('.ipy')]: |
|
915 | 915 | if not batchfile.isfile(): |
|
916 | 916 | print "No such batch file:", batchfile |
|
917 | 917 | continue |
|
918 | 918 | self.api.runlines(batchfile.text()) |
|
919 | 919 | batchrun = True |
|
920 | 920 | # without -i option, exit after running the batch file |
|
921 | 921 | if batchrun and not self.rc.interact: |
|
922 | 922 | self.ask_exit() |
|
923 | 923 | |
|
924 | 924 | def init_namespaces(self): |
|
925 | 925 | """Initialize all user-visible namespaces to their minimum defaults. |
|
926 | 926 | |
|
927 | 927 | Certain history lists are also initialized here, as they effectively |
|
928 | 928 | act as user namespaces. |
|
929 | 929 | |
|
930 | 930 | Note |
|
931 | 931 | ---- |
|
932 | 932 | All data structures here are only filled in, they are NOT reset by this |
|
933 | 933 | method. If they were not empty before, data will simply be added to |
|
934 | 934 | therm. |
|
935 | 935 | """ |
|
936 | 936 | # The user namespace MUST have a pointer to the shell itself. |
|
937 | 937 | self.user_ns[self.name] = self |
|
938 | 938 | |
|
939 | 939 | # Store the public api instance |
|
940 | 940 | self.user_ns['_ip'] = self.api |
|
941 | 941 | |
|
942 | 942 | # make global variables for user access to the histories |
|
943 | 943 | self.user_ns['_ih'] = self.input_hist |
|
944 | 944 | self.user_ns['_oh'] = self.output_hist |
|
945 | 945 | self.user_ns['_dh'] = self.dir_hist |
|
946 | 946 | |
|
947 | 947 | # user aliases to input and output histories |
|
948 | 948 | self.user_ns['In'] = self.input_hist |
|
949 | 949 | self.user_ns['Out'] = self.output_hist |
|
950 | 950 | |
|
951 | 951 | self.user_ns['_sh'] = shadowns |
|
952 | 952 | |
|
953 | 953 | # Fill the history zero entry, user counter starts at 1 |
|
954 | 954 | self.input_hist.append('\n') |
|
955 | 955 | self.input_hist_raw.append('\n') |
|
956 | 956 | |
|
957 | 957 | def add_builtins(self): |
|
958 | 958 | """Store ipython references into the builtin namespace. |
|
959 | 959 | |
|
960 | 960 | Some parts of ipython operate via builtins injected here, which hold a |
|
961 | 961 | reference to IPython itself.""" |
|
962 | 962 | |
|
963 | 963 | # TODO: deprecate all of these, they are unsafe |
|
964 | 964 | builtins_new = dict(__IPYTHON__ = self, |
|
965 | 965 | ip_set_hook = self.set_hook, |
|
966 | 966 | jobs = self.jobs, |
|
967 | 967 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
968 | 968 | ipalias = wrap_deprecated(self.ipalias), |
|
969 | 969 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
970 | 970 | #_ip = self.api |
|
971 | 971 | ) |
|
972 | 972 | for biname,bival in builtins_new.items(): |
|
973 | 973 | try: |
|
974 | 974 | # store the orignal value so we can restore it |
|
975 | 975 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
976 | 976 | except KeyError: |
|
977 | 977 | # or mark that it wasn't defined, and we'll just delete it at |
|
978 | 978 | # cleanup |
|
979 | 979 | self.builtins_added[biname] = Undefined |
|
980 | 980 | __builtin__.__dict__[biname] = bival |
|
981 | 981 | |
|
982 | 982 | # Keep in the builtins a flag for when IPython is active. We set it |
|
983 | 983 | # with setdefault so that multiple nested IPythons don't clobber one |
|
984 | 984 | # another. Each will increase its value by one upon being activated, |
|
985 | 985 | # which also gives us a way to determine the nesting level. |
|
986 | 986 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
987 | 987 | |
|
988 | 988 | def clean_builtins(self): |
|
989 | 989 | """Remove any builtins which might have been added by add_builtins, or |
|
990 | 990 | restore overwritten ones to their previous values.""" |
|
991 | 991 | for biname,bival in self.builtins_added.items(): |
|
992 | 992 | if bival is Undefined: |
|
993 | 993 | del __builtin__.__dict__[biname] |
|
994 | 994 | else: |
|
995 | 995 | __builtin__.__dict__[biname] = bival |
|
996 | 996 | self.builtins_added.clear() |
|
997 | 997 | |
|
998 | 998 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
999 | 999 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1000 | 1000 | |
|
1001 | 1001 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1002 | 1002 | adding your function to one of these hooks, you can modify IPython's |
|
1003 | 1003 | behavior to call at runtime your own routines.""" |
|
1004 | 1004 | |
|
1005 | 1005 | # At some point in the future, this should validate the hook before it |
|
1006 | 1006 | # accepts it. Probably at least check that the hook takes the number |
|
1007 | 1007 | # of args it's supposed to. |
|
1008 | 1008 | |
|
1009 | 1009 | f = new.instancemethod(hook,self,self.__class__) |
|
1010 | 1010 | |
|
1011 | 1011 | # check if the hook is for strdispatcher first |
|
1012 | 1012 | if str_key is not None: |
|
1013 | 1013 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1014 | 1014 | sdp.add_s(str_key, f, priority ) |
|
1015 | 1015 | self.strdispatchers[name] = sdp |
|
1016 | 1016 | return |
|
1017 | 1017 | if re_key is not None: |
|
1018 | 1018 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1019 | 1019 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1020 | 1020 | self.strdispatchers[name] = sdp |
|
1021 | 1021 | return |
|
1022 | 1022 | |
|
1023 | 1023 | dp = getattr(self.hooks, name, None) |
|
1024 | 1024 | if name not in IPython.core.hooks.__all__: |
|
1025 | 1025 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) |
|
1026 | 1026 | if not dp: |
|
1027 | 1027 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1028 | 1028 | |
|
1029 | 1029 | try: |
|
1030 | 1030 | dp.add(f,priority) |
|
1031 | 1031 | except AttributeError: |
|
1032 | 1032 | # it was not commandchain, plain old func - replace |
|
1033 | 1033 | dp = f |
|
1034 | 1034 | |
|
1035 | 1035 | setattr(self.hooks,name, dp) |
|
1036 | 1036 | |
|
1037 | 1037 | |
|
1038 | 1038 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
1039 | 1039 | |
|
1040 | 1040 | def set_crash_handler(self,crashHandler): |
|
1041 | 1041 | """Set the IPython crash handler. |
|
1042 | 1042 | |
|
1043 | 1043 | This must be a callable with a signature suitable for use as |
|
1044 | 1044 | sys.excepthook.""" |
|
1045 | 1045 | |
|
1046 | 1046 | # Install the given crash handler as the Python exception hook |
|
1047 | 1047 | sys.excepthook = crashHandler |
|
1048 | 1048 | |
|
1049 | 1049 | # The instance will store a pointer to this, so that runtime code |
|
1050 | 1050 | # (such as magics) can access it. This is because during the |
|
1051 | 1051 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
1052 | 1052 | # frameworks). |
|
1053 | 1053 | self.sys_excepthook = sys.excepthook |
|
1054 | 1054 | |
|
1055 | 1055 | |
|
1056 | 1056 | def set_custom_exc(self,exc_tuple,handler): |
|
1057 | 1057 | """set_custom_exc(exc_tuple,handler) |
|
1058 | 1058 | |
|
1059 | 1059 | Set a custom exception handler, which will be called if any of the |
|
1060 | 1060 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1061 | 1061 | runcode() method. |
|
1062 | 1062 | |
|
1063 | 1063 | Inputs: |
|
1064 | 1064 | |
|
1065 | 1065 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1066 | 1066 | handler for. It is very important that you use a tuple, and NOT A |
|
1067 | 1067 | LIST here, because of the way Python's except statement works. If |
|
1068 | 1068 | you only want to trap a single exception, use a singleton tuple: |
|
1069 | 1069 | |
|
1070 | 1070 | exc_tuple == (MyCustomException,) |
|
1071 | 1071 | |
|
1072 | 1072 | - handler: this must be defined as a function with the following |
|
1073 | 1073 | basic interface: def my_handler(self,etype,value,tb). |
|
1074 | 1074 | |
|
1075 | 1075 | This will be made into an instance method (via new.instancemethod) |
|
1076 | 1076 | of IPython itself, and it will be called if any of the exceptions |
|
1077 | 1077 | listed in the exc_tuple are caught. If the handler is None, an |
|
1078 | 1078 | internal basic one is used, which just prints basic info. |
|
1079 | 1079 | |
|
1080 | 1080 | WARNING: by putting in your own exception handler into IPython's main |
|
1081 | 1081 | execution loop, you run a very good chance of nasty crashes. This |
|
1082 | 1082 | facility should only be used if you really know what you are doing.""" |
|
1083 | 1083 | |
|
1084 | 1084 | assert type(exc_tuple)==type(()) , \ |
|
1085 | 1085 | "The custom exceptions must be given AS A TUPLE." |
|
1086 | 1086 | |
|
1087 | 1087 | def dummy_handler(self,etype,value,tb): |
|
1088 | 1088 | print '*** Simple custom exception handler ***' |
|
1089 | 1089 | print 'Exception type :',etype |
|
1090 | 1090 | print 'Exception value:',value |
|
1091 | 1091 | print 'Traceback :',tb |
|
1092 | 1092 | print 'Source code :','\n'.join(self.buffer) |
|
1093 | 1093 | |
|
1094 | 1094 | if handler is None: handler = dummy_handler |
|
1095 | 1095 | |
|
1096 | 1096 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
1097 | 1097 | self.custom_exceptions = exc_tuple |
|
1098 | 1098 | |
|
1099 | 1099 | def set_custom_completer(self,completer,pos=0): |
|
1100 | 1100 | """set_custom_completer(completer,pos=0) |
|
1101 | 1101 | |
|
1102 | 1102 | Adds a new custom completer function. |
|
1103 | 1103 | |
|
1104 | 1104 | The position argument (defaults to 0) is the index in the completers |
|
1105 | 1105 | list where you want the completer to be inserted.""" |
|
1106 | 1106 | |
|
1107 | 1107 | newcomp = new.instancemethod(completer,self.Completer, |
|
1108 | 1108 | self.Completer.__class__) |
|
1109 | 1109 | self.Completer.matchers.insert(pos,newcomp) |
|
1110 | 1110 | |
|
1111 | 1111 | def set_completer(self): |
|
1112 | 1112 | """reset readline's completer to be our own.""" |
|
1113 | 1113 | self.readline.set_completer(self.Completer.complete) |
|
1114 | 1114 | |
|
1115 | 1115 | def _get_call_pdb(self): |
|
1116 | 1116 | return self._call_pdb |
|
1117 | 1117 | |
|
1118 | 1118 | def _set_call_pdb(self,val): |
|
1119 | 1119 | |
|
1120 | 1120 | if val not in (0,1,False,True): |
|
1121 | 1121 | raise ValueError,'new call_pdb value must be boolean' |
|
1122 | 1122 | |
|
1123 | 1123 | # store value in instance |
|
1124 | 1124 | self._call_pdb = val |
|
1125 | 1125 | |
|
1126 | 1126 | # notify the actual exception handlers |
|
1127 | 1127 | self.InteractiveTB.call_pdb = val |
|
1128 | 1128 | if self.isthreaded: |
|
1129 | 1129 | try: |
|
1130 | 1130 | self.sys_excepthook.call_pdb = val |
|
1131 | 1131 | except: |
|
1132 | 1132 | warn('Failed to activate pdb for threaded exception handler') |
|
1133 | 1133 | |
|
1134 | 1134 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1135 | 1135 | 'Control auto-activation of pdb at exceptions') |
|
1136 | 1136 | |
|
1137 | 1137 | # These special functions get installed in the builtin namespace, to |
|
1138 | 1138 | # provide programmatic (pure python) access to magics, aliases and system |
|
1139 | 1139 | # calls. This is important for logging, user scripting, and more. |
|
1140 | 1140 | |
|
1141 | 1141 | # We are basically exposing, via normal python functions, the three |
|
1142 | 1142 | # mechanisms in which ipython offers special call modes (magics for |
|
1143 | 1143 | # internal control, aliases for direct system access via pre-selected |
|
1144 | 1144 | # names, and !cmd for calling arbitrary system commands). |
|
1145 | 1145 | |
|
1146 | 1146 | def ipmagic(self,arg_s): |
|
1147 | 1147 | """Call a magic function by name. |
|
1148 | 1148 | |
|
1149 | 1149 | Input: a string containing the name of the magic function to call and any |
|
1150 | 1150 | additional arguments to be passed to the magic. |
|
1151 | 1151 | |
|
1152 | 1152 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
1153 | 1153 | prompt: |
|
1154 | 1154 | |
|
1155 | 1155 | In[1]: %name -opt foo bar |
|
1156 | 1156 | |
|
1157 | 1157 | To call a magic without arguments, simply use ipmagic('name'). |
|
1158 | 1158 | |
|
1159 | 1159 | This provides a proper Python function to call IPython's magics in any |
|
1160 | 1160 | valid Python code you can type at the interpreter, including loops and |
|
1161 | 1161 | compound statements. It is added by IPython to the Python builtin |
|
1162 | 1162 | namespace upon initialization.""" |
|
1163 | 1163 | |
|
1164 | 1164 | args = arg_s.split(' ',1) |
|
1165 | 1165 | magic_name = args[0] |
|
1166 | 1166 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
1167 | 1167 | |
|
1168 | 1168 | try: |
|
1169 | 1169 | magic_args = args[1] |
|
1170 | 1170 | except IndexError: |
|
1171 | 1171 | magic_args = '' |
|
1172 | 1172 | fn = getattr(self,'magic_'+magic_name,None) |
|
1173 | 1173 | if fn is None: |
|
1174 | 1174 | error("Magic function `%s` not found." % magic_name) |
|
1175 | 1175 | else: |
|
1176 | 1176 | magic_args = self.var_expand(magic_args,1) |
|
1177 | 1177 | return fn(magic_args) |
|
1178 | 1178 | |
|
1179 | 1179 | def ipalias(self,arg_s): |
|
1180 | 1180 | """Call an alias by name. |
|
1181 | 1181 | |
|
1182 | 1182 | Input: a string containing the name of the alias to call and any |
|
1183 | 1183 | additional arguments to be passed to the magic. |
|
1184 | 1184 | |
|
1185 | 1185 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
1186 | 1186 | prompt: |
|
1187 | 1187 | |
|
1188 | 1188 | In[1]: name -opt foo bar |
|
1189 | 1189 | |
|
1190 | 1190 | To call an alias without arguments, simply use ipalias('name'). |
|
1191 | 1191 | |
|
1192 | 1192 | This provides a proper Python function to call IPython's aliases in any |
|
1193 | 1193 | valid Python code you can type at the interpreter, including loops and |
|
1194 | 1194 | compound statements. It is added by IPython to the Python builtin |
|
1195 | 1195 | namespace upon initialization.""" |
|
1196 | 1196 | |
|
1197 | 1197 | args = arg_s.split(' ',1) |
|
1198 | 1198 | alias_name = args[0] |
|
1199 | 1199 | try: |
|
1200 | 1200 | alias_args = args[1] |
|
1201 | 1201 | except IndexError: |
|
1202 | 1202 | alias_args = '' |
|
1203 | 1203 | if alias_name in self.alias_table: |
|
1204 | 1204 | self.call_alias(alias_name,alias_args) |
|
1205 | 1205 | else: |
|
1206 | 1206 | error("Alias `%s` not found." % alias_name) |
|
1207 | 1207 | |
|
1208 | 1208 | def ipsystem(self,arg_s): |
|
1209 | 1209 | """Make a system call, using IPython.""" |
|
1210 | 1210 | |
|
1211 | 1211 | self.system(arg_s) |
|
1212 | 1212 | |
|
1213 | 1213 | def complete(self,text): |
|
1214 | 1214 | """Return a sorted list of all possible completions on text. |
|
1215 | 1215 | |
|
1216 | 1216 | Inputs: |
|
1217 | 1217 | |
|
1218 | 1218 | - text: a string of text to be completed on. |
|
1219 | 1219 | |
|
1220 | 1220 | This is a wrapper around the completion mechanism, similar to what |
|
1221 | 1221 | readline does at the command line when the TAB key is hit. By |
|
1222 | 1222 | exposing it as a method, it can be used by other non-readline |
|
1223 | 1223 | environments (such as GUIs) for text completion. |
|
1224 | 1224 | |
|
1225 | 1225 | Simple usage example: |
|
1226 | 1226 | |
|
1227 | 1227 | In [7]: x = 'hello' |
|
1228 | 1228 | |
|
1229 | 1229 | In [8]: x |
|
1230 | 1230 | Out[8]: 'hello' |
|
1231 | 1231 | |
|
1232 | 1232 | In [9]: print x |
|
1233 | 1233 | hello |
|
1234 | 1234 | |
|
1235 | 1235 | In [10]: _ip.IP.complete('x.l') |
|
1236 | 1236 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1237 | 1237 | """ |
|
1238 | 1238 | |
|
1239 | 1239 | complete = self.Completer.complete |
|
1240 | 1240 | state = 0 |
|
1241 | 1241 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1242 | 1242 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1243 | 1243 | # start using sets instead, which are faster. |
|
1244 | 1244 | comps = {} |
|
1245 | 1245 | while True: |
|
1246 | 1246 | newcomp = complete(text,state,line_buffer=text) |
|
1247 | 1247 | if newcomp is None: |
|
1248 | 1248 | break |
|
1249 | 1249 | comps[newcomp] = 1 |
|
1250 | 1250 | state += 1 |
|
1251 | 1251 | outcomps = comps.keys() |
|
1252 | 1252 | outcomps.sort() |
|
1253 | 1253 | #print "T:",text,"OC:",outcomps # dbg |
|
1254 | 1254 | #print "vars:",self.user_ns.keys() |
|
1255 | 1255 | return outcomps |
|
1256 | 1256 | |
|
1257 | 1257 | def set_completer_frame(self, frame=None): |
|
1258 | 1258 | if frame: |
|
1259 | 1259 | self.Completer.namespace = frame.f_locals |
|
1260 | 1260 | self.Completer.global_namespace = frame.f_globals |
|
1261 | 1261 | else: |
|
1262 | 1262 | self.Completer.namespace = self.user_ns |
|
1263 | 1263 | self.Completer.global_namespace = self.user_global_ns |
|
1264 | 1264 | |
|
1265 | 1265 | def init_auto_alias(self): |
|
1266 | 1266 | """Define some aliases automatically. |
|
1267 | 1267 | |
|
1268 | 1268 | These are ALL parameter-less aliases""" |
|
1269 | 1269 | |
|
1270 | 1270 | for alias,cmd in self.auto_alias: |
|
1271 | 1271 | self.getapi().defalias(alias,cmd) |
|
1272 | 1272 | |
|
1273 | 1273 | |
|
1274 | 1274 | def alias_table_validate(self,verbose=0): |
|
1275 | 1275 | """Update information about the alias table. |
|
1276 | 1276 | |
|
1277 | 1277 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1278 | 1278 | |
|
1279 | 1279 | no_alias = self.no_alias |
|
1280 | 1280 | for k in self.alias_table.keys(): |
|
1281 | 1281 | if k in no_alias: |
|
1282 | 1282 | del self.alias_table[k] |
|
1283 | 1283 | if verbose: |
|
1284 | 1284 | print ("Deleting alias <%s>, it's a Python " |
|
1285 | 1285 | "keyword or builtin." % k) |
|
1286 | 1286 | |
|
1287 | 1287 | def set_autoindent(self,value=None): |
|
1288 | 1288 | """Set the autoindent flag, checking for readline support. |
|
1289 | 1289 | |
|
1290 | 1290 | If called with no arguments, it acts as a toggle.""" |
|
1291 | 1291 | |
|
1292 | 1292 | if not self.has_readline: |
|
1293 | 1293 | if os.name == 'posix': |
|
1294 | 1294 | warn("The auto-indent feature requires the readline library") |
|
1295 | 1295 | self.autoindent = 0 |
|
1296 | 1296 | return |
|
1297 | 1297 | if value is None: |
|
1298 | 1298 | self.autoindent = not self.autoindent |
|
1299 | 1299 | else: |
|
1300 | 1300 | self.autoindent = value |
|
1301 | 1301 | |
|
1302 | 1302 | def rc_set_toggle(self,rc_field,value=None): |
|
1303 | 1303 | """Set or toggle a field in IPython's rc config. structure. |
|
1304 | 1304 | |
|
1305 | 1305 | If called with no arguments, it acts as a toggle. |
|
1306 | 1306 | |
|
1307 | 1307 | If called with a non-existent field, the resulting AttributeError |
|
1308 | 1308 | exception will propagate out.""" |
|
1309 | 1309 | |
|
1310 | 1310 | rc_val = getattr(self.rc,rc_field) |
|
1311 | 1311 | if value is None: |
|
1312 | 1312 | value = not rc_val |
|
1313 | 1313 | setattr(self.rc,rc_field,value) |
|
1314 | 1314 | |
|
1315 | 1315 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1316 | 1316 | """Install the user configuration directory. |
|
1317 | 1317 | |
|
1318 | 1318 | Note |
|
1319 | 1319 | ---- |
|
1320 | 1320 | DEPRECATED: use the top-level user_setup() function instead. |
|
1321 | 1321 | """ |
|
1322 | 1322 | return user_setup(ipythondir,rc_suffix,mode) |
|
1323 | 1323 | |
|
1324 | 1324 | def atexit_operations(self): |
|
1325 | 1325 | """This will be executed at the time of exit. |
|
1326 | 1326 | |
|
1327 | 1327 | Saving of persistent data should be performed here. """ |
|
1328 | 1328 | |
|
1329 | 1329 | #print '*** IPython exit cleanup ***' # dbg |
|
1330 | 1330 | # input history |
|
1331 | 1331 | self.savehist() |
|
1332 | 1332 | |
|
1333 | 1333 | # Cleanup all tempfiles left around |
|
1334 | 1334 | for tfile in self.tempfiles: |
|
1335 | 1335 | try: |
|
1336 | 1336 | os.unlink(tfile) |
|
1337 | 1337 | except OSError: |
|
1338 | 1338 | pass |
|
1339 | 1339 | |
|
1340 | 1340 | # Clear all user namespaces to release all references cleanly. |
|
1341 | 1341 | self.reset() |
|
1342 | 1342 | |
|
1343 | 1343 | # Run user hooks |
|
1344 | 1344 | self.hooks.shutdown_hook() |
|
1345 | 1345 | |
|
1346 | 1346 | def reset(self): |
|
1347 | 1347 | """Clear all internal namespaces. |
|
1348 | 1348 | |
|
1349 | 1349 | Note that this is much more aggressive than %reset, since it clears |
|
1350 | 1350 | fully all namespaces, as well as all input/output lists. |
|
1351 | 1351 | """ |
|
1352 | 1352 | for ns in self.ns_refs_table: |
|
1353 | 1353 | ns.clear() |
|
1354 | 1354 | |
|
1355 | 1355 | # Clear input and output histories |
|
1356 | 1356 | self.input_hist[:] = [] |
|
1357 | 1357 | self.input_hist_raw[:] = [] |
|
1358 | 1358 | self.output_hist.clear() |
|
1359 | 1359 | # Restore the user namespaces to minimal usability |
|
1360 | 1360 | self.init_namespaces() |
|
1361 | 1361 | |
|
1362 | 1362 | def savehist(self): |
|
1363 | 1363 | """Save input history to a file (via readline library).""" |
|
1364 | 1364 | |
|
1365 | 1365 | if not self.has_readline: |
|
1366 | 1366 | return |
|
1367 | 1367 | |
|
1368 | 1368 | try: |
|
1369 | 1369 | self.readline.write_history_file(self.histfile) |
|
1370 | 1370 | except: |
|
1371 | 1371 | print 'Unable to save IPython command history to file: ' + \ |
|
1372 | 1372 | `self.histfile` |
|
1373 | 1373 | |
|
1374 | 1374 | def reloadhist(self): |
|
1375 | 1375 | """Reload the input history from disk file.""" |
|
1376 | 1376 | |
|
1377 | 1377 | if self.has_readline: |
|
1378 | 1378 | try: |
|
1379 | 1379 | self.readline.clear_history() |
|
1380 | 1380 | self.readline.read_history_file(self.shell.histfile) |
|
1381 | 1381 | except AttributeError: |
|
1382 | 1382 | pass |
|
1383 | 1383 | |
|
1384 | 1384 | |
|
1385 | 1385 | def history_saving_wrapper(self, func): |
|
1386 | 1386 | """ Wrap func for readline history saving |
|
1387 | 1387 | |
|
1388 | 1388 | Convert func into callable that saves & restores |
|
1389 | 1389 | history around the call """ |
|
1390 | 1390 | |
|
1391 | 1391 | if not self.has_readline: |
|
1392 | 1392 | return func |
|
1393 | 1393 | |
|
1394 | 1394 | def wrapper(): |
|
1395 | 1395 | self.savehist() |
|
1396 | 1396 | try: |
|
1397 | 1397 | func() |
|
1398 | 1398 | finally: |
|
1399 | 1399 | readline.read_history_file(self.histfile) |
|
1400 | 1400 | return wrapper |
|
1401 | 1401 | |
|
1402 | 1402 | def pre_readline(self): |
|
1403 | 1403 | """readline hook to be used at the start of each line. |
|
1404 | 1404 | |
|
1405 | 1405 | Currently it handles auto-indent only.""" |
|
1406 | 1406 | |
|
1407 | 1407 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1408 | 1408 | |
|
1409 | 1409 | if self.rl_do_indent: |
|
1410 | 1410 | self.readline.insert_text(self.indent_current_str()) |
|
1411 | 1411 | if self.rl_next_input is not None: |
|
1412 | 1412 | self.readline.insert_text(self.rl_next_input) |
|
1413 | 1413 | self.rl_next_input = None |
|
1414 | 1414 | |
|
1415 | 1415 | def init_readline(self): |
|
1416 | 1416 | """Command history completion/saving/reloading.""" |
|
1417 | 1417 | |
|
1418 | 1418 | |
|
1419 | 1419 | import IPython.utils.rlineimpl as readline |
|
1420 | 1420 | |
|
1421 | 1421 | if not readline.have_readline: |
|
1422 | 1422 | self.has_readline = 0 |
|
1423 | 1423 | self.readline = None |
|
1424 | 1424 | # no point in bugging windows users with this every time: |
|
1425 | 1425 | warn('Readline services not available on this platform.') |
|
1426 | 1426 | else: |
|
1427 | 1427 | sys.modules['readline'] = readline |
|
1428 | 1428 | import atexit |
|
1429 | 1429 | from IPython.core.completer import IPCompleter |
|
1430 | 1430 | self.Completer = IPCompleter(self, |
|
1431 | 1431 | self.user_ns, |
|
1432 | 1432 | self.user_global_ns, |
|
1433 | 1433 | self.rc.readline_omit__names, |
|
1434 | 1434 | self.alias_table) |
|
1435 | 1435 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1436 | 1436 | self.strdispatchers['complete_command'] = sdisp |
|
1437 | 1437 | self.Completer.custom_completers = sdisp |
|
1438 | 1438 | # Platform-specific configuration |
|
1439 | 1439 | if os.name == 'nt': |
|
1440 | 1440 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1441 | 1441 | else: |
|
1442 | 1442 | self.readline_startup_hook = readline.set_startup_hook |
|
1443 | 1443 | |
|
1444 | 1444 | # Load user's initrc file (readline config) |
|
1445 | 1445 | # Or if libedit is used, load editrc. |
|
1446 | 1446 | inputrc_name = os.environ.get('INPUTRC') |
|
1447 | 1447 | if inputrc_name is None: |
|
1448 | 1448 | home_dir = get_home_dir() |
|
1449 | 1449 | if home_dir is not None: |
|
1450 | 1450 | inputrc_name = '.inputrc' |
|
1451 | 1451 | if readline.uses_libedit: |
|
1452 | 1452 | inputrc_name = '.editrc' |
|
1453 | 1453 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1454 | 1454 | if os.path.isfile(inputrc_name): |
|
1455 | 1455 | try: |
|
1456 | 1456 | readline.read_init_file(inputrc_name) |
|
1457 | 1457 | except: |
|
1458 | 1458 | warn('Problems reading readline initialization file <%s>' |
|
1459 | 1459 | % inputrc_name) |
|
1460 | 1460 | |
|
1461 | 1461 | self.has_readline = 1 |
|
1462 | 1462 | self.readline = readline |
|
1463 | 1463 | # save this in sys so embedded copies can restore it properly |
|
1464 | 1464 | sys.ipcompleter = self.Completer.complete |
|
1465 | 1465 | self.set_completer() |
|
1466 | 1466 | |
|
1467 | 1467 | # Configure readline according to user's prefs |
|
1468 | 1468 | # This is only done if GNU readline is being used. If libedit |
|
1469 | 1469 | # is being used (as on Leopard) the readline config is |
|
1470 | 1470 | # not run as the syntax for libedit is different. |
|
1471 | 1471 | if not readline.uses_libedit: |
|
1472 | 1472 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1473 | 1473 | #print "loading rl:",rlcommand # dbg |
|
1474 | 1474 | readline.parse_and_bind(rlcommand) |
|
1475 | 1475 | |
|
1476 | 1476 | # Remove some chars from the delimiters list. If we encounter |
|
1477 | 1477 | # unicode chars, discard them. |
|
1478 | 1478 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1479 | 1479 | delims = delims.translate(string._idmap, |
|
1480 | 1480 | self.rc.readline_remove_delims) |
|
1481 | 1481 | readline.set_completer_delims(delims) |
|
1482 | 1482 | # otherwise we end up with a monster history after a while: |
|
1483 | 1483 | readline.set_history_length(1000) |
|
1484 | 1484 | try: |
|
1485 | 1485 | #print '*** Reading readline history' # dbg |
|
1486 | 1486 | readline.read_history_file(self.histfile) |
|
1487 | 1487 | except IOError: |
|
1488 | 1488 | pass # It doesn't exist yet. |
|
1489 | 1489 | |
|
1490 | 1490 | atexit.register(self.atexit_operations) |
|
1491 | 1491 | del atexit |
|
1492 | 1492 | |
|
1493 | 1493 | # Configure auto-indent for all platforms |
|
1494 | 1494 | self.set_autoindent(self.rc.autoindent) |
|
1495 | 1495 | |
|
1496 | 1496 | def ask_yes_no(self,prompt,default=True): |
|
1497 | 1497 | if self.rc.quiet: |
|
1498 | 1498 | return True |
|
1499 | 1499 | return ask_yes_no(prompt,default) |
|
1500 | 1500 | |
|
1501 | 1501 | def new_main_mod(self,ns=None): |
|
1502 | 1502 | """Return a new 'main' module object for user code execution. |
|
1503 | 1503 | """ |
|
1504 | 1504 | main_mod = self._user_main_module |
|
1505 | 1505 | init_fakemod_dict(main_mod,ns) |
|
1506 | 1506 | return main_mod |
|
1507 | 1507 | |
|
1508 | 1508 | def cache_main_mod(self,ns,fname): |
|
1509 | 1509 | """Cache a main module's namespace. |
|
1510 | 1510 | |
|
1511 | 1511 | When scripts are executed via %run, we must keep a reference to the |
|
1512 | 1512 | namespace of their __main__ module (a FakeModule instance) around so |
|
1513 | 1513 | that Python doesn't clear it, rendering objects defined therein |
|
1514 | 1514 | useless. |
|
1515 | 1515 | |
|
1516 | 1516 | This method keeps said reference in a private dict, keyed by the |
|
1517 | 1517 | absolute path of the module object (which corresponds to the script |
|
1518 | 1518 | path). This way, for multiple executions of the same script we only |
|
1519 | 1519 | keep one copy of the namespace (the last one), thus preventing memory |
|
1520 | 1520 | leaks from old references while allowing the objects from the last |
|
1521 | 1521 | execution to be accessible. |
|
1522 | 1522 | |
|
1523 | 1523 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
1524 | 1524 | because of how Python tears down modules (it hard-sets all their |
|
1525 | 1525 | references to None without regard for reference counts). This method |
|
1526 | 1526 | must therefore make a *copy* of the given namespace, to allow the |
|
1527 | 1527 | original module's __dict__ to be cleared and reused. |
|
1528 | 1528 | |
|
1529 | 1529 | |
|
1530 | 1530 | Parameters |
|
1531 | 1531 | ---------- |
|
1532 | 1532 | ns : a namespace (a dict, typically) |
|
1533 | 1533 | |
|
1534 | 1534 | fname : str |
|
1535 | 1535 | Filename associated with the namespace. |
|
1536 | 1536 | |
|
1537 | 1537 | Examples |
|
1538 | 1538 | -------- |
|
1539 | 1539 | |
|
1540 | 1540 | In [10]: import IPython |
|
1541 | 1541 | |
|
1542 | 1542 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1543 | 1543 | |
|
1544 | 1544 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache |
|
1545 | 1545 | Out[12]: True |
|
1546 | 1546 | """ |
|
1547 | 1547 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
1548 | 1548 | |
|
1549 | 1549 | def clear_main_mod_cache(self): |
|
1550 | 1550 | """Clear the cache of main modules. |
|
1551 | 1551 | |
|
1552 | 1552 | Mainly for use by utilities like %reset. |
|
1553 | 1553 | |
|
1554 | 1554 | Examples |
|
1555 | 1555 | -------- |
|
1556 | 1556 | |
|
1557 | 1557 | In [15]: import IPython |
|
1558 | 1558 | |
|
1559 | 1559 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1560 | 1560 | |
|
1561 | 1561 | In [17]: len(_ip.IP._main_ns_cache) > 0 |
|
1562 | 1562 | Out[17]: True |
|
1563 | 1563 | |
|
1564 | 1564 | In [18]: _ip.IP.clear_main_mod_cache() |
|
1565 | 1565 | |
|
1566 | 1566 | In [19]: len(_ip.IP._main_ns_cache) == 0 |
|
1567 | 1567 | Out[19]: True |
|
1568 | 1568 | """ |
|
1569 | 1569 | self._main_ns_cache.clear() |
|
1570 | 1570 | |
|
1571 | 1571 | def _should_recompile(self,e): |
|
1572 | 1572 | """Utility routine for edit_syntax_error""" |
|
1573 | 1573 | |
|
1574 | 1574 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1575 | 1575 | '<console>','<BackgroundJob compilation>', |
|
1576 | 1576 | None): |
|
1577 | 1577 | |
|
1578 | 1578 | return False |
|
1579 | 1579 | try: |
|
1580 | 1580 | if (self.rc.autoedit_syntax and |
|
1581 | 1581 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1582 | 1582 | '[Y/n] ','y')): |
|
1583 | 1583 | return False |
|
1584 | 1584 | except EOFError: |
|
1585 | 1585 | return False |
|
1586 | 1586 | |
|
1587 | 1587 | def int0(x): |
|
1588 | 1588 | try: |
|
1589 | 1589 | return int(x) |
|
1590 | 1590 | except TypeError: |
|
1591 | 1591 | return 0 |
|
1592 | 1592 | # always pass integer line and offset values to editor hook |
|
1593 | 1593 | try: |
|
1594 | 1594 | self.hooks.fix_error_editor(e.filename, |
|
1595 | 1595 | int0(e.lineno),int0(e.offset),e.msg) |
|
1596 | 1596 | except ipapi.TryNext: |
|
1597 | 1597 | warn('Could not open editor') |
|
1598 | 1598 | return False |
|
1599 | 1599 | return True |
|
1600 | 1600 | |
|
1601 | 1601 | def edit_syntax_error(self): |
|
1602 | 1602 | """The bottom half of the syntax error handler called in the main loop. |
|
1603 | 1603 | |
|
1604 | 1604 | Loop until syntax error is fixed or user cancels. |
|
1605 | 1605 | """ |
|
1606 | 1606 | |
|
1607 | 1607 | while self.SyntaxTB.last_syntax_error: |
|
1608 | 1608 | # copy and clear last_syntax_error |
|
1609 | 1609 | err = self.SyntaxTB.clear_err_state() |
|
1610 | 1610 | if not self._should_recompile(err): |
|
1611 | 1611 | return |
|
1612 | 1612 | try: |
|
1613 | 1613 | # may set last_syntax_error again if a SyntaxError is raised |
|
1614 | 1614 | self.safe_execfile(err.filename,self.user_ns) |
|
1615 | 1615 | except: |
|
1616 | 1616 | self.showtraceback() |
|
1617 | 1617 | else: |
|
1618 | 1618 | try: |
|
1619 | 1619 | f = file(err.filename) |
|
1620 | 1620 | try: |
|
1621 | 1621 | sys.displayhook(f.read()) |
|
1622 | 1622 | finally: |
|
1623 | 1623 | f.close() |
|
1624 | 1624 | except: |
|
1625 | 1625 | self.showtraceback() |
|
1626 | 1626 | |
|
1627 | 1627 | def showsyntaxerror(self, filename=None): |
|
1628 | 1628 | """Display the syntax error that just occurred. |
|
1629 | 1629 | |
|
1630 | 1630 | This doesn't display a stack trace because there isn't one. |
|
1631 | 1631 | |
|
1632 | 1632 | If a filename is given, it is stuffed in the exception instead |
|
1633 | 1633 | of what was there before (because Python's parser always uses |
|
1634 | 1634 | "<string>" when reading from a string). |
|
1635 | 1635 | """ |
|
1636 | 1636 | etype, value, last_traceback = sys.exc_info() |
|
1637 | 1637 | |
|
1638 | 1638 | # See note about these variables in showtraceback() below |
|
1639 | 1639 | sys.last_type = etype |
|
1640 | 1640 | sys.last_value = value |
|
1641 | 1641 | sys.last_traceback = last_traceback |
|
1642 | 1642 | |
|
1643 | 1643 | if filename and etype is SyntaxError: |
|
1644 | 1644 | # Work hard to stuff the correct filename in the exception |
|
1645 | 1645 | try: |
|
1646 | 1646 | msg, (dummy_filename, lineno, offset, line) = value |
|
1647 | 1647 | except: |
|
1648 | 1648 | # Not the format we expect; leave it alone |
|
1649 | 1649 | pass |
|
1650 | 1650 | else: |
|
1651 | 1651 | # Stuff in the right filename |
|
1652 | 1652 | try: |
|
1653 | 1653 | # Assume SyntaxError is a class exception |
|
1654 | 1654 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1655 | 1655 | except: |
|
1656 | 1656 | # If that failed, assume SyntaxError is a string |
|
1657 | 1657 | value = msg, (filename, lineno, offset, line) |
|
1658 | 1658 | self.SyntaxTB(etype,value,[]) |
|
1659 | 1659 | |
|
1660 | 1660 | def debugger(self,force=False): |
|
1661 | 1661 | """Call the pydb/pdb debugger. |
|
1662 | 1662 | |
|
1663 | 1663 | Keywords: |
|
1664 | 1664 | |
|
1665 | 1665 | - force(False): by default, this routine checks the instance call_pdb |
|
1666 | 1666 | flag and does not actually invoke the debugger if the flag is false. |
|
1667 | 1667 | The 'force' option forces the debugger to activate even if the flag |
|
1668 | 1668 | is false. |
|
1669 | 1669 | """ |
|
1670 | 1670 | |
|
1671 | 1671 | if not (force or self.call_pdb): |
|
1672 | 1672 | return |
|
1673 | 1673 | |
|
1674 | 1674 | if not hasattr(sys,'last_traceback'): |
|
1675 | 1675 | error('No traceback has been produced, nothing to debug.') |
|
1676 | 1676 | return |
|
1677 | 1677 | |
|
1678 | 1678 | # use pydb if available |
|
1679 | 1679 | if debugger.has_pydb: |
|
1680 | 1680 | from pydb import pm |
|
1681 | 1681 | else: |
|
1682 | 1682 | # fallback to our internal debugger |
|
1683 | 1683 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1684 | 1684 | self.history_saving_wrapper(pm)() |
|
1685 | 1685 | |
|
1686 | 1686 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1687 | 1687 | """Display the exception that just occurred. |
|
1688 | 1688 | |
|
1689 | 1689 | If nothing is known about the exception, this is the method which |
|
1690 | 1690 | should be used throughout the code for presenting user tracebacks, |
|
1691 | 1691 | rather than directly invoking the InteractiveTB object. |
|
1692 | 1692 | |
|
1693 | 1693 | A specific showsyntaxerror() also exists, but this method can take |
|
1694 | 1694 | care of calling it if needed, so unless you are explicitly catching a |
|
1695 | 1695 | SyntaxError exception, don't try to analyze the stack manually and |
|
1696 | 1696 | simply call this method.""" |
|
1697 | 1697 | |
|
1698 | 1698 | |
|
1699 | 1699 | # Though this won't be called by syntax errors in the input line, |
|
1700 | 1700 | # there may be SyntaxError cases whith imported code. |
|
1701 | 1701 | |
|
1702 | 1702 | try: |
|
1703 | 1703 | if exc_tuple is None: |
|
1704 | 1704 | etype, value, tb = sys.exc_info() |
|
1705 | 1705 | else: |
|
1706 | 1706 | etype, value, tb = exc_tuple |
|
1707 | 1707 | |
|
1708 | 1708 | if etype is SyntaxError: |
|
1709 | 1709 | self.showsyntaxerror(filename) |
|
1710 | 1710 | elif etype is ipapi.UsageError: |
|
1711 | 1711 | print "UsageError:", value |
|
1712 | 1712 | else: |
|
1713 | 1713 | # WARNING: these variables are somewhat deprecated and not |
|
1714 | 1714 | # necessarily safe to use in a threaded environment, but tools |
|
1715 | 1715 | # like pdb depend on their existence, so let's set them. If we |
|
1716 | 1716 | # find problems in the field, we'll need to revisit their use. |
|
1717 | 1717 | sys.last_type = etype |
|
1718 | 1718 | sys.last_value = value |
|
1719 | 1719 | sys.last_traceback = tb |
|
1720 | 1720 | |
|
1721 | 1721 | if etype in self.custom_exceptions: |
|
1722 | 1722 | self.CustomTB(etype,value,tb) |
|
1723 | 1723 | else: |
|
1724 | 1724 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1725 | 1725 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1726 | 1726 | # pdb mucks up readline, fix it back |
|
1727 | 1727 | self.set_completer() |
|
1728 | 1728 | except KeyboardInterrupt: |
|
1729 | 1729 | self.write("\nKeyboardInterrupt\n") |
|
1730 | 1730 | |
|
1731 | 1731 | def mainloop(self,banner=None): |
|
1732 | 1732 | """Creates the local namespace and starts the mainloop. |
|
1733 | 1733 | |
|
1734 | 1734 | If an optional banner argument is given, it will override the |
|
1735 | 1735 | internally created default banner.""" |
|
1736 | 1736 | |
|
1737 | 1737 | if self.rc.c: # Emulate Python's -c option |
|
1738 | 1738 | self.exec_init_cmd() |
|
1739 | 1739 | if banner is None: |
|
1740 | 1740 | if not self.rc.banner: |
|
1741 | 1741 | banner = '' |
|
1742 | 1742 | # banner is string? Use it directly! |
|
1743 | 1743 | elif isinstance(self.rc.banner,basestring): |
|
1744 | 1744 | banner = self.rc.banner |
|
1745 | 1745 | else: |
|
1746 | 1746 | banner = self.BANNER+self.banner2 |
|
1747 | 1747 | |
|
1748 | 1748 | # if you run stuff with -c <cmd>, raw hist is not updated |
|
1749 | 1749 | # ensure that it's in sync |
|
1750 | 1750 | if len(self.input_hist) != len (self.input_hist_raw): |
|
1751 | 1751 | self.input_hist_raw = InputList(self.input_hist) |
|
1752 | 1752 | |
|
1753 | 1753 | while 1: |
|
1754 | 1754 | try: |
|
1755 | 1755 | self.interact(banner) |
|
1756 | 1756 | #self.interact_with_readline() |
|
1757 | 1757 | |
|
1758 | 1758 | # XXX for testing of a readline-decoupled repl loop, call |
|
1759 | 1759 | # interact_with_readline above |
|
1760 | 1760 | |
|
1761 | 1761 | break |
|
1762 | 1762 | except KeyboardInterrupt: |
|
1763 | 1763 | # this should not be necessary, but KeyboardInterrupt |
|
1764 | 1764 | # handling seems rather unpredictable... |
|
1765 | 1765 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1766 | 1766 | |
|
1767 | 1767 | def exec_init_cmd(self): |
|
1768 | 1768 | """Execute a command given at the command line. |
|
1769 | 1769 | |
|
1770 | 1770 | This emulates Python's -c option.""" |
|
1771 | 1771 | |
|
1772 | 1772 | #sys.argv = ['-c'] |
|
1773 | 1773 | self.push(self.prefilter(self.rc.c, False)) |
|
1774 | 1774 | if not self.rc.interact: |
|
1775 | 1775 | self.ask_exit() |
|
1776 | 1776 | |
|
1777 | 1777 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1778 | 1778 | """Embeds IPython into a running python program. |
|
1779 | 1779 | |
|
1780 | 1780 | Input: |
|
1781 | 1781 | |
|
1782 | 1782 | - header: An optional header message can be specified. |
|
1783 | 1783 | |
|
1784 | 1784 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1785 | 1785 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1786 | 1786 | program variables become visible but user-specific configuration |
|
1787 | 1787 | remains possible. |
|
1788 | 1788 | |
|
1789 | 1789 | - stack_depth: specifies how many levels in the stack to go to |
|
1790 | 1790 | looking for namespaces (when local_ns and global_ns are None). This |
|
1791 | 1791 | allows an intermediate caller to make sure that this function gets |
|
1792 | 1792 | the namespace from the intended level in the stack. By default (0) |
|
1793 | 1793 | it will get its locals and globals from the immediate caller. |
|
1794 | 1794 | |
|
1795 | 1795 | Warning: it's possible to use this in a program which is being run by |
|
1796 | 1796 | IPython itself (via %run), but some funny things will happen (a few |
|
1797 | 1797 | globals get overwritten). In the future this will be cleaned up, as |
|
1798 | 1798 | there is no fundamental reason why it can't work perfectly.""" |
|
1799 | 1799 | |
|
1800 | 1800 | # Get locals and globals from caller |
|
1801 | 1801 | if local_ns is None or global_ns is None: |
|
1802 | 1802 | call_frame = sys._getframe(stack_depth).f_back |
|
1803 | 1803 | |
|
1804 | 1804 | if local_ns is None: |
|
1805 | 1805 | local_ns = call_frame.f_locals |
|
1806 | 1806 | if global_ns is None: |
|
1807 | 1807 | global_ns = call_frame.f_globals |
|
1808 | 1808 | |
|
1809 | 1809 | # Update namespaces and fire up interpreter |
|
1810 | 1810 | |
|
1811 | 1811 | # The global one is easy, we can just throw it in |
|
1812 | 1812 | self.user_global_ns = global_ns |
|
1813 | 1813 | |
|
1814 | 1814 | # but the user/local one is tricky: ipython needs it to store internal |
|
1815 | 1815 | # data, but we also need the locals. We'll copy locals in the user |
|
1816 | 1816 | # one, but will track what got copied so we can delete them at exit. |
|
1817 | 1817 | # This is so that a later embedded call doesn't see locals from a |
|
1818 | 1818 | # previous call (which most likely existed in a separate scope). |
|
1819 | 1819 | local_varnames = local_ns.keys() |
|
1820 | 1820 | self.user_ns.update(local_ns) |
|
1821 | 1821 | #self.user_ns['local_ns'] = local_ns # dbg |
|
1822 | 1822 | |
|
1823 | 1823 | # Patch for global embedding to make sure that things don't overwrite |
|
1824 | 1824 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1825 | 1825 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1826 | 1826 | if local_ns is None and global_ns is None: |
|
1827 | 1827 | self.user_global_ns.update(__main__.__dict__) |
|
1828 | 1828 | |
|
1829 | 1829 | # make sure the tab-completer has the correct frame information, so it |
|
1830 | 1830 | # actually completes using the frame's locals/globals |
|
1831 | 1831 | self.set_completer_frame() |
|
1832 | 1832 | |
|
1833 | 1833 | # before activating the interactive mode, we need to make sure that |
|
1834 | 1834 | # all names in the builtin namespace needed by ipython point to |
|
1835 | 1835 | # ourselves, and not to other instances. |
|
1836 | 1836 | self.add_builtins() |
|
1837 | 1837 | |
|
1838 | 1838 | self.interact(header) |
|
1839 | 1839 | |
|
1840 | 1840 | # now, purge out the user namespace from anything we might have added |
|
1841 | 1841 | # from the caller's local namespace |
|
1842 | 1842 | delvar = self.user_ns.pop |
|
1843 | 1843 | for var in local_varnames: |
|
1844 | 1844 | delvar(var,None) |
|
1845 | 1845 | # and clean builtins we may have overridden |
|
1846 | 1846 | self.clean_builtins() |
|
1847 | 1847 | |
|
1848 | 1848 | def interact_prompt(self): |
|
1849 | 1849 | """ Print the prompt (in read-eval-print loop) |
|
1850 | 1850 | |
|
1851 | 1851 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1852 | 1852 | used in standard IPython flow. |
|
1853 | 1853 | """ |
|
1854 | 1854 | if self.more: |
|
1855 | 1855 | try: |
|
1856 | 1856 | prompt = self.hooks.generate_prompt(True) |
|
1857 | 1857 | except: |
|
1858 | 1858 | self.showtraceback() |
|
1859 | 1859 | if self.autoindent: |
|
1860 | 1860 | self.rl_do_indent = True |
|
1861 | 1861 | |
|
1862 | 1862 | else: |
|
1863 | 1863 | try: |
|
1864 | 1864 | prompt = self.hooks.generate_prompt(False) |
|
1865 | 1865 | except: |
|
1866 | 1866 | self.showtraceback() |
|
1867 | 1867 | self.write(prompt) |
|
1868 | 1868 | |
|
1869 | 1869 | def interact_handle_input(self,line): |
|
1870 | 1870 | """ Handle the input line (in read-eval-print loop) |
|
1871 | 1871 | |
|
1872 | 1872 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1873 | 1873 | used in standard IPython flow. |
|
1874 | 1874 | """ |
|
1875 | 1875 | if line.lstrip() == line: |
|
1876 | 1876 | self.shadowhist.add(line.strip()) |
|
1877 | 1877 | lineout = self.prefilter(line,self.more) |
|
1878 | 1878 | |
|
1879 | 1879 | if line.strip(): |
|
1880 | 1880 | if self.more: |
|
1881 | 1881 | self.input_hist_raw[-1] += '%s\n' % line |
|
1882 | 1882 | else: |
|
1883 | 1883 | self.input_hist_raw.append('%s\n' % line) |
|
1884 | 1884 | |
|
1885 | 1885 | |
|
1886 | 1886 | self.more = self.push(lineout) |
|
1887 | 1887 | if (self.SyntaxTB.last_syntax_error and |
|
1888 | 1888 | self.rc.autoedit_syntax): |
|
1889 | 1889 | self.edit_syntax_error() |
|
1890 | 1890 | |
|
1891 | 1891 | def interact_with_readline(self): |
|
1892 | 1892 | """ Demo of using interact_handle_input, interact_prompt |
|
1893 | 1893 | |
|
1894 | 1894 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1895 | 1895 | it should work like this. |
|
1896 | 1896 | """ |
|
1897 | 1897 | self.readline_startup_hook(self.pre_readline) |
|
1898 | 1898 | while not self.exit_now: |
|
1899 | 1899 | self.interact_prompt() |
|
1900 | 1900 | if self.more: |
|
1901 | 1901 | self.rl_do_indent = True |
|
1902 | 1902 | else: |
|
1903 | 1903 | self.rl_do_indent = False |
|
1904 | 1904 | line = raw_input_original().decode(self.stdin_encoding) |
|
1905 | 1905 | self.interact_handle_input(line) |
|
1906 | 1906 | |
|
1907 | 1907 | |
|
1908 | 1908 | def interact(self, banner=None): |
|
1909 | 1909 | """Closely emulate the interactive Python console. |
|
1910 | 1910 | |
|
1911 | 1911 | The optional banner argument specify the banner to print |
|
1912 | 1912 | before the first interaction; by default it prints a banner |
|
1913 | 1913 | similar to the one printed by the real Python interpreter, |
|
1914 | 1914 | followed by the current class name in parentheses (so as not |
|
1915 | 1915 | to confuse this with the real interpreter -- since it's so |
|
1916 | 1916 | close!). |
|
1917 | 1917 | |
|
1918 | 1918 | """ |
|
1919 | 1919 | |
|
1920 | 1920 | if self.exit_now: |
|
1921 | 1921 | # batch run -> do not interact |
|
1922 | 1922 | return |
|
1923 | 1923 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1924 | 1924 | if banner is None: |
|
1925 | 1925 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1926 | 1926 | (sys.version, sys.platform, cprt, |
|
1927 | 1927 | self.__class__.__name__)) |
|
1928 | 1928 | else: |
|
1929 | 1929 | self.write(banner) |
|
1930 | 1930 | |
|
1931 | 1931 | more = 0 |
|
1932 | 1932 | |
|
1933 | 1933 | # Mark activity in the builtins |
|
1934 | 1934 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1935 | 1935 | |
|
1936 | 1936 | if self.has_readline: |
|
1937 | 1937 | self.readline_startup_hook(self.pre_readline) |
|
1938 | 1938 | # exit_now is set by a call to %Exit or %Quit, through the |
|
1939 | 1939 | # ask_exit callback. |
|
1940 | 1940 | |
|
1941 | 1941 | while not self.exit_now: |
|
1942 | 1942 | self.hooks.pre_prompt_hook() |
|
1943 | 1943 | if more: |
|
1944 | 1944 | try: |
|
1945 | 1945 | prompt = self.hooks.generate_prompt(True) |
|
1946 | 1946 | except: |
|
1947 | 1947 | self.showtraceback() |
|
1948 | 1948 | if self.autoindent: |
|
1949 | 1949 | self.rl_do_indent = True |
|
1950 | 1950 | |
|
1951 | 1951 | else: |
|
1952 | 1952 | try: |
|
1953 | 1953 | prompt = self.hooks.generate_prompt(False) |
|
1954 | 1954 | except: |
|
1955 | 1955 | self.showtraceback() |
|
1956 | 1956 | try: |
|
1957 | 1957 | line = self.raw_input(prompt,more) |
|
1958 | 1958 | if self.exit_now: |
|
1959 | 1959 | # quick exit on sys.std[in|out] close |
|
1960 | 1960 | break |
|
1961 | 1961 | if self.autoindent: |
|
1962 | 1962 | self.rl_do_indent = False |
|
1963 | 1963 | |
|
1964 | 1964 | except KeyboardInterrupt: |
|
1965 | 1965 | #double-guard against keyboardinterrupts during kbdint handling |
|
1966 | 1966 | try: |
|
1967 | 1967 | self.write('\nKeyboardInterrupt\n') |
|
1968 | 1968 | self.resetbuffer() |
|
1969 | 1969 | # keep cache in sync with the prompt counter: |
|
1970 | 1970 | self.outputcache.prompt_count -= 1 |
|
1971 | 1971 | |
|
1972 | 1972 | if self.autoindent: |
|
1973 | 1973 | self.indent_current_nsp = 0 |
|
1974 | 1974 | more = 0 |
|
1975 | 1975 | except KeyboardInterrupt: |
|
1976 | 1976 | pass |
|
1977 | 1977 | except EOFError: |
|
1978 | 1978 | if self.autoindent: |
|
1979 | 1979 | self.rl_do_indent = False |
|
1980 | 1980 | self.readline_startup_hook(None) |
|
1981 | 1981 | self.write('\n') |
|
1982 | 1982 | self.exit() |
|
1983 | 1983 | except bdb.BdbQuit: |
|
1984 | 1984 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1985 | 1985 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1986 | 1986 | 'for IPython to properly format this particular exception.\n' |
|
1987 | 1987 | 'IPython will resume normal operation.') |
|
1988 | 1988 | except: |
|
1989 | 1989 | # exceptions here are VERY RARE, but they can be triggered |
|
1990 | 1990 | # asynchronously by signal handlers, for example. |
|
1991 | 1991 | self.showtraceback() |
|
1992 | 1992 | else: |
|
1993 | 1993 | more = self.push(line) |
|
1994 | 1994 | if (self.SyntaxTB.last_syntax_error and |
|
1995 | 1995 | self.rc.autoedit_syntax): |
|
1996 | 1996 | self.edit_syntax_error() |
|
1997 | 1997 | |
|
1998 | 1998 | # We are off again... |
|
1999 | 1999 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
2000 | 2000 | |
|
2001 | 2001 | def excepthook(self, etype, value, tb): |
|
2002 | 2002 | """One more defense for GUI apps that call sys.excepthook. |
|
2003 | 2003 | |
|
2004 | 2004 | GUI frameworks like wxPython trap exceptions and call |
|
2005 | 2005 | sys.excepthook themselves. I guess this is a feature that |
|
2006 | 2006 | enables them to keep running after exceptions that would |
|
2007 | 2007 | otherwise kill their mainloop. This is a bother for IPython |
|
2008 | 2008 | which excepts to catch all of the program exceptions with a try: |
|
2009 | 2009 | except: statement. |
|
2010 | 2010 | |
|
2011 | 2011 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
2012 | 2012 | any app directly invokes sys.excepthook, it will look to the user like |
|
2013 | 2013 | IPython crashed. In order to work around this, we can disable the |
|
2014 | 2014 | CrashHandler and replace it with this excepthook instead, which prints a |
|
2015 | 2015 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
2016 | 2016 | call sys.excepthook will generate a regular-looking exception from |
|
2017 | 2017 | IPython, and the CrashHandler will only be triggered by real IPython |
|
2018 | 2018 | crashes. |
|
2019 | 2019 | |
|
2020 | 2020 | This hook should be used sparingly, only in places which are not likely |
|
2021 | 2021 | to be true IPython errors. |
|
2022 | 2022 | """ |
|
2023 | 2023 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
2024 | 2024 | |
|
2025 | 2025 | def expand_aliases(self,fn,rest): |
|
2026 | 2026 | """ Expand multiple levels of aliases: |
|
2027 | 2027 | |
|
2028 | 2028 | if: |
|
2029 | 2029 | |
|
2030 | 2030 | alias foo bar /tmp |
|
2031 | 2031 | alias baz foo |
|
2032 | 2032 | |
|
2033 | 2033 | then: |
|
2034 | 2034 | |
|
2035 | 2035 | baz huhhahhei -> bar /tmp huhhahhei |
|
2036 | 2036 | |
|
2037 | 2037 | """ |
|
2038 | 2038 | line = fn + " " + rest |
|
2039 | 2039 | |
|
2040 | 2040 | done = set() |
|
2041 | 2041 | while 1: |
|
2042 | 2042 | pre,fn,rest = prefilter.splitUserInput(line, |
|
2043 | 2043 | prefilter.shell_line_split) |
|
2044 | 2044 | if fn in self.alias_table: |
|
2045 | 2045 | if fn in done: |
|
2046 | 2046 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
2047 | 2047 | return "" |
|
2048 | 2048 | done.add(fn) |
|
2049 | 2049 | |
|
2050 | 2050 | l2 = self.transform_alias(fn,rest) |
|
2051 | 2051 | # dir -> dir |
|
2052 | 2052 | # print "alias",line, "->",l2 #dbg |
|
2053 | 2053 | if l2 == line: |
|
2054 | 2054 | break |
|
2055 | 2055 | # ls -> ls -F should not recurse forever |
|
2056 | 2056 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
2057 | 2057 | line = l2 |
|
2058 | 2058 | break |
|
2059 | 2059 | |
|
2060 | 2060 | line=l2 |
|
2061 | 2061 | |
|
2062 | 2062 | |
|
2063 | 2063 | # print "al expand to",line #dbg |
|
2064 | 2064 | else: |
|
2065 | 2065 | break |
|
2066 | 2066 | |
|
2067 | 2067 | return line |
|
2068 | 2068 | |
|
2069 | 2069 | def transform_alias(self, alias,rest=''): |
|
2070 | 2070 | """ Transform alias to system command string. |
|
2071 | 2071 | """ |
|
2072 | 2072 | trg = self.alias_table[alias] |
|
2073 | 2073 | |
|
2074 | 2074 | nargs,cmd = trg |
|
2075 | 2075 | # print trg #dbg |
|
2076 | 2076 | if ' ' in cmd and os.path.isfile(cmd): |
|
2077 | 2077 | cmd = '"%s"' % cmd |
|
2078 | 2078 | |
|
2079 | 2079 | # Expand the %l special to be the user's input line |
|
2080 | 2080 | if cmd.find('%l') >= 0: |
|
2081 | 2081 | cmd = cmd.replace('%l',rest) |
|
2082 | 2082 | rest = '' |
|
2083 | 2083 | if nargs==0: |
|
2084 | 2084 | # Simple, argument-less aliases |
|
2085 | 2085 | cmd = '%s %s' % (cmd,rest) |
|
2086 | 2086 | else: |
|
2087 | 2087 | # Handle aliases with positional arguments |
|
2088 | 2088 | args = rest.split(None,nargs) |
|
2089 | 2089 | if len(args)< nargs: |
|
2090 | 2090 | error('Alias <%s> requires %s arguments, %s given.' % |
|
2091 | 2091 | (alias,nargs,len(args))) |
|
2092 | 2092 | return None |
|
2093 | 2093 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
2094 | 2094 | # Now call the macro, evaluating in the user's namespace |
|
2095 | 2095 | #print 'new command: <%r>' % cmd # dbg |
|
2096 | 2096 | return cmd |
|
2097 | 2097 | |
|
2098 | 2098 | def call_alias(self,alias,rest=''): |
|
2099 | 2099 | """Call an alias given its name and the rest of the line. |
|
2100 | 2100 | |
|
2101 | 2101 | This is only used to provide backwards compatibility for users of |
|
2102 | 2102 | ipalias(), use of which is not recommended for anymore.""" |
|
2103 | 2103 | |
|
2104 | 2104 | # Now call the macro, evaluating in the user's namespace |
|
2105 | 2105 | cmd = self.transform_alias(alias, rest) |
|
2106 | 2106 | try: |
|
2107 | 2107 | self.system(cmd) |
|
2108 | 2108 | except: |
|
2109 | 2109 | self.showtraceback() |
|
2110 | 2110 | |
|
2111 | 2111 | def indent_current_str(self): |
|
2112 | 2112 | """return the current level of indentation as a string""" |
|
2113 | 2113 | return self.indent_current_nsp * ' ' |
|
2114 | 2114 | |
|
2115 | 2115 | def autoindent_update(self,line): |
|
2116 | 2116 | """Keep track of the indent level.""" |
|
2117 | 2117 | |
|
2118 | 2118 | #debugx('line') |
|
2119 | 2119 | #debugx('self.indent_current_nsp') |
|
2120 | 2120 | if self.autoindent: |
|
2121 | 2121 | if line: |
|
2122 | 2122 | inisp = num_ini_spaces(line) |
|
2123 | 2123 | if inisp < self.indent_current_nsp: |
|
2124 | 2124 | self.indent_current_nsp = inisp |
|
2125 | 2125 | |
|
2126 | 2126 | if line[-1] == ':': |
|
2127 | 2127 | self.indent_current_nsp += 4 |
|
2128 | 2128 | elif dedent_re.match(line): |
|
2129 | 2129 | self.indent_current_nsp -= 4 |
|
2130 | 2130 | else: |
|
2131 | 2131 | self.indent_current_nsp = 0 |
|
2132 | 2132 | |
|
2133 | 2133 | def runlines(self,lines): |
|
2134 | 2134 | """Run a string of one or more lines of source. |
|
2135 | 2135 | |
|
2136 | 2136 | This method is capable of running a string containing multiple source |
|
2137 | 2137 | lines, as if they had been entered at the IPython prompt. Since it |
|
2138 | 2138 | exposes IPython's processing machinery, the given strings can contain |
|
2139 | 2139 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
2140 | 2140 | |
|
2141 | 2141 | # We must start with a clean buffer, in case this is run from an |
|
2142 | 2142 | # interactive IPython session (via a magic, for example). |
|
2143 | 2143 | self.resetbuffer() |
|
2144 | 2144 | lines = lines.split('\n') |
|
2145 | 2145 | more = 0 |
|
2146 | 2146 | |
|
2147 | 2147 | for line in lines: |
|
2148 | 2148 | # skip blank lines so we don't mess up the prompt counter, but do |
|
2149 | 2149 | # NOT skip even a blank line if we are in a code block (more is |
|
2150 | 2150 | # true) |
|
2151 | 2151 | |
|
2152 | 2152 | if line or more: |
|
2153 | 2153 | # push to raw history, so hist line numbers stay in sync |
|
2154 | 2154 | self.input_hist_raw.append("# " + line + "\n") |
|
2155 | 2155 | more = self.push(self.prefilter(line,more)) |
|
2156 | 2156 | # IPython's runsource returns None if there was an error |
|
2157 | 2157 | # compiling the code. This allows us to stop processing right |
|
2158 | 2158 | # away, so the user gets the error message at the right place. |
|
2159 | 2159 | if more is None: |
|
2160 | 2160 | break |
|
2161 | 2161 | else: |
|
2162 | 2162 | self.input_hist_raw.append("\n") |
|
2163 | 2163 | # final newline in case the input didn't have it, so that the code |
|
2164 | 2164 | # actually does get executed |
|
2165 | 2165 | if more: |
|
2166 | 2166 | self.push('\n') |
|
2167 | 2167 | |
|
2168 | 2168 | def runsource(self, source, filename='<input>', symbol='single'): |
|
2169 | 2169 | """Compile and run some source in the interpreter. |
|
2170 | 2170 | |
|
2171 | 2171 | Arguments are as for compile_command(). |
|
2172 | 2172 | |
|
2173 | 2173 | One several things can happen: |
|
2174 | 2174 | |
|
2175 | 2175 | 1) The input is incorrect; compile_command() raised an |
|
2176 | 2176 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2177 | 2177 | will be printed by calling the showsyntaxerror() method. |
|
2178 | 2178 | |
|
2179 | 2179 | 2) The input is incomplete, and more input is required; |
|
2180 | 2180 | compile_command() returned None. Nothing happens. |
|
2181 | 2181 | |
|
2182 | 2182 | 3) The input is complete; compile_command() returned a code |
|
2183 | 2183 | object. The code is executed by calling self.runcode() (which |
|
2184 | 2184 | also handles run-time exceptions, except for SystemExit). |
|
2185 | 2185 | |
|
2186 | 2186 | The return value is: |
|
2187 | 2187 | |
|
2188 | 2188 | - True in case 2 |
|
2189 | 2189 | |
|
2190 | 2190 | - False in the other cases, unless an exception is raised, where |
|
2191 | 2191 | None is returned instead. This can be used by external callers to |
|
2192 | 2192 | know whether to continue feeding input or not. |
|
2193 | 2193 | |
|
2194 | 2194 | The return value can be used to decide whether to use sys.ps1 or |
|
2195 | 2195 | sys.ps2 to prompt the next line.""" |
|
2196 | 2196 | |
|
2197 | 2197 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2198 | 2198 | # this allows execution of indented pasted code. It is tempting |
|
2199 | 2199 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2200 | 2200 | # directly, but this fails for more complicated scenarios |
|
2201 | 2201 | source=source.encode(self.stdin_encoding) |
|
2202 | 2202 | if source[:1] in [' ', '\t']: |
|
2203 | 2203 | source = 'if 1:\n%s' % source |
|
2204 | 2204 | |
|
2205 | 2205 | try: |
|
2206 | 2206 | code = self.compile(source,filename,symbol) |
|
2207 | 2207 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2208 | 2208 | # Case 1 |
|
2209 | 2209 | self.showsyntaxerror(filename) |
|
2210 | 2210 | return None |
|
2211 | 2211 | |
|
2212 | 2212 | if code is None: |
|
2213 | 2213 | # Case 2 |
|
2214 | 2214 | return True |
|
2215 | 2215 | |
|
2216 | 2216 | # Case 3 |
|
2217 | 2217 | # We store the code object so that threaded shells and |
|
2218 | 2218 | # custom exception handlers can access all this info if needed. |
|
2219 | 2219 | # The source corresponding to this can be obtained from the |
|
2220 | 2220 | # buffer attribute as '\n'.join(self.buffer). |
|
2221 | 2221 | self.code_to_run = code |
|
2222 | 2222 | # now actually execute the code object |
|
2223 | 2223 | if self.runcode(code) == 0: |
|
2224 | 2224 | return False |
|
2225 | 2225 | else: |
|
2226 | 2226 | return None |
|
2227 | 2227 | |
|
2228 | 2228 | def runcode(self,code_obj): |
|
2229 | 2229 | """Execute a code object. |
|
2230 | 2230 | |
|
2231 | 2231 | When an exception occurs, self.showtraceback() is called to display a |
|
2232 | 2232 | traceback. |
|
2233 | 2233 | |
|
2234 | 2234 | Return value: a flag indicating whether the code to be run completed |
|
2235 | 2235 | successfully: |
|
2236 | 2236 | |
|
2237 | 2237 | - 0: successful execution. |
|
2238 | 2238 | - 1: an error occurred. |
|
2239 | 2239 | """ |
|
2240 | 2240 | |
|
2241 | 2241 | # Set our own excepthook in case the user code tries to call it |
|
2242 | 2242 | # directly, so that the IPython crash handler doesn't get triggered |
|
2243 | 2243 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2244 | 2244 | |
|
2245 | 2245 | # we save the original sys.excepthook in the instance, in case config |
|
2246 | 2246 | # code (such as magics) needs access to it. |
|
2247 | 2247 | self.sys_excepthook = old_excepthook |
|
2248 | 2248 | outflag = 1 # happens in more places, so it's easier as default |
|
2249 | 2249 | try: |
|
2250 | 2250 | try: |
|
2251 | 2251 | self.hooks.pre_runcode_hook() |
|
2252 | 2252 | exec code_obj in self.user_global_ns, self.user_ns |
|
2253 | 2253 | finally: |
|
2254 | 2254 | # Reset our crash handler in place |
|
2255 | 2255 | sys.excepthook = old_excepthook |
|
2256 | 2256 | except SystemExit: |
|
2257 | 2257 | self.resetbuffer() |
|
2258 | 2258 | self.showtraceback() |
|
2259 | 2259 | warn("Type %exit or %quit to exit IPython " |
|
2260 | 2260 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2261 | 2261 | except self.custom_exceptions: |
|
2262 | 2262 | etype,value,tb = sys.exc_info() |
|
2263 | 2263 | self.CustomTB(etype,value,tb) |
|
2264 | 2264 | except: |
|
2265 | 2265 | self.showtraceback() |
|
2266 | 2266 | else: |
|
2267 | 2267 | outflag = 0 |
|
2268 | 2268 | if softspace(sys.stdout, 0): |
|
2269 | 2269 | |
|
2270 | 2270 | # Flush out code object which has been run (and source) |
|
2271 | 2271 | self.code_to_run = None |
|
2272 | 2272 | return outflag |
|
2273 | 2273 | |
|
2274 | 2274 | def push(self, line): |
|
2275 | 2275 | """Push a line to the interpreter. |
|
2276 | 2276 | |
|
2277 | 2277 | The line should not have a trailing newline; it may have |
|
2278 | 2278 | internal newlines. The line is appended to a buffer and the |
|
2279 | 2279 | interpreter's runsource() method is called with the |
|
2280 | 2280 | concatenated contents of the buffer as source. If this |
|
2281 | 2281 | indicates that the command was executed or invalid, the buffer |
|
2282 | 2282 | is reset; otherwise, the command is incomplete, and the buffer |
|
2283 | 2283 | is left as it was after the line was appended. The return |
|
2284 | 2284 | value is 1 if more input is required, 0 if the line was dealt |
|
2285 | 2285 | with in some way (this is the same as runsource()). |
|
2286 | 2286 | """ |
|
2287 | 2287 | |
|
2288 | 2288 | # autoindent management should be done here, and not in the |
|
2289 | 2289 | # interactive loop, since that one is only seen by keyboard input. We |
|
2290 | 2290 | # need this done correctly even for code run via runlines (which uses |
|
2291 | 2291 | # push). |
|
2292 | 2292 | |
|
2293 | 2293 | #print 'push line: <%s>' % line # dbg |
|
2294 | 2294 | for subline in line.splitlines(): |
|
2295 | 2295 | self.autoindent_update(subline) |
|
2296 | 2296 | self.buffer.append(line) |
|
2297 | 2297 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2298 | 2298 | if not more: |
|
2299 | 2299 | self.resetbuffer() |
|
2300 | 2300 | return more |
|
2301 | 2301 | |
|
2302 | 2302 | def split_user_input(self, line): |
|
2303 | 2303 | # This is really a hold-over to support ipapi and some extensions |
|
2304 | 2304 | return prefilter.splitUserInput(line) |
|
2305 | 2305 | |
|
2306 | 2306 | def resetbuffer(self): |
|
2307 | 2307 | """Reset the input buffer.""" |
|
2308 | 2308 | self.buffer[:] = [] |
|
2309 | 2309 | |
|
2310 | 2310 | def raw_input(self,prompt='',continue_prompt=False): |
|
2311 | 2311 | """Write a prompt and read a line. |
|
2312 | 2312 | |
|
2313 | 2313 | The returned line does not include the trailing newline. |
|
2314 | 2314 | When the user enters the EOF key sequence, EOFError is raised. |
|
2315 | 2315 | |
|
2316 | 2316 | Optional inputs: |
|
2317 | 2317 | |
|
2318 | 2318 | - prompt(''): a string to be printed to prompt the user. |
|
2319 | 2319 | |
|
2320 | 2320 | - continue_prompt(False): whether this line is the first one or a |
|
2321 | 2321 | continuation in a sequence of inputs. |
|
2322 | 2322 | """ |
|
2323 | 2323 | |
|
2324 | 2324 | # Code run by the user may have modified the readline completer state. |
|
2325 | 2325 | # We must ensure that our completer is back in place. |
|
2326 | 2326 | if self.has_readline: |
|
2327 | 2327 | self.set_completer() |
|
2328 | 2328 | |
|
2329 | 2329 | try: |
|
2330 | 2330 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2331 | 2331 | except ValueError: |
|
2332 | 2332 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2333 | 2333 | " or sys.stdout.close()!\nExiting IPython!") |
|
2334 | 2334 | self.ask_exit() |
|
2335 | 2335 | return "" |
|
2336 | 2336 | |
|
2337 | 2337 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2338 | 2338 | # than necessary. We do this by trimming out the auto-indent initial |
|
2339 | 2339 | # spaces, if the user's actual input started itself with whitespace. |
|
2340 | 2340 | #debugx('self.buffer[-1]') |
|
2341 | 2341 | |
|
2342 | 2342 | if self.autoindent: |
|
2343 | 2343 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2344 | 2344 | line = line[self.indent_current_nsp:] |
|
2345 | 2345 | self.indent_current_nsp = 0 |
|
2346 | 2346 | |
|
2347 | 2347 | # store the unfiltered input before the user has any chance to modify |
|
2348 | 2348 | # it. |
|
2349 | 2349 | if line.strip(): |
|
2350 | 2350 | if continue_prompt: |
|
2351 | 2351 | self.input_hist_raw[-1] += '%s\n' % line |
|
2352 | 2352 | if self.has_readline: # and some config option is set? |
|
2353 | 2353 | try: |
|
2354 | 2354 | histlen = self.readline.get_current_history_length() |
|
2355 | 2355 | if histlen > 1: |
|
2356 | 2356 | newhist = self.input_hist_raw[-1].rstrip() |
|
2357 | 2357 | self.readline.remove_history_item(histlen-1) |
|
2358 | 2358 | self.readline.replace_history_item(histlen-2, |
|
2359 | 2359 | newhist.encode(self.stdin_encoding)) |
|
2360 | 2360 | except AttributeError: |
|
2361 | 2361 | pass # re{move,place}_history_item are new in 2.4. |
|
2362 | 2362 | else: |
|
2363 | 2363 | self.input_hist_raw.append('%s\n' % line) |
|
2364 | 2364 | # only entries starting at first column go to shadow history |
|
2365 | 2365 | if line.lstrip() == line: |
|
2366 | 2366 | self.shadowhist.add(line.strip()) |
|
2367 | 2367 | elif not continue_prompt: |
|
2368 | 2368 | self.input_hist_raw.append('\n') |
|
2369 | 2369 | try: |
|
2370 | 2370 | lineout = self.prefilter(line,continue_prompt) |
|
2371 | 2371 | except: |
|
2372 | 2372 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2373 | 2373 | # can't take all of ipython with it. |
|
2374 | 2374 | self.showtraceback() |
|
2375 | 2375 | return '' |
|
2376 | 2376 | else: |
|
2377 | 2377 | return lineout |
|
2378 | 2378 | |
|
2379 | 2379 | def _prefilter(self, line, continue_prompt): |
|
2380 | 2380 | """Calls different preprocessors, depending on the form of line.""" |
|
2381 | 2381 | |
|
2382 | 2382 | # All handlers *must* return a value, even if it's blank (''). |
|
2383 | 2383 | |
|
2384 | 2384 | # Lines are NOT logged here. Handlers should process the line as |
|
2385 | 2385 | # needed, update the cache AND log it (so that the input cache array |
|
2386 | 2386 | # stays synced). |
|
2387 | 2387 | |
|
2388 | 2388 | #..................................................................... |
|
2389 | 2389 | # Code begins |
|
2390 | 2390 | |
|
2391 | 2391 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2392 | 2392 | |
|
2393 | 2393 | # save the line away in case we crash, so the post-mortem handler can |
|
2394 | 2394 | # record it |
|
2395 | 2395 | self._last_input_line = line |
|
2396 | 2396 | |
|
2397 | 2397 | #print '***line: <%s>' % line # dbg |
|
2398 | 2398 | |
|
2399 | 2399 | if not line: |
|
2400 | 2400 | # Return immediately on purely empty lines, so that if the user |
|
2401 | 2401 | # previously typed some whitespace that started a continuation |
|
2402 | 2402 | # prompt, he can break out of that loop with just an empty line. |
|
2403 | 2403 | # This is how the default python prompt works. |
|
2404 | 2404 | |
|
2405 | 2405 | # Only return if the accumulated input buffer was just whitespace! |
|
2406 | 2406 | if ''.join(self.buffer).isspace(): |
|
2407 | 2407 | self.buffer[:] = [] |
|
2408 | 2408 | return '' |
|
2409 | 2409 | |
|
2410 | 2410 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2411 | 2411 | |
|
2412 | 2412 | # the input history needs to track even empty lines |
|
2413 | 2413 | stripped = line.strip() |
|
2414 | 2414 | |
|
2415 | 2415 | if not stripped: |
|
2416 | 2416 | if not continue_prompt: |
|
2417 | 2417 | self.outputcache.prompt_count -= 1 |
|
2418 | 2418 | return self.handle_normal(line_info) |
|
2419 | 2419 | |
|
2420 | 2420 | # print '***cont',continue_prompt # dbg |
|
2421 | 2421 | # special handlers are only allowed for single line statements |
|
2422 | 2422 | if continue_prompt and not self.rc.multi_line_specials: |
|
2423 | 2423 | return self.handle_normal(line_info) |
|
2424 | 2424 | |
|
2425 | 2425 | |
|
2426 | 2426 | # See whether any pre-existing handler can take care of it |
|
2427 | 2427 | rewritten = self.hooks.input_prefilter(stripped) |
|
2428 | 2428 | if rewritten != stripped: # ok, some prefilter did something |
|
2429 | 2429 | rewritten = line_info.pre + rewritten # add indentation |
|
2430 | 2430 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2431 | 2431 | continue_prompt)) |
|
2432 | 2432 | |
|
2433 | 2433 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2434 | 2434 | |
|
2435 | 2435 | return prefilter.prefilter(line_info, self) |
|
2436 | 2436 | |
|
2437 | 2437 | |
|
2438 | 2438 | def _prefilter_dumb(self, line, continue_prompt): |
|
2439 | 2439 | """simple prefilter function, for debugging""" |
|
2440 | 2440 | return self.handle_normal(line,continue_prompt) |
|
2441 | 2441 | |
|
2442 | 2442 | |
|
2443 | 2443 | def multiline_prefilter(self, line, continue_prompt): |
|
2444 | 2444 | """ Run _prefilter for each line of input |
|
2445 | 2445 | |
|
2446 | 2446 | Covers cases where there are multiple lines in the user entry, |
|
2447 | 2447 | which is the case when the user goes back to a multiline history |
|
2448 | 2448 | entry and presses enter. |
|
2449 | 2449 | |
|
2450 | 2450 | """ |
|
2451 | 2451 | out = [] |
|
2452 | 2452 | for l in line.rstrip('\n').split('\n'): |
|
2453 | 2453 | out.append(self._prefilter(l, continue_prompt)) |
|
2454 | 2454 | return '\n'.join(out) |
|
2455 | 2455 | |
|
2456 | 2456 | # Set the default prefilter() function (this can be user-overridden) |
|
2457 | 2457 | prefilter = multiline_prefilter |
|
2458 | 2458 | |
|
2459 | 2459 | def handle_normal(self,line_info): |
|
2460 | 2460 | """Handle normal input lines. Use as a template for handlers.""" |
|
2461 | 2461 | |
|
2462 | 2462 | # With autoindent on, we need some way to exit the input loop, and I |
|
2463 | 2463 | # don't want to force the user to have to backspace all the way to |
|
2464 | 2464 | # clear the line. The rule will be in this case, that either two |
|
2465 | 2465 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2466 | 2466 | # of a size different to the indent level, will exit the input loop. |
|
2467 | 2467 | line = line_info.line |
|
2468 | 2468 | continue_prompt = line_info.continue_prompt |
|
2469 | 2469 | |
|
2470 | 2470 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2471 | 2471 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2472 | 2472 | (self.buffer[-1]).isspace() )): |
|
2473 | 2473 | line = '' |
|
2474 | 2474 | |
|
2475 | 2475 | self.log(line,line,continue_prompt) |
|
2476 | 2476 | return line |
|
2477 | 2477 | |
|
2478 | 2478 | def handle_alias(self,line_info): |
|
2479 | 2479 | """Handle alias input lines. """ |
|
2480 | 2480 | tgt = self.alias_table[line_info.iFun] |
|
2481 | 2481 | # print "=>",tgt #dbg |
|
2482 | 2482 | if callable(tgt): |
|
2483 | 2483 | if '$' in line_info.line: |
|
2484 | 2484 | call_meth = '(_ip, _ip.itpl(%s))' |
|
2485 | 2485 | else: |
|
2486 | 2486 | call_meth = '(_ip,%s)' |
|
2487 | 2487 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, |
|
2488 | 2488 | line_info.iFun, |
|
2489 | 2489 | make_quoted_expr(line_info.line)) |
|
2490 | 2490 | else: |
|
2491 | 2491 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2492 | 2492 | |
|
2493 | 2493 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2494 | 2494 | # aliases won't work in indented sections. |
|
2495 | 2495 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2496 | 2496 | make_quoted_expr( transformed )) |
|
2497 | 2497 | |
|
2498 | 2498 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2499 | 2499 | #print 'line out:',line_out # dbg |
|
2500 | 2500 | return line_out |
|
2501 | 2501 | |
|
2502 | 2502 | def handle_shell_escape(self, line_info): |
|
2503 | 2503 | """Execute the line in a shell, empty return value""" |
|
2504 | 2504 | #print 'line in :', `line` # dbg |
|
2505 | 2505 | line = line_info.line |
|
2506 | 2506 | if line.lstrip().startswith('!!'): |
|
2507 | 2507 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2508 | 2508 | # call to %sx and the actual command to be executed, so |
|
2509 | 2509 | # handle_magic can work correctly. Note that this works even if |
|
2510 | 2510 | # the line is indented, so it handles multi_line_specials |
|
2511 | 2511 | # properly. |
|
2512 | 2512 | new_rest = line.lstrip()[2:] |
|
2513 | 2513 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2514 | 2514 | line_info.iFun = 'sx' |
|
2515 | 2515 | line_info.theRest = new_rest |
|
2516 | 2516 | return self.handle_magic(line_info) |
|
2517 | 2517 | else: |
|
2518 | 2518 | cmd = line.lstrip().lstrip('!') |
|
2519 | 2519 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2520 | 2520 | make_quoted_expr(cmd)) |
|
2521 | 2521 | # update cache/log and return |
|
2522 | 2522 | self.log(line,line_out,line_info.continue_prompt) |
|
2523 | 2523 | return line_out |
|
2524 | 2524 | |
|
2525 | 2525 | def handle_magic(self, line_info): |
|
2526 | 2526 | """Execute magic functions.""" |
|
2527 | 2527 | iFun = line_info.iFun |
|
2528 | 2528 | theRest = line_info.theRest |
|
2529 | 2529 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2530 | 2530 | make_quoted_expr(iFun + " " + theRest)) |
|
2531 | 2531 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2532 | 2532 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2533 | 2533 | return cmd |
|
2534 | 2534 | |
|
2535 | 2535 | def handle_auto(self, line_info): |
|
2536 | 2536 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2537 | 2537 | |
|
2538 | 2538 | line = line_info.line |
|
2539 | 2539 | iFun = line_info.iFun |
|
2540 | 2540 | theRest = line_info.theRest |
|
2541 | 2541 | pre = line_info.pre |
|
2542 | 2542 | continue_prompt = line_info.continue_prompt |
|
2543 | 2543 | obj = line_info.ofind(self)['obj'] |
|
2544 | 2544 | |
|
2545 | 2545 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2546 | 2546 | |
|
2547 | 2547 | # This should only be active for single-line input! |
|
2548 | 2548 | if continue_prompt: |
|
2549 | 2549 | self.log(line,line,continue_prompt) |
|
2550 | 2550 | return line |
|
2551 | 2551 | |
|
2552 | 2552 | force_auto = isinstance(obj, ipapi.IPyAutocall) |
|
2553 | 2553 | auto_rewrite = True |
|
2554 | 2554 | |
|
2555 | 2555 | if pre == self.ESC_QUOTE: |
|
2556 | 2556 | # Auto-quote splitting on whitespace |
|
2557 | 2557 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2558 | 2558 | elif pre == self.ESC_QUOTE2: |
|
2559 | 2559 | # Auto-quote whole string |
|
2560 | 2560 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2561 | 2561 | elif pre == self.ESC_PAREN: |
|
2562 | 2562 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2563 | 2563 | else: |
|
2564 | 2564 | # Auto-paren. |
|
2565 | 2565 | # We only apply it to argument-less calls if the autocall |
|
2566 | 2566 | # parameter is set to 2. We only need to check that autocall is < |
|
2567 | 2567 | # 2, since this function isn't called unless it's at least 1. |
|
2568 | 2568 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2569 | 2569 | newcmd = '%s %s' % (iFun,theRest) |
|
2570 | 2570 | auto_rewrite = False |
|
2571 | 2571 | else: |
|
2572 | 2572 | if not force_auto and theRest.startswith('['): |
|
2573 | 2573 | if hasattr(obj,'__getitem__'): |
|
2574 | 2574 | # Don't autocall in this case: item access for an object |
|
2575 | 2575 | # which is BOTH callable and implements __getitem__. |
|
2576 | 2576 | newcmd = '%s %s' % (iFun,theRest) |
|
2577 | 2577 | auto_rewrite = False |
|
2578 | 2578 | else: |
|
2579 | 2579 | # if the object doesn't support [] access, go ahead and |
|
2580 | 2580 | # autocall |
|
2581 | 2581 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2582 | 2582 | elif theRest.endswith(';'): |
|
2583 | 2583 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2584 | 2584 | else: |
|
2585 | 2585 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2586 | 2586 | |
|
2587 | 2587 | if auto_rewrite: |
|
2588 | 2588 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2589 | 2589 | |
|
2590 | 2590 | try: |
|
2591 | 2591 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2592 | 2592 | # we use it and only print uncolored rewrite if we have unicode |
|
2593 | 2593 | rw = str(rw) |
|
2594 | 2594 | print >>Term.cout, rw |
|
2595 | 2595 | except UnicodeEncodeError: |
|
2596 | 2596 | print "-------------->" + newcmd |
|
2597 | 2597 | |
|
2598 | 2598 | # log what is now valid Python, not the actual user input (without the |
|
2599 | 2599 | # final newline) |
|
2600 | 2600 | self.log(line,newcmd,continue_prompt) |
|
2601 | 2601 | return newcmd |
|
2602 | 2602 | |
|
2603 | 2603 | def handle_help(self, line_info): |
|
2604 | 2604 | """Try to get some help for the object. |
|
2605 | 2605 | |
|
2606 | 2606 | obj? or ?obj -> basic information. |
|
2607 | 2607 | obj?? or ??obj -> more details. |
|
2608 | 2608 | """ |
|
2609 | 2609 | |
|
2610 | 2610 | line = line_info.line |
|
2611 | 2611 | # We need to make sure that we don't process lines which would be |
|
2612 | 2612 | # otherwise valid python, such as "x=1 # what?" |
|
2613 | 2613 | try: |
|
2614 | 2614 | codeop.compile_command(line) |
|
2615 | 2615 | except SyntaxError: |
|
2616 | 2616 | # We should only handle as help stuff which is NOT valid syntax |
|
2617 | 2617 | if line[0]==self.ESC_HELP: |
|
2618 | 2618 | line = line[1:] |
|
2619 | 2619 | elif line[-1]==self.ESC_HELP: |
|
2620 | 2620 | line = line[:-1] |
|
2621 | 2621 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2622 | 2622 | if line: |
|
2623 | 2623 | #print 'line:<%r>' % line # dbg |
|
2624 | 2624 | self.magic_pinfo(line) |
|
2625 | 2625 | else: |
|
2626 | 2626 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2627 | 2627 | return '' # Empty string is needed here! |
|
2628 | 2628 | except: |
|
2629 | 2629 | # Pass any other exceptions through to the normal handler |
|
2630 | 2630 | return self.handle_normal(line_info) |
|
2631 | 2631 | else: |
|
2632 | 2632 | # If the code compiles ok, we should handle it normally |
|
2633 | 2633 | return self.handle_normal(line_info) |
|
2634 | 2634 | |
|
2635 | 2635 | def getapi(self): |
|
2636 | 2636 | """ Get an IPApi object for this shell instance |
|
2637 | 2637 | |
|
2638 | 2638 | Getting an IPApi object is always preferable to accessing the shell |
|
2639 | 2639 | directly, but this holds true especially for extensions. |
|
2640 | 2640 | |
|
2641 | 2641 | It should always be possible to implement an extension with IPApi |
|
2642 | 2642 | alone. If not, contact maintainer to request an addition. |
|
2643 | 2643 | |
|
2644 | 2644 | """ |
|
2645 | 2645 | return self.api |
|
2646 | 2646 | |
|
2647 | 2647 | def handle_emacs(self, line_info): |
|
2648 | 2648 | """Handle input lines marked by python-mode.""" |
|
2649 | 2649 | |
|
2650 | 2650 | # Currently, nothing is done. Later more functionality can be added |
|
2651 | 2651 | # here if needed. |
|
2652 | 2652 | |
|
2653 | 2653 | # The input cache shouldn't be updated |
|
2654 | 2654 | return line_info.line |
|
2655 | 2655 | |
|
2656 | 2656 | |
|
2657 | 2657 | def mktempfile(self,data=None): |
|
2658 | 2658 | """Make a new tempfile and return its filename. |
|
2659 | 2659 | |
|
2660 | 2660 | This makes a call to tempfile.mktemp, but it registers the created |
|
2661 | 2661 | filename internally so ipython cleans it up at exit time. |
|
2662 | 2662 | |
|
2663 | 2663 | Optional inputs: |
|
2664 | 2664 | |
|
2665 | 2665 | - data(None): if data is given, it gets written out to the temp file |
|
2666 | 2666 | immediately, and the file is closed again.""" |
|
2667 | 2667 | |
|
2668 | 2668 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2669 | 2669 | self.tempfiles.append(filename) |
|
2670 | 2670 | |
|
2671 | 2671 | if data: |
|
2672 | 2672 | tmp_file = open(filename,'w') |
|
2673 | 2673 | tmp_file.write(data) |
|
2674 | 2674 | tmp_file.close() |
|
2675 | 2675 | return filename |
|
2676 | 2676 | |
|
2677 | 2677 | def write(self,data): |
|
2678 | 2678 | """Write a string to the default output""" |
|
2679 | 2679 | Term.cout.write(data) |
|
2680 | 2680 | |
|
2681 | 2681 | def write_err(self,data): |
|
2682 | 2682 | """Write a string to the default error output""" |
|
2683 | 2683 | Term.cerr.write(data) |
|
2684 | 2684 | |
|
2685 | 2685 | def ask_exit(self): |
|
2686 | 2686 | """ Call for exiting. Can be overiden and used as a callback. """ |
|
2687 | 2687 | self.exit_now = True |
|
2688 | 2688 | |
|
2689 | 2689 | def exit(self): |
|
2690 | 2690 | """Handle interactive exit. |
|
2691 | 2691 | |
|
2692 | 2692 | This method calls the ask_exit callback.""" |
|
2693 | 2693 | |
|
2694 | 2694 | if self.rc.confirm_exit: |
|
2695 | 2695 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2696 | 2696 | self.ask_exit() |
|
2697 | 2697 | else: |
|
2698 | 2698 | self.ask_exit() |
|
2699 | 2699 | |
|
2700 | 2700 | def safe_execfile(self,fname,*where,**kw): |
|
2701 | 2701 | """A safe version of the builtin execfile(). |
|
2702 | 2702 | |
|
2703 | 2703 | This version will never throw an exception, and knows how to handle |
|
2704 | 2704 | ipython logs as well. |
|
2705 | 2705 | |
|
2706 | 2706 | :Parameters: |
|
2707 | 2707 | fname : string |
|
2708 | 2708 | Name of the file to be executed. |
|
2709 | 2709 | |
|
2710 | 2710 | where : tuple |
|
2711 | 2711 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2712 | 2712 | If only one is given, it is passed as both. |
|
2713 | 2713 | |
|
2714 | 2714 | :Keywords: |
|
2715 | 2715 | islog : boolean (False) |
|
2716 | 2716 | |
|
2717 | 2717 | quiet : boolean (True) |
|
2718 | 2718 | |
|
2719 | 2719 | exit_ignore : boolean (False) |
|
2720 | 2720 | """ |
|
2721 | 2721 | |
|
2722 | 2722 | def syspath_cleanup(): |
|
2723 | 2723 | """Internal cleanup routine for sys.path.""" |
|
2724 | 2724 | if add_dname: |
|
2725 | 2725 | try: |
|
2726 | 2726 | sys.path.remove(dname) |
|
2727 | 2727 | except ValueError: |
|
2728 | 2728 | # For some reason the user has already removed it, ignore. |
|
2729 | 2729 | pass |
|
2730 | 2730 | |
|
2731 | 2731 | fname = os.path.expanduser(fname) |
|
2732 | 2732 | |
|
2733 | 2733 | # Find things also in current directory. This is needed to mimic the |
|
2734 | 2734 | # behavior of running a script from the system command line, where |
|
2735 | 2735 | # Python inserts the script's directory into sys.path |
|
2736 | 2736 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2737 | 2737 | add_dname = False |
|
2738 | 2738 | if dname not in sys.path: |
|
2739 | 2739 | sys.path.insert(0,dname) |
|
2740 | 2740 | add_dname = True |
|
2741 | 2741 | |
|
2742 | 2742 | try: |
|
2743 | 2743 | xfile = open(fname) |
|
2744 | 2744 | except: |
|
2745 | 2745 | print >> Term.cerr, \ |
|
2746 | 2746 | 'Could not open file <%s> for safe execution.' % fname |
|
2747 | 2747 | syspath_cleanup() |
|
2748 | 2748 | return None |
|
2749 | 2749 | |
|
2750 | 2750 | kw.setdefault('islog',0) |
|
2751 | 2751 | kw.setdefault('quiet',1) |
|
2752 | 2752 | kw.setdefault('exit_ignore',0) |
|
2753 | 2753 | |
|
2754 | 2754 | first = xfile.readline() |
|
2755 | 2755 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2756 | 2756 | xfile.close() |
|
2757 | 2757 | # line by line execution |
|
2758 | 2758 | if first.startswith(loghead) or kw['islog']: |
|
2759 | 2759 | print 'Loading log file <%s> one line at a time...' % fname |
|
2760 | 2760 | if kw['quiet']: |
|
2761 | 2761 | stdout_save = sys.stdout |
|
2762 | 2762 | sys.stdout = StringIO.StringIO() |
|
2763 | 2763 | try: |
|
2764 | 2764 | globs,locs = where[0:2] |
|
2765 | 2765 | except: |
|
2766 | 2766 | try: |
|
2767 | 2767 | globs = locs = where[0] |
|
2768 | 2768 | except: |
|
2769 | 2769 | globs = locs = globals() |
|
2770 | 2770 | badblocks = [] |
|
2771 | 2771 | |
|
2772 | 2772 | # we also need to identify indented blocks of code when replaying |
|
2773 | 2773 | # logs and put them together before passing them to an exec |
|
2774 | 2774 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2775 | 2775 | # file. It's easiest if we swallow the whole thing in memory |
|
2776 | 2776 | # first, and manually walk through the lines list moving the |
|
2777 | 2777 | # counter ourselves. |
|
2778 | 2778 | indent_re = re.compile('\s+\S') |
|
2779 | 2779 | xfile = open(fname) |
|
2780 | 2780 | filelines = xfile.readlines() |
|
2781 | 2781 | xfile.close() |
|
2782 | 2782 | nlines = len(filelines) |
|
2783 | 2783 | lnum = 0 |
|
2784 | 2784 | while lnum < nlines: |
|
2785 | 2785 | line = filelines[lnum] |
|
2786 | 2786 | lnum += 1 |
|
2787 | 2787 | # don't re-insert logger status info into cache |
|
2788 | 2788 | if line.startswith('#log#'): |
|
2789 | 2789 | continue |
|
2790 | 2790 | else: |
|
2791 | 2791 | # build a block of code (maybe a single line) for execution |
|
2792 | 2792 | block = line |
|
2793 | 2793 | try: |
|
2794 | 2794 | next = filelines[lnum] # lnum has already incremented |
|
2795 | 2795 | except: |
|
2796 | 2796 | next = None |
|
2797 | 2797 | while next and indent_re.match(next): |
|
2798 | 2798 | block += next |
|
2799 | 2799 | lnum += 1 |
|
2800 | 2800 | try: |
|
2801 | 2801 | next = filelines[lnum] |
|
2802 | 2802 | except: |
|
2803 | 2803 | next = None |
|
2804 | 2804 | # now execute the block of one or more lines |
|
2805 | 2805 | try: |
|
2806 | 2806 | exec block in globs,locs |
|
2807 | 2807 | except SystemExit: |
|
2808 | 2808 | pass |
|
2809 | 2809 | except: |
|
2810 | 2810 | badblocks.append(block.rstrip()) |
|
2811 | 2811 | if kw['quiet']: # restore stdout |
|
2812 | 2812 | sys.stdout.close() |
|
2813 | 2813 | sys.stdout = stdout_save |
|
2814 | 2814 | print 'Finished replaying log file <%s>' % fname |
|
2815 | 2815 | if badblocks: |
|
2816 | 2816 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2817 | 2817 | '<%s> reported errors:' % fname) |
|
2818 | 2818 | |
|
2819 | 2819 | for badline in badblocks: |
|
2820 | 2820 | print >> sys.stderr, badline |
|
2821 | 2821 | else: # regular file execution |
|
2822 | 2822 | try: |
|
2823 | 2823 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2824 | 2824 | # Work around a bug in Python for Windows. The bug was |
|
2825 | 2825 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2826 | 2826 | # SVN Python as of March/07. For details, see: |
|
2827 | 2827 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2828 | 2828 | try: |
|
2829 | 2829 | globs,locs = where[0:2] |
|
2830 | 2830 | except: |
|
2831 | 2831 | try: |
|
2832 | 2832 | globs = locs = where[0] |
|
2833 | 2833 | except: |
|
2834 | 2834 | globs = locs = globals() |
|
2835 | 2835 | exec file(fname) in globs,locs |
|
2836 | 2836 | else: |
|
2837 | 2837 | execfile(fname,*where) |
|
2838 | 2838 | except SyntaxError: |
|
2839 | 2839 | self.showsyntaxerror() |
|
2840 | 2840 | warn('Failure executing file: <%s>' % fname) |
|
2841 | 2841 | except SystemExit,status: |
|
2842 | 2842 | # Code that correctly sets the exit status flag to success (0) |
|
2843 | 2843 | # shouldn't be bothered with a traceback. Note that a plain |
|
2844 | 2844 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2845 | 2845 | # will still get a traceback. Note that the structure of the |
|
2846 | 2846 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2847 | 2847 | # the checks must be done in a version-dependent way. |
|
2848 | 2848 | show = False |
|
2849 | 2849 | |
|
2850 | 2850 | if sys.version_info[:2] > (2,5): |
|
2851 | 2851 | if status.message!=0 and not kw['exit_ignore']: |
|
2852 | 2852 | show = True |
|
2853 | 2853 | else: |
|
2854 | 2854 | if status.code and not kw['exit_ignore']: |
|
2855 | 2855 | show = True |
|
2856 | 2856 | if show: |
|
2857 | 2857 | self.showtraceback() |
|
2858 | 2858 | warn('Failure executing file: <%s>' % fname) |
|
2859 | 2859 | except: |
|
2860 | 2860 | self.showtraceback() |
|
2861 | 2861 | warn('Failure executing file: <%s>' % fname) |
|
2862 | 2862 | |
|
2863 | 2863 | syspath_cleanup() |
|
2864 | 2864 | |
|
2865 | 2865 | #************************* end of file <iplib.py> ***************************** |
@@ -1,3457 +1,3457 b'' | |||
|
1 | 1 | # -*- coding: 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-2006 Fernando Perez <fperez@colorado.edu> |
|
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 | # Modules and globals |
|
15 | 15 | |
|
16 | 16 | # Python standard modules |
|
17 | 17 | import __builtin__ |
|
18 | 18 | import bdb |
|
19 | 19 | import inspect |
|
20 | 20 | import os |
|
21 | 21 | import pdb |
|
22 | 22 | import pydoc |
|
23 | 23 | import sys |
|
24 | 24 | import re |
|
25 | 25 | import tempfile |
|
26 | 26 | import time |
|
27 | 27 | import cPickle as pickle |
|
28 | 28 | import textwrap |
|
29 | 29 | from cStringIO import StringIO |
|
30 | 30 | from getopt import getopt,GetoptError |
|
31 | 31 | from pprint import pprint, pformat |
|
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 | # Homebrewed |
|
45 | 45 | import IPython |
|
46 | 46 | from IPython.utils import wildcard |
|
47 | 47 | from IPython.core import debugger, oinspect |
|
48 | 48 | from IPython.core.fakemodule import FakeModule |
|
49 | 49 | from IPython.external.Itpl import Itpl, itpl, printpl,itplns |
|
50 | 50 | from IPython.utils.PyColorize import Parser |
|
51 | 51 | from IPython.utils.ipstruct import Struct |
|
52 | 52 | from IPython.core.macro import Macro |
|
53 | 53 | from IPython.utils.genutils import * |
|
54 | 54 | from IPython.utils import platutils |
|
55 | 55 | import IPython.utils.generics |
|
56 | 56 | from IPython.core import ipapi |
|
57 | 57 | from IPython.core.ipapi import UsageError |
|
58 | 58 | from IPython.testing import decorators as testdec |
|
59 | 59 | |
|
60 | 60 | #*************************************************************************** |
|
61 | 61 | # Utility functions |
|
62 | 62 | def on_off(tag): |
|
63 | 63 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
64 | 64 | return ['OFF','ON'][tag] |
|
65 | 65 | |
|
66 | 66 | class Bunch: pass |
|
67 | 67 | |
|
68 | 68 | def compress_dhist(dh): |
|
69 | 69 | head, tail = dh[:-10], dh[-10:] |
|
70 | 70 | |
|
71 | 71 | newhead = [] |
|
72 | 72 | done = set() |
|
73 | 73 | for h in head: |
|
74 | 74 | if h in done: |
|
75 | 75 | continue |
|
76 | 76 | newhead.append(h) |
|
77 | 77 | done.add(h) |
|
78 | 78 | |
|
79 | 79 | return newhead + tail |
|
80 | 80 | |
|
81 | 81 | |
|
82 | 82 | #*************************************************************************** |
|
83 | 83 | # Main class implementing Magic functionality |
|
84 | 84 | class Magic: |
|
85 | 85 | """Magic functions for InteractiveShell. |
|
86 | 86 | |
|
87 | 87 | Shell functions which can be reached as %function_name. All magic |
|
88 | 88 | functions should accept a string, which they can parse for their own |
|
89 | 89 | needs. This can make some functions easier to type, eg `%cd ../` |
|
90 | 90 | vs. `%cd("../")` |
|
91 | 91 | |
|
92 | 92 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
93 | 93 | at the command line, but it is is needed in the definition. """ |
|
94 | 94 | |
|
95 | 95 | # class globals |
|
96 | 96 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
97 | 97 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
98 | 98 | |
|
99 | 99 | #...................................................................... |
|
100 | 100 | # some utility functions |
|
101 | 101 | |
|
102 | 102 | def __init__(self,shell): |
|
103 | 103 | |
|
104 | 104 | self.options_table = {} |
|
105 | 105 | if profile is None: |
|
106 | 106 | self.magic_prun = self.profile_missing_notice |
|
107 | 107 | self.shell = shell |
|
108 | 108 | |
|
109 | 109 | # namespace for holding state we may need |
|
110 | 110 | self._magic_state = Bunch() |
|
111 | 111 | |
|
112 | 112 | def profile_missing_notice(self, *args, **kwargs): |
|
113 | 113 | error("""\ |
|
114 | 114 | The profile module could not be found. It has been removed from the standard |
|
115 | 115 | python packages because of its non-free license. To use profiling, install the |
|
116 | 116 | python-profiler package from non-free.""") |
|
117 | 117 | |
|
118 | 118 | def default_option(self,fn,optstr): |
|
119 | 119 | """Make an entry in the options_table for fn, with value optstr""" |
|
120 | 120 | |
|
121 | 121 | if fn not in self.lsmagic(): |
|
122 | 122 | error("%s is not a magic function" % fn) |
|
123 | 123 | self.options_table[fn] = optstr |
|
124 | 124 | |
|
125 | 125 | def lsmagic(self): |
|
126 | 126 | """Return a list of currently available magic functions. |
|
127 | 127 | |
|
128 | 128 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
129 | 129 | ['magic_ls','magic_cd',...]""" |
|
130 | 130 | |
|
131 | 131 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
132 | 132 | |
|
133 | 133 | # magics in class definition |
|
134 | 134 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
135 | 135 | callable(Magic.__dict__[fn]) |
|
136 | 136 | # in instance namespace (run-time user additions) |
|
137 | 137 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
138 | 138 | callable(self.__dict__[fn]) |
|
139 | 139 | # and bound magics by user (so they can access self): |
|
140 | 140 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
141 | 141 | callable(self.__class__.__dict__[fn]) |
|
142 | 142 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
143 | 143 | filter(inst_magic,self.__dict__.keys()) + \ |
|
144 | 144 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
145 | 145 | out = [] |
|
146 | 146 | for fn in set(magics): |
|
147 | 147 | out.append(fn.replace('magic_','',1)) |
|
148 | 148 | out.sort() |
|
149 | 149 | return out |
|
150 | 150 | |
|
151 | 151 | def extract_input_slices(self,slices,raw=False): |
|
152 | 152 | """Return as a string a set of input history slices. |
|
153 | 153 | |
|
154 | 154 | Inputs: |
|
155 | 155 | |
|
156 | 156 | - slices: the set of slices is given as a list of strings (like |
|
157 | 157 | ['1','4:8','9'], since this function is for use by magic functions |
|
158 | 158 | which get their arguments as strings. |
|
159 | 159 | |
|
160 | 160 | Optional inputs: |
|
161 | 161 | |
|
162 | 162 | - raw(False): by default, the processed input is used. If this is |
|
163 | 163 | true, the raw input history is used instead. |
|
164 | 164 | |
|
165 | 165 | Note that slices can be called with two notations: |
|
166 | 166 | |
|
167 | 167 | N:M -> standard python form, means including items N...(M-1). |
|
168 | 168 | |
|
169 | 169 | N-M -> include items N..M (closed endpoint).""" |
|
170 | 170 | |
|
171 | 171 | if raw: |
|
172 | 172 | hist = self.shell.input_hist_raw |
|
173 | 173 | else: |
|
174 | 174 | hist = self.shell.input_hist |
|
175 | 175 | |
|
176 | 176 | cmds = [] |
|
177 | 177 | for chunk in slices: |
|
178 | 178 | if ':' in chunk: |
|
179 | 179 | ini,fin = map(int,chunk.split(':')) |
|
180 | 180 | elif '-' in chunk: |
|
181 | 181 | ini,fin = map(int,chunk.split('-')) |
|
182 | 182 | fin += 1 |
|
183 | 183 | else: |
|
184 | 184 | ini = int(chunk) |
|
185 | 185 | fin = ini+1 |
|
186 | 186 | cmds.append(hist[ini:fin]) |
|
187 | 187 | return cmds |
|
188 | 188 | |
|
189 | 189 | def _ofind(self, oname, namespaces=None): |
|
190 | 190 | """Find an object in the available namespaces. |
|
191 | 191 | |
|
192 | 192 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
193 | 193 | |
|
194 | 194 | Has special code to detect magic functions. |
|
195 | 195 | """ |
|
196 | 196 | |
|
197 | 197 | oname = oname.strip() |
|
198 | 198 | |
|
199 | 199 | alias_ns = None |
|
200 | 200 | if namespaces is None: |
|
201 | 201 | # Namespaces to search in: |
|
202 | 202 | # Put them in a list. The order is important so that we |
|
203 | 203 | # find things in the same order that Python finds them. |
|
204 | 204 | namespaces = [ ('Interactive', self.shell.user_ns), |
|
205 | 205 | ('IPython internal', self.shell.internal_ns), |
|
206 | 206 | ('Python builtin', __builtin__.__dict__), |
|
207 | 207 | ('Alias', self.shell.alias_table), |
|
208 | 208 | ] |
|
209 | 209 | alias_ns = self.shell.alias_table |
|
210 | 210 | |
|
211 | 211 | # initialize results to 'null' |
|
212 | 212 | found = 0; obj = None; ospace = None; ds = None; |
|
213 | 213 | ismagic = 0; isalias = 0; parent = None |
|
214 | 214 | |
|
215 | 215 | # Look for the given name by splitting it in parts. If the head is |
|
216 | 216 | # found, then we look for all the remaining parts as members, and only |
|
217 | 217 | # declare success if we can find them all. |
|
218 | 218 | oname_parts = oname.split('.') |
|
219 | 219 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
220 | 220 | for nsname,ns in namespaces: |
|
221 | 221 | try: |
|
222 | 222 | obj = ns[oname_head] |
|
223 | 223 | except KeyError: |
|
224 | 224 | continue |
|
225 | 225 | else: |
|
226 | 226 | #print 'oname_rest:', oname_rest # dbg |
|
227 | 227 | for part in oname_rest: |
|
228 | 228 | try: |
|
229 | 229 | parent = obj |
|
230 | 230 | obj = getattr(obj,part) |
|
231 | 231 | except: |
|
232 | 232 | # Blanket except b/c some badly implemented objects |
|
233 | 233 | # allow __getattr__ to raise exceptions other than |
|
234 | 234 | # AttributeError, which then crashes IPython. |
|
235 | 235 | break |
|
236 | 236 | else: |
|
237 | 237 | # If we finish the for loop (no break), we got all members |
|
238 | 238 | found = 1 |
|
239 | 239 | ospace = nsname |
|
240 | 240 | if ns == alias_ns: |
|
241 | 241 | isalias = 1 |
|
242 | 242 | break # namespace loop |
|
243 | 243 | |
|
244 | 244 | # Try to see if it's magic |
|
245 | 245 | if not found: |
|
246 | 246 | if oname.startswith(self.shell.ESC_MAGIC): |
|
247 | 247 | oname = oname[1:] |
|
248 | 248 | obj = getattr(self,'magic_'+oname,None) |
|
249 | 249 | if obj is not None: |
|
250 | 250 | found = 1 |
|
251 | 251 | ospace = 'IPython internal' |
|
252 | 252 | ismagic = 1 |
|
253 | 253 | |
|
254 | 254 | # Last try: special-case some literals like '', [], {}, etc: |
|
255 | 255 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
256 | 256 | obj = eval(oname_head) |
|
257 | 257 | found = 1 |
|
258 | 258 | ospace = 'Interactive' |
|
259 | 259 | |
|
260 | 260 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
261 | 261 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
262 | 262 | |
|
263 | 263 | def arg_err(self,func): |
|
264 | 264 | """Print docstring if incorrect arguments were passed""" |
|
265 | 265 | print 'Error in arguments:' |
|
266 | 266 | print OInspect.getdoc(func) |
|
267 | 267 | |
|
268 | 268 | def format_latex(self,strng): |
|
269 | 269 | """Format a string for latex inclusion.""" |
|
270 | 270 | |
|
271 | 271 | # Characters that need to be escaped for latex: |
|
272 | 272 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
273 | 273 | # Magic command names as headers: |
|
274 | 274 | cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC, |
|
275 | 275 | re.MULTILINE) |
|
276 | 276 | # Magic commands |
|
277 | 277 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC, |
|
278 | 278 | re.MULTILINE) |
|
279 | 279 | # Paragraph continue |
|
280 | 280 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
281 | 281 | |
|
282 | 282 | # The "\n" symbol |
|
283 | 283 | newline_re = re.compile(r'\\n') |
|
284 | 284 | |
|
285 | 285 | # Now build the string for output: |
|
286 | 286 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
287 | 287 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
288 | 288 | strng) |
|
289 | 289 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
290 | 290 | strng = par_re.sub(r'\\\\',strng) |
|
291 | 291 | strng = escape_re.sub(r'\\\1',strng) |
|
292 | 292 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
293 | 293 | return strng |
|
294 | 294 | |
|
295 | 295 | def format_screen(self,strng): |
|
296 | 296 | """Format a string for screen printing. |
|
297 | 297 | |
|
298 | 298 | This removes some latex-type format codes.""" |
|
299 | 299 | # Paragraph continue |
|
300 | 300 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
301 | 301 | strng = par_re.sub('',strng) |
|
302 | 302 | return strng |
|
303 | 303 | |
|
304 | 304 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
305 | 305 | """Parse options passed to an argument string. |
|
306 | 306 | |
|
307 | 307 | The interface is similar to that of getopt(), but it returns back a |
|
308 | 308 | Struct with the options as keys and the stripped argument string still |
|
309 | 309 | as a string. |
|
310 | 310 | |
|
311 | 311 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
312 | 312 | This allows us to easily expand variables, glob files, quote |
|
313 | 313 | arguments, etc. |
|
314 | 314 | |
|
315 | 315 | Options: |
|
316 | 316 | -mode: default 'string'. If given as 'list', the argument string is |
|
317 | 317 | returned as a list (split on whitespace) instead of a string. |
|
318 | 318 | |
|
319 | 319 | -list_all: put all option values in lists. Normally only options |
|
320 | 320 | appearing more than once are put in a list. |
|
321 | 321 | |
|
322 | 322 | -posix (True): whether to split the input line in POSIX mode or not, |
|
323 | 323 | as per the conventions outlined in the shlex module from the |
|
324 | 324 | standard library.""" |
|
325 | 325 | |
|
326 | 326 | # inject default options at the beginning of the input line |
|
327 | 327 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
328 | 328 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
329 | 329 | |
|
330 | 330 | mode = kw.get('mode','string') |
|
331 | 331 | if mode not in ['string','list']: |
|
332 | 332 | raise ValueError,'incorrect mode given: %s' % mode |
|
333 | 333 | # Get options |
|
334 | 334 | list_all = kw.get('list_all',0) |
|
335 | 335 | posix = kw.get('posix',True) |
|
336 | 336 | |
|
337 | 337 | # Check if we have more than one argument to warrant extra processing: |
|
338 | 338 | odict = {} # Dictionary with options |
|
339 | 339 | args = arg_str.split() |
|
340 | 340 | if len(args) >= 1: |
|
341 | 341 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
342 | 342 | # need to look for options |
|
343 | 343 | argv = arg_split(arg_str,posix) |
|
344 | 344 | # Do regular option processing |
|
345 | 345 | try: |
|
346 | 346 | opts,args = getopt(argv,opt_str,*long_opts) |
|
347 | 347 | except GetoptError,e: |
|
348 | 348 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
349 | 349 | " ".join(long_opts))) |
|
350 | 350 | for o,a in opts: |
|
351 | 351 | if o.startswith('--'): |
|
352 | 352 | o = o[2:] |
|
353 | 353 | else: |
|
354 | 354 | o = o[1:] |
|
355 | 355 | try: |
|
356 | 356 | odict[o].append(a) |
|
357 | 357 | except AttributeError: |
|
358 | 358 | odict[o] = [odict[o],a] |
|
359 | 359 | except KeyError: |
|
360 | 360 | if list_all: |
|
361 | 361 | odict[o] = [a] |
|
362 | 362 | else: |
|
363 | 363 | odict[o] = a |
|
364 | 364 | |
|
365 | 365 | # Prepare opts,args for return |
|
366 | 366 | opts = Struct(odict) |
|
367 | 367 | if mode == 'string': |
|
368 | 368 | args = ' '.join(args) |
|
369 | 369 | |
|
370 | 370 | return opts,args |
|
371 | 371 | |
|
372 | 372 | #...................................................................... |
|
373 | 373 | # And now the actual magic functions |
|
374 | 374 | |
|
375 | 375 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
376 | 376 | def magic_lsmagic(self, parameter_s = ''): |
|
377 | 377 | """List currently available magic functions.""" |
|
378 | 378 | mesc = self.shell.ESC_MAGIC |
|
379 | 379 | print 'Available magic functions:\n'+mesc+\ |
|
380 | 380 | (' '+mesc).join(self.lsmagic()) |
|
381 | 381 | print '\n' + Magic.auto_status[self.shell.rc.automagic] |
|
382 | 382 | return None |
|
383 | 383 | |
|
384 | 384 | def magic_magic(self, parameter_s = ''): |
|
385 | 385 | """Print information about the magic function system. |
|
386 | 386 | |
|
387 | 387 | Supported formats: -latex, -brief, -rest |
|
388 | 388 | """ |
|
389 | 389 | |
|
390 | 390 | mode = '' |
|
391 | 391 | try: |
|
392 | 392 | if parameter_s.split()[0] == '-latex': |
|
393 | 393 | mode = 'latex' |
|
394 | 394 | if parameter_s.split()[0] == '-brief': |
|
395 | 395 | mode = 'brief' |
|
396 | 396 | if parameter_s.split()[0] == '-rest': |
|
397 | 397 | mode = 'rest' |
|
398 | 398 | rest_docs = [] |
|
399 | 399 | except: |
|
400 | 400 | pass |
|
401 | 401 | |
|
402 | 402 | magic_docs = [] |
|
403 | 403 | for fname in self.lsmagic(): |
|
404 | 404 | mname = 'magic_' + fname |
|
405 | 405 | for space in (Magic,self,self.__class__): |
|
406 | 406 | try: |
|
407 | 407 | fn = space.__dict__[mname] |
|
408 | 408 | except KeyError: |
|
409 | 409 | pass |
|
410 | 410 | else: |
|
411 | 411 | break |
|
412 | 412 | if mode == 'brief': |
|
413 | 413 | # only first line |
|
414 | 414 | if fn.__doc__: |
|
415 | 415 | fndoc = fn.__doc__.split('\n',1)[0] |
|
416 | 416 | else: |
|
417 | 417 | fndoc = 'No documentation' |
|
418 | 418 | else: |
|
419 | 419 | if fn.__doc__: |
|
420 | 420 | fndoc = fn.__doc__.rstrip() |
|
421 | 421 | else: |
|
422 | 422 | fndoc = 'No documentation' |
|
423 | 423 | |
|
424 | 424 | |
|
425 | 425 | if mode == 'rest': |
|
426 | 426 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(self.shell.ESC_MAGIC, |
|
427 | 427 | fname,fndoc)) |
|
428 | 428 | |
|
429 | 429 | else: |
|
430 | 430 | magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC, |
|
431 | 431 | fname,fndoc)) |
|
432 | 432 | |
|
433 | 433 | magic_docs = ''.join(magic_docs) |
|
434 | 434 | |
|
435 | 435 | if mode == 'rest': |
|
436 | 436 | return "".join(rest_docs) |
|
437 | 437 | |
|
438 | 438 | if mode == 'latex': |
|
439 | 439 | print self.format_latex(magic_docs) |
|
440 | 440 | return |
|
441 | 441 | else: |
|
442 | 442 | magic_docs = self.format_screen(magic_docs) |
|
443 | 443 | if mode == 'brief': |
|
444 | 444 | return magic_docs |
|
445 | 445 | |
|
446 | 446 | outmsg = """ |
|
447 | 447 | IPython's 'magic' functions |
|
448 | 448 | =========================== |
|
449 | 449 | |
|
450 | 450 | The magic function system provides a series of functions which allow you to |
|
451 | 451 | control the behavior of IPython itself, plus a lot of system-type |
|
452 | 452 | features. All these functions are prefixed with a % character, but parameters |
|
453 | 453 | are given without parentheses or quotes. |
|
454 | 454 | |
|
455 | 455 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
456 | 456 | %automagic function), you don't need to type in the % explicitly. By default, |
|
457 | 457 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
458 | 458 | |
|
459 | 459 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
460 | 460 | to 'mydir', if it exists. |
|
461 | 461 | |
|
462 | 462 | You can define your own magic functions to extend the system. See the supplied |
|
463 | 463 | ipythonrc and example-magic.py files for details (in your ipython |
|
464 | 464 | configuration directory, typically $HOME/.ipython/). |
|
465 | 465 | |
|
466 | 466 | You can also define your own aliased names for magic functions. In your |
|
467 | 467 | ipythonrc file, placing a line like: |
|
468 | 468 | |
|
469 | 469 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile |
|
470 | 470 | |
|
471 | 471 | will define %pf as a new name for %profile. |
|
472 | 472 | |
|
473 | 473 | You can also call magics in code using the ipmagic() function, which IPython |
|
474 | 474 | automatically adds to the builtin namespace. Type 'ipmagic?' for details. |
|
475 | 475 | |
|
476 | 476 | For a list of the available magic functions, use %lsmagic. For a description |
|
477 | 477 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
478 | 478 | |
|
479 | 479 | Currently the magic system has the following functions:\n""" |
|
480 | 480 | |
|
481 | 481 | mesc = self.shell.ESC_MAGIC |
|
482 | 482 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
483 | 483 | "\n\n%s%s\n\n%s" % (outmsg, |
|
484 | 484 | magic_docs,mesc,mesc, |
|
485 | 485 | (' '+mesc).join(self.lsmagic()), |
|
486 | 486 | Magic.auto_status[self.shell.rc.automagic] ) ) |
|
487 | 487 | |
|
488 | 488 | page(outmsg,screen_lines=self.shell.rc.screen_length) |
|
489 | 489 | |
|
490 | 490 | |
|
491 | 491 | def magic_autoindent(self, parameter_s = ''): |
|
492 | 492 | """Toggle autoindent on/off (if available).""" |
|
493 | 493 | |
|
494 | 494 | self.shell.set_autoindent() |
|
495 | 495 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
496 | 496 | |
|
497 | 497 | |
|
498 | 498 | def magic_automagic(self, parameter_s = ''): |
|
499 | 499 | """Make magic functions callable without having to type the initial %. |
|
500 | 500 | |
|
501 | 501 | Without argumentsl toggles on/off (when off, you must call it as |
|
502 | 502 | %automagic, of course). With arguments it sets the value, and you can |
|
503 | 503 | use any of (case insensitive): |
|
504 | 504 | |
|
505 | 505 | - on,1,True: to activate |
|
506 | 506 | |
|
507 | 507 | - off,0,False: to deactivate. |
|
508 | 508 | |
|
509 | 509 | Note that magic functions have lowest priority, so if there's a |
|
510 | 510 | variable whose name collides with that of a magic fn, automagic won't |
|
511 | 511 | work for that function (you get the variable instead). However, if you |
|
512 | 512 | delete the variable (del var), the previously shadowed magic function |
|
513 | 513 | becomes visible to automagic again.""" |
|
514 | 514 | |
|
515 | 515 | rc = self.shell.rc |
|
516 | 516 | arg = parameter_s.lower() |
|
517 | 517 | if parameter_s in ('on','1','true'): |
|
518 | 518 | rc.automagic = True |
|
519 | 519 | elif parameter_s in ('off','0','false'): |
|
520 | 520 | rc.automagic = False |
|
521 | 521 | else: |
|
522 | 522 | rc.automagic = not rc.automagic |
|
523 | 523 | print '\n' + Magic.auto_status[rc.automagic] |
|
524 | 524 | |
|
525 | 525 | @testdec.skip_doctest |
|
526 | 526 | def magic_autocall(self, parameter_s = ''): |
|
527 | 527 | """Make functions callable without having to type parentheses. |
|
528 | 528 | |
|
529 | 529 | Usage: |
|
530 | 530 | |
|
531 | 531 | %autocall [mode] |
|
532 | 532 | |
|
533 | 533 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the |
|
534 | 534 | value is toggled on and off (remembering the previous state). |
|
535 | 535 | |
|
536 | 536 | In more detail, these values mean: |
|
537 | 537 | |
|
538 | 538 | 0 -> fully disabled |
|
539 | 539 | |
|
540 | 540 | 1 -> active, but do not apply if there are no arguments on the line. |
|
541 | 541 | |
|
542 | 542 | In this mode, you get: |
|
543 | 543 | |
|
544 | 544 | In [1]: callable |
|
545 | 545 | Out[1]: <built-in function callable> |
|
546 | 546 | |
|
547 | 547 | In [2]: callable 'hello' |
|
548 | 548 | ------> callable('hello') |
|
549 | 549 | Out[2]: False |
|
550 | 550 | |
|
551 | 551 | 2 -> Active always. Even if no arguments are present, the callable |
|
552 | 552 | object is called: |
|
553 | 553 | |
|
554 | 554 | In [2]: float |
|
555 | 555 | ------> float() |
|
556 | 556 | Out[2]: 0.0 |
|
557 | 557 | |
|
558 | 558 | Note that even with autocall off, you can still use '/' at the start of |
|
559 | 559 | a line to treat the first argument on the command line as a function |
|
560 | 560 | and add parentheses to it: |
|
561 | 561 | |
|
562 | 562 | In [8]: /str 43 |
|
563 | 563 | ------> str(43) |
|
564 | 564 | Out[8]: '43' |
|
565 | 565 | |
|
566 | 566 | # all-random (note for auto-testing) |
|
567 | 567 | """ |
|
568 | 568 | |
|
569 | 569 | rc = self.shell.rc |
|
570 | 570 | |
|
571 | 571 | if parameter_s: |
|
572 | 572 | arg = int(parameter_s) |
|
573 | 573 | else: |
|
574 | 574 | arg = 'toggle' |
|
575 | 575 | |
|
576 | 576 | if not arg in (0,1,2,'toggle'): |
|
577 | 577 | error('Valid modes: (0->Off, 1->Smart, 2->Full') |
|
578 | 578 | return |
|
579 | 579 | |
|
580 | 580 | if arg in (0,1,2): |
|
581 | 581 | rc.autocall = arg |
|
582 | 582 | else: # toggle |
|
583 | 583 | if rc.autocall: |
|
584 | 584 | self._magic_state.autocall_save = rc.autocall |
|
585 | 585 | rc.autocall = 0 |
|
586 | 586 | else: |
|
587 | 587 | try: |
|
588 | 588 | rc.autocall = self._magic_state.autocall_save |
|
589 | 589 | except AttributeError: |
|
590 | 590 | rc.autocall = self._magic_state.autocall_save = 1 |
|
591 | 591 | |
|
592 | 592 | print "Automatic calling is:",['OFF','Smart','Full'][rc.autocall] |
|
593 | 593 | |
|
594 | 594 | def magic_system_verbose(self, parameter_s = ''): |
|
595 | 595 | """Set verbose printing of system calls. |
|
596 | 596 | |
|
597 | 597 | If called without an argument, act as a toggle""" |
|
598 | 598 | |
|
599 | 599 | if parameter_s: |
|
600 | 600 | val = bool(eval(parameter_s)) |
|
601 | 601 | else: |
|
602 | 602 | val = None |
|
603 | 603 | |
|
604 | 604 | self.shell.rc_set_toggle('system_verbose',val) |
|
605 | 605 | print "System verbose printing is:",\ |
|
606 | 606 | ['OFF','ON'][self.shell.rc.system_verbose] |
|
607 | 607 | |
|
608 | 608 | |
|
609 | 609 | def magic_page(self, parameter_s=''): |
|
610 | 610 | """Pretty print the object and display it through a pager. |
|
611 | 611 | |
|
612 | 612 | %page [options] OBJECT |
|
613 | 613 | |
|
614 | 614 | If no object is given, use _ (last output). |
|
615 | 615 | |
|
616 | 616 | Options: |
|
617 | 617 | |
|
618 | 618 | -r: page str(object), don't pretty-print it.""" |
|
619 | 619 | |
|
620 | 620 | # After a function contributed by Olivier Aubert, slightly modified. |
|
621 | 621 | |
|
622 | 622 | # Process options/args |
|
623 | 623 | opts,args = self.parse_options(parameter_s,'r') |
|
624 | 624 | raw = 'r' in opts |
|
625 | 625 | |
|
626 | 626 | oname = args and args or '_' |
|
627 | 627 | info = self._ofind(oname) |
|
628 | 628 | if info['found']: |
|
629 | 629 | txt = (raw and str or pformat)( info['obj'] ) |
|
630 | 630 | page(txt) |
|
631 | 631 | else: |
|
632 | 632 | print 'Object `%s` not found' % oname |
|
633 | 633 | |
|
634 | 634 | def magic_profile(self, parameter_s=''): |
|
635 | 635 | """Print your currently active IPyhton profile.""" |
|
636 | 636 | if self.shell.rc.profile: |
|
637 | 637 | printpl('Current IPython profile: $self.shell.rc.profile.') |
|
638 | 638 | else: |
|
639 | 639 | print 'No profile active.' |
|
640 | 640 | |
|
641 | 641 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
642 | 642 | """Provide detailed information about an object. |
|
643 | 643 | |
|
644 | 644 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
645 | 645 | |
|
646 | 646 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
647 | 647 | |
|
648 | 648 | |
|
649 | 649 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
650 | 650 | detail_level = 0 |
|
651 | 651 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
652 | 652 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
653 | 653 | pinfo,qmark1,oname,qmark2 = \ |
|
654 | 654 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
655 | 655 | if pinfo or qmark1 or qmark2: |
|
656 | 656 | detail_level = 1 |
|
657 | 657 | if "*" in oname: |
|
658 | 658 | self.magic_psearch(oname) |
|
659 | 659 | else: |
|
660 | 660 | self._inspect('pinfo', oname, detail_level=detail_level, |
|
661 | 661 | namespaces=namespaces) |
|
662 | 662 | |
|
663 | 663 | def magic_pdef(self, parameter_s='', namespaces=None): |
|
664 | 664 | """Print the definition header for any callable object. |
|
665 | 665 | |
|
666 | 666 | If the object is a class, print the constructor information.""" |
|
667 | 667 | self._inspect('pdef',parameter_s, namespaces) |
|
668 | 668 | |
|
669 | 669 | def magic_pdoc(self, parameter_s='', namespaces=None): |
|
670 | 670 | """Print the docstring for an object. |
|
671 | 671 | |
|
672 | 672 | If the given object is a class, it will print both the class and the |
|
673 | 673 | constructor docstrings.""" |
|
674 | 674 | self._inspect('pdoc',parameter_s, namespaces) |
|
675 | 675 | |
|
676 | 676 | def magic_psource(self, parameter_s='', namespaces=None): |
|
677 | 677 | """Print (or run through pager) the source code for an object.""" |
|
678 | 678 | self._inspect('psource',parameter_s, namespaces) |
|
679 | 679 | |
|
680 | 680 | def magic_pfile(self, parameter_s=''): |
|
681 | 681 | """Print (or run through pager) the file where an object is defined. |
|
682 | 682 | |
|
683 | 683 | The file opens at the line where the object definition begins. IPython |
|
684 | 684 | will honor the environment variable PAGER if set, and otherwise will |
|
685 | 685 | do its best to print the file in a convenient form. |
|
686 | 686 | |
|
687 | 687 | If the given argument is not an object currently defined, IPython will |
|
688 | 688 | try to interpret it as a filename (automatically adding a .py extension |
|
689 | 689 | if needed). You can thus use %pfile as a syntax highlighting code |
|
690 | 690 | viewer.""" |
|
691 | 691 | |
|
692 | 692 | # first interpret argument as an object name |
|
693 | 693 | out = self._inspect('pfile',parameter_s) |
|
694 | 694 | # if not, try the input as a filename |
|
695 | 695 | if out == 'not found': |
|
696 | 696 | try: |
|
697 | 697 | filename = get_py_filename(parameter_s) |
|
698 | 698 | except IOError,msg: |
|
699 | 699 | print msg |
|
700 | 700 | return |
|
701 | 701 | page(self.shell.inspector.format(file(filename).read())) |
|
702 | 702 | |
|
703 | 703 | def _inspect(self,meth,oname,namespaces=None,**kw): |
|
704 | 704 | """Generic interface to the inspector system. |
|
705 | 705 | |
|
706 | 706 | This function is meant to be called by pdef, pdoc & friends.""" |
|
707 | 707 | |
|
708 | 708 | #oname = oname.strip() |
|
709 | 709 | #print '1- oname: <%r>' % oname # dbg |
|
710 | 710 | try: |
|
711 | 711 | oname = oname.strip().encode('ascii') |
|
712 | 712 | #print '2- oname: <%r>' % oname # dbg |
|
713 | 713 | except UnicodeEncodeError: |
|
714 | 714 | print 'Python identifiers can only contain ascii characters.' |
|
715 | 715 | return 'not found' |
|
716 | 716 | |
|
717 | 717 | info = Struct(self._ofind(oname, namespaces)) |
|
718 | 718 | |
|
719 | 719 | if info.found: |
|
720 | 720 | try: |
|
721 | 721 | IPython.utils.generics.inspect_object(info.obj) |
|
722 | 722 | return |
|
723 | 723 | except ipapi.TryNext: |
|
724 | 724 | pass |
|
725 | 725 | # Get the docstring of the class property if it exists. |
|
726 | 726 | path = oname.split('.') |
|
727 | 727 | root = '.'.join(path[:-1]) |
|
728 | 728 | if info.parent is not None: |
|
729 | 729 | try: |
|
730 | 730 | target = getattr(info.parent, '__class__') |
|
731 | 731 | # The object belongs to a class instance. |
|
732 | 732 | try: |
|
733 | 733 | target = getattr(target, path[-1]) |
|
734 | 734 | # The class defines the object. |
|
735 | 735 | if isinstance(target, property): |
|
736 | 736 | oname = root + '.__class__.' + path[-1] |
|
737 | 737 | info = Struct(self._ofind(oname)) |
|
738 | 738 | except AttributeError: pass |
|
739 | 739 | except AttributeError: pass |
|
740 | 740 | |
|
741 | 741 | pmethod = getattr(self.shell.inspector,meth) |
|
742 | 742 | formatter = info.ismagic and self.format_screen or None |
|
743 | 743 | if meth == 'pdoc': |
|
744 | 744 | pmethod(info.obj,oname,formatter) |
|
745 | 745 | elif meth == 'pinfo': |
|
746 | 746 | pmethod(info.obj,oname,formatter,info,**kw) |
|
747 | 747 | else: |
|
748 | 748 | pmethod(info.obj,oname) |
|
749 | 749 | else: |
|
750 | 750 | print 'Object `%s` not found.' % oname |
|
751 | 751 | return 'not found' # so callers can take other action |
|
752 | 752 | |
|
753 | 753 | def magic_psearch(self, parameter_s=''): |
|
754 | 754 | """Search for object in namespaces by wildcard. |
|
755 | 755 | |
|
756 | 756 | %psearch [options] PATTERN [OBJECT TYPE] |
|
757 | 757 | |
|
758 | 758 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
759 | 759 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
760 | 760 | rest of the command line must be unchanged (options come first), so |
|
761 | 761 | for example the following forms are equivalent |
|
762 | 762 | |
|
763 | 763 | %psearch -i a* function |
|
764 | 764 | -i a* function? |
|
765 | 765 | ?-i a* function |
|
766 | 766 | |
|
767 | 767 | Arguments: |
|
768 | 768 | |
|
769 | 769 | PATTERN |
|
770 | 770 | |
|
771 | 771 | where PATTERN is a string containing * as a wildcard similar to its |
|
772 | 772 | use in a shell. The pattern is matched in all namespaces on the |
|
773 | 773 | search path. By default objects starting with a single _ are not |
|
774 | 774 | matched, many IPython generated objects have a single |
|
775 | 775 | underscore. The default is case insensitive matching. Matching is |
|
776 | 776 | also done on the attributes of objects and not only on the objects |
|
777 | 777 | in a module. |
|
778 | 778 | |
|
779 | 779 | [OBJECT TYPE] |
|
780 | 780 | |
|
781 | 781 | Is the name of a python type from the types module. The name is |
|
782 | 782 | given in lowercase without the ending type, ex. StringType is |
|
783 | 783 | written string. By adding a type here only objects matching the |
|
784 | 784 | given type are matched. Using all here makes the pattern match all |
|
785 | 785 | types (this is the default). |
|
786 | 786 | |
|
787 | 787 | Options: |
|
788 | 788 | |
|
789 | 789 | -a: makes the pattern match even objects whose names start with a |
|
790 | 790 | single underscore. These names are normally ommitted from the |
|
791 | 791 | search. |
|
792 | 792 | |
|
793 | 793 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
794 | 794 | these options is given, the default is read from your ipythonrc |
|
795 | 795 | file. The option name which sets this value is |
|
796 | 796 | 'wildcards_case_sensitive'. If this option is not specified in your |
|
797 | 797 | ipythonrc file, IPython's internal default is to do a case sensitive |
|
798 | 798 | search. |
|
799 | 799 | |
|
800 | 800 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
801 | 801 | specifiy can be searched in any of the following namespaces: |
|
802 | 802 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
803 | 803 | 'builtin' and 'user' are the search defaults. Note that you should |
|
804 | 804 | not use quotes when specifying namespaces. |
|
805 | 805 | |
|
806 | 806 | 'Builtin' contains the python module builtin, 'user' contains all |
|
807 | 807 | user data, 'alias' only contain the shell aliases and no python |
|
808 | 808 | objects, 'internal' contains objects used by IPython. The |
|
809 | 809 | 'user_global' namespace is only used by embedded IPython instances, |
|
810 | 810 | and it contains module-level globals. You can add namespaces to the |
|
811 | 811 | search with -s or exclude them with -e (these options can be given |
|
812 | 812 | more than once). |
|
813 | 813 | |
|
814 | 814 | Examples: |
|
815 | 815 | |
|
816 | 816 | %psearch a* -> objects beginning with an a |
|
817 | 817 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
818 | 818 | %psearch a* function -> all functions beginning with an a |
|
819 | 819 | %psearch re.e* -> objects beginning with an e in module re |
|
820 | 820 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
821 | 821 | %psearch r*.* string -> all strings in modules beginning with r |
|
822 | 822 | |
|
823 | 823 | Case sensitve search: |
|
824 | 824 | |
|
825 | 825 | %psearch -c a* list all object beginning with lower case a |
|
826 | 826 | |
|
827 | 827 | Show objects beginning with a single _: |
|
828 | 828 | |
|
829 | 829 | %psearch -a _* list objects beginning with a single underscore""" |
|
830 | 830 | try: |
|
831 | 831 | parameter_s = parameter_s.encode('ascii') |
|
832 | 832 | except UnicodeEncodeError: |
|
833 | 833 | print 'Python identifiers can only contain ascii characters.' |
|
834 | 834 | return |
|
835 | 835 | |
|
836 | 836 | # default namespaces to be searched |
|
837 | 837 | def_search = ['user','builtin'] |
|
838 | 838 | |
|
839 | 839 | # Process options/args |
|
840 | 840 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
841 | 841 | opt = opts.get |
|
842 | 842 | shell = self.shell |
|
843 | 843 | psearch = shell.inspector.psearch |
|
844 | 844 | |
|
845 | 845 | # select case options |
|
846 | 846 | if opts.has_key('i'): |
|
847 | 847 | ignore_case = True |
|
848 | 848 | elif opts.has_key('c'): |
|
849 | 849 | ignore_case = False |
|
850 | 850 | else: |
|
851 | 851 | ignore_case = not shell.rc.wildcards_case_sensitive |
|
852 | 852 | |
|
853 | 853 | # Build list of namespaces to search from user options |
|
854 | 854 | def_search.extend(opt('s',[])) |
|
855 | 855 | ns_exclude = ns_exclude=opt('e',[]) |
|
856 | 856 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
857 | 857 | |
|
858 | 858 | # Call the actual search |
|
859 | 859 | try: |
|
860 | 860 | psearch(args,shell.ns_table,ns_search, |
|
861 | 861 | show_all=opt('a'),ignore_case=ignore_case) |
|
862 | 862 | except: |
|
863 | 863 | shell.showtraceback() |
|
864 | 864 | |
|
865 | 865 | def magic_who_ls(self, parameter_s=''): |
|
866 | 866 | """Return a sorted list of all interactive variables. |
|
867 | 867 | |
|
868 | 868 | If arguments are given, only variables of types matching these |
|
869 | 869 | arguments are returned.""" |
|
870 | 870 | |
|
871 | 871 | user_ns = self.shell.user_ns |
|
872 | 872 | internal_ns = self.shell.internal_ns |
|
873 | 873 | user_config_ns = self.shell.user_config_ns |
|
874 | 874 | out = [] |
|
875 | 875 | typelist = parameter_s.split() |
|
876 | 876 | |
|
877 | 877 | for i in user_ns: |
|
878 | 878 | if not (i.startswith('_') or i.startswith('_i')) \ |
|
879 | 879 | and not (i in internal_ns or i in user_config_ns): |
|
880 | 880 | if typelist: |
|
881 | 881 | if type(user_ns[i]).__name__ in typelist: |
|
882 | 882 | out.append(i) |
|
883 | 883 | else: |
|
884 | 884 | out.append(i) |
|
885 | 885 | out.sort() |
|
886 | 886 | return out |
|
887 | 887 | |
|
888 | 888 | def magic_who(self, parameter_s=''): |
|
889 | 889 | """Print all interactive variables, with some minimal formatting. |
|
890 | 890 | |
|
891 | 891 | If any arguments are given, only variables whose type matches one of |
|
892 | 892 | these are printed. For example: |
|
893 | 893 | |
|
894 | 894 | %who function str |
|
895 | 895 | |
|
896 | 896 | will only list functions and strings, excluding all other types of |
|
897 | 897 | variables. To find the proper type names, simply use type(var) at a |
|
898 | 898 | command line to see how python prints type names. For example: |
|
899 | 899 | |
|
900 | 900 | In [1]: type('hello')\\ |
|
901 | 901 | Out[1]: <type 'str'> |
|
902 | 902 | |
|
903 | 903 | indicates that the type name for strings is 'str'. |
|
904 | 904 | |
|
905 | 905 | %who always excludes executed names loaded through your configuration |
|
906 | 906 | file and things which are internal to IPython. |
|
907 | 907 | |
|
908 | 908 | This is deliberate, as typically you may load many modules and the |
|
909 | 909 | purpose of %who is to show you only what you've manually defined.""" |
|
910 | 910 | |
|
911 | 911 | varlist = self.magic_who_ls(parameter_s) |
|
912 | 912 | if not varlist: |
|
913 | 913 | if parameter_s: |
|
914 | 914 | print 'No variables match your requested type.' |
|
915 | 915 | else: |
|
916 | 916 | print 'Interactive namespace is empty.' |
|
917 | 917 | return |
|
918 | 918 | |
|
919 | 919 | # if we have variables, move on... |
|
920 | 920 | count = 0 |
|
921 | 921 | for i in varlist: |
|
922 | 922 | print i+'\t', |
|
923 | 923 | count += 1 |
|
924 | 924 | if count > 8: |
|
925 | 925 | count = 0 |
|
926 | 926 | |
|
927 | 927 | |
|
928 | 928 | |
|
929 | 929 | def magic_whos(self, parameter_s=''): |
|
930 | 930 | """Like %who, but gives some extra information about each variable. |
|
931 | 931 | |
|
932 | 932 | The same type filtering of %who can be applied here. |
|
933 | 933 | |
|
934 | 934 | For all variables, the type is printed. Additionally it prints: |
|
935 | 935 | |
|
936 | 936 | - For {},[],(): their length. |
|
937 | 937 | |
|
938 | 938 | - For numpy and Numeric arrays, a summary with shape, number of |
|
939 | 939 | elements, typecode and size in memory. |
|
940 | 940 | |
|
941 | 941 | - Everything else: a string representation, snipping their middle if |
|
942 | 942 | too long.""" |
|
943 | 943 | |
|
944 | 944 | varnames = self.magic_who_ls(parameter_s) |
|
945 | 945 | if not varnames: |
|
946 | 946 | if parameter_s: |
|
947 | 947 | print 'No variables match your requested type.' |
|
948 | 948 | else: |
|
949 | 949 | print 'Interactive namespace is empty.' |
|
950 | 950 | return |
|
951 | 951 | |
|
952 | 952 | # if we have variables, move on... |
|
953 | 953 | |
|
954 | 954 | # for these types, show len() instead of data: |
|
955 | 955 | seq_types = [types.DictType,types.ListType,types.TupleType] |
|
956 | 956 | |
|
957 | 957 | # for numpy/Numeric arrays, display summary info |
|
958 | 958 | try: |
|
959 | 959 | import numpy |
|
960 | 960 | except ImportError: |
|
961 | 961 | ndarray_type = None |
|
962 | 962 | else: |
|
963 | 963 | ndarray_type = numpy.ndarray.__name__ |
|
964 | 964 | try: |
|
965 | 965 | import Numeric |
|
966 | 966 | except ImportError: |
|
967 | 967 | array_type = None |
|
968 | 968 | else: |
|
969 | 969 | array_type = Numeric.ArrayType.__name__ |
|
970 | 970 | |
|
971 | 971 | # Find all variable names and types so we can figure out column sizes |
|
972 | 972 | def get_vars(i): |
|
973 | 973 | return self.shell.user_ns[i] |
|
974 | 974 | |
|
975 | 975 | # some types are well known and can be shorter |
|
976 | 976 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} |
|
977 | 977 | def type_name(v): |
|
978 | 978 | tn = type(v).__name__ |
|
979 | 979 | return abbrevs.get(tn,tn) |
|
980 | 980 | |
|
981 | 981 | varlist = map(get_vars,varnames) |
|
982 | 982 | |
|
983 | 983 | typelist = [] |
|
984 | 984 | for vv in varlist: |
|
985 | 985 | tt = type_name(vv) |
|
986 | 986 | |
|
987 | 987 | if tt=='instance': |
|
988 | 988 | typelist.append( abbrevs.get(str(vv.__class__), |
|
989 | 989 | str(vv.__class__))) |
|
990 | 990 | else: |
|
991 | 991 | typelist.append(tt) |
|
992 | 992 | |
|
993 | 993 | # column labels and # of spaces as separator |
|
994 | 994 | varlabel = 'Variable' |
|
995 | 995 | typelabel = 'Type' |
|
996 | 996 | datalabel = 'Data/Info' |
|
997 | 997 | colsep = 3 |
|
998 | 998 | # variable format strings |
|
999 | 999 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" |
|
1000 | 1000 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' |
|
1001 | 1001 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
1002 | 1002 | # find the size of the columns to format the output nicely |
|
1003 | 1003 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
1004 | 1004 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
1005 | 1005 | # table header |
|
1006 | 1006 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
1007 | 1007 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
1008 | 1008 | # and the table itself |
|
1009 | 1009 | kb = 1024 |
|
1010 | 1010 | Mb = 1048576 # kb**2 |
|
1011 | 1011 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
1012 | 1012 | print itpl(vformat), |
|
1013 | 1013 | if vtype in seq_types: |
|
1014 | 1014 | print len(var) |
|
1015 | 1015 | elif vtype in [array_type,ndarray_type]: |
|
1016 | 1016 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
1017 | 1017 | if vtype==ndarray_type: |
|
1018 | 1018 | # numpy |
|
1019 | 1019 | vsize = var.size |
|
1020 | 1020 | vbytes = vsize*var.itemsize |
|
1021 | 1021 | vdtype = var.dtype |
|
1022 | 1022 | else: |
|
1023 | 1023 | # Numeric |
|
1024 | 1024 | vsize = Numeric.size(var) |
|
1025 | 1025 | vbytes = vsize*var.itemsize() |
|
1026 | 1026 | vdtype = var.typecode() |
|
1027 | 1027 | |
|
1028 | 1028 | if vbytes < 100000: |
|
1029 | 1029 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
1030 | 1030 | else: |
|
1031 | 1031 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
1032 | 1032 | if vbytes < Mb: |
|
1033 | 1033 | print '(%s kb)' % (vbytes/kb,) |
|
1034 | 1034 | else: |
|
1035 | 1035 | print '(%s Mb)' % (vbytes/Mb,) |
|
1036 | 1036 | else: |
|
1037 | 1037 | try: |
|
1038 | 1038 | vstr = str(var) |
|
1039 | 1039 | except UnicodeEncodeError: |
|
1040 | 1040 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
1041 | 1041 | 'backslashreplace') |
|
1042 | 1042 | vstr = vstr.replace('\n','\\n') |
|
1043 | 1043 | if len(vstr) < 50: |
|
1044 | 1044 | print vstr |
|
1045 | 1045 | else: |
|
1046 | 1046 | printpl(vfmt_short) |
|
1047 | 1047 | |
|
1048 | 1048 | def magic_reset(self, parameter_s=''): |
|
1049 | 1049 | """Resets the namespace by removing all names defined by the user. |
|
1050 | 1050 | |
|
1051 | 1051 | Input/Output history are left around in case you need them. |
|
1052 | 1052 | |
|
1053 | 1053 | Parameters |
|
1054 | 1054 | ---------- |
|
1055 | 1055 | -y : force reset without asking for confirmation. |
|
1056 | 1056 | |
|
1057 | 1057 | Examples |
|
1058 | 1058 | -------- |
|
1059 | 1059 | In [6]: a = 1 |
|
1060 | 1060 | |
|
1061 | 1061 | In [7]: a |
|
1062 | 1062 | Out[7]: 1 |
|
1063 | 1063 | |
|
1064 | 1064 | In [8]: 'a' in _ip.user_ns |
|
1065 | 1065 | Out[8]: True |
|
1066 | 1066 | |
|
1067 | 1067 | In [9]: %reset -f |
|
1068 | 1068 | |
|
1069 | 1069 | In [10]: 'a' in _ip.user_ns |
|
1070 | 1070 | Out[10]: False |
|
1071 | 1071 | """ |
|
1072 | 1072 | |
|
1073 | 1073 | if parameter_s == '-f': |
|
1074 | 1074 | ans = True |
|
1075 | 1075 | else: |
|
1076 | 1076 | ans = self.shell.ask_yes_no( |
|
1077 | 1077 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
1078 | 1078 | if not ans: |
|
1079 | 1079 | print 'Nothing done.' |
|
1080 | 1080 | return |
|
1081 | 1081 | user_ns = self.shell.user_ns |
|
1082 | 1082 | for i in self.magic_who_ls(): |
|
1083 | 1083 | del(user_ns[i]) |
|
1084 | 1084 | |
|
1085 | 1085 | # Also flush the private list of module references kept for script |
|
1086 | 1086 | # execution protection |
|
1087 | 1087 | self.shell.clear_main_mod_cache() |
|
1088 | 1088 | |
|
1089 | 1089 | def magic_logstart(self,parameter_s=''): |
|
1090 | 1090 | """Start logging anywhere in a session. |
|
1091 | 1091 | |
|
1092 | 1092 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
1093 | 1093 | |
|
1094 | 1094 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
1095 | 1095 | current directory, in 'rotate' mode (see below). |
|
1096 | 1096 | |
|
1097 | 1097 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
1098 | 1098 | history up to that point and then continues logging. |
|
1099 | 1099 | |
|
1100 | 1100 | %logstart takes a second optional parameter: logging mode. This can be one |
|
1101 | 1101 | of (note that the modes are given unquoted):\\ |
|
1102 | 1102 | append: well, that says it.\\ |
|
1103 | 1103 | backup: rename (if exists) to name~ and start name.\\ |
|
1104 | 1104 | global: single logfile in your home dir, appended to.\\ |
|
1105 | 1105 | over : overwrite existing log.\\ |
|
1106 | 1106 | rotate: create rotating logs name.1~, name.2~, etc. |
|
1107 | 1107 | |
|
1108 | 1108 | Options: |
|
1109 | 1109 | |
|
1110 | 1110 | -o: log also IPython's output. In this mode, all commands which |
|
1111 | 1111 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
1112 | 1112 | their corresponding input line. The output lines are always |
|
1113 | 1113 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
1114 | 1114 | Python code. |
|
1115 | 1115 | |
|
1116 | 1116 | Since this marker is always the same, filtering only the output from |
|
1117 | 1117 | a log is very easy, using for example a simple awk call: |
|
1118 | 1118 | |
|
1119 | 1119 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
1120 | 1120 | |
|
1121 | 1121 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
1122 | 1122 | input, so that user lines are logged in their final form, converted |
|
1123 | 1123 | into valid Python. For example, %Exit is logged as |
|
1124 | 1124 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
1125 | 1125 | exactly as typed, with no transformations applied. |
|
1126 | 1126 | |
|
1127 | 1127 | -t: put timestamps before each input line logged (these are put in |
|
1128 | 1128 | comments).""" |
|
1129 | 1129 | |
|
1130 | 1130 | opts,par = self.parse_options(parameter_s,'ort') |
|
1131 | 1131 | log_output = 'o' in opts |
|
1132 | 1132 | log_raw_input = 'r' in opts |
|
1133 | 1133 | timestamp = 't' in opts |
|
1134 | 1134 | |
|
1135 | 1135 | rc = self.shell.rc |
|
1136 | 1136 | logger = self.shell.logger |
|
1137 | 1137 | |
|
1138 | 1138 | # if no args are given, the defaults set in the logger constructor by |
|
1139 | 1139 | # ipytohn remain valid |
|
1140 | 1140 | if par: |
|
1141 | 1141 | try: |
|
1142 | 1142 | logfname,logmode = par.split() |
|
1143 | 1143 | except: |
|
1144 | 1144 | logfname = par |
|
1145 | 1145 | logmode = 'backup' |
|
1146 | 1146 | else: |
|
1147 | 1147 | logfname = logger.logfname |
|
1148 | 1148 | logmode = logger.logmode |
|
1149 | 1149 | # put logfname into rc struct as if it had been called on the command |
|
1150 | 1150 | # line, so it ends up saved in the log header Save it in case we need |
|
1151 | 1151 | # to restore it... |
|
1152 | 1152 | old_logfile = rc.opts.get('logfile','') |
|
1153 | 1153 | if logfname: |
|
1154 | 1154 | logfname = os.path.expanduser(logfname) |
|
1155 | 1155 | rc.opts.logfile = logfname |
|
1156 | 1156 | loghead = self.shell.loghead_tpl % (rc.opts,rc.args) |
|
1157 | 1157 | try: |
|
1158 | 1158 | started = logger.logstart(logfname,loghead,logmode, |
|
1159 | 1159 | log_output,timestamp,log_raw_input) |
|
1160 | 1160 | except: |
|
1161 | 1161 | rc.opts.logfile = old_logfile |
|
1162 | 1162 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1163 | 1163 | else: |
|
1164 | 1164 | # log input history up to this point, optionally interleaving |
|
1165 | 1165 | # output if requested |
|
1166 | 1166 | |
|
1167 | 1167 | if timestamp: |
|
1168 | 1168 | # disable timestamping for the previous history, since we've |
|
1169 | 1169 | # lost those already (no time machine here). |
|
1170 | 1170 | logger.timestamp = False |
|
1171 | 1171 | |
|
1172 | 1172 | if log_raw_input: |
|
1173 | 1173 | input_hist = self.shell.input_hist_raw |
|
1174 | 1174 | else: |
|
1175 | 1175 | input_hist = self.shell.input_hist |
|
1176 | 1176 | |
|
1177 | 1177 | if log_output: |
|
1178 | 1178 | log_write = logger.log_write |
|
1179 | 1179 | output_hist = self.shell.output_hist |
|
1180 | 1180 | for n in range(1,len(input_hist)-1): |
|
1181 | 1181 | log_write(input_hist[n].rstrip()) |
|
1182 | 1182 | if n in output_hist: |
|
1183 | 1183 | log_write(repr(output_hist[n]),'output') |
|
1184 | 1184 | else: |
|
1185 | 1185 | logger.log_write(input_hist[1:]) |
|
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 | |
|
1270 | 1270 | self.shell.debugger(force=True) |
|
1271 | 1271 | |
|
1272 | 1272 | @testdec.skip_doctest |
|
1273 | 1273 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1274 | 1274 | opts=None,arg_lst=None,prog_ns=None): |
|
1275 | 1275 | |
|
1276 | 1276 | """Run a statement through the python code profiler. |
|
1277 | 1277 | |
|
1278 | 1278 | Usage: |
|
1279 | 1279 | %prun [options] statement |
|
1280 | 1280 | |
|
1281 | 1281 | The given statement (which doesn't require quote marks) is run via the |
|
1282 | 1282 | python profiler in a manner similar to the profile.run() function. |
|
1283 | 1283 | Namespaces are internally managed to work correctly; profile.run |
|
1284 | 1284 | cannot be used in IPython because it makes certain assumptions about |
|
1285 | 1285 | namespaces which do not hold under IPython. |
|
1286 | 1286 | |
|
1287 | 1287 | Options: |
|
1288 | 1288 | |
|
1289 | 1289 | -l <limit>: you can place restrictions on what or how much of the |
|
1290 | 1290 | profile gets printed. The limit value can be: |
|
1291 | 1291 | |
|
1292 | 1292 | * A string: only information for function names containing this string |
|
1293 | 1293 | is printed. |
|
1294 | 1294 | |
|
1295 | 1295 | * An integer: only these many lines are printed. |
|
1296 | 1296 | |
|
1297 | 1297 | * A float (between 0 and 1): this fraction of the report is printed |
|
1298 | 1298 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1299 | 1299 | |
|
1300 | 1300 | You can combine several limits with repeated use of the option. For |
|
1301 | 1301 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1302 | 1302 | information about class constructors. |
|
1303 | 1303 | |
|
1304 | 1304 | -r: return the pstats.Stats object generated by the profiling. This |
|
1305 | 1305 | object has all the information about the profile in it, and you can |
|
1306 | 1306 | later use it for further analysis or in other functions. |
|
1307 | 1307 | |
|
1308 | 1308 | -s <key>: sort profile by given key. You can provide more than one key |
|
1309 | 1309 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1310 | 1310 | default sorting key is 'time'. |
|
1311 | 1311 | |
|
1312 | 1312 | The following is copied verbatim from the profile documentation |
|
1313 | 1313 | referenced below: |
|
1314 | 1314 | |
|
1315 | 1315 | When more than one key is provided, additional keys are used as |
|
1316 | 1316 | secondary criteria when the there is equality in all keys selected |
|
1317 | 1317 | before them. |
|
1318 | 1318 | |
|
1319 | 1319 | Abbreviations can be used for any key names, as long as the |
|
1320 | 1320 | abbreviation is unambiguous. The following are the keys currently |
|
1321 | 1321 | defined: |
|
1322 | 1322 | |
|
1323 | 1323 | Valid Arg Meaning |
|
1324 | 1324 | "calls" call count |
|
1325 | 1325 | "cumulative" cumulative time |
|
1326 | 1326 | "file" file name |
|
1327 | 1327 | "module" file name |
|
1328 | 1328 | "pcalls" primitive call count |
|
1329 | 1329 | "line" line number |
|
1330 | 1330 | "name" function name |
|
1331 | 1331 | "nfl" name/file/line |
|
1332 | 1332 | "stdname" standard name |
|
1333 | 1333 | "time" internal time |
|
1334 | 1334 | |
|
1335 | 1335 | Note that all sorts on statistics are in descending order (placing |
|
1336 | 1336 | most time consuming items first), where as name, file, and line number |
|
1337 | 1337 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1338 | 1338 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1339 | 1339 | sort of the name as printed, which means that the embedded line |
|
1340 | 1340 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1341 | 1341 | would (if the file names were the same) appear in the string order |
|
1342 | 1342 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1343 | 1343 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1344 | 1344 | sort_stats("name", "file", "line"). |
|
1345 | 1345 | |
|
1346 | 1346 | -T <filename>: save profile results as shown on screen to a text |
|
1347 | 1347 | file. The profile is still shown on screen. |
|
1348 | 1348 | |
|
1349 | 1349 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1350 | 1350 | filename. This data is in a format understod by the pstats module, and |
|
1351 | 1351 | is generated by a call to the dump_stats() method of profile |
|
1352 | 1352 | objects. The profile is still shown on screen. |
|
1353 | 1353 | |
|
1354 | 1354 | If you want to run complete programs under the profiler's control, use |
|
1355 | 1355 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1356 | 1356 | contains profiler specific options as described here. |
|
1357 | 1357 | |
|
1358 | 1358 | You can read the complete documentation for the profile module with:: |
|
1359 | 1359 | |
|
1360 | 1360 | In [1]: import profile; profile.help() |
|
1361 | 1361 | """ |
|
1362 | 1362 | |
|
1363 | 1363 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1364 | 1364 | # protect user quote marks |
|
1365 | 1365 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1366 | 1366 | |
|
1367 | 1367 | if user_mode: # regular user call |
|
1368 | 1368 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1369 | 1369 | list_all=1) |
|
1370 | 1370 | namespace = self.shell.user_ns |
|
1371 | 1371 | else: # called to run a program by %run -p |
|
1372 | 1372 | try: |
|
1373 | 1373 | filename = get_py_filename(arg_lst[0]) |
|
1374 | 1374 | except IOError,msg: |
|
1375 | 1375 | error(msg) |
|
1376 | 1376 | return |
|
1377 | 1377 | |
|
1378 | 1378 | arg_str = 'execfile(filename,prog_ns)' |
|
1379 | 1379 | namespace = locals() |
|
1380 | 1380 | |
|
1381 | 1381 | opts.merge(opts_def) |
|
1382 | 1382 | |
|
1383 | 1383 | prof = profile.Profile() |
|
1384 | 1384 | try: |
|
1385 | 1385 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1386 | 1386 | sys_exit = '' |
|
1387 | 1387 | except SystemExit: |
|
1388 | 1388 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1389 | 1389 | |
|
1390 | 1390 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1391 | 1391 | |
|
1392 | 1392 | lims = opts.l |
|
1393 | 1393 | if lims: |
|
1394 | 1394 | lims = [] # rebuild lims with ints/floats/strings |
|
1395 | 1395 | for lim in opts.l: |
|
1396 | 1396 | try: |
|
1397 | 1397 | lims.append(int(lim)) |
|
1398 | 1398 | except ValueError: |
|
1399 | 1399 | try: |
|
1400 | 1400 | lims.append(float(lim)) |
|
1401 | 1401 | except ValueError: |
|
1402 | 1402 | lims.append(lim) |
|
1403 | 1403 | |
|
1404 | 1404 | # Trap output. |
|
1405 | 1405 | stdout_trap = StringIO() |
|
1406 | 1406 | |
|
1407 | 1407 | if hasattr(stats,'stream'): |
|
1408 | 1408 | # In newer versions of python, the stats object has a 'stream' |
|
1409 | 1409 | # attribute to write into. |
|
1410 | 1410 | stats.stream = stdout_trap |
|
1411 | 1411 | stats.print_stats(*lims) |
|
1412 | 1412 | else: |
|
1413 | 1413 | # For older versions, we manually redirect stdout during printing |
|
1414 | 1414 | sys_stdout = sys.stdout |
|
1415 | 1415 | try: |
|
1416 | 1416 | sys.stdout = stdout_trap |
|
1417 | 1417 | stats.print_stats(*lims) |
|
1418 | 1418 | finally: |
|
1419 | 1419 | sys.stdout = sys_stdout |
|
1420 | 1420 | |
|
1421 | 1421 | output = stdout_trap.getvalue() |
|
1422 | 1422 | output = output.rstrip() |
|
1423 | 1423 | |
|
1424 | 1424 | page(output,screen_lines=self.shell.rc.screen_length) |
|
1425 | 1425 | print sys_exit, |
|
1426 | 1426 | |
|
1427 | 1427 | dump_file = opts.D[0] |
|
1428 | 1428 | text_file = opts.T[0] |
|
1429 | 1429 | if dump_file: |
|
1430 | 1430 | prof.dump_stats(dump_file) |
|
1431 | 1431 | print '\n*** Profile stats marshalled to file',\ |
|
1432 | 1432 | `dump_file`+'.',sys_exit |
|
1433 | 1433 | if text_file: |
|
1434 | 1434 | pfile = file(text_file,'w') |
|
1435 | 1435 | pfile.write(output) |
|
1436 | 1436 | pfile.close() |
|
1437 | 1437 | print '\n*** Profile printout saved to text file',\ |
|
1438 | 1438 | `text_file`+'.',sys_exit |
|
1439 | 1439 | |
|
1440 | 1440 | if opts.has_key('r'): |
|
1441 | 1441 | return stats |
|
1442 | 1442 | else: |
|
1443 | 1443 | return None |
|
1444 | 1444 | |
|
1445 | 1445 | @testdec.skip_doctest |
|
1446 | 1446 | def magic_run(self, parameter_s ='',runner=None, |
|
1447 | 1447 | file_finder=get_py_filename): |
|
1448 | 1448 | """Run the named file inside IPython as a program. |
|
1449 | 1449 | |
|
1450 | 1450 | Usage:\\ |
|
1451 | 1451 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1452 | 1452 | |
|
1453 | 1453 | Parameters after the filename are passed as command-line arguments to |
|
1454 | 1454 | the program (put in sys.argv). Then, control returns to IPython's |
|
1455 | 1455 | prompt. |
|
1456 | 1456 | |
|
1457 | 1457 | This is similar to running at a system prompt:\\ |
|
1458 | 1458 | $ python file args\\ |
|
1459 | 1459 | but with the advantage of giving you IPython's tracebacks, and of |
|
1460 | 1460 | loading all variables into your interactive namespace for further use |
|
1461 | 1461 | (unless -p is used, see below). |
|
1462 | 1462 | |
|
1463 | 1463 | The file is executed in a namespace initially consisting only of |
|
1464 | 1464 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1465 | 1465 | sees its environment as if it were being run as a stand-alone program |
|
1466 | 1466 | (except for sharing global objects such as previously imported |
|
1467 | 1467 | modules). But after execution, the IPython interactive namespace gets |
|
1468 | 1468 | updated with all variables defined in the program (except for __name__ |
|
1469 | 1469 | and sys.argv). This allows for very convenient loading of code for |
|
1470 | 1470 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1471 | 1471 | |
|
1472 | 1472 | Options: |
|
1473 | 1473 | |
|
1474 | 1474 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1475 | 1475 | without extension (as python does under import). This allows running |
|
1476 | 1476 | scripts and reloading the definitions in them without calling code |
|
1477 | 1477 | protected by an ' if __name__ == "__main__" ' clause. |
|
1478 | 1478 | |
|
1479 | 1479 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1480 | 1480 | is useful if you are experimenting with code written in a text editor |
|
1481 | 1481 | which depends on variables defined interactively. |
|
1482 | 1482 | |
|
1483 | 1483 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1484 | 1484 | being run. This is particularly useful if IPython is being used to |
|
1485 | 1485 | run unittests, which always exit with a sys.exit() call. In such |
|
1486 | 1486 | cases you are interested in the output of the test results, not in |
|
1487 | 1487 | seeing a traceback of the unittest module. |
|
1488 | 1488 | |
|
1489 | 1489 | -t: print timing information at the end of the run. IPython will give |
|
1490 | 1490 | you an estimated CPU time consumption for your script, which under |
|
1491 | 1491 | Unix uses the resource module to avoid the wraparound problems of |
|
1492 | 1492 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1493 | 1493 | is also given (for Windows platforms this is reported as 0.0). |
|
1494 | 1494 | |
|
1495 | 1495 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1496 | 1496 | must be an integer indicating how many times you want the script to |
|
1497 | 1497 | run. The final timing report will include total and per run results. |
|
1498 | 1498 | |
|
1499 | 1499 | For example (testing the script uniq_stable.py): |
|
1500 | 1500 | |
|
1501 | 1501 | In [1]: run -t uniq_stable |
|
1502 | 1502 | |
|
1503 | 1503 | IPython CPU timings (estimated):\\ |
|
1504 | 1504 | User : 0.19597 s.\\ |
|
1505 | 1505 | System: 0.0 s.\\ |
|
1506 | 1506 | |
|
1507 | 1507 | In [2]: run -t -N5 uniq_stable |
|
1508 | 1508 | |
|
1509 | 1509 | IPython CPU timings (estimated):\\ |
|
1510 | 1510 | Total runs performed: 5\\ |
|
1511 | 1511 | Times : Total Per run\\ |
|
1512 | 1512 | User : 0.910862 s, 0.1821724 s.\\ |
|
1513 | 1513 | System: 0.0 s, 0.0 s. |
|
1514 | 1514 | |
|
1515 | 1515 | -d: run your program under the control of pdb, the Python debugger. |
|
1516 | 1516 | This allows you to execute your program step by step, watch variables, |
|
1517 | 1517 | etc. Internally, what IPython does is similar to calling: |
|
1518 | 1518 | |
|
1519 | 1519 | pdb.run('execfile("YOURFILENAME")') |
|
1520 | 1520 | |
|
1521 | 1521 | with a breakpoint set on line 1 of your file. You can change the line |
|
1522 | 1522 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1523 | 1523 | (where N must be an integer). For example: |
|
1524 | 1524 | |
|
1525 | 1525 | %run -d -b40 myscript |
|
1526 | 1526 | |
|
1527 | 1527 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1528 | 1528 | the first breakpoint must be set on a line which actually does |
|
1529 | 1529 | something (not a comment or docstring) for it to stop execution. |
|
1530 | 1530 | |
|
1531 | 1531 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1532 | 1532 | first enter 'c' (without qoutes) to start execution up to the first |
|
1533 | 1533 | breakpoint. |
|
1534 | 1534 | |
|
1535 | 1535 | Entering 'help' gives information about the use of the debugger. You |
|
1536 | 1536 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1537 | 1537 | at a prompt. |
|
1538 | 1538 | |
|
1539 | 1539 | -p: run program under the control of the Python profiler module (which |
|
1540 | 1540 | prints a detailed report of execution times, function calls, etc). |
|
1541 | 1541 | |
|
1542 | 1542 | You can pass other options after -p which affect the behavior of the |
|
1543 | 1543 | profiler itself. See the docs for %prun for details. |
|
1544 | 1544 | |
|
1545 | 1545 | In this mode, the program's variables do NOT propagate back to the |
|
1546 | 1546 | IPython interactive namespace (because they remain in the namespace |
|
1547 | 1547 | where the profiler executes them). |
|
1548 | 1548 | |
|
1549 | 1549 | Internally this triggers a call to %prun, see its documentation for |
|
1550 | 1550 | details on the options available specifically for profiling. |
|
1551 | 1551 | |
|
1552 | 1552 | There is one special usage for which the text above doesn't apply: |
|
1553 | 1553 | if the filename ends with .ipy, the file is run as ipython script, |
|
1554 | 1554 | just as if the commands were written on IPython prompt. |
|
1555 | 1555 | """ |
|
1556 | 1556 | |
|
1557 | 1557 | # get arguments and set sys.argv for program to be run. |
|
1558 | 1558 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', |
|
1559 | 1559 | mode='list',list_all=1) |
|
1560 | 1560 | |
|
1561 | 1561 | try: |
|
1562 | 1562 | filename = file_finder(arg_lst[0]) |
|
1563 | 1563 | except IndexError: |
|
1564 | 1564 | warn('you must provide at least a filename.') |
|
1565 | 1565 | print '\n%run:\n',oinspect.getdoc(self.magic_run) |
|
1566 | 1566 | return |
|
1567 | 1567 | except IOError,msg: |
|
1568 | 1568 | error(msg) |
|
1569 | 1569 | return |
|
1570 | 1570 | |
|
1571 | 1571 | if filename.lower().endswith('.ipy'): |
|
1572 | 1572 | self.api.runlines(open(filename).read()) |
|
1573 | 1573 | return |
|
1574 | 1574 | |
|
1575 | 1575 | # Control the response to exit() calls made by the script being run |
|
1576 | 1576 | exit_ignore = opts.has_key('e') |
|
1577 | 1577 | |
|
1578 | 1578 | # Make sure that the running script gets a proper sys.argv as if it |
|
1579 | 1579 | # were run from a system shell. |
|
1580 | 1580 | save_argv = sys.argv # save it for later restoring |
|
1581 | 1581 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename |
|
1582 | 1582 | |
|
1583 | 1583 | if opts.has_key('i'): |
|
1584 | 1584 | # Run in user's interactive namespace |
|
1585 | 1585 | prog_ns = self.shell.user_ns |
|
1586 | 1586 | __name__save = self.shell.user_ns['__name__'] |
|
1587 | 1587 | prog_ns['__name__'] = '__main__' |
|
1588 | 1588 | main_mod = self.shell.new_main_mod(prog_ns) |
|
1589 | 1589 | else: |
|
1590 | 1590 | # Run in a fresh, empty namespace |
|
1591 | 1591 | if opts.has_key('n'): |
|
1592 | 1592 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1593 | 1593 | else: |
|
1594 | 1594 | name = '__main__' |
|
1595 | 1595 | |
|
1596 | 1596 | main_mod = self.shell.new_main_mod() |
|
1597 | 1597 | prog_ns = main_mod.__dict__ |
|
1598 | 1598 | prog_ns['__name__'] = name |
|
1599 | 1599 | |
|
1600 | 1600 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1601 | 1601 | # set the __file__ global in the script's namespace |
|
1602 | 1602 | prog_ns['__file__'] = filename |
|
1603 | 1603 | |
|
1604 | 1604 | # pickle fix. See iplib for an explanation. But we need to make sure |
|
1605 | 1605 | # that, if we overwrite __main__, we replace it at the end |
|
1606 | 1606 | main_mod_name = prog_ns['__name__'] |
|
1607 | 1607 | |
|
1608 | 1608 | if main_mod_name == '__main__': |
|
1609 | 1609 | restore_main = sys.modules['__main__'] |
|
1610 | 1610 | else: |
|
1611 | 1611 | restore_main = False |
|
1612 | 1612 | |
|
1613 | 1613 | # This needs to be undone at the end to prevent holding references to |
|
1614 | 1614 | # every single object ever created. |
|
1615 | 1615 | sys.modules[main_mod_name] = main_mod |
|
1616 | 1616 | |
|
1617 | 1617 | stats = None |
|
1618 | 1618 | try: |
|
1619 | 1619 | self.shell.savehist() |
|
1620 | 1620 | |
|
1621 | 1621 | if opts.has_key('p'): |
|
1622 | 1622 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) |
|
1623 | 1623 | else: |
|
1624 | 1624 | if opts.has_key('d'): |
|
1625 | 1625 | deb = debugger.Pdb(self.shell.rc.colors) |
|
1626 | 1626 | # reset Breakpoint state, which is moronically kept |
|
1627 | 1627 | # in a class |
|
1628 | 1628 | bdb.Breakpoint.next = 1 |
|
1629 | 1629 | bdb.Breakpoint.bplist = {} |
|
1630 | 1630 | bdb.Breakpoint.bpbynumber = [None] |
|
1631 | 1631 | # Set an initial breakpoint to stop execution |
|
1632 | 1632 | maxtries = 10 |
|
1633 | 1633 | bp = int(opts.get('b',[1])[0]) |
|
1634 | 1634 | checkline = deb.checkline(filename,bp) |
|
1635 | 1635 | if not checkline: |
|
1636 | 1636 | for bp in range(bp+1,bp+maxtries+1): |
|
1637 | 1637 | if deb.checkline(filename,bp): |
|
1638 | 1638 | break |
|
1639 | 1639 | else: |
|
1640 | 1640 | msg = ("\nI failed to find a valid line to set " |
|
1641 | 1641 | "a breakpoint\n" |
|
1642 | 1642 | "after trying up to line: %s.\n" |
|
1643 | 1643 | "Please set a valid breakpoint manually " |
|
1644 | 1644 | "with the -b option." % bp) |
|
1645 | 1645 | error(msg) |
|
1646 | 1646 | return |
|
1647 | 1647 | # if we find a good linenumber, set the breakpoint |
|
1648 | 1648 | deb.do_break('%s:%s' % (filename,bp)) |
|
1649 | 1649 | # Start file run |
|
1650 | 1650 | print "NOTE: Enter 'c' at the", |
|
1651 | 1651 | print "%s prompt to start your script." % deb.prompt |
|
1652 | 1652 | try: |
|
1653 | 1653 | deb.run('execfile("%s")' % filename,prog_ns) |
|
1654 | 1654 | |
|
1655 | 1655 | except: |
|
1656 | 1656 | etype, value, tb = sys.exc_info() |
|
1657 | 1657 | # Skip three frames in the traceback: the %run one, |
|
1658 | 1658 | # one inside bdb.py, and the command-line typed by the |
|
1659 | 1659 | # user (run by exec in pdb itself). |
|
1660 | 1660 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) |
|
1661 | 1661 | else: |
|
1662 | 1662 | if runner is None: |
|
1663 | 1663 | runner = self.shell.safe_execfile |
|
1664 | 1664 | if opts.has_key('t'): |
|
1665 | 1665 | # timed execution |
|
1666 | 1666 | try: |
|
1667 | 1667 | nruns = int(opts['N'][0]) |
|
1668 | 1668 | if nruns < 1: |
|
1669 | 1669 | error('Number of runs must be >=1') |
|
1670 | 1670 | return |
|
1671 | 1671 | except (KeyError): |
|
1672 | 1672 | nruns = 1 |
|
1673 | 1673 | if nruns == 1: |
|
1674 | 1674 | t0 = clock2() |
|
1675 | 1675 | runner(filename,prog_ns,prog_ns, |
|
1676 | 1676 | exit_ignore=exit_ignore) |
|
1677 | 1677 | t1 = clock2() |
|
1678 | 1678 | t_usr = t1[0]-t0[0] |
|
1679 | 1679 | t_sys = t1[1]-t0[1] |
|
1680 | 1680 | print "\nIPython CPU timings (estimated):" |
|
1681 | 1681 | print " User : %10s s." % t_usr |
|
1682 | 1682 | print " System: %10s s." % t_sys |
|
1683 | 1683 | else: |
|
1684 | 1684 | runs = range(nruns) |
|
1685 | 1685 | t0 = clock2() |
|
1686 | 1686 | for nr in runs: |
|
1687 | 1687 | runner(filename,prog_ns,prog_ns, |
|
1688 | 1688 | exit_ignore=exit_ignore) |
|
1689 | 1689 | t1 = clock2() |
|
1690 | 1690 | t_usr = t1[0]-t0[0] |
|
1691 | 1691 | t_sys = t1[1]-t0[1] |
|
1692 | 1692 | print "\nIPython CPU timings (estimated):" |
|
1693 | 1693 | print "Total runs performed:",nruns |
|
1694 | 1694 | print " Times : %10s %10s" % ('Total','Per run') |
|
1695 | 1695 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) |
|
1696 | 1696 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) |
|
1697 | 1697 | |
|
1698 | 1698 | else: |
|
1699 | 1699 | # regular execution |
|
1700 | 1700 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) |
|
1701 | 1701 | |
|
1702 | 1702 | if opts.has_key('i'): |
|
1703 | 1703 | self.shell.user_ns['__name__'] = __name__save |
|
1704 | 1704 | else: |
|
1705 | 1705 | # The shell MUST hold a reference to prog_ns so after %run |
|
1706 | 1706 | # exits, the python deletion mechanism doesn't zero it out |
|
1707 | 1707 | # (leaving dangling references). |
|
1708 | 1708 | self.shell.cache_main_mod(prog_ns,filename) |
|
1709 | 1709 | # update IPython interactive namespace |
|
1710 | 1710 | del prog_ns['__name__'] |
|
1711 | 1711 | self.shell.user_ns.update(prog_ns) |
|
1712 | 1712 | finally: |
|
1713 | 1713 | # It's a bit of a mystery why, but __builtins__ can change from |
|
1714 | 1714 | # being a module to becoming a dict missing some key data after |
|
1715 | 1715 | # %run. As best I can see, this is NOT something IPython is doing |
|
1716 | 1716 | # at all, and similar problems have been reported before: |
|
1717 | 1717 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
1718 | 1718 | # Since this seems to be done by the interpreter itself, the best |
|
1719 | 1719 | # we can do is to at least restore __builtins__ for the user on |
|
1720 | 1720 | # exit. |
|
1721 | 1721 | self.shell.user_ns['__builtins__'] = __builtin__ |
|
1722 | 1722 | |
|
1723 | 1723 | # Ensure key global structures are restored |
|
1724 | 1724 | sys.argv = save_argv |
|
1725 | 1725 | if restore_main: |
|
1726 | 1726 | sys.modules['__main__'] = restore_main |
|
1727 | 1727 | else: |
|
1728 | 1728 | # Remove from sys.modules the reference to main_mod we'd |
|
1729 | 1729 | # added. Otherwise it will trap references to objects |
|
1730 | 1730 | # contained therein. |
|
1731 | 1731 | del sys.modules[main_mod_name] |
|
1732 | 1732 | |
|
1733 | 1733 | self.shell.reloadhist() |
|
1734 | 1734 | |
|
1735 | 1735 | return stats |
|
1736 | 1736 | |
|
1737 | 1737 | def magic_runlog(self, parameter_s =''): |
|
1738 | 1738 | """Run files as logs. |
|
1739 | 1739 | |
|
1740 | 1740 | Usage:\\ |
|
1741 | 1741 | %runlog file1 file2 ... |
|
1742 | 1742 | |
|
1743 | 1743 | Run the named files (treating them as log files) in sequence inside |
|
1744 | 1744 | the interpreter, and return to the prompt. This is much slower than |
|
1745 | 1745 | %run because each line is executed in a try/except block, but it |
|
1746 | 1746 | allows running files with syntax errors in them. |
|
1747 | 1747 | |
|
1748 | 1748 | Normally IPython will guess when a file is one of its own logfiles, so |
|
1749 | 1749 | you can typically use %run even for logs. This shorthand allows you to |
|
1750 | 1750 | force any file to be treated as a log file.""" |
|
1751 | 1751 | |
|
1752 | 1752 | for f in parameter_s.split(): |
|
1753 | 1753 | self.shell.safe_execfile(f,self.shell.user_ns, |
|
1754 | 1754 | self.shell.user_ns,islog=1) |
|
1755 | 1755 | |
|
1756 | 1756 | @testdec.skip_doctest |
|
1757 | 1757 | def magic_timeit(self, parameter_s =''): |
|
1758 | 1758 | """Time execution of a Python statement or expression |
|
1759 | 1759 | |
|
1760 | 1760 | Usage:\\ |
|
1761 | 1761 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1762 | 1762 | |
|
1763 | 1763 | Time execution of a Python statement or expression using the timeit |
|
1764 | 1764 | module. |
|
1765 | 1765 | |
|
1766 | 1766 | Options: |
|
1767 | 1767 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1768 | 1768 | is not given, a fitting value is chosen. |
|
1769 | 1769 | |
|
1770 | 1770 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1771 | 1771 | Default: 3 |
|
1772 | 1772 | |
|
1773 | 1773 | -t: use time.time to measure the time, which is the default on Unix. |
|
1774 | 1774 | This function measures wall time. |
|
1775 | 1775 | |
|
1776 | 1776 | -c: use time.clock to measure the time, which is the default on |
|
1777 | 1777 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1778 | 1778 | instead and returns the CPU user time. |
|
1779 | 1779 | |
|
1780 | 1780 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1781 | 1781 | Default: 3 |
|
1782 | 1782 | |
|
1783 | 1783 | |
|
1784 | 1784 | Examples: |
|
1785 | 1785 | |
|
1786 | 1786 | In [1]: %timeit pass |
|
1787 | 1787 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1788 | 1788 | |
|
1789 | 1789 | In [2]: u = None |
|
1790 | 1790 | |
|
1791 | 1791 | In [3]: %timeit u is None |
|
1792 | 1792 | 10000000 loops, best of 3: 184 ns per loop |
|
1793 | 1793 | |
|
1794 | 1794 | In [4]: %timeit -r 4 u == None |
|
1795 | 1795 | 1000000 loops, best of 4: 242 ns per loop |
|
1796 | 1796 | |
|
1797 | 1797 | In [5]: import time |
|
1798 | 1798 | |
|
1799 | 1799 | In [6]: %timeit -n1 time.sleep(2) |
|
1800 | 1800 | 1 loops, best of 3: 2 s per loop |
|
1801 | 1801 | |
|
1802 | 1802 | |
|
1803 | 1803 | The times reported by %timeit will be slightly higher than those |
|
1804 | 1804 | reported by the timeit.py script when variables are accessed. This is |
|
1805 | 1805 | due to the fact that %timeit executes the statement in the namespace |
|
1806 | 1806 | of the shell, compared with timeit.py, which uses a single setup |
|
1807 | 1807 | statement to import function or create variables. Generally, the bias |
|
1808 | 1808 | does not matter as long as results from timeit.py are not mixed with |
|
1809 | 1809 | those from %timeit.""" |
|
1810 | 1810 | |
|
1811 | 1811 | import timeit |
|
1812 | 1812 | import math |
|
1813 | 1813 | |
|
1814 | 1814 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in |
|
1815 | 1815 | # certain terminals. Until we figure out a robust way of |
|
1816 | 1816 | # auto-detecting if the terminal can deal with it, use plain 'us' for |
|
1817 | 1817 | # microseconds. I am really NOT happy about disabling the proper |
|
1818 | 1818 | # 'micro' prefix, but crashing is worse... If anyone knows what the |
|
1819 | 1819 | # right solution for this is, I'm all ears... |
|
1820 | 1820 | # |
|
1821 | 1821 | # Note: using |
|
1822 | 1822 | # |
|
1823 | 1823 | # s = u'\xb5' |
|
1824 | 1824 | # s.encode(sys.getdefaultencoding()) |
|
1825 | 1825 | # |
|
1826 | 1826 | # is not sufficient, as I've seen terminals where that fails but |
|
1827 | 1827 | # print s |
|
1828 | 1828 | # |
|
1829 | 1829 | # succeeds |
|
1830 | 1830 | # |
|
1831 | 1831 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1832 | 1832 | |
|
1833 | 1833 | #units = [u"s", u"ms",u'\xb5',"ns"] |
|
1834 | 1834 | units = [u"s", u"ms",u'us',"ns"] |
|
1835 | 1835 | |
|
1836 | 1836 | scaling = [1, 1e3, 1e6, 1e9] |
|
1837 | 1837 | |
|
1838 | 1838 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1839 | 1839 | posix=False) |
|
1840 | 1840 | if stmt == "": |
|
1841 | 1841 | return |
|
1842 | 1842 | timefunc = timeit.default_timer |
|
1843 | 1843 | number = int(getattr(opts, "n", 0)) |
|
1844 | 1844 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1845 | 1845 | precision = int(getattr(opts, "p", 3)) |
|
1846 | 1846 | if hasattr(opts, "t"): |
|
1847 | 1847 | timefunc = time.time |
|
1848 | 1848 | if hasattr(opts, "c"): |
|
1849 | 1849 | timefunc = clock |
|
1850 | 1850 | |
|
1851 | 1851 | timer = timeit.Timer(timer=timefunc) |
|
1852 | 1852 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1853 | 1853 | # but is there a better way to achieve that the code stmt has access |
|
1854 | 1854 | # to the shell namespace? |
|
1855 | 1855 | |
|
1856 | 1856 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1857 | 1857 | 'setup': "pass"} |
|
1858 | 1858 | # Track compilation time so it can be reported if too long |
|
1859 | 1859 | # Minimum time above which compilation time will be reported |
|
1860 | 1860 | tc_min = 0.1 |
|
1861 | 1861 | |
|
1862 | 1862 | t0 = clock() |
|
1863 | 1863 | code = compile(src, "<magic-timeit>", "exec") |
|
1864 | 1864 | tc = clock()-t0 |
|
1865 | 1865 | |
|
1866 | 1866 | ns = {} |
|
1867 | 1867 | exec code in self.shell.user_ns, ns |
|
1868 | 1868 | timer.inner = ns["inner"] |
|
1869 | 1869 | |
|
1870 | 1870 | if number == 0: |
|
1871 | 1871 | # determine number so that 0.2 <= total time < 2.0 |
|
1872 | 1872 | number = 1 |
|
1873 | 1873 | for i in range(1, 10): |
|
1874 | 1874 | if timer.timeit(number) >= 0.2: |
|
1875 | 1875 | break |
|
1876 | 1876 | number *= 10 |
|
1877 | 1877 | |
|
1878 | 1878 | best = min(timer.repeat(repeat, number)) / number |
|
1879 | 1879 | |
|
1880 | 1880 | if best > 0.0: |
|
1881 | 1881 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1882 | 1882 | else: |
|
1883 | 1883 | order = 3 |
|
1884 | 1884 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1885 | 1885 | precision, |
|
1886 | 1886 | best * scaling[order], |
|
1887 | 1887 | units[order]) |
|
1888 | 1888 | if tc > tc_min: |
|
1889 | 1889 | print "Compiler time: %.2f s" % tc |
|
1890 | 1890 | |
|
1891 | 1891 | @testdec.skip_doctest |
|
1892 | 1892 | def magic_time(self,parameter_s = ''): |
|
1893 | 1893 | """Time execution of a Python statement or expression. |
|
1894 | 1894 | |
|
1895 | 1895 | The CPU and wall clock times are printed, and the value of the |
|
1896 | 1896 | expression (if any) is returned. Note that under Win32, system time |
|
1897 | 1897 | is always reported as 0, since it can not be measured. |
|
1898 | 1898 | |
|
1899 | 1899 | This function provides very basic timing functionality. In Python |
|
1900 | 1900 | 2.3, the timeit module offers more control and sophistication, so this |
|
1901 | 1901 | could be rewritten to use it (patches welcome). |
|
1902 | 1902 | |
|
1903 | 1903 | Some examples: |
|
1904 | 1904 | |
|
1905 | 1905 | In [1]: time 2**128 |
|
1906 | 1906 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1907 | 1907 | Wall time: 0.00 |
|
1908 | 1908 | Out[1]: 340282366920938463463374607431768211456L |
|
1909 | 1909 | |
|
1910 | 1910 | In [2]: n = 1000000 |
|
1911 | 1911 | |
|
1912 | 1912 | In [3]: time sum(range(n)) |
|
1913 | 1913 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1914 | 1914 | Wall time: 1.37 |
|
1915 | 1915 | Out[3]: 499999500000L |
|
1916 | 1916 | |
|
1917 | 1917 | In [4]: time print 'hello world' |
|
1918 | 1918 | hello world |
|
1919 | 1919 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1920 | 1920 | Wall time: 0.00 |
|
1921 | 1921 | |
|
1922 | 1922 | Note that the time needed by Python to compile the given expression |
|
1923 | 1923 | will be reported if it is more than 0.1s. In this example, the |
|
1924 | 1924 | actual exponentiation is done by Python at compilation time, so while |
|
1925 | 1925 | the expression can take a noticeable amount of time to compute, that |
|
1926 | 1926 | time is purely due to the compilation: |
|
1927 | 1927 | |
|
1928 | 1928 | In [5]: time 3**9999; |
|
1929 | 1929 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1930 | 1930 | Wall time: 0.00 s |
|
1931 | 1931 | |
|
1932 | 1932 | In [6]: time 3**999999; |
|
1933 | 1933 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1934 | 1934 | Wall time: 0.00 s |
|
1935 | 1935 | Compiler : 0.78 s |
|
1936 | 1936 | """ |
|
1937 | 1937 | |
|
1938 | 1938 | # fail immediately if the given expression can't be compiled |
|
1939 | 1939 | |
|
1940 | 1940 | expr = self.shell.prefilter(parameter_s,False) |
|
1941 | 1941 | |
|
1942 | 1942 | # Minimum time above which compilation time will be reported |
|
1943 | 1943 | tc_min = 0.1 |
|
1944 | 1944 | |
|
1945 | 1945 | try: |
|
1946 | 1946 | mode = 'eval' |
|
1947 | 1947 | t0 = clock() |
|
1948 | 1948 | code = compile(expr,'<timed eval>',mode) |
|
1949 | 1949 | tc = clock()-t0 |
|
1950 | 1950 | except SyntaxError: |
|
1951 | 1951 | mode = 'exec' |
|
1952 | 1952 | t0 = clock() |
|
1953 | 1953 | code = compile(expr,'<timed exec>',mode) |
|
1954 | 1954 | tc = clock()-t0 |
|
1955 | 1955 | # skew measurement as little as possible |
|
1956 | 1956 | glob = self.shell.user_ns |
|
1957 | 1957 | clk = clock2 |
|
1958 | 1958 | wtime = time.time |
|
1959 | 1959 | # time execution |
|
1960 | 1960 | wall_st = wtime() |
|
1961 | 1961 | if mode=='eval': |
|
1962 | 1962 | st = clk() |
|
1963 | 1963 | out = eval(code,glob) |
|
1964 | 1964 | end = clk() |
|
1965 | 1965 | else: |
|
1966 | 1966 | st = clk() |
|
1967 | 1967 | exec code in glob |
|
1968 | 1968 | end = clk() |
|
1969 | 1969 | out = None |
|
1970 | 1970 | wall_end = wtime() |
|
1971 | 1971 | # Compute actual times and report |
|
1972 | 1972 | wall_time = wall_end-wall_st |
|
1973 | 1973 | cpu_user = end[0]-st[0] |
|
1974 | 1974 | cpu_sys = end[1]-st[1] |
|
1975 | 1975 | cpu_tot = cpu_user+cpu_sys |
|
1976 | 1976 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
1977 | 1977 | (cpu_user,cpu_sys,cpu_tot) |
|
1978 | 1978 | print "Wall time: %.2f s" % wall_time |
|
1979 | 1979 | if tc > tc_min: |
|
1980 | 1980 | print "Compiler : %.2f s" % tc |
|
1981 | 1981 | return out |
|
1982 | 1982 | |
|
1983 | 1983 | @testdec.skip_doctest |
|
1984 | 1984 | def magic_macro(self,parameter_s = ''): |
|
1985 | 1985 | """Define a set of input lines as a macro for future re-execution. |
|
1986 | 1986 | |
|
1987 | 1987 | Usage:\\ |
|
1988 | 1988 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1989 | 1989 | |
|
1990 | 1990 | Options: |
|
1991 | 1991 | |
|
1992 | 1992 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1993 | 1993 | so that magics are loaded in their transformed version to valid |
|
1994 | 1994 | Python. If this option is given, the raw input as typed as the |
|
1995 | 1995 | command line is used instead. |
|
1996 | 1996 | |
|
1997 | 1997 | This will define a global variable called `name` which is a string |
|
1998 | 1998 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1999 | 1999 | above) from your input history into a single string. This variable |
|
2000 | 2000 | acts like an automatic function which re-executes those lines as if |
|
2001 | 2001 | you had typed them. You just type 'name' at the prompt and the code |
|
2002 | 2002 | executes. |
|
2003 | 2003 | |
|
2004 | 2004 | The notation for indicating number ranges is: n1-n2 means 'use line |
|
2005 | 2005 | numbers n1,...n2' (the endpoint is included). That is, '5-7' means |
|
2006 | 2006 | using the lines numbered 5,6 and 7. |
|
2007 | 2007 | |
|
2008 | 2008 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
2009 | 2009 | notation, where N:M means numbers N through M-1. |
|
2010 | 2010 | |
|
2011 | 2011 | For example, if your history contains (%hist prints it): |
|
2012 | 2012 | |
|
2013 | 2013 | 44: x=1 |
|
2014 | 2014 | 45: y=3 |
|
2015 | 2015 | 46: z=x+y |
|
2016 | 2016 | 47: print x |
|
2017 | 2017 | 48: a=5 |
|
2018 | 2018 | 49: print 'x',x,'y',y |
|
2019 | 2019 | |
|
2020 | 2020 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
2021 | 2021 | called my_macro with: |
|
2022 | 2022 | |
|
2023 | 2023 | In [55]: %macro my_macro 44-47 49 |
|
2024 | 2024 | |
|
2025 | 2025 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
2026 | 2026 | in one pass. |
|
2027 | 2027 | |
|
2028 | 2028 | You don't need to give the line-numbers in order, and any given line |
|
2029 | 2029 | number can appear multiple times. You can assemble macros with any |
|
2030 | 2030 | lines from your input history in any order. |
|
2031 | 2031 | |
|
2032 | 2032 | The macro is a simple object which holds its value in an attribute, |
|
2033 | 2033 | but IPython's display system checks for macros and executes them as |
|
2034 | 2034 | code instead of printing them when you type their name. |
|
2035 | 2035 | |
|
2036 | 2036 | You can view a macro's contents by explicitly printing it with: |
|
2037 | 2037 | |
|
2038 | 2038 | 'print macro_name'. |
|
2039 | 2039 | |
|
2040 | 2040 | For one-off cases which DON'T contain magic function calls in them you |
|
2041 | 2041 | can obtain similar results by explicitly executing slices from your |
|
2042 | 2042 | input history with: |
|
2043 | 2043 | |
|
2044 | 2044 | In [60]: exec In[44:48]+In[49]""" |
|
2045 | 2045 | |
|
2046 | 2046 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2047 | 2047 | if not args: |
|
2048 | 2048 | macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)] |
|
2049 | 2049 | macs.sort() |
|
2050 | 2050 | return macs |
|
2051 | 2051 | if len(args) == 1: |
|
2052 | 2052 | raise UsageError( |
|
2053 | 2053 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
2054 | 2054 | name,ranges = args[0], args[1:] |
|
2055 | 2055 | |
|
2056 | 2056 | #print 'rng',ranges # dbg |
|
2057 | 2057 | lines = self.extract_input_slices(ranges,opts.has_key('r')) |
|
2058 | 2058 | macro = Macro(lines) |
|
2059 | 2059 | self.shell.user_ns.update({name:macro}) |
|
2060 | 2060 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
2061 | 2061 | print 'Macro contents:' |
|
2062 | 2062 | print macro, |
|
2063 | 2063 | |
|
2064 | 2064 | def magic_save(self,parameter_s = ''): |
|
2065 | 2065 | """Save a set of lines to a given filename. |
|
2066 | 2066 | |
|
2067 | 2067 | Usage:\\ |
|
2068 | 2068 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
2069 | 2069 | |
|
2070 | 2070 | Options: |
|
2071 | 2071 | |
|
2072 | 2072 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2073 | 2073 | so that magics are loaded in their transformed version to valid |
|
2074 | 2074 | Python. If this option is given, the raw input as typed as the |
|
2075 | 2075 | command line is used instead. |
|
2076 | 2076 | |
|
2077 | 2077 | This function uses the same syntax as %macro for line extraction, but |
|
2078 | 2078 | instead of creating a macro it saves the resulting string to the |
|
2079 | 2079 | filename you specify. |
|
2080 | 2080 | |
|
2081 | 2081 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
2082 | 2082 | it asks for confirmation before overwriting existing files.""" |
|
2083 | 2083 | |
|
2084 | 2084 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2085 | 2085 | fname,ranges = args[0], args[1:] |
|
2086 | 2086 | if not fname.endswith('.py'): |
|
2087 | 2087 | fname += '.py' |
|
2088 | 2088 | if os.path.isfile(fname): |
|
2089 | 2089 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
2090 | 2090 | if ans.lower() not in ['y','yes']: |
|
2091 | 2091 | print 'Operation cancelled.' |
|
2092 | 2092 | return |
|
2093 | 2093 | cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r'))) |
|
2094 | 2094 | f = file(fname,'w') |
|
2095 | 2095 | f.write(cmds) |
|
2096 | 2096 | f.close() |
|
2097 | 2097 | print 'The following commands were written to file `%s`:' % fname |
|
2098 | 2098 | print cmds |
|
2099 | 2099 | |
|
2100 | 2100 | def _edit_macro(self,mname,macro): |
|
2101 | 2101 | """open an editor with the macro data in a file""" |
|
2102 | 2102 | filename = self.shell.mktempfile(macro.value) |
|
2103 | 2103 | self.shell.hooks.editor(filename) |
|
2104 | 2104 | |
|
2105 | 2105 | # and make a new macro object, to replace the old one |
|
2106 | 2106 | mfile = open(filename) |
|
2107 | 2107 | mvalue = mfile.read() |
|
2108 | 2108 | mfile.close() |
|
2109 | 2109 | self.shell.user_ns[mname] = Macro(mvalue) |
|
2110 | 2110 | |
|
2111 | 2111 | def magic_ed(self,parameter_s=''): |
|
2112 | 2112 | """Alias to %edit.""" |
|
2113 | 2113 | return self.magic_edit(parameter_s) |
|
2114 | 2114 | |
|
2115 | 2115 | @testdec.skip_doctest |
|
2116 | 2116 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
2117 | 2117 | """Bring up an editor and execute the resulting code. |
|
2118 | 2118 | |
|
2119 | 2119 | Usage: |
|
2120 | 2120 | %edit [options] [args] |
|
2121 | 2121 | |
|
2122 | 2122 | %edit runs IPython's editor hook. The default version of this hook is |
|
2123 | 2123 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
2124 | 2124 | environment variable $EDITOR. If this isn't found, it will default to |
|
2125 | 2125 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
2126 | 2126 | docstring for how to change the editor hook. |
|
2127 | 2127 | |
|
2128 | 2128 | You can also set the value of this editor via the command line option |
|
2129 | 2129 | '-editor' or in your ipythonrc file. This is useful if you wish to use |
|
2130 | 2130 | specifically for IPython an editor different from your typical default |
|
2131 | 2131 | (and for Windows users who typically don't set environment variables). |
|
2132 | 2132 | |
|
2133 | 2133 | This command allows you to conveniently edit multi-line code right in |
|
2134 | 2134 | your IPython session. |
|
2135 | 2135 | |
|
2136 | 2136 | If called without arguments, %edit opens up an empty editor with a |
|
2137 | 2137 | temporary file and will execute the contents of this file when you |
|
2138 | 2138 | close it (don't forget to save it!). |
|
2139 | 2139 | |
|
2140 | 2140 | |
|
2141 | 2141 | Options: |
|
2142 | 2142 | |
|
2143 | 2143 | -n <number>: open the editor at a specified line number. By default, |
|
2144 | 2144 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
2145 | 2145 | you can configure this by providing your own modified hook if your |
|
2146 | 2146 | favorite editor supports line-number specifications with a different |
|
2147 | 2147 | syntax. |
|
2148 | 2148 | |
|
2149 | 2149 | -p: this will call the editor with the same data as the previous time |
|
2150 | 2150 | it was used, regardless of how long ago (in your current session) it |
|
2151 | 2151 | was. |
|
2152 | 2152 | |
|
2153 | 2153 | -r: use 'raw' input. This option only applies to input taken from the |
|
2154 | 2154 | user's history. By default, the 'processed' history is used, so that |
|
2155 | 2155 | magics are loaded in their transformed version to valid Python. If |
|
2156 | 2156 | this option is given, the raw input as typed as the command line is |
|
2157 | 2157 | used instead. When you exit the editor, it will be executed by |
|
2158 | 2158 | IPython's own processor. |
|
2159 | 2159 | |
|
2160 | 2160 | -x: do not execute the edited code immediately upon exit. This is |
|
2161 | 2161 | mainly useful if you are editing programs which need to be called with |
|
2162 | 2162 | command line arguments, which you can then do using %run. |
|
2163 | 2163 | |
|
2164 | 2164 | |
|
2165 | 2165 | Arguments: |
|
2166 | 2166 | |
|
2167 | 2167 | If arguments are given, the following possibilites exist: |
|
2168 | 2168 | |
|
2169 | 2169 | - The arguments are numbers or pairs of colon-separated numbers (like |
|
2170 | 2170 | 1 4:8 9). These are interpreted as lines of previous input to be |
|
2171 | 2171 | loaded into the editor. The syntax is the same of the %macro command. |
|
2172 | 2172 | |
|
2173 | 2173 | - If the argument doesn't start with a number, it is evaluated as a |
|
2174 | 2174 | variable and its contents loaded into the editor. You can thus edit |
|
2175 | 2175 | any string which contains python code (including the result of |
|
2176 | 2176 | previous edits). |
|
2177 | 2177 | |
|
2178 | 2178 | - If the argument is the name of an object (other than a string), |
|
2179 | 2179 | IPython will try to locate the file where it was defined and open the |
|
2180 | 2180 | editor at the point where it is defined. You can use `%edit function` |
|
2181 | 2181 | to load an editor exactly at the point where 'function' is defined, |
|
2182 | 2182 | edit it and have the file be executed automatically. |
|
2183 | 2183 | |
|
2184 | 2184 | If the object is a macro (see %macro for details), this opens up your |
|
2185 | 2185 | specified editor with a temporary file containing the macro's data. |
|
2186 | 2186 | Upon exit, the macro is reloaded with the contents of the file. |
|
2187 | 2187 | |
|
2188 | 2188 | Note: opening at an exact line is only supported under Unix, and some |
|
2189 | 2189 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
2190 | 2190 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
2191 | 2191 | (X)Emacs, vi, jed, pico and joe all do. |
|
2192 | 2192 | |
|
2193 | 2193 | - If the argument is not found as a variable, IPython will look for a |
|
2194 | 2194 | file with that name (adding .py if necessary) and load it into the |
|
2195 | 2195 | editor. It will execute its contents with execfile() when you exit, |
|
2196 | 2196 | loading any code in the file into your interactive namespace. |
|
2197 | 2197 | |
|
2198 | 2198 | After executing your code, %edit will return as output the code you |
|
2199 | 2199 | typed in the editor (except when it was an existing file). This way |
|
2200 | 2200 | you can reload the code in further invocations of %edit as a variable, |
|
2201 | 2201 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
2202 | 2202 | the output. |
|
2203 | 2203 | |
|
2204 | 2204 | Note that %edit is also available through the alias %ed. |
|
2205 | 2205 | |
|
2206 | 2206 | This is an example of creating a simple function inside the editor and |
|
2207 | 2207 | then modifying it. First, start up the editor: |
|
2208 | 2208 | |
|
2209 | 2209 | In [1]: ed |
|
2210 | 2210 | Editing... done. Executing edited code... |
|
2211 | 2211 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' |
|
2212 | 2212 | |
|
2213 | 2213 | We can then call the function foo(): |
|
2214 | 2214 | |
|
2215 | 2215 | In [2]: foo() |
|
2216 | 2216 | foo() was defined in an editing session |
|
2217 | 2217 | |
|
2218 | 2218 | Now we edit foo. IPython automatically loads the editor with the |
|
2219 | 2219 | (temporary) file where foo() was previously defined: |
|
2220 | 2220 | |
|
2221 | 2221 | In [3]: ed foo |
|
2222 | 2222 | Editing... done. Executing edited code... |
|
2223 | 2223 | |
|
2224 | 2224 | And if we call foo() again we get the modified version: |
|
2225 | 2225 | |
|
2226 | 2226 | In [4]: foo() |
|
2227 | 2227 | foo() has now been changed! |
|
2228 | 2228 | |
|
2229 | 2229 | Here is an example of how to edit a code snippet successive |
|
2230 | 2230 | times. First we call the editor: |
|
2231 | 2231 | |
|
2232 | 2232 | In [5]: ed |
|
2233 | 2233 | Editing... done. Executing edited code... |
|
2234 | 2234 | hello |
|
2235 | 2235 | Out[5]: "print 'hello'n" |
|
2236 | 2236 | |
|
2237 | 2237 | Now we call it again with the previous output (stored in _): |
|
2238 | 2238 | |
|
2239 | 2239 | In [6]: ed _ |
|
2240 | 2240 | Editing... done. Executing edited code... |
|
2241 | 2241 | hello world |
|
2242 | 2242 | Out[6]: "print 'hello world'n" |
|
2243 | 2243 | |
|
2244 | 2244 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
2245 | 2245 | |
|
2246 | 2246 | In [7]: ed _8 |
|
2247 | 2247 | Editing... done. Executing edited code... |
|
2248 | 2248 | hello again |
|
2249 | 2249 | Out[7]: "print 'hello again'n" |
|
2250 | 2250 | |
|
2251 | 2251 | |
|
2252 | 2252 | Changing the default editor hook: |
|
2253 | 2253 | |
|
2254 | 2254 | If you wish to write your own editor hook, you can put it in a |
|
2255 | 2255 | configuration file which you load at startup time. The default hook |
|
2256 | 2256 | is defined in the IPython.core.hooks module, and you can use that as a |
|
2257 | 2257 | starting example for further modifications. That file also has |
|
2258 | 2258 | general instructions on how to set a new hook for use once you've |
|
2259 | 2259 | defined it.""" |
|
2260 | 2260 | |
|
2261 | 2261 | # FIXME: This function has become a convoluted mess. It needs a |
|
2262 | 2262 | # ground-up rewrite with clean, simple logic. |
|
2263 | 2263 | |
|
2264 | 2264 | def make_filename(arg): |
|
2265 | 2265 | "Make a filename from the given args" |
|
2266 | 2266 | try: |
|
2267 | 2267 | filename = get_py_filename(arg) |
|
2268 | 2268 | except IOError: |
|
2269 | 2269 | if args.endswith('.py'): |
|
2270 | 2270 | filename = arg |
|
2271 | 2271 | else: |
|
2272 | 2272 | filename = None |
|
2273 | 2273 | return filename |
|
2274 | 2274 | |
|
2275 | 2275 | # custom exceptions |
|
2276 | 2276 | class DataIsObject(Exception): pass |
|
2277 | 2277 | |
|
2278 | 2278 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
2279 | 2279 | # Set a few locals from the options for convenience: |
|
2280 | 2280 | opts_p = opts.has_key('p') |
|
2281 | 2281 | opts_r = opts.has_key('r') |
|
2282 | 2282 | |
|
2283 | 2283 | # Default line number value |
|
2284 | 2284 | lineno = opts.get('n',None) |
|
2285 | 2285 | |
|
2286 | 2286 | if opts_p: |
|
2287 | 2287 | args = '_%s' % last_call[0] |
|
2288 | 2288 | if not self.shell.user_ns.has_key(args): |
|
2289 | 2289 | args = last_call[1] |
|
2290 | 2290 | |
|
2291 | 2291 | # use last_call to remember the state of the previous call, but don't |
|
2292 | 2292 | # let it be clobbered by successive '-p' calls. |
|
2293 | 2293 | try: |
|
2294 | 2294 | last_call[0] = self.shell.outputcache.prompt_count |
|
2295 | 2295 | if not opts_p: |
|
2296 | 2296 | last_call[1] = parameter_s |
|
2297 | 2297 | except: |
|
2298 | 2298 | pass |
|
2299 | 2299 | |
|
2300 | 2300 | # by default this is done with temp files, except when the given |
|
2301 | 2301 | # arg is a filename |
|
2302 | 2302 | use_temp = 1 |
|
2303 | 2303 | |
|
2304 | 2304 | if re.match(r'\d',args): |
|
2305 | 2305 | # Mode where user specifies ranges of lines, like in %macro. |
|
2306 | 2306 | # This means that you can't edit files whose names begin with |
|
2307 | 2307 | # numbers this way. Tough. |
|
2308 | 2308 | ranges = args.split() |
|
2309 | 2309 | data = ''.join(self.extract_input_slices(ranges,opts_r)) |
|
2310 | 2310 | elif args.endswith('.py'): |
|
2311 | 2311 | filename = make_filename(args) |
|
2312 | 2312 | data = '' |
|
2313 | 2313 | use_temp = 0 |
|
2314 | 2314 | elif args: |
|
2315 | 2315 | try: |
|
2316 | 2316 | # Load the parameter given as a variable. If not a string, |
|
2317 | 2317 | # process it as an object instead (below) |
|
2318 | 2318 | |
|
2319 | 2319 | #print '*** args',args,'type',type(args) # dbg |
|
2320 | 2320 | data = eval(args,self.shell.user_ns) |
|
2321 | 2321 | if not type(data) in StringTypes: |
|
2322 | 2322 | raise DataIsObject |
|
2323 | 2323 | |
|
2324 | 2324 | except (NameError,SyntaxError): |
|
2325 | 2325 | # given argument is not a variable, try as a filename |
|
2326 | 2326 | filename = make_filename(args) |
|
2327 | 2327 | if filename is None: |
|
2328 | 2328 | warn("Argument given (%s) can't be found as a variable " |
|
2329 | 2329 | "or as a filename." % args) |
|
2330 | 2330 | return |
|
2331 | 2331 | |
|
2332 | 2332 | data = '' |
|
2333 | 2333 | use_temp = 0 |
|
2334 | 2334 | except DataIsObject: |
|
2335 | 2335 | |
|
2336 | 2336 | # macros have a special edit function |
|
2337 | 2337 | if isinstance(data,Macro): |
|
2338 | 2338 | self._edit_macro(args,data) |
|
2339 | 2339 | return |
|
2340 | 2340 | |
|
2341 | 2341 | # For objects, try to edit the file where they are defined |
|
2342 | 2342 | try: |
|
2343 | 2343 | filename = inspect.getabsfile(data) |
|
2344 | 2344 | if 'fakemodule' in filename.lower() and inspect.isclass(data): |
|
2345 | 2345 | # class created by %edit? Try to find source |
|
2346 | 2346 | # by looking for method definitions instead, the |
|
2347 | 2347 | # __module__ in those classes is FakeModule. |
|
2348 | 2348 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
2349 | 2349 | for attr in attrs: |
|
2350 | 2350 | if not inspect.ismethod(attr): |
|
2351 | 2351 | continue |
|
2352 | 2352 | filename = inspect.getabsfile(attr) |
|
2353 | 2353 | if filename and 'fakemodule' not in filename.lower(): |
|
2354 | 2354 | # change the attribute to be the edit target instead |
|
2355 | 2355 | data = attr |
|
2356 | 2356 | break |
|
2357 | 2357 | |
|
2358 | 2358 | datafile = 1 |
|
2359 | 2359 | except TypeError: |
|
2360 | 2360 | filename = make_filename(args) |
|
2361 | 2361 | datafile = 1 |
|
2362 | 2362 | warn('Could not find file where `%s` is defined.\n' |
|
2363 | 2363 | 'Opening a file named `%s`' % (args,filename)) |
|
2364 | 2364 | # Now, make sure we can actually read the source (if it was in |
|
2365 | 2365 | # a temp file it's gone by now). |
|
2366 | 2366 | if datafile: |
|
2367 | 2367 | try: |
|
2368 | 2368 | if lineno is None: |
|
2369 | 2369 | lineno = inspect.getsourcelines(data)[1] |
|
2370 | 2370 | except IOError: |
|
2371 | 2371 | filename = make_filename(args) |
|
2372 | 2372 | if filename is None: |
|
2373 | 2373 | warn('The file `%s` where `%s` was defined cannot ' |
|
2374 | 2374 | 'be read.' % (filename,data)) |
|
2375 | 2375 | return |
|
2376 | 2376 | use_temp = 0 |
|
2377 | 2377 | else: |
|
2378 | 2378 | data = '' |
|
2379 | 2379 | |
|
2380 | 2380 | if use_temp: |
|
2381 | 2381 | filename = self.shell.mktempfile(data) |
|
2382 | 2382 | print 'IPython will make a temporary file named:',filename |
|
2383 | 2383 | |
|
2384 | 2384 | # do actual editing here |
|
2385 | 2385 | print 'Editing...', |
|
2386 | 2386 | sys.stdout.flush() |
|
2387 | 2387 | try: |
|
2388 | 2388 | self.shell.hooks.editor(filename,lineno) |
|
2389 | 2389 | except ipapi.TryNext: |
|
2390 | 2390 | warn('Could not open editor') |
|
2391 | 2391 | return |
|
2392 | 2392 | |
|
2393 | 2393 | # XXX TODO: should this be generalized for all string vars? |
|
2394 | 2394 | # For now, this is special-cased to blocks created by cpaste |
|
2395 | 2395 | if args.strip() == 'pasted_block': |
|
2396 | 2396 | self.shell.user_ns['pasted_block'] = file_read(filename) |
|
2397 | 2397 | |
|
2398 | 2398 | if opts.has_key('x'): # -x prevents actual execution |
|
2399 | 2399 | |
|
2400 | 2400 | else: |
|
2401 | 2401 | print 'done. Executing edited code...' |
|
2402 | 2402 | if opts_r: |
|
2403 | 2403 | self.shell.runlines(file_read(filename)) |
|
2404 | 2404 | else: |
|
2405 | 2405 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2406 | 2406 | self.shell.user_ns) |
|
2407 | 2407 | |
|
2408 | 2408 | |
|
2409 | 2409 | if use_temp: |
|
2410 | 2410 | try: |
|
2411 | 2411 | return open(filename).read() |
|
2412 | 2412 | except IOError,msg: |
|
2413 | 2413 | if msg.filename == filename: |
|
2414 | 2414 | warn('File not found. Did you forget to save?') |
|
2415 | 2415 | return |
|
2416 | 2416 | else: |
|
2417 | 2417 | self.shell.showtraceback() |
|
2418 | 2418 | |
|
2419 | 2419 | def magic_xmode(self,parameter_s = ''): |
|
2420 | 2420 | """Switch modes for the exception handlers. |
|
2421 | 2421 | |
|
2422 | 2422 | Valid modes: Plain, Context and Verbose. |
|
2423 | 2423 | |
|
2424 | 2424 | If called without arguments, acts as a toggle.""" |
|
2425 | 2425 | |
|
2426 | 2426 | def xmode_switch_err(name): |
|
2427 | 2427 | warn('Error changing %s exception modes.\n%s' % |
|
2428 | 2428 | (name,sys.exc_info()[1])) |
|
2429 | 2429 | |
|
2430 | 2430 | shell = self.shell |
|
2431 | 2431 | new_mode = parameter_s.strip().capitalize() |
|
2432 | 2432 | try: |
|
2433 | 2433 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2434 | 2434 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2435 | 2435 | except: |
|
2436 | 2436 | xmode_switch_err('user') |
|
2437 | 2437 | |
|
2438 | 2438 | # threaded shells use a special handler in sys.excepthook |
|
2439 | 2439 | if shell.isthreaded: |
|
2440 | 2440 | try: |
|
2441 | 2441 | shell.sys_excepthook.set_mode(mode=new_mode) |
|
2442 | 2442 | except: |
|
2443 | 2443 | xmode_switch_err('threaded') |
|
2444 | 2444 | |
|
2445 | 2445 | def magic_colors(self,parameter_s = ''): |
|
2446 | 2446 | """Switch color scheme for prompts, info system and exception handlers. |
|
2447 | 2447 | |
|
2448 | 2448 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2449 | 2449 | |
|
2450 | 2450 | Color scheme names are not case-sensitive.""" |
|
2451 | 2451 | |
|
2452 | 2452 | def color_switch_err(name): |
|
2453 | 2453 | warn('Error changing %s color schemes.\n%s' % |
|
2454 | 2454 | (name,sys.exc_info()[1])) |
|
2455 | 2455 | |
|
2456 | 2456 | |
|
2457 | 2457 | new_scheme = parameter_s.strip() |
|
2458 | 2458 | if not new_scheme: |
|
2459 | 2459 | raise UsageError( |
|
2460 | 2460 | "%colors: you must specify a color scheme. See '%colors?'") |
|
2461 | 2461 | return |
|
2462 | 2462 | # local shortcut |
|
2463 | 2463 | shell = self.shell |
|
2464 | 2464 | |
|
2465 | 2465 | import IPython.utils.rlineimpl as readline |
|
2466 | 2466 | |
|
2467 | 2467 | if not readline.have_readline and sys.platform == "win32": |
|
2468 | 2468 | msg = """\ |
|
2469 | 2469 | Proper color support under MS Windows requires the pyreadline library. |
|
2470 | 2470 | You can find it at: |
|
2471 | 2471 | http://ipython.scipy.org/moin/PyReadline/Intro |
|
2472 | 2472 | Gary's readline needs the ctypes module, from: |
|
2473 | 2473 | http://starship.python.net/crew/theller/ctypes |
|
2474 | 2474 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2475 | 2475 | |
|
2476 | 2476 | Defaulting color scheme to 'NoColor'""" |
|
2477 | 2477 | new_scheme = 'NoColor' |
|
2478 | 2478 | warn(msg) |
|
2479 | 2479 | |
|
2480 | 2480 | # readline option is 0 |
|
2481 | 2481 | if not shell.has_readline: |
|
2482 | 2482 | new_scheme = 'NoColor' |
|
2483 | 2483 | |
|
2484 | 2484 | # Set prompt colors |
|
2485 | 2485 | try: |
|
2486 | 2486 | shell.outputcache.set_colors(new_scheme) |
|
2487 | 2487 | except: |
|
2488 | 2488 | color_switch_err('prompt') |
|
2489 | 2489 | else: |
|
2490 | 2490 | shell.rc.colors = \ |
|
2491 | 2491 | shell.outputcache.color_table.active_scheme_name |
|
2492 | 2492 | # Set exception colors |
|
2493 | 2493 | try: |
|
2494 | 2494 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2495 | 2495 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2496 | 2496 | except: |
|
2497 | 2497 | color_switch_err('exception') |
|
2498 | 2498 | |
|
2499 | 2499 | # threaded shells use a verbose traceback in sys.excepthook |
|
2500 | 2500 | if shell.isthreaded: |
|
2501 | 2501 | try: |
|
2502 | 2502 | shell.sys_excepthook.set_colors(scheme=new_scheme) |
|
2503 | 2503 | except: |
|
2504 | 2504 | color_switch_err('system exception handler') |
|
2505 | 2505 | |
|
2506 | 2506 | # Set info (for 'object?') colors |
|
2507 | 2507 | if shell.rc.color_info: |
|
2508 | 2508 | try: |
|
2509 | 2509 | shell.inspector.set_active_scheme(new_scheme) |
|
2510 | 2510 | except: |
|
2511 | 2511 | color_switch_err('object inspector') |
|
2512 | 2512 | else: |
|
2513 | 2513 | shell.inspector.set_active_scheme('NoColor') |
|
2514 | 2514 | |
|
2515 | 2515 | def magic_color_info(self,parameter_s = ''): |
|
2516 | 2516 | """Toggle color_info. |
|
2517 | 2517 | |
|
2518 | 2518 | The color_info configuration parameter controls whether colors are |
|
2519 | 2519 | used for displaying object details (by things like %psource, %pfile or |
|
2520 | 2520 | the '?' system). This function toggles this value with each call. |
|
2521 | 2521 | |
|
2522 | 2522 | Note that unless you have a fairly recent pager (less works better |
|
2523 | 2523 | than more) in your system, using colored object information displays |
|
2524 | 2524 | will not work properly. Test it and see.""" |
|
2525 | 2525 | |
|
2526 | 2526 | self.shell.rc.color_info = 1 - self.shell.rc.color_info |
|
2527 | 2527 | self.magic_colors(self.shell.rc.colors) |
|
2528 | 2528 | print 'Object introspection functions have now coloring:', |
|
2529 | 2529 | print ['OFF','ON'][self.shell.rc.color_info] |
|
2530 | 2530 | |
|
2531 | 2531 | def magic_Pprint(self, parameter_s=''): |
|
2532 | 2532 | """Toggle pretty printing on/off.""" |
|
2533 | 2533 | |
|
2534 | 2534 | self.shell.rc.pprint = 1 - self.shell.rc.pprint |
|
2535 | 2535 | print 'Pretty printing has been turned', \ |
|
2536 | 2536 | ['OFF','ON'][self.shell.rc.pprint] |
|
2537 | 2537 | |
|
2538 | 2538 | def magic_exit(self, parameter_s=''): |
|
2539 | 2539 | """Exit IPython, confirming if configured to do so. |
|
2540 | 2540 | |
|
2541 | 2541 | You can configure whether IPython asks for confirmation upon exit by |
|
2542 | 2542 | setting the confirm_exit flag in the ipythonrc file.""" |
|
2543 | 2543 | |
|
2544 | 2544 | self.shell.exit() |
|
2545 | 2545 | |
|
2546 | 2546 | def magic_quit(self, parameter_s=''): |
|
2547 | 2547 | """Exit IPython, confirming if configured to do so (like %exit)""" |
|
2548 | 2548 | |
|
2549 | 2549 | self.shell.exit() |
|
2550 | 2550 | |
|
2551 | 2551 | def magic_Exit(self, parameter_s=''): |
|
2552 | 2552 | """Exit IPython without confirmation.""" |
|
2553 | 2553 | |
|
2554 | 2554 | self.shell.ask_exit() |
|
2555 | 2555 | |
|
2556 | 2556 | #...................................................................... |
|
2557 | 2557 | # Functions to implement unix shell-type things |
|
2558 | 2558 | |
|
2559 | 2559 | @testdec.skip_doctest |
|
2560 | 2560 | def magic_alias(self, parameter_s = ''): |
|
2561 | 2561 | """Define an alias for a system command. |
|
2562 | 2562 | |
|
2563 | 2563 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2564 | 2564 | |
|
2565 | 2565 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2566 | 2566 | params' (from your underlying operating system). |
|
2567 | 2567 | |
|
2568 | 2568 | Aliases have lower precedence than magic functions and Python normal |
|
2569 | 2569 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2570 | 2570 | alias can not be executed until 'del foo' removes the Python variable. |
|
2571 | 2571 | |
|
2572 | 2572 | You can use the %l specifier in an alias definition to represent the |
|
2573 | 2573 | whole line when the alias is called. For example: |
|
2574 | 2574 | |
|
2575 | 2575 | In [2]: alias all echo "Input in brackets: <%l>" |
|
2576 | 2576 | In [3]: all hello world |
|
2577 | 2577 | Input in brackets: <hello world> |
|
2578 | 2578 | |
|
2579 | 2579 | You can also define aliases with parameters using %s specifiers (one |
|
2580 | 2580 | per parameter): |
|
2581 | 2581 | |
|
2582 | 2582 | In [1]: alias parts echo first %s second %s |
|
2583 | 2583 | In [2]: %parts A B |
|
2584 | 2584 | first A second B |
|
2585 | 2585 | In [3]: %parts A |
|
2586 | 2586 | Incorrect number of arguments: 2 expected. |
|
2587 | 2587 | parts is an alias to: 'echo first %s second %s' |
|
2588 | 2588 | |
|
2589 | 2589 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2590 | 2590 | the other in your aliases. |
|
2591 | 2591 | |
|
2592 | 2592 | Aliases expand Python variables just like system calls using ! or !! |
|
2593 | 2593 | do: all expressions prefixed with '$' get expanded. For details of |
|
2594 | 2594 | the semantic rules, see PEP-215: |
|
2595 | 2595 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2596 | 2596 | IPython for variable expansion. If you want to access a true shell |
|
2597 | 2597 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2598 | 2598 | |
|
2599 | 2599 | In [6]: alias show echo |
|
2600 | 2600 | In [7]: PATH='A Python string' |
|
2601 | 2601 | In [8]: show $PATH |
|
2602 | 2602 | A Python string |
|
2603 | 2603 | In [9]: show $$PATH |
|
2604 | 2604 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2605 | 2605 | |
|
2606 | 2606 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2607 | 2607 | and %rehashx functions, which automatically create aliases for the |
|
2608 | 2608 | contents of your $PATH. |
|
2609 | 2609 | |
|
2610 | 2610 | If called with no parameters, %alias prints the current alias table.""" |
|
2611 | 2611 | |
|
2612 | 2612 | par = parameter_s.strip() |
|
2613 | 2613 | if not par: |
|
2614 | 2614 | stored = self.db.get('stored_aliases', {} ) |
|
2615 | 2615 | atab = self.shell.alias_table |
|
2616 | 2616 | aliases = atab.keys() |
|
2617 | 2617 | aliases.sort() |
|
2618 | 2618 | res = [] |
|
2619 | 2619 | showlast = [] |
|
2620 | 2620 | for alias in aliases: |
|
2621 | 2621 | special = False |
|
2622 | 2622 | try: |
|
2623 | 2623 | tgt = atab[alias][1] |
|
2624 | 2624 | except (TypeError, AttributeError): |
|
2625 | 2625 | # unsubscriptable? probably a callable |
|
2626 | 2626 | tgt = atab[alias] |
|
2627 | 2627 | special = True |
|
2628 | 2628 | # 'interesting' aliases |
|
2629 | 2629 | if (alias in stored or |
|
2630 | 2630 | special or |
|
2631 | 2631 | alias.lower() != os.path.splitext(tgt)[0].lower() or |
|
2632 | 2632 | ' ' in tgt): |
|
2633 | 2633 | showlast.append((alias, tgt)) |
|
2634 | 2634 | else: |
|
2635 | 2635 | res.append((alias, tgt )) |
|
2636 | 2636 | |
|
2637 | 2637 | # show most interesting aliases last |
|
2638 | 2638 | res.extend(showlast) |
|
2639 | 2639 | print "Total number of aliases:",len(aliases) |
|
2640 | 2640 | return res |
|
2641 | 2641 | try: |
|
2642 | 2642 | alias,cmd = par.split(None,1) |
|
2643 | 2643 | except: |
|
2644 | 2644 | print oinspect.getdoc(self.magic_alias) |
|
2645 | 2645 | else: |
|
2646 | 2646 | nargs = cmd.count('%s') |
|
2647 | 2647 | if nargs>0 and cmd.find('%l')>=0: |
|
2648 | 2648 | error('The %s and %l specifiers are mutually exclusive ' |
|
2649 | 2649 | 'in alias definitions.') |
|
2650 | 2650 | else: # all looks OK |
|
2651 | 2651 | self.shell.alias_table[alias] = (nargs,cmd) |
|
2652 | 2652 | self.shell.alias_table_validate(verbose=0) |
|
2653 | 2653 | # end magic_alias |
|
2654 | 2654 | |
|
2655 | 2655 | def magic_unalias(self, parameter_s = ''): |
|
2656 | 2656 | """Remove an alias""" |
|
2657 | 2657 | |
|
2658 | 2658 | aname = parameter_s.strip() |
|
2659 | 2659 | if aname in self.shell.alias_table: |
|
2660 | 2660 | del self.shell.alias_table[aname] |
|
2661 | 2661 | stored = self.db.get('stored_aliases', {} ) |
|
2662 | 2662 | if aname in stored: |
|
2663 | 2663 | print "Removing %stored alias",aname |
|
2664 | 2664 | del stored[aname] |
|
2665 | 2665 | self.db['stored_aliases'] = stored |
|
2666 | 2666 | |
|
2667 | 2667 | |
|
2668 | 2668 | def magic_rehashx(self, parameter_s = ''): |
|
2669 | 2669 | """Update the alias table with all executable files in $PATH. |
|
2670 | 2670 | |
|
2671 | 2671 | This version explicitly checks that every entry in $PATH is a file |
|
2672 | 2672 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2673 | 2673 | |
|
2674 | 2674 | Under Windows, it checks executability as a match agains a |
|
2675 | 2675 | '|'-separated string of extensions, stored in the IPython config |
|
2676 | 2676 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2677 | 2677 | |
|
2678 | 2678 | This function also resets the root module cache of module completer, |
|
2679 | 2679 | used on slow filesystems. |
|
2680 | 2680 | """ |
|
2681 | 2681 | |
|
2682 | 2682 | |
|
2683 | 2683 | ip = self.api |
|
2684 | 2684 | |
|
2685 | 2685 | # for the benefit of module completer in ipy_completers.py |
|
2686 | 2686 | del ip.db['rootmodules'] |
|
2687 | 2687 | |
|
2688 | 2688 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2689 | 2689 | os.environ.get('PATH','').split(os.pathsep)] |
|
2690 | 2690 | path = filter(os.path.isdir,path) |
|
2691 | 2691 | |
|
2692 | 2692 | alias_table = self.shell.alias_table |
|
2693 | 2693 | syscmdlist = [] |
|
2694 | 2694 | if os.name == 'posix': |
|
2695 | 2695 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2696 | 2696 | os.access(fname,os.X_OK) |
|
2697 | 2697 | else: |
|
2698 | 2698 | |
|
2699 | 2699 | try: |
|
2700 | 2700 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2701 | 2701 | except KeyError: |
|
2702 | 2702 | winext = 'exe|com|bat|py' |
|
2703 | 2703 | if 'py' not in winext: |
|
2704 | 2704 | winext += '|py' |
|
2705 | 2705 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2706 | 2706 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2707 | 2707 | savedir = os.getcwd() |
|
2708 | 2708 | try: |
|
2709 | 2709 | # write the whole loop for posix/Windows so we don't have an if in |
|
2710 | 2710 | # the innermost part |
|
2711 | 2711 | if os.name == 'posix': |
|
2712 | 2712 | for pdir in path: |
|
2713 | 2713 | os.chdir(pdir) |
|
2714 | 2714 | for ff in os.listdir(pdir): |
|
2715 | 2715 | if isexec(ff) and ff not in self.shell.no_alias: |
|
2716 | 2716 | # each entry in the alias table must be (N,name), |
|
2717 | 2717 | # where N is the number of positional arguments of the |
|
2718 | 2718 | # alias. |
|
2719 | 2719 | # Dots will be removed from alias names, since ipython |
|
2720 | 2720 | # assumes names with dots to be python code |
|
2721 | 2721 | alias_table[ff.replace('.','')] = (0,ff) |
|
2722 | 2722 | syscmdlist.append(ff) |
|
2723 | 2723 | else: |
|
2724 | 2724 | for pdir in path: |
|
2725 | 2725 | os.chdir(pdir) |
|
2726 | 2726 | for ff in os.listdir(pdir): |
|
2727 | 2727 | base, ext = os.path.splitext(ff) |
|
2728 | 2728 | if isexec(ff) and base.lower() not in self.shell.no_alias: |
|
2729 | 2729 | if ext.lower() == '.exe': |
|
2730 | 2730 | ff = base |
|
2731 | 2731 | alias_table[base.lower().replace('.','')] = (0,ff) |
|
2732 | 2732 | syscmdlist.append(ff) |
|
2733 | 2733 | # Make sure the alias table doesn't contain keywords or builtins |
|
2734 | 2734 | self.shell.alias_table_validate() |
|
2735 | 2735 | # Call again init_auto_alias() so we get 'rm -i' and other |
|
2736 | 2736 | # modified aliases since %rehashx will probably clobber them |
|
2737 | 2737 | |
|
2738 | 2738 | # no, we don't want them. if %rehashx clobbers them, good, |
|
2739 | 2739 | # we'll probably get better versions |
|
2740 | 2740 | # self.shell.init_auto_alias() |
|
2741 | 2741 | db = ip.db |
|
2742 | 2742 | db['syscmdlist'] = syscmdlist |
|
2743 | 2743 | finally: |
|
2744 | 2744 | os.chdir(savedir) |
|
2745 | 2745 | |
|
2746 | 2746 | def magic_pwd(self, parameter_s = ''): |
|
2747 | 2747 | """Return the current working directory path.""" |
|
2748 | 2748 | return os.getcwd() |
|
2749 | 2749 | |
|
2750 | 2750 | def magic_cd(self, parameter_s=''): |
|
2751 | 2751 | """Change the current working directory. |
|
2752 | 2752 | |
|
2753 | 2753 | This command automatically maintains an internal list of directories |
|
2754 | 2754 | you visit during your IPython session, in the variable _dh. The |
|
2755 | 2755 | command %dhist shows this history nicely formatted. You can also |
|
2756 | 2756 | do 'cd -<tab>' to see directory history conveniently. |
|
2757 | 2757 | |
|
2758 | 2758 | Usage: |
|
2759 | 2759 | |
|
2760 | 2760 | cd 'dir': changes to directory 'dir'. |
|
2761 | 2761 | |
|
2762 | 2762 | cd -: changes to the last visited directory. |
|
2763 | 2763 | |
|
2764 | 2764 | cd -<n>: changes to the n-th directory in the directory history. |
|
2765 | 2765 | |
|
2766 | 2766 | cd --foo: change to directory that matches 'foo' in history |
|
2767 | 2767 | |
|
2768 | 2768 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2769 | 2769 | (note: cd <bookmark_name> is enough if there is no |
|
2770 | 2770 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2771 | 2771 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2772 | 2772 | |
|
2773 | 2773 | Options: |
|
2774 | 2774 | |
|
2775 | 2775 | -q: quiet. Do not print the working directory after the cd command is |
|
2776 | 2776 | executed. By default IPython's cd command does print this directory, |
|
2777 | 2777 | since the default prompts do not display path information. |
|
2778 | 2778 | |
|
2779 | 2779 | Note that !cd doesn't work for this purpose because the shell where |
|
2780 | 2780 | !command runs is immediately discarded after executing 'command'.""" |
|
2781 | 2781 | |
|
2782 | 2782 | parameter_s = parameter_s.strip() |
|
2783 | 2783 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2784 | 2784 | |
|
2785 | 2785 | oldcwd = os.getcwd() |
|
2786 | 2786 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2787 | 2787 | # jump in directory history by number |
|
2788 | 2788 | if numcd: |
|
2789 | 2789 | nn = int(numcd.group(2)) |
|
2790 | 2790 | try: |
|
2791 | 2791 | ps = self.shell.user_ns['_dh'][nn] |
|
2792 | 2792 | except IndexError: |
|
2793 | 2793 | print 'The requested directory does not exist in history.' |
|
2794 | 2794 | return |
|
2795 | 2795 | else: |
|
2796 | 2796 | opts = {} |
|
2797 | 2797 | elif parameter_s.startswith('--'): |
|
2798 | 2798 | ps = None |
|
2799 | 2799 | fallback = None |
|
2800 | 2800 | pat = parameter_s[2:] |
|
2801 | 2801 | dh = self.shell.user_ns['_dh'] |
|
2802 | 2802 | # first search only by basename (last component) |
|
2803 | 2803 | for ent in reversed(dh): |
|
2804 | 2804 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
2805 | 2805 | ps = ent |
|
2806 | 2806 | break |
|
2807 | 2807 | |
|
2808 | 2808 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
2809 | 2809 | fallback = ent |
|
2810 | 2810 | |
|
2811 | 2811 | # if we have no last part match, pick the first full path match |
|
2812 | 2812 | if ps is None: |
|
2813 | 2813 | ps = fallback |
|
2814 | 2814 | |
|
2815 | 2815 | if ps is None: |
|
2816 | 2816 | print "No matching entry in directory history" |
|
2817 | 2817 | return |
|
2818 | 2818 | else: |
|
2819 | 2819 | opts = {} |
|
2820 | 2820 | |
|
2821 | 2821 | |
|
2822 | 2822 | else: |
|
2823 | 2823 | #turn all non-space-escaping backslashes to slashes, |
|
2824 | 2824 | # for c:\windows\directory\names\ |
|
2825 | 2825 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2826 | 2826 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2827 | 2827 | # jump to previous |
|
2828 | 2828 | if ps == '-': |
|
2829 | 2829 | try: |
|
2830 | 2830 | ps = self.shell.user_ns['_dh'][-2] |
|
2831 | 2831 | except IndexError: |
|
2832 | 2832 | raise UsageError('%cd -: No previous directory to change to.') |
|
2833 | 2833 | # jump to bookmark if needed |
|
2834 | 2834 | else: |
|
2835 | 2835 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2836 | 2836 | bkms = self.db.get('bookmarks', {}) |
|
2837 | 2837 | |
|
2838 | 2838 | if bkms.has_key(ps): |
|
2839 | 2839 | target = bkms[ps] |
|
2840 | 2840 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2841 | 2841 | ps = target |
|
2842 | 2842 | else: |
|
2843 | 2843 | if opts.has_key('b'): |
|
2844 | 2844 | raise UsageError("Bookmark '%s' not found. " |
|
2845 | 2845 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2846 | 2846 | |
|
2847 | 2847 | # at this point ps should point to the target dir |
|
2848 | 2848 | if ps: |
|
2849 | 2849 | try: |
|
2850 | 2850 | os.chdir(os.path.expanduser(ps)) |
|
2851 | 2851 | if self.shell.rc.term_title: |
|
2852 | 2852 | #print 'set term title:',self.shell.rc.term_title # dbg |
|
2853 | 2853 | platutils.set_term_title('IPy ' + abbrev_cwd()) |
|
2854 | 2854 | except OSError: |
|
2855 | 2855 | print sys.exc_info()[1] |
|
2856 | 2856 | else: |
|
2857 | 2857 | cwd = os.getcwd() |
|
2858 | 2858 | dhist = self.shell.user_ns['_dh'] |
|
2859 | 2859 | if oldcwd != cwd: |
|
2860 | 2860 | dhist.append(cwd) |
|
2861 | 2861 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2862 | 2862 | |
|
2863 | 2863 | else: |
|
2864 | 2864 | os.chdir(self.shell.home_dir) |
|
2865 | 2865 | if self.shell.rc.term_title: |
|
2866 | 2866 | platutils.set_term_title("IPy ~") |
|
2867 | 2867 | cwd = os.getcwd() |
|
2868 | 2868 | dhist = self.shell.user_ns['_dh'] |
|
2869 | 2869 | |
|
2870 | 2870 | if oldcwd != cwd: |
|
2871 | 2871 | dhist.append(cwd) |
|
2872 | 2872 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2873 | 2873 | if not 'q' in opts and self.shell.user_ns['_dh']: |
|
2874 | 2874 | print self.shell.user_ns['_dh'][-1] |
|
2875 | 2875 | |
|
2876 | 2876 | |
|
2877 | 2877 | def magic_env(self, parameter_s=''): |
|
2878 | 2878 | """List environment variables.""" |
|
2879 | 2879 | |
|
2880 | 2880 | return os.environ.data |
|
2881 | 2881 | |
|
2882 | 2882 | def magic_pushd(self, parameter_s=''): |
|
2883 | 2883 | """Place the current dir on stack and change directory. |
|
2884 | 2884 | |
|
2885 | 2885 | Usage:\\ |
|
2886 | 2886 | %pushd ['dirname'] |
|
2887 | 2887 | """ |
|
2888 | 2888 | |
|
2889 | 2889 | dir_s = self.shell.dir_stack |
|
2890 | 2890 | tgt = os.path.expanduser(parameter_s) |
|
2891 | 2891 | cwd = os.getcwd().replace(self.home_dir,'~') |
|
2892 | 2892 | if tgt: |
|
2893 | 2893 | self.magic_cd(parameter_s) |
|
2894 | 2894 | dir_s.insert(0,cwd) |
|
2895 | 2895 | return self.magic_dirs() |
|
2896 | 2896 | |
|
2897 | 2897 | def magic_popd(self, parameter_s=''): |
|
2898 | 2898 | """Change to directory popped off the top of the stack. |
|
2899 | 2899 | """ |
|
2900 | 2900 | if not self.shell.dir_stack: |
|
2901 | 2901 | raise UsageError("%popd on empty stack") |
|
2902 | 2902 | top = self.shell.dir_stack.pop(0) |
|
2903 | 2903 | self.magic_cd(top) |
|
2904 | 2904 | print "popd ->",top |
|
2905 | 2905 | |
|
2906 | 2906 | def magic_dirs(self, parameter_s=''): |
|
2907 | 2907 | """Return the current directory stack.""" |
|
2908 | 2908 | |
|
2909 | 2909 | return self.shell.dir_stack |
|
2910 | 2910 | |
|
2911 | 2911 | def magic_dhist(self, parameter_s=''): |
|
2912 | 2912 | """Print your history of visited directories. |
|
2913 | 2913 | |
|
2914 | 2914 | %dhist -> print full history\\ |
|
2915 | 2915 | %dhist n -> print last n entries only\\ |
|
2916 | 2916 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ |
|
2917 | 2917 | |
|
2918 | 2918 | This history is automatically maintained by the %cd command, and |
|
2919 | 2919 | always available as the global list variable _dh. You can use %cd -<n> |
|
2920 | 2920 | to go to directory number <n>. |
|
2921 | 2921 | |
|
2922 | 2922 | Note that most of time, you should view directory history by entering |
|
2923 | 2923 | cd -<TAB>. |
|
2924 | 2924 | |
|
2925 | 2925 | """ |
|
2926 | 2926 | |
|
2927 | 2927 | dh = self.shell.user_ns['_dh'] |
|
2928 | 2928 | if parameter_s: |
|
2929 | 2929 | try: |
|
2930 | 2930 | args = map(int,parameter_s.split()) |
|
2931 | 2931 | except: |
|
2932 | 2932 | self.arg_err(Magic.magic_dhist) |
|
2933 | 2933 | return |
|
2934 | 2934 | if len(args) == 1: |
|
2935 | 2935 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
2936 | 2936 | elif len(args) == 2: |
|
2937 | 2937 | ini,fin = args |
|
2938 | 2938 | else: |
|
2939 | 2939 | self.arg_err(Magic.magic_dhist) |
|
2940 | 2940 | return |
|
2941 | 2941 | else: |
|
2942 | 2942 | ini,fin = 0,len(dh) |
|
2943 | 2943 | nlprint(dh, |
|
2944 | 2944 | header = 'Directory history (kept in _dh)', |
|
2945 | 2945 | start=ini,stop=fin) |
|
2946 | 2946 | |
|
2947 | 2947 | @testdec.skip_doctest |
|
2948 | 2948 | def magic_sc(self, parameter_s=''): |
|
2949 | 2949 | """Shell capture - execute a shell command and capture its output. |
|
2950 | 2950 | |
|
2951 | 2951 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2952 | 2952 | |
|
2953 | 2953 | You should use the form 'var = !command' instead. Example: |
|
2954 | 2954 | |
|
2955 | 2955 | "%sc -l myfiles = ls ~" should now be written as |
|
2956 | 2956 | |
|
2957 | 2957 | "myfiles = !ls ~" |
|
2958 | 2958 | |
|
2959 | 2959 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2960 | 2960 | below. |
|
2961 | 2961 | |
|
2962 | 2962 | -- |
|
2963 | 2963 | %sc [options] varname=command |
|
2964 | 2964 | |
|
2965 | 2965 | IPython will run the given command using commands.getoutput(), and |
|
2966 | 2966 | will then update the user's interactive namespace with a variable |
|
2967 | 2967 | called varname, containing the value of the call. Your command can |
|
2968 | 2968 | contain shell wildcards, pipes, etc. |
|
2969 | 2969 | |
|
2970 | 2970 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2971 | 2971 | supply must follow Python's standard conventions for valid names. |
|
2972 | 2972 | |
|
2973 | 2973 | (A special format without variable name exists for internal use) |
|
2974 | 2974 | |
|
2975 | 2975 | Options: |
|
2976 | 2976 | |
|
2977 | 2977 | -l: list output. Split the output on newlines into a list before |
|
2978 | 2978 | assigning it to the given variable. By default the output is stored |
|
2979 | 2979 | as a single string. |
|
2980 | 2980 | |
|
2981 | 2981 | -v: verbose. Print the contents of the variable. |
|
2982 | 2982 | |
|
2983 | 2983 | In most cases you should not need to split as a list, because the |
|
2984 | 2984 | returned value is a special type of string which can automatically |
|
2985 | 2985 | provide its contents either as a list (split on newlines) or as a |
|
2986 | 2986 | space-separated string. These are convenient, respectively, either |
|
2987 | 2987 | for sequential processing or to be passed to a shell command. |
|
2988 | 2988 | |
|
2989 | 2989 | For example: |
|
2990 | 2990 | |
|
2991 | 2991 | # all-random |
|
2992 | 2992 | |
|
2993 | 2993 | # Capture into variable a |
|
2994 | 2994 | In [1]: sc a=ls *py |
|
2995 | 2995 | |
|
2996 | 2996 | # a is a string with embedded newlines |
|
2997 | 2997 | In [2]: a |
|
2998 | 2998 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
2999 | 2999 | |
|
3000 | 3000 | # which can be seen as a list: |
|
3001 | 3001 | In [3]: a.l |
|
3002 | 3002 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
3003 | 3003 | |
|
3004 | 3004 | # or as a whitespace-separated string: |
|
3005 | 3005 | In [4]: a.s |
|
3006 | 3006 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
3007 | 3007 | |
|
3008 | 3008 | # a.s is useful to pass as a single command line: |
|
3009 | 3009 | In [5]: !wc -l $a.s |
|
3010 | 3010 | 146 setup.py |
|
3011 | 3011 | 130 win32_manual_post_install.py |
|
3012 | 3012 | 276 total |
|
3013 | 3013 | |
|
3014 | 3014 | # while the list form is useful to loop over: |
|
3015 | 3015 | In [6]: for f in a.l: |
|
3016 | 3016 | ...: !wc -l $f |
|
3017 | 3017 | ...: |
|
3018 | 3018 | 146 setup.py |
|
3019 | 3019 | 130 win32_manual_post_install.py |
|
3020 | 3020 | |
|
3021 | 3021 | Similiarly, the lists returned by the -l option are also special, in |
|
3022 | 3022 | the sense that you can equally invoke the .s attribute on them to |
|
3023 | 3023 | automatically get a whitespace-separated string from their contents: |
|
3024 | 3024 | |
|
3025 | 3025 | In [7]: sc -l b=ls *py |
|
3026 | 3026 | |
|
3027 | 3027 | In [8]: b |
|
3028 | 3028 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
3029 | 3029 | |
|
3030 | 3030 | In [9]: b.s |
|
3031 | 3031 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
3032 | 3032 | |
|
3033 | 3033 | In summary, both the lists and strings used for ouptut capture have |
|
3034 | 3034 | the following special attributes: |
|
3035 | 3035 | |
|
3036 | 3036 | .l (or .list) : value as list. |
|
3037 | 3037 | .n (or .nlstr): value as newline-separated string. |
|
3038 | 3038 | .s (or .spstr): value as space-separated string. |
|
3039 | 3039 | """ |
|
3040 | 3040 | |
|
3041 | 3041 | opts,args = self.parse_options(parameter_s,'lv') |
|
3042 | 3042 | # Try to get a variable name and command to run |
|
3043 | 3043 | try: |
|
3044 | 3044 | # the variable name must be obtained from the parse_options |
|
3045 | 3045 | # output, which uses shlex.split to strip options out. |
|
3046 | 3046 | var,_ = args.split('=',1) |
|
3047 | 3047 | var = var.strip() |
|
3048 | 3048 | # But the the command has to be extracted from the original input |
|
3049 | 3049 | # parameter_s, not on what parse_options returns, to avoid the |
|
3050 | 3050 | # quote stripping which shlex.split performs on it. |
|
3051 | 3051 | _,cmd = parameter_s.split('=',1) |
|
3052 | 3052 | except ValueError: |
|
3053 | 3053 | var,cmd = '','' |
|
3054 | 3054 | # If all looks ok, proceed |
|
3055 | 3055 | out,err = self.shell.getoutputerror(cmd) |
|
3056 | 3056 | if err: |
|
3057 | 3057 | print >> Term.cerr,err |
|
3058 | 3058 | if opts.has_key('l'): |
|
3059 | 3059 | out = SList(out.split('\n')) |
|
3060 | 3060 | else: |
|
3061 | 3061 | out = LSString(out) |
|
3062 | 3062 | if opts.has_key('v'): |
|
3063 | 3063 | print '%s ==\n%s' % (var,pformat(out)) |
|
3064 | 3064 | if var: |
|
3065 | 3065 | self.shell.user_ns.update({var:out}) |
|
3066 | 3066 | else: |
|
3067 | 3067 | return out |
|
3068 | 3068 | |
|
3069 | 3069 | def magic_sx(self, parameter_s=''): |
|
3070 | 3070 | """Shell execute - run a shell command and capture its output. |
|
3071 | 3071 | |
|
3072 | 3072 | %sx command |
|
3073 | 3073 | |
|
3074 | 3074 | IPython will run the given command using commands.getoutput(), and |
|
3075 | 3075 | return the result formatted as a list (split on '\\n'). Since the |
|
3076 | 3076 | output is _returned_, it will be stored in ipython's regular output |
|
3077 | 3077 | cache Out[N] and in the '_N' automatic variables. |
|
3078 | 3078 | |
|
3079 | 3079 | Notes: |
|
3080 | 3080 | |
|
3081 | 3081 | 1) If an input line begins with '!!', then %sx is automatically |
|
3082 | 3082 | invoked. That is, while: |
|
3083 | 3083 | !ls |
|
3084 | 3084 | causes ipython to simply issue system('ls'), typing |
|
3085 | 3085 | !!ls |
|
3086 | 3086 | is a shorthand equivalent to: |
|
3087 | 3087 | %sx ls |
|
3088 | 3088 | |
|
3089 | 3089 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
3090 | 3090 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
3091 | 3091 | to process line-oriented shell output via further python commands. |
|
3092 | 3092 | %sc is meant to provide much finer control, but requires more |
|
3093 | 3093 | typing. |
|
3094 | 3094 | |
|
3095 | 3095 | 3) Just like %sc -l, this is a list with special attributes: |
|
3096 | 3096 | |
|
3097 | 3097 | .l (or .list) : value as list. |
|
3098 | 3098 | .n (or .nlstr): value as newline-separated string. |
|
3099 | 3099 | .s (or .spstr): value as whitespace-separated string. |
|
3100 | 3100 | |
|
3101 | 3101 | This is very useful when trying to use such lists as arguments to |
|
3102 | 3102 | system commands.""" |
|
3103 | 3103 | |
|
3104 | 3104 | if parameter_s: |
|
3105 | 3105 | out,err = self.shell.getoutputerror(parameter_s) |
|
3106 | 3106 | if err: |
|
3107 | 3107 | print >> Term.cerr,err |
|
3108 | 3108 | return SList(out.split('\n')) |
|
3109 | 3109 | |
|
3110 | 3110 | def magic_bg(self, parameter_s=''): |
|
3111 | 3111 | """Run a job in the background, in a separate thread. |
|
3112 | 3112 | |
|
3113 | 3113 | For example, |
|
3114 | 3114 | |
|
3115 | 3115 | %bg myfunc(x,y,z=1) |
|
3116 | 3116 | |
|
3117 | 3117 | will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the |
|
3118 | 3118 | execution starts, a message will be printed indicating the job |
|
3119 | 3119 | number. If your job number is 5, you can use |
|
3120 | 3120 | |
|
3121 | 3121 | myvar = jobs.result(5) or myvar = jobs[5].result |
|
3122 | 3122 | |
|
3123 | 3123 | to assign this result to variable 'myvar'. |
|
3124 | 3124 | |
|
3125 | 3125 | IPython has a job manager, accessible via the 'jobs' object. You can |
|
3126 | 3126 | type jobs? to get more information about it, and use jobs.<TAB> to see |
|
3127 | 3127 | its attributes. All attributes not starting with an underscore are |
|
3128 | 3128 | meant for public use. |
|
3129 | 3129 | |
|
3130 | 3130 | In particular, look at the jobs.new() method, which is used to create |
|
3131 | 3131 | new jobs. This magic %bg function is just a convenience wrapper |
|
3132 | 3132 | around jobs.new(), for expression-based jobs. If you want to create a |
|
3133 | 3133 | new job with an explicit function object and arguments, you must call |
|
3134 | 3134 | jobs.new() directly. |
|
3135 | 3135 | |
|
3136 | 3136 | The jobs.new docstring also describes in detail several important |
|
3137 | 3137 | caveats associated with a thread-based model for background job |
|
3138 | 3138 | execution. Type jobs.new? for details. |
|
3139 | 3139 | |
|
3140 | 3140 | You can check the status of all jobs with jobs.status(). |
|
3141 | 3141 | |
|
3142 | 3142 | The jobs variable is set by IPython into the Python builtin namespace. |
|
3143 | 3143 | If you ever declare a variable named 'jobs', you will shadow this |
|
3144 | 3144 | name. You can either delete your global jobs variable to regain |
|
3145 | 3145 | access to the job manager, or make a new name and assign it manually |
|
3146 | 3146 | to the manager (stored in IPython's namespace). For example, to |
|
3147 | 3147 | assign the job manager to the Jobs name, use: |
|
3148 | 3148 | |
|
3149 | 3149 | Jobs = __builtins__.jobs""" |
|
3150 | 3150 | |
|
3151 | 3151 | self.shell.jobs.new(parameter_s,self.shell.user_ns) |
|
3152 | 3152 | |
|
3153 | 3153 | def magic_r(self, parameter_s=''): |
|
3154 | 3154 | """Repeat previous input. |
|
3155 | 3155 | |
|
3156 | 3156 | Note: Consider using the more powerfull %rep instead! |
|
3157 | 3157 | |
|
3158 | 3158 | If given an argument, repeats the previous command which starts with |
|
3159 | 3159 | the same string, otherwise it just repeats the previous input. |
|
3160 | 3160 | |
|
3161 | 3161 | Shell escaped commands (with ! as first character) are not recognized |
|
3162 | 3162 | by this system, only pure python code and magic commands. |
|
3163 | 3163 | """ |
|
3164 | 3164 | |
|
3165 | 3165 | start = parameter_s.strip() |
|
3166 | 3166 | esc_magic = self.shell.ESC_MAGIC |
|
3167 | 3167 | # Identify magic commands even if automagic is on (which means |
|
3168 | 3168 | # the in-memory version is different from that typed by the user). |
|
3169 | 3169 | if self.shell.rc.automagic: |
|
3170 | 3170 | start_magic = esc_magic+start |
|
3171 | 3171 | else: |
|
3172 | 3172 | start_magic = start |
|
3173 | 3173 | # Look through the input history in reverse |
|
3174 | 3174 | for n in range(len(self.shell.input_hist)-2,0,-1): |
|
3175 | 3175 | input = self.shell.input_hist[n] |
|
3176 | 3176 | # skip plain 'r' lines so we don't recurse to infinity |
|
3177 | 3177 | if input != '_ip.magic("r")\n' and \ |
|
3178 | 3178 | (input.startswith(start) or input.startswith(start_magic)): |
|
3179 | 3179 | #print 'match',`input` # dbg |
|
3180 | 3180 | print 'Executing:',input, |
|
3181 | 3181 | self.shell.runlines(input) |
|
3182 | 3182 | return |
|
3183 | 3183 | print 'No previous input matching `%s` found.' % start |
|
3184 | 3184 | |
|
3185 | 3185 | |
|
3186 | 3186 | def magic_bookmark(self, parameter_s=''): |
|
3187 | 3187 | """Manage IPython's bookmark system. |
|
3188 | 3188 | |
|
3189 | 3189 | %bookmark <name> - set bookmark to current dir |
|
3190 | 3190 | %bookmark <name> <dir> - set bookmark to <dir> |
|
3191 | 3191 | %bookmark -l - list all bookmarks |
|
3192 | 3192 | %bookmark -d <name> - remove bookmark |
|
3193 | 3193 | %bookmark -r - remove all bookmarks |
|
3194 | 3194 | |
|
3195 | 3195 | You can later on access a bookmarked folder with: |
|
3196 | 3196 | %cd -b <name> |
|
3197 | 3197 | or simply '%cd <name>' if there is no directory called <name> AND |
|
3198 | 3198 | there is such a bookmark defined. |
|
3199 | 3199 | |
|
3200 | 3200 | Your bookmarks persist through IPython sessions, but they are |
|
3201 | 3201 | associated with each profile.""" |
|
3202 | 3202 | |
|
3203 | 3203 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
3204 | 3204 | if len(args) > 2: |
|
3205 | 3205 | raise UsageError("%bookmark: too many arguments") |
|
3206 | 3206 | |
|
3207 | 3207 | bkms = self.db.get('bookmarks',{}) |
|
3208 | 3208 | |
|
3209 | 3209 | if opts.has_key('d'): |
|
3210 | 3210 | try: |
|
3211 | 3211 | todel = args[0] |
|
3212 | 3212 | except IndexError: |
|
3213 | 3213 | raise UsageError( |
|
3214 | 3214 | "%bookmark -d: must provide a bookmark to delete") |
|
3215 | 3215 | else: |
|
3216 | 3216 | try: |
|
3217 | 3217 | del bkms[todel] |
|
3218 | 3218 | except KeyError: |
|
3219 | 3219 | raise UsageError( |
|
3220 | 3220 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) |
|
3221 | 3221 | |
|
3222 | 3222 | elif opts.has_key('r'): |
|
3223 | 3223 | bkms = {} |
|
3224 | 3224 | elif opts.has_key('l'): |
|
3225 | 3225 | bks = bkms.keys() |
|
3226 | 3226 | bks.sort() |
|
3227 | 3227 | if bks: |
|
3228 | 3228 | size = max(map(len,bks)) |
|
3229 | 3229 | else: |
|
3230 | 3230 | size = 0 |
|
3231 | 3231 | fmt = '%-'+str(size)+'s -> %s' |
|
3232 | 3232 | print 'Current bookmarks:' |
|
3233 | 3233 | for bk in bks: |
|
3234 | 3234 | print fmt % (bk,bkms[bk]) |
|
3235 | 3235 | else: |
|
3236 | 3236 | if not args: |
|
3237 | 3237 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
3238 | 3238 | elif len(args)==1: |
|
3239 | 3239 | bkms[args[0]] = os.getcwd() |
|
3240 | 3240 | elif len(args)==2: |
|
3241 | 3241 | bkms[args[0]] = args[1] |
|
3242 | 3242 | self.db['bookmarks'] = bkms |
|
3243 | 3243 | |
|
3244 | 3244 | def magic_pycat(self, parameter_s=''): |
|
3245 | 3245 | """Show a syntax-highlighted file through a pager. |
|
3246 | 3246 | |
|
3247 | 3247 | This magic is similar to the cat utility, but it will assume the file |
|
3248 | 3248 | to be Python source and will show it with syntax highlighting. """ |
|
3249 | 3249 | |
|
3250 | 3250 | try: |
|
3251 | 3251 | filename = get_py_filename(parameter_s) |
|
3252 | 3252 | cont = file_read(filename) |
|
3253 | 3253 | except IOError: |
|
3254 | 3254 | try: |
|
3255 | 3255 | cont = eval(parameter_s,self.user_ns) |
|
3256 | 3256 | except NameError: |
|
3257 | 3257 | cont = None |
|
3258 | 3258 | if cont is None: |
|
3259 | 3259 | print "Error: no such file or variable" |
|
3260 | 3260 | return |
|
3261 | 3261 | |
|
3262 | 3262 | page(self.shell.pycolorize(cont), |
|
3263 | 3263 | screen_lines=self.shell.rc.screen_length) |
|
3264 | 3264 | |
|
3265 | 3265 | def magic_cpaste(self, parameter_s=''): |
|
3266 | 3266 | """Allows you to paste & execute a pre-formatted code block from clipboard. |
|
3267 | 3267 | |
|
3268 | 3268 | You must terminate the block with '--' (two minus-signs) alone on the |
|
3269 | 3269 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' |
|
3270 | 3270 | is the new sentinel for this operation) |
|
3271 | 3271 | |
|
3272 | 3272 | The block is dedented prior to execution to enable execution of method |
|
3273 | 3273 | definitions. '>' and '+' characters at the beginning of a line are |
|
3274 | 3274 | ignored, to allow pasting directly from e-mails, diff files and |
|
3275 | 3275 | doctests (the '...' continuation prompt is also stripped). The |
|
3276 | 3276 | executed block is also assigned to variable named 'pasted_block' for |
|
3277 | 3277 | later editing with '%edit pasted_block'. |
|
3278 | 3278 | |
|
3279 | 3279 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
3280 | 3280 | This assigns the pasted block to variable 'foo' as string, without |
|
3281 | 3281 | dedenting or executing it (preceding >>> and + is still stripped) |
|
3282 | 3282 | |
|
3283 | 3283 | '%cpaste -r' re-executes the block previously entered by cpaste. |
|
3284 | 3284 | |
|
3285 | 3285 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
3286 | 3286 | Just press enter and type -- (and press enter again) and the block |
|
3287 | 3287 | will be what was just pasted. |
|
3288 | 3288 | |
|
3289 | 3289 | IPython statements (magics, shell escapes) are not supported (yet). |
|
3290 | 3290 | """ |
|
3291 | 3291 | opts,args = self.parse_options(parameter_s,'rs:',mode='string') |
|
3292 | 3292 | par = args.strip() |
|
3293 | 3293 | if opts.has_key('r'): |
|
3294 | 3294 | b = self.user_ns.get('pasted_block', None) |
|
3295 | 3295 | if b is None: |
|
3296 | 3296 | raise UsageError('No previous pasted block available') |
|
3297 | 3297 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) |
|
3298 | 3298 | exec b in self.user_ns |
|
3299 | 3299 | return |
|
3300 | 3300 | |
|
3301 | 3301 | sentinel = opts.get('s','--') |
|
3302 | 3302 | |
|
3303 | 3303 | # Regular expressions that declare text we strip from the input: |
|
3304 | 3304 | strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt |
|
3305 | 3305 | r'^\s*(\s?>)+', # Python input prompt |
|
3306 | 3306 | r'^\s*\.{3,}', # Continuation prompts |
|
3307 | 3307 | r'^\++', |
|
3308 | 3308 | ] |
|
3309 | 3309 | |
|
3310 | 3310 | strip_from_start = map(re.compile,strip_re) |
|
3311 | 3311 | |
|
3312 | 3312 | from IPython.core import iplib |
|
3313 | 3313 | lines = [] |
|
3314 | 3314 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel |
|
3315 | 3315 | while 1: |
|
3316 | 3316 | l = iplib.raw_input_original(':') |
|
3317 | 3317 | if l ==sentinel: |
|
3318 | 3318 | break |
|
3319 | 3319 | |
|
3320 | 3320 | for pat in strip_from_start: |
|
3321 | 3321 | l = pat.sub('',l) |
|
3322 | 3322 | lines.append(l) |
|
3323 | 3323 | |
|
3324 | 3324 | block = "\n".join(lines) + '\n' |
|
3325 | 3325 | #print "block:\n",block |
|
3326 | 3326 | if not par: |
|
3327 | 3327 | b = textwrap.dedent(block) |
|
3328 | 3328 | self.user_ns['pasted_block'] = b |
|
3329 | 3329 | exec b in self.user_ns |
|
3330 | 3330 | else: |
|
3331 | 3331 | self.user_ns[par] = SList(block.splitlines()) |
|
3332 | 3332 | print "Block assigned to '%s'" % par |
|
3333 | 3333 | |
|
3334 | 3334 | def magic_quickref(self,arg): |
|
3335 | 3335 | """ Show a quick reference sheet """ |
|
3336 | 3336 | import IPython.core.usage |
|
3337 | 3337 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') |
|
3338 | 3338 | |
|
3339 | 3339 | page(qr) |
|
3340 | 3340 | |
|
3341 | 3341 | def magic_upgrade(self,arg): |
|
3342 | 3342 | """ Upgrade your IPython installation |
|
3343 | 3343 | |
|
3344 | 3344 | This will copy the config files that don't yet exist in your |
|
3345 | 3345 | ipython dir from the system config dir. Use this after upgrading |
|
3346 | 3346 | IPython if you don't wish to delete your .ipython dir. |
|
3347 | 3347 | |
|
3348 | 3348 | Call with -nolegacy to get rid of ipythonrc* files (recommended for |
|
3349 | 3349 | new users) |
|
3350 | 3350 | |
|
3351 | 3351 | """ |
|
3352 | 3352 | ip = self.getapi() |
|
3353 | 3353 | ipinstallation = path(IPython.__file__).dirname() |
|
3354 | 3354 | upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'utils' / 'upgradedir.py') |
|
3355 | 3355 | src_config = ipinstallation / 'config' / 'userconfig' |
|
3356 | 3356 | userdir = path(ip.options.ipythondir) |
|
3357 | 3357 | cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir) |
|
3358 | 3358 | print ">",cmd |
|
3359 | 3359 | shell(cmd) |
|
3360 | 3360 | if arg == '-nolegacy': |
|
3361 | 3361 | legacy = userdir.files('ipythonrc*') |
|
3362 | 3362 | print "Nuking legacy files:",legacy |
|
3363 | 3363 | |
|
3364 | 3364 | [p.remove() for p in legacy] |
|
3365 | 3365 | suffix = (sys.platform == 'win32' and '.ini' or '') |
|
3366 | 3366 | (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n') |
|
3367 | 3367 | |
|
3368 | 3368 | |
|
3369 | 3369 | def magic_doctest_mode(self,parameter_s=''): |
|
3370 | 3370 | """Toggle doctest mode on and off. |
|
3371 | 3371 | |
|
3372 | 3372 | This mode allows you to toggle the prompt behavior between normal |
|
3373 | 3373 | IPython prompts and ones that are as similar to the default IPython |
|
3374 | 3374 | interpreter as possible. |
|
3375 | 3375 | |
|
3376 | 3376 | It also supports the pasting of code snippets that have leading '>>>' |
|
3377 | 3377 | and '...' prompts in them. This means that you can paste doctests from |
|
3378 | 3378 | files or docstrings (even if they have leading whitespace), and the |
|
3379 | 3379 | code will execute correctly. You can then use '%history -tn' to see |
|
3380 | 3380 | the translated history without line numbers; this will give you the |
|
3381 | 3381 | input after removal of all the leading prompts and whitespace, which |
|
3382 | 3382 | can be pasted back into an editor. |
|
3383 | 3383 | |
|
3384 | 3384 | With these features, you can switch into this mode easily whenever you |
|
3385 | 3385 | need to do testing and changes to doctests, without having to leave |
|
3386 | 3386 | your existing IPython session. |
|
3387 | 3387 | """ |
|
3388 | 3388 | |
|
3389 | 3389 | # XXX - Fix this to have cleaner activate/deactivate calls. |
|
3390 |
from IPython. |
|
|
3390 | from IPython.extensions import InterpreterPasteInput as ipaste | |
|
3391 | 3391 | from IPython.utils.ipstruct import Struct |
|
3392 | 3392 | |
|
3393 | 3393 | # Shorthands |
|
3394 | 3394 | shell = self.shell |
|
3395 | 3395 | oc = shell.outputcache |
|
3396 | 3396 | rc = shell.rc |
|
3397 | 3397 | meta = shell.meta |
|
3398 | 3398 | # dstore is a data store kept in the instance metadata bag to track any |
|
3399 | 3399 | # changes we make, so we can undo them later. |
|
3400 | 3400 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
3401 | 3401 | save_dstore = dstore.setdefault |
|
3402 | 3402 | |
|
3403 | 3403 | # save a few values we'll need to recover later |
|
3404 | 3404 | mode = save_dstore('mode',False) |
|
3405 | 3405 | save_dstore('rc_pprint',rc.pprint) |
|
3406 | 3406 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
3407 | 3407 | save_dstore('rc_separate_out',rc.separate_out) |
|
3408 | 3408 | save_dstore('rc_separate_out2',rc.separate_out2) |
|
3409 | 3409 | save_dstore('rc_prompts_pad_left',rc.prompts_pad_left) |
|
3410 | 3410 | save_dstore('rc_separate_in',rc.separate_in) |
|
3411 | 3411 | |
|
3412 | 3412 | if mode == False: |
|
3413 | 3413 | # turn on |
|
3414 | 3414 | ipaste.activate_prefilter() |
|
3415 | 3415 | |
|
3416 | 3416 | oc.prompt1.p_template = '>>> ' |
|
3417 | 3417 | oc.prompt2.p_template = '... ' |
|
3418 | 3418 | oc.prompt_out.p_template = '' |
|
3419 | 3419 | |
|
3420 | 3420 | # Prompt separators like plain python |
|
3421 | 3421 | oc.input_sep = oc.prompt1.sep = '' |
|
3422 | 3422 | oc.output_sep = '' |
|
3423 | 3423 | oc.output_sep2 = '' |
|
3424 | 3424 | |
|
3425 | 3425 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3426 | 3426 | oc.prompt_out.pad_left = False |
|
3427 | 3427 | |
|
3428 | 3428 | rc.pprint = False |
|
3429 | 3429 | |
|
3430 | 3430 | shell.magic_xmode('Plain') |
|
3431 | 3431 | |
|
3432 | 3432 | else: |
|
3433 | 3433 | # turn off |
|
3434 | 3434 | ipaste.deactivate_prefilter() |
|
3435 | 3435 | |
|
3436 | 3436 | oc.prompt1.p_template = rc.prompt_in1 |
|
3437 | 3437 | oc.prompt2.p_template = rc.prompt_in2 |
|
3438 | 3438 | oc.prompt_out.p_template = rc.prompt_out |
|
3439 | 3439 | |
|
3440 | 3440 | oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in |
|
3441 | 3441 | |
|
3442 | 3442 | oc.output_sep = dstore.rc_separate_out |
|
3443 | 3443 | oc.output_sep2 = dstore.rc_separate_out2 |
|
3444 | 3444 | |
|
3445 | 3445 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3446 | 3446 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
3447 | 3447 | |
|
3448 | 3448 | rc.pprint = dstore.rc_pprint |
|
3449 | 3449 | |
|
3450 | 3450 | shell.magic_xmode(dstore.xmode) |
|
3451 | 3451 | |
|
3452 | 3452 | # Store new mode and inform |
|
3453 | 3453 | dstore.mode = bool(1-int(mode)) |
|
3454 | 3454 | print 'Doctest mode is:', |
|
3455 | 3455 | print ['OFF','ON'][dstore.mode] |
|
3456 | 3456 | |
|
3457 | 3457 | # end Magic |
@@ -1,249 +1,249 b'' | |||
|
1 | 1 | """Tests for various magic functions. |
|
2 | 2 | |
|
3 | 3 | Needs to be run by nose (to make ipython session available). |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | 6 | import os |
|
7 | 7 | import sys |
|
8 | 8 | import tempfile |
|
9 | 9 | import types |
|
10 | 10 | |
|
11 | 11 | import nose.tools as nt |
|
12 | 12 | |
|
13 | 13 | from IPython.utils.platutils import find_cmd, get_long_path_name |
|
14 | 14 | from IPython.testing import decorators as dec |
|
15 | 15 | from IPython.testing import tools as tt |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Test functions begin |
|
19 | 19 | |
|
20 | 20 | def test_rehashx(): |
|
21 | 21 | # clear up everything |
|
22 | 22 | _ip.IP.alias_table.clear() |
|
23 | 23 | del _ip.db['syscmdlist'] |
|
24 | 24 | |
|
25 | 25 | _ip.magic('rehashx') |
|
26 | 26 | # Practically ALL ipython development systems will have more than 10 aliases |
|
27 | 27 | |
|
28 | 28 | assert len(_ip.IP.alias_table) > 10 |
|
29 | 29 | for key, val in _ip.IP.alias_table.items(): |
|
30 | 30 | # we must strip dots from alias names |
|
31 | 31 | assert '.' not in key |
|
32 | 32 | |
|
33 | 33 | # rehashx must fill up syscmdlist |
|
34 | 34 | scoms = _ip.db['syscmdlist'] |
|
35 | 35 | assert len(scoms) > 10 |
|
36 | 36 | |
|
37 | 37 | |
|
38 | 38 | def doctest_hist_f(): |
|
39 | 39 | """Test %hist -f with temporary filename. |
|
40 | 40 | |
|
41 | 41 | In [9]: import tempfile |
|
42 | 42 | |
|
43 | 43 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
44 | 44 | |
|
45 | 45 | In [11]: %history -n -f $tfile 3 |
|
46 | 46 | """ |
|
47 | 47 | |
|
48 | 48 | |
|
49 | 49 | def doctest_hist_r(): |
|
50 | 50 | """Test %hist -r |
|
51 | 51 | |
|
52 | 52 | XXX - This test is not recording the output correctly. Not sure why... |
|
53 | 53 | |
|
54 | 54 | In [6]: x=1 |
|
55 | 55 | |
|
56 | 56 | In [7]: hist -n -r 2 |
|
57 | 57 | x=1 # random |
|
58 | 58 | hist -n -r 2 # random |
|
59 | 59 | """ |
|
60 | 60 | |
|
61 | 61 | # This test is known to fail on win32. |
|
62 | 62 | # See ticket https://bugs.launchpad.net/bugs/366334 |
|
63 | 63 | def test_obj_del(): |
|
64 | 64 | """Test that object's __del__ methods are called on exit.""" |
|
65 | 65 | test_dir = os.path.dirname(__file__) |
|
66 | 66 | del_file = os.path.join(test_dir,'obj_del.py') |
|
67 | 67 | ipython_cmd = find_cmd('ipython') |
|
68 | 68 | out = _ip.IP.getoutput('%s %s' % (ipython_cmd, del_file)) |
|
69 | 69 | nt.assert_equals(out,'obj_del.py: object A deleted') |
|
70 | 70 | |
|
71 | 71 | |
|
72 | 72 | def test_shist(): |
|
73 | 73 | # Simple tests of ShadowHist class - test generator. |
|
74 | 74 | import os, shutil, tempfile |
|
75 | 75 | |
|
76 |
from IPython. |
|
|
76 | from IPython.extensions import pickleshare | |
|
77 | 77 | from IPython.core.history import ShadowHist |
|
78 | 78 | |
|
79 | 79 | tfile = tempfile.mktemp('','tmp-ipython-') |
|
80 | 80 | |
|
81 | 81 | db = pickleshare.PickleShareDB(tfile) |
|
82 | 82 | s = ShadowHist(db) |
|
83 | 83 | s.add('hello') |
|
84 | 84 | s.add('world') |
|
85 | 85 | s.add('hello') |
|
86 | 86 | s.add('hello') |
|
87 | 87 | s.add('karhu') |
|
88 | 88 | |
|
89 | 89 | yield nt.assert_equals,s.all(),[(1, 'hello'), (2, 'world'), (3, 'karhu')] |
|
90 | 90 | |
|
91 | 91 | yield nt.assert_equal,s.get(2),'world' |
|
92 | 92 | |
|
93 | 93 | shutil.rmtree(tfile) |
|
94 | 94 | |
|
95 | 95 | @dec.skipif_not_numpy |
|
96 | 96 | def test_numpy_clear_array_undec(): |
|
97 | 97 | _ip.ex('import numpy as np') |
|
98 | 98 | _ip.ex('a = np.empty(2)') |
|
99 | 99 | |
|
100 | 100 | yield nt.assert_true,'a' in _ip.user_ns |
|
101 | 101 | _ip.magic('clear array') |
|
102 | 102 | yield nt.assert_false,'a' in _ip.user_ns |
|
103 | 103 | |
|
104 | 104 | |
|
105 | 105 | @dec.skip() |
|
106 | 106 | def test_fail_dec(*a,**k): |
|
107 | 107 | yield nt.assert_true, False |
|
108 | 108 | |
|
109 | 109 | @dec.skip('This one shouldn not run') |
|
110 | 110 | def test_fail_dec2(*a,**k): |
|
111 | 111 | yield nt.assert_true, False |
|
112 | 112 | |
|
113 | 113 | @dec.skipknownfailure |
|
114 | 114 | def test_fail_dec3(*a,**k): |
|
115 | 115 | yield nt.assert_true, False |
|
116 | 116 | |
|
117 | 117 | |
|
118 | 118 | def doctest_refbug(): |
|
119 | 119 | """Very nasty problem with references held by multiple runs of a script. |
|
120 | 120 | See: https://bugs.launchpad.net/ipython/+bug/269966 |
|
121 | 121 | |
|
122 | 122 | In [1]: _ip.IP.clear_main_mod_cache() |
|
123 | 123 | |
|
124 | 124 | In [2]: run refbug |
|
125 | 125 | |
|
126 | 126 | In [3]: call_f() |
|
127 | 127 | lowercased: hello |
|
128 | 128 | |
|
129 | 129 | In [4]: run refbug |
|
130 | 130 | |
|
131 | 131 | In [5]: call_f() |
|
132 | 132 | lowercased: hello |
|
133 | 133 | lowercased: hello |
|
134 | 134 | """ |
|
135 | 135 | |
|
136 | 136 | #----------------------------------------------------------------------------- |
|
137 | 137 | # Tests for %run |
|
138 | 138 | #----------------------------------------------------------------------------- |
|
139 | 139 | |
|
140 | 140 | # %run is critical enough that it's a good idea to have a solid collection of |
|
141 | 141 | # tests for it, some as doctests and some as normal tests. |
|
142 | 142 | |
|
143 | 143 | def doctest_run_ns(): |
|
144 | 144 | """Classes declared %run scripts must be instantiable afterwards. |
|
145 | 145 | |
|
146 | 146 | In [11]: run tclass foo |
|
147 | 147 | |
|
148 | 148 | In [12]: isinstance(f(),foo) |
|
149 | 149 | Out[12]: True |
|
150 | 150 | """ |
|
151 | 151 | |
|
152 | 152 | |
|
153 | 153 | def doctest_run_ns2(): |
|
154 | 154 | """Classes declared %run scripts must be instantiable afterwards. |
|
155 | 155 | |
|
156 | 156 | In [4]: run tclass C-first_pass |
|
157 | 157 | |
|
158 | 158 | In [5]: run tclass C-second_pass |
|
159 | 159 | tclass.py: deleting object: C-first_pass |
|
160 | 160 | """ |
|
161 | 161 | |
|
162 | 162 | @dec.skip_win32 |
|
163 | 163 | def doctest_run_builtins(): |
|
164 | 164 | """Check that %run doesn't damage __builtins__ via a doctest. |
|
165 | 165 | |
|
166 | 166 | This is similar to the test_run_builtins, but I want *both* forms of the |
|
167 | 167 | test to catch any possible glitches in our testing machinery, since that |
|
168 | 168 | modifies %run somewhat. So for this, we have both a normal test (below) |
|
169 | 169 | and a doctest (this one). |
|
170 | 170 | |
|
171 | 171 | In [1]: import tempfile |
|
172 | 172 | |
|
173 | 173 | In [2]: bid1 = id(__builtins__) |
|
174 | 174 | |
|
175 | 175 | In [3]: f = tempfile.NamedTemporaryFile() |
|
176 | 176 | |
|
177 | 177 | In [4]: f.write('pass\\n') |
|
178 | 178 | |
|
179 | 179 | In [5]: f.flush() |
|
180 | 180 | |
|
181 | 181 | In [6]: print 'B1:',type(__builtins__) |
|
182 | 182 | B1: <type 'module'> |
|
183 | 183 | |
|
184 | 184 | In [7]: %run $f.name |
|
185 | 185 | |
|
186 | 186 | In [8]: bid2 = id(__builtins__) |
|
187 | 187 | |
|
188 | 188 | In [9]: print 'B2:',type(__builtins__) |
|
189 | 189 | B2: <type 'module'> |
|
190 | 190 | |
|
191 | 191 | In [10]: bid1 == bid2 |
|
192 | 192 | Out[10]: True |
|
193 | 193 | """ |
|
194 | 194 | |
|
195 | 195 | # For some tests, it will be handy to organize them in a class with a common |
|
196 | 196 | # setup that makes a temp file |
|
197 | 197 | |
|
198 | 198 | class TestMagicRun(object): |
|
199 | 199 | |
|
200 | 200 | def setup(self): |
|
201 | 201 | """Make a valid python temp file.""" |
|
202 | 202 | f = tempfile.NamedTemporaryFile() |
|
203 | 203 | f.write('pass\n') |
|
204 | 204 | f.flush() |
|
205 | 205 | self.tmpfile = f |
|
206 | 206 | |
|
207 | 207 | def run_tmpfile(self): |
|
208 | 208 | # This fails on Windows if self.tmpfile.name has spaces or "~" in it. |
|
209 | 209 | # See below and ticket https://bugs.launchpad.net/bugs/366353 |
|
210 | 210 | _ip.magic('run %s' % self.tmpfile.name) |
|
211 | 211 | |
|
212 | 212 | # See https://bugs.launchpad.net/bugs/366353 |
|
213 | 213 | @dec.skip_if_not_win32 |
|
214 | 214 | def test_run_tempfile_path(self): |
|
215 | 215 | tt.assert_equals(True,False,"%run doesn't work with tempfile paths on win32.") |
|
216 | 216 | |
|
217 | 217 | # See https://bugs.launchpad.net/bugs/366353 |
|
218 | 218 | @dec.skip_win32 |
|
219 | 219 | def test_builtins_id(self): |
|
220 | 220 | """Check that %run doesn't damage __builtins__ """ |
|
221 | 221 | |
|
222 | 222 | # Test that the id of __builtins__ is not modified by %run |
|
223 | 223 | bid1 = id(_ip.user_ns['__builtins__']) |
|
224 | 224 | self.run_tmpfile() |
|
225 | 225 | bid2 = id(_ip.user_ns['__builtins__']) |
|
226 | 226 | tt.assert_equals(bid1, bid2) |
|
227 | 227 | |
|
228 | 228 | # See https://bugs.launchpad.net/bugs/366353 |
|
229 | 229 | @dec.skip_win32 |
|
230 | 230 | def test_builtins_type(self): |
|
231 | 231 | """Check that the type of __builtins__ doesn't change with %run. |
|
232 | 232 | |
|
233 | 233 | However, the above could pass if __builtins__ was already modified to |
|
234 | 234 | be a dict (it should be a module) by a previous use of %run. So we |
|
235 | 235 | also check explicitly that it really is a module: |
|
236 | 236 | """ |
|
237 | 237 | self.run_tmpfile() |
|
238 | 238 | tt.assert_equals(type(_ip.user_ns['__builtins__']),type(sys)) |
|
239 | 239 | |
|
240 | 240 | # See https://bugs.launchpad.net/bugs/366353 |
|
241 | 241 | @dec.skip_win32 |
|
242 | 242 | def test_prompts(self): |
|
243 | 243 | """Test that prompts correctly generate after %run""" |
|
244 | 244 | self.run_tmpfile() |
|
245 | 245 | p2 = str(_ip.IP.outputcache.prompt2).strip() |
|
246 | 246 | nt.assert_equals(p2[:3], '...') |
|
247 | 247 | |
|
248 | 248 | def teardown(self): |
|
249 | 249 | self.tmpfile.close() |
@@ -1,13 +1,13 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """This directory is meant for special-purpose extensions to IPython. |
|
3 | 3 | |
|
4 | 4 | This can include things which alter the syntax processing stage (see |
|
5 | 5 | PhysicalQ_Input for an example of how to do this). |
|
6 | 6 | |
|
7 | 7 | Any file located here can be called with an 'execfile =' option as |
|
8 | 8 | |
|
9 |
execfile = |
|
|
9 | execfile = extensions/filename.py | |
|
10 | 10 | |
|
11 | 11 | since the IPython directory itself is already part of the search path for |
|
12 | 12 | files listed as 'execfile ='. |
|
13 | 13 | """ |
@@ -1,2328 +1,2328 b'' | |||
|
1 | 1 | # -*- coding: iso-8859-1 -*- |
|
2 | 2 | |
|
3 | 3 | """ |
|
4 | 4 | ``ipipe`` provides classes to be used in an interactive Python session. Doing a |
|
5 | 5 | ``from ipipe import *`` is the preferred way to do this. The name of all |
|
6 | 6 | objects imported this way starts with ``i`` to minimize collisions. |
|
7 | 7 | |
|
8 | 8 | ``ipipe`` supports "pipeline expressions", which is something resembling Unix |
|
9 | 9 | pipes. An example is:: |
|
10 | 10 | |
|
11 | 11 | >>> ienv | isort("key.lower()") |
|
12 | 12 | |
|
13 | 13 | This gives a listing of all environment variables sorted by name. |
|
14 | 14 | |
|
15 | 15 | |
|
16 | 16 | There are three types of objects in a pipeline expression: |
|
17 | 17 | |
|
18 | 18 | * ``Table``s: These objects produce items. Examples are ``ils`` (listing the |
|
19 | 19 | current directory, ``ienv`` (listing environment variables), ``ipwd`` (listing |
|
20 | 20 | user accounts) and ``igrp`` (listing user groups). A ``Table`` must be the |
|
21 | 21 | first object in a pipe expression. |
|
22 | 22 | |
|
23 | 23 | * ``Pipe``s: These objects sit in the middle of a pipe expression. They |
|
24 | 24 | transform the input in some way (e.g. filtering or sorting it). Examples are: |
|
25 | 25 | ``ifilter`` (which filters the input pipe), ``isort`` (which sorts the input |
|
26 | 26 | pipe) and ``ieval`` (which evaluates a function or expression for each object |
|
27 | 27 | in the input pipe). |
|
28 | 28 | |
|
29 | 29 | * ``Display``s: These objects can be put as the last object in a pipeline |
|
30 | 30 | expression. There are responsible for displaying the result of the pipeline |
|
31 | 31 | expression. If a pipeline expression doesn't end in a display object a default |
|
32 | 32 | display objects will be used. One example is ``ibrowse`` which is a ``curses`` |
|
33 | 33 | based browser. |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | Adding support for pipeline expressions to your own objects can be done through |
|
37 | 37 | three extensions points (all of them optional): |
|
38 | 38 | |
|
39 | 39 | * An object that will be displayed as a row by a ``Display`` object should |
|
40 | 40 | implement the method ``__xattrs__(self, mode)`` method or register an |
|
41 | 41 | implementation of the generic function ``xattrs``. For more info see ``xattrs``. |
|
42 | 42 | |
|
43 | 43 | * When an object ``foo`` is displayed by a ``Display`` object, the generic |
|
44 | 44 | function ``xrepr`` is used. |
|
45 | 45 | |
|
46 | 46 | * Objects that can be iterated by ``Pipe``s must iterable. For special cases, |
|
47 | 47 | where iteration for display is different than the normal iteration a special |
|
48 | 48 | implementation can be registered with the generic function ``xiter``. This |
|
49 | 49 | makes it possible to use dictionaries and modules in pipeline expressions, |
|
50 | 50 | for example:: |
|
51 | 51 | |
|
52 | 52 | >>> import sys |
|
53 | 53 | >>> sys | ifilter("isinstance(value, int)") | idump |
|
54 | 54 | key |value |
|
55 | 55 | api_version| 1012 |
|
56 | 56 | dllhandle | 503316480 |
|
57 | 57 | hexversion | 33817328 |
|
58 | 58 | maxint |2147483647 |
|
59 | 59 | maxunicode | 65535 |
|
60 | 60 | >>> sys.modules | ifilter("_.value is not None") | isort("_.key.lower()") |
|
61 | 61 | ... |
|
62 | 62 | |
|
63 | 63 | Note: The expression strings passed to ``ifilter()`` and ``isort()`` can |
|
64 | 64 | refer to the object to be filtered or sorted via the variable ``_`` and to any |
|
65 | 65 | of the attributes of the object, i.e.:: |
|
66 | 66 | |
|
67 | 67 | >>> sys.modules | ifilter("_.value is not None") | isort("_.key.lower()") |
|
68 | 68 | |
|
69 | 69 | does the same as:: |
|
70 | 70 | |
|
71 | 71 | >>> sys.modules | ifilter("value is not None") | isort("key.lower()") |
|
72 | 72 | |
|
73 | 73 | In addition to expression strings, it's possible to pass callables (taking |
|
74 | 74 | the object as an argument) to ``ifilter()``, ``isort()`` and ``ieval()``:: |
|
75 | 75 | |
|
76 | 76 | >>> sys | ifilter(lambda _:isinstance(_.value, int)) \ |
|
77 | 77 | ... | ieval(lambda _: (_.key, hex(_.value))) | idump |
|
78 | 78 | 0 |1 |
|
79 | 79 | api_version|0x3f4 |
|
80 | 80 | dllhandle |0x1e000000 |
|
81 | 81 | hexversion |0x20402f0 |
|
82 | 82 | maxint |0x7fffffff |
|
83 | 83 | maxunicode |0xffff |
|
84 | 84 | """ |
|
85 | 85 | |
|
86 | 86 | skip_doctest = True # ignore top-level docstring as a doctest. |
|
87 | 87 | |
|
88 | 88 | import sys, os, os.path, stat, glob, new, csv, datetime, types |
|
89 | 89 | import itertools, mimetypes, StringIO |
|
90 | 90 | |
|
91 | 91 | try: # Python 2.3 compatibility |
|
92 | 92 | import collections |
|
93 | 93 | except ImportError: |
|
94 | 94 | deque = list |
|
95 | 95 | else: |
|
96 | 96 | deque = collections.deque |
|
97 | 97 | |
|
98 | 98 | try: # Python 2.3 compatibility |
|
99 | 99 | set |
|
100 | 100 | except NameError: |
|
101 | 101 | import sets |
|
102 | 102 | set = sets.Set |
|
103 | 103 | |
|
104 | 104 | try: # Python 2.3 compatibility |
|
105 | 105 | sorted |
|
106 | 106 | except NameError: |
|
107 | 107 | def sorted(iterator, key=None, reverse=False): |
|
108 | 108 | items = list(iterator) |
|
109 | 109 | if key is not None: |
|
110 | 110 | items.sort(lambda i1, i2: cmp(key(i1), key(i2))) |
|
111 | 111 | else: |
|
112 | 112 | items.sort() |
|
113 | 113 | if reverse: |
|
114 | 114 | items.reverse() |
|
115 | 115 | return items |
|
116 | 116 | |
|
117 | 117 | try: # Python 2.4 compatibility |
|
118 | 118 | GeneratorExit |
|
119 | 119 | except NameError: |
|
120 | 120 | GeneratorExit = SystemExit |
|
121 | 121 | |
|
122 | 122 | try: |
|
123 | 123 | import pwd |
|
124 | 124 | except ImportError: |
|
125 | 125 | pwd = None |
|
126 | 126 | |
|
127 | 127 | try: |
|
128 | 128 | import grp |
|
129 | 129 | except ImportError: |
|
130 | 130 | grp = None |
|
131 | 131 | |
|
132 | 132 | from IPython.external import simplegeneric |
|
133 | 133 | from IPython.external import path |
|
134 | 134 | |
|
135 | 135 | try: |
|
136 | 136 | from IPython.utils import genutils |
|
137 | 137 | from IPython.utils import generics |
|
138 | 138 | except ImportError: |
|
139 | 139 | genutils = None |
|
140 | 140 | generics = None |
|
141 | 141 | |
|
142 | 142 | from IPython.core import ipapi |
|
143 | 143 | |
|
144 | 144 | |
|
145 | 145 | __all__ = [ |
|
146 | 146 | "ifile", "ils", "iglob", "iwalk", "ipwdentry", "ipwd", "igrpentry", "igrp", |
|
147 | 147 | "icsv", "ix", "ichain", "isort", "ifilter", "ieval", "ienum", |
|
148 | 148 | "ienv", "ihist", "ialias", "icap", "idump", "iless" |
|
149 | 149 | ] |
|
150 | 150 | |
|
151 | 151 | |
|
152 | 152 | os.stat_float_times(True) # enable microseconds |
|
153 | 153 | |
|
154 | 154 | |
|
155 | 155 | class AttrNamespace(object): |
|
156 | 156 | """ |
|
157 | 157 | Helper class that is used for providing a namespace for evaluating |
|
158 | 158 | expressions containing attribute names of an object. |
|
159 | 159 | """ |
|
160 | 160 | def __init__(self, wrapped): |
|
161 | 161 | self.wrapped = wrapped |
|
162 | 162 | |
|
163 | 163 | def __getitem__(self, name): |
|
164 | 164 | if name == "_": |
|
165 | 165 | return self.wrapped |
|
166 | 166 | try: |
|
167 | 167 | return getattr(self.wrapped, name) |
|
168 | 168 | except AttributeError: |
|
169 | 169 | raise KeyError(name) |
|
170 | 170 | |
|
171 | 171 | # Python 2.3 compatibility |
|
172 | 172 | # use eval workaround to find out which names are used in the |
|
173 | 173 | # eval string and put them into the locals. This works for most |
|
174 | 174 | # normal uses case, bizarre ones like accessing the locals() |
|
175 | 175 | # will fail |
|
176 | 176 | try: |
|
177 | 177 | eval("_", None, AttrNamespace(None)) |
|
178 | 178 | except TypeError: |
|
179 | 179 | real_eval = eval |
|
180 | 180 | def eval(codestring, _globals, _locals): |
|
181 | 181 | """ |
|
182 | 182 | eval(source[, globals[, locals]]) -> value |
|
183 | 183 | |
|
184 | 184 | Evaluate the source in the context of globals and locals. |
|
185 | 185 | The source may be a string representing a Python expression |
|
186 | 186 | or a code object as returned by compile(). |
|
187 | 187 | The globals must be a dictionary and locals can be any mappping. |
|
188 | 188 | |
|
189 | 189 | This function is a workaround for the shortcomings of |
|
190 | 190 | Python 2.3's eval. |
|
191 | 191 | """ |
|
192 | 192 | |
|
193 | 193 | if isinstance(codestring, basestring): |
|
194 | 194 | code = compile(codestring, "_eval", "eval") |
|
195 | 195 | else: |
|
196 | 196 | code = codestring |
|
197 | 197 | newlocals = {} |
|
198 | 198 | for name in code.co_names: |
|
199 | 199 | try: |
|
200 | 200 | newlocals[name] = _locals[name] |
|
201 | 201 | except KeyError: |
|
202 | 202 | pass |
|
203 | 203 | return real_eval(code, _globals, newlocals) |
|
204 | 204 | |
|
205 | 205 | |
|
206 | 206 | noitem = object() |
|
207 | 207 | |
|
208 | 208 | |
|
209 | 209 | def item(iterator, index, default=noitem): |
|
210 | 210 | """ |
|
211 | 211 | Return the ``index``th item from the iterator ``iterator``. |
|
212 | 212 | ``index`` must be an integer (negative integers are relative to the |
|
213 | 213 | end (i.e. the last items produced by the iterator)). |
|
214 | 214 | |
|
215 | 215 | If ``default`` is given, this will be the default value when |
|
216 | 216 | the iterator doesn't contain an item at this position. Otherwise an |
|
217 | 217 | ``IndexError`` will be raised. |
|
218 | 218 | |
|
219 | 219 | Note that using this function will partially or totally exhaust the |
|
220 | 220 | iterator. |
|
221 | 221 | """ |
|
222 | 222 | i = index |
|
223 | 223 | if i>=0: |
|
224 | 224 | for item in iterator: |
|
225 | 225 | if not i: |
|
226 | 226 | return item |
|
227 | 227 | i -= 1 |
|
228 | 228 | else: |
|
229 | 229 | i = -index |
|
230 | 230 | cache = deque() |
|
231 | 231 | for item in iterator: |
|
232 | 232 | cache.append(item) |
|
233 | 233 | if len(cache)>i: |
|
234 | 234 | cache.popleft() |
|
235 | 235 | if len(cache)==i: |
|
236 | 236 | return cache.popleft() |
|
237 | 237 | if default is noitem: |
|
238 | 238 | raise IndexError(index) |
|
239 | 239 | else: |
|
240 | 240 | return default |
|
241 | 241 | |
|
242 | 242 | |
|
243 | 243 | def getglobals(g): |
|
244 | 244 | """ |
|
245 | 245 | Return the global namespace that is used for expression strings in |
|
246 | 246 | ``ifilter`` and others. This is ``g`` or (if ``g`` is ``None``) IPython's |
|
247 | 247 | user namespace. |
|
248 | 248 | """ |
|
249 | 249 | if g is None: |
|
250 | 250 | if ipapi is not None: |
|
251 | 251 | api = ipapi.get() |
|
252 | 252 | if api is not None: |
|
253 | 253 | return api.user_ns |
|
254 | 254 | return globals() |
|
255 | 255 | return g |
|
256 | 256 | |
|
257 | 257 | |
|
258 | 258 | class Descriptor(object): |
|
259 | 259 | """ |
|
260 | 260 | A ``Descriptor`` object is used for describing the attributes of objects. |
|
261 | 261 | """ |
|
262 | 262 | def __hash__(self): |
|
263 | 263 | return hash(self.__class__) ^ hash(self.key()) |
|
264 | 264 | |
|
265 | 265 | def __eq__(self, other): |
|
266 | 266 | return self.__class__ is other.__class__ and self.key() == other.key() |
|
267 | 267 | |
|
268 | 268 | def __ne__(self, other): |
|
269 | 269 | return self.__class__ is not other.__class__ or self.key() != other.key() |
|
270 | 270 | |
|
271 | 271 | def key(self): |
|
272 | 272 | pass |
|
273 | 273 | |
|
274 | 274 | def name(self): |
|
275 | 275 | """ |
|
276 | 276 | Return the name of this attribute for display by a ``Display`` object |
|
277 | 277 | (e.g. as a column title). |
|
278 | 278 | """ |
|
279 | 279 | key = self.key() |
|
280 | 280 | if key is None: |
|
281 | 281 | return "_" |
|
282 | 282 | return str(key) |
|
283 | 283 | |
|
284 | 284 | def attrtype(self, obj): |
|
285 | 285 | """ |
|
286 | 286 | Return the type of this attribute (i.e. something like "attribute" or |
|
287 | 287 | "method"). |
|
288 | 288 | """ |
|
289 | 289 | |
|
290 | 290 | def valuetype(self, obj): |
|
291 | 291 | """ |
|
292 | 292 | Return the type of this attribute value of the object ``obj``. |
|
293 | 293 | """ |
|
294 | 294 | |
|
295 | 295 | def value(self, obj): |
|
296 | 296 | """ |
|
297 | 297 | Return the value of this attribute of the object ``obj``. |
|
298 | 298 | """ |
|
299 | 299 | |
|
300 | 300 | def doc(self, obj): |
|
301 | 301 | """ |
|
302 | 302 | Return the documentation for this attribute. |
|
303 | 303 | """ |
|
304 | 304 | |
|
305 | 305 | def shortdoc(self, obj): |
|
306 | 306 | """ |
|
307 | 307 | Return a short documentation for this attribute (defaulting to the |
|
308 | 308 | first line). |
|
309 | 309 | """ |
|
310 | 310 | doc = self.doc(obj) |
|
311 | 311 | if doc is not None: |
|
312 | 312 | doc = doc.strip().splitlines()[0].strip() |
|
313 | 313 | return doc |
|
314 | 314 | |
|
315 | 315 | def iter(self, obj): |
|
316 | 316 | """ |
|
317 | 317 | Return an iterator for this attribute of the object ``obj``. |
|
318 | 318 | """ |
|
319 | 319 | return xiter(self.value(obj)) |
|
320 | 320 | |
|
321 | 321 | |
|
322 | 322 | class SelfDescriptor(Descriptor): |
|
323 | 323 | """ |
|
324 | 324 | A ``SelfDescriptor`` describes the object itself. |
|
325 | 325 | """ |
|
326 | 326 | def key(self): |
|
327 | 327 | return None |
|
328 | 328 | |
|
329 | 329 | def attrtype(self, obj): |
|
330 | 330 | return "self" |
|
331 | 331 | |
|
332 | 332 | def valuetype(self, obj): |
|
333 | 333 | return type(obj) |
|
334 | 334 | |
|
335 | 335 | def value(self, obj): |
|
336 | 336 | return obj |
|
337 | 337 | |
|
338 | 338 | def __repr__(self): |
|
339 | 339 | return "Self" |
|
340 | 340 | |
|
341 | 341 | selfdescriptor = SelfDescriptor() # there's no need for more than one |
|
342 | 342 | |
|
343 | 343 | |
|
344 | 344 | class AttributeDescriptor(Descriptor): |
|
345 | 345 | """ |
|
346 | 346 | An ``AttributeDescriptor`` describes a simple attribute of an object. |
|
347 | 347 | """ |
|
348 | 348 | __slots__ = ("_name", "_doc") |
|
349 | 349 | |
|
350 | 350 | def __init__(self, name, doc=None): |
|
351 | 351 | self._name = name |
|
352 | 352 | self._doc = doc |
|
353 | 353 | |
|
354 | 354 | def key(self): |
|
355 | 355 | return self._name |
|
356 | 356 | |
|
357 | 357 | def doc(self, obj): |
|
358 | 358 | return self._doc |
|
359 | 359 | |
|
360 | 360 | def attrtype(self, obj): |
|
361 | 361 | return "attr" |
|
362 | 362 | |
|
363 | 363 | def valuetype(self, obj): |
|
364 | 364 | return type(getattr(obj, self._name)) |
|
365 | 365 | |
|
366 | 366 | def value(self, obj): |
|
367 | 367 | return getattr(obj, self._name) |
|
368 | 368 | |
|
369 | 369 | def __repr__(self): |
|
370 | 370 | if self._doc is None: |
|
371 | 371 | return "Attribute(%r)" % self._name |
|
372 | 372 | else: |
|
373 | 373 | return "Attribute(%r, %r)" % (self._name, self._doc) |
|
374 | 374 | |
|
375 | 375 | |
|
376 | 376 | class IndexDescriptor(Descriptor): |
|
377 | 377 | """ |
|
378 | 378 | An ``IndexDescriptor`` describes an "attribute" of an object that is fetched |
|
379 | 379 | via ``__getitem__``. |
|
380 | 380 | """ |
|
381 | 381 | __slots__ = ("_index",) |
|
382 | 382 | |
|
383 | 383 | def __init__(self, index): |
|
384 | 384 | self._index = index |
|
385 | 385 | |
|
386 | 386 | def key(self): |
|
387 | 387 | return self._index |
|
388 | 388 | |
|
389 | 389 | def attrtype(self, obj): |
|
390 | 390 | return "item" |
|
391 | 391 | |
|
392 | 392 | def valuetype(self, obj): |
|
393 | 393 | return type(obj[self._index]) |
|
394 | 394 | |
|
395 | 395 | def value(self, obj): |
|
396 | 396 | return obj[self._index] |
|
397 | 397 | |
|
398 | 398 | def __repr__(self): |
|
399 | 399 | return "Index(%r)" % self._index |
|
400 | 400 | |
|
401 | 401 | |
|
402 | 402 | class MethodDescriptor(Descriptor): |
|
403 | 403 | """ |
|
404 | 404 | A ``MethodDescriptor`` describes a method of an object that can be called |
|
405 | 405 | without argument. Note that this method shouldn't change the object. |
|
406 | 406 | """ |
|
407 | 407 | __slots__ = ("_name", "_doc") |
|
408 | 408 | |
|
409 | 409 | def __init__(self, name, doc=None): |
|
410 | 410 | self._name = name |
|
411 | 411 | self._doc = doc |
|
412 | 412 | |
|
413 | 413 | def key(self): |
|
414 | 414 | return self._name |
|
415 | 415 | |
|
416 | 416 | def doc(self, obj): |
|
417 | 417 | if self._doc is None: |
|
418 | 418 | return getattr(obj, self._name).__doc__ |
|
419 | 419 | return self._doc |
|
420 | 420 | |
|
421 | 421 | def attrtype(self, obj): |
|
422 | 422 | return "method" |
|
423 | 423 | |
|
424 | 424 | def valuetype(self, obj): |
|
425 | 425 | return type(self.value(obj)) |
|
426 | 426 | |
|
427 | 427 | def value(self, obj): |
|
428 | 428 | return getattr(obj, self._name)() |
|
429 | 429 | |
|
430 | 430 | def __repr__(self): |
|
431 | 431 | if self._doc is None: |
|
432 | 432 | return "Method(%r)" % self._name |
|
433 | 433 | else: |
|
434 | 434 | return "Method(%r, %r)" % (self._name, self._doc) |
|
435 | 435 | |
|
436 | 436 | |
|
437 | 437 | class IterAttributeDescriptor(Descriptor): |
|
438 | 438 | """ |
|
439 | 439 | An ``IterAttributeDescriptor`` works like an ``AttributeDescriptor`` but |
|
440 | 440 | doesn't return an attribute values (because this value might be e.g. a large |
|
441 | 441 | list). |
|
442 | 442 | """ |
|
443 | 443 | __slots__ = ("_name", "_doc") |
|
444 | 444 | |
|
445 | 445 | def __init__(self, name, doc=None): |
|
446 | 446 | self._name = name |
|
447 | 447 | self._doc = doc |
|
448 | 448 | |
|
449 | 449 | def key(self): |
|
450 | 450 | return self._name |
|
451 | 451 | |
|
452 | 452 | def doc(self, obj): |
|
453 | 453 | return self._doc |
|
454 | 454 | |
|
455 | 455 | def attrtype(self, obj): |
|
456 | 456 | return "iter" |
|
457 | 457 | |
|
458 | 458 | def valuetype(self, obj): |
|
459 | 459 | return noitem |
|
460 | 460 | |
|
461 | 461 | def value(self, obj): |
|
462 | 462 | return noitem |
|
463 | 463 | |
|
464 | 464 | def iter(self, obj): |
|
465 | 465 | return xiter(getattr(obj, self._name)) |
|
466 | 466 | |
|
467 | 467 | def __repr__(self): |
|
468 | 468 | if self._doc is None: |
|
469 | 469 | return "IterAttribute(%r)" % self._name |
|
470 | 470 | else: |
|
471 | 471 | return "IterAttribute(%r, %r)" % (self._name, self._doc) |
|
472 | 472 | |
|
473 | 473 | |
|
474 | 474 | class IterMethodDescriptor(Descriptor): |
|
475 | 475 | """ |
|
476 | 476 | An ``IterMethodDescriptor`` works like an ``MethodDescriptor`` but doesn't |
|
477 | 477 | return an attribute values (because this value might be e.g. a large list). |
|
478 | 478 | """ |
|
479 | 479 | __slots__ = ("_name", "_doc") |
|
480 | 480 | |
|
481 | 481 | def __init__(self, name, doc=None): |
|
482 | 482 | self._name = name |
|
483 | 483 | self._doc = doc |
|
484 | 484 | |
|
485 | 485 | def key(self): |
|
486 | 486 | return self._name |
|
487 | 487 | |
|
488 | 488 | def doc(self, obj): |
|
489 | 489 | if self._doc is None: |
|
490 | 490 | return getattr(obj, self._name).__doc__ |
|
491 | 491 | return self._doc |
|
492 | 492 | |
|
493 | 493 | def attrtype(self, obj): |
|
494 | 494 | return "itermethod" |
|
495 | 495 | |
|
496 | 496 | def valuetype(self, obj): |
|
497 | 497 | return noitem |
|
498 | 498 | |
|
499 | 499 | def value(self, obj): |
|
500 | 500 | return noitem |
|
501 | 501 | |
|
502 | 502 | def iter(self, obj): |
|
503 | 503 | return xiter(getattr(obj, self._name)()) |
|
504 | 504 | |
|
505 | 505 | def __repr__(self): |
|
506 | 506 | if self._doc is None: |
|
507 | 507 | return "IterMethod(%r)" % self._name |
|
508 | 508 | else: |
|
509 | 509 | return "IterMethod(%r, %r)" % (self._name, self._doc) |
|
510 | 510 | |
|
511 | 511 | |
|
512 | 512 | class FunctionDescriptor(Descriptor): |
|
513 | 513 | """ |
|
514 | 514 | A ``FunctionDescriptor`` turns a function into a descriptor. The function |
|
515 | 515 | will be called with the object to get the type and value of the attribute. |
|
516 | 516 | """ |
|
517 | 517 | __slots__ = ("_function", "_name", "_doc") |
|
518 | 518 | |
|
519 | 519 | def __init__(self, function, name=None, doc=None): |
|
520 | 520 | self._function = function |
|
521 | 521 | self._name = name |
|
522 | 522 | self._doc = doc |
|
523 | 523 | |
|
524 | 524 | def key(self): |
|
525 | 525 | return self._function |
|
526 | 526 | |
|
527 | 527 | def name(self): |
|
528 | 528 | if self._name is not None: |
|
529 | 529 | return self._name |
|
530 | 530 | return getattr(self._function, "__xname__", self._function.__name__) |
|
531 | 531 | |
|
532 | 532 | def doc(self, obj): |
|
533 | 533 | if self._doc is None: |
|
534 | 534 | return self._function.__doc__ |
|
535 | 535 | return self._doc |
|
536 | 536 | |
|
537 | 537 | def attrtype(self, obj): |
|
538 | 538 | return "function" |
|
539 | 539 | |
|
540 | 540 | def valuetype(self, obj): |
|
541 | 541 | return type(self._function(obj)) |
|
542 | 542 | |
|
543 | 543 | def value(self, obj): |
|
544 | 544 | return self._function(obj) |
|
545 | 545 | |
|
546 | 546 | def __repr__(self): |
|
547 | 547 | if self._doc is None: |
|
548 | 548 | return "Function(%r)" % self._name |
|
549 | 549 | else: |
|
550 | 550 | return "Function(%r, %r)" % (self._name, self._doc) |
|
551 | 551 | |
|
552 | 552 | |
|
553 | 553 | class Table(object): |
|
554 | 554 | """ |
|
555 | 555 | A ``Table`` is an object that produces items (just like a normal Python |
|
556 | 556 | iterator/generator does) and can be used as the first object in a pipeline |
|
557 | 557 | expression. The displayhook will open the default browser for such an object |
|
558 | 558 | (instead of simply printing the ``repr()`` result). |
|
559 | 559 | """ |
|
560 | 560 | |
|
561 | 561 | # We want to support ``foo`` and ``foo()`` in pipeline expression: |
|
562 | 562 | # So we implement the required operators (``|`` and ``+``) in the metaclass, |
|
563 | 563 | # instantiate the class and forward the operator to the instance |
|
564 | 564 | class __metaclass__(type): |
|
565 | 565 | def __iter__(self): |
|
566 | 566 | return iter(self()) |
|
567 | 567 | |
|
568 | 568 | def __or__(self, other): |
|
569 | 569 | return self() | other |
|
570 | 570 | |
|
571 | 571 | def __add__(self, other): |
|
572 | 572 | return self() + other |
|
573 | 573 | |
|
574 | 574 | def __radd__(self, other): |
|
575 | 575 | return other + self() |
|
576 | 576 | |
|
577 | 577 | def __getitem__(self, index): |
|
578 | 578 | return self()[index] |
|
579 | 579 | |
|
580 | 580 | def __getitem__(self, index): |
|
581 | 581 | return item(self, index) |
|
582 | 582 | |
|
583 | 583 | def __contains__(self, item): |
|
584 | 584 | for haveitem in self: |
|
585 | 585 | if item == haveitem: |
|
586 | 586 | return True |
|
587 | 587 | return False |
|
588 | 588 | |
|
589 | 589 | def __or__(self, other): |
|
590 | 590 | # autoinstantiate right hand side |
|
591 | 591 | if isinstance(other, type) and issubclass(other, (Table, Display)): |
|
592 | 592 | other = other() |
|
593 | 593 | # treat simple strings and functions as ``ieval`` instances |
|
594 | 594 | elif not isinstance(other, Display) and not isinstance(other, Table): |
|
595 | 595 | other = ieval(other) |
|
596 | 596 | # forward operations to the right hand side |
|
597 | 597 | return other.__ror__(self) |
|
598 | 598 | |
|
599 | 599 | def __add__(self, other): |
|
600 | 600 | # autoinstantiate right hand side |
|
601 | 601 | if isinstance(other, type) and issubclass(other, Table): |
|
602 | 602 | other = other() |
|
603 | 603 | return ichain(self, other) |
|
604 | 604 | |
|
605 | 605 | def __radd__(self, other): |
|
606 | 606 | # autoinstantiate left hand side |
|
607 | 607 | if isinstance(other, type) and issubclass(other, Table): |
|
608 | 608 | other = other() |
|
609 | 609 | return ichain(other, self) |
|
610 | 610 | |
|
611 | 611 | |
|
612 | 612 | class Pipe(Table): |
|
613 | 613 | """ |
|
614 | 614 | A ``Pipe`` is an object that can be used in a pipeline expression. It |
|
615 | 615 | processes the objects it gets from its input ``Table``/``Pipe``. Note that |
|
616 | 616 | a ``Pipe`` object can't be used as the first object in a pipeline |
|
617 | 617 | expression, as it doesn't produces items itself. |
|
618 | 618 | """ |
|
619 | 619 | class __metaclass__(Table.__metaclass__): |
|
620 | 620 | def __ror__(self, input): |
|
621 | 621 | return input | self() |
|
622 | 622 | |
|
623 | 623 | def __ror__(self, input): |
|
624 | 624 | # autoinstantiate left hand side |
|
625 | 625 | if isinstance(input, type) and issubclass(input, Table): |
|
626 | 626 | input = input() |
|
627 | 627 | self.input = input |
|
628 | 628 | return self |
|
629 | 629 | |
|
630 | 630 | |
|
631 | 631 | def xrepr(item, mode="default"): |
|
632 | 632 | """ |
|
633 | 633 | Generic function that adds color output and different display modes to ``repr``. |
|
634 | 634 | |
|
635 | 635 | The result of an ``xrepr`` call is iterable and consists of ``(style, string)`` |
|
636 | 636 | tuples. The ``style`` in this tuple must be a ``Style`` object from the |
|
637 | 637 | ``astring`` module. To reconfigure the output the first yielded tuple can be |
|
638 | 638 | a ``(aligment, full)`` tuple instead of a ``(style, string)`` tuple. |
|
639 | 639 | ``alignment`` can be -1 for left aligned, 0 for centered and 1 for right |
|
640 | 640 | aligned (the default is left alignment). ``full`` is a boolean that specifies |
|
641 | 641 | whether the complete output must be displayed or the ``Display`` object is |
|
642 | 642 | allowed to stop output after enough text has been produced (e.g. a syntax |
|
643 | 643 | highlighted text line would use ``True``, but for a large data structure |
|
644 | 644 | (i.e. a nested list, tuple or dictionary) ``False`` would be used). |
|
645 | 645 | The default is full output. |
|
646 | 646 | |
|
647 | 647 | There are four different possible values for ``mode`` depending on where |
|
648 | 648 | the ``Display`` object will display ``item``: |
|
649 | 649 | |
|
650 | 650 | ``"header"`` |
|
651 | 651 | ``item`` will be displayed in a header line (this is used by ``ibrowse``). |
|
652 | 652 | |
|
653 | 653 | ``"footer"`` |
|
654 | 654 | ``item`` will be displayed in a footer line (this is used by ``ibrowse``). |
|
655 | 655 | |
|
656 | 656 | ``"cell"`` |
|
657 | 657 | ``item`` will be displayed in a table cell/list. |
|
658 | 658 | |
|
659 | 659 | ``"default"`` |
|
660 | 660 | default mode. If an ``xrepr`` implementation recursively outputs objects, |
|
661 | 661 | ``"default"`` must be passed in the recursive calls to ``xrepr``. |
|
662 | 662 | |
|
663 | 663 | If no implementation is registered for ``item``, ``xrepr`` will try the |
|
664 | 664 | ``__xrepr__`` method on ``item``. If ``item`` doesn't have an ``__xrepr__`` |
|
665 | 665 | method it falls back to ``repr``/``__repr__`` for all modes. |
|
666 | 666 | """ |
|
667 | 667 | try: |
|
668 | 668 | func = item.__xrepr__ |
|
669 | 669 | except AttributeError: |
|
670 | 670 | yield (astyle.style_default, repr(item)) |
|
671 | 671 | else: |
|
672 | 672 | try: |
|
673 | 673 | for x in func(mode): |
|
674 | 674 | yield x |
|
675 | 675 | except (KeyboardInterrupt, SystemExit, GeneratorExit): |
|
676 | 676 | raise |
|
677 | 677 | except Exception: |
|
678 | 678 | yield (astyle.style_default, repr(item)) |
|
679 | 679 | xrepr = simplegeneric.generic(xrepr) |
|
680 | 680 | |
|
681 | 681 | |
|
682 | 682 | def xrepr_none(self, mode="default"): |
|
683 | 683 | yield (astyle.style_type_none, repr(self)) |
|
684 | 684 | xrepr.when_object(None)(xrepr_none) |
|
685 | 685 | |
|
686 | 686 | |
|
687 | 687 | def xrepr_noitem(self, mode="default"): |
|
688 | 688 | yield (2, True) |
|
689 | 689 | yield (astyle.style_nodata, "<?>") |
|
690 | 690 | xrepr.when_object(noitem)(xrepr_noitem) |
|
691 | 691 | |
|
692 | 692 | |
|
693 | 693 | def xrepr_bool(self, mode="default"): |
|
694 | 694 | yield (astyle.style_type_bool, repr(self)) |
|
695 | 695 | xrepr.when_type(bool)(xrepr_bool) |
|
696 | 696 | |
|
697 | 697 | |
|
698 | 698 | def xrepr_str(self, mode="default"): |
|
699 | 699 | if mode == "cell": |
|
700 | 700 | yield (astyle.style_default, repr(self.expandtabs(tab))[1:-1]) |
|
701 | 701 | else: |
|
702 | 702 | yield (astyle.style_default, repr(self)) |
|
703 | 703 | xrepr.when_type(str)(xrepr_str) |
|
704 | 704 | |
|
705 | 705 | |
|
706 | 706 | def xrepr_unicode(self, mode="default"): |
|
707 | 707 | if mode == "cell": |
|
708 | 708 | yield (astyle.style_default, repr(self.expandtabs(tab))[2:-1]) |
|
709 | 709 | else: |
|
710 | 710 | yield (astyle.style_default, repr(self)) |
|
711 | 711 | xrepr.when_type(unicode)(xrepr_unicode) |
|
712 | 712 | |
|
713 | 713 | |
|
714 | 714 | def xrepr_number(self, mode="default"): |
|
715 | 715 | yield (1, True) |
|
716 | 716 | yield (astyle.style_type_number, repr(self)) |
|
717 | 717 | xrepr.when_type(int)(xrepr_number) |
|
718 | 718 | xrepr.when_type(long)(xrepr_number) |
|
719 | 719 | xrepr.when_type(float)(xrepr_number) |
|
720 | 720 | |
|
721 | 721 | |
|
722 | 722 | def xrepr_complex(self, mode="default"): |
|
723 | 723 | yield (astyle.style_type_number, repr(self)) |
|
724 | 724 | xrepr.when_type(complex)(xrepr_number) |
|
725 | 725 | |
|
726 | 726 | |
|
727 | 727 | def xrepr_datetime(self, mode="default"): |
|
728 | 728 | if mode == "cell": |
|
729 | 729 | # Don't use strftime() here, as this requires year >= 1900 |
|
730 | 730 | yield (astyle.style_type_datetime, |
|
731 | 731 | "%04d-%02d-%02d %02d:%02d:%02d.%06d" % \ |
|
732 | 732 | (self.year, self.month, self.day, |
|
733 | 733 | self.hour, self.minute, self.second, |
|
734 | 734 | self.microsecond), |
|
735 | 735 | ) |
|
736 | 736 | else: |
|
737 | 737 | yield (astyle.style_type_datetime, repr(self)) |
|
738 | 738 | xrepr.when_type(datetime.datetime)(xrepr_datetime) |
|
739 | 739 | |
|
740 | 740 | |
|
741 | 741 | def xrepr_date(self, mode="default"): |
|
742 | 742 | if mode == "cell": |
|
743 | 743 | yield (astyle.style_type_datetime, |
|
744 | 744 | "%04d-%02d-%02d" % (self.year, self.month, self.day)) |
|
745 | 745 | else: |
|
746 | 746 | yield (astyle.style_type_datetime, repr(self)) |
|
747 | 747 | xrepr.when_type(datetime.date)(xrepr_date) |
|
748 | 748 | |
|
749 | 749 | |
|
750 | 750 | def xrepr_time(self, mode="default"): |
|
751 | 751 | if mode == "cell": |
|
752 | 752 | yield (astyle.style_type_datetime, |
|
753 | 753 | "%02d:%02d:%02d.%06d" % \ |
|
754 | 754 | (self.hour, self.minute, self.second, self.microsecond)) |
|
755 | 755 | else: |
|
756 | 756 | yield (astyle.style_type_datetime, repr(self)) |
|
757 | 757 | xrepr.when_type(datetime.time)(xrepr_time) |
|
758 | 758 | |
|
759 | 759 | |
|
760 | 760 | def xrepr_timedelta(self, mode="default"): |
|
761 | 761 | yield (astyle.style_type_datetime, repr(self)) |
|
762 | 762 | xrepr.when_type(datetime.timedelta)(xrepr_timedelta) |
|
763 | 763 | |
|
764 | 764 | |
|
765 | 765 | def xrepr_type(self, mode="default"): |
|
766 | 766 | if self.__module__ == "__builtin__": |
|
767 | 767 | yield (astyle.style_type_type, self.__name__) |
|
768 | 768 | else: |
|
769 | 769 | yield (astyle.style_type_type, "%s.%s" % (self.__module__, self.__name__)) |
|
770 | 770 | xrepr.when_type(type)(xrepr_type) |
|
771 | 771 | |
|
772 | 772 | |
|
773 | 773 | def xrepr_exception(self, mode="default"): |
|
774 | 774 | if self.__class__.__module__ == "exceptions": |
|
775 | 775 | classname = self.__class__.__name__ |
|
776 | 776 | else: |
|
777 | 777 | classname = "%s.%s" % \ |
|
778 | 778 | (self.__class__.__module__, self.__class__.__name__) |
|
779 | 779 | if mode == "header" or mode == "footer": |
|
780 | 780 | yield (astyle.style_error, "%s: %s" % (classname, self)) |
|
781 | 781 | else: |
|
782 | 782 | yield (astyle.style_error, classname) |
|
783 | 783 | xrepr.when_type(Exception)(xrepr_exception) |
|
784 | 784 | |
|
785 | 785 | |
|
786 | 786 | def xrepr_listtuple(self, mode="default"): |
|
787 | 787 | if mode == "header" or mode == "footer": |
|
788 | 788 | if self.__class__.__module__ == "__builtin__": |
|
789 | 789 | classname = self.__class__.__name__ |
|
790 | 790 | else: |
|
791 | 791 | classname = "%s.%s" % \ |
|
792 | 792 | (self.__class__.__module__,self.__class__.__name__) |
|
793 | 793 | yield (astyle.style_default, |
|
794 | 794 | "<%s object with %d items at 0x%x>" % \ |
|
795 | 795 | (classname, len(self), id(self))) |
|
796 | 796 | else: |
|
797 | 797 | yield (-1, False) |
|
798 | 798 | if isinstance(self, list): |
|
799 | 799 | yield (astyle.style_default, "[") |
|
800 | 800 | end = "]" |
|
801 | 801 | else: |
|
802 | 802 | yield (astyle.style_default, "(") |
|
803 | 803 | end = ")" |
|
804 | 804 | for (i, subself) in enumerate(self): |
|
805 | 805 | if i: |
|
806 | 806 | yield (astyle.style_default, ", ") |
|
807 | 807 | for part in xrepr(subself, "default"): |
|
808 | 808 | yield part |
|
809 | 809 | yield (astyle.style_default, end) |
|
810 | 810 | xrepr.when_type(list)(xrepr_listtuple) |
|
811 | 811 | xrepr.when_type(tuple)(xrepr_listtuple) |
|
812 | 812 | |
|
813 | 813 | |
|
814 | 814 | def xrepr_dict(self, mode="default"): |
|
815 | 815 | if mode == "header" or mode == "footer": |
|
816 | 816 | if self.__class__.__module__ == "__builtin__": |
|
817 | 817 | classname = self.__class__.__name__ |
|
818 | 818 | else: |
|
819 | 819 | classname = "%s.%s" % \ |
|
820 | 820 | (self.__class__.__module__,self.__class__.__name__) |
|
821 | 821 | yield (astyle.style_default, |
|
822 | 822 | "<%s object with %d items at 0x%x>" % \ |
|
823 | 823 | (classname, len(self), id(self))) |
|
824 | 824 | else: |
|
825 | 825 | yield (-1, False) |
|
826 | 826 | if isinstance(self, dict): |
|
827 | 827 | yield (astyle.style_default, "{") |
|
828 | 828 | end = "}" |
|
829 | 829 | else: |
|
830 | 830 | yield (astyle.style_default, "dictproxy((") |
|
831 | 831 | end = "})" |
|
832 | 832 | for (i, (key, value)) in enumerate(self.iteritems()): |
|
833 | 833 | if i: |
|
834 | 834 | yield (astyle.style_default, ", ") |
|
835 | 835 | for part in xrepr(key, "default"): |
|
836 | 836 | yield part |
|
837 | 837 | yield (astyle.style_default, ": ") |
|
838 | 838 | for part in xrepr(value, "default"): |
|
839 | 839 | yield part |
|
840 | 840 | yield (astyle.style_default, end) |
|
841 | 841 | xrepr.when_type(dict)(xrepr_dict) |
|
842 | 842 | xrepr.when_type(types.DictProxyType)(xrepr_dict) |
|
843 | 843 | |
|
844 | 844 | |
|
845 | 845 | def upgradexattr(attr): |
|
846 | 846 | """ |
|
847 | 847 | Convert an attribute descriptor string to a real descriptor object. |
|
848 | 848 | |
|
849 | 849 | If attr already is a descriptor object return it unmodified. A |
|
850 | 850 | ``SelfDescriptor`` will be returned if ``attr`` is ``None``. ``"foo"`` |
|
851 | 851 | returns an ``AttributeDescriptor`` for the attribute named ``"foo"``. |
|
852 | 852 | ``"foo()"`` returns a ``MethodDescriptor`` for the method named ``"foo"``. |
|
853 | 853 | ``"-foo"`` will return an ``IterAttributeDescriptor`` for the attribute |
|
854 | 854 | named ``"foo"`` and ``"-foo()"`` will return an ``IterMethodDescriptor`` |
|
855 | 855 | for the method named ``"foo"``. Furthermore integers will return the appropriate |
|
856 | 856 | ``IndexDescriptor`` and callables will return a ``FunctionDescriptor``. |
|
857 | 857 | """ |
|
858 | 858 | if attr is None: |
|
859 | 859 | return selfdescriptor |
|
860 | 860 | elif isinstance(attr, Descriptor): |
|
861 | 861 | return attr |
|
862 | 862 | elif isinstance(attr, basestring): |
|
863 | 863 | if attr.endswith("()"): |
|
864 | 864 | if attr.startswith("-"): |
|
865 | 865 | return IterMethodDescriptor(attr[1:-2]) |
|
866 | 866 | else: |
|
867 | 867 | return MethodDescriptor(attr[:-2]) |
|
868 | 868 | else: |
|
869 | 869 | if attr.startswith("-"): |
|
870 | 870 | return IterAttributeDescriptor(attr[1:]) |
|
871 | 871 | else: |
|
872 | 872 | return AttributeDescriptor(attr) |
|
873 | 873 | elif isinstance(attr, (int, long)): |
|
874 | 874 | return IndexDescriptor(attr) |
|
875 | 875 | elif callable(attr): |
|
876 | 876 | return FunctionDescriptor(attr) |
|
877 | 877 | else: |
|
878 | 878 | raise TypeError("can't handle descriptor %r" % attr) |
|
879 | 879 | |
|
880 | 880 | |
|
881 | 881 | def xattrs(item, mode="default"): |
|
882 | 882 | """ |
|
883 | 883 | Generic function that returns an iterable of attribute descriptors |
|
884 | 884 | to be used for displaying the attributes ob the object ``item`` in display |
|
885 | 885 | mode ``mode``. |
|
886 | 886 | |
|
887 | 887 | There are two possible modes: |
|
888 | 888 | |
|
889 | 889 | ``"detail"`` |
|
890 | 890 | The ``Display`` object wants to display a detailed list of the object |
|
891 | 891 | attributes. |
|
892 | 892 | |
|
893 | 893 | ``"default"`` |
|
894 | 894 | The ``Display`` object wants to display the object in a list view. |
|
895 | 895 | |
|
896 | 896 | If no implementation is registered for the object ``item`` ``xattrs`` falls |
|
897 | 897 | back to trying the ``__xattrs__`` method of the object. If this doesn't |
|
898 | 898 | exist either, ``dir(item)`` is used for ``"detail"`` mode and ``(None,)`` |
|
899 | 899 | for ``"default"`` mode. |
|
900 | 900 | |
|
901 | 901 | The implementation must yield attribute descriptors (see the class |
|
902 | 902 | ``Descriptor`` for more info). The ``__xattrs__`` method may also return |
|
903 | 903 | attribute descriptor strings (and ``None``) which will be converted to real |
|
904 | 904 | descriptors by ``upgradexattr()``. |
|
905 | 905 | """ |
|
906 | 906 | try: |
|
907 | 907 | func = item.__xattrs__ |
|
908 | 908 | except AttributeError: |
|
909 | 909 | if mode == "detail": |
|
910 | 910 | for attrname in dir(item): |
|
911 | 911 | yield AttributeDescriptor(attrname) |
|
912 | 912 | else: |
|
913 | 913 | yield selfdescriptor |
|
914 | 914 | else: |
|
915 | 915 | for attr in func(mode): |
|
916 | 916 | yield upgradexattr(attr) |
|
917 | 917 | xattrs = simplegeneric.generic(xattrs) |
|
918 | 918 | |
|
919 | 919 | |
|
920 | 920 | def xattrs_complex(self, mode="default"): |
|
921 | 921 | if mode == "detail": |
|
922 | 922 | return (AttributeDescriptor("real"), AttributeDescriptor("imag")) |
|
923 | 923 | return (selfdescriptor,) |
|
924 | 924 | xattrs.when_type(complex)(xattrs_complex) |
|
925 | 925 | |
|
926 | 926 | |
|
927 | 927 | def _isdict(item): |
|
928 | 928 | try: |
|
929 | 929 | itermeth = item.__class__.__iter__ |
|
930 | 930 | except (AttributeError, TypeError): |
|
931 | 931 | return False |
|
932 | 932 | return itermeth is dict.__iter__ or itermeth is types.DictProxyType.__iter__ |
|
933 | 933 | |
|
934 | 934 | |
|
935 | 935 | def _isstr(item): |
|
936 | 936 | if not isinstance(item, basestring): |
|
937 | 937 | return False |
|
938 | 938 | try: |
|
939 | 939 | itermeth = item.__class__.__iter__ |
|
940 | 940 | except AttributeError: |
|
941 | 941 | return True |
|
942 | 942 | return False # ``__iter__`` has been redefined |
|
943 | 943 | |
|
944 | 944 | |
|
945 | 945 | def xiter(item): |
|
946 | 946 | """ |
|
947 | 947 | Generic function that implements iteration for pipeline expression. If no |
|
948 | 948 | implementation is registered for ``item`` ``xiter`` falls back to ``iter``. |
|
949 | 949 | """ |
|
950 | 950 | try: |
|
951 | 951 | func = item.__xiter__ |
|
952 | 952 | except AttributeError: |
|
953 | 953 | if _isdict(item): |
|
954 | 954 | def items(item): |
|
955 | 955 | fields = ("key", "value") |
|
956 | 956 | for (key, value) in item.iteritems(): |
|
957 | 957 | yield Fields(fields, key=key, value=value) |
|
958 | 958 | return items(item) |
|
959 | 959 | elif isinstance(item, new.module): |
|
960 | 960 | def items(item): |
|
961 | 961 | fields = ("key", "value") |
|
962 | 962 | for key in sorted(item.__dict__): |
|
963 | 963 | yield Fields(fields, key=key, value=getattr(item, key)) |
|
964 | 964 | return items(item) |
|
965 | 965 | elif _isstr(item): |
|
966 | 966 | if not item: |
|
967 | 967 | raise ValueError("can't enter empty string") |
|
968 | 968 | lines = item.splitlines() |
|
969 | 969 | if len(lines) == 1: |
|
970 | 970 | def iterone(item): |
|
971 | 971 | yield item |
|
972 | 972 | return iterone(item) |
|
973 | 973 | else: |
|
974 | 974 | return iter(lines) |
|
975 | 975 | return iter(item) |
|
976 | 976 | else: |
|
977 | 977 | return iter(func()) # iter() just to be safe |
|
978 | 978 | xiter = simplegeneric.generic(xiter) |
|
979 | 979 | |
|
980 | 980 | |
|
981 | 981 | class ichain(Pipe): |
|
982 | 982 | """ |
|
983 | 983 | Chains multiple ``Table``s into one. |
|
984 | 984 | """ |
|
985 | 985 | |
|
986 | 986 | def __init__(self, *iters): |
|
987 | 987 | self.iters = iters |
|
988 | 988 | |
|
989 | 989 | def __iter__(self): |
|
990 | 990 | return itertools.chain(*self.iters) |
|
991 | 991 | |
|
992 | 992 | def __xrepr__(self, mode="default"): |
|
993 | 993 | if mode == "header" or mode == "footer": |
|
994 | 994 | for (i, item) in enumerate(self.iters): |
|
995 | 995 | if i: |
|
996 | 996 | yield (astyle.style_default, "+") |
|
997 | 997 | if isinstance(item, Pipe): |
|
998 | 998 | yield (astyle.style_default, "(") |
|
999 | 999 | for part in xrepr(item, mode): |
|
1000 | 1000 | yield part |
|
1001 | 1001 | if isinstance(item, Pipe): |
|
1002 | 1002 | yield (astyle.style_default, ")") |
|
1003 | 1003 | else: |
|
1004 | 1004 | yield (astyle.style_default, repr(self)) |
|
1005 | 1005 | |
|
1006 | 1006 | def __repr__(self): |
|
1007 | 1007 | args = ", ".join([repr(it) for it in self.iters]) |
|
1008 | 1008 | return "%s.%s(%s)" % \ |
|
1009 | 1009 | (self.__class__.__module__, self.__class__.__name__, args) |
|
1010 | 1010 | |
|
1011 | 1011 | |
|
1012 | 1012 | class ifile(path.path): |
|
1013 | 1013 | """ |
|
1014 | 1014 | file (or directory) object. |
|
1015 | 1015 | """ |
|
1016 | 1016 | |
|
1017 | 1017 | def getmode(self): |
|
1018 | 1018 | return self.stat().st_mode |
|
1019 | 1019 | mode = property(getmode, None, None, "Access mode") |
|
1020 | 1020 | |
|
1021 | 1021 | def gettype(self): |
|
1022 | 1022 | data = [ |
|
1023 | 1023 | (stat.S_ISREG, "file"), |
|
1024 | 1024 | (stat.S_ISDIR, "dir"), |
|
1025 | 1025 | (stat.S_ISCHR, "chardev"), |
|
1026 | 1026 | (stat.S_ISBLK, "blockdev"), |
|
1027 | 1027 | (stat.S_ISFIFO, "fifo"), |
|
1028 | 1028 | (stat.S_ISLNK, "symlink"), |
|
1029 | 1029 | (stat.S_ISSOCK,"socket"), |
|
1030 | 1030 | ] |
|
1031 | 1031 | lstat = self.lstat() |
|
1032 | 1032 | if lstat is not None: |
|
1033 | 1033 | types = set([text for (func, text) in data if func(lstat.st_mode)]) |
|
1034 | 1034 | else: |
|
1035 | 1035 | types = set() |
|
1036 | 1036 | m = self.mode |
|
1037 | 1037 | types.update([text for (func, text) in data if func(m)]) |
|
1038 | 1038 | return ", ".join(types) |
|
1039 | 1039 | type = property(gettype, None, None, "file type (file, directory, link, etc.)") |
|
1040 | 1040 | |
|
1041 | 1041 | def getmodestr(self): |
|
1042 | 1042 | m = self.mode |
|
1043 | 1043 | data = [ |
|
1044 | 1044 | (stat.S_IRUSR, "-r"), |
|
1045 | 1045 | (stat.S_IWUSR, "-w"), |
|
1046 | 1046 | (stat.S_IXUSR, "-x"), |
|
1047 | 1047 | (stat.S_IRGRP, "-r"), |
|
1048 | 1048 | (stat.S_IWGRP, "-w"), |
|
1049 | 1049 | (stat.S_IXGRP, "-x"), |
|
1050 | 1050 | (stat.S_IROTH, "-r"), |
|
1051 | 1051 | (stat.S_IWOTH, "-w"), |
|
1052 | 1052 | (stat.S_IXOTH, "-x"), |
|
1053 | 1053 | ] |
|
1054 | 1054 | return "".join([text[bool(m&bit)] for (bit, text) in data]) |
|
1055 | 1055 | |
|
1056 | 1056 | modestr = property(getmodestr, None, None, "Access mode as string") |
|
1057 | 1057 | |
|
1058 | 1058 | def getblocks(self): |
|
1059 | 1059 | return self.stat().st_blocks |
|
1060 | 1060 | blocks = property(getblocks, None, None, "File size in blocks") |
|
1061 | 1061 | |
|
1062 | 1062 | def getblksize(self): |
|
1063 | 1063 | return self.stat().st_blksize |
|
1064 | 1064 | blksize = property(getblksize, None, None, "Filesystem block size") |
|
1065 | 1065 | |
|
1066 | 1066 | def getdev(self): |
|
1067 | 1067 | return self.stat().st_dev |
|
1068 | 1068 | dev = property(getdev) |
|
1069 | 1069 | |
|
1070 | 1070 | def getnlink(self): |
|
1071 | 1071 | return self.stat().st_nlink |
|
1072 | 1072 | nlink = property(getnlink, None, None, "Number of links") |
|
1073 | 1073 | |
|
1074 | 1074 | def getuid(self): |
|
1075 | 1075 | return self.stat().st_uid |
|
1076 | 1076 | uid = property(getuid, None, None, "User id of file owner") |
|
1077 | 1077 | |
|
1078 | 1078 | def getgid(self): |
|
1079 | 1079 | return self.stat().st_gid |
|
1080 | 1080 | gid = property(getgid, None, None, "Group id of file owner") |
|
1081 | 1081 | |
|
1082 | 1082 | def getowner(self): |
|
1083 | 1083 | stat = self.stat() |
|
1084 | 1084 | try: |
|
1085 | 1085 | return pwd.getpwuid(stat.st_uid).pw_name |
|
1086 | 1086 | except KeyError: |
|
1087 | 1087 | return stat.st_uid |
|
1088 | 1088 | owner = property(getowner, None, None, "Owner name (or id)") |
|
1089 | 1089 | |
|
1090 | 1090 | def getgroup(self): |
|
1091 | 1091 | stat = self.stat() |
|
1092 | 1092 | try: |
|
1093 | 1093 | return grp.getgrgid(stat.st_gid).gr_name |
|
1094 | 1094 | except KeyError: |
|
1095 | 1095 | return stat.st_gid |
|
1096 | 1096 | group = property(getgroup, None, None, "Group name (or id)") |
|
1097 | 1097 | |
|
1098 | 1098 | def getadate(self): |
|
1099 | 1099 | return datetime.datetime.utcfromtimestamp(self.atime) |
|
1100 | 1100 | adate = property(getadate, None, None, "Access date") |
|
1101 | 1101 | |
|
1102 | 1102 | def getcdate(self): |
|
1103 | 1103 | return datetime.datetime.utcfromtimestamp(self.ctime) |
|
1104 | 1104 | cdate = property(getcdate, None, None, "Creation date") |
|
1105 | 1105 | |
|
1106 | 1106 | def getmdate(self): |
|
1107 | 1107 | return datetime.datetime.utcfromtimestamp(self.mtime) |
|
1108 | 1108 | mdate = property(getmdate, None, None, "Modification date") |
|
1109 | 1109 | |
|
1110 | 1110 | def mimetype(self): |
|
1111 | 1111 | """ |
|
1112 | 1112 | Return MIME type guessed from the extension. |
|
1113 | 1113 | """ |
|
1114 | 1114 | return mimetypes.guess_type(self.basename())[0] |
|
1115 | 1115 | |
|
1116 | 1116 | def encoding(self): |
|
1117 | 1117 | """ |
|
1118 | 1118 | Return guessed compression (like "compress" or "gzip"). |
|
1119 | 1119 | """ |
|
1120 | 1120 | return mimetypes.guess_type(self.basename())[1] |
|
1121 | 1121 | |
|
1122 | 1122 | def __repr__(self): |
|
1123 | 1123 | return "ifile(%s)" % path._base.__repr__(self) |
|
1124 | 1124 | |
|
1125 | 1125 | if sys.platform == "win32": |
|
1126 | 1126 | defaultattrs = (None, "type", "size", "modestr", "mdate") |
|
1127 | 1127 | else: |
|
1128 | 1128 | defaultattrs = (None, "type", "size", "modestr", "owner", "group", "mdate") |
|
1129 | 1129 | |
|
1130 | 1130 | def __xattrs__(self, mode="default"): |
|
1131 | 1131 | if mode == "detail": |
|
1132 | 1132 | return ( |
|
1133 | 1133 | "name", |
|
1134 | 1134 | "basename()", |
|
1135 | 1135 | "abspath()", |
|
1136 | 1136 | "realpath()", |
|
1137 | 1137 | "type", |
|
1138 | 1138 | "mode", |
|
1139 | 1139 | "modestr", |
|
1140 | 1140 | "stat()", |
|
1141 | 1141 | "lstat()", |
|
1142 | 1142 | "uid", |
|
1143 | 1143 | "gid", |
|
1144 | 1144 | "owner", |
|
1145 | 1145 | "group", |
|
1146 | 1146 | "dev", |
|
1147 | 1147 | "nlink", |
|
1148 | 1148 | "ctime", |
|
1149 | 1149 | "mtime", |
|
1150 | 1150 | "atime", |
|
1151 | 1151 | "cdate", |
|
1152 | 1152 | "mdate", |
|
1153 | 1153 | "adate", |
|
1154 | 1154 | "size", |
|
1155 | 1155 | "blocks", |
|
1156 | 1156 | "blksize", |
|
1157 | 1157 | "isdir()", |
|
1158 | 1158 | "islink()", |
|
1159 | 1159 | "mimetype()", |
|
1160 | 1160 | "encoding()", |
|
1161 | 1161 | "-listdir()", |
|
1162 | 1162 | "-dirs()", |
|
1163 | 1163 | "-files()", |
|
1164 | 1164 | "-walk()", |
|
1165 | 1165 | "-walkdirs()", |
|
1166 | 1166 | "-walkfiles()", |
|
1167 | 1167 | ) |
|
1168 | 1168 | else: |
|
1169 | 1169 | return self.defaultattrs |
|
1170 | 1170 | |
|
1171 | 1171 | |
|
1172 | 1172 | def xiter_ifile(self): |
|
1173 | 1173 | if self.isdir(): |
|
1174 | 1174 | yield (self / os.pardir).abspath() |
|
1175 | 1175 | for child in sorted(self.listdir()): |
|
1176 | 1176 | yield child |
|
1177 | 1177 | else: |
|
1178 | 1178 | f = self.open("rb") |
|
1179 | 1179 | for line in f: |
|
1180 | 1180 | yield line |
|
1181 | 1181 | f.close() |
|
1182 | 1182 | xiter.when_type(ifile)(xiter_ifile) |
|
1183 | 1183 | |
|
1184 | 1184 | |
|
1185 | 1185 | # We need to implement ``xrepr`` for ``ifile`` as a generic function, because |
|
1186 | 1186 | # otherwise ``xrepr_str`` would kick in. |
|
1187 | 1187 | def xrepr_ifile(self, mode="default"): |
|
1188 | 1188 | try: |
|
1189 | 1189 | if self.isdir(): |
|
1190 | 1190 | name = "idir" |
|
1191 | 1191 | style = astyle.style_dir |
|
1192 | 1192 | else: |
|
1193 | 1193 | name = "ifile" |
|
1194 | 1194 | style = astyle.style_file |
|
1195 | 1195 | except IOError: |
|
1196 | 1196 | name = "ifile" |
|
1197 | 1197 | style = astyle.style_default |
|
1198 | 1198 | if mode in ("cell", "header", "footer"): |
|
1199 | 1199 | abspath = repr(path._base(self.normpath())) |
|
1200 | 1200 | if abspath.startswith("u"): |
|
1201 | 1201 | abspath = abspath[2:-1] |
|
1202 | 1202 | else: |
|
1203 | 1203 | abspath = abspath[1:-1] |
|
1204 | 1204 | if mode == "cell": |
|
1205 | 1205 | yield (style, abspath) |
|
1206 | 1206 | else: |
|
1207 | 1207 | yield (style, "%s(%s)" % (name, abspath)) |
|
1208 | 1208 | else: |
|
1209 | 1209 | yield (style, repr(self)) |
|
1210 | 1210 | xrepr.when_type(ifile)(xrepr_ifile) |
|
1211 | 1211 | |
|
1212 | 1212 | |
|
1213 | 1213 | class ils(Table): |
|
1214 | 1214 | """ |
|
1215 | 1215 | List the current (or a specified) directory. |
|
1216 | 1216 | |
|
1217 | 1217 | Examples:: |
|
1218 | 1218 | |
|
1219 | 1219 | >>> ils |
|
1220 |
<class 'IPython. |
|
|
1220 | <class 'IPython.extensions.ipipe.ils'> | |
|
1221 | 1221 | >>> ils("/usr/local/lib/python2.4") |
|
1222 |
IPython. |
|
|
1222 | IPython.extensions.ipipe.ils('/usr/local/lib/python2.4') | |
|
1223 | 1223 | >>> ils("~") |
|
1224 |
IPython. |
|
|
1224 | IPython.extensions.ipipe.ils('/home/fperez') | |
|
1225 | 1225 | # all-random |
|
1226 | 1226 | """ |
|
1227 | 1227 | def __init__(self, base=os.curdir, dirs=True, files=True): |
|
1228 | 1228 | self.base = os.path.expanduser(base) |
|
1229 | 1229 | self.dirs = dirs |
|
1230 | 1230 | self.files = files |
|
1231 | 1231 | |
|
1232 | 1232 | def __iter__(self): |
|
1233 | 1233 | base = ifile(self.base) |
|
1234 | 1234 | yield (base / os.pardir).abspath() |
|
1235 | 1235 | for child in sorted(base.listdir()): |
|
1236 | 1236 | if self.dirs: |
|
1237 | 1237 | if self.files: |
|
1238 | 1238 | yield child |
|
1239 | 1239 | else: |
|
1240 | 1240 | if child.isdir(): |
|
1241 | 1241 | yield child |
|
1242 | 1242 | elif self.files: |
|
1243 | 1243 | if not child.isdir(): |
|
1244 | 1244 | yield child |
|
1245 | 1245 | |
|
1246 | 1246 | def __xrepr__(self, mode="default"): |
|
1247 | 1247 | return xrepr(ifile(self.base), mode) |
|
1248 | 1248 | |
|
1249 | 1249 | def __repr__(self): |
|
1250 | 1250 | return "%s.%s(%r)" % \ |
|
1251 | 1251 | (self.__class__.__module__, self.__class__.__name__, self.base) |
|
1252 | 1252 | |
|
1253 | 1253 | |
|
1254 | 1254 | class iglob(Table): |
|
1255 | 1255 | """ |
|
1256 | 1256 | List all files and directories matching a specified pattern. |
|
1257 | 1257 | (See ``glob.glob()`` for more info.). |
|
1258 | 1258 | |
|
1259 | 1259 | Examples:: |
|
1260 | 1260 | |
|
1261 | 1261 | >>> iglob("*.py") |
|
1262 |
IPython. |
|
|
1262 | IPython.extensions.ipipe.iglob('*.py') | |
|
1263 | 1263 | """ |
|
1264 | 1264 | def __init__(self, glob): |
|
1265 | 1265 | self.glob = glob |
|
1266 | 1266 | |
|
1267 | 1267 | def __iter__(self): |
|
1268 | 1268 | for name in glob.glob(self.glob): |
|
1269 | 1269 | yield ifile(name) |
|
1270 | 1270 | |
|
1271 | 1271 | def __xrepr__(self, mode="default"): |
|
1272 | 1272 | if mode == "header" or mode == "footer" or mode == "cell": |
|
1273 | 1273 | yield (astyle.style_default, |
|
1274 | 1274 | "%s(%r)" % (self.__class__.__name__, self.glob)) |
|
1275 | 1275 | else: |
|
1276 | 1276 | yield (astyle.style_default, repr(self)) |
|
1277 | 1277 | |
|
1278 | 1278 | def __repr__(self): |
|
1279 | 1279 | return "%s.%s(%r)" % \ |
|
1280 | 1280 | (self.__class__.__module__, self.__class__.__name__, self.glob) |
|
1281 | 1281 | |
|
1282 | 1282 | |
|
1283 | 1283 | class iwalk(Table): |
|
1284 | 1284 | """ |
|
1285 | 1285 | List all files and directories in a directory and it's subdirectory:: |
|
1286 | 1286 | |
|
1287 | 1287 | >>> iwalk |
|
1288 |
<class 'IPython. |
|
|
1288 | <class 'IPython.extensions.ipipe.iwalk'> | |
|
1289 | 1289 | >>> iwalk("/usr/lib") |
|
1290 |
IPython. |
|
|
1290 | IPython.extensions.ipipe.iwalk('/usr/lib') | |
|
1291 | 1291 | >>> iwalk("~") |
|
1292 |
IPython. |
|
|
1292 | IPython.extensions.ipipe.iwalk('/home/fperez') # random | |
|
1293 | 1293 | |
|
1294 | 1294 | """ |
|
1295 | 1295 | def __init__(self, base=os.curdir, dirs=True, files=True): |
|
1296 | 1296 | self.base = os.path.expanduser(base) |
|
1297 | 1297 | self.dirs = dirs |
|
1298 | 1298 | self.files = files |
|
1299 | 1299 | |
|
1300 | 1300 | def __iter__(self): |
|
1301 | 1301 | for (dirpath, dirnames, filenames) in os.walk(self.base): |
|
1302 | 1302 | if self.dirs: |
|
1303 | 1303 | for name in sorted(dirnames): |
|
1304 | 1304 | yield ifile(os.path.join(dirpath, name)) |
|
1305 | 1305 | if self.files: |
|
1306 | 1306 | for name in sorted(filenames): |
|
1307 | 1307 | yield ifile(os.path.join(dirpath, name)) |
|
1308 | 1308 | |
|
1309 | 1309 | def __xrepr__(self, mode="default"): |
|
1310 | 1310 | if mode == "header" or mode == "footer" or mode == "cell": |
|
1311 | 1311 | yield (astyle.style_default, |
|
1312 | 1312 | "%s(%r)" % (self.__class__.__name__, self.base)) |
|
1313 | 1313 | else: |
|
1314 | 1314 | yield (astyle.style_default, repr(self)) |
|
1315 | 1315 | |
|
1316 | 1316 | def __repr__(self): |
|
1317 | 1317 | return "%s.%s(%r)" % \ |
|
1318 | 1318 | (self.__class__.__module__, self.__class__.__name__, self.base) |
|
1319 | 1319 | |
|
1320 | 1320 | |
|
1321 | 1321 | class ipwdentry(object): |
|
1322 | 1322 | """ |
|
1323 | 1323 | ``ipwdentry`` objects encapsulate entries in the Unix user account and |
|
1324 | 1324 | password database. |
|
1325 | 1325 | """ |
|
1326 | 1326 | def __init__(self, id): |
|
1327 | 1327 | self._id = id |
|
1328 | 1328 | self._entry = None |
|
1329 | 1329 | |
|
1330 | 1330 | def __eq__(self, other): |
|
1331 | 1331 | return self.__class__ is other.__class__ and self._id == other._id |
|
1332 | 1332 | |
|
1333 | 1333 | def __ne__(self, other): |
|
1334 | 1334 | return self.__class__ is not other.__class__ or self._id != other._id |
|
1335 | 1335 | |
|
1336 | 1336 | def _getentry(self): |
|
1337 | 1337 | if self._entry is None: |
|
1338 | 1338 | if isinstance(self._id, basestring): |
|
1339 | 1339 | self._entry = pwd.getpwnam(self._id) |
|
1340 | 1340 | else: |
|
1341 | 1341 | self._entry = pwd.getpwuid(self._id) |
|
1342 | 1342 | return self._entry |
|
1343 | 1343 | |
|
1344 | 1344 | def getname(self): |
|
1345 | 1345 | if isinstance(self._id, basestring): |
|
1346 | 1346 | return self._id |
|
1347 | 1347 | else: |
|
1348 | 1348 | return self._getentry().pw_name |
|
1349 | 1349 | name = property(getname, None, None, "User name") |
|
1350 | 1350 | |
|
1351 | 1351 | def getpasswd(self): |
|
1352 | 1352 | return self._getentry().pw_passwd |
|
1353 | 1353 | passwd = property(getpasswd, None, None, "Password") |
|
1354 | 1354 | |
|
1355 | 1355 | def getuid(self): |
|
1356 | 1356 | if isinstance(self._id, basestring): |
|
1357 | 1357 | return self._getentry().pw_uid |
|
1358 | 1358 | else: |
|
1359 | 1359 | return self._id |
|
1360 | 1360 | uid = property(getuid, None, None, "User id") |
|
1361 | 1361 | |
|
1362 | 1362 | def getgid(self): |
|
1363 | 1363 | return self._getentry().pw_gid |
|
1364 | 1364 | gid = property(getgid, None, None, "Primary group id") |
|
1365 | 1365 | |
|
1366 | 1366 | def getgroup(self): |
|
1367 | 1367 | return igrpentry(self.gid) |
|
1368 | 1368 | group = property(getgroup, None, None, "Group") |
|
1369 | 1369 | |
|
1370 | 1370 | def getgecos(self): |
|
1371 | 1371 | return self._getentry().pw_gecos |
|
1372 | 1372 | gecos = property(getgecos, None, None, "Information (e.g. full user name)") |
|
1373 | 1373 | |
|
1374 | 1374 | def getdir(self): |
|
1375 | 1375 | return self._getentry().pw_dir |
|
1376 | 1376 | dir = property(getdir, None, None, "$HOME directory") |
|
1377 | 1377 | |
|
1378 | 1378 | def getshell(self): |
|
1379 | 1379 | return self._getentry().pw_shell |
|
1380 | 1380 | shell = property(getshell, None, None, "Login shell") |
|
1381 | 1381 | |
|
1382 | 1382 | def __xattrs__(self, mode="default"): |
|
1383 | 1383 | return ("name", "passwd", "uid", "gid", "gecos", "dir", "shell") |
|
1384 | 1384 | |
|
1385 | 1385 | def __repr__(self): |
|
1386 | 1386 | return "%s.%s(%r)" % \ |
|
1387 | 1387 | (self.__class__.__module__, self.__class__.__name__, self._id) |
|
1388 | 1388 | |
|
1389 | 1389 | |
|
1390 | 1390 | class ipwd(Table): |
|
1391 | 1391 | """ |
|
1392 | 1392 | List all entries in the Unix user account and password database. |
|
1393 | 1393 | |
|
1394 | 1394 | Example:: |
|
1395 | 1395 | |
|
1396 | 1396 | >>> ipwd | isort("uid") |
|
1397 |
<IPython. |
|
|
1397 | <IPython.extensions.ipipe.isort key='uid' reverse=False at 0x849efec> | |
|
1398 | 1398 | # random |
|
1399 | 1399 | """ |
|
1400 | 1400 | def __iter__(self): |
|
1401 | 1401 | for entry in pwd.getpwall(): |
|
1402 | 1402 | yield ipwdentry(entry.pw_name) |
|
1403 | 1403 | |
|
1404 | 1404 | def __xrepr__(self, mode="default"): |
|
1405 | 1405 | if mode == "header" or mode == "footer" or mode == "cell": |
|
1406 | 1406 | yield (astyle.style_default, "%s()" % self.__class__.__name__) |
|
1407 | 1407 | else: |
|
1408 | 1408 | yield (astyle.style_default, repr(self)) |
|
1409 | 1409 | |
|
1410 | 1410 | |
|
1411 | 1411 | class igrpentry(object): |
|
1412 | 1412 | """ |
|
1413 | 1413 | ``igrpentry`` objects encapsulate entries in the Unix group database. |
|
1414 | 1414 | """ |
|
1415 | 1415 | def __init__(self, id): |
|
1416 | 1416 | self._id = id |
|
1417 | 1417 | self._entry = None |
|
1418 | 1418 | |
|
1419 | 1419 | def __eq__(self, other): |
|
1420 | 1420 | return self.__class__ is other.__class__ and self._id == other._id |
|
1421 | 1421 | |
|
1422 | 1422 | def __ne__(self, other): |
|
1423 | 1423 | return self.__class__ is not other.__class__ or self._id != other._id |
|
1424 | 1424 | |
|
1425 | 1425 | def _getentry(self): |
|
1426 | 1426 | if self._entry is None: |
|
1427 | 1427 | if isinstance(self._id, basestring): |
|
1428 | 1428 | self._entry = grp.getgrnam(self._id) |
|
1429 | 1429 | else: |
|
1430 | 1430 | self._entry = grp.getgrgid(self._id) |
|
1431 | 1431 | return self._entry |
|
1432 | 1432 | |
|
1433 | 1433 | def getname(self): |
|
1434 | 1434 | if isinstance(self._id, basestring): |
|
1435 | 1435 | return self._id |
|
1436 | 1436 | else: |
|
1437 | 1437 | return self._getentry().gr_name |
|
1438 | 1438 | name = property(getname, None, None, "Group name") |
|
1439 | 1439 | |
|
1440 | 1440 | def getpasswd(self): |
|
1441 | 1441 | return self._getentry().gr_passwd |
|
1442 | 1442 | passwd = property(getpasswd, None, None, "Password") |
|
1443 | 1443 | |
|
1444 | 1444 | def getgid(self): |
|
1445 | 1445 | if isinstance(self._id, basestring): |
|
1446 | 1446 | return self._getentry().gr_gid |
|
1447 | 1447 | else: |
|
1448 | 1448 | return self._id |
|
1449 | 1449 | gid = property(getgid, None, None, "Group id") |
|
1450 | 1450 | |
|
1451 | 1451 | def getmem(self): |
|
1452 | 1452 | return self._getentry().gr_mem |
|
1453 | 1453 | mem = property(getmem, None, None, "Members") |
|
1454 | 1454 | |
|
1455 | 1455 | def __xattrs__(self, mode="default"): |
|
1456 | 1456 | return ("name", "passwd", "gid", "mem") |
|
1457 | 1457 | |
|
1458 | 1458 | def __xrepr__(self, mode="default"): |
|
1459 | 1459 | if mode == "header" or mode == "footer" or mode == "cell": |
|
1460 | 1460 | yield (astyle.style_default, "group ") |
|
1461 | 1461 | try: |
|
1462 | 1462 | yield (astyle.style_default, self.name) |
|
1463 | 1463 | except KeyError: |
|
1464 | 1464 | if isinstance(self._id, basestring): |
|
1465 | 1465 | yield (astyle.style_default, self.name_id) |
|
1466 | 1466 | else: |
|
1467 | 1467 | yield (astyle.style_type_number, str(self._id)) |
|
1468 | 1468 | else: |
|
1469 | 1469 | yield (astyle.style_default, repr(self)) |
|
1470 | 1470 | |
|
1471 | 1471 | def __iter__(self): |
|
1472 | 1472 | for member in self.mem: |
|
1473 | 1473 | yield ipwdentry(member) |
|
1474 | 1474 | |
|
1475 | 1475 | def __repr__(self): |
|
1476 | 1476 | return "%s.%s(%r)" % \ |
|
1477 | 1477 | (self.__class__.__module__, self.__class__.__name__, self._id) |
|
1478 | 1478 | |
|
1479 | 1479 | |
|
1480 | 1480 | class igrp(Table): |
|
1481 | 1481 | """ |
|
1482 | 1482 | This ``Table`` lists all entries in the Unix group database. |
|
1483 | 1483 | """ |
|
1484 | 1484 | def __iter__(self): |
|
1485 | 1485 | for entry in grp.getgrall(): |
|
1486 | 1486 | yield igrpentry(entry.gr_name) |
|
1487 | 1487 | |
|
1488 | 1488 | def __xrepr__(self, mode="default"): |
|
1489 | 1489 | if mode == "header" or mode == "footer": |
|
1490 | 1490 | yield (astyle.style_default, "%s()" % self.__class__.__name__) |
|
1491 | 1491 | else: |
|
1492 | 1492 | yield (astyle.style_default, repr(self)) |
|
1493 | 1493 | |
|
1494 | 1494 | |
|
1495 | 1495 | class Fields(object): |
|
1496 | 1496 | def __init__(self, fieldnames, **fields): |
|
1497 | 1497 | self.__fieldnames = [upgradexattr(fieldname) for fieldname in fieldnames] |
|
1498 | 1498 | for (key, value) in fields.iteritems(): |
|
1499 | 1499 | setattr(self, key, value) |
|
1500 | 1500 | |
|
1501 | 1501 | def __xattrs__(self, mode="default"): |
|
1502 | 1502 | return self.__fieldnames |
|
1503 | 1503 | |
|
1504 | 1504 | def __xrepr__(self, mode="default"): |
|
1505 | 1505 | yield (-1, False) |
|
1506 | 1506 | if mode == "header" or mode == "cell": |
|
1507 | 1507 | yield (astyle.style_default, self.__class__.__name__) |
|
1508 | 1508 | yield (astyle.style_default, "(") |
|
1509 | 1509 | for (i, f) in enumerate(self.__fieldnames): |
|
1510 | 1510 | if i: |
|
1511 | 1511 | yield (astyle.style_default, ", ") |
|
1512 | 1512 | yield (astyle.style_default, f.name()) |
|
1513 | 1513 | yield (astyle.style_default, "=") |
|
1514 | 1514 | for part in xrepr(getattr(self, f), "default"): |
|
1515 | 1515 | yield part |
|
1516 | 1516 | yield (astyle.style_default, ")") |
|
1517 | 1517 | elif mode == "footer": |
|
1518 | 1518 | yield (astyle.style_default, self.__class__.__name__) |
|
1519 | 1519 | yield (astyle.style_default, "(") |
|
1520 | 1520 | for (i, f) in enumerate(self.__fieldnames): |
|
1521 | 1521 | if i: |
|
1522 | 1522 | yield (astyle.style_default, ", ") |
|
1523 | 1523 | yield (astyle.style_default, f.name()) |
|
1524 | 1524 | yield (astyle.style_default, ")") |
|
1525 | 1525 | else: |
|
1526 | 1526 | yield (astyle.style_default, repr(self)) |
|
1527 | 1527 | |
|
1528 | 1528 | |
|
1529 | 1529 | class FieldTable(Table, list): |
|
1530 | 1530 | def __init__(self, *fields): |
|
1531 | 1531 | Table.__init__(self) |
|
1532 | 1532 | list.__init__(self) |
|
1533 | 1533 | self.fields = fields |
|
1534 | 1534 | |
|
1535 | 1535 | def add(self, **fields): |
|
1536 | 1536 | self.append(Fields(self.fields, **fields)) |
|
1537 | 1537 | |
|
1538 | 1538 | def __xrepr__(self, mode="default"): |
|
1539 | 1539 | yield (-1, False) |
|
1540 | 1540 | if mode == "header" or mode == "footer": |
|
1541 | 1541 | yield (astyle.style_default, self.__class__.__name__) |
|
1542 | 1542 | yield (astyle.style_default, "(") |
|
1543 | 1543 | for (i, f) in enumerate(self.__fieldnames): |
|
1544 | 1544 | if i: |
|
1545 | 1545 | yield (astyle.style_default, ", ") |
|
1546 | 1546 | yield (astyle.style_default, f) |
|
1547 | 1547 | yield (astyle.style_default, ")") |
|
1548 | 1548 | else: |
|
1549 | 1549 | yield (astyle.style_default, repr(self)) |
|
1550 | 1550 | |
|
1551 | 1551 | def __repr__(self): |
|
1552 | 1552 | return "<%s.%s object with fields=%r at 0x%x>" % \ |
|
1553 | 1553 | (self.__class__.__module__, self.__class__.__name__, |
|
1554 | 1554 | ", ".join(map(repr, self.fields)), id(self)) |
|
1555 | 1555 | |
|
1556 | 1556 | |
|
1557 | 1557 | class List(list): |
|
1558 | 1558 | def __xattrs__(self, mode="default"): |
|
1559 | 1559 | return xrange(len(self)) |
|
1560 | 1560 | |
|
1561 | 1561 | def __xrepr__(self, mode="default"): |
|
1562 | 1562 | yield (-1, False) |
|
1563 | 1563 | if mode == "header" or mode == "cell" or mode == "footer" or mode == "default": |
|
1564 | 1564 | yield (astyle.style_default, self.__class__.__name__) |
|
1565 | 1565 | yield (astyle.style_default, "(") |
|
1566 | 1566 | for (i, item) in enumerate(self): |
|
1567 | 1567 | if i: |
|
1568 | 1568 | yield (astyle.style_default, ", ") |
|
1569 | 1569 | for part in xrepr(item, "default"): |
|
1570 | 1570 | yield part |
|
1571 | 1571 | yield (astyle.style_default, ")") |
|
1572 | 1572 | else: |
|
1573 | 1573 | yield (astyle.style_default, repr(self)) |
|
1574 | 1574 | |
|
1575 | 1575 | |
|
1576 | 1576 | class ienv(Table): |
|
1577 | 1577 | """ |
|
1578 | 1578 | List environment variables. |
|
1579 | 1579 | |
|
1580 | 1580 | Example:: |
|
1581 | 1581 | |
|
1582 | 1582 | >>> ienv |
|
1583 |
<class 'IPython. |
|
|
1583 | <class 'IPython.extensions.ipipe.ienv'> | |
|
1584 | 1584 | """ |
|
1585 | 1585 | |
|
1586 | 1586 | def __iter__(self): |
|
1587 | 1587 | fields = ("key", "value") |
|
1588 | 1588 | for (key, value) in os.environ.iteritems(): |
|
1589 | 1589 | yield Fields(fields, key=key, value=value) |
|
1590 | 1590 | |
|
1591 | 1591 | def __xrepr__(self, mode="default"): |
|
1592 | 1592 | if mode == "header" or mode == "cell": |
|
1593 | 1593 | yield (astyle.style_default, "%s()" % self.__class__.__name__) |
|
1594 | 1594 | else: |
|
1595 | 1595 | yield (astyle.style_default, repr(self)) |
|
1596 | 1596 | |
|
1597 | 1597 | |
|
1598 | 1598 | class ihist(Table): |
|
1599 | 1599 | """ |
|
1600 | 1600 | IPython input history |
|
1601 | 1601 | |
|
1602 | 1602 | Example:: |
|
1603 | 1603 | |
|
1604 | 1604 | >>> ihist |
|
1605 |
<class 'IPython. |
|
|
1605 | <class 'IPython.extensions.ipipe.ihist'> | |
|
1606 | 1606 | >>> ihist(True) # raw mode |
|
1607 |
<IPython. |
|
|
1607 | <IPython.extensions.ipipe.ihist object at 0x849602c> # random | |
|
1608 | 1608 | """ |
|
1609 | 1609 | def __init__(self, raw=True): |
|
1610 | 1610 | self.raw = raw |
|
1611 | 1611 | |
|
1612 | 1612 | def __iter__(self): |
|
1613 | 1613 | api = ipapi.get() |
|
1614 | 1614 | if self.raw: |
|
1615 | 1615 | for line in api.IP.input_hist_raw: |
|
1616 | 1616 | yield line.rstrip("\n") |
|
1617 | 1617 | else: |
|
1618 | 1618 | for line in api.IP.input_hist: |
|
1619 | 1619 | yield line.rstrip("\n") |
|
1620 | 1620 | |
|
1621 | 1621 | |
|
1622 | 1622 | class Alias(object): |
|
1623 | 1623 | """ |
|
1624 | 1624 | Entry in the alias table |
|
1625 | 1625 | """ |
|
1626 | 1626 | def __init__(self, name, args, command): |
|
1627 | 1627 | self.name = name |
|
1628 | 1628 | self.args = args |
|
1629 | 1629 | self.command = command |
|
1630 | 1630 | |
|
1631 | 1631 | def __xattrs__(self, mode="default"): |
|
1632 | 1632 | return ("name", "args", "command") |
|
1633 | 1633 | |
|
1634 | 1634 | |
|
1635 | 1635 | class ialias(Table): |
|
1636 | 1636 | """ |
|
1637 | 1637 | IPython alias list |
|
1638 | 1638 | |
|
1639 | 1639 | Example:: |
|
1640 | 1640 | |
|
1641 | 1641 | >>> ialias |
|
1642 |
<class 'IPython. |
|
|
1642 | <class 'IPython.extensions.ipipe.ialias'> | |
|
1643 | 1643 | """ |
|
1644 | 1644 | def __iter__(self): |
|
1645 | 1645 | api = ipapi.get() |
|
1646 | 1646 | |
|
1647 | 1647 | for (name, (args, command)) in api.IP.alias_table.iteritems(): |
|
1648 | 1648 | yield Alias(name, args, command) |
|
1649 | 1649 | |
|
1650 | 1650 | |
|
1651 | 1651 | class icsv(Pipe): |
|
1652 | 1652 | """ |
|
1653 | 1653 | This ``Pipe`` turns the input (with must be a pipe outputting lines |
|
1654 | 1654 | or an ``ifile``) into lines of CVS columns. |
|
1655 | 1655 | """ |
|
1656 | 1656 | def __init__(self, **csvargs): |
|
1657 | 1657 | """ |
|
1658 | 1658 | Create an ``icsv`` object. ``cvsargs`` will be passed through as |
|
1659 | 1659 | keyword arguments to ``cvs.reader()``. |
|
1660 | 1660 | """ |
|
1661 | 1661 | self.csvargs = csvargs |
|
1662 | 1662 | |
|
1663 | 1663 | def __iter__(self): |
|
1664 | 1664 | input = self.input |
|
1665 | 1665 | if isinstance(input, ifile): |
|
1666 | 1666 | input = input.open("rb") |
|
1667 | 1667 | reader = csv.reader(input, **self.csvargs) |
|
1668 | 1668 | for line in reader: |
|
1669 | 1669 | yield List(line) |
|
1670 | 1670 | |
|
1671 | 1671 | def __xrepr__(self, mode="default"): |
|
1672 | 1672 | yield (-1, False) |
|
1673 | 1673 | if mode == "header" or mode == "footer": |
|
1674 | 1674 | input = getattr(self, "input", None) |
|
1675 | 1675 | if input is not None: |
|
1676 | 1676 | for part in xrepr(input, mode): |
|
1677 | 1677 | yield part |
|
1678 | 1678 | yield (astyle.style_default, " | ") |
|
1679 | 1679 | yield (astyle.style_default, "%s(" % self.__class__.__name__) |
|
1680 | 1680 | for (i, (name, value)) in enumerate(self.csvargs.iteritems()): |
|
1681 | 1681 | if i: |
|
1682 | 1682 | yield (astyle.style_default, ", ") |
|
1683 | 1683 | yield (astyle.style_default, name) |
|
1684 | 1684 | yield (astyle.style_default, "=") |
|
1685 | 1685 | for part in xrepr(value, "default"): |
|
1686 | 1686 | yield part |
|
1687 | 1687 | yield (astyle.style_default, ")") |
|
1688 | 1688 | else: |
|
1689 | 1689 | yield (astyle.style_default, repr(self)) |
|
1690 | 1690 | |
|
1691 | 1691 | def __repr__(self): |
|
1692 | 1692 | args = ", ".join(["%s=%r" % item for item in self.csvargs.iteritems()]) |
|
1693 | 1693 | return "<%s.%s %s at 0x%x>" % \ |
|
1694 | 1694 | (self.__class__.__module__, self.__class__.__name__, args, id(self)) |
|
1695 | 1695 | |
|
1696 | 1696 | |
|
1697 | 1697 | class ix(Table): |
|
1698 | 1698 | """ |
|
1699 | 1699 | Execute a system command and list its output as lines |
|
1700 | 1700 | (similar to ``os.popen()``). |
|
1701 | 1701 | |
|
1702 | 1702 | Examples:: |
|
1703 | 1703 | |
|
1704 | 1704 | >>> ix("ps x") |
|
1705 |
IPython. |
|
|
1705 | IPython.extensions.ipipe.ix('ps x') | |
|
1706 | 1706 | |
|
1707 | 1707 | >>> ix("find .") | ifile |
|
1708 |
<IPython. |
|
|
1708 | <IPython.extensions.ipipe.ieval expr=<class 'IPython.extensions.ipipe.ifile'> at 0x8509d2c> | |
|
1709 | 1709 | # random |
|
1710 | 1710 | """ |
|
1711 | 1711 | def __init__(self, cmd): |
|
1712 | 1712 | self.cmd = cmd |
|
1713 | 1713 | self._pipeout = None |
|
1714 | 1714 | |
|
1715 | 1715 | def __iter__(self): |
|
1716 | 1716 | (_pipein, self._pipeout) = os.popen4(self.cmd) |
|
1717 | 1717 | _pipein.close() |
|
1718 | 1718 | for l in self._pipeout: |
|
1719 | 1719 | yield l.rstrip("\r\n") |
|
1720 | 1720 | self._pipeout.close() |
|
1721 | 1721 | self._pipeout = None |
|
1722 | 1722 | |
|
1723 | 1723 | def __del__(self): |
|
1724 | 1724 | if self._pipeout is not None and not self._pipeout.closed: |
|
1725 | 1725 | self._pipeout.close() |
|
1726 | 1726 | self._pipeout = None |
|
1727 | 1727 | |
|
1728 | 1728 | def __xrepr__(self, mode="default"): |
|
1729 | 1729 | if mode == "header" or mode == "footer": |
|
1730 | 1730 | yield (astyle.style_default, |
|
1731 | 1731 | "%s(%r)" % (self.__class__.__name__, self.cmd)) |
|
1732 | 1732 | else: |
|
1733 | 1733 | yield (astyle.style_default, repr(self)) |
|
1734 | 1734 | |
|
1735 | 1735 | def __repr__(self): |
|
1736 | 1736 | return "%s.%s(%r)" % \ |
|
1737 | 1737 | (self.__class__.__module__, self.__class__.__name__, self.cmd) |
|
1738 | 1738 | |
|
1739 | 1739 | |
|
1740 | 1740 | class ifilter(Pipe): |
|
1741 | 1741 | """ |
|
1742 | 1742 | Filter an input pipe. Only objects where an expression evaluates to true |
|
1743 | 1743 | (and doesn't raise an exception) are listed. |
|
1744 | 1744 | |
|
1745 | 1745 | Examples:: |
|
1746 | 1746 | |
|
1747 | 1747 | >>> ils | ifilter("_.isfile() and size>1000") |
|
1748 | 1748 | >>> igrp | ifilter("len(mem)") |
|
1749 | 1749 | >>> sys.modules | ifilter(lambda _:_.value is not None) |
|
1750 | 1750 | # all-random |
|
1751 | 1751 | """ |
|
1752 | 1752 | |
|
1753 | 1753 | def __init__(self, expr, globals=None, errors="raiseifallfail"): |
|
1754 | 1754 | """ |
|
1755 | 1755 | Create an ``ifilter`` object. ``expr`` can be a callable or a string |
|
1756 | 1756 | containing an expression. ``globals`` will be used as the global |
|
1757 | 1757 | namespace for calling string expressions (defaulting to IPython's |
|
1758 | 1758 | user namespace). ``errors`` specifies how exception during evaluation |
|
1759 | 1759 | of ``expr`` are handled: |
|
1760 | 1760 | |
|
1761 | 1761 | ``"drop"`` |
|
1762 | 1762 | drop all items that have errors; |
|
1763 | 1763 | |
|
1764 | 1764 | ``"keep"`` |
|
1765 | 1765 | keep all items that have errors; |
|
1766 | 1766 | |
|
1767 | 1767 | ``"keeperror"`` |
|
1768 | 1768 | keep the exception of all items that have errors; |
|
1769 | 1769 | |
|
1770 | 1770 | ``"raise"`` |
|
1771 | 1771 | raise the exception; |
|
1772 | 1772 | |
|
1773 | 1773 | ``"raiseifallfail"`` |
|
1774 | 1774 | raise the first exception if all items have errors; otherwise drop |
|
1775 | 1775 | those with errors (this is the default). |
|
1776 | 1776 | """ |
|
1777 | 1777 | self.expr = expr |
|
1778 | 1778 | self.globals = globals |
|
1779 | 1779 | self.errors = errors |
|
1780 | 1780 | |
|
1781 | 1781 | def __iter__(self): |
|
1782 | 1782 | if callable(self.expr): |
|
1783 | 1783 | test = self.expr |
|
1784 | 1784 | else: |
|
1785 | 1785 | g = getglobals(self.globals) |
|
1786 | 1786 | expr = compile(self.expr, "ipipe-expression", "eval") |
|
1787 | 1787 | def test(item): |
|
1788 | 1788 | return eval(expr, g, AttrNamespace(item)) |
|
1789 | 1789 | |
|
1790 | 1790 | ok = 0 |
|
1791 | 1791 | exc_info = None |
|
1792 | 1792 | for item in xiter(self.input): |
|
1793 | 1793 | try: |
|
1794 | 1794 | if test(item): |
|
1795 | 1795 | yield item |
|
1796 | 1796 | ok += 1 |
|
1797 | 1797 | except (KeyboardInterrupt, SystemExit): |
|
1798 | 1798 | raise |
|
1799 | 1799 | except Exception, exc: |
|
1800 | 1800 | if self.errors == "drop": |
|
1801 | 1801 | pass # Ignore errors |
|
1802 | 1802 | elif self.errors == "keep": |
|
1803 | 1803 | yield item |
|
1804 | 1804 | elif self.errors == "keeperror": |
|
1805 | 1805 | yield exc |
|
1806 | 1806 | elif self.errors == "raise": |
|
1807 | 1807 | raise |
|
1808 | 1808 | elif self.errors == "raiseifallfail": |
|
1809 | 1809 | if exc_info is None: |
|
1810 | 1810 | exc_info = sys.exc_info() |
|
1811 | 1811 | if not ok and exc_info is not None: |
|
1812 | 1812 | raise exc_info[0], exc_info[1], exc_info[2] |
|
1813 | 1813 | |
|
1814 | 1814 | def __xrepr__(self, mode="default"): |
|
1815 | 1815 | if mode == "header" or mode == "footer": |
|
1816 | 1816 | input = getattr(self, "input", None) |
|
1817 | 1817 | if input is not None: |
|
1818 | 1818 | for part in xrepr(input, mode): |
|
1819 | 1819 | yield part |
|
1820 | 1820 | yield (astyle.style_default, " | ") |
|
1821 | 1821 | yield (astyle.style_default, "%s(" % self.__class__.__name__) |
|
1822 | 1822 | for part in xrepr(self.expr, "default"): |
|
1823 | 1823 | yield part |
|
1824 | 1824 | yield (astyle.style_default, ")") |
|
1825 | 1825 | else: |
|
1826 | 1826 | yield (astyle.style_default, repr(self)) |
|
1827 | 1827 | |
|
1828 | 1828 | def __repr__(self): |
|
1829 | 1829 | return "<%s.%s expr=%r at 0x%x>" % \ |
|
1830 | 1830 | (self.__class__.__module__, self.__class__.__name__, |
|
1831 | 1831 | self.expr, id(self)) |
|
1832 | 1832 | |
|
1833 | 1833 | |
|
1834 | 1834 | class ieval(Pipe): |
|
1835 | 1835 | """ |
|
1836 | 1836 | Evaluate an expression for each object in the input pipe. |
|
1837 | 1837 | |
|
1838 | 1838 | Examples:: |
|
1839 | 1839 | |
|
1840 | 1840 | >>> ils | ieval("_.abspath()") |
|
1841 | 1841 | # random |
|
1842 | 1842 | >>> sys.path | ieval(ifile) |
|
1843 | 1843 | # random |
|
1844 | 1844 | """ |
|
1845 | 1845 | |
|
1846 | 1846 | def __init__(self, expr, globals=None, errors="raiseifallfail"): |
|
1847 | 1847 | """ |
|
1848 | 1848 | Create an ``ieval`` object. ``expr`` can be a callable or a string |
|
1849 | 1849 | containing an expression. For the meaning of ``globals`` and |
|
1850 | 1850 | ``errors`` see ``ifilter``. |
|
1851 | 1851 | """ |
|
1852 | 1852 | self.expr = expr |
|
1853 | 1853 | self.globals = globals |
|
1854 | 1854 | self.errors = errors |
|
1855 | 1855 | |
|
1856 | 1856 | def __iter__(self): |
|
1857 | 1857 | if callable(self.expr): |
|
1858 | 1858 | do = self.expr |
|
1859 | 1859 | else: |
|
1860 | 1860 | g = getglobals(self.globals) |
|
1861 | 1861 | expr = compile(self.expr, "ipipe-expression", "eval") |
|
1862 | 1862 | def do(item): |
|
1863 | 1863 | return eval(expr, g, AttrNamespace(item)) |
|
1864 | 1864 | |
|
1865 | 1865 | ok = 0 |
|
1866 | 1866 | exc_info = None |
|
1867 | 1867 | for item in xiter(self.input): |
|
1868 | 1868 | try: |
|
1869 | 1869 | yield do(item) |
|
1870 | 1870 | except (KeyboardInterrupt, SystemExit): |
|
1871 | 1871 | raise |
|
1872 | 1872 | except Exception, exc: |
|
1873 | 1873 | if self.errors == "drop": |
|
1874 | 1874 | pass # Ignore errors |
|
1875 | 1875 | elif self.errors == "keep": |
|
1876 | 1876 | yield item |
|
1877 | 1877 | elif self.errors == "keeperror": |
|
1878 | 1878 | yield exc |
|
1879 | 1879 | elif self.errors == "raise": |
|
1880 | 1880 | raise |
|
1881 | 1881 | elif self.errors == "raiseifallfail": |
|
1882 | 1882 | if exc_info is None: |
|
1883 | 1883 | exc_info = sys.exc_info() |
|
1884 | 1884 | if not ok and exc_info is not None: |
|
1885 | 1885 | raise exc_info[0], exc_info[1], exc_info[2] |
|
1886 | 1886 | |
|
1887 | 1887 | def __xrepr__(self, mode="default"): |
|
1888 | 1888 | if mode == "header" or mode == "footer": |
|
1889 | 1889 | input = getattr(self, "input", None) |
|
1890 | 1890 | if input is not None: |
|
1891 | 1891 | for part in xrepr(input, mode): |
|
1892 | 1892 | yield part |
|
1893 | 1893 | yield (astyle.style_default, " | ") |
|
1894 | 1894 | yield (astyle.style_default, "%s(" % self.__class__.__name__) |
|
1895 | 1895 | for part in xrepr(self.expr, "default"): |
|
1896 | 1896 | yield part |
|
1897 | 1897 | yield (astyle.style_default, ")") |
|
1898 | 1898 | else: |
|
1899 | 1899 | yield (astyle.style_default, repr(self)) |
|
1900 | 1900 | |
|
1901 | 1901 | def __repr__(self): |
|
1902 | 1902 | return "<%s.%s expr=%r at 0x%x>" % \ |
|
1903 | 1903 | (self.__class__.__module__, self.__class__.__name__, |
|
1904 | 1904 | self.expr, id(self)) |
|
1905 | 1905 | |
|
1906 | 1906 | |
|
1907 | 1907 | class ienum(Pipe): |
|
1908 | 1908 | """ |
|
1909 | 1909 | Enumerate the input pipe (i.e. wrap each input object in an object |
|
1910 | 1910 | with ``index`` and ``object`` attributes). |
|
1911 | 1911 | |
|
1912 | 1912 | Examples:: |
|
1913 | 1913 | |
|
1914 | 1914 | >>> xrange(20) | ieval("_,_*_") | ienum | ifilter("index % 2 == 0") | ieval("object") |
|
1915 | 1915 | """ |
|
1916 | 1916 | skip_doctest = True |
|
1917 | 1917 | |
|
1918 | 1918 | def __iter__(self): |
|
1919 | 1919 | fields = ("index", "object") |
|
1920 | 1920 | for (index, object) in enumerate(xiter(self.input)): |
|
1921 | 1921 | yield Fields(fields, index=index, object=object) |
|
1922 | 1922 | |
|
1923 | 1923 | |
|
1924 | 1924 | class isort(Pipe): |
|
1925 | 1925 | """ |
|
1926 | 1926 | Sorts the input pipe. |
|
1927 | 1927 | |
|
1928 | 1928 | Examples:: |
|
1929 | 1929 | |
|
1930 | 1930 | >>> ils | isort("size") |
|
1931 |
<IPython. |
|
|
1931 | <IPython.extensions.ipipe.isort key='size' reverse=False at 0x849ec2c> | |
|
1932 | 1932 | >>> ils | isort("_.isdir(), _.lower()", reverse=True) |
|
1933 |
<IPython. |
|
|
1933 | <IPython.extensions.ipipe.isort key='_.isdir(), _.lower()' reverse=True at 0x849eacc> | |
|
1934 | 1934 | # all-random |
|
1935 | 1935 | """ |
|
1936 | 1936 | |
|
1937 | 1937 | def __init__(self, key=None, globals=None, reverse=False): |
|
1938 | 1938 | """ |
|
1939 | 1939 | Create an ``isort`` object. ``key`` can be a callable or a string |
|
1940 | 1940 | containing an expression (or ``None`` in which case the items |
|
1941 | 1941 | themselves will be sorted). If ``reverse`` is true the sort order |
|
1942 | 1942 | will be reversed. For the meaning of ``globals`` see ``ifilter``. |
|
1943 | 1943 | """ |
|
1944 | 1944 | self.key = key |
|
1945 | 1945 | self.globals = globals |
|
1946 | 1946 | self.reverse = reverse |
|
1947 | 1947 | |
|
1948 | 1948 | def __iter__(self): |
|
1949 | 1949 | if self.key is None: |
|
1950 | 1950 | items = sorted(xiter(self.input), reverse=self.reverse) |
|
1951 | 1951 | elif callable(self.key): |
|
1952 | 1952 | items = sorted(xiter(self.input), key=self.key, reverse=self.reverse) |
|
1953 | 1953 | else: |
|
1954 | 1954 | g = getglobals(self.globals) |
|
1955 | 1955 | key = compile(self.key, "ipipe-expression", "eval") |
|
1956 | 1956 | def realkey(item): |
|
1957 | 1957 | return eval(key, g, AttrNamespace(item)) |
|
1958 | 1958 | items = sorted(xiter(self.input), key=realkey, reverse=self.reverse) |
|
1959 | 1959 | for item in items: |
|
1960 | 1960 | yield item |
|
1961 | 1961 | |
|
1962 | 1962 | def __xrepr__(self, mode="default"): |
|
1963 | 1963 | if mode == "header" or mode == "footer": |
|
1964 | 1964 | input = getattr(self, "input", None) |
|
1965 | 1965 | if input is not None: |
|
1966 | 1966 | for part in xrepr(input, mode): |
|
1967 | 1967 | yield part |
|
1968 | 1968 | yield (astyle.style_default, " | ") |
|
1969 | 1969 | yield (astyle.style_default, "%s(" % self.__class__.__name__) |
|
1970 | 1970 | for part in xrepr(self.key, "default"): |
|
1971 | 1971 | yield part |
|
1972 | 1972 | if self.reverse: |
|
1973 | 1973 | yield (astyle.style_default, ", ") |
|
1974 | 1974 | for part in xrepr(True, "default"): |
|
1975 | 1975 | yield part |
|
1976 | 1976 | yield (astyle.style_default, ")") |
|
1977 | 1977 | else: |
|
1978 | 1978 | yield (astyle.style_default, repr(self)) |
|
1979 | 1979 | |
|
1980 | 1980 | def __repr__(self): |
|
1981 | 1981 | return "<%s.%s key=%r reverse=%r at 0x%x>" % \ |
|
1982 | 1982 | (self.__class__.__module__, self.__class__.__name__, |
|
1983 | 1983 | self.key, self.reverse, id(self)) |
|
1984 | 1984 | |
|
1985 | 1985 | |
|
1986 | 1986 | tab = 3 # for expandtabs() |
|
1987 | 1987 | |
|
1988 | 1988 | def _format(field): |
|
1989 | 1989 | if isinstance(field, str): |
|
1990 | 1990 | text = repr(field.expandtabs(tab))[1:-1] |
|
1991 | 1991 | elif isinstance(field, unicode): |
|
1992 | 1992 | text = repr(field.expandtabs(tab))[2:-1] |
|
1993 | 1993 | elif isinstance(field, datetime.datetime): |
|
1994 | 1994 | # Don't use strftime() here, as this requires year >= 1900 |
|
1995 | 1995 | text = "%04d-%02d-%02d %02d:%02d:%02d.%06d" % \ |
|
1996 | 1996 | (field.year, field.month, field.day, |
|
1997 | 1997 | field.hour, field.minute, field.second, field.microsecond) |
|
1998 | 1998 | elif isinstance(field, datetime.date): |
|
1999 | 1999 | text = "%04d-%02d-%02d" % (field.year, field.month, field.day) |
|
2000 | 2000 | else: |
|
2001 | 2001 | text = repr(field) |
|
2002 | 2002 | return text |
|
2003 | 2003 | |
|
2004 | 2004 | |
|
2005 | 2005 | class Display(object): |
|
2006 | 2006 | class __metaclass__(type): |
|
2007 | 2007 | def __ror__(self, input): |
|
2008 | 2008 | return input | self() |
|
2009 | 2009 | |
|
2010 | 2010 | def __init__(self, input=None): |
|
2011 | 2011 | self.input = input |
|
2012 | 2012 | |
|
2013 | 2013 | def __ror__(self, input): |
|
2014 | 2014 | self.input = input |
|
2015 | 2015 | return self |
|
2016 | 2016 | |
|
2017 | 2017 | def display(self): |
|
2018 | 2018 | pass |
|
2019 | 2019 | |
|
2020 | 2020 | |
|
2021 | 2021 | class iless(Display): |
|
2022 | 2022 | cmd = "less --quit-if-one-screen --LONG-PROMPT --LINE-NUMBERS --chop-long-lines --shift=8 --RAW-CONTROL-CHARS" |
|
2023 | 2023 | |
|
2024 | 2024 | def display(self): |
|
2025 | 2025 | try: |
|
2026 | 2026 | pager = os.popen(self.cmd, "w") |
|
2027 | 2027 | try: |
|
2028 | 2028 | for item in xiter(self.input): |
|
2029 | 2029 | first = False |
|
2030 | 2030 | for attr in xattrs(item, "default"): |
|
2031 | 2031 | if first: |
|
2032 | 2032 | first = False |
|
2033 | 2033 | else: |
|
2034 | 2034 | pager.write(" ") |
|
2035 | 2035 | attr = upgradexattr(attr) |
|
2036 | 2036 | if not isinstance(attr, SelfDescriptor): |
|
2037 | 2037 | pager.write(attr.name()) |
|
2038 | 2038 | pager.write("=") |
|
2039 | 2039 | pager.write(str(attr.value(item))) |
|
2040 | 2040 | pager.write("\n") |
|
2041 | 2041 | finally: |
|
2042 | 2042 | pager.close() |
|
2043 | 2043 | except Exception, exc: |
|
2044 | 2044 | print "%s: %s" % (exc.__class__.__name__, str(exc)) |
|
2045 | 2045 | |
|
2046 | 2046 | |
|
2047 | 2047 | class _RedirectIO(object): |
|
2048 | 2048 | def __init__(self,*args,**kwargs): |
|
2049 | 2049 | """ |
|
2050 | 2050 | Map the system output streams to self. |
|
2051 | 2051 | """ |
|
2052 | 2052 | self.stream = StringIO.StringIO() |
|
2053 | 2053 | self.stdout = sys.stdout |
|
2054 | 2054 | sys.stdout = self |
|
2055 | 2055 | self.stderr = sys.stderr |
|
2056 | 2056 | sys.stderr = self |
|
2057 | 2057 | |
|
2058 | 2058 | def write(self, text): |
|
2059 | 2059 | """ |
|
2060 | 2060 | Write both to screen and to self. |
|
2061 | 2061 | """ |
|
2062 | 2062 | self.stream.write(text) |
|
2063 | 2063 | self.stdout.write(text) |
|
2064 | 2064 | if "\n" in text: |
|
2065 | 2065 | self.stdout.flush() |
|
2066 | 2066 | |
|
2067 | 2067 | def writelines(self, lines): |
|
2068 | 2068 | """ |
|
2069 | 2069 | Write lines both to screen and to self. |
|
2070 | 2070 | """ |
|
2071 | 2071 | self.stream.writelines(lines) |
|
2072 | 2072 | self.stdout.writelines(lines) |
|
2073 | 2073 | self.stdout.flush() |
|
2074 | 2074 | |
|
2075 | 2075 | def restore(self): |
|
2076 | 2076 | """ |
|
2077 | 2077 | Restore the default system streams. |
|
2078 | 2078 | """ |
|
2079 | 2079 | self.stdout.flush() |
|
2080 | 2080 | self.stderr.flush() |
|
2081 | 2081 | sys.stdout = self.stdout |
|
2082 | 2082 | sys.stderr = self.stderr |
|
2083 | 2083 | |
|
2084 | 2084 | |
|
2085 | 2085 | class icap(Table): |
|
2086 | 2086 | """ |
|
2087 | 2087 | Execute a python string and capture any output to stderr/stdout. |
|
2088 | 2088 | |
|
2089 | 2089 | Examples:: |
|
2090 | 2090 | |
|
2091 | 2091 | >>> import time |
|
2092 | 2092 | >>> icap("for i in range(10): print i, time.sleep(0.1)") |
|
2093 | 2093 | |
|
2094 | 2094 | """ |
|
2095 | 2095 | skip_doctest = True |
|
2096 | 2096 | |
|
2097 | 2097 | def __init__(self, expr, globals=None): |
|
2098 | 2098 | self.expr = expr |
|
2099 | 2099 | self.globals = globals |
|
2100 | 2100 | log = _RedirectIO() |
|
2101 | 2101 | try: |
|
2102 | 2102 | exec(expr, getglobals(globals)) |
|
2103 | 2103 | finally: |
|
2104 | 2104 | log.restore() |
|
2105 | 2105 | self.stream = log.stream |
|
2106 | 2106 | |
|
2107 | 2107 | def __iter__(self): |
|
2108 | 2108 | self.stream.seek(0) |
|
2109 | 2109 | for line in self.stream: |
|
2110 | 2110 | yield line.rstrip("\r\n") |
|
2111 | 2111 | |
|
2112 | 2112 | def __xrepr__(self, mode="default"): |
|
2113 | 2113 | if mode == "header" or mode == "footer": |
|
2114 | 2114 | yield (astyle.style_default, |
|
2115 | 2115 | "%s(%r)" % (self.__class__.__name__, self.expr)) |
|
2116 | 2116 | else: |
|
2117 | 2117 | yield (astyle.style_default, repr(self)) |
|
2118 | 2118 | |
|
2119 | 2119 | def __repr__(self): |
|
2120 | 2120 | return "%s.%s(%r)" % \ |
|
2121 | 2121 | (self.__class__.__module__, self.__class__.__name__, self.expr) |
|
2122 | 2122 | |
|
2123 | 2123 | |
|
2124 | 2124 | def xformat(value, mode, maxlength): |
|
2125 | 2125 | align = None |
|
2126 | 2126 | full = True |
|
2127 | 2127 | width = 0 |
|
2128 | 2128 | text = astyle.Text() |
|
2129 | 2129 | for (style, part) in xrepr(value, mode): |
|
2130 | 2130 | # only consider the first result |
|
2131 | 2131 | if align is None: |
|
2132 | 2132 | if isinstance(style, int): |
|
2133 | 2133 | # (style, text) really is (alignment, stop) |
|
2134 | 2134 | align = style |
|
2135 | 2135 | full = part |
|
2136 | 2136 | continue |
|
2137 | 2137 | else: |
|
2138 | 2138 | align = -1 |
|
2139 | 2139 | full = True |
|
2140 | 2140 | if not isinstance(style, int): |
|
2141 | 2141 | text.append((style, part)) |
|
2142 | 2142 | width += len(part) |
|
2143 | 2143 | if width >= maxlength and not full: |
|
2144 | 2144 | text.append((astyle.style_ellisis, "...")) |
|
2145 | 2145 | width += 3 |
|
2146 | 2146 | break |
|
2147 | 2147 | if align is None: # default to left alignment |
|
2148 | 2148 | align = -1 |
|
2149 | 2149 | return (align, width, text) |
|
2150 | 2150 | |
|
2151 | 2151 | |
|
2152 | 2152 | |
|
2153 | 2153 | import astyle |
|
2154 | 2154 | |
|
2155 | 2155 | class idump(Display): |
|
2156 | 2156 | # The approximate maximum length of a column entry |
|
2157 | 2157 | maxattrlength = 200 |
|
2158 | 2158 | |
|
2159 | 2159 | # Style for column names |
|
2160 | 2160 | style_header = astyle.Style.fromstr("white:black:bold") |
|
2161 | 2161 | |
|
2162 | 2162 | def __init__(self, input=None, *attrs): |
|
2163 | 2163 | Display.__init__(self, input) |
|
2164 | 2164 | self.attrs = [upgradexattr(attr) for attr in attrs] |
|
2165 | 2165 | self.headerpadchar = " " |
|
2166 | 2166 | self.headersepchar = "|" |
|
2167 | 2167 | self.datapadchar = " " |
|
2168 | 2168 | self.datasepchar = "|" |
|
2169 | 2169 | |
|
2170 | 2170 | def display(self): |
|
2171 | 2171 | stream = genutils.Term.cout |
|
2172 | 2172 | allattrs = [] |
|
2173 | 2173 | attrset = set() |
|
2174 | 2174 | colwidths = {} |
|
2175 | 2175 | rows = [] |
|
2176 | 2176 | for item in xiter(self.input): |
|
2177 | 2177 | row = {} |
|
2178 | 2178 | attrs = self.attrs |
|
2179 | 2179 | if not attrs: |
|
2180 | 2180 | attrs = xattrs(item, "default") |
|
2181 | 2181 | for attr in attrs: |
|
2182 | 2182 | if attr not in attrset: |
|
2183 | 2183 | allattrs.append(attr) |
|
2184 | 2184 | attrset.add(attr) |
|
2185 | 2185 | colwidths[attr] = len(attr.name()) |
|
2186 | 2186 | try: |
|
2187 | 2187 | value = attr.value(item) |
|
2188 | 2188 | except (KeyboardInterrupt, SystemExit): |
|
2189 | 2189 | raise |
|
2190 | 2190 | except Exception, exc: |
|
2191 | 2191 | value = exc |
|
2192 | 2192 | (align, width, text) = xformat(value, "cell", self.maxattrlength) |
|
2193 | 2193 | colwidths[attr] = max(colwidths[attr], width) |
|
2194 | 2194 | # remember alignment, length and colored parts |
|
2195 | 2195 | row[attr] = (align, width, text) |
|
2196 | 2196 | rows.append(row) |
|
2197 | 2197 | |
|
2198 | 2198 | stream.write("\n") |
|
2199 | 2199 | for (i, attr) in enumerate(allattrs): |
|
2200 | 2200 | attrname = attr.name() |
|
2201 | 2201 | self.style_header(attrname).write(stream) |
|
2202 | 2202 | spc = colwidths[attr] - len(attrname) |
|
2203 | 2203 | if i < len(colwidths)-1: |
|
2204 | 2204 | stream.write(self.headerpadchar*spc) |
|
2205 | 2205 | stream.write(self.headersepchar) |
|
2206 | 2206 | stream.write("\n") |
|
2207 | 2207 | |
|
2208 | 2208 | for row in rows: |
|
2209 | 2209 | for (i, attr) in enumerate(allattrs): |
|
2210 | 2210 | (align, width, text) = row[attr] |
|
2211 | 2211 | spc = colwidths[attr] - width |
|
2212 | 2212 | if align == -1: |
|
2213 | 2213 | text.write(stream) |
|
2214 | 2214 | if i < len(colwidths)-1: |
|
2215 | 2215 | stream.write(self.datapadchar*spc) |
|
2216 | 2216 | elif align == 0: |
|
2217 | 2217 | spc = colwidths[attr] - width |
|
2218 | 2218 | spc1 = spc//2 |
|
2219 | 2219 | spc2 = spc-spc1 |
|
2220 | 2220 | stream.write(self.datapadchar*spc1) |
|
2221 | 2221 | text.write(stream) |
|
2222 | 2222 | if i < len(colwidths)-1: |
|
2223 | 2223 | stream.write(self.datapadchar*spc2) |
|
2224 | 2224 | else: |
|
2225 | 2225 | stream.write(self.datapadchar*spc) |
|
2226 | 2226 | text.write(stream) |
|
2227 | 2227 | if i < len(colwidths)-1: |
|
2228 | 2228 | stream.write(self.datasepchar) |
|
2229 | 2229 | stream.write("\n") |
|
2230 | 2230 | |
|
2231 | 2231 | |
|
2232 | 2232 | class AttributeDetail(Table): |
|
2233 | 2233 | """ |
|
2234 | 2234 | ``AttributeDetail`` objects are use for displaying a detailed list of object |
|
2235 | 2235 | attributes. |
|
2236 | 2236 | """ |
|
2237 | 2237 | def __init__(self, object, descriptor): |
|
2238 | 2238 | self.object = object |
|
2239 | 2239 | self.descriptor = descriptor |
|
2240 | 2240 | |
|
2241 | 2241 | def __iter__(self): |
|
2242 | 2242 | return self.descriptor.iter(self.object) |
|
2243 | 2243 | |
|
2244 | 2244 | def name(self): |
|
2245 | 2245 | return self.descriptor.name() |
|
2246 | 2246 | |
|
2247 | 2247 | def attrtype(self): |
|
2248 | 2248 | return self.descriptor.attrtype(self.object) |
|
2249 | 2249 | |
|
2250 | 2250 | def valuetype(self): |
|
2251 | 2251 | return self.descriptor.valuetype(self.object) |
|
2252 | 2252 | |
|
2253 | 2253 | def doc(self): |
|
2254 | 2254 | return self.descriptor.doc(self.object) |
|
2255 | 2255 | |
|
2256 | 2256 | def shortdoc(self): |
|
2257 | 2257 | return self.descriptor.shortdoc(self.object) |
|
2258 | 2258 | |
|
2259 | 2259 | def value(self): |
|
2260 | 2260 | return self.descriptor.value(self.object) |
|
2261 | 2261 | |
|
2262 | 2262 | def __xattrs__(self, mode="default"): |
|
2263 | 2263 | attrs = ("name()", "attrtype()", "valuetype()", "value()", "shortdoc()") |
|
2264 | 2264 | if mode == "detail": |
|
2265 | 2265 | attrs += ("doc()",) |
|
2266 | 2266 | return attrs |
|
2267 | 2267 | |
|
2268 | 2268 | def __xrepr__(self, mode="default"): |
|
2269 | 2269 | yield (-1, True) |
|
2270 | 2270 | valuetype = self.valuetype() |
|
2271 | 2271 | if valuetype is not noitem: |
|
2272 | 2272 | for part in xrepr(valuetype): |
|
2273 | 2273 | yield part |
|
2274 | 2274 | yield (astyle.style_default, " ") |
|
2275 | 2275 | yield (astyle.style_default, self.attrtype()) |
|
2276 | 2276 | yield (astyle.style_default, " ") |
|
2277 | 2277 | yield (astyle.style_default, self.name()) |
|
2278 | 2278 | yield (astyle.style_default, " of ") |
|
2279 | 2279 | for part in xrepr(self.object): |
|
2280 | 2280 | yield part |
|
2281 | 2281 | |
|
2282 | 2282 | |
|
2283 | 2283 | try: |
|
2284 | 2284 | from ibrowse import ibrowse |
|
2285 | 2285 | except ImportError: |
|
2286 | 2286 | # No curses (probably Windows) => try igrid |
|
2287 | 2287 | try: |
|
2288 | 2288 | from igrid import igrid |
|
2289 | 2289 | except ImportError: |
|
2290 | 2290 | # no wx either => use ``idump`` as the default display. |
|
2291 | 2291 | defaultdisplay = idump |
|
2292 | 2292 | else: |
|
2293 | 2293 | defaultdisplay = igrid |
|
2294 | 2294 | __all__.append("igrid") |
|
2295 | 2295 | else: |
|
2296 | 2296 | defaultdisplay = ibrowse |
|
2297 | 2297 | __all__.append("ibrowse") |
|
2298 | 2298 | |
|
2299 | 2299 | |
|
2300 | 2300 | # If we're running under IPython, register our objects with IPython's |
|
2301 | 2301 | # generic function ``result_display``, else install a displayhook |
|
2302 | 2302 | # directly as sys.displayhook |
|
2303 | 2303 | if generics is not None: |
|
2304 | 2304 | def display_display(obj): |
|
2305 | 2305 | return obj.display() |
|
2306 | 2306 | generics.result_display.when_type(Display)(display_display) |
|
2307 | 2307 | |
|
2308 | 2308 | def display_tableobject(obj): |
|
2309 | 2309 | return display_display(defaultdisplay(obj)) |
|
2310 | 2310 | generics.result_display.when_type(Table)(display_tableobject) |
|
2311 | 2311 | |
|
2312 | 2312 | def display_tableclass(obj): |
|
2313 | 2313 | return display_tableobject(obj()) |
|
2314 | 2314 | generics.result_display.when_type(Table.__metaclass__)(display_tableclass) |
|
2315 | 2315 | else: |
|
2316 | 2316 | def installdisplayhook(): |
|
2317 | 2317 | _originalhook = sys.displayhook |
|
2318 | 2318 | def displayhook(obj): |
|
2319 | 2319 | if isinstance(obj, type) and issubclass(obj, Table): |
|
2320 | 2320 | obj = obj() |
|
2321 | 2321 | if isinstance(obj, Table): |
|
2322 | 2322 | obj = defaultdisplay(obj) |
|
2323 | 2323 | if isinstance(obj, Display): |
|
2324 | 2324 | return obj.display() |
|
2325 | 2325 | else: |
|
2326 | 2326 | _originalhook(obj) |
|
2327 | 2327 | sys.displayhook = displayhook |
|
2328 | 2328 | installdisplayhook() |
@@ -1,19 +1,19 b'' | |||
|
1 | 1 | """ Install various IPython completers |
|
2 | 2 | |
|
3 | 3 | IPython extension that installs the completers related to external apps. |
|
4 | 4 | |
|
5 |
The actual implementations are in |
|
|
5 | The actual implementations are in extensions/ipy_completers.py | |
|
6 | 6 | |
|
7 | 7 | """ |
|
8 | 8 | from IPython.core import ipapi |
|
9 | 9 | |
|
10 | 10 | ip = ipapi.get() |
|
11 | 11 | |
|
12 | 12 | from ipy_completers import * |
|
13 | 13 | |
|
14 | 14 | ip.set_hook('complete_command', apt_completer, re_key = '.*apt-get') |
|
15 | 15 | ip.set_hook('complete_command', svn_completer, str_key = 'svn') |
|
16 | 16 | ip.set_hook('complete_command', hg_completer, str_key = 'hg') |
|
17 | 17 | |
|
18 | 18 | # the old bzr completer is deprecated, we recommend ipy_bzr |
|
19 | 19 | #ip.set_hook('complete_command', bzr_completer, str_key = 'bzr') |
@@ -1,400 +1,400 b'' | |||
|
1 | 1 | |
|
2 | 2 | """ Implementations for various useful completers |
|
3 | 3 | |
|
4 |
See |
|
|
4 | See extensions/ipy_stock_completers.py on examples of how to enable a completer, | |
|
5 | 5 | but the basic idea is to do: |
|
6 | 6 | |
|
7 | 7 | ip.set_hook('complete_command', svn_completer, str_key = 'svn') |
|
8 | 8 | |
|
9 | 9 | """ |
|
10 | 10 | from IPython.core import ipapi |
|
11 | 11 | import glob,os,shlex,sys |
|
12 | 12 | import inspect |
|
13 | 13 | from time import time |
|
14 | 14 | from zipimport import zipimporter |
|
15 | 15 | ip = ipapi.get() |
|
16 | 16 | |
|
17 | 17 | try: |
|
18 | 18 | set |
|
19 | 19 | except: |
|
20 | 20 | from sets import Set as set |
|
21 | 21 | |
|
22 | 22 | TIMEOUT_STORAGE = 3 #Time in seconds after which the rootmodules will be stored |
|
23 | 23 | TIMEOUT_GIVEUP = 20 #Time in seconds after which we give up |
|
24 | 24 | |
|
25 | 25 | def quick_completer(cmd, completions): |
|
26 | 26 | """ Easily create a trivial completer for a command. |
|
27 | 27 | |
|
28 | 28 | Takes either a list of completions, or all completions in string |
|
29 | 29 | (that will be split on whitespace) |
|
30 | 30 | |
|
31 | 31 | Example:: |
|
32 | 32 | |
|
33 | 33 | [d:\ipython]|1> import ipy_completers |
|
34 | 34 | [d:\ipython]|2> ipy_completers.quick_completer('foo', ['bar','baz']) |
|
35 | 35 | [d:\ipython]|3> foo b<TAB> |
|
36 | 36 | bar baz |
|
37 | 37 | [d:\ipython]|3> foo ba |
|
38 | 38 | """ |
|
39 | 39 | if isinstance(completions, basestring): |
|
40 | 40 | |
|
41 | 41 | completions = completions.split() |
|
42 | 42 | def do_complete(self,event): |
|
43 | 43 | return completions |
|
44 | 44 | |
|
45 | 45 | ip.set_hook('complete_command',do_complete, str_key = cmd) |
|
46 | 46 | |
|
47 | 47 | def getRootModules(): |
|
48 | 48 | """ |
|
49 | 49 | Returns a list containing the names of all the modules available in the |
|
50 | 50 | folders of the pythonpath. |
|
51 | 51 | """ |
|
52 | 52 | modules = [] |
|
53 | 53 | if ip.db.has_key('rootmodules'): |
|
54 | 54 | return ip.db['rootmodules'] |
|
55 | 55 | t = time() |
|
56 | 56 | store = False |
|
57 | 57 | for path in sys.path: |
|
58 | 58 | modules += moduleList(path) |
|
59 | 59 | if time() - t >= TIMEOUT_STORAGE and not store: |
|
60 | 60 | store = True |
|
61 | 61 | print "\nCaching the list of root modules, please wait!" |
|
62 | 62 | print "(This will only be done once - type '%rehashx' to " + \ |
|
63 | 63 | "reset cache!)" |
|
64 | 64 | |
|
65 | 65 | if time() - t > TIMEOUT_GIVEUP: |
|
66 | 66 | print "This is taking too long, we give up." |
|
67 | 67 | |
|
68 | 68 | ip.db['rootmodules'] = [] |
|
69 | 69 | return [] |
|
70 | 70 | |
|
71 | 71 | modules += sys.builtin_module_names |
|
72 | 72 | |
|
73 | 73 | modules = list(set(modules)) |
|
74 | 74 | if '__init__' in modules: |
|
75 | 75 | modules.remove('__init__') |
|
76 | 76 | modules = list(set(modules)) |
|
77 | 77 | if store: |
|
78 | 78 | ip.db['rootmodules'] = modules |
|
79 | 79 | return modules |
|
80 | 80 | |
|
81 | 81 | def moduleList(path): |
|
82 | 82 | """ |
|
83 | 83 | Return the list containing the names of the modules available in the given |
|
84 | 84 | folder. |
|
85 | 85 | """ |
|
86 | 86 | |
|
87 | 87 | if os.path.isdir(path): |
|
88 | 88 | folder_list = os.listdir(path) |
|
89 | 89 | elif path.endswith('.egg'): |
|
90 | 90 | try: |
|
91 | 91 | folder_list = [f for f in zipimporter(path)._files] |
|
92 | 92 | except: |
|
93 | 93 | folder_list = [] |
|
94 | 94 | else: |
|
95 | 95 | folder_list = [] |
|
96 | 96 | #folder_list = glob.glob(os.path.join(path,'*')) |
|
97 | 97 | folder_list = [p for p in folder_list \ |
|
98 | 98 | if os.path.exists(os.path.join(path, p,'__init__.py'))\ |
|
99 | 99 | or p[-3:] in ('.py','.so')\ |
|
100 | 100 | or p[-4:] in ('.pyc','.pyo','.pyd')] |
|
101 | 101 | |
|
102 | 102 | folder_list = [os.path.basename(p).split('.')[0] for p in folder_list] |
|
103 | 103 | return folder_list |
|
104 | 104 | |
|
105 | 105 | def moduleCompletion(line): |
|
106 | 106 | """ |
|
107 | 107 | Returns a list containing the completion possibilities for an import line. |
|
108 | 108 | The line looks like this : |
|
109 | 109 | 'import xml.d' |
|
110 | 110 | 'from xml.dom import' |
|
111 | 111 | """ |
|
112 | 112 | def tryImport(mod, only_modules=False): |
|
113 | 113 | def isImportable(module, attr): |
|
114 | 114 | if only_modules: |
|
115 | 115 | return inspect.ismodule(getattr(module, attr)) |
|
116 | 116 | else: |
|
117 | 117 | return not(attr[:2] == '__' and attr[-2:] == '__') |
|
118 | 118 | try: |
|
119 | 119 | m = __import__(mod) |
|
120 | 120 | except: |
|
121 | 121 | return [] |
|
122 | 122 | mods = mod.split('.') |
|
123 | 123 | for module in mods[1:]: |
|
124 | 124 | m = getattr(m,module) |
|
125 | 125 | if (not hasattr(m, '__file__')) or (not only_modules) or\ |
|
126 | 126 | (hasattr(m, '__file__') and '__init__' in m.__file__): |
|
127 | 127 | completion_list = [attr for attr in dir(m) if isImportable(m, attr)] |
|
128 | 128 | completion_list.extend(getattr(m,'__all__',[])) |
|
129 | 129 | if hasattr(m, '__file__') and '__init__' in m.__file__: |
|
130 | 130 | completion_list.extend(moduleList(os.path.dirname(m.__file__))) |
|
131 | 131 | completion_list = list(set(completion_list)) |
|
132 | 132 | if '__init__' in completion_list: |
|
133 | 133 | completion_list.remove('__init__') |
|
134 | 134 | return completion_list |
|
135 | 135 | |
|
136 | 136 | words = line.split(' ') |
|
137 | 137 | if len(words) == 3 and words[0] == 'from': |
|
138 | 138 | return ['import '] |
|
139 | 139 | if len(words) < 3 and (words[0] in ['import','from']) : |
|
140 | 140 | if len(words) == 1: |
|
141 | 141 | return getRootModules() |
|
142 | 142 | mod = words[1].split('.') |
|
143 | 143 | if len(mod) < 2: |
|
144 | 144 | return getRootModules() |
|
145 | 145 | completion_list = tryImport('.'.join(mod[:-1]), True) |
|
146 | 146 | completion_list = ['.'.join(mod[:-1] + [el]) for el in completion_list] |
|
147 | 147 | return completion_list |
|
148 | 148 | if len(words) >= 3 and words[0] == 'from': |
|
149 | 149 | mod = words[1] |
|
150 | 150 | return tryImport(mod) |
|
151 | 151 | |
|
152 | 152 | def vcs_completer(commands, event): |
|
153 | 153 | """ utility to make writing typical version control app completers easier |
|
154 | 154 | |
|
155 | 155 | VCS command line apps typically have the format: |
|
156 | 156 | |
|
157 | 157 | [sudo ]PROGNAME [help] [command] file file... |
|
158 | 158 | |
|
159 | 159 | """ |
|
160 | 160 | |
|
161 | 161 | |
|
162 | 162 | cmd_param = event.line.split() |
|
163 | 163 | if event.line.endswith(' '): |
|
164 | 164 | cmd_param.append('') |
|
165 | 165 | |
|
166 | 166 | if cmd_param[0] == 'sudo': |
|
167 | 167 | cmd_param = cmd_param[1:] |
|
168 | 168 | |
|
169 | 169 | if len(cmd_param) == 2 or 'help' in cmd_param: |
|
170 | 170 | return commands.split() |
|
171 | 171 | |
|
172 | 172 | return ip.IP.Completer.file_matches(event.symbol) |
|
173 | 173 | |
|
174 | 174 | |
|
175 | 175 | pkg_cache = None |
|
176 | 176 | |
|
177 | 177 | def module_completer(self,event): |
|
178 | 178 | """ Give completions after user has typed 'import ...' or 'from ...'""" |
|
179 | 179 | |
|
180 | 180 | # This works in all versions of python. While 2.5 has |
|
181 | 181 | # pkgutil.walk_packages(), that particular routine is fairly dangerous, |
|
182 | 182 | # since it imports *EVERYTHING* on sys.path. That is: a) very slow b) full |
|
183 | 183 | # of possibly problematic side effects. |
|
184 | 184 | # This search the folders in the sys.path for available modules. |
|
185 | 185 | |
|
186 | 186 | return moduleCompletion(event.line) |
|
187 | 187 | |
|
188 | 188 | |
|
189 | 189 | svn_commands = """\ |
|
190 | 190 | add blame praise annotate ann cat checkout co cleanup commit ci copy |
|
191 | 191 | cp delete del remove rm diff di export help ? h import info list ls |
|
192 | 192 | lock log merge mkdir move mv rename ren propdel pdel pd propedit pedit |
|
193 | 193 | pe propget pget pg proplist plist pl propset pset ps resolved revert |
|
194 | 194 | status stat st switch sw unlock update |
|
195 | 195 | """ |
|
196 | 196 | |
|
197 | 197 | def svn_completer(self,event): |
|
198 | 198 | return vcs_completer(svn_commands, event) |
|
199 | 199 | |
|
200 | 200 | |
|
201 | 201 | hg_commands = """ |
|
202 | 202 | add addremove annotate archive backout branch branches bundle cat |
|
203 | 203 | clone commit copy diff export grep heads help identify import incoming |
|
204 | 204 | init locate log manifest merge outgoing parents paths pull push |
|
205 | 205 | qapplied qclone qcommit qdelete qdiff qfold qguard qheader qimport |
|
206 | 206 | qinit qnew qnext qpop qprev qpush qrefresh qrename qrestore qsave |
|
207 | 207 | qselect qseries qtop qunapplied recover remove rename revert rollback |
|
208 | 208 | root serve showconfig status strip tag tags tip unbundle update verify |
|
209 | 209 | version |
|
210 | 210 | """ |
|
211 | 211 | |
|
212 | 212 | def hg_completer(self,event): |
|
213 | 213 | """ Completer for mercurial commands """ |
|
214 | 214 | |
|
215 | 215 | return vcs_completer(hg_commands, event) |
|
216 | 216 | |
|
217 | 217 | |
|
218 | 218 | |
|
219 | 219 | __bzr_commands = None |
|
220 | 220 | |
|
221 | 221 | def bzr_commands(): |
|
222 | 222 | global __bzr_commands |
|
223 | 223 | if __bzr_commands is not None: |
|
224 | 224 | return __bzr_commands |
|
225 | 225 | out = os.popen('bzr help commands') |
|
226 | 226 | __bzr_commands = [l.split()[0] for l in out] |
|
227 | 227 | return __bzr_commands |
|
228 | 228 | |
|
229 | 229 | def bzr_completer(self,event): |
|
230 | 230 | """ Completer for bazaar commands """ |
|
231 | 231 | cmd_param = event.line.split() |
|
232 | 232 | if event.line.endswith(' '): |
|
233 | 233 | cmd_param.append('') |
|
234 | 234 | |
|
235 | 235 | if len(cmd_param) > 2: |
|
236 | 236 | cmd = cmd_param[1] |
|
237 | 237 | param = cmd_param[-1] |
|
238 | 238 | output_file = (param == '--output=') |
|
239 | 239 | if cmd == 'help': |
|
240 | 240 | return bzr_commands() |
|
241 | 241 | elif cmd in ['bundle-revisions','conflicts', |
|
242 | 242 | 'deleted','nick','register-branch', |
|
243 | 243 | 'serve','unbind','upgrade','version', |
|
244 | 244 | 'whoami'] and not output_file: |
|
245 | 245 | return [] |
|
246 | 246 | else: |
|
247 | 247 | # the rest are probably file names |
|
248 | 248 | return ip.IP.Completer.file_matches(event.symbol) |
|
249 | 249 | |
|
250 | 250 | return bzr_commands() |
|
251 | 251 | |
|
252 | 252 | |
|
253 | 253 | def shlex_split(x): |
|
254 | 254 | """Helper function to split lines into segments.""" |
|
255 | 255 | #shlex.split raise exception if syntax error in sh syntax |
|
256 | 256 | #for example if no closing " is found. This function keeps dropping |
|
257 | 257 | #the last character of the line until shlex.split does not raise |
|
258 | 258 | #exception. Adds end of the line to the result of shlex.split |
|
259 | 259 | #example: %run "c:/python -> ['%run','"c:/python'] |
|
260 | 260 | endofline=[] |
|
261 | 261 | while x!="": |
|
262 | 262 | try: |
|
263 | 263 | comps=shlex.split(x) |
|
264 | 264 | if len(endofline)>=1: |
|
265 | 265 | comps.append("".join(endofline)) |
|
266 | 266 | return comps |
|
267 | 267 | except ValueError: |
|
268 | 268 | endofline=[x[-1:]]+endofline |
|
269 | 269 | x=x[:-1] |
|
270 | 270 | return ["".join(endofline)] |
|
271 | 271 | |
|
272 | 272 | def runlistpy(self, event): |
|
273 | 273 | comps = shlex_split(event.line) |
|
274 | 274 | relpath = (len(comps) > 1 and comps[-1] or '').strip("'\"") |
|
275 | 275 | |
|
276 | 276 | #print "\nev=",event # dbg |
|
277 | 277 | #print "rp=",relpath # dbg |
|
278 | 278 | #print 'comps=',comps # dbg |
|
279 | 279 | |
|
280 | 280 | lglob = glob.glob |
|
281 | 281 | isdir = os.path.isdir |
|
282 | 282 | if relpath.startswith('~'): |
|
283 | 283 | relpath = os.path.expanduser(relpath) |
|
284 | 284 | dirs = [f.replace('\\','/') + "/" for f in lglob(relpath+'*') |
|
285 | 285 | if isdir(f)] |
|
286 | 286 | |
|
287 | 287 | # Find if the user has already typed the first filename, after which we |
|
288 | 288 | # should complete on all files, since after the first one other files may |
|
289 | 289 | # be arguments to the input script. |
|
290 | 290 | #filter( |
|
291 | 291 | if filter(lambda f: f.endswith('.py') or f.endswith('.ipy') or |
|
292 | 292 | f.endswith('.pyw'),comps): |
|
293 | 293 | pys = [f.replace('\\','/') for f in lglob('*')] |
|
294 | 294 | else: |
|
295 | 295 | pys = [f.replace('\\','/') |
|
296 | 296 | for f in lglob(relpath+'*.py') + lglob(relpath+'*.ipy') + |
|
297 | 297 | lglob(relpath + '*.pyw')] |
|
298 | 298 | return dirs + pys |
|
299 | 299 | |
|
300 | 300 | |
|
301 | 301 | greedy_cd_completer = False |
|
302 | 302 | |
|
303 | 303 | def cd_completer(self, event): |
|
304 | 304 | relpath = event.symbol |
|
305 | 305 | #print event # dbg |
|
306 | 306 | if '-b' in event.line: |
|
307 | 307 | # return only bookmark completions |
|
308 | 308 | bkms = self.db.get('bookmarks',{}) |
|
309 | 309 | return bkms.keys() |
|
310 | 310 | |
|
311 | 311 | |
|
312 | 312 | if event.symbol == '-': |
|
313 | 313 | width_dh = str(len(str(len(ip.user_ns['_dh']) + 1))) |
|
314 | 314 | # jump in directory history by number |
|
315 | 315 | fmt = '-%0' + width_dh +'d [%s]' |
|
316 | 316 | ents = [ fmt % (i,s) for i,s in enumerate(ip.user_ns['_dh'])] |
|
317 | 317 | if len(ents) > 1: |
|
318 | 318 | return ents |
|
319 | 319 | return [] |
|
320 | 320 | |
|
321 | 321 | if event.symbol.startswith('--'): |
|
322 | 322 | return ["--" + os.path.basename(d) for d in ip.user_ns['_dh']] |
|
323 | 323 | |
|
324 | 324 | if relpath.startswith('~'): |
|
325 | 325 | relpath = os.path.expanduser(relpath).replace('\\','/') |
|
326 | 326 | found = [] |
|
327 | 327 | for d in [f.replace('\\','/') + '/' for f in glob.glob(relpath+'*') |
|
328 | 328 | if os.path.isdir(f)]: |
|
329 | 329 | if ' ' in d: |
|
330 | 330 | # we don't want to deal with any of that, complex code |
|
331 | 331 | # for this is elsewhere |
|
332 | 332 | raise ipapi.TryNext |
|
333 | 333 | found.append( d ) |
|
334 | 334 | |
|
335 | 335 | if not found: |
|
336 | 336 | if os.path.isdir(relpath): |
|
337 | 337 | return [relpath] |
|
338 | 338 | # if no completions so far, try bookmarks |
|
339 | 339 | bks = self.db.get('bookmarks',{}).keys() |
|
340 | 340 | bkmatches = [s for s in bks if s.startswith(event.symbol)] |
|
341 | 341 | if bkmatches: |
|
342 | 342 | return bkmatches |
|
343 | 343 | |
|
344 | 344 | raise ipapi.TryNext |
|
345 | 345 | |
|
346 | 346 | |
|
347 | 347 | def single_dir_expand(matches): |
|
348 | 348 | "Recursively expand match lists containing a single dir." |
|
349 | 349 | |
|
350 | 350 | if len(matches) == 1 and os.path.isdir(matches[0]): |
|
351 | 351 | # Takes care of links to directories also. Use '/' |
|
352 | 352 | # explicitly, even under Windows, so that name completions |
|
353 | 353 | # don't end up escaped. |
|
354 | 354 | d = matches[0] |
|
355 | 355 | if d[-1] in ['/','\\']: |
|
356 | 356 | d = d[:-1] |
|
357 | 357 | |
|
358 | 358 | subdirs = [p for p in os.listdir(d) if os.path.isdir( d + '/' + p) and not p.startswith('.')] |
|
359 | 359 | if subdirs: |
|
360 | 360 | matches = [ (d + '/' + p) for p in subdirs ] |
|
361 | 361 | return single_dir_expand(matches) |
|
362 | 362 | else: |
|
363 | 363 | return matches |
|
364 | 364 | else: |
|
365 | 365 | return matches |
|
366 | 366 | |
|
367 | 367 | if greedy_cd_completer: |
|
368 | 368 | return single_dir_expand(found) |
|
369 | 369 | else: |
|
370 | 370 | return found |
|
371 | 371 | |
|
372 | 372 | def apt_get_packages(prefix): |
|
373 | 373 | out = os.popen('apt-cache pkgnames') |
|
374 | 374 | for p in out: |
|
375 | 375 | if p.startswith(prefix): |
|
376 | 376 | yield p.rstrip() |
|
377 | 377 | |
|
378 | 378 | |
|
379 | 379 | apt_commands = """\ |
|
380 | 380 | update upgrade install remove purge source build-dep dist-upgrade |
|
381 | 381 | dselect-upgrade clean autoclean check""" |
|
382 | 382 | |
|
383 | 383 | def apt_completer(self, event): |
|
384 | 384 | """ Completer for apt-get (uses apt-cache internally) |
|
385 | 385 | |
|
386 | 386 | """ |
|
387 | 387 | |
|
388 | 388 | |
|
389 | 389 | cmd_param = event.line.split() |
|
390 | 390 | if event.line.endswith(' '): |
|
391 | 391 | cmd_param.append('') |
|
392 | 392 | |
|
393 | 393 | if cmd_param[0] == 'sudo': |
|
394 | 394 | cmd_param = cmd_param[1:] |
|
395 | 395 | |
|
396 | 396 | if len(cmd_param) == 2 or 'help' in cmd_param: |
|
397 | 397 | return apt_commands.split() |
|
398 | 398 | |
|
399 | 399 | return list(apt_get_packages(event.symbol)) |
|
400 | 400 |
@@ -1,669 +1,669 b'' | |||
|
1 | 1 | """ Module with physical constants for use with ipython, profile |
|
2 | 2 | "physics". |
|
3 | 3 | |
|
4 | 4 | Definition of Fundamental Physical Constants, CODATA Recommended Values |
|
5 | 5 | |
|
6 | 6 | Source, Peter J. Mohr and Barry N. Taylor, |
|
7 | 7 | CODATA Recommended Values of the Fundamental |
|
8 | 8 | Physical Constants, 1998 |
|
9 | 9 | |
|
10 | 10 | Website: physics.nist.gov/constants |
|
11 | 11 | """ |
|
12 | 12 | # License: BSD-like |
|
13 | 13 | # Copyright: Gael Varoquaux (gael.varoquaux@normalesup.org) |
|
14 | 14 | |
|
15 | 15 | # inspired by maxima's physconst.mac by Cliff Yapp |
|
16 | 16 | |
|
17 | 17 | #from math import * # math MUST be imported BEFORE PhysicalQInteractive |
|
18 |
from IPython. |
|
|
18 | from IPython.extensions.PhysicalQInteractive import PhysicalQuantityInteractive | |
|
19 | 19 | |
|
20 | 20 | # Math constants: |
|
21 | 21 | |
|
22 | 22 | # Pi mathematical constants |
|
23 | 23 | pi = 3.141592653589793238462643383279502884197169399375105820974944592 |
|
24 | 24 | |
|
25 | 25 | # Universal Constants |
|
26 | 26 | #------------------------------------------------------------------------- |
|
27 | 27 | |
|
28 | 28 | c = PhysicalQuantityInteractive(299792458 , 'm/s') |
|
29 | 29 | c.__doc__ = """speed of light in vacuum""" |
|
30 | 30 | c.__doc__ = "speed of light in vacuum" |
|
31 | 31 | |
|
32 | 32 | u_0 = PhysicalQuantityInteractive(4*pi*1E-7 , 'N/(A**2)') |
|
33 | 33 | u_0.__doc__ = """magnetic constant""" |
|
34 | 34 | mu_0 = PhysicalQuantityInteractive(4*pi*1E-7 , 'N/(A**2)') |
|
35 | 35 | |
|
36 | 36 | epsilon_0 = PhysicalQuantityInteractive(8.854187817E-12 , 'F/m') |
|
37 | 37 | epsilon_0.__doc__ = """electric constant """ |
|
38 | 38 | |
|
39 | 39 | Z_0 = PhysicalQuantityInteractive(376.730313461 , 'ohm') |
|
40 | 40 | Z_0.__doc__ = """characteristic impedance of vacuum """ |
|
41 | 41 | |
|
42 | 42 | G = PhysicalQuantityInteractive(6.673E-11 , 'm**3/(kg*s**2)') |
|
43 | 43 | G.__doc__ = """Newtonian constant of gravitation """ |
|
44 | 44 | |
|
45 | 45 | |
|
46 | 46 | h = PhysicalQuantityInteractive(6.62606876E-34 , 'J*s') |
|
47 | 47 | h.__doc__ = """Planck constant """ |
|
48 | 48 | |
|
49 | 49 | |
|
50 | 50 | h_eV = PhysicalQuantityInteractive(4.13566727E-15 , 'eV*s') |
|
51 | 51 | h_eV.__doc__ = """Planck constant in eVs """ |
|
52 | 52 | |
|
53 | 53 | |
|
54 | 54 | h_bar = PhysicalQuantityInteractive(1.054571596E-34 , 'J*s') |
|
55 | 55 | h_bar.__doc__ = """Hbar""" |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | h_bar_eV = PhysicalQuantityInteractive(6.58211889E-16 , 'eV*s') |
|
59 | 59 | h_bar_eV.__doc__ = """Hbar in eV""" |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | P_m = PhysicalQuantityInteractive(2.1767E-8 , 'kg') |
|
63 | 63 | P_m.__doc__ = """Planck mass""" |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | P_l = PhysicalQuantityInteractive(1.6160E-35 , 'm') |
|
67 | 67 | P_l.__doc__ = """Planck length """ |
|
68 | 68 | |
|
69 | 69 | |
|
70 | 70 | P_t = PhysicalQuantityInteractive(5.3906E-44 , 's') |
|
71 | 71 | P_t.__doc__ = """Planck time """ |
|
72 | 72 | |
|
73 | 73 | # Electromagnetic Constants |
|
74 | 74 | #------------------------------------------------------------------------ |
|
75 | 75 | |
|
76 | 76 | _e = PhysicalQuantityInteractive(1.602176462E-19 , 'C') |
|
77 | 77 | _e.__doc__ = """elementary charge""" |
|
78 | 78 | q = _e |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | capitalphi_0 = PhysicalQuantityInteractive(2.067833636E-15 , 'Wb') |
|
82 | 82 | capitalphi_0.__doc__ = """magnetic flux quantum """ |
|
83 | 83 | mfq_0 = PhysicalQuantityInteractive(2.067833636E-15 , 'Wb') |
|
84 | 84 | |
|
85 | 85 | |
|
86 | 86 | G_0 = PhysicalQuantityInteractive(7.748091696E-5 , 'S') |
|
87 | 87 | G_0.__doc__ = """conductance quantum """ |
|
88 | 88 | |
|
89 | 89 | |
|
90 | 90 | K_J = PhysicalQuantityInteractive(483597.898E9 , 'Hz/V') |
|
91 | 91 | K_J.__doc__ = """Josephson constant""" |
|
92 | 92 | |
|
93 | 93 | |
|
94 | 94 | R_K = PhysicalQuantityInteractive(25812.807572 , 'ohm') |
|
95 | 95 | R_K.__doc__ = """von Klitzing constant""" |
|
96 | 96 | |
|
97 | 97 | |
|
98 | 98 | u_B = PhysicalQuantityInteractive(927.400899E-26 , 'J/T') |
|
99 | 99 | u_B.__doc__ = """Bohr magneton""" |
|
100 | 100 | |
|
101 | 101 | ueVT_B = PhysicalQuantityInteractive(5.788381749E-5 , 'eV/T') |
|
102 | 102 | ueVT_B.__doc__ = """Bohr magneton in eV T-1""" |
|
103 | 103 | |
|
104 | 104 | |
|
105 | 105 | u_N = PhysicalQuantityInteractive(5.05078317E-27 , 'J/T') |
|
106 | 106 | u_N.__doc__ = """nuclear magneton """ |
|
107 | 107 | |
|
108 | 108 | ueVT_N = PhysicalQuantityInteractive(3.152451238E-8 , 'eV/T') |
|
109 | 109 | ueVT_N.__doc__ = """nuclear magneton in eV T-1 """ |
|
110 | 110 | |
|
111 | 111 | # Atomic and Nuclear Constants |
|
112 | 112 | # General |
|
113 | 113 | #------------------------------------------------------------------------- |
|
114 | 114 | # fine-structure constant |
|
115 | 115 | alpha = 7.297352533E-3 |
|
116 | 116 | |
|
117 | 117 | |
|
118 | 118 | Ry = PhysicalQuantityInteractive(10973731.568549 , '1/m') |
|
119 | 119 | Ry.__doc__ = """Rydberg constant """ |
|
120 | 120 | Ry_INF = PhysicalQuantityInteractive(10973731.568549 , '1/m') |
|
121 | 121 | |
|
122 | 122 | |
|
123 | 123 | a_0 = PhysicalQuantityInteractive(0.5291772083E-10 , 'm') |
|
124 | 124 | a_0.__doc__ = """Bohr radius """ |
|
125 | 125 | |
|
126 | 126 | |
|
127 | 127 | E_h = PhysicalQuantityInteractive(4.35974381E-18 , 'J') |
|
128 | 128 | E_h.__doc__ = """Hartree energy """ |
|
129 | 129 | |
|
130 | 130 | Eev_h = PhysicalQuantityInteractive(27.2113834 , 'eV') |
|
131 | 131 | Eev_h.__doc__ = """Hartree energy in eV """ |
|
132 | 132 | |
|
133 | 133 | |
|
134 | 134 | qcir2 = PhysicalQuantityInteractive(3.636947516E-4 , 'm**2/s') |
|
135 | 135 | qcir2.__doc__ = """quantum of circulation h/(2me) """ |
|
136 | 136 | |
|
137 | 137 | qcir = PhysicalQuantityInteractive(7.273895032E-4 , 'm**2/s') |
|
138 | 138 | qcir.__doc__ = """quantum of circulation h/(me) """ |
|
139 | 139 | |
|
140 | 140 | # Electroweak |
|
141 | 141 | #------------------------------------------------------------------------- |
|
142 | 142 | |
|
143 | 143 | Fcc = PhysicalQuantityInteractive(1.16639E-5 , '1/GeV**2') |
|
144 | 144 | Fcc.__doc__ = """Fermi coupling constant """ |
|
145 | 145 | # weak mixing angled W (on-shell scheme) |
|
146 | 146 | wma_W = 0.2224 |
|
147 | 147 | |
|
148 | 148 | # Electron, e- |
|
149 | 149 | #------------------------------------------------------------------------- |
|
150 | 150 | |
|
151 | 151 | m_e = PhysicalQuantityInteractive(9.10938188E-31 , 'kg') |
|
152 | 152 | m_e.__doc__ = """electron mass """ |
|
153 | 153 | |
|
154 | 154 | m_e_u = PhysicalQuantityInteractive(5.485799110E-4 , 'amu') |
|
155 | 155 | m_e_u.__doc__ = """electron mass (electron relative atomic mass times amu)""" |
|
156 | 156 | |
|
157 | 157 | me_J = PhysicalQuantityInteractive(8.18710414E-14 , 'J') |
|
158 | 158 | me_J.__doc__ = """electron mass - energy equivalent """ |
|
159 | 159 | |
|
160 | 160 | me_MeV = PhysicalQuantityInteractive(0.510998902 , 'MeV') |
|
161 | 161 | me_MeV.__doc__ = """electron mass - energy equivalent in MeV""" |
|
162 | 162 | |
|
163 | 163 | # electron-muon mass ratio |
|
164 | 164 | memu = 4.83633210E-3 |
|
165 | 165 | |
|
166 | 166 | # electron-tau mass ratio |
|
167 | 167 | metau = 2.87555E-4 |
|
168 | 168 | |
|
169 | 169 | # electron-proton mass ratio |
|
170 | 170 | memp = 5.446170232E-4 |
|
171 | 171 | |
|
172 | 172 | # electron-neutron mass ratio |
|
173 | 173 | memn = 5.438673462E-4 |
|
174 | 174 | |
|
175 | 175 | # electron-deuteron mass ratio |
|
176 | 176 | memd = 2.7244371170E-4 |
|
177 | 177 | |
|
178 | 178 | # electron to alpha particle mass ratio |
|
179 | 179 | memalpha = 1.3709335611E-4 |
|
180 | 180 | |
|
181 | 181 | |
|
182 | 182 | echargeemass = PhysicalQuantityInteractive(-1.758820174E11 , 'C/kg') |
|
183 | 183 | echargeemass.__doc__ = """electron charge to mass quotient """ |
|
184 | 184 | |
|
185 | 185 | |
|
186 | 186 | Molar_e = PhysicalQuantityInteractive(5.485799110E-7 , 'kg/mol') |
|
187 | 187 | Molar_e.__doc__ = """electron molar mass """ |
|
188 | 188 | |
|
189 | 189 | |
|
190 | 190 | lambdaC = PhysicalQuantityInteractive(2.426310215E-12 , 'm') |
|
191 | 191 | lambdaC.__doc__ = """Compton wavelength """ |
|
192 | 192 | |
|
193 | 193 | |
|
194 | 194 | r_e = PhysicalQuantityInteractive(2.817940285E-15 , 'm') |
|
195 | 195 | r_e.__doc__ = """classical electron radius """ |
|
196 | 196 | |
|
197 | 197 | |
|
198 | 198 | sigma_e = PhysicalQuantityInteractive(0.665245854E-28 , 'm**2') |
|
199 | 199 | sigma_e.__doc__ = """Thomson cross section """ |
|
200 | 200 | |
|
201 | 201 | |
|
202 | 202 | u_e = PhysicalQuantityInteractive(-928.476362E-26 , 'J/T') |
|
203 | 203 | u_e.__doc__ = """electron magnetic moment """ |
|
204 | 204 | |
|
205 | 205 | # electron magnetic moment to Bohr magneton ratio |
|
206 | 206 | ueuB = -1.0011596521869 |
|
207 | 207 | |
|
208 | 208 | # electron magnetic moment to nuclear magneton ratio |
|
209 | 209 | ueuN = -1838.2819660 |
|
210 | 210 | |
|
211 | 211 | # electron magnetic moment anomaly |ue|/uB - 1 |
|
212 | 212 | a_e = 1.1596521869E-3 |
|
213 | 213 | |
|
214 | 214 | # electron g-factor |
|
215 | 215 | g_e = -2.0023193043737 |
|
216 | 216 | |
|
217 | 217 | # electron-muon magnetic moment ratio |
|
218 | 218 | ueuu = 206.7669720 |
|
219 | 219 | |
|
220 | 220 | # electron-proton magnetic moment ratio |
|
221 | 221 | ueup = -658.2106875 |
|
222 | 222 | |
|
223 | 223 | # electron to shielded proton magnetic moment ratio (H2O, sphere, 25 C) |
|
224 | 224 | ueusp = -658.2275954 |
|
225 | 225 | |
|
226 | 226 | # electron-neutron magnetic moment ratio |
|
227 | 227 | ueun = 960.92050 |
|
228 | 228 | |
|
229 | 229 | # electron-deuteron magnetic moment ratio |
|
230 | 230 | ueud = -2143.923498 |
|
231 | 231 | |
|
232 | 232 | # electron to shielded helione magnetic moment ratio (gas, sphere, 25 C) |
|
233 | 233 | ueush = 864.058255 |
|
234 | 234 | |
|
235 | 235 | |
|
236 | 236 | gamma_e = PhysicalQuantityInteractive(1.760859794E11 , '1/(s*T)') |
|
237 | 237 | gamma_e.__doc__ = """electron gyromagnetic ratio """ |
|
238 | 238 | |
|
239 | 239 | # Muon, u- |
|
240 | 240 | #------------------------------------------------------------------------- |
|
241 | 241 | |
|
242 | 242 | m_u = PhysicalQuantityInteractive(1.88353109E-28 , 'kg') |
|
243 | 243 | m_u.__doc__ = """muon mass """ |
|
244 | 244 | |
|
245 | 245 | mu_u = PhysicalQuantityInteractive(0.1134289168 , 'amu') |
|
246 | 246 | mu_u.__doc__ = """muon mass in muon relative atomic mass times amu """ |
|
247 | 247 | |
|
248 | 248 | |
|
249 | 249 | muc2_J = PhysicalQuantityInteractive(1.69283332E-11 , 'J') |
|
250 | 250 | muc2_J.__doc__ = """energy equivalent """ |
|
251 | 251 | |
|
252 | 252 | muc2_MeV = PhysicalQuantityInteractive(105.6583568 , 'MeV') |
|
253 | 253 | muc2_MeV.__doc__ = """energy equivalent in MeV """ |
|
254 | 254 | |
|
255 | 255 | # muon-electron mass ratio |
|
256 | 256 | mume = 206.7682657 |
|
257 | 257 | |
|
258 | 258 | # muon-tau mass ratio |
|
259 | 259 | mum = 5.94572E-2 |
|
260 | 260 | |
|
261 | 261 | # muon-proton mass ratio |
|
262 | 262 | mump = 0.1126095173 |
|
263 | 263 | |
|
264 | 264 | # muon-neutron mass ratio |
|
265 | 265 | mumn = 0.1124545079 |
|
266 | 266 | |
|
267 | 267 | |
|
268 | 268 | Molar_u = PhysicalQuantityInteractive(0.1134289168E-3 , 'kg/mol') |
|
269 | 269 | Molar_u.__doc__ = """muon molar mass """ |
|
270 | 270 | |
|
271 | 271 | |
|
272 | 272 | lambda_C_u = PhysicalQuantityInteractive(11.73444197E-15 , 'm') |
|
273 | 273 | lambda_C_u.__doc__ = """muon Compton wavelength """ |
|
274 | 274 | |
|
275 | 275 | |
|
276 | 276 | uu = PhysicalQuantityInteractive(-4.49044813E-26 , 'J/T') |
|
277 | 277 | uu.__doc__ = """muon magnetic moment """ |
|
278 | 278 | |
|
279 | 279 | # ratio of muon magnetic moment to Bohr magneton ratio |
|
280 | 280 | uuuB = -4.84197085E-3 |
|
281 | 281 | |
|
282 | 282 | # ratio of muon magnetic moment to nuclear magneton ratio |
|
283 | 283 | uuuN = -8.89059770 |
|
284 | 284 | |
|
285 | 285 | # muon magnetic moment anomaly |uu|/(e /2mu) - 1 |
|
286 | 286 | a_u = 1.16591602E-3 |
|
287 | 287 | |
|
288 | 288 | # muon g-factor -2(1 + au) |
|
289 | 289 | g_u = -2.0023318320 |
|
290 | 290 | |
|
291 | 291 | # muon-proton magnetic moment ratio |
|
292 | 292 | uuup = -3.18334539 |
|
293 | 293 | |
|
294 | 294 | # Tau, tau- |
|
295 | 295 | #------------------------------------------------------------------------- |
|
296 | 296 | |
|
297 | 297 | m_tau = PhysicalQuantityInteractive(3.16788E-27 , 'kg') |
|
298 | 298 | m_tau.__doc__ = """tau mass """ |
|
299 | 299 | |
|
300 | 300 | mu_tau = PhysicalQuantityInteractive(1.90774 , 'amu') |
|
301 | 301 | mu_tau.__doc__ = """tau mass (tau relative atomic mass times amu) """ |
|
302 | 302 | |
|
303 | 303 | |
|
304 | 304 | mtauc2_J = PhysicalQuantityInteractive(2.84715E-10 , 'J') |
|
305 | 305 | mtauc2_J.__doc__ = """tau mass energy equivalent """ |
|
306 | 306 | |
|
307 | 307 | |
|
308 | 308 | mtauc2_MeV = PhysicalQuantityInteractive(1777.05 , 'MeV') |
|
309 | 309 | mtauc2_MeV.__doc__ = """tau mass energy equivalent in MeV """ |
|
310 | 310 | |
|
311 | 311 | # tau-electron mass ratio |
|
312 | 312 | mtaume = 3477.60 |
|
313 | 313 | |
|
314 | 314 | # tau-muon mass ratio |
|
315 | 315 | mtaumu = 16.8188 |
|
316 | 316 | |
|
317 | 317 | # tau-proton mass ratio |
|
318 | 318 | mtaump = 1.89396 |
|
319 | 319 | |
|
320 | 320 | # tau-neutron mass ratio |
|
321 | 321 | mtaumn = 1.89135 |
|
322 | 322 | |
|
323 | 323 | |
|
324 | 324 | Molar_tau = PhysicalQuantityInteractive(1.90774E-3 , 'kg/mol') |
|
325 | 325 | Molar_tau.__doc__ = """tau molar mass """ |
|
326 | 326 | |
|
327 | 327 | |
|
328 | 328 | lambda_C_tau = PhysicalQuantityInteractive(0.69770E-15 , 'm') |
|
329 | 329 | lambda_C_tau.__doc__ = """tau Compton wavelength """ |
|
330 | 330 | |
|
331 | 331 | # Proton, p |
|
332 | 332 | #------------------------------------------------------------------------- |
|
333 | 333 | |
|
334 | 334 | m_p = PhysicalQuantityInteractive(1.67262158E-27 , 'kg') |
|
335 | 335 | m_p.__doc__ = """proton mass """ |
|
336 | 336 | |
|
337 | 337 | mu_p = PhysicalQuantityInteractive(1.00727646688 , 'amu') |
|
338 | 338 | mu_p.__doc__ = """proton mass (proton relative atomic mass times amu) """ |
|
339 | 339 | |
|
340 | 340 | |
|
341 | 341 | mpc2_J = PhysicalQuantityInteractive(1.50327731E-10 , 'J') |
|
342 | 342 | mpc2_J.__doc__ = """energy equivalent """ |
|
343 | 343 | |
|
344 | 344 | mpc2_MeV = PhysicalQuantityInteractive(938.271998 , 'MeV') |
|
345 | 345 | mpc2_MeV.__doc__ = """energy equivalent in MeV """ |
|
346 | 346 | |
|
347 | 347 | # proton-electron mass ratio |
|
348 | 348 | mpme = 1836.1526675 |
|
349 | 349 | |
|
350 | 350 | # proton-muon mass ratio |
|
351 | 351 | mpmu = 8.88024408 |
|
352 | 352 | |
|
353 | 353 | # proton-tau mass ratio |
|
354 | 354 | mpmtau = 0.527994 |
|
355 | 355 | |
|
356 | 356 | # proton-neutron mass ratio |
|
357 | 357 | mpmn = 0.99862347855 |
|
358 | 358 | |
|
359 | 359 | |
|
360 | 360 | emp = PhysicalQuantityInteractive(9.57883408E7 , 'C/kg') |
|
361 | 361 | emp.__doc__ = """proton charge to mass quotient """ |
|
362 | 362 | |
|
363 | 363 | |
|
364 | 364 | Molar_p = PhysicalQuantityInteractive(1.00727646688E-3 , 'kg/mol') |
|
365 | 365 | Molar_p.__doc__ = """proton molar mass """ |
|
366 | 366 | |
|
367 | 367 | |
|
368 | 368 | lambda_C_p = PhysicalQuantityInteractive(1.321409847E-15 , 'm') |
|
369 | 369 | lambda_C_p.__doc__ = """proton Compton wavelength h/mpc """ |
|
370 | 370 | |
|
371 | 371 | |
|
372 | 372 | up = PhysicalQuantityInteractive(1.410606633E-26 , 'J/T') |
|
373 | 373 | up.__doc__ = """proton magnetic moment """ |
|
374 | 374 | |
|
375 | 375 | # proton magnetic moment to Bohr magneton ratio |
|
376 | 376 | upuB = 1.521032203E-3 |
|
377 | 377 | |
|
378 | 378 | # proton magnetic moment to nuclear magneton ratio |
|
379 | 379 | upuN = 2.792847337 |
|
380 | 380 | |
|
381 | 381 | # proton g-factor 2up/uN |
|
382 | 382 | g_p = 5.585694675 |
|
383 | 383 | |
|
384 | 384 | # proton-neutron magnetic moment ratio |
|
385 | 385 | upun = -1.45989805 |
|
386 | 386 | |
|
387 | 387 | |
|
388 | 388 | usp = PhysicalQuantityInteractive(1.410570399E-26 , 'J/T') |
|
389 | 389 | usp.__doc__ = """shielded proton magnetic moment (H2O, sphere, 25 C)""" |
|
390 | 390 | |
|
391 | 391 | # shielded proton magnetic moment to Bohr magneton ratio |
|
392 | 392 | uspuB = 1.520993132E-3 |
|
393 | 393 | |
|
394 | 394 | # shielded proton magnetic moment to nuclear magneton ratio |
|
395 | 395 | uspuN = 2.792775597 |
|
396 | 396 | |
|
397 | 397 | # proton magnetic shielding correction 1 - u p/up (H2O, sphere, 25 C) |
|
398 | 398 | spc = 25.687E-6 |
|
399 | 399 | |
|
400 | 400 | |
|
401 | 401 | gamma_p = PhysicalQuantityInteractive(2.67522212E8 , '1/(s*T)') |
|
402 | 402 | gamma_p.__doc__ = """proton gyromagnetic ratio """ |
|
403 | 403 | |
|
404 | 404 | |
|
405 | 405 | gamma_sp = PhysicalQuantityInteractive(2.67515341E8 , '1/(s*T)') |
|
406 | 406 | gamma_sp.__doc__ = """shielded proton gyromagnetic ratio (H2O, sphere, 25 C)""" |
|
407 | 407 | |
|
408 | 408 | # Neutron, n |
|
409 | 409 | #------------------------------------------------------------------------- |
|
410 | 410 | |
|
411 | 411 | m_n = PhysicalQuantityInteractive(1.67492716E-27 , 'kg') |
|
412 | 412 | m_n.__doc__ = """neutron mass """ |
|
413 | 413 | |
|
414 | 414 | mu_n = PhysicalQuantityInteractive(1.00866491578 , 'amu') |
|
415 | 415 | mu_n.__doc__ = """neutron mass (neutron relative atomic mass times amu) """ |
|
416 | 416 | |
|
417 | 417 | |
|
418 | 418 | mnc2_J = PhysicalQuantityInteractive(1.50534946E-10 , 'J') |
|
419 | 419 | mnc2_J.__doc__ = """neutron mass energy equivalent """ |
|
420 | 420 | |
|
421 | 421 | |
|
422 | 422 | mnc2_MeV = PhysicalQuantityInteractive(939.565330 , 'MeV') |
|
423 | 423 | mnc2_MeV.__doc__ = """neutron mass energy equivalent in MeV """ |
|
424 | 424 | |
|
425 | 425 | # neutron-electron mass ratio |
|
426 | 426 | mnme = 1838.6836550 |
|
427 | 427 | |
|
428 | 428 | # neutron-muon mass ratio |
|
429 | 429 | mnmu = 8.89248478 |
|
430 | 430 | |
|
431 | 431 | # neutron-tau mass ratio |
|
432 | 432 | mnm = 0.528722 |
|
433 | 433 | |
|
434 | 434 | # neutron-proton mass ratio |
|
435 | 435 | mnmp = 1.00137841887 |
|
436 | 436 | |
|
437 | 437 | |
|
438 | 438 | Molar_n = PhysicalQuantityInteractive(1.00866491578E-3 , 'kg/mol') |
|
439 | 439 | Molar_n.__doc__ = """neutron molar mass """ |
|
440 | 440 | |
|
441 | 441 | |
|
442 | 442 | lambda_C_n = PhysicalQuantityInteractive(1.319590898E-15 , 'm') |
|
443 | 443 | lambda_C_n.__doc__ = """neutron Compton wavelength""" |
|
444 | 444 | |
|
445 | 445 | |
|
446 | 446 | un = PhysicalQuantityInteractive(-0.96623640E-26 , 'J/T') |
|
447 | 447 | un.__doc__ = """neutron magnetic moment """ |
|
448 | 448 | |
|
449 | 449 | # neutron magnetic moment to Bohr magneton ratio |
|
450 | 450 | unuB = -1.04187563E-3 |
|
451 | 451 | |
|
452 | 452 | # neutron magnetic moment to nuclear magneton ratio |
|
453 | 453 | unuN = -1.91304272 |
|
454 | 454 | |
|
455 | 455 | # neutron g-factor |
|
456 | 456 | g_n = -3.82608545 |
|
457 | 457 | |
|
458 | 458 | # neutron-electron magnetic moment ratio |
|
459 | 459 | unue = 1.04066882E-3 |
|
460 | 460 | |
|
461 | 461 | # neutron-proton magnetic moment ratio |
|
462 | 462 | unup = -0.68497934 |
|
463 | 463 | |
|
464 | 464 | # neutron to shielded proton magnetic moment ratio (H2O, sphere, 25 C) |
|
465 | 465 | unusp = -0.68499694 |
|
466 | 466 | |
|
467 | 467 | |
|
468 | 468 | gamma_n = PhysicalQuantityInteractive(1.83247188E8 , '1/(s*T)') |
|
469 | 469 | gamma_n.__doc__ = """neutron gyromagnetic ratio """ |
|
470 | 470 | |
|
471 | 471 | # Deuteron, d |
|
472 | 472 | #------------------------------------------------------------------------- |
|
473 | 473 | |
|
474 | 474 | m_d = PhysicalQuantityInteractive(3.34358309E-27 , 'kg') |
|
475 | 475 | m_d.__doc__ = """deuteron mass """ |
|
476 | 476 | |
|
477 | 477 | |
|
478 | 478 | mu_d = PhysicalQuantityInteractive(2.01355321271 , 'amu') |
|
479 | 479 | mu_d.__doc__ = """deuteron mass (deuteron relative atomic mass times amu) """ |
|
480 | 480 | |
|
481 | 481 | |
|
482 | 482 | mdc2_J = PhysicalQuantityInteractive(3.00506262E-10 , 'J') |
|
483 | 483 | mdc2_J.__doc__ = """deuteron mass energy equivalent """ |
|
484 | 484 | |
|
485 | 485 | |
|
486 | 486 | mdc2_eV = PhysicalQuantityInteractive(1875.612762 , 'MeV') |
|
487 | 487 | mdc2_eV.__doc__ = """deuteron mass energy equivalent in MeV """ |
|
488 | 488 | |
|
489 | 489 | # deuteron-electron mass ratio |
|
490 | 490 | mdme = 3670.4829550 |
|
491 | 491 | |
|
492 | 492 | # deuteron-proton mass ratio |
|
493 | 493 | mdmp = 1.99900750083 |
|
494 | 494 | |
|
495 | 495 | |
|
496 | 496 | Molar_d = PhysicalQuantityInteractive(2.01355321271E-3 , 'kg/mol') |
|
497 | 497 | Molar_d.__doc__ = """deuteron molar mass """ |
|
498 | 498 | |
|
499 | 499 | |
|
500 | 500 | ud = PhysicalQuantityInteractive(0.433073457E-26 , 'J/T') |
|
501 | 501 | ud.__doc__ = """deuteron magnetic moment """ |
|
502 | 502 | |
|
503 | 503 | # deuteron magnetic moment to Bohr magneton ratio |
|
504 | 504 | uduB = 0.4669754556E-3 |
|
505 | 505 | |
|
506 | 506 | # deuteron magnetic moment to nuclear magneton ratio |
|
507 | 507 | uduN = 0.8574382284 |
|
508 | 508 | |
|
509 | 509 | # deuteron-electron magnetic moment ratio |
|
510 | 510 | udue = -4.664345537E-4 |
|
511 | 511 | |
|
512 | 512 | # deuteron-proton magnetic moment ratio |
|
513 | 513 | udup = 0.3070122083 |
|
514 | 514 | |
|
515 | 515 | # deuteron-neutron magnetic moment ratio |
|
516 | 516 | udun = -0.44820652 |
|
517 | 517 | |
|
518 | 518 | # Helion, h |
|
519 | 519 | #------------------------------------------------------------------------- |
|
520 | 520 | |
|
521 | 521 | m_h = PhysicalQuantityInteractive(5.00641174E-27 , 'kg') |
|
522 | 522 | m_h.__doc__ = """helion mass """ |
|
523 | 523 | |
|
524 | 524 | |
|
525 | 525 | mu_h = PhysicalQuantityInteractive(3.01493223469 , 'amu') |
|
526 | 526 | mu_h.__doc__ = """helion mass (helion relative atomic mass times amu) """ |
|
527 | 527 | |
|
528 | 528 | |
|
529 | 529 | mhc2_J = PhysicalQuantityInteractive(4.49953848E-10 , 'J') |
|
530 | 530 | mhc2_J.__doc__ = """helion mass energy equivalent """ |
|
531 | 531 | |
|
532 | 532 | mhc2_MeV = PhysicalQuantityInteractive(2808.39132 , 'MeV') |
|
533 | 533 | mhc2_MeV.__doc__ = """helion mass energy equivalent in MeV """ |
|
534 | 534 | |
|
535 | 535 | # helion-electron mass ratio |
|
536 | 536 | mhme = 5495.885238 |
|
537 | 537 | |
|
538 | 538 | # helion-proton mass ratio |
|
539 | 539 | mhmp = 2.99315265850 |
|
540 | 540 | |
|
541 | 541 | |
|
542 | 542 | Molar_h = PhysicalQuantityInteractive(3.01493223469E-3 , 'kg/mol') |
|
543 | 543 | Molar_h.__doc__ = """helion molar mass """ |
|
544 | 544 | |
|
545 | 545 | |
|
546 | 546 | ush = PhysicalQuantityInteractive(-1.074552967E-26 , 'J/T') |
|
547 | 547 | ush.__doc__ = """shielded helion magnetic moment (gas, sphere, 25 C)""" |
|
548 | 548 | |
|
549 | 549 | # shielded helion magnetic moment to Bohr magneton ratio |
|
550 | 550 | ushuB = -1.158671474E-3 |
|
551 | 551 | |
|
552 | 552 | # shielded helion magnetic moment to nuclear magneton ratio |
|
553 | 553 | ushuN = -2.127497718 |
|
554 | 554 | |
|
555 | 555 | # shielded helion to proton magnetic moment ratio (gas, sphere, 25 C) |
|
556 | 556 | ushup = -0.761766563 |
|
557 | 557 | |
|
558 | 558 | # shielded helion to shielded proton magnetic moment ratio (gas/H2O, spheres, 25 C) |
|
559 | 559 | ushusp = -0.7617861313 |
|
560 | 560 | |
|
561 | 561 | |
|
562 | 562 | gamma_h = PhysicalQuantityInteractive(2.037894764E8 , '1/(s*T)') |
|
563 | 563 | gamma_h.__doc__ = """shielded helion gyromagnetic (gas, sphere, 25 C) """ |
|
564 | 564 | |
|
565 | 565 | # Alpha particle, |
|
566 | 566 | #------------------------------------------------------------------------- |
|
567 | 567 | |
|
568 | 568 | m_alpha = PhysicalQuantityInteractive(6.64465598E-27 , 'kg') |
|
569 | 569 | m_alpha.__doc__ = """alpha particle mass """ |
|
570 | 570 | |
|
571 | 571 | mu_alpha = PhysicalQuantityInteractive(4.0015061747 , 'amu') |
|
572 | 572 | mu_alpha.__doc__ = """alpha particle mass (alpha particle relative atomic mass times amu) """ |
|
573 | 573 | |
|
574 | 574 | |
|
575 | 575 | malphac2_J = PhysicalQuantityInteractive(5.97191897E-10 , 'J') |
|
576 | 576 | malphac2_J.__doc__ = """alpha particle mass energy equivalent """ |
|
577 | 577 | |
|
578 | 578 | |
|
579 | 579 | malphac2_MeV = PhysicalQuantityInteractive(3727.37904 , 'MeV') |
|
580 | 580 | malphac2_MeV.__doc__ = """alpha particle mass energy equivalent in MeV """ |
|
581 | 581 | |
|
582 | 582 | # alpha particle to electron mass ratio |
|
583 | 583 | malphame = 7294.299508 |
|
584 | 584 | |
|
585 | 585 | # alpha particle to proton mass ratio |
|
586 | 586 | malphamp = 3.9725996846 |
|
587 | 587 | |
|
588 | 588 | |
|
589 | 589 | Molar_alpha = PhysicalQuantityInteractive(4.0015061747E-3 , 'kg/mol') |
|
590 | 590 | Molar_alpha.__doc__ = """alpha particle molar mass""" |
|
591 | 591 | |
|
592 | 592 | # PHYSICO-CHEMICAL |
|
593 | 593 | #------------------------------------------------------------------------- |
|
594 | 594 | |
|
595 | 595 | N_A = PhysicalQuantityInteractive(6.02214199E23 , '1/mol') |
|
596 | 596 | N_A.__doc__ = """Avogadro constant """ |
|
597 | 597 | L = PhysicalQuantityInteractive(6.02214199E23 , '1/mol') |
|
598 | 598 | |
|
599 | 599 | |
|
600 | 600 | m_u = PhysicalQuantityInteractive(1.66053873E-27 , 'kg') |
|
601 | 601 | m_u.__doc__ = """atomic mass constant mu = 112m(12C) = 1 u = 10E-3 kg mol-1/NA""" |
|
602 | 602 | # atomic mass constant mu = 112m(12C) = 1 u = 10E-3 kg mol-1/NA |
|
603 | 603 | amu = m_u |
|
604 | 604 | |
|
605 | 605 | |
|
606 | 606 | muc2_J = PhysicalQuantityInteractive(1.49241778E-10 , 'J') |
|
607 | 607 | muc2_J.__doc__ = """energy equivalent of the atomic mass constant""" |
|
608 | 608 | |
|
609 | 609 | |
|
610 | 610 | muc2_MeV = PhysicalQuantityInteractive(931.494013 , 'MeV') |
|
611 | 611 | muc2_MeV.__doc__ = """energy equivalent of the atomic mass constant in MeV """ |
|
612 | 612 | |
|
613 | 613 | |
|
614 | 614 | F = PhysicalQuantityInteractive(96485.3415 , 'C/mol') |
|
615 | 615 | F.__doc__ = """Faraday constant""" |
|
616 | 616 | |
|
617 | 617 | |
|
618 | 618 | N_Ah = PhysicalQuantityInteractive(3.990312689E-10 , 'J*s/mol') |
|
619 | 619 | N_Ah.__doc__ = """molar Planck constant """ |
|
620 | 620 | |
|
621 | 621 | |
|
622 | 622 | R = PhysicalQuantityInteractive(8.314472 , 'J/(mol*K)') |
|
623 | 623 | R.__doc__ = """molar gas constant """ |
|
624 | 624 | |
|
625 | 625 | |
|
626 | 626 | k_J = PhysicalQuantityInteractive(1.3806503E-23 , 'J/K') |
|
627 | 627 | k_J.__doc__ = """Boltzmann constant """ |
|
628 | 628 | |
|
629 | 629 | |
|
630 | 630 | k_eV = PhysicalQuantityInteractive(8.617342E-5 , 'eV/K') |
|
631 | 631 | k_eV.__doc__ = """Boltzmann constant in eV """ |
|
632 | 632 | |
|
633 | 633 | |
|
634 | 634 | n_0 = PhysicalQuantityInteractive(2.6867775E25 , '1/m**3') |
|
635 | 635 | n_0.__doc__ = """Loschmidt constant NA/Vm """ |
|
636 | 636 | |
|
637 | 637 | |
|
638 | 638 | Vm_1 = PhysicalQuantityInteractive(22.413996E-3 , 'm**3/mol') |
|
639 | 639 | Vm_1.__doc__ = """molar volume of ideal gas RT/p T = 273.15 K, p = 101.325 kPa """ |
|
640 | 640 | |
|
641 | 641 | Vm_2 = PhysicalQuantityInteractive(22.710981E-3 , 'm**3/mol') |
|
642 | 642 | Vm_2.__doc__ = """molar volume of ideal gas RT/p T = 273.15 K, p = 100 kPa """ |
|
643 | 643 | |
|
644 | 644 | # Sackur-Tetrode constant (absolute entropy constant) 52 + ln_(2 mukT1/h2)3/2kT1/p0 |
|
645 | 645 | # T1 = 1 K, p0 = 100 kPa |
|
646 | 646 | S_0R_1 = -1.1517048 |
|
647 | 647 | # T1 = 1 K, p0 = 101.325 kPa |
|
648 | 648 | S_0R_2 = -1.1648678 |
|
649 | 649 | |
|
650 | 650 | |
|
651 | 651 | sigma = PhysicalQuantityInteractive(5.670400E-8 , 'W/(m**2*K**4)') |
|
652 | 652 | sigma.__doc__ = """Stefan-Boltzmann constant """ |
|
653 | 653 | |
|
654 | 654 | |
|
655 | 655 | c_1 = PhysicalQuantityInteractive(3.74177107E-16 , 'W*m**2') |
|
656 | 656 | c_1.__doc__ = """first radiation constant""" |
|
657 | 657 | |
|
658 | 658 | |
|
659 | 659 | c_1L = PhysicalQuantityInteractive(1.191042722E-16 , 'W*m**2/sr') |
|
660 | 660 | c_1L.__doc__ = """first radiation constant for spectral radiance""" |
|
661 | 661 | |
|
662 | 662 | |
|
663 | 663 | c_2 = PhysicalQuantityInteractive(1.4387752E-2 , 'm*K') |
|
664 | 664 | c_2.__doc__ = """second radiation constant""" |
|
665 | 665 | |
|
666 | 666 | |
|
667 | 667 | b = PhysicalQuantityInteractive(2.8977686E-3 , 'm*K') |
|
668 | 668 | b.__doc__ = """Wien displacement law constant b = maxT = c2/4.965 114231... """ |
|
669 | 669 |
@@ -1,132 +1,132 b'' | |||
|
1 | 1 | """ Use pretty.py for configurable pretty-printing. |
|
2 | 2 | |
|
3 | 3 | Register pretty-printers for types using ipy_pretty.for_type() or |
|
4 | 4 | ipy_pretty.for_type_by_name(). For example, to use the example pretty-printer |
|
5 | 5 | for numpy dtype objects, add the following to your ipy_user_conf.py:: |
|
6 | 6 | |
|
7 |
from IPython. |
|
|
7 | from IPython.extensions import ipy_pretty | |
|
8 | 8 | |
|
9 | 9 | ipy_pretty.activate() |
|
10 | 10 | |
|
11 | 11 | # If you want to have numpy always imported anyways: |
|
12 | 12 | import numpy |
|
13 | 13 | ipy_pretty.for_type(numpy.dtype, ipy_pretty.dtype_pprinter) |
|
14 | 14 | |
|
15 | 15 | # If you don't want to have numpy imported until it needs to be: |
|
16 | 16 | ipy_pretty.for_type_by_name('numpy', 'dtype', ipy_pretty.dtype_pprinter) |
|
17 | 17 | """ |
|
18 | 18 | |
|
19 | 19 | from IPython.core import ipapi |
|
20 | 20 | from IPython.utils.genutils import Term |
|
21 | 21 | |
|
22 | 22 | from IPython.external import pretty |
|
23 | 23 | |
|
24 | 24 | ip = ipapi.get() |
|
25 | 25 | |
|
26 | 26 | |
|
27 | 27 | #### Implementation ############################################################ |
|
28 | 28 | |
|
29 | 29 | def pretty_result_display(self, arg): |
|
30 | 30 | """ Uber-pretty-printing display hook. |
|
31 | 31 | |
|
32 | 32 | Called for displaying the result to the user. |
|
33 | 33 | """ |
|
34 | 34 | |
|
35 | 35 | if ip.options.pprint: |
|
36 | 36 | verbose = getattr(ip.options, 'pretty_verbose', False) |
|
37 | 37 | out = pretty.pretty(arg, verbose=verbose) |
|
38 | 38 | if '\n' in out: |
|
39 | 39 | # So that multi-line strings line up with the left column of |
|
40 | 40 | # the screen, instead of having the output prompt mess up |
|
41 | 41 | # their first line. |
|
42 | 42 | Term.cout.write('\n') |
|
43 | 43 | print >>Term.cout, out |
|
44 | 44 | else: |
|
45 | 45 | raise TryNext |
|
46 | 46 | |
|
47 | 47 | |
|
48 | 48 | #### API ####################################################################### |
|
49 | 49 | |
|
50 | 50 | # Expose the for_type and for_type_by_name functions for easier use. |
|
51 | 51 | for_type = pretty.for_type |
|
52 | 52 | for_type_by_name = pretty.for_type_by_name |
|
53 | 53 | |
|
54 | 54 | |
|
55 | 55 | # FIXME: write deactivate(). We need a way to remove a hook. |
|
56 | 56 | def activate(): |
|
57 | 57 | """ Activate this extension. |
|
58 | 58 | """ |
|
59 | 59 | ip.set_hook('result_display', pretty_result_display, priority=99) |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | #### Example pretty-printers ################################################### |
|
63 | 63 | |
|
64 | 64 | def dtype_pprinter(obj, p, cycle): |
|
65 | 65 | """ A pretty-printer for numpy dtype objects. |
|
66 | 66 | """ |
|
67 | 67 | if cycle: |
|
68 | 68 | return p.text('dtype(...)') |
|
69 | 69 | if obj.fields is None: |
|
70 | 70 | p.text(repr(obj)) |
|
71 | 71 | else: |
|
72 | 72 | p.begin_group(7, 'dtype([') |
|
73 | 73 | for i, field in enumerate(obj.descr): |
|
74 | 74 | if i > 0: |
|
75 | 75 | p.text(',') |
|
76 | 76 | p.breakable() |
|
77 | 77 | p.pretty(field) |
|
78 | 78 | p.end_group(7, '])') |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | #### Tests ##################################################################### |
|
82 | 82 | |
|
83 | 83 | def test_pretty(): |
|
84 | 84 | """ |
|
85 |
In [1]: from IPython. |
|
|
85 | In [1]: from IPython.extensions import ipy_pretty | |
|
86 | 86 | |
|
87 | 87 | In [2]: ipy_pretty.activate() |
|
88 | 88 | |
|
89 | 89 | In [3]: class A(object): |
|
90 | 90 | ...: def __repr__(self): |
|
91 | 91 | ...: return 'A()' |
|
92 | 92 | ...: |
|
93 | 93 | ...: |
|
94 | 94 | |
|
95 | 95 | In [4]: a = A() |
|
96 | 96 | |
|
97 | 97 | In [5]: a |
|
98 | 98 | Out[5]: A() |
|
99 | 99 | |
|
100 | 100 | In [6]: def a_pretty_printer(obj, p, cycle): |
|
101 | 101 | ...: p.text('<A>') |
|
102 | 102 | ...: |
|
103 | 103 | ...: |
|
104 | 104 | |
|
105 | 105 | In [7]: ipy_pretty.for_type(A, a_pretty_printer) |
|
106 | 106 | |
|
107 | 107 | In [8]: a |
|
108 | 108 | Out[8]: <A> |
|
109 | 109 | |
|
110 | 110 | In [9]: class B(object): |
|
111 | 111 | ...: def __repr__(self): |
|
112 | 112 | ...: return 'B()' |
|
113 | 113 | ...: |
|
114 | 114 | ...: |
|
115 | 115 | |
|
116 | 116 | In [10]: B.__module__, B.__name__ |
|
117 | 117 | Out[10]: ('__main__', 'B') |
|
118 | 118 | |
|
119 | 119 | In [11]: def b_pretty_printer(obj, p, cycle): |
|
120 | 120 | ....: p.text('<B>') |
|
121 | 121 | ....: |
|
122 | 122 | ....: |
|
123 | 123 | |
|
124 | 124 | In [12]: ipy_pretty.for_type_by_name('__main__', 'B', b_pretty_printer) |
|
125 | 125 | |
|
126 | 126 | In [13]: b = B() |
|
127 | 127 | |
|
128 | 128 | In [14]: b |
|
129 | 129 | Out[14]: <B> |
|
130 | 130 | """ |
|
131 | 131 | assert False, "This should only be doctested, not run." |
|
132 | 132 |
@@ -1,46 +1,46 b'' | |||
|
1 | 1 | """Config file for 'doctest' profile. |
|
2 | 2 | |
|
3 | 3 | This profile modifies the prompts to be the standard Python ones, so that you |
|
4 | 4 | can generate easily doctests from an IPython session. |
|
5 | 5 | |
|
6 | 6 | But more importantly, it enables pasting of code with '>>>' prompts and |
|
7 | 7 | arbitrary initial whitespace, as is typical of doctests in reST files and |
|
8 | 8 | docstrings. This allows you to easily re-run existing doctests and iteratively |
|
9 | 9 | work on them as part of your development workflow. |
|
10 | 10 | |
|
11 | 11 | The exception mode is also set to 'plain' so the generated exceptions are as |
|
12 | 12 | similar as possible to the default Python ones, for inclusion in doctests.""" |
|
13 | 13 | |
|
14 | 14 | # get various stuff that are there for historical / familiarity reasons |
|
15 | 15 | import ipy_legacy |
|
16 | 16 | |
|
17 | 17 | from IPython.core import ipapi |
|
18 | 18 | |
|
19 |
from IPython. |
|
|
19 | from IPython.extensions import InterpreterPasteInput | |
|
20 | 20 | |
|
21 | 21 | def main(): |
|
22 | 22 | ip = ipapi.get() |
|
23 | 23 | o = ip.options |
|
24 | 24 | |
|
25 | 25 | # Set the prompts similar to the defaults |
|
26 | 26 | o.prompt_in1 = '>>> ' |
|
27 | 27 | o.prompt_in2 = '... ' |
|
28 | 28 | o.prompt_out = '' |
|
29 | 29 | |
|
30 | 30 | # Add a blank line before each new set of inputs. This is needed by |
|
31 | 31 | # doctest to distinguish each test from the next. |
|
32 | 32 | o.separate_in = '\n' |
|
33 | 33 | o.separate_out = '' |
|
34 | 34 | o.separate_out2 = '' |
|
35 | 35 | |
|
36 | 36 | # Disable pprint, so that outputs are printed as similarly to standard |
|
37 | 37 | # python as possible |
|
38 | 38 | o.pprint = False |
|
39 | 39 | |
|
40 | 40 | # Use plain exceptions, to also resemble normal pyhton. |
|
41 | 41 | o.xmode = 'plain' |
|
42 | 42 | |
|
43 | 43 | # Store the activity flag in the metadata bag from the running shell |
|
44 | 44 | ip.IP.meta.doctest_mode = True |
|
45 | 45 | |
|
46 | 46 | main() |
@@ -1,17 +1,17 b'' | |||
|
1 | 1 | """ Install various IPython completers |
|
2 | 2 | |
|
3 | 3 | IPython extension that installs completers related to core ipython behaviour. |
|
4 | 4 | |
|
5 |
The actual implementations are in |
|
|
5 | The actual implementations are in extensions/ipy_completers.py | |
|
6 | 6 | |
|
7 | 7 | """ |
|
8 | 8 | from IPython.core import ipapi |
|
9 | 9 | |
|
10 | 10 | ip = ipapi.get() |
|
11 | 11 | |
|
12 | 12 | from ipy_completers import * |
|
13 | 13 | |
|
14 | 14 | ip.set_hook('complete_command', module_completer, str_key = 'import') |
|
15 | 15 | ip.set_hook('complete_command', module_completer, str_key = 'from') |
|
16 | 16 | ip.set_hook('complete_command', runlistpy, str_key = '%run') |
|
17 | 17 | ip.set_hook('complete_command', cd_completer, str_key = '%cd') |
@@ -1,300 +1,300 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """IPython Test Suite Runner. |
|
3 | 3 | |
|
4 | 4 | This module provides a main entry point to a user script to test IPython |
|
5 | 5 | itself from the command line. There are two ways of running this script: |
|
6 | 6 | |
|
7 | 7 | 1. With the syntax `iptest all`. This runs our entire test suite by |
|
8 | 8 | calling this script (with different arguments) or trial recursively. This |
|
9 | 9 | causes modules and package to be tested in different processes, using nose |
|
10 | 10 | or trial where appropriate. |
|
11 | 11 | 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form |
|
12 | 12 | the script simply calls nose, but with special command line flags and |
|
13 | 13 | plugins loaded. |
|
14 | 14 | |
|
15 | 15 | For now, this script requires that both nose and twisted are installed. This |
|
16 | 16 | will change in the future. |
|
17 | 17 | """ |
|
18 | 18 | |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | # Module imports |
|
21 | 21 | #----------------------------------------------------------------------------- |
|
22 | 22 | |
|
23 | 23 | import os |
|
24 | 24 | import os.path as path |
|
25 | 25 | import sys |
|
26 | 26 | import subprocess |
|
27 | 27 | import time |
|
28 | 28 | import warnings |
|
29 | 29 | |
|
30 | 30 | import nose.plugins.builtin |
|
31 | 31 | from nose.core import TestProgram |
|
32 | 32 | |
|
33 | 33 | from IPython.utils.platutils import find_cmd |
|
34 | 34 | from IPython.testing.plugin.ipdoctest import IPythonDoctest |
|
35 | 35 | |
|
36 | 36 | pjoin = path.join |
|
37 | 37 | |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | # Logic for skipping doctests |
|
40 | 40 | #----------------------------------------------------------------------------- |
|
41 | 41 | |
|
42 | 42 | def test_for(mod): |
|
43 | 43 | """Test to see if mod is importable.""" |
|
44 | 44 | try: |
|
45 | 45 | __import__(mod) |
|
46 | 46 | except ImportError: |
|
47 | 47 | return False |
|
48 | 48 | else: |
|
49 | 49 | return True |
|
50 | 50 | |
|
51 | 51 | have_curses = test_for('_curses') |
|
52 | 52 | have_wx = test_for('wx') |
|
53 | 53 | have_zi = test_for('zope.interface') |
|
54 | 54 | have_twisted = test_for('twisted') |
|
55 | 55 | have_foolscap = test_for('foolscap') |
|
56 | 56 | have_objc = test_for('objc') |
|
57 | 57 | have_pexpect = test_for('pexpect') |
|
58 | 58 | |
|
59 | 59 | # For the IPythonDoctest plugin, we need to exclude certain patterns that cause |
|
60 | 60 | # testing problems. We should strive to minimize the number of skipped |
|
61 | 61 | # modules, since this means untested code. As the testing machinery |
|
62 | 62 | # solidifies, this list should eventually become empty. |
|
63 | 63 | EXCLUDE = [pjoin('IPython', 'external'), |
|
64 | 64 | pjoin('IPython', 'frontend', 'process', 'winprocess.py'), |
|
65 | 65 | pjoin('IPython_doctest_plugin'), |
|
66 | 66 | pjoin('IPython', 'Gnuplot'), |
|
67 |
pjoin('IPython', ' |
|
|
68 |
pjoin('IPython', ' |
|
|
69 |
pjoin('IPython', ' |
|
|
70 |
pjoin('IPython', ' |
|
|
71 |
pjoin('IPython', ' |
|
|
67 | pjoin('IPython', 'extensions', 'ipy_'), | |
|
68 | pjoin('IPython', 'extensions', 'clearcmd'), | |
|
69 | pjoin('IPython', 'extensions', 'PhysicalQInteractive'), | |
|
70 | pjoin('IPython', 'extensions', 'scitedirector'), | |
|
71 | pjoin('IPython', 'extensions', 'numeric_formats'), | |
|
72 | 72 | pjoin('IPython', 'testing', 'attic'), |
|
73 | 73 | pjoin('IPython', 'testing', 'tutils'), |
|
74 | 74 | pjoin('IPython', 'testing', 'tools'), |
|
75 | 75 | pjoin('IPython', 'testing', 'mkdoctests') |
|
76 | 76 | ] |
|
77 | 77 | |
|
78 | 78 | if not have_wx: |
|
79 |
EXCLUDE.append(pjoin('IPython', ' |
|
|
79 | EXCLUDE.append(pjoin('IPython', 'extensions', 'igrid')) | |
|
80 | 80 | EXCLUDE.append(pjoin('IPython', 'gui')) |
|
81 | 81 | EXCLUDE.append(pjoin('IPython', 'frontend', 'wx')) |
|
82 | 82 | |
|
83 | 83 | if not have_objc: |
|
84 | 84 | EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa')) |
|
85 | 85 | |
|
86 | 86 | if not have_curses: |
|
87 |
EXCLUDE.append(pjoin('IPython', ' |
|
|
87 | EXCLUDE.append(pjoin('IPython', 'extensions', 'ibrowse')) | |
|
88 | 88 | |
|
89 | 89 | if not sys.platform == 'win32': |
|
90 | 90 | EXCLUDE.append(pjoin('IPython', 'platutils_win32')) |
|
91 | 91 | |
|
92 | 92 | # These have to be skipped on win32 because the use echo, rm, cd, etc. |
|
93 | 93 | # See ticket https://bugs.launchpad.net/bugs/366982 |
|
94 | 94 | if sys.platform == 'win32': |
|
95 | 95 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip')) |
|
96 | 96 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample')) |
|
97 | 97 | |
|
98 | 98 | if not os.name == 'posix': |
|
99 | 99 | EXCLUDE.append(pjoin('IPython', 'platutils_posix')) |
|
100 | 100 | |
|
101 | 101 | if not have_pexpect: |
|
102 | 102 | EXCLUDE.append(pjoin('IPython', 'lib', 'irunner')) |
|
103 | 103 | |
|
104 | 104 | # This is needed for the reg-exp to match on win32 in the ipdoctest plugin. |
|
105 | 105 | if sys.platform == 'win32': |
|
106 | 106 | EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE] |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | #----------------------------------------------------------------------------- |
|
110 | 110 | # Functions and classes |
|
111 | 111 | #----------------------------------------------------------------------------- |
|
112 | 112 | |
|
113 | 113 | def run_iptest(): |
|
114 | 114 | """Run the IPython test suite using nose. |
|
115 | 115 | |
|
116 | 116 | This function is called when this script is **not** called with the form |
|
117 | 117 | `iptest all`. It simply calls nose with appropriate command line flags |
|
118 | 118 | and accepts all of the standard nose arguments. |
|
119 | 119 | """ |
|
120 | 120 | |
|
121 | 121 | warnings.filterwarnings('ignore', |
|
122 | 122 | 'This will be removed soon. Use IPython.testing.util instead') |
|
123 | 123 | |
|
124 | 124 | argv = sys.argv + [ |
|
125 | 125 | # Loading ipdoctest causes problems with Twisted. |
|
126 | 126 | # I am removing this as a temporary fix to get the |
|
127 | 127 | # test suite back into working shape. Our nose |
|
128 | 128 | # plugin needs to be gone through with a fine |
|
129 | 129 | # toothed comb to find what is causing the problem. |
|
130 | 130 | '--with-ipdoctest', |
|
131 | 131 | '--ipdoctest-tests','--ipdoctest-extension=txt', |
|
132 | 132 | '--detailed-errors', |
|
133 | 133 | |
|
134 | 134 | # We add --exe because of setuptools' imbecility (it |
|
135 | 135 | # blindly does chmod +x on ALL files). Nose does the |
|
136 | 136 | # right thing and it tries to avoid executables, |
|
137 | 137 | # setuptools unfortunately forces our hand here. This |
|
138 | 138 | # has been discussed on the distutils list and the |
|
139 | 139 | # setuptools devs refuse to fix this problem! |
|
140 | 140 | '--exe', |
|
141 | 141 | ] |
|
142 | 142 | |
|
143 | 143 | # Detect if any tests were required by explicitly calling an IPython |
|
144 | 144 | # submodule or giving a specific path |
|
145 | 145 | has_tests = False |
|
146 | 146 | for arg in sys.argv: |
|
147 | 147 | if 'IPython' in arg or arg.endswith('.py') or \ |
|
148 | 148 | (':' in arg and '.py' in arg): |
|
149 | 149 | has_tests = True |
|
150 | 150 | break |
|
151 | 151 | |
|
152 | 152 | # If nothing was specifically requested, test full IPython |
|
153 | 153 | if not has_tests: |
|
154 | 154 | argv.append('IPython') |
|
155 | 155 | |
|
156 | 156 | # Construct list of plugins, omitting the existing doctest plugin, which |
|
157 | 157 | # ours replaces (and extends). |
|
158 | 158 | plugins = [IPythonDoctest(EXCLUDE)] |
|
159 | 159 | for p in nose.plugins.builtin.plugins: |
|
160 | 160 | plug = p() |
|
161 | 161 | if plug.name == 'doctest': |
|
162 | 162 | continue |
|
163 | 163 | |
|
164 | 164 | #print '*** adding plugin:',plug.name # dbg |
|
165 | 165 | plugins.append(plug) |
|
166 | 166 | |
|
167 | 167 | TestProgram(argv=argv,plugins=plugins) |
|
168 | 168 | |
|
169 | 169 | |
|
170 | 170 | class IPTester(object): |
|
171 | 171 | """Call that calls iptest or trial in a subprocess. |
|
172 | 172 | """ |
|
173 | 173 | def __init__(self,runner='iptest',params=None): |
|
174 | 174 | """ """ |
|
175 | 175 | if runner == 'iptest': |
|
176 | 176 | self.runner = ['iptest','-v'] |
|
177 | 177 | else: |
|
178 | 178 | self.runner = [find_cmd('trial')] |
|
179 | 179 | if params is None: |
|
180 | 180 | params = [] |
|
181 | 181 | if isinstance(params,str): |
|
182 | 182 | params = [params] |
|
183 | 183 | self.params = params |
|
184 | 184 | |
|
185 | 185 | # Assemble call |
|
186 | 186 | self.call_args = self.runner+self.params |
|
187 | 187 | |
|
188 | 188 | def run(self): |
|
189 | 189 | """Run the stored commands""" |
|
190 | 190 | return subprocess.call(self.call_args) |
|
191 | 191 | |
|
192 | 192 | |
|
193 | 193 | def make_runners(): |
|
194 | 194 | """Define the modules and packages that need to be tested. |
|
195 | 195 | """ |
|
196 | 196 | |
|
197 | 197 | # This omits additional top-level modules that should not be doctested. |
|
198 | 198 | # XXX: shell.py is also ommited because of a bug in the skip_doctest |
|
199 | 199 | # decorator. See ticket https://bugs.launchpad.net/bugs/366209 |
|
200 | 200 | top_mod = \ |
|
201 | 201 | ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py', |
|
202 | 202 | 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py', |
|
203 | 203 | 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py', |
|
204 | 204 | 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py', |
|
205 | 205 | 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py', |
|
206 | 206 | 'logger.py', 'macro.py', 'magic.py', 'oinspect.py', |
|
207 | 207 | 'outputtrap.py', 'platutils.py', 'prefilter.py', 'prompts.py', |
|
208 | 208 | 'PyColorize.py', 'release.py', 'rlineimpl.py', 'shadowns.py', |
|
209 | 209 | 'shellglobals.py', 'strdispatch.py', 'twshell.py', |
|
210 | 210 | 'ultratb.py', 'upgradedir.py', 'usage.py', 'wildcard.py', |
|
211 | 211 | # See note above for why this is skipped |
|
212 | 212 | # 'shell.py', |
|
213 | 213 | 'winconsole.py'] |
|
214 | 214 | |
|
215 | 215 | if have_pexpect: |
|
216 | 216 | top_mod.append('irunner.py') |
|
217 | 217 | |
|
218 | 218 | if sys.platform == 'win32': |
|
219 | 219 | top_mod.append('platutils_win32.py') |
|
220 | 220 | elif os.name == 'posix': |
|
221 | 221 | top_mod.append('platutils_posix.py') |
|
222 | 222 | else: |
|
223 | 223 | top_mod.append('platutils_dummy.py') |
|
224 | 224 | |
|
225 | 225 | # These are tested by nose, so skip IPython.kernel |
|
226 |
top_pack = ['config',' |
|
|
226 | top_pack = ['config','extensions','frontend', | |
|
227 | 227 | 'testing','tests','tools','userconfig'] |
|
228 | 228 | |
|
229 | 229 | if have_wx: |
|
230 | 230 | top_pack.append('gui') |
|
231 | 231 | |
|
232 | 232 | modules = ['IPython.%s' % m[:-3] for m in top_mod ] |
|
233 | 233 | packages = ['IPython.%s' % m for m in top_pack ] |
|
234 | 234 | |
|
235 | 235 | # Make runners |
|
236 | 236 | runners = dict(zip(top_pack, [IPTester(params=v) for v in packages])) |
|
237 | 237 | |
|
238 | 238 | # Test IPython.kernel using trial if twisted is installed |
|
239 | 239 | if have_zi and have_twisted and have_foolscap: |
|
240 | 240 | runners['trial'] = IPTester('trial',['IPython']) |
|
241 | 241 | |
|
242 | 242 | runners['modules'] = IPTester(params=modules) |
|
243 | 243 | |
|
244 | 244 | return runners |
|
245 | 245 | |
|
246 | 246 | |
|
247 | 247 | def run_iptestall(): |
|
248 | 248 | """Run the entire IPython test suite by calling nose and trial. |
|
249 | 249 | |
|
250 | 250 | This function constructs :class:`IPTester` instances for all IPython |
|
251 | 251 | modules and package and then runs each of them. This causes the modules |
|
252 | 252 | and packages of IPython to be tested each in their own subprocess using |
|
253 | 253 | nose or twisted.trial appropriately. |
|
254 | 254 | """ |
|
255 | 255 | runners = make_runners() |
|
256 | 256 | # Run all test runners, tracking execution time |
|
257 | 257 | failed = {} |
|
258 | 258 | t_start = time.time() |
|
259 | 259 | for name,runner in runners.iteritems(): |
|
260 | 260 | print '*'*77 |
|
261 | 261 | print 'IPython test set:',name |
|
262 | 262 | res = runner.run() |
|
263 | 263 | if res: |
|
264 | 264 | failed[name] = res |
|
265 | 265 | t_end = time.time() |
|
266 | 266 | t_tests = t_end - t_start |
|
267 | 267 | nrunners = len(runners) |
|
268 | 268 | nfail = len(failed) |
|
269 | 269 | # summarize results |
|
270 | 270 | |
|
271 | 271 | print '*'*77 |
|
272 | 272 | print 'Ran %s test sets in %.3fs' % (nrunners, t_tests) |
|
273 | 273 | |
|
274 | 274 | if not failed: |
|
275 | 275 | print 'OK' |
|
276 | 276 | else: |
|
277 | 277 | # If anything went wrong, point out what command to rerun manually to |
|
278 | 278 | # see the actual errors and individual summary |
|
279 | 279 | print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners) |
|
280 | 280 | for name in failed: |
|
281 | 281 | failed_runner = runners[name] |
|
282 | 282 | print '-'*40 |
|
283 | 283 | print 'Runner failed:',name |
|
284 | 284 | print 'You may wish to rerun this one individually, with:' |
|
285 | 285 | print ' '.join(failed_runner.call_args) |
|
286 | 286 | |
|
287 | 287 | |
|
288 | 288 | |
|
289 | 289 | def main(): |
|
290 | 290 | if len(sys.argv) == 1: |
|
291 | 291 | run_iptestall() |
|
292 | 292 | else: |
|
293 | 293 | if sys.argv[1] == 'all': |
|
294 | 294 | run_iptestall() |
|
295 | 295 | else: |
|
296 | 296 | run_iptest() |
|
297 | 297 | |
|
298 | 298 | |
|
299 | 299 | if __name__ == '__main__': |
|
300 | 300 | main() No newline at end of file |
@@ -1,37 +1,37 b'' | |||
|
1 | 1 | include ipython.py |
|
2 | 2 | include setupbase.py |
|
3 | 3 | include setupegg.py |
|
4 | 4 | |
|
5 | 5 | graft setupext |
|
6 | 6 | |
|
7 | 7 | graft scripts |
|
8 | 8 | graft IPython/kernel |
|
9 | 9 | graft IPython/config |
|
10 | 10 | graft IPython/core |
|
11 | 11 | graft IPython/deathrow |
|
12 | 12 | graft IPython/external |
|
13 | 13 | graft IPython/frontend |
|
14 | 14 | graft IPython/gui |
|
15 | 15 | graft IPython/lib |
|
16 | 16 | graft IPython/quarantine |
|
17 | 17 | graft IPython/scripts |
|
18 | 18 | graft IPython/testing |
|
19 | 19 | graft IPython/utils |
|
20 | 20 | |
|
21 |
recursive-include IPython/ |
|
|
21 | recursive-include IPython/extensions igrid_help* | |
|
22 | 22 | |
|
23 | 23 | graft docs |
|
24 | 24 | exclude docs/\#* |
|
25 | 25 | exclude docs/man/*.1 |
|
26 | 26 | |
|
27 | 27 | # docs subdirs we want to skip |
|
28 | 28 | prune docs/attic |
|
29 | 29 | prune docs/build |
|
30 | 30 | |
|
31 | 31 | global-exclude *~ |
|
32 | 32 | global-exclude *.flc |
|
33 | 33 | global-exclude *.pyc |
|
34 | 34 | global-exclude .dircopy.log |
|
35 | 35 | global-exclude .svn |
|
36 | 36 | global-exclude .bzr |
|
37 | 37 | global-exclude .hgignore |
@@ -1,34 +1,34 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """Script to auto-generate our API docs. |
|
3 | 3 | """ |
|
4 | 4 | # stdlib imports |
|
5 | 5 | import os |
|
6 | 6 | import sys |
|
7 | 7 | |
|
8 | 8 | # local imports |
|
9 | 9 | sys.path.append(os.path.abspath('sphinxext')) |
|
10 | 10 | from apigen import ApiDocWriter |
|
11 | 11 | |
|
12 | 12 | #***************************************************************************** |
|
13 | 13 | if __name__ == '__main__': |
|
14 | 14 | pjoin = os.path.join |
|
15 | 15 | package = 'IPython' |
|
16 | 16 | outdir = pjoin('source','api','generated') |
|
17 | 17 | docwriter = ApiDocWriter(package,rst_extension='.txt') |
|
18 | 18 | docwriter.package_skip_patterns += [r'\.fixes$', |
|
19 | 19 | r'\.externals$', |
|
20 |
r'\. |
|
|
20 | r'\.extensions', | |
|
21 | 21 | r'\.kernel.config', |
|
22 | 22 | r'\.attic', |
|
23 | 23 | ] |
|
24 | 24 | docwriter.module_skip_patterns += [ r'\.FakeModule', |
|
25 | 25 | r'\.cocoa', |
|
26 | 26 | r'\.ipdoctest', |
|
27 | 27 | r'\.Gnuplot', |
|
28 | 28 | r'\.frontend.process.winprocess', |
|
29 | 29 | ] |
|
30 | 30 | docwriter.write_api_docs(outdir) |
|
31 | 31 | docwriter.write_index(outdir, 'gen', |
|
32 | 32 | relative_to = pjoin('source','api') |
|
33 | 33 | ) |
|
34 | 34 | print '%d files written' % len(docwriter.written_modules) |
@@ -1,274 +1,274 b'' | |||
|
1 | 1 | ============================= |
|
2 | 2 | IPython module reorganization |
|
3 | 3 | =============================' |
|
4 | 4 | |
|
5 | 5 | Currently, IPython has many top-level modules that serve many different |
|
6 | 6 | purposes. The lack of organization make it very difficult for developers to |
|
7 | 7 | work on IPython and understand its design. This document contains notes about |
|
8 | 8 | how we will reorganize the modules into sub-packages. |
|
9 | 9 | |
|
10 | 10 | .. warning:: |
|
11 | 11 | |
|
12 | 12 | This effort will possibly break third party packages that use IPython as |
|
13 | 13 | a library or hack on the IPython internals. |
|
14 | 14 | |
|
15 | 15 | .. warning:: |
|
16 | 16 | |
|
17 | 17 | This effort will result in the removal from IPython of certain modules |
|
18 | 18 | that are not used anymore, don't currently work, are unmaintained, etc. |
|
19 | 19 | |
|
20 | 20 | |
|
21 | 21 | Current subpackges |
|
22 | 22 | ================== |
|
23 | 23 | |
|
24 | 24 | IPython currently has the following sub-packages: |
|
25 | 25 | |
|
26 | 26 | * :mod:`IPython.config` |
|
27 | 27 | |
|
28 |
* :mod:`IPython. |
|
|
28 | * :mod:`IPython.extensions` | |
|
29 | 29 | |
|
30 | 30 | * :mod:`IPython.external` |
|
31 | 31 | |
|
32 | 32 | * :mod:`IPython.frontend` |
|
33 | 33 | |
|
34 | 34 | * :mod:`IPython.gui` |
|
35 | 35 | |
|
36 | 36 | * :mod:`IPython.kernel` |
|
37 | 37 | |
|
38 | 38 | * :mod:`IPython.testing` |
|
39 | 39 | |
|
40 | 40 | * :mod:`IPython.tests` |
|
41 | 41 | |
|
42 | 42 | * :mod:`IPython.tools` |
|
43 | 43 | |
|
44 | 44 | * :mod:`IPython.UserConfig` |
|
45 | 45 | |
|
46 | 46 | New Subpackages to be created |
|
47 | 47 | ============================= |
|
48 | 48 | |
|
49 | 49 | We propose to create the following new sub-packages: |
|
50 | 50 | |
|
51 | 51 | * :mod:`IPython.core`. This sub-package will contain the core of the IPython |
|
52 | 52 | interpreter, but none of its extended capabilities. |
|
53 | 53 | |
|
54 | 54 | * :mod:`IPython.lib`. IPython has many extended capabilities that are not part |
|
55 | 55 | of the IPython core. These things will go here. Any better names than |
|
56 | 56 | :mod:`IPython.lib`? |
|
57 | 57 | |
|
58 | 58 | * :mod:`IPython.utils`. This sub-package will contain anything that might |
|
59 | 59 | eventually be found in the Python standard library, like things in |
|
60 | 60 | :mod:`genutils`. Each sub-module in this sub-package should contain |
|
61 | 61 | functions and classes that serve a single purpose. |
|
62 | 62 | |
|
63 | 63 | * :mod:`IPython.deathrow`. This is for code that is untested and/or rotting |
|
64 | 64 | and needs to be removed from IPython. Eventually all this code will either |
|
65 | 65 | i) be revived by someone willing to maintain it with tests and docs and |
|
66 | 66 | re-included into IPython or 2) be removed from IPython proper, but put into |
|
67 | 67 | a separate top-level (not IPython) package that we keep around. No new code |
|
68 | 68 | will be allowed here. |
|
69 | 69 | |
|
70 | 70 | * :mod:`IPython.quarantine`. This is for code that doesn't meet IPython's |
|
71 | 71 | standards, but that we plan on keeping. To be moved out of this sub-package |
|
72 | 72 | a module needs to have a maintainer, tests and documentation. |
|
73 | 73 | |
|
74 | 74 | Prodedure |
|
75 | 75 | ========= |
|
76 | 76 | |
|
77 | 77 | 1. Move the file to its new location with its new name. |
|
78 | 78 | 2. Rename all import statements to reflect the change. |
|
79 | 79 | 3. Run PyFlakes on each changes module. |
|
80 | 80 | 3. Add tests/test_imports.py to test it. |
|
81 | 81 | |
|
82 | 82 | Status |
|
83 | 83 | ====== |
|
84 | 84 | |
|
85 | 85 | The new subpackages have been created and the top-level modules have been |
|
86 | 86 | moved and renamed. Import tests have been created for all of the moved and |
|
87 | 87 | renamed modules. The build infrastructure (setup.py and friends) have been |
|
88 | 88 | updated and tested on Mac and Windows. Finally, a compatibility layer has been |
|
89 | 89 | added for iplib, ipapi and Shell. The follow things still need to be done:: |
|
90 | 90 | |
|
91 | 91 | * I need to modify iptests to properly skip modules that are no longer top |
|
92 | 92 | level modules. |
|
93 | 93 | |
|
94 | 94 | * I Need to update the top level IPython/__init__.py file. We need to make |
|
95 | 95 | sure that as we change how this is setup, that all modules still import. |
|
96 | 96 | |
|
97 | 97 | * When running python setup.py sdist, the Sphinx API docs fail to build |
|
98 | 98 | because of something going on with IPython.core.fakemodule |
|
99 | 99 | |
|
100 |
* :file:` |
|
|
100 | * :file:`extensions`. This needs to be gone through separately. Minimally, | |
|
101 | 101 | the package should be renamed to :file:`extensions` and the PYTHONPATH |
|
102 | 102 | setting in __init__.py needs to be updated. |
|
103 | 103 | |
|
104 | 104 | Where things have been moved |
|
105 | 105 | ============================ |
|
106 | 106 | |
|
107 | 107 | Top-level modules: |
|
108 | 108 | |
|
109 | 109 | * :file:`background_jobs.py`. Move to :file:`IPython/lib/backgroundjobs.py`. |
|
110 | 110 | |
|
111 | 111 | * :file:`ColorANSI.py`. Move to :file:`IPython/utils/coloransi.py`. |
|
112 | 112 | |
|
113 | 113 | * :file:`completer.py`. Move to :file:`IPython/core/completer.py`. |
|
114 | 114 | |
|
115 | 115 | * :file:`ConfigLoader.py`. Move to :file:`IPython/config/configloader.py`. |
|
116 | 116 | |
|
117 | 117 | * :file:`CrashHandler.py`. Move to :file:`IPython/core/crashhandler`. |
|
118 | 118 | |
|
119 | 119 | * :file:`Debugger.py`. Move to :file:`IPython/core/debugger.py`. |
|
120 | 120 | |
|
121 | 121 | * :file:`deep_reload.py`. Move to :file:`IPython/lib/deepreload.py`. |
|
122 | 122 | |
|
123 | 123 | * :file:`demo.py`. Move to :file:`IPython/lib/demo.py`. |
|
124 | 124 | |
|
125 | 125 | * :file:`DPyGetOpt.py`. Move to :mod:`IPython.utils` and replace with newer options parser. |
|
126 | 126 | |
|
127 | 127 | * :file:`dtutils.py`. Move to :file:`IPython.deathrow`. |
|
128 | 128 | |
|
129 | 129 | * :file:`excolors.py`. Move to :file:`IPython.core` or :file:`IPython.config`. |
|
130 | 130 | Maybe move to :mod:`IPython.lib` or :mod:`IPython.python`? |
|
131 | 131 | |
|
132 | 132 | * :file:`FakeModule.py`. Move to :file:`IPython/core/fakemodule.py`. |
|
133 | 133 | |
|
134 | 134 | * :file:`generics.py`. Move to :file:`IPython.python`. |
|
135 | 135 | |
|
136 | 136 | * :file:`genutils.py`. Move to :file:`IPython.utils`. |
|
137 | 137 | |
|
138 | 138 | * :file:`Gnuplot2.py`. Move to :file:`IPython.sandbox`. |
|
139 | 139 | |
|
140 | 140 | * :file:`GnuplotInteractive.py`. Move to :file:`IPython.sandbox`. |
|
141 | 141 | |
|
142 | 142 | * :file:`GnuplotRuntime.py`. Move to :file:`IPython.sandbox`. |
|
143 | 143 | |
|
144 | 144 | * :file:`numutils.py`. Move to :file:`IPython.sandbox`. |
|
145 | 145 | |
|
146 | 146 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. |
|
147 | 147 | |
|
148 | 148 | * :file:`history.py`. Move to :file:`IPython.core`. |
|
149 | 149 | |
|
150 | 150 | * :file:`hooks.py`. Move to :file:`IPython.core`. |
|
151 | 151 | |
|
152 | 152 | * :file:`ipapi.py`. Move to :file:`IPython.core`. |
|
153 | 153 | |
|
154 | 154 | * :file:`iplib.py`. Move to :file:`IPython.core`. |
|
155 | 155 | |
|
156 | 156 | * :file:`ipmaker.py`: Move to :file:`IPython.core`. |
|
157 | 157 | |
|
158 | 158 | * :file:`ipstruct.py`. Move to :file:`IPython.python`. |
|
159 | 159 | |
|
160 | 160 | * :file:`irunner.py`. Move to :file:`IPython.scripts`. |
|
161 | 161 | |
|
162 | 162 | * :file:`Itpl.py`. Move to :file:`deathrow/Itpl.py`. Copy already in |
|
163 | 163 | :file:`IPython.external`. |
|
164 | 164 | |
|
165 | 165 | * :file:`Logger.py`. Move to :file:`IPython/core/logger.py`. |
|
166 | 166 | |
|
167 | 167 | * :file:`macro.py`. Move to :file:`IPython.core`. |
|
168 | 168 | |
|
169 | 169 | * :file:`Magic.py`. Move to :file:`IPython/core/magic.py`. |
|
170 | 170 | |
|
171 | 171 | * :file:`OInspect.py`. Move to :file:`IPython/core/oinspect.py`. |
|
172 | 172 | |
|
173 | 173 | * :file:`OutputTrap.py`. Move to :file:`IPython/core/outputtrap.py`. |
|
174 | 174 | |
|
175 | 175 | * :file:`platutils.py`. Move to :file:`IPython.python`. |
|
176 | 176 | |
|
177 | 177 | * :file:`platutils_dummy.py`. Move to :file:`IPython.python`. |
|
178 | 178 | |
|
179 | 179 | * :file:`platutils_posix.py`. Move to :file:`IPython.python`. |
|
180 | 180 | |
|
181 | 181 | * :file:`platutils_win32.py`. Move to :file:`IPython.python`. |
|
182 | 182 | |
|
183 | 183 | * :file:`prefilter.py`: Move to :file:`IPython.core`. |
|
184 | 184 | |
|
185 | 185 | * :file:`Prompts.py`. Move to :file:`IPython/core/prompts.py` or |
|
186 | 186 | :file:`IPython/frontend/prompts.py`. |
|
187 | 187 | |
|
188 | 188 | * :file:`PyColorize.py`. Move to :file:`IPython/utils/pycolorize.py`. Explore |
|
189 | 189 | replacing with pygments. |
|
190 | 190 | |
|
191 | 191 | * :file:`Release.py`. Move to ??? or remove? |
|
192 | 192 | |
|
193 | 193 | * :file:`rlineimpl.py`. Move to :file:`IPython.core`. |
|
194 | 194 | |
|
195 | 195 | * :file:`shadowns.py`. Move to :file:`IPython.core`. |
|
196 | 196 | |
|
197 | 197 | * :file:`Shell.py`. Move to :file:`IPython.core.shell.py` or |
|
198 | 198 | :file:`IPython/frontend/shell.py`. |
|
199 | 199 | |
|
200 | 200 | * :file:`shellglobals.py`. Move to :file:`IPython.core`. |
|
201 | 201 | |
|
202 | 202 | * :file:`strdispatch.py`. Move to :file:`IPython.python`. |
|
203 | 203 | |
|
204 | 204 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. |
|
205 | 205 | |
|
206 | 206 | * :file:`ultraTB.py`. Move to :file:`IPython/core/ultratb.py`. |
|
207 | 207 | |
|
208 | 208 | * :file:`upgrade_dir.py`. Move to :file:`IPython/utils/upgradedir.py`. |
|
209 | 209 | |
|
210 | 210 | * :file:`usage.py`. Move to :file:`IPython.core`. |
|
211 | 211 | |
|
212 | 212 | * :file:`wildcard.py`. Move to :file:`IPython.utils`. |
|
213 | 213 | |
|
214 | 214 | * :file:`winconsole.py`. Move to :file:`IPython.utils`. |
|
215 | 215 | |
|
216 | 216 | Top-level sub-packages: |
|
217 | 217 | |
|
218 | 218 | * :file:`testing`. Good where it is. |
|
219 | 219 | |
|
220 | 220 | * :file:`tests`. Remove. |
|
221 | 221 | |
|
222 | 222 | * :file:`tools`. Things in here need to be looked at and moved elsewhere like |
|
223 | 223 | :file:`IPython.utils`. |
|
224 | 224 | |
|
225 | 225 | * :file:`UserConfig`. Move to :file:`IPython.config.userconfig`. |
|
226 | 226 | |
|
227 | 227 | * :file:`config`. Good where it is! |
|
228 | 228 | |
|
229 | 229 | * :file:`external`. Good where it is! |
|
230 | 230 | |
|
231 | 231 | * :file:`frontend`. Good where it is! |
|
232 | 232 | |
|
233 | 233 | * :file:`gui`. Eventually this should be moved to a subdir of |
|
234 | 234 | :file:`IPython.frontend`. |
|
235 | 235 | |
|
236 | 236 | * :file:`kernel`. Good where it is. |
|
237 | 237 | |
|
238 | 238 | |
|
239 | 239 | |
|
240 | 240 | |
|
241 | 241 | |
|
242 | 242 | |
|
243 | 243 | |
|
244 | 244 | |
|
245 | 245 | |
|
246 | 246 | |
|
247 | 247 | |
|
248 | 248 | |
|
249 | 249 | |
|
250 | 250 | |
|
251 | 251 | |
|
252 | 252 | |
|
253 | 253 | |
|
254 | 254 | Other things |
|
255 | 255 | ============ |
|
256 | 256 | |
|
257 | 257 | When these files are moved around, a number of other things will happen at the same time: |
|
258 | 258 | |
|
259 | 259 | 1. Test files will be created for each module in IPython. Minimally, all |
|
260 | 260 | modules will be imported as a part of the test. This will serve as a |
|
261 | 261 | test of the module reorganization. These tests will be put into new |
|
262 | 262 | :file:`tests` subdirectories that each package will have. |
|
263 | 263 | |
|
264 | 264 | 2. PyFlakes and other code checkers will be run to look for problems. |
|
265 | 265 | |
|
266 | 266 | 3. Modules will be renamed to comply with PEP 8 naming conventions: all |
|
267 | 267 | lowercase and no special characters like ``-`` or ``_``. |
|
268 | 268 | |
|
269 | 269 | 4. Existing tests will be moved to the appropriate :file:`tests` |
|
270 | 270 | subdirectories. |
|
271 | 271 | |
|
272 | 272 | |
|
273 | 273 | |
|
274 | 274 |
@@ -1,252 +1,252 b'' | |||
|
1 | 1 | ===================== |
|
2 | 2 | IPython extension API |
|
3 | 3 | ===================== |
|
4 | 4 | |
|
5 | 5 | IPython api (defined in IPython/ipapi.py) is the public api that |
|
6 | 6 | should be used for |
|
7 | 7 | |
|
8 | 8 | * Configuration of user preferences (.ipython/ipy_user_conf.py) |
|
9 | 9 | * Creating new profiles (.ipython/ipy_profile_PROFILENAME.py) |
|
10 | 10 | * Writing extensions |
|
11 | 11 | |
|
12 | 12 | Note that by using the extension api for configuration (editing |
|
13 | 13 | ipy_user_conf.py instead of ipythonrc), you get better validity checks |
|
14 | 14 | and get richer functionality - for example, you can import an |
|
15 | 15 | extension and call functions in it to configure it for your purposes. |
|
16 | 16 | |
|
17 | 17 | For an example extension (the 'sh' profile), see |
|
18 |
IPython/ |
|
|
18 | IPython/extensions/ipy_profile_sh.py. | |
|
19 | 19 | |
|
20 | 20 | For the last word on what's available, see the source code of |
|
21 | 21 | IPython/ipapi.py. |
|
22 | 22 | |
|
23 | 23 | |
|
24 | 24 | Getting started |
|
25 | 25 | =============== |
|
26 | 26 | |
|
27 | 27 | If you want to define an extension, create a normal python module that |
|
28 | 28 | can be imported. The module will access IPython functionality through |
|
29 | 29 | the 'ip' object defined below. |
|
30 | 30 | |
|
31 | 31 | If you are creating a new profile (e.g. foobar), name the module as |
|
32 | 32 | 'ipy_profile_foobar.py' and put it in your ~/.ipython directory. Then, |
|
33 | 33 | when you start ipython with the '-p foobar' argument, the module is |
|
34 | 34 | automatically imported on ipython startup. |
|
35 | 35 | |
|
36 | 36 | If you are just doing some per-user configuration, you can either |
|
37 | 37 | |
|
38 | 38 | * Put the commands directly into ipy_user_conf.py. |
|
39 | 39 | |
|
40 | 40 | * Create a new module with your customization code and import *that* |
|
41 | 41 | module in ipy_user_conf.py. This is preferable to the first approach, |
|
42 | 42 | because now you can reuse and distribute your customization code. |
|
43 | 43 | |
|
44 | 44 | Getting a handle to the api |
|
45 | 45 | =========================== |
|
46 | 46 | |
|
47 | 47 | Put this in the start of your module:: |
|
48 | 48 | |
|
49 | 49 | #!python |
|
50 | 50 | import IPython.ipapi |
|
51 | 51 | ip = IPython.ipapi.get() |
|
52 | 52 | |
|
53 | 53 | The 'ip' object will then be used for accessing IPython |
|
54 | 54 | functionality. 'ip' will mean this api object in all the following |
|
55 | 55 | code snippets. The same 'ip' that we just acquired is always |
|
56 | 56 | accessible in interactive IPython sessions by the name _ip - play with |
|
57 | 57 | it like this:: |
|
58 | 58 | |
|
59 | 59 | [~\_ipython]|81> a = 10 |
|
60 | 60 | [~\_ipython]|82> _ip.e |
|
61 | 61 | _ip.ev _ip.ex _ip.expose_magic |
|
62 | 62 | [~\_ipython]|82> _ip.ev('a+13') |
|
63 | 63 | <82> 23 |
|
64 | 64 | |
|
65 | 65 | The _ip object is also used in some examples in this document - it can |
|
66 | 66 | be substituted by 'ip' in non-interactive use. |
|
67 | 67 | |
|
68 | 68 | Changing options |
|
69 | 69 | ================ |
|
70 | 70 | |
|
71 | 71 | The ip object has 'options' attribute that can be used te get/set |
|
72 | 72 | configuration options (just as in the ipythonrc file):: |
|
73 | 73 | |
|
74 | 74 | o = ip.options |
|
75 | 75 | o.autocall = 2 |
|
76 | 76 | o.automagic = 1 |
|
77 | 77 | |
|
78 | 78 | Executing statements in IPython namespace with 'ex' and 'ev' |
|
79 | 79 | ============================================================ |
|
80 | 80 | |
|
81 | 81 | Often, you want to e.g. import some module or define something that |
|
82 | 82 | should be visible in IPython namespace. Use ``ip.ev`` to |
|
83 | 83 | *evaluate* (calculate the value of) expression and ``ip.ex`` to |
|
84 | 84 | '''execute''' a statement:: |
|
85 | 85 | |
|
86 | 86 | # path module will be visible to the interactive session |
|
87 | 87 | ip.ex("from path import path" ) |
|
88 | 88 | |
|
89 | 89 | # define a handy function 'up' that changes the working directory |
|
90 | 90 | |
|
91 | 91 | ip.ex('import os') |
|
92 | 92 | ip.ex("def up(): os.chdir('..')") |
|
93 | 93 | |
|
94 | 94 | |
|
95 | 95 | # _i2 has the input history entry #2, print its value in uppercase. |
|
96 | 96 | print ip.ev('_i2.upper()') |
|
97 | 97 | |
|
98 | 98 | Accessing the IPython namespace |
|
99 | 99 | =============================== |
|
100 | 100 | |
|
101 | 101 | ip.user_ns attribute has a dictionary containing the IPython global |
|
102 | 102 | namespace (the namespace visible in the interactive session). |
|
103 | 103 | |
|
104 | 104 | :: |
|
105 | 105 | |
|
106 | 106 | [~\_ipython]|84> tauno = 555 |
|
107 | 107 | [~\_ipython]|85> _ip.user_ns['tauno'] |
|
108 | 108 | <85> 555 |
|
109 | 109 | |
|
110 | 110 | Defining new magic commands |
|
111 | 111 | =========================== |
|
112 | 112 | |
|
113 | 113 | The following example defines a new magic command, %impall. What the |
|
114 | 114 | command does should be obvious:: |
|
115 | 115 | |
|
116 | 116 | def doimp(self, arg): |
|
117 | 117 | ip = self.api |
|
118 | 118 | ip.ex("import %s; reload(%s); from %s import *" % ( |
|
119 | 119 | arg,arg,arg) |
|
120 | 120 | ) |
|
121 | 121 | |
|
122 | 122 | ip.expose_magic('impall', doimp) |
|
123 | 123 | |
|
124 | 124 | Things to observe in this example: |
|
125 | 125 | |
|
126 | 126 | * Define a function that implements the magic command using the |
|
127 | 127 | ipapi methods defined in this document |
|
128 | 128 | * The first argument of the function is 'self', i.e. the |
|
129 | 129 | interpreter object. It shouldn't be used directly. however. |
|
130 | 130 | The interpreter object is probably *not* going to remain stable |
|
131 | 131 | through IPython versions. |
|
132 | 132 | * Access the ipapi through 'self.api' instead of the global 'ip' object. |
|
133 | 133 | * All the text following the magic command on the command line is |
|
134 | 134 | contained in the second argument |
|
135 | 135 | * Expose the magic by ip.expose_magic() |
|
136 | 136 | |
|
137 | 137 | |
|
138 | 138 | Calling magic functions and system commands |
|
139 | 139 | =========================================== |
|
140 | 140 | |
|
141 | 141 | Use ip.magic() to execute a magic function, and ip.system() to execute |
|
142 | 142 | a system command:: |
|
143 | 143 | |
|
144 | 144 | # go to a bookmark |
|
145 | 145 | ip.magic('%cd -b relfiles') |
|
146 | 146 | |
|
147 | 147 | # execute 'ls -F' system command. Interchangeable with os.system('ls'), really. |
|
148 | 148 | ip.system('ls -F') |
|
149 | 149 | |
|
150 | 150 | Launching IPython instance from normal python code |
|
151 | 151 | ================================================== |
|
152 | 152 | |
|
153 | 153 | Use ipapi.launch_new_instance() with an argument that specifies the |
|
154 | 154 | namespace to use. This can be useful for trivially embedding IPython |
|
155 | 155 | into your program. Here's an example of normal python program test.py |
|
156 | 156 | ('''without''' an existing IPython session) that launches an IPython |
|
157 | 157 | interpreter and regains control when the interpreter is exited:: |
|
158 | 158 | |
|
159 | 159 | [ipython]|1> cat test.py |
|
160 | 160 | my_ns = dict( |
|
161 | 161 | kissa = 15, |
|
162 | 162 | koira = 16) |
|
163 | 163 | import IPython.ipapi |
|
164 | 164 | print "launching IPython instance" |
|
165 | 165 | IPython.ipapi.launch_new_instance(my_ns) |
|
166 | 166 | print "Exited IPython instance!" |
|
167 | 167 | print "New vals:",my_ns['kissa'], my_ns['koira'] |
|
168 | 168 | |
|
169 | 169 | And here's what it looks like when run (note how we don't start it |
|
170 | 170 | from an ipython session):: |
|
171 | 171 | |
|
172 | 172 | Q:\ipython>python test.py |
|
173 | 173 | launching IPython instance |
|
174 | 174 | Py 2.5 (r25:51908, Sep 19 2006, 09:52:17) [MSC v.1310 32 bit (Intel)] IPy 0.7.3b3.r1975 |
|
175 | 175 | [ipython]|1> kissa = 444 |
|
176 | 176 | [ipython]|2> koira = 555 |
|
177 | 177 | [ipython]|3> Exit |
|
178 | 178 | Exited IPython instance! |
|
179 | 179 | New vals: 444 555 |
|
180 | 180 | |
|
181 | 181 | Accessing unexposed functionality |
|
182 | 182 | ================================= |
|
183 | 183 | |
|
184 | 184 | There are still many features that are not exposed via the ipapi. If |
|
185 | 185 | you can't avoid using them, you can use the functionality in |
|
186 | 186 | InteractiveShell object (central IPython session class, defined in |
|
187 | 187 | iplib.py) through ip.IP. |
|
188 | 188 | |
|
189 | 189 | For example:: |
|
190 | 190 | |
|
191 | 191 | [~]|7> _ip.IP.expand_aliases('np','myfile.py') |
|
192 | 192 | <7> 'c:/opt/Notepad++/notepad++.exe myfile.py' |
|
193 | 193 | [~]|8> |
|
194 | 194 | |
|
195 | 195 | Still, it's preferable that if you encounter such a feature, contact |
|
196 | 196 | the IPython team and request that the functionality be exposed in a |
|
197 | 197 | future version of IPython. Things not in ipapi are more likely to |
|
198 | 198 | change over time. |
|
199 | 199 | |
|
200 | 200 | Provided extensions |
|
201 | 201 | =================== |
|
202 | 202 | |
|
203 | 203 | You can see the list of available extensions (and profiles) by doing |
|
204 | 204 | ``import ipy_<TAB>``. Some extensions don't have the ``ipy_`` prefix in |
|
205 |
module name, so you may need to see the contents of IPython/ |
|
|
205 | module name, so you may need to see the contents of IPython/extensions | |
|
206 | 206 | folder to see what's available. |
|
207 | 207 | |
|
208 | 208 | You can see a brief documentation of an extension by looking at the |
|
209 | 209 | module docstring:: |
|
210 | 210 | |
|
211 | 211 | [c:p/ipython_main]|190> import ipy_fsops |
|
212 | 212 | [c:p/ipython_main]|191> ipy_fsops? |
|
213 | 213 | |
|
214 | 214 | ... |
|
215 | 215 | |
|
216 | 216 | Docstring: |
|
217 | 217 | File system operations |
|
218 | 218 | |
|
219 | 219 | Contains: Simple variants of normal unix shell commands (icp, imv, irm, |
|
220 | 220 | imkdir, igrep). |
|
221 | 221 | |
|
222 | 222 | You can also install your own extensions - the recommended way is to |
|
223 | 223 | just copy the module to ~/.ipython. Extensions are typically enabled |
|
224 | 224 | by just importing them (e.g. in ipy_user_conf.py), but some extensions |
|
225 | 225 | require additional steps, for example:: |
|
226 | 226 | |
|
227 | 227 | [c:p]|192> import ipy_traits_completer |
|
228 | 228 | [c:p]|193> ipy_traits_completer.activate() |
|
229 | 229 | |
|
230 | 230 | Note that extensions, even if provided in the stock IPython |
|
231 | 231 | installation, are not guaranteed to have the same requirements as the |
|
232 | 232 | rest of IPython - an extension may require external libraries or a |
|
233 | 233 | newer version of Python than what IPython officially requires. An |
|
234 | 234 | extension may also be under a more restrictive license than IPython |
|
235 | 235 | (e.g. ipy_bzr is under GPL). |
|
236 | 236 | |
|
237 | 237 | Just for reference, the list of bundled extensions at the time of |
|
238 | 238 | writing is below: |
|
239 | 239 | |
|
240 | 240 | astyle.py clearcmd.py envpersist.py ext_rescapture.py ibrowse.py |
|
241 | 241 | igrid.py InterpreterExec.py InterpreterPasteInput.py ipipe.py |
|
242 | 242 | ipy_app_completers.py ipy_autoreload.py ipy_bzr.py ipy_completers.py |
|
243 | 243 | ipy_constants.py ipy_defaults.py ipy_editors.py ipy_exportdb.py |
|
244 | 244 | ipy_extutil.py ipy_fsops.py ipy_gnuglobal.py ipy_kitcfg.py |
|
245 | 245 | ipy_legacy.py ipy_leo.py ipy_p4.py ipy_profile_doctest.py |
|
246 | 246 | ipy_profile_none.py ipy_profile_scipy.py ipy_profile_sh.py |
|
247 | 247 | ipy_profile_zope.py ipy_pydb.py ipy_rehashdir.py ipy_render.py |
|
248 | 248 | ipy_server.py ipy_signals.py ipy_stock_completers.py |
|
249 | 249 | ipy_system_conf.py ipy_traits_completer.py ipy_vimserver.py |
|
250 | 250 | ipy_which.py ipy_workdir.py jobctrl.py ledit.py numeric_formats.py |
|
251 | 251 | PhysicalQInput.py PhysicalQInteractive.py pickleshare.py |
|
252 | 252 | pspersistence.py win32clip.py __init__.py No newline at end of file |
@@ -1,1631 +1,1631 b'' | |||
|
1 | 1 | ================= |
|
2 | 2 | IPython reference |
|
3 | 3 | ================= |
|
4 | 4 | |
|
5 | 5 | .. _command_line_options: |
|
6 | 6 | |
|
7 | 7 | Command-line usage |
|
8 | 8 | ================== |
|
9 | 9 | |
|
10 | 10 | You start IPython with the command:: |
|
11 | 11 | |
|
12 | 12 | $ ipython [options] files |
|
13 | 13 | |
|
14 | 14 | If invoked with no options, it executes all the files listed in sequence |
|
15 | 15 | and drops you into the interpreter while still acknowledging any options |
|
16 | 16 | you may have set in your ipythonrc file. This behavior is different from |
|
17 | 17 | standard Python, which when called as python -i will only execute one |
|
18 | 18 | file and ignore your configuration setup. |
|
19 | 19 | |
|
20 | 20 | Please note that some of the configuration options are not available at |
|
21 | 21 | the command line, simply because they are not practical here. Look into |
|
22 | 22 | your ipythonrc configuration file for details on those. This file |
|
23 | 23 | typically installed in the $HOME/.ipython directory. For Windows users, |
|
24 | 24 | $HOME resolves to C:\\Documents and Settings\\YourUserName in most |
|
25 | 25 | instances. In the rest of this text, we will refer to this directory as |
|
26 | 26 | IPYTHONDIR. |
|
27 | 27 | |
|
28 | 28 | .. _Threading options: |
|
29 | 29 | |
|
30 | 30 | |
|
31 | 31 | Special Threading Options |
|
32 | 32 | ------------------------- |
|
33 | 33 | |
|
34 | 34 | The following special options are ONLY valid at the beginning of the |
|
35 | 35 | command line, and not later. This is because they control the initial- |
|
36 | 36 | ization of ipython itself, before the normal option-handling mechanism |
|
37 | 37 | is active. |
|
38 | 38 | |
|
39 | 39 | -gthread, -qthread, -q4thread, -wthread, -pylab: |
|
40 | 40 | Only one of these can be given, and it can only be given as |
|
41 | 41 | the first option passed to IPython (it will have no effect in |
|
42 | 42 | any other position). They provide threading support for the |
|
43 | 43 | GTK, Qt (versions 3 and 4) and WXPython toolkits, and for the |
|
44 | 44 | matplotlib library. |
|
45 | 45 | |
|
46 | 46 | With any of the first four options, IPython starts running a |
|
47 | 47 | separate thread for the graphical toolkit's operation, so that |
|
48 | 48 | you can open and control graphical elements from within an |
|
49 | 49 | IPython command line, without blocking. All four provide |
|
50 | 50 | essentially the same functionality, respectively for GTK, Qt3, |
|
51 | 51 | Qt4 and WXWidgets (via their Python interfaces). |
|
52 | 52 | |
|
53 | 53 | Note that with -wthread, you can additionally use the |
|
54 | 54 | -wxversion option to request a specific version of wx to be |
|
55 | 55 | used. This requires that you have the wxversion Python module |
|
56 | 56 | installed, which is part of recent wxPython distributions. |
|
57 | 57 | |
|
58 | 58 | If -pylab is given, IPython loads special support for the mat |
|
59 | 59 | plotlib library (http://matplotlib.sourceforge.net), allowing |
|
60 | 60 | interactive usage of any of its backends as defined in the |
|
61 | 61 | user's ~/.matplotlib/matplotlibrc file. It automatically |
|
62 | 62 | activates GTK, Qt or WX threading for IPyhton if the choice of |
|
63 | 63 | matplotlib backend requires it. It also modifies the %run |
|
64 | 64 | command to correctly execute (without blocking) any |
|
65 | 65 | matplotlib-based script which calls show() at the end. |
|
66 | 66 | |
|
67 | 67 | -tk |
|
68 | 68 | The -g/q/q4/wthread options, and -pylab (if matplotlib is |
|
69 | 69 | configured to use GTK, Qt3, Qt4 or WX), will normally block Tk |
|
70 | 70 | graphical interfaces. This means that when either GTK, Qt or WX |
|
71 | 71 | threading is active, any attempt to open a Tk GUI will result in a |
|
72 | 72 | dead window, and possibly cause the Python interpreter to crash. |
|
73 | 73 | An extra option, -tk, is available to address this issue. It can |
|
74 | 74 | only be given as a second option after any of the above (-gthread, |
|
75 | 75 | -wthread or -pylab). |
|
76 | 76 | |
|
77 | 77 | If -tk is given, IPython will try to coordinate Tk threading |
|
78 | 78 | with GTK, Qt or WX. This is however potentially unreliable, and |
|
79 | 79 | you will have to test on your platform and Python configuration to |
|
80 | 80 | determine whether it works for you. Debian users have reported |
|
81 | 81 | success, apparently due to the fact that Debian builds all of Tcl, |
|
82 | 82 | Tk, Tkinter and Python with pthreads support. Under other Linux |
|
83 | 83 | environments (such as Fedora Core 2/3), this option has caused |
|
84 | 84 | random crashes and lockups of the Python interpreter. Under other |
|
85 | 85 | operating systems (Mac OSX and Windows), you'll need to try it to |
|
86 | 86 | find out, since currently no user reports are available. |
|
87 | 87 | |
|
88 | 88 | There is unfortunately no way for IPython to determine at run time |
|
89 | 89 | whether -tk will work reliably or not, so you will need to do some |
|
90 | 90 | experiments before relying on it for regular work. |
|
91 | 91 | |
|
92 | 92 | |
|
93 | 93 | |
|
94 | 94 | Regular Options |
|
95 | 95 | --------------- |
|
96 | 96 | |
|
97 | 97 | After the above threading options have been given, regular options can |
|
98 | 98 | follow in any order. All options can be abbreviated to their shortest |
|
99 | 99 | non-ambiguous form and are case-sensitive. One or two dashes can be |
|
100 | 100 | used. Some options have an alternate short form, indicated after a ``|``. |
|
101 | 101 | |
|
102 | 102 | Most options can also be set from your ipythonrc configuration file. See |
|
103 | 103 | the provided example for more details on what the options do. Options |
|
104 | 104 | given at the command line override the values set in the ipythonrc file. |
|
105 | 105 | |
|
106 | 106 | All options with a [no] prepended can be specified in negated form |
|
107 | 107 | (-nooption instead of -option) to turn the feature off. |
|
108 | 108 | |
|
109 | 109 | -help print a help message and exit. |
|
110 | 110 | |
|
111 | 111 | -pylab |
|
112 | 112 | this can only be given as the first option passed to IPython |
|
113 | 113 | (it will have no effect in any other position). It adds |
|
114 | 114 | special support for the matplotlib library |
|
115 | 115 | (http://matplotlib.sourceforge.ne), allowing interactive usage |
|
116 | 116 | of any of its backends as defined in the user's .matplotlibrc |
|
117 | 117 | file. It automatically activates GTK or WX threading for |
|
118 | 118 | IPyhton if the choice of matplotlib backend requires it. It |
|
119 | 119 | also modifies the %run command to correctly execute (without |
|
120 | 120 | blocking) any matplotlib-based script which calls show() at |
|
121 | 121 | the end. See `Matplotlib support`_ for more details. |
|
122 | 122 | |
|
123 | 123 | -autocall <val> |
|
124 | 124 | Make IPython automatically call any callable object even if you |
|
125 | 125 | didn't type explicit parentheses. For example, 'str 43' becomes |
|
126 | 126 | 'str(43)' automatically. The value can be '0' to disable the feature, |
|
127 | 127 | '1' for smart autocall, where it is not applied if there are no more |
|
128 | 128 | arguments on the line, and '2' for full autocall, where all callable |
|
129 | 129 | objects are automatically called (even if no arguments are |
|
130 | 130 | present). The default is '1'. |
|
131 | 131 | |
|
132 | 132 | -[no]autoindent |
|
133 | 133 | Turn automatic indentation on/off. |
|
134 | 134 | |
|
135 | 135 | -[no]automagic |
|
136 | 136 | make magic commands automatic (without needing their first character |
|
137 | 137 | to be %). Type %magic at the IPython prompt for more information. |
|
138 | 138 | |
|
139 | 139 | -[no]autoedit_syntax |
|
140 | 140 | When a syntax error occurs after editing a file, automatically |
|
141 | 141 | open the file to the trouble causing line for convenient |
|
142 | 142 | fixing. |
|
143 | 143 | |
|
144 | 144 | -[no]banner Print the initial information banner (default on). |
|
145 | 145 | |
|
146 | 146 | -c <command> |
|
147 | 147 | execute the given command string. This is similar to the -c |
|
148 | 148 | option in the normal Python interpreter. |
|
149 | 149 | |
|
150 | 150 | -cache_size, cs <n> |
|
151 | 151 | size of the output cache (maximum number of entries to hold in |
|
152 | 152 | memory). The default is 1000, you can change it permanently in your |
|
153 | 153 | config file. Setting it to 0 completely disables the caching system, |
|
154 | 154 | and the minimum value accepted is 20 (if you provide a value less than |
|
155 | 155 | 20, it is reset to 0 and a warning is issued) This limit is defined |
|
156 | 156 | because otherwise you'll spend more time re-flushing a too small cache |
|
157 | 157 | than working. |
|
158 | 158 | |
|
159 | 159 | -classic, cl |
|
160 | 160 | Gives IPython a similar feel to the classic Python |
|
161 | 161 | prompt. |
|
162 | 162 | |
|
163 | 163 | -colors <scheme> |
|
164 | 164 | Color scheme for prompts and exception reporting. Currently |
|
165 | 165 | implemented: NoColor, Linux and LightBG. |
|
166 | 166 | |
|
167 | 167 | -[no]color_info |
|
168 | 168 | IPython can display information about objects via a set of functions, |
|
169 | 169 | and optionally can use colors for this, syntax highlighting source |
|
170 | 170 | code and various other elements. However, because this information is |
|
171 | 171 | passed through a pager (like 'less') and many pagers get confused with |
|
172 | 172 | color codes, this option is off by default. You can test it and turn |
|
173 | 173 | it on permanently in your ipythonrc file if it works for you. As a |
|
174 | 174 | reference, the 'less' pager supplied with Mandrake 8.2 works ok, but |
|
175 | 175 | that in RedHat 7.2 doesn't. |
|
176 | 176 | |
|
177 | 177 | Test it and turn it on permanently if it works with your |
|
178 | 178 | system. The magic function %color_info allows you to toggle this |
|
179 | 179 | interactively for testing. |
|
180 | 180 | |
|
181 | 181 | -[no]debug |
|
182 | 182 | Show information about the loading process. Very useful to pin down |
|
183 | 183 | problems with your configuration files or to get details about |
|
184 | 184 | session restores. |
|
185 | 185 | |
|
186 | 186 | -[no]deep_reload: |
|
187 | 187 | IPython can use the deep_reload module which reloads changes in |
|
188 | 188 | modules recursively (it replaces the reload() function, so you don't |
|
189 | 189 | need to change anything to use it). deep_reload() forces a full |
|
190 | 190 | reload of modules whose code may have changed, which the default |
|
191 | 191 | reload() function does not. |
|
192 | 192 | |
|
193 | 193 | When deep_reload is off, IPython will use the normal reload(), |
|
194 | 194 | but deep_reload will still be available as dreload(). This |
|
195 | 195 | feature is off by default [which means that you have both |
|
196 | 196 | normal reload() and dreload()]. |
|
197 | 197 | |
|
198 | 198 | -editor <name> |
|
199 | 199 | Which editor to use with the %edit command. By default, |
|
200 | 200 | IPython will honor your EDITOR environment variable (if not |
|
201 | 201 | set, vi is the Unix default and notepad the Windows one). |
|
202 | 202 | Since this editor is invoked on the fly by IPython and is |
|
203 | 203 | meant for editing small code snippets, you may want to use a |
|
204 | 204 | small, lightweight editor here (in case your default EDITOR is |
|
205 | 205 | something like Emacs). |
|
206 | 206 | |
|
207 | 207 | -ipythondir <name> |
|
208 | 208 | name of your IPython configuration directory IPYTHONDIR. This |
|
209 | 209 | can also be specified through the environment variable |
|
210 | 210 | IPYTHONDIR. |
|
211 | 211 | |
|
212 | 212 | -log, l |
|
213 | 213 | generate a log file of all input. The file is named |
|
214 | 214 | ipython_log.py in your current directory (which prevents logs |
|
215 | 215 | from multiple IPython sessions from trampling each other). You |
|
216 | 216 | can use this to later restore a session by loading your |
|
217 | 217 | logfile as a file to be executed with option -logplay (see |
|
218 | 218 | below). |
|
219 | 219 | |
|
220 | 220 | -logfile, lf <name> specify the name of your logfile. |
|
221 | 221 | |
|
222 | 222 | -logplay, lp <name> |
|
223 | 223 | |
|
224 | 224 | you can replay a previous log. For restoring a session as close as |
|
225 | 225 | possible to the state you left it in, use this option (don't just run |
|
226 | 226 | the logfile). With -logplay, IPython will try to reconstruct the |
|
227 | 227 | previous working environment in full, not just execute the commands in |
|
228 | 228 | the logfile. |
|
229 | 229 | |
|
230 | 230 | When a session is restored, logging is automatically turned on |
|
231 | 231 | again with the name of the logfile it was invoked with (it is |
|
232 | 232 | read from the log header). So once you've turned logging on for |
|
233 | 233 | a session, you can quit IPython and reload it as many times as |
|
234 | 234 | you want and it will continue to log its history and restore |
|
235 | 235 | from the beginning every time. |
|
236 | 236 | |
|
237 | 237 | Caveats: there are limitations in this option. The history |
|
238 | 238 | variables _i*,_* and _dh don't get restored properly. In the |
|
239 | 239 | future we will try to implement full session saving by writing |
|
240 | 240 | and retrieving a 'snapshot' of the memory state of IPython. But |
|
241 | 241 | our first attempts failed because of inherent limitations of |
|
242 | 242 | Python's Pickle module, so this may have to wait. |
|
243 | 243 | |
|
244 | 244 | -[no]messages |
|
245 | 245 | Print messages which IPython collects about its startup |
|
246 | 246 | process (default on). |
|
247 | 247 | |
|
248 | 248 | -[no]pdb |
|
249 | 249 | Automatically call the pdb debugger after every uncaught |
|
250 | 250 | exception. If you are used to debugging using pdb, this puts |
|
251 | 251 | you automatically inside of it after any call (either in |
|
252 | 252 | IPython or in code called by it) which triggers an exception |
|
253 | 253 | which goes uncaught. |
|
254 | 254 | |
|
255 | 255 | -pydb |
|
256 | 256 | Makes IPython use the third party "pydb" package as debugger, |
|
257 | 257 | instead of pdb. Requires that pydb is installed. |
|
258 | 258 | |
|
259 | 259 | -[no]pprint |
|
260 | 260 | ipython can optionally use the pprint (pretty printer) module |
|
261 | 261 | for displaying results. pprint tends to give a nicer display |
|
262 | 262 | of nested data structures. If you like it, you can turn it on |
|
263 | 263 | permanently in your config file (default off). |
|
264 | 264 | |
|
265 | 265 | -profile, p <name> |
|
266 | 266 | |
|
267 | 267 | assume that your config file is ipythonrc-<name> or |
|
268 | 268 | ipy_profile_<name>.py (looks in current dir first, then in |
|
269 | 269 | IPYTHONDIR). This is a quick way to keep and load multiple |
|
270 | 270 | config files for different tasks, especially if you use the |
|
271 | 271 | include option of config files. You can keep a basic |
|
272 | 272 | IPYTHONDIR/ipythonrc file and then have other 'profiles' which |
|
273 | 273 | include this one and load extra things for particular |
|
274 | 274 | tasks. For example: |
|
275 | 275 | |
|
276 | 276 | 1. $HOME/.ipython/ipythonrc : load basic things you always want. |
|
277 | 277 | 2. $HOME/.ipython/ipythonrc-math : load (1) and basic math-related modules. |
|
278 | 278 | 3. $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and plotting modules. |
|
279 | 279 | |
|
280 | 280 | Since it is possible to create an endless loop by having |
|
281 | 281 | circular file inclusions, IPython will stop if it reaches 15 |
|
282 | 282 | recursive inclusions. |
|
283 | 283 | |
|
284 | 284 | -prompt_in1, pi1 <string> |
|
285 | 285 | |
|
286 | 286 | Specify the string used for input prompts. Note that if you are using |
|
287 | 287 | numbered prompts, the number is represented with a '\#' in the |
|
288 | 288 | string. Don't forget to quote strings with spaces embedded in |
|
289 | 289 | them. Default: 'In [\#]:'. The :ref:`prompts section <prompts>` |
|
290 | 290 | discusses in detail all the available escapes to customize your |
|
291 | 291 | prompts. |
|
292 | 292 | |
|
293 | 293 | -prompt_in2, pi2 <string> |
|
294 | 294 | Similar to the previous option, but used for the continuation |
|
295 | 295 | prompts. The special sequence '\D' is similar to '\#', but |
|
296 | 296 | with all digits replaced dots (so you can have your |
|
297 | 297 | continuation prompt aligned with your input prompt). Default: |
|
298 | 298 | ' .\D.:' (note three spaces at the start for alignment with |
|
299 | 299 | 'In [\#]'). |
|
300 | 300 | |
|
301 | 301 | -prompt_out,po <string> |
|
302 | 302 | String used for output prompts, also uses numbers like |
|
303 | 303 | prompt_in1. Default: 'Out[\#]:' |
|
304 | 304 | |
|
305 | 305 | -quick start in bare bones mode (no config file loaded). |
|
306 | 306 | |
|
307 | 307 | -rcfile <name> |
|
308 | 308 | name of your IPython resource configuration file. Normally |
|
309 | 309 | IPython loads ipythonrc (from current directory) or |
|
310 | 310 | IPYTHONDIR/ipythonrc. |
|
311 | 311 | |
|
312 | 312 | If the loading of your config file fails, IPython starts with |
|
313 | 313 | a bare bones configuration (no modules loaded at all). |
|
314 | 314 | |
|
315 | 315 | -[no]readline |
|
316 | 316 | use the readline library, which is needed to support name |
|
317 | 317 | completion and command history, among other things. It is |
|
318 | 318 | enabled by default, but may cause problems for users of |
|
319 | 319 | X/Emacs in Python comint or shell buffers. |
|
320 | 320 | |
|
321 | 321 | Note that X/Emacs 'eterm' buffers (opened with M-x term) support |
|
322 | 322 | IPython's readline and syntax coloring fine, only 'emacs' (M-x |
|
323 | 323 | shell and C-c !) buffers do not. |
|
324 | 324 | |
|
325 | 325 | -screen_length, sl <n> |
|
326 | 326 | number of lines of your screen. This is used to control |
|
327 | 327 | printing of very long strings. Strings longer than this number |
|
328 | 328 | of lines will be sent through a pager instead of directly |
|
329 | 329 | printed. |
|
330 | 330 | |
|
331 | 331 | The default value for this is 0, which means IPython will |
|
332 | 332 | auto-detect your screen size every time it needs to print certain |
|
333 | 333 | potentially long strings (this doesn't change the behavior of the |
|
334 | 334 | 'print' keyword, it's only triggered internally). If for some |
|
335 | 335 | reason this isn't working well (it needs curses support), specify |
|
336 | 336 | it yourself. Otherwise don't change the default. |
|
337 | 337 | |
|
338 | 338 | -separate_in, si <string> |
|
339 | 339 | |
|
340 | 340 | separator before input prompts. |
|
341 | 341 | Default: '\n' |
|
342 | 342 | |
|
343 | 343 | -separate_out, so <string> |
|
344 | 344 | separator before output prompts. |
|
345 | 345 | Default: nothing. |
|
346 | 346 | |
|
347 | 347 | -separate_out2, so2 |
|
348 | 348 | separator after output prompts. |
|
349 | 349 | Default: nothing. |
|
350 | 350 | For these three options, use the value 0 to specify no separator. |
|
351 | 351 | |
|
352 | 352 | -nosep |
|
353 | 353 | shorthand for '-SeparateIn 0 -SeparateOut 0 -SeparateOut2 |
|
354 | 354 | 0'. Simply removes all input/output separators. |
|
355 | 355 | |
|
356 | 356 | -upgrade |
|
357 | 357 | allows you to upgrade your IPYTHONDIR configuration when you |
|
358 | 358 | install a new version of IPython. Since new versions may |
|
359 | 359 | include new command line options or example files, this copies |
|
360 | 360 | updated ipythonrc-type files. However, it backs up (with a |
|
361 | 361 | .old extension) all files which it overwrites so that you can |
|
362 | 362 | merge back any customizations you might have in your personal |
|
363 | 363 | files. Note that you should probably use %upgrade instead, |
|
364 | 364 | it's a safer alternative. |
|
365 | 365 | |
|
366 | 366 | |
|
367 | 367 | -Version print version information and exit. |
|
368 | 368 | |
|
369 | 369 | -wxversion <string> |
|
370 | 370 | Select a specific version of wxPython (used in conjunction |
|
371 | 371 | with -wthread). Requires the wxversion module, part of recent |
|
372 | 372 | wxPython distributions |
|
373 | 373 | |
|
374 | 374 | -xmode <modename> |
|
375 | 375 | |
|
376 | 376 | Mode for exception reporting. |
|
377 | 377 | |
|
378 | 378 | Valid modes: Plain, Context and Verbose. |
|
379 | 379 | |
|
380 | 380 | * Plain: similar to python's normal traceback printing. |
|
381 | 381 | * Context: prints 5 lines of context source code around each |
|
382 | 382 | line in the traceback. |
|
383 | 383 | * Verbose: similar to Context, but additionally prints the |
|
384 | 384 | variables currently visible where the exception happened |
|
385 | 385 | (shortening their strings if too long). This can potentially be |
|
386 | 386 | very slow, if you happen to have a huge data structure whose |
|
387 | 387 | string representation is complex to compute. Your computer may |
|
388 | 388 | appear to freeze for a while with cpu usage at 100%. If this |
|
389 | 389 | occurs, you can cancel the traceback with Ctrl-C (maybe hitting it |
|
390 | 390 | more than once). |
|
391 | 391 | |
|
392 | 392 | Interactive use |
|
393 | 393 | =============== |
|
394 | 394 | |
|
395 | 395 | Warning: IPython relies on the existence of a global variable called |
|
396 | 396 | _ip which controls the shell itself. If you redefine _ip to anything, |
|
397 | 397 | bizarre behavior will quickly occur. |
|
398 | 398 | |
|
399 | 399 | Other than the above warning, IPython is meant to work as a drop-in |
|
400 | 400 | replacement for the standard interactive interpreter. As such, any code |
|
401 | 401 | which is valid python should execute normally under IPython (cases where |
|
402 | 402 | this is not true should be reported as bugs). It does, however, offer |
|
403 | 403 | many features which are not available at a standard python prompt. What |
|
404 | 404 | follows is a list of these. |
|
405 | 405 | |
|
406 | 406 | |
|
407 | 407 | Caution for Windows users |
|
408 | 408 | ------------------------- |
|
409 | 409 | |
|
410 | 410 | Windows, unfortunately, uses the '\' character as a path |
|
411 | 411 | separator. This is a terrible choice, because '\' also represents the |
|
412 | 412 | escape character in most modern programming languages, including |
|
413 | 413 | Python. For this reason, using '/' character is recommended if you |
|
414 | 414 | have problems with ``\``. However, in Windows commands '/' flags |
|
415 | 415 | options, so you can not use it for the root directory. This means that |
|
416 | 416 | paths beginning at the root must be typed in a contrived manner like: |
|
417 | 417 | ``%copy \opt/foo/bar.txt \tmp`` |
|
418 | 418 | |
|
419 | 419 | .. _magic: |
|
420 | 420 | |
|
421 | 421 | Magic command system |
|
422 | 422 | -------------------- |
|
423 | 423 | |
|
424 | 424 | IPython will treat any line whose first character is a % as a special |
|
425 | 425 | call to a 'magic' function. These allow you to control the behavior of |
|
426 | 426 | IPython itself, plus a lot of system-type features. They are all |
|
427 | 427 | prefixed with a % character, but parameters are given without |
|
428 | 428 | parentheses or quotes. |
|
429 | 429 | |
|
430 | 430 | Example: typing '%cd mydir' (without the quotes) changes you working |
|
431 | 431 | directory to 'mydir', if it exists. |
|
432 | 432 | |
|
433 | 433 | If you have 'automagic' enabled (in your ipythonrc file, via the command |
|
434 | 434 | line option -automagic or with the %automagic function), you don't need |
|
435 | 435 | to type in the % explicitly. IPython will scan its internal list of |
|
436 | 436 | magic functions and call one if it exists. With automagic on you can |
|
437 | 437 | then just type 'cd mydir' to go to directory 'mydir'. The automagic |
|
438 | 438 | system has the lowest possible precedence in name searches, so defining |
|
439 | 439 | an identifier with the same name as an existing magic function will |
|
440 | 440 | shadow it for automagic use. You can still access the shadowed magic |
|
441 | 441 | function by explicitly using the % character at the beginning of the line. |
|
442 | 442 | |
|
443 | 443 | An example (with automagic on) should clarify all this:: |
|
444 | 444 | |
|
445 | 445 | In [1]: cd ipython # %cd is called by automagic |
|
446 | 446 | |
|
447 | 447 | /home/fperez/ipython |
|
448 | 448 | |
|
449 | 449 | In [2]: cd=1 # now cd is just a variable |
|
450 | 450 | |
|
451 | 451 | In [3]: cd .. # and doesn't work as a function anymore |
|
452 | 452 | |
|
453 | 453 | ------------------------------ |
|
454 | 454 | |
|
455 | 455 | File "<console>", line 1 |
|
456 | 456 | |
|
457 | 457 | cd .. |
|
458 | 458 | |
|
459 | 459 | ^ |
|
460 | 460 | |
|
461 | 461 | SyntaxError: invalid syntax |
|
462 | 462 | |
|
463 | 463 | In [4]: %cd .. # but %cd always works |
|
464 | 464 | |
|
465 | 465 | /home/fperez |
|
466 | 466 | |
|
467 | 467 | In [5]: del cd # if you remove the cd variable |
|
468 | 468 | |
|
469 | 469 | In [6]: cd ipython # automagic can work again |
|
470 | 470 | |
|
471 | 471 | /home/fperez/ipython |
|
472 | 472 | |
|
473 | 473 | You can define your own magic functions to extend the system. The |
|
474 | 474 | following example defines a new magic command, %impall:: |
|
475 | 475 | |
|
476 | 476 | import IPython.ipapi |
|
477 | 477 | |
|
478 | 478 | ip = IPython.ipapi.get() |
|
479 | 479 | |
|
480 | 480 | def doimp(self, arg): |
|
481 | 481 | |
|
482 | 482 | ip = self.api |
|
483 | 483 | |
|
484 | 484 | ip.ex("import %s; reload(%s); from %s import *" % ( |
|
485 | 485 | |
|
486 | 486 | arg,arg,arg) |
|
487 | 487 | |
|
488 | 488 | ) |
|
489 | 489 | |
|
490 | 490 | ip.expose_magic('impall', doimp) |
|
491 | 491 | |
|
492 | 492 | You can also define your own aliased names for magic functions. In your |
|
493 | 493 | ipythonrc file, placing a line like:: |
|
494 | 494 | |
|
495 | 495 | execute __IP.magic_cl = __IP.magic_clear |
|
496 | 496 | |
|
497 | 497 | will define %cl as a new name for %clear. |
|
498 | 498 | |
|
499 | 499 | Type %magic for more information, including a list of all available |
|
500 | 500 | magic functions at any time and their docstrings. You can also type |
|
501 | 501 | %magic_function_name? (see sec. 6.4 <#sec:dyn-object-info> for |
|
502 | 502 | information on the '?' system) to get information about any particular |
|
503 | 503 | magic function you are interested in. |
|
504 | 504 | |
|
505 | 505 | The API documentation for the :mod:`IPython.Magic` module contains the full |
|
506 | 506 | docstrings of all currently available magic commands. |
|
507 | 507 | |
|
508 | 508 | |
|
509 | 509 | Access to the standard Python help |
|
510 | 510 | ---------------------------------- |
|
511 | 511 | |
|
512 | 512 | As of Python 2.1, a help system is available with access to object docstrings |
|
513 | 513 | and the Python manuals. Simply type 'help' (no quotes) to access it. You can |
|
514 | 514 | also type help(object) to obtain information about a given object, and |
|
515 | 515 | help('keyword') for information on a keyword. As noted :ref:`here |
|
516 | 516 | <accessing_help>`, you need to properly configure your environment variable |
|
517 | 517 | PYTHONDOCS for this feature to work correctly. |
|
518 | 518 | |
|
519 | 519 | .. _dynamic_object_info: |
|
520 | 520 | |
|
521 | 521 | Dynamic object information |
|
522 | 522 | -------------------------- |
|
523 | 523 | |
|
524 | 524 | Typing ?word or word? prints detailed information about an object. If |
|
525 | 525 | certain strings in the object are too long (docstrings, code, etc.) they |
|
526 | 526 | get snipped in the center for brevity. This system gives access variable |
|
527 | 527 | types and values, full source code for any object (if available), |
|
528 | 528 | function prototypes and other useful information. |
|
529 | 529 | |
|
530 | 530 | Typing ??word or word?? gives access to the full information without |
|
531 | 531 | snipping long strings. Long strings are sent to the screen through the |
|
532 | 532 | less pager if longer than the screen and printed otherwise. On systems |
|
533 | 533 | lacking the less command, IPython uses a very basic internal pager. |
|
534 | 534 | |
|
535 | 535 | The following magic functions are particularly useful for gathering |
|
536 | 536 | information about your working environment. You can get more details by |
|
537 | 537 | typing %magic or querying them individually (use %function_name? with or |
|
538 | 538 | without the %), this is just a summary: |
|
539 | 539 | |
|
540 | 540 | * **%pdoc <object>**: Print (or run through a pager if too long) the |
|
541 | 541 | docstring for an object. If the given object is a class, it will |
|
542 | 542 | print both the class and the constructor docstrings. |
|
543 | 543 | * **%pdef <object>**: Print the definition header for any callable |
|
544 | 544 | object. If the object is a class, print the constructor information. |
|
545 | 545 | * **%psource <object>**: Print (or run through a pager if too long) |
|
546 | 546 | the source code for an object. |
|
547 | 547 | * **%pfile <object>**: Show the entire source file where an object was |
|
548 | 548 | defined via a pager, opening it at the line where the object |
|
549 | 549 | definition begins. |
|
550 | 550 | * **%who/%whos**: These functions give information about identifiers |
|
551 | 551 | you have defined interactively (not things you loaded or defined |
|
552 | 552 | in your configuration files). %who just prints a list of |
|
553 | 553 | identifiers and %whos prints a table with some basic details about |
|
554 | 554 | each identifier. |
|
555 | 555 | |
|
556 | 556 | Note that the dynamic object information functions (?/??, %pdoc, %pfile, |
|
557 | 557 | %pdef, %psource) give you access to documentation even on things which |
|
558 | 558 | are not really defined as separate identifiers. Try for example typing |
|
559 | 559 | {}.get? or after doing import os, type os.path.abspath??. |
|
560 | 560 | |
|
561 | 561 | |
|
562 | 562 | .. _readline: |
|
563 | 563 | |
|
564 | 564 | Readline-based features |
|
565 | 565 | ----------------------- |
|
566 | 566 | |
|
567 | 567 | These features require the GNU readline library, so they won't work if |
|
568 | 568 | your Python installation lacks readline support. We will first describe |
|
569 | 569 | the default behavior IPython uses, and then how to change it to suit |
|
570 | 570 | your preferences. |
|
571 | 571 | |
|
572 | 572 | |
|
573 | 573 | Command line completion |
|
574 | 574 | +++++++++++++++++++++++ |
|
575 | 575 | |
|
576 | 576 | At any time, hitting TAB will complete any available python commands or |
|
577 | 577 | variable names, and show you a list of the possible completions if |
|
578 | 578 | there's no unambiguous one. It will also complete filenames in the |
|
579 | 579 | current directory if no python names match what you've typed so far. |
|
580 | 580 | |
|
581 | 581 | |
|
582 | 582 | Search command history |
|
583 | 583 | ++++++++++++++++++++++ |
|
584 | 584 | |
|
585 | 585 | IPython provides two ways for searching through previous input and thus |
|
586 | 586 | reduce the need for repetitive typing: |
|
587 | 587 | |
|
588 | 588 | 1. Start typing, and then use Ctrl-p (previous,up) and Ctrl-n |
|
589 | 589 | (next,down) to search through only the history items that match |
|
590 | 590 | what you've typed so far. If you use Ctrl-p/Ctrl-n at a blank |
|
591 | 591 | prompt, they just behave like normal arrow keys. |
|
592 | 592 | 2. Hit Ctrl-r: opens a search prompt. Begin typing and the system |
|
593 | 593 | searches your history for lines that contain what you've typed so |
|
594 | 594 | far, completing as much as it can. |
|
595 | 595 | |
|
596 | 596 | |
|
597 | 597 | Persistent command history across sessions |
|
598 | 598 | ++++++++++++++++++++++++++++++++++++++++++ |
|
599 | 599 | |
|
600 | 600 | IPython will save your input history when it leaves and reload it next |
|
601 | 601 | time you restart it. By default, the history file is named |
|
602 | 602 | $IPYTHONDIR/history, but if you've loaded a named profile, |
|
603 | 603 | '-PROFILE_NAME' is appended to the name. This allows you to keep |
|
604 | 604 | separate histories related to various tasks: commands related to |
|
605 | 605 | numerical work will not be clobbered by a system shell history, for |
|
606 | 606 | example. |
|
607 | 607 | |
|
608 | 608 | |
|
609 | 609 | Autoindent |
|
610 | 610 | ++++++++++ |
|
611 | 611 | |
|
612 | 612 | IPython can recognize lines ending in ':' and indent the next line, |
|
613 | 613 | while also un-indenting automatically after 'raise' or 'return'. |
|
614 | 614 | |
|
615 | 615 | This feature uses the readline library, so it will honor your ~/.inputrc |
|
616 | 616 | configuration (or whatever file your INPUTRC variable points to). Adding |
|
617 | 617 | the following lines to your .inputrc file can make indenting/unindenting |
|
618 | 618 | more convenient (M-i indents, M-u unindents):: |
|
619 | 619 | |
|
620 | 620 | $if Python |
|
621 | 621 | "\M-i": " " |
|
622 | 622 | "\M-u": "\d\d\d\d" |
|
623 | 623 | $endif |
|
624 | 624 | |
|
625 | 625 | Note that there are 4 spaces between the quote marks after "M-i" above. |
|
626 | 626 | |
|
627 | 627 | Warning: this feature is ON by default, but it can cause problems with |
|
628 | 628 | the pasting of multi-line indented code (the pasted code gets |
|
629 | 629 | re-indented on each line). A magic function %autoindent allows you to |
|
630 | 630 | toggle it on/off at runtime. You can also disable it permanently on in |
|
631 | 631 | your ipythonrc file (set autoindent 0). |
|
632 | 632 | |
|
633 | 633 | |
|
634 | 634 | Customizing readline behavior |
|
635 | 635 | +++++++++++++++++++++++++++++ |
|
636 | 636 | |
|
637 | 637 | All these features are based on the GNU readline library, which has an |
|
638 | 638 | extremely customizable interface. Normally, readline is configured via a |
|
639 | 639 | file which defines the behavior of the library; the details of the |
|
640 | 640 | syntax for this can be found in the readline documentation available |
|
641 | 641 | with your system or on the Internet. IPython doesn't read this file (if |
|
642 | 642 | it exists) directly, but it does support passing to readline valid |
|
643 | 643 | options via a simple interface. In brief, you can customize readline by |
|
644 | 644 | setting the following options in your ipythonrc configuration file (note |
|
645 | 645 | that these options can not be specified at the command line): |
|
646 | 646 | |
|
647 | 647 | * **readline_parse_and_bind**: this option can appear as many times as |
|
648 | 648 | you want, each time defining a string to be executed via a |
|
649 | 649 | readline.parse_and_bind() command. The syntax for valid commands |
|
650 | 650 | of this kind can be found by reading the documentation for the GNU |
|
651 | 651 | readline library, as these commands are of the kind which readline |
|
652 | 652 | accepts in its configuration file. |
|
653 | 653 | * **readline_remove_delims**: a string of characters to be removed |
|
654 | 654 | from the default word-delimiters list used by readline, so that |
|
655 | 655 | completions may be performed on strings which contain them. Do not |
|
656 | 656 | change the default value unless you know what you're doing. |
|
657 | 657 | * **readline_omit__names**: when tab-completion is enabled, hitting |
|
658 | 658 | <tab> after a '.' in a name will complete all attributes of an |
|
659 | 659 | object, including all the special methods whose names include |
|
660 | 660 | double underscores (like __getitem__ or __class__). If you'd |
|
661 | 661 | rather not see these names by default, you can set this option to |
|
662 | 662 | 1. Note that even when this option is set, you can still see those |
|
663 | 663 | names by explicitly typing a _ after the period and hitting <tab>: |
|
664 | 664 | 'name._<tab>' will always complete attribute names starting with '_'. |
|
665 | 665 | |
|
666 | 666 | This option is off by default so that new users see all |
|
667 | 667 | attributes of any objects they are dealing with. |
|
668 | 668 | |
|
669 | 669 | You will find the default values along with a corresponding detailed |
|
670 | 670 | explanation in your ipythonrc file. |
|
671 | 671 | |
|
672 | 672 | |
|
673 | 673 | Session logging and restoring |
|
674 | 674 | ----------------------------- |
|
675 | 675 | |
|
676 | 676 | You can log all input from a session either by starting IPython with the |
|
677 | 677 | command line switches -log or -logfile (see :ref:`here <command_line_options>`) |
|
678 | 678 | or by activating the logging at any moment with the magic function %logstart. |
|
679 | 679 | |
|
680 | 680 | Log files can later be reloaded with the -logplay option and IPython |
|
681 | 681 | will attempt to 'replay' the log by executing all the lines in it, thus |
|
682 | 682 | restoring the state of a previous session. This feature is not quite |
|
683 | 683 | perfect, but can still be useful in many cases. |
|
684 | 684 | |
|
685 | 685 | The log files can also be used as a way to have a permanent record of |
|
686 | 686 | any code you wrote while experimenting. Log files are regular text files |
|
687 | 687 | which you can later open in your favorite text editor to extract code or |
|
688 | 688 | to 'clean them up' before using them to replay a session. |
|
689 | 689 | |
|
690 | 690 | The %logstart function for activating logging in mid-session is used as |
|
691 | 691 | follows: |
|
692 | 692 | |
|
693 | 693 | %logstart [log_name [log_mode]] |
|
694 | 694 | |
|
695 | 695 | If no name is given, it defaults to a file named 'log' in your |
|
696 | 696 | IPYTHONDIR directory, in 'rotate' mode (see below). |
|
697 | 697 | |
|
698 | 698 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
699 | 699 | history up to that point and then continues logging. |
|
700 | 700 | |
|
701 | 701 | %logstart takes a second optional parameter: logging mode. This can be |
|
702 | 702 | one of (note that the modes are given unquoted): |
|
703 | 703 | |
|
704 | 704 | * [over:] overwrite existing log_name. |
|
705 | 705 | * [backup:] rename (if exists) to log_name~ and start log_name. |
|
706 | 706 | * [append:] well, that says it. |
|
707 | 707 | * [rotate:] create rotating logs log_name.1~, log_name.2~, etc. |
|
708 | 708 | |
|
709 | 709 | The %logoff and %logon functions allow you to temporarily stop and |
|
710 | 710 | resume logging to a file which had previously been started with |
|
711 | 711 | %logstart. They will fail (with an explanation) if you try to use them |
|
712 | 712 | before logging has been started. |
|
713 | 713 | |
|
714 | 714 | .. _system_shell_access: |
|
715 | 715 | |
|
716 | 716 | System shell access |
|
717 | 717 | ------------------- |
|
718 | 718 | |
|
719 | 719 | Any input line beginning with a ! character is passed verbatim (minus |
|
720 | 720 | the !, of course) to the underlying operating system. For example, |
|
721 | 721 | typing !ls will run 'ls' in the current directory. |
|
722 | 722 | |
|
723 | 723 | Manual capture of command output |
|
724 | 724 | -------------------------------- |
|
725 | 725 | |
|
726 | 726 | If the input line begins with two exclamation marks, !!, the command is |
|
727 | 727 | executed but its output is captured and returned as a python list, split |
|
728 | 728 | on newlines. Any output sent by the subprocess to standard error is |
|
729 | 729 | printed separately, so that the resulting list only captures standard |
|
730 | 730 | output. The !! syntax is a shorthand for the %sx magic command. |
|
731 | 731 | |
|
732 | 732 | Finally, the %sc magic (short for 'shell capture') is similar to %sx, |
|
733 | 733 | but allowing more fine-grained control of the capture details, and |
|
734 | 734 | storing the result directly into a named variable. The direct use of |
|
735 | 735 | %sc is now deprecated, and you should ise the ``var = !cmd`` syntax |
|
736 | 736 | instead. |
|
737 | 737 | |
|
738 | 738 | IPython also allows you to expand the value of python variables when |
|
739 | 739 | making system calls. Any python variable or expression which you prepend |
|
740 | 740 | with $ will get expanded before the system call is made:: |
|
741 | 741 | |
|
742 | 742 | In [1]: pyvar='Hello world' |
|
743 | 743 | In [2]: !echo "A python variable: $pyvar" |
|
744 | 744 | A python variable: Hello world |
|
745 | 745 | |
|
746 | 746 | If you want the shell to actually see a literal $, you need to type it |
|
747 | 747 | twice:: |
|
748 | 748 | |
|
749 | 749 | In [3]: !echo "A system variable: $$HOME" |
|
750 | 750 | A system variable: /home/fperez |
|
751 | 751 | |
|
752 | 752 | You can pass arbitrary expressions, though you'll need to delimit them |
|
753 | 753 | with {} if there is ambiguity as to the extent of the expression:: |
|
754 | 754 | |
|
755 | 755 | In [5]: x=10 |
|
756 | 756 | In [6]: y=20 |
|
757 | 757 | In [13]: !echo $x+y |
|
758 | 758 | 10+y |
|
759 | 759 | In [7]: !echo ${x+y} |
|
760 | 760 | 30 |
|
761 | 761 | |
|
762 | 762 | Even object attributes can be expanded:: |
|
763 | 763 | |
|
764 | 764 | In [12]: !echo $sys.argv |
|
765 | 765 | [/home/fperez/usr/bin/ipython] |
|
766 | 766 | |
|
767 | 767 | |
|
768 | 768 | System command aliases |
|
769 | 769 | ---------------------- |
|
770 | 770 | |
|
771 | 771 | The %alias magic function and the alias option in the ipythonrc |
|
772 | 772 | configuration file allow you to define magic functions which are in fact |
|
773 | 773 | system shell commands. These aliases can have parameters. |
|
774 | 774 | |
|
775 | 775 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
776 | 776 | |
|
777 | 777 | Then, typing '%alias_name params' will execute the system command 'cmd |
|
778 | 778 | params' (from your underlying operating system). |
|
779 | 779 | |
|
780 | 780 | You can also define aliases with parameters using %s specifiers (one per |
|
781 | 781 | parameter). The following example defines the %parts function as an |
|
782 | 782 | alias to the command 'echo first %s second %s' where each %s will be |
|
783 | 783 | replaced by a positional parameter to the call to %parts:: |
|
784 | 784 | |
|
785 | 785 | In [1]: alias parts echo first %s second %s |
|
786 | 786 | In [2]: %parts A B |
|
787 | 787 | first A second B |
|
788 | 788 | In [3]: %parts A |
|
789 | 789 | Incorrect number of arguments: 2 expected. |
|
790 | 790 | parts is an alias to: 'echo first %s second %s' |
|
791 | 791 | |
|
792 | 792 | If called with no parameters, %alias prints the table of currently |
|
793 | 793 | defined aliases. |
|
794 | 794 | |
|
795 | 795 | The %rehash/rehashx magics allow you to load your entire $PATH as |
|
796 | 796 | ipython aliases. See their respective docstrings (or sec. 6.2 |
|
797 | 797 | <#sec:magic> for further details). |
|
798 | 798 | |
|
799 | 799 | |
|
800 | 800 | .. _dreload: |
|
801 | 801 | |
|
802 | 802 | Recursive reload |
|
803 | 803 | ---------------- |
|
804 | 804 | |
|
805 | 805 | The dreload function does a recursive reload of a module: changes made |
|
806 | 806 | to the module since you imported will actually be available without |
|
807 | 807 | having to exit. |
|
808 | 808 | |
|
809 | 809 | |
|
810 | 810 | Verbose and colored exception traceback printouts |
|
811 | 811 | ------------------------------------------------- |
|
812 | 812 | |
|
813 | 813 | IPython provides the option to see very detailed exception tracebacks, |
|
814 | 814 | which can be especially useful when debugging large programs. You can |
|
815 | 815 | run any Python file with the %run function to benefit from these |
|
816 | 816 | detailed tracebacks. Furthermore, both normal and verbose tracebacks can |
|
817 | 817 | be colored (if your terminal supports it) which makes them much easier |
|
818 | 818 | to parse visually. |
|
819 | 819 | |
|
820 | 820 | See the magic xmode and colors functions for details (just type %magic). |
|
821 | 821 | |
|
822 | 822 | These features are basically a terminal version of Ka-Ping Yee's cgitb |
|
823 | 823 | module, now part of the standard Python library. |
|
824 | 824 | |
|
825 | 825 | |
|
826 | 826 | .. _input_caching: |
|
827 | 827 | |
|
828 | 828 | Input caching system |
|
829 | 829 | -------------------- |
|
830 | 830 | |
|
831 | 831 | IPython offers numbered prompts (In/Out) with input and output caching |
|
832 | 832 | (also referred to as 'input history'). All input is saved and can be |
|
833 | 833 | retrieved as variables (besides the usual arrow key recall), in |
|
834 | 834 | addition to the %rep magic command that brings a history entry |
|
835 | 835 | up for editing on the next command line. |
|
836 | 836 | |
|
837 | 837 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
838 | 838 | _i: stores previous input. _ii: next previous. _iii: next-next previous. |
|
839 | 839 | _ih : a list of all input _ih[n] is the input from line n and this list |
|
840 | 840 | is aliased to the global variable In. If you overwrite In with a |
|
841 | 841 | variable of your own, you can remake the assignment to the internal list |
|
842 | 842 | with a simple 'In=_ih'. |
|
843 | 843 | |
|
844 | 844 | Additionally, global variables named _i<n> are dynamically created (<n> |
|
845 | 845 | being the prompt counter), such that |
|
846 | 846 | _i<n> == _ih[<n>] == In[<n>]. |
|
847 | 847 | |
|
848 | 848 | For example, what you typed at prompt 14 is available as _i14, _ih[14] |
|
849 | 849 | and In[14]. |
|
850 | 850 | |
|
851 | 851 | This allows you to easily cut and paste multi line interactive prompts |
|
852 | 852 | by printing them out: they print like a clean string, without prompt |
|
853 | 853 | characters. You can also manipulate them like regular variables (they |
|
854 | 854 | are strings), modify or exec them (typing 'exec _i9' will re-execute the |
|
855 | 855 | contents of input prompt 9, 'exec In[9:14]+In[18]' will re-execute lines |
|
856 | 856 | 9 through 13 and line 18). |
|
857 | 857 | |
|
858 | 858 | You can also re-execute multiple lines of input easily by using the |
|
859 | 859 | magic %macro function (which automates the process and allows |
|
860 | 860 | re-execution without having to type 'exec' every time). The macro system |
|
861 | 861 | also allows you to re-execute previous lines which include magic |
|
862 | 862 | function calls (which require special processing). Type %macro? or see |
|
863 | 863 | sec. 6.2 <#sec:magic> for more details on the macro system. |
|
864 | 864 | |
|
865 | 865 | A history function %hist allows you to see any part of your input |
|
866 | 866 | history by printing a range of the _i variables. |
|
867 | 867 | |
|
868 | 868 | You can also search ('grep') through your history by typing |
|
869 | 869 | '%hist -g somestring'. This also searches through the so called *shadow history*, |
|
870 | 870 | which remembers all the commands (apart from multiline code blocks) |
|
871 | 871 | you have ever entered. Handy for searching for svn/bzr URL's, IP adrresses |
|
872 | 872 | etc. You can bring shadow history entries listed by '%hist -g' up for editing |
|
873 | 873 | (or re-execution by just pressing ENTER) with %rep command. Shadow history |
|
874 | 874 | entries are not available as _iNUMBER variables, and they are identified by |
|
875 | 875 | the '0' prefix in %hist -g output. That is, history entry 12 is a normal |
|
876 | 876 | history entry, but 0231 is a shadow history entry. |
|
877 | 877 | |
|
878 | 878 | Shadow history was added because the readline history is inherently very |
|
879 | 879 | unsafe - if you have multiple IPython sessions open, the last session |
|
880 | 880 | to close will overwrite the history of previountly closed session. Likewise, |
|
881 | 881 | if a crash occurs, history is never saved, whereas shadow history entries |
|
882 | 882 | are added after entering every command (so a command executed |
|
883 | 883 | in another IPython session is immediately available in other IPython |
|
884 | 884 | sessions that are open). |
|
885 | 885 | |
|
886 | 886 | To conserve space, a command can exist in shadow history only once - it doesn't |
|
887 | 887 | make sense to store a common line like "cd .." a thousand times. The idea is |
|
888 | 888 | mainly to provide a reliable place where valuable, hard-to-remember commands can |
|
889 | 889 | always be retrieved, as opposed to providing an exact sequence of commands |
|
890 | 890 | you have entered in actual order. |
|
891 | 891 | |
|
892 | 892 | Because shadow history has all the commands you have ever executed, |
|
893 | 893 | time taken by %hist -g will increase oven time. If it ever starts to take |
|
894 | 894 | too long (or it ends up containing sensitive information like passwords), |
|
895 | 895 | clear the shadow history by `%clear shadow_nuke`. |
|
896 | 896 | |
|
897 | 897 | Time taken to add entries to shadow history should be negligible, but |
|
898 | 898 | in any case, if you start noticing performance degradation after using |
|
899 | 899 | IPython for a long time (or running a script that floods the shadow history!), |
|
900 | 900 | you can 'compress' the shadow history by executing |
|
901 | 901 | `%clear shadow_compress`. In practice, this should never be necessary |
|
902 | 902 | in normal use. |
|
903 | 903 | |
|
904 | 904 | .. _output_caching: |
|
905 | 905 | |
|
906 | 906 | Output caching system |
|
907 | 907 | --------------------- |
|
908 | 908 | |
|
909 | 909 | For output that is returned from actions, a system similar to the input |
|
910 | 910 | cache exists but using _ instead of _i. Only actions that produce a |
|
911 | 911 | result (NOT assignments, for example) are cached. If you are familiar |
|
912 | 912 | with Mathematica, IPython's _ variables behave exactly like |
|
913 | 913 | Mathematica's % variables. |
|
914 | 914 | |
|
915 | 915 | The following GLOBAL variables always exist (so don't overwrite them!): |
|
916 | 916 | |
|
917 | 917 | * [_] (a single underscore) : stores previous output, like Python's |
|
918 | 918 | default interpreter. |
|
919 | 919 | * [__] (two underscores): next previous. |
|
920 | 920 | * [___] (three underscores): next-next previous. |
|
921 | 921 | |
|
922 | 922 | Additionally, global variables named _<n> are dynamically created (<n> |
|
923 | 923 | being the prompt counter), such that the result of output <n> is always |
|
924 | 924 | available as _<n> (don't use the angle brackets, just the number, e.g. |
|
925 | 925 | _21). |
|
926 | 926 | |
|
927 | 927 | These global variables are all stored in a global dictionary (not a |
|
928 | 928 | list, since it only has entries for lines which returned a result) |
|
929 | 929 | available under the names _oh and Out (similar to _ih and In). So the |
|
930 | 930 | output from line 12 can be obtained as _12, Out[12] or _oh[12]. If you |
|
931 | 931 | accidentally overwrite the Out variable you can recover it by typing |
|
932 | 932 | 'Out=_oh' at the prompt. |
|
933 | 933 | |
|
934 | 934 | This system obviously can potentially put heavy memory demands on your |
|
935 | 935 | system, since it prevents Python's garbage collector from removing any |
|
936 | 936 | previously computed results. You can control how many results are kept |
|
937 | 937 | in memory with the option (at the command line or in your ipythonrc |
|
938 | 938 | file) cache_size. If you set it to 0, the whole system is completely |
|
939 | 939 | disabled and the prompts revert to the classic '>>>' of normal Python. |
|
940 | 940 | |
|
941 | 941 | |
|
942 | 942 | Directory history |
|
943 | 943 | ----------------- |
|
944 | 944 | |
|
945 | 945 | Your history of visited directories is kept in the global list _dh, and |
|
946 | 946 | the magic %cd command can be used to go to any entry in that list. The |
|
947 | 947 | %dhist command allows you to view this history. Do ``cd -<TAB`` to |
|
948 | 948 | conventiently view the directory history. |
|
949 | 949 | |
|
950 | 950 | |
|
951 | 951 | Automatic parentheses and quotes |
|
952 | 952 | -------------------------------- |
|
953 | 953 | |
|
954 | 954 | These features were adapted from Nathan Gray's LazyPython. They are |
|
955 | 955 | meant to allow less typing for common situations. |
|
956 | 956 | |
|
957 | 957 | |
|
958 | 958 | Automatic parentheses |
|
959 | 959 | --------------------- |
|
960 | 960 | |
|
961 | 961 | Callable objects (i.e. functions, methods, etc) can be invoked like this |
|
962 | 962 | (notice the commas between the arguments):: |
|
963 | 963 | |
|
964 | 964 | >>> callable_ob arg1, arg2, arg3 |
|
965 | 965 | |
|
966 | 966 | and the input will be translated to this:: |
|
967 | 967 | |
|
968 | 968 | -> callable_ob(arg1, arg2, arg3) |
|
969 | 969 | |
|
970 | 970 | You can force automatic parentheses by using '/' as the first character |
|
971 | 971 | of a line. For example:: |
|
972 | 972 | |
|
973 | 973 | >>> /globals # becomes 'globals()' |
|
974 | 974 | |
|
975 | 975 | Note that the '/' MUST be the first character on the line! This won't work:: |
|
976 | 976 | |
|
977 | 977 | >>> print /globals # syntax error |
|
978 | 978 | |
|
979 | 979 | In most cases the automatic algorithm should work, so you should rarely |
|
980 | 980 | need to explicitly invoke /. One notable exception is if you are trying |
|
981 | 981 | to call a function with a list of tuples as arguments (the parenthesis |
|
982 | 982 | will confuse IPython):: |
|
983 | 983 | |
|
984 | 984 | In [1]: zip (1,2,3),(4,5,6) # won't work |
|
985 | 985 | |
|
986 | 986 | but this will work:: |
|
987 | 987 | |
|
988 | 988 | In [2]: /zip (1,2,3),(4,5,6) |
|
989 | 989 | ---> zip ((1,2,3),(4,5,6)) |
|
990 | 990 | Out[2]= [(1, 4), (2, 5), (3, 6)] |
|
991 | 991 | |
|
992 | 992 | IPython tells you that it has altered your command line by displaying |
|
993 | 993 | the new command line preceded by ->. e.g.:: |
|
994 | 994 | |
|
995 | 995 | In [18]: callable list |
|
996 | 996 | ----> callable (list) |
|
997 | 997 | |
|
998 | 998 | |
|
999 | 999 | Automatic quoting |
|
1000 | 1000 | ----------------- |
|
1001 | 1001 | |
|
1002 | 1002 | You can force automatic quoting of a function's arguments by using ',' |
|
1003 | 1003 | or ';' as the first character of a line. For example:: |
|
1004 | 1004 | |
|
1005 | 1005 | >>> ,my_function /home/me # becomes my_function("/home/me") |
|
1006 | 1006 | |
|
1007 | 1007 | If you use ';' instead, the whole argument is quoted as a single string |
|
1008 | 1008 | (while ',' splits on whitespace):: |
|
1009 | 1009 | |
|
1010 | 1010 | >>> ,my_function a b c # becomes my_function("a","b","c") |
|
1011 | 1011 | |
|
1012 | 1012 | >>> ;my_function a b c # becomes my_function("a b c") |
|
1013 | 1013 | |
|
1014 | 1014 | Note that the ',' or ';' MUST be the first character on the line! This |
|
1015 | 1015 | won't work:: |
|
1016 | 1016 | |
|
1017 | 1017 | >>> x = ,my_function /home/me # syntax error |
|
1018 | 1018 | |
|
1019 | 1019 | IPython as your default Python environment |
|
1020 | 1020 | ========================================== |
|
1021 | 1021 | |
|
1022 | 1022 | Python honors the environment variable PYTHONSTARTUP and will execute at |
|
1023 | 1023 | startup the file referenced by this variable. If you put at the end of |
|
1024 | 1024 | this file the following two lines of code:: |
|
1025 | 1025 | |
|
1026 | 1026 | import IPython |
|
1027 | 1027 | IPython.Shell.IPShell().mainloop(sys_exit=1) |
|
1028 | 1028 | |
|
1029 | 1029 | then IPython will be your working environment anytime you start Python. |
|
1030 | 1030 | The sys_exit=1 is needed to have IPython issue a call to sys.exit() when |
|
1031 | 1031 | it finishes, otherwise you'll be back at the normal Python '>>>' |
|
1032 | 1032 | prompt. |
|
1033 | 1033 | |
|
1034 | 1034 | This is probably useful to developers who manage multiple Python |
|
1035 | 1035 | versions and don't want to have correspondingly multiple IPython |
|
1036 | 1036 | versions. Note that in this mode, there is no way to pass IPython any |
|
1037 | 1037 | command-line options, as those are trapped first by Python itself. |
|
1038 | 1038 | |
|
1039 | 1039 | .. _Embedding: |
|
1040 | 1040 | |
|
1041 | 1041 | Embedding IPython |
|
1042 | 1042 | ================= |
|
1043 | 1043 | |
|
1044 | 1044 | It is possible to start an IPython instance inside your own Python |
|
1045 | 1045 | programs. This allows you to evaluate dynamically the state of your |
|
1046 | 1046 | code, operate with your variables, analyze them, etc. Note however that |
|
1047 | 1047 | any changes you make to values while in the shell do not propagate back |
|
1048 | 1048 | to the running code, so it is safe to modify your values because you |
|
1049 | 1049 | won't break your code in bizarre ways by doing so. |
|
1050 | 1050 | |
|
1051 | 1051 | This feature allows you to easily have a fully functional python |
|
1052 | 1052 | environment for doing object introspection anywhere in your code with a |
|
1053 | 1053 | simple function call. In some cases a simple print statement is enough, |
|
1054 | 1054 | but if you need to do more detailed analysis of a code fragment this |
|
1055 | 1055 | feature can be very valuable. |
|
1056 | 1056 | |
|
1057 | 1057 | It can also be useful in scientific computing situations where it is |
|
1058 | 1058 | common to need to do some automatic, computationally intensive part and |
|
1059 | 1059 | then stop to look at data, plots, etc. |
|
1060 | 1060 | Opening an IPython instance will give you full access to your data and |
|
1061 | 1061 | functions, and you can resume program execution once you are done with |
|
1062 | 1062 | the interactive part (perhaps to stop again later, as many times as |
|
1063 | 1063 | needed). |
|
1064 | 1064 | |
|
1065 | 1065 | The following code snippet is the bare minimum you need to include in |
|
1066 | 1066 | your Python programs for this to work (detailed examples follow later):: |
|
1067 | 1067 | |
|
1068 | 1068 | from IPython.Shell import IPShellEmbed |
|
1069 | 1069 | |
|
1070 | 1070 | ipshell = IPShellEmbed() |
|
1071 | 1071 | |
|
1072 | 1072 | ipshell() # this call anywhere in your program will start IPython |
|
1073 | 1073 | |
|
1074 | 1074 | You can run embedded instances even in code which is itself being run at |
|
1075 | 1075 | the IPython interactive prompt with '%run <filename>'. Since it's easy |
|
1076 | 1076 | to get lost as to where you are (in your top-level IPython or in your |
|
1077 | 1077 | embedded one), it's a good idea in such cases to set the in/out prompts |
|
1078 | 1078 | to something different for the embedded instances. The code examples |
|
1079 | 1079 | below illustrate this. |
|
1080 | 1080 | |
|
1081 | 1081 | You can also have multiple IPython instances in your program and open |
|
1082 | 1082 | them separately, for example with different options for data |
|
1083 | 1083 | presentation. If you close and open the same instance multiple times, |
|
1084 | 1084 | its prompt counters simply continue from each execution to the next. |
|
1085 | 1085 | |
|
1086 | 1086 | Please look at the docstrings in the Shell.py module for more details on |
|
1087 | 1087 | the use of this system. |
|
1088 | 1088 | |
|
1089 | 1089 | The following sample file illustrating how to use the embedding |
|
1090 | 1090 | functionality is provided in the examples directory as example-embed.py. |
|
1091 | 1091 | It should be fairly self-explanatory:: |
|
1092 | 1092 | |
|
1093 | 1093 | |
|
1094 | 1094 | #!/usr/bin/env python |
|
1095 | 1095 | |
|
1096 | 1096 | """An example of how to embed an IPython shell into a running program. |
|
1097 | 1097 | |
|
1098 | 1098 | Please see the documentation in the IPython.Shell module for more details. |
|
1099 | 1099 | |
|
1100 | 1100 | The accompanying file example-embed-short.py has quick code fragments for |
|
1101 | 1101 | embedding which you can cut and paste in your code once you understand how |
|
1102 | 1102 | things work. |
|
1103 | 1103 | |
|
1104 | 1104 | The code in this file is deliberately extra-verbose, meant for learning.""" |
|
1105 | 1105 | |
|
1106 | 1106 | # The basics to get you going: |
|
1107 | 1107 | |
|
1108 | 1108 | # IPython sets the __IPYTHON__ variable so you can know if you have nested |
|
1109 | 1109 | # copies running. |
|
1110 | 1110 | |
|
1111 | 1111 | # Try running this code both at the command line and from inside IPython (with |
|
1112 | 1112 | # %run example-embed.py) |
|
1113 | 1113 | try: |
|
1114 | 1114 | __IPYTHON__ |
|
1115 | 1115 | except NameError: |
|
1116 | 1116 | nested = 0 |
|
1117 | 1117 | args = [''] |
|
1118 | 1118 | else: |
|
1119 | 1119 | print "Running nested copies of IPython." |
|
1120 | 1120 | print "The prompts for the nested copy have been modified" |
|
1121 | 1121 | nested = 1 |
|
1122 | 1122 | # what the embedded instance will see as sys.argv: |
|
1123 | 1123 | args = ['-pi1','In <\\#>: ','-pi2',' .\\D.: ', |
|
1124 | 1124 | '-po','Out<\\#>: ','-nosep'] |
|
1125 | 1125 | |
|
1126 | 1126 | # First import the embeddable shell class |
|
1127 | 1127 | from IPython.Shell import IPShellEmbed |
|
1128 | 1128 | |
|
1129 | 1129 | # Now create an instance of the embeddable shell. The first argument is a |
|
1130 | 1130 | # string with options exactly as you would type them if you were starting |
|
1131 | 1131 | # IPython at the system command line. Any parameters you want to define for |
|
1132 | 1132 | # configuration can thus be specified here. |
|
1133 | 1133 | ipshell = IPShellEmbed(args, |
|
1134 | 1134 | banner = 'Dropping into IPython', |
|
1135 | 1135 | exit_msg = 'Leaving Interpreter, back to program.') |
|
1136 | 1136 | |
|
1137 | 1137 | # Make a second instance, you can have as many as you want. |
|
1138 | 1138 | if nested: |
|
1139 | 1139 | args[1] = 'In2<\\#>' |
|
1140 | 1140 | else: |
|
1141 | 1141 | args = ['-pi1','In2<\\#>: ','-pi2',' .\\D.: ', |
|
1142 | 1142 | '-po','Out<\\#>: ','-nosep'] |
|
1143 | 1143 | ipshell2 = IPShellEmbed(args,banner = 'Second IPython instance.') |
|
1144 | 1144 | |
|
1145 | 1145 | print '\nHello. This is printed from the main controller program.\n' |
|
1146 | 1146 | |
|
1147 | 1147 | # You can then call ipshell() anywhere you need it (with an optional |
|
1148 | 1148 | # message): |
|
1149 | 1149 | ipshell('***Called from top level. ' |
|
1150 | 1150 | 'Hit Ctrl-D to exit interpreter and continue program.\n' |
|
1151 | 1151 | 'Note that if you use %kill_embedded, you can fully deactivate\n' |
|
1152 | 1152 | 'This embedded instance so it will never turn on again') |
|
1153 | 1153 | |
|
1154 | 1154 | print '\nBack in caller program, moving along...\n' |
|
1155 | 1155 | |
|
1156 | 1156 | #--------------------------------------------------------------------------- |
|
1157 | 1157 | # More details: |
|
1158 | 1158 | |
|
1159 | 1159 | # IPShellEmbed instances don't print the standard system banner and |
|
1160 | 1160 | # messages. The IPython banner (which actually may contain initialization |
|
1161 | 1161 | # messages) is available as <instance>.IP.BANNER in case you want it. |
|
1162 | 1162 | |
|
1163 | 1163 | # IPShellEmbed instances print the following information everytime they |
|
1164 | 1164 | # start: |
|
1165 | 1165 | |
|
1166 | 1166 | # - A global startup banner. |
|
1167 | 1167 | |
|
1168 | 1168 | # - A call-specific header string, which you can use to indicate where in the |
|
1169 | 1169 | # execution flow the shell is starting. |
|
1170 | 1170 | |
|
1171 | 1171 | # They also print an exit message every time they exit. |
|
1172 | 1172 | |
|
1173 | 1173 | # Both the startup banner and the exit message default to None, and can be set |
|
1174 | 1174 | # either at the instance constructor or at any other time with the |
|
1175 | 1175 | # set_banner() and set_exit_msg() methods. |
|
1176 | 1176 | |
|
1177 | 1177 | # The shell instance can be also put in 'dummy' mode globally or on a per-call |
|
1178 | 1178 | # basis. This gives you fine control for debugging without having to change |
|
1179 | 1179 | # code all over the place. |
|
1180 | 1180 | |
|
1181 | 1181 | # The code below illustrates all this. |
|
1182 | 1182 | |
|
1183 | 1183 | |
|
1184 | 1184 | # This is how the global banner and exit_msg can be reset at any point |
|
1185 | 1185 | ipshell.set_banner('Entering interpreter - New Banner') |
|
1186 | 1186 | ipshell.set_exit_msg('Leaving interpreter - New exit_msg') |
|
1187 | 1187 | |
|
1188 | 1188 | def foo(m): |
|
1189 | 1189 | s = 'spam' |
|
1190 | 1190 | ipshell('***In foo(). Try @whos, or print s or m:') |
|
1191 | 1191 | print 'foo says m = ',m |
|
1192 | 1192 | |
|
1193 | 1193 | def bar(n): |
|
1194 | 1194 | s = 'eggs' |
|
1195 | 1195 | ipshell('***In bar(). Try @whos, or print s or n:') |
|
1196 | 1196 | print 'bar says n = ',n |
|
1197 | 1197 | |
|
1198 | 1198 | # Some calls to the above functions which will trigger IPython: |
|
1199 | 1199 | print 'Main program calling foo("eggs")\n' |
|
1200 | 1200 | foo('eggs') |
|
1201 | 1201 | |
|
1202 | 1202 | # The shell can be put in 'dummy' mode where calls to it silently return. This |
|
1203 | 1203 | # allows you, for example, to globally turn off debugging for a program with a |
|
1204 | 1204 | # single call. |
|
1205 | 1205 | ipshell.set_dummy_mode(1) |
|
1206 | 1206 | print '\nTrying to call IPython which is now "dummy":' |
|
1207 | 1207 | ipshell() |
|
1208 | 1208 | print 'Nothing happened...' |
|
1209 | 1209 | # The global 'dummy' mode can still be overridden for a single call |
|
1210 | 1210 | print '\nOverriding dummy mode manually:' |
|
1211 | 1211 | ipshell(dummy=0) |
|
1212 | 1212 | |
|
1213 | 1213 | # Reactivate the IPython shell |
|
1214 | 1214 | ipshell.set_dummy_mode(0) |
|
1215 | 1215 | |
|
1216 | 1216 | print 'You can even have multiple embedded instances:' |
|
1217 | 1217 | ipshell2() |
|
1218 | 1218 | |
|
1219 | 1219 | print '\nMain program calling bar("spam")\n' |
|
1220 | 1220 | bar('spam') |
|
1221 | 1221 | |
|
1222 | 1222 | print 'Main program finished. Bye!' |
|
1223 | 1223 | |
|
1224 | 1224 | #********************** End of file <example-embed.py> *********************** |
|
1225 | 1225 | |
|
1226 | 1226 | Once you understand how the system functions, you can use the following |
|
1227 | 1227 | code fragments in your programs which are ready for cut and paste:: |
|
1228 | 1228 | |
|
1229 | 1229 | |
|
1230 | 1230 | """Quick code snippets for embedding IPython into other programs. |
|
1231 | 1231 | |
|
1232 | 1232 | See example-embed.py for full details, this file has the bare minimum code for |
|
1233 | 1233 | cut and paste use once you understand how to use the system.""" |
|
1234 | 1234 | |
|
1235 | 1235 | #--------------------------------------------------------------------------- |
|
1236 | 1236 | # This code loads IPython but modifies a few things if it detects it's running |
|
1237 | 1237 | # embedded in another IPython session (helps avoid confusion) |
|
1238 | 1238 | |
|
1239 | 1239 | try: |
|
1240 | 1240 | __IPYTHON__ |
|
1241 | 1241 | except NameError: |
|
1242 | 1242 | argv = [''] |
|
1243 | 1243 | banner = exit_msg = '' |
|
1244 | 1244 | else: |
|
1245 | 1245 | # Command-line options for IPython (a list like sys.argv) |
|
1246 | 1246 | argv = ['-pi1','In <\\#>:','-pi2',' .\\D.:','-po','Out<\\#>:'] |
|
1247 | 1247 | banner = '*** Nested interpreter ***' |
|
1248 | 1248 | exit_msg = '*** Back in main IPython ***' |
|
1249 | 1249 | |
|
1250 | 1250 | # First import the embeddable shell class |
|
1251 | 1251 | from IPython.Shell import IPShellEmbed |
|
1252 | 1252 | # Now create the IPython shell instance. Put ipshell() anywhere in your code |
|
1253 | 1253 | # where you want it to open. |
|
1254 | 1254 | ipshell = IPShellEmbed(argv,banner=banner,exit_msg=exit_msg) |
|
1255 | 1255 | |
|
1256 | 1256 | #--------------------------------------------------------------------------- |
|
1257 | 1257 | # This code will load an embeddable IPython shell always with no changes for |
|
1258 | 1258 | # nested embededings. |
|
1259 | 1259 | |
|
1260 | 1260 | from IPython.Shell import IPShellEmbed |
|
1261 | 1261 | ipshell = IPShellEmbed() |
|
1262 | 1262 | # Now ipshell() will open IPython anywhere in the code. |
|
1263 | 1263 | |
|
1264 | 1264 | #--------------------------------------------------------------------------- |
|
1265 | 1265 | # This code loads an embeddable shell only if NOT running inside |
|
1266 | 1266 | # IPython. Inside IPython, the embeddable shell variable ipshell is just a |
|
1267 | 1267 | # dummy function. |
|
1268 | 1268 | |
|
1269 | 1269 | try: |
|
1270 | 1270 | __IPYTHON__ |
|
1271 | 1271 | except NameError: |
|
1272 | 1272 | from IPython.Shell import IPShellEmbed |
|
1273 | 1273 | ipshell = IPShellEmbed() |
|
1274 | 1274 | # Now ipshell() will open IPython anywhere in the code |
|
1275 | 1275 | else: |
|
1276 | 1276 | # Define a dummy ipshell() so the same code doesn't crash inside an |
|
1277 | 1277 | # interactive IPython |
|
1278 | 1278 | def ipshell(): pass |
|
1279 | 1279 | |
|
1280 | 1280 | #******************* End of file <example-embed-short.py> ******************** |
|
1281 | 1281 | |
|
1282 | 1282 | Using the Python debugger (pdb) |
|
1283 | 1283 | =============================== |
|
1284 | 1284 | |
|
1285 | 1285 | Running entire programs via pdb |
|
1286 | 1286 | ------------------------------- |
|
1287 | 1287 | |
|
1288 | 1288 | pdb, the Python debugger, is a powerful interactive debugger which |
|
1289 | 1289 | allows you to step through code, set breakpoints, watch variables, |
|
1290 | 1290 | etc. IPython makes it very easy to start any script under the control |
|
1291 | 1291 | of pdb, regardless of whether you have wrapped it into a 'main()' |
|
1292 | 1292 | function or not. For this, simply type '%run -d myscript' at an |
|
1293 | 1293 | IPython prompt. See the %run command's documentation (via '%run?' or |
|
1294 | 1294 | in Sec. magic_ for more details, including how to control where pdb |
|
1295 | 1295 | will stop execution first. |
|
1296 | 1296 | |
|
1297 | 1297 | For more information on the use of the pdb debugger, read the included |
|
1298 | 1298 | pdb.doc file (part of the standard Python distribution). On a stock |
|
1299 | 1299 | Linux system it is located at /usr/lib/python2.3/pdb.doc, but the |
|
1300 | 1300 | easiest way to read it is by using the help() function of the pdb module |
|
1301 | 1301 | as follows (in an IPython prompt): |
|
1302 | 1302 | |
|
1303 | 1303 | In [1]: import pdb |
|
1304 | 1304 | In [2]: pdb.help() |
|
1305 | 1305 | |
|
1306 | 1306 | This will load the pdb.doc document in a file viewer for you automatically. |
|
1307 | 1307 | |
|
1308 | 1308 | |
|
1309 | 1309 | Automatic invocation of pdb on exceptions |
|
1310 | 1310 | ----------------------------------------- |
|
1311 | 1311 | |
|
1312 | 1312 | IPython, if started with the -pdb option (or if the option is set in |
|
1313 | 1313 | your rc file) can call the Python pdb debugger every time your code |
|
1314 | 1314 | triggers an uncaught exception. This feature |
|
1315 | 1315 | can also be toggled at any time with the %pdb magic command. This can be |
|
1316 | 1316 | extremely useful in order to find the origin of subtle bugs, because pdb |
|
1317 | 1317 | opens up at the point in your code which triggered the exception, and |
|
1318 | 1318 | while your program is at this point 'dead', all the data is still |
|
1319 | 1319 | available and you can walk up and down the stack frame and understand |
|
1320 | 1320 | the origin of the problem. |
|
1321 | 1321 | |
|
1322 | 1322 | Furthermore, you can use these debugging facilities both with the |
|
1323 | 1323 | embedded IPython mode and without IPython at all. For an embedded shell |
|
1324 | 1324 | (see sec. Embedding_), simply call the constructor with |
|
1325 | 1325 | '-pdb' in the argument string and automatically pdb will be called if an |
|
1326 | 1326 | uncaught exception is triggered by your code. |
|
1327 | 1327 | |
|
1328 | 1328 | For stand-alone use of the feature in your programs which do not use |
|
1329 | 1329 | IPython at all, put the following lines toward the top of your 'main' |
|
1330 | 1330 | routine:: |
|
1331 | 1331 | |
|
1332 | 1332 | import sys,IPython.ultraTB |
|
1333 | 1333 | sys.excepthook = IPython.ultraTB.FormattedTB(mode='Verbose', |
|
1334 | 1334 | color_scheme='Linux', call_pdb=1) |
|
1335 | 1335 | |
|
1336 | 1336 | The mode keyword can be either 'Verbose' or 'Plain', giving either very |
|
1337 | 1337 | detailed or normal tracebacks respectively. The color_scheme keyword can |
|
1338 | 1338 | be one of 'NoColor', 'Linux' (default) or 'LightBG'. These are the same |
|
1339 | 1339 | options which can be set in IPython with -colors and -xmode. |
|
1340 | 1340 | |
|
1341 | 1341 | This will give any of your programs detailed, colored tracebacks with |
|
1342 | 1342 | automatic invocation of pdb. |
|
1343 | 1343 | |
|
1344 | 1344 | |
|
1345 | 1345 | Extensions for syntax processing |
|
1346 | 1346 | ================================ |
|
1347 | 1347 | |
|
1348 | 1348 | This isn't for the faint of heart, because the potential for breaking |
|
1349 | 1349 | things is quite high. But it can be a very powerful and useful feature. |
|
1350 | 1350 | In a nutshell, you can redefine the way IPython processes the user input |
|
1351 | 1351 | line to accept new, special extensions to the syntax without needing to |
|
1352 | 1352 | change any of IPython's own code. |
|
1353 | 1353 | |
|
1354 |
In the IPython/ |
|
|
1354 | In the IPython/extensions directory you will find some examples | |
|
1355 | 1355 | supplied, which we will briefly describe now. These can be used 'as is' |
|
1356 | 1356 | (and both provide very useful functionality), or you can use them as a |
|
1357 | 1357 | starting point for writing your own extensions. |
|
1358 | 1358 | |
|
1359 | 1359 | |
|
1360 | 1360 | Pasting of code starting with '>>> ' or '... ' |
|
1361 | 1361 | ---------------------------------------------- |
|
1362 | 1362 | |
|
1363 | 1363 | In the python tutorial it is common to find code examples which have |
|
1364 | 1364 | been taken from real python sessions. The problem with those is that all |
|
1365 | 1365 | the lines begin with either '>>> ' or '... ', which makes it impossible |
|
1366 | 1366 | to paste them all at once. One must instead do a line by line manual |
|
1367 | 1367 | copying, carefully removing the leading extraneous characters. |
|
1368 | 1368 | |
|
1369 | 1369 | This extension identifies those starting characters and removes them |
|
1370 | 1370 | from the input automatically, so that one can paste multi-line examples |
|
1371 | 1371 | directly into IPython, saving a lot of time. Please look at the file |
|
1372 |
InterpreterPasteInput.py in the IPython/ |
|
|
1372 | InterpreterPasteInput.py in the IPython/extensions directory for details | |
|
1373 | 1373 | on how this is done. |
|
1374 | 1374 | |
|
1375 | 1375 | IPython comes with a special profile enabling this feature, called |
|
1376 | 1376 | tutorial. Simply start IPython via 'ipython -p tutorial' and the feature |
|
1377 | 1377 | will be available. In a normal IPython session you can activate the |
|
1378 | 1378 | feature by importing the corresponding module with: |
|
1379 |
In [1]: import IPython. |
|
|
1379 | In [1]: import IPython.extensions.InterpreterPasteInput | |
|
1380 | 1380 | |
|
1381 | 1381 | The following is a 'screenshot' of how things work when this extension |
|
1382 | 1382 | is on, copying an example from the standard tutorial:: |
|
1383 | 1383 | |
|
1384 | 1384 | IPython profile: tutorial |
|
1385 | 1385 | |
|
1386 | 1386 | *** Pasting of code with ">>>" or "..." has been enabled. |
|
1387 | 1387 | |
|
1388 | 1388 | In [1]: >>> def fib2(n): # return Fibonacci series up to n |
|
1389 | 1389 | ...: ... """Return a list containing the Fibonacci series up to |
|
1390 | 1390 | n.""" |
|
1391 | 1391 | ...: ... result = [] |
|
1392 | 1392 | ...: ... a, b = 0, 1 |
|
1393 | 1393 | ...: ... while b < n: |
|
1394 | 1394 | ...: ... result.append(b) # see below |
|
1395 | 1395 | ...: ... a, b = b, a+b |
|
1396 | 1396 | ...: ... return result |
|
1397 | 1397 | ...: |
|
1398 | 1398 | |
|
1399 | 1399 | In [2]: fib2(10) |
|
1400 | 1400 | Out[2]: [1, 1, 2, 3, 5, 8] |
|
1401 | 1401 | |
|
1402 | 1402 | Note that as currently written, this extension does not recognize |
|
1403 | 1403 | IPython's prompts for pasting. Those are more complicated, since the |
|
1404 | 1404 | user can change them very easily, they involve numbers and can vary in |
|
1405 | 1405 | length. One could however extract all the relevant information from the |
|
1406 | 1406 | IPython instance and build an appropriate regular expression. This is |
|
1407 | 1407 | left as an exercise for the reader. |
|
1408 | 1408 | |
|
1409 | 1409 | |
|
1410 | 1410 | Input of physical quantities with units |
|
1411 | 1411 | --------------------------------------- |
|
1412 | 1412 | |
|
1413 | 1413 | The module PhysicalQInput allows a simplified form of input for physical |
|
1414 | 1414 | quantities with units. This file is meant to be used in conjunction with |
|
1415 | 1415 | the PhysicalQInteractive module (in the same directory) and |
|
1416 | 1416 | Physics.PhysicalQuantities from Konrad Hinsen's ScientificPython |
|
1417 | 1417 | (http://dirac.cnrs-orleans.fr/ScientificPython/). |
|
1418 | 1418 | |
|
1419 | 1419 | The Physics.PhysicalQuantities module defines PhysicalQuantity objects, |
|
1420 | 1420 | but these must be declared as instances of a class. For example, to |
|
1421 | 1421 | define v as a velocity of 3 m/s, normally you would write:: |
|
1422 | 1422 | |
|
1423 | 1423 | In [1]: v = PhysicalQuantity(3,'m/s') |
|
1424 | 1424 | |
|
1425 | 1425 | Using the PhysicalQ_Input extension this can be input instead as: |
|
1426 | 1426 | In [1]: v = 3 m/s |
|
1427 | 1427 | which is much more convenient for interactive use (even though it is |
|
1428 | 1428 | blatantly invalid Python syntax). |
|
1429 | 1429 | |
|
1430 | 1430 | The physics profile supplied with IPython (enabled via 'ipython -p |
|
1431 | 1431 | physics') uses these extensions, which you can also activate with: |
|
1432 | 1432 | |
|
1433 | 1433 | from math import * # math MUST be imported BEFORE PhysicalQInteractive |
|
1434 |
from IPython. |
|
|
1435 |
import IPython. |
|
|
1434 | from IPython.extensions.PhysicalQInteractive import * | |
|
1435 | import IPython.extensions.PhysicalQInput | |
|
1436 | 1436 | |
|
1437 | 1437 | |
|
1438 | 1438 | Threading support |
|
1439 | 1439 | ================= |
|
1440 | 1440 | |
|
1441 | 1441 | WARNING: The threading support is still somewhat experimental, and it |
|
1442 | 1442 | has only seen reasonable testing under Linux. Threaded code is |
|
1443 | 1443 | particularly tricky to debug, and it tends to show extremely |
|
1444 | 1444 | platform-dependent behavior. Since I only have access to Linux machines, |
|
1445 | 1445 | I will have to rely on user's experiences and assistance for this area |
|
1446 | 1446 | of IPython to improve under other platforms. |
|
1447 | 1447 | |
|
1448 | 1448 | IPython, via the -gthread , -qthread, -q4thread and -wthread options |
|
1449 | 1449 | (described in Sec. `Threading options`_), can run in |
|
1450 | 1450 | multithreaded mode to support pyGTK, Qt3, Qt4 and WXPython applications |
|
1451 | 1451 | respectively. These GUI toolkits need to control the python main loop of |
|
1452 | 1452 | execution, so under a normal Python interpreter, starting a pyGTK, Qt3, |
|
1453 | 1453 | Qt4 or WXPython application will immediately freeze the shell. |
|
1454 | 1454 | |
|
1455 | 1455 | IPython, with one of these options (you can only use one at a time), |
|
1456 | 1456 | separates the graphical loop and IPython's code execution run into |
|
1457 | 1457 | different threads. This allows you to test interactively (with %run, for |
|
1458 | 1458 | example) your GUI code without blocking. |
|
1459 | 1459 | |
|
1460 | 1460 | A nice mini-tutorial on using IPython along with the Qt Designer |
|
1461 | 1461 | application is available at the SciPy wiki: |
|
1462 | 1462 | http://www.scipy.org/Cookbook/Matplotlib/Qt_with_IPython_and_Designer. |
|
1463 | 1463 | |
|
1464 | 1464 | |
|
1465 | 1465 | Tk issues |
|
1466 | 1466 | --------- |
|
1467 | 1467 | |
|
1468 | 1468 | As indicated in Sec. `Threading options`_, a special -tk option is |
|
1469 | 1469 | provided to try and allow Tk graphical applications to coexist |
|
1470 | 1470 | interactively with WX, Qt or GTK ones. Whether this works at all, |
|
1471 | 1471 | however, is very platform and configuration dependent. Please |
|
1472 | 1472 | experiment with simple test cases before committing to using this |
|
1473 | 1473 | combination of Tk and GTK/Qt/WX threading in a production environment. |
|
1474 | 1474 | |
|
1475 | 1475 | |
|
1476 | 1476 | I/O pitfalls |
|
1477 | 1477 | ------------ |
|
1478 | 1478 | |
|
1479 | 1479 | Be mindful that the Python interpreter switches between threads every |
|
1480 | 1480 | $N$ bytecodes, where the default value as of Python 2.3 is $N=100.$ This |
|
1481 | 1481 | value can be read by using the sys.getcheckinterval() function, and it |
|
1482 | 1482 | can be reset via sys.setcheckinterval(N). This switching of threads can |
|
1483 | 1483 | cause subtly confusing effects if one of your threads is doing file I/O. |
|
1484 | 1484 | In text mode, most systems only flush file buffers when they encounter a |
|
1485 | 1485 | '\n'. An instruction as simple as:: |
|
1486 | 1486 | |
|
1487 | 1487 | print >> filehandle, ''hello world'' |
|
1488 | 1488 | |
|
1489 | 1489 | actually consists of several bytecodes, so it is possible that the |
|
1490 | 1490 | newline does not reach your file before the next thread switch. |
|
1491 | 1491 | Similarly, if you are writing to a file in binary mode, the file won't |
|
1492 | 1492 | be flushed until the buffer fills, and your other thread may see |
|
1493 | 1493 | apparently truncated files. |
|
1494 | 1494 | |
|
1495 | 1495 | For this reason, if you are using IPython's thread support and have (for |
|
1496 | 1496 | example) a GUI application which will read data generated by files |
|
1497 | 1497 | written to from the IPython thread, the safest approach is to open all |
|
1498 | 1498 | of your files in unbuffered mode (the third argument to the file/open |
|
1499 | 1499 | function is the buffering value):: |
|
1500 | 1500 | |
|
1501 | 1501 | filehandle = open(filename,mode,0) |
|
1502 | 1502 | |
|
1503 | 1503 | This is obviously a brute force way of avoiding race conditions with the |
|
1504 | 1504 | file buffering. If you want to do it cleanly, and you have a resource |
|
1505 | 1505 | which is being shared by the interactive IPython loop and your GUI |
|
1506 | 1506 | thread, you should really handle it with thread locking and |
|
1507 | 1507 | syncrhonization properties. The Python documentation discusses these. |
|
1508 | 1508 | |
|
1509 | 1509 | .. _interactive_demos: |
|
1510 | 1510 | |
|
1511 | 1511 | Interactive demos with IPython |
|
1512 | 1512 | ============================== |
|
1513 | 1513 | |
|
1514 | 1514 | IPython ships with a basic system for running scripts interactively in |
|
1515 | 1515 | sections, useful when presenting code to audiences. A few tags embedded |
|
1516 | 1516 | in comments (so that the script remains valid Python code) divide a file |
|
1517 | 1517 | into separate blocks, and the demo can be run one block at a time, with |
|
1518 | 1518 | IPython printing (with syntax highlighting) the block before executing |
|
1519 | 1519 | it, and returning to the interactive prompt after each block. The |
|
1520 | 1520 | interactive namespace is updated after each block is run with the |
|
1521 | 1521 | contents of the demo's namespace. |
|
1522 | 1522 | |
|
1523 | 1523 | This allows you to show a piece of code, run it and then execute |
|
1524 | 1524 | interactively commands based on the variables just created. Once you |
|
1525 | 1525 | want to continue, you simply execute the next block of the demo. The |
|
1526 | 1526 | following listing shows the markup necessary for dividing a script into |
|
1527 | 1527 | sections for execution as a demo:: |
|
1528 | 1528 | |
|
1529 | 1529 | |
|
1530 | 1530 | """A simple interactive demo to illustrate the use of IPython's Demo class. |
|
1531 | 1531 | |
|
1532 | 1532 | Any python script can be run as a demo, but that does little more than showing |
|
1533 | 1533 | it on-screen, syntax-highlighted in one shot. If you add a little simple |
|
1534 | 1534 | markup, you can stop at specified intervals and return to the ipython prompt, |
|
1535 | 1535 | resuming execution later. |
|
1536 | 1536 | """ |
|
1537 | 1537 | |
|
1538 | 1538 | print 'Hello, welcome to an interactive IPython demo.' |
|
1539 | 1539 | print 'Executing this block should require confirmation before proceeding,' |
|
1540 | 1540 | print 'unless auto_all has been set to true in the demo object' |
|
1541 | 1541 | |
|
1542 | 1542 | # The mark below defines a block boundary, which is a point where IPython will |
|
1543 | 1543 | # stop execution and return to the interactive prompt. |
|
1544 | 1544 | # Note that in actual interactive execution, |
|
1545 | 1545 | # <demo> --- stop --- |
|
1546 | 1546 | |
|
1547 | 1547 | x = 1 |
|
1548 | 1548 | y = 2 |
|
1549 | 1549 | |
|
1550 | 1550 | # <demo> --- stop --- |
|
1551 | 1551 | |
|
1552 | 1552 | # the mark below makes this block as silent |
|
1553 | 1553 | # <demo> silent |
|
1554 | 1554 | |
|
1555 | 1555 | print 'This is a silent block, which gets executed but not printed.' |
|
1556 | 1556 | |
|
1557 | 1557 | # <demo> --- stop --- |
|
1558 | 1558 | # <demo> auto |
|
1559 | 1559 | print 'This is an automatic block.' |
|
1560 | 1560 | print 'It is executed without asking for confirmation, but printed.' |
|
1561 | 1561 | z = x+y |
|
1562 | 1562 | |
|
1563 | 1563 | print 'z=',x |
|
1564 | 1564 | |
|
1565 | 1565 | # <demo> --- stop --- |
|
1566 | 1566 | # This is just another normal block. |
|
1567 | 1567 | print 'z is now:', z |
|
1568 | 1568 | |
|
1569 | 1569 | print 'bye!' |
|
1570 | 1570 | |
|
1571 | 1571 | In order to run a file as a demo, you must first make a Demo object out |
|
1572 | 1572 | of it. If the file is named myscript.py, the following code will make a |
|
1573 | 1573 | demo:: |
|
1574 | 1574 | |
|
1575 | 1575 | from IPython.demo import Demo |
|
1576 | 1576 | |
|
1577 | 1577 | mydemo = Demo('myscript.py') |
|
1578 | 1578 | |
|
1579 | 1579 | This creates the mydemo object, whose blocks you run one at a time by |
|
1580 | 1580 | simply calling the object with no arguments. If you have autocall active |
|
1581 | 1581 | in IPython (the default), all you need to do is type:: |
|
1582 | 1582 | |
|
1583 | 1583 | mydemo |
|
1584 | 1584 | |
|
1585 | 1585 | and IPython will call it, executing each block. Demo objects can be |
|
1586 | 1586 | restarted, you can move forward or back skipping blocks, re-execute the |
|
1587 | 1587 | last block, etc. Simply use the Tab key on a demo object to see its |
|
1588 | 1588 | methods, and call '?' on them to see their docstrings for more usage |
|
1589 | 1589 | details. In addition, the demo module itself contains a comprehensive |
|
1590 | 1590 | docstring, which you can access via:: |
|
1591 | 1591 | |
|
1592 | 1592 | from IPython import demo |
|
1593 | 1593 | |
|
1594 | 1594 | demo? |
|
1595 | 1595 | |
|
1596 | 1596 | Limitations: It is important to note that these demos are limited to |
|
1597 | 1597 | fairly simple uses. In particular, you can not put division marks in |
|
1598 | 1598 | indented code (loops, if statements, function definitions, etc.) |
|
1599 | 1599 | Supporting something like this would basically require tracking the |
|
1600 | 1600 | internal execution state of the Python interpreter, so only top-level |
|
1601 | 1601 | divisions are allowed. If you want to be able to open an IPython |
|
1602 | 1602 | instance at an arbitrary point in a program, you can use IPython's |
|
1603 | 1603 | embedding facilities, described in detail in Sec. 9 |
|
1604 | 1604 | |
|
1605 | 1605 | |
|
1606 | 1606 | .. _Matplotlib support: |
|
1607 | 1607 | |
|
1608 | 1608 | Plotting with matplotlib |
|
1609 | 1609 | ======================== |
|
1610 | 1610 | |
|
1611 | 1611 | The matplotlib library (http://matplotlib.sourceforge.net |
|
1612 | 1612 | http://matplotlib.sourceforge.net) provides high quality 2D plotting for |
|
1613 | 1613 | Python. Matplotlib can produce plots on screen using a variety of GUI |
|
1614 | 1614 | toolkits, including Tk, GTK and WXPython. It also provides a number of |
|
1615 | 1615 | commands useful for scientific computing, all with a syntax compatible |
|
1616 | 1616 | with that of the popular Matlab program. |
|
1617 | 1617 | |
|
1618 | 1618 | IPython accepts the special option -pylab (see :ref:`here |
|
1619 | 1619 | <command_line_options>`). This configures it to support matplotlib, honoring |
|
1620 | 1620 | the settings in the .matplotlibrc file. IPython will detect the user's choice |
|
1621 | 1621 | of matplotlib GUI backend, and automatically select the proper threading model |
|
1622 | 1622 | to prevent blocking. It also sets matplotlib in interactive mode and modifies |
|
1623 | 1623 | %run slightly, so that any matplotlib-based script can be executed using %run |
|
1624 | 1624 | and the final show() command does not block the interactive shell. |
|
1625 | 1625 | |
|
1626 | 1626 | The -pylab option must be given first in order for IPython to configure its |
|
1627 | 1627 | threading mode. However, you can still issue other options afterwards. This |
|
1628 | 1628 | allows you to have a matplotlib-based environment customized with additional |
|
1629 | 1629 | modules using the standard IPython profile mechanism (see :ref:`here |
|
1630 | 1630 | <profiles>`): ``ipython -pylab -p myprofile`` will load the profile defined in |
|
1631 | 1631 | ipythonrc-myprofile after configuring matplotlib. |
@@ -1,284 +1,284 b'' | |||
|
1 | 1 | .. _ipython_as_shell: |
|
2 | 2 | |
|
3 | 3 | ========================= |
|
4 | 4 | IPython as a system shell |
|
5 | 5 | ========================= |
|
6 | 6 | |
|
7 | 7 | Overview |
|
8 | 8 | ======== |
|
9 | 9 | |
|
10 | 10 | The 'sh' profile optimizes IPython for system shell usage. Apart from |
|
11 | 11 | certain job control functionality that is present in unix (ctrl+z does |
|
12 | 12 | "suspend"), the sh profile should provide you with most of the |
|
13 | 13 | functionality you use daily in system shell, and more. Invoke IPython |
|
14 | 14 | in 'sh' profile by doing 'ipython -p sh', or (in win32) by launching |
|
15 | 15 | the "pysh" shortcut in start menu. |
|
16 | 16 | |
|
17 | 17 | If you want to use the features of sh profile as your defaults (which |
|
18 | 18 | might be a good idea if you use other profiles a lot of the time but |
|
19 | 19 | still want the convenience of sh profile), add ``import ipy_profile_sh`` |
|
20 | 20 | to your ~/.ipython/ipy_user_conf.py. |
|
21 | 21 | |
|
22 | 22 | The 'sh' profile is different from the default profile in that: |
|
23 | 23 | |
|
24 | 24 | * Prompt shows the current directory |
|
25 | 25 | * Spacing between prompts and input is more compact (no padding with |
|
26 | 26 | empty lines). The startup banner is more compact as well. |
|
27 | 27 | * System commands are directly available (in alias table) without |
|
28 | 28 | requesting %rehashx - however, if you install new programs along |
|
29 | 29 | your PATH, you might want to run %rehashx to update the persistent |
|
30 | 30 | alias table |
|
31 | 31 | * Macros are stored in raw format by default. That is, instead of |
|
32 | 32 | '_ip.system("cat foo"), the macro will contain text 'cat foo') |
|
33 | 33 | * Autocall is in full mode |
|
34 | 34 | * Calling "up" does "cd .." |
|
35 | 35 | |
|
36 | 36 | The 'sh' profile is different from the now-obsolete (and unavailable) |
|
37 | 37 | 'pysh' profile in that: |
|
38 | 38 | |
|
39 | 39 | * '$$var = command' and '$var = command' syntax is not supported |
|
40 | 40 | * anymore. Use 'var = !command' instead (incidentally, this is |
|
41 | 41 | * available in all IPython profiles). Note that !!command *will* |
|
42 | 42 | * work. |
|
43 | 43 | |
|
44 | 44 | Aliases |
|
45 | 45 | ======= |
|
46 | 46 | |
|
47 | 47 | All of your $PATH has been loaded as IPython aliases, so you should be |
|
48 | 48 | able to type any normal system command and have it executed. See |
|
49 | 49 | %alias? and %unalias? for details on the alias facilities. See also |
|
50 | 50 | %rehashx? for details on the mechanism used to load $PATH. |
|
51 | 51 | |
|
52 | 52 | |
|
53 | 53 | Directory management |
|
54 | 54 | ==================== |
|
55 | 55 | |
|
56 | 56 | Since each command passed by ipython to the underlying system is executed |
|
57 | 57 | in a subshell which exits immediately, you can NOT use !cd to navigate |
|
58 | 58 | the filesystem. |
|
59 | 59 | |
|
60 | 60 | IPython provides its own builtin '%cd' magic command to move in the |
|
61 | 61 | filesystem (the % is not required with automagic on). It also maintains |
|
62 | 62 | a list of visited directories (use %dhist to see it) and allows direct |
|
63 | 63 | switching to any of them. Type 'cd?' for more details. |
|
64 | 64 | |
|
65 | 65 | %pushd, %popd and %dirs are provided for directory stack handling. |
|
66 | 66 | |
|
67 | 67 | |
|
68 | 68 | Enabled extensions |
|
69 | 69 | ================== |
|
70 | 70 | |
|
71 | 71 | Some extensions, listed below, are enabled as default in this profile. |
|
72 | 72 | |
|
73 | 73 | envpersist |
|
74 | 74 | ---------- |
|
75 | 75 | |
|
76 | 76 | %env can be used to "remember" environment variable manipulations. Examples:: |
|
77 | 77 | |
|
78 | 78 | %env - Show all environment variables |
|
79 | 79 | %env VISUAL=jed - set VISUAL to jed |
|
80 | 80 | %env PATH+=;/foo - append ;foo to PATH |
|
81 | 81 | %env PATH+=;/bar - also append ;bar to PATH |
|
82 | 82 | %env PATH-=/wbin; - prepend /wbin; to PATH |
|
83 | 83 | %env -d VISUAL - forget VISUAL persistent val |
|
84 | 84 | %env -p - print all persistent env modifications |
|
85 | 85 | |
|
86 | 86 | ipy_which |
|
87 | 87 | --------- |
|
88 | 88 | |
|
89 | 89 | %which magic command. Like 'which' in unix, but knows about ipython aliases. |
|
90 | 90 | |
|
91 | 91 | Example:: |
|
92 | 92 | |
|
93 | 93 | [C:/ipython]|14> %which st |
|
94 | 94 | st -> start . |
|
95 | 95 | [C:/ipython]|15> %which d |
|
96 | 96 | d -> dir /w /og /on |
|
97 | 97 | [C:/ipython]|16> %which cp |
|
98 | 98 | cp -> cp |
|
99 | 99 | == c:\bin\cp.exe |
|
100 | 100 | c:\bin\cp.exe |
|
101 | 101 | |
|
102 | 102 | ipy_app_completers |
|
103 | 103 | ------------------ |
|
104 | 104 | |
|
105 | 105 | Custom tab completers for some apps like svn, hg, bzr, apt-get. Try 'apt-get install <TAB>' in debian/ubuntu. |
|
106 | 106 | |
|
107 | 107 | ipy_rehashdir |
|
108 | 108 | ------------- |
|
109 | 109 | |
|
110 | 110 | Allows you to add system command aliases for commands that are not along your path. Let's say that you just installed Putty and want to be able to invoke it without adding it to path, you can create the alias for it with rehashdir:: |
|
111 | 111 | |
|
112 | 112 | [~]|22> cd c:/opt/PuTTY/ |
|
113 | 113 | [c:opt/PuTTY]|23> rehashdir . |
|
114 | 114 | <23> ['pageant', 'plink', 'pscp', 'psftp', 'putty', 'puttygen', 'unins000'] |
|
115 | 115 | |
|
116 | 116 | Now, you can execute any of those commams directly:: |
|
117 | 117 | |
|
118 | 118 | [c:opt/PuTTY]|24> cd |
|
119 | 119 | [~]|25> putty |
|
120 | 120 | |
|
121 | 121 | (the putty window opens). |
|
122 | 122 | |
|
123 | 123 | If you want to store the alias so that it will always be available, do '%store putty'. If you want to %store all these aliases persistently, just do it in a for loop:: |
|
124 | 124 | |
|
125 | 125 | [~]|27> for a in _23: |
|
126 | 126 | |..> %store $a |
|
127 | 127 | |..> |
|
128 | 128 | |..> |
|
129 | 129 | Alias stored: pageant (0, 'c:\\opt\\PuTTY\\pageant.exe') |
|
130 | 130 | Alias stored: plink (0, 'c:\\opt\\PuTTY\\plink.exe') |
|
131 | 131 | Alias stored: pscp (0, 'c:\\opt\\PuTTY\\pscp.exe') |
|
132 | 132 | Alias stored: psftp (0, 'c:\\opt\\PuTTY\\psftp.exe') |
|
133 | 133 | ... |
|
134 | 134 | |
|
135 | 135 | mglob |
|
136 | 136 | ----- |
|
137 | 137 | |
|
138 | 138 | Provide the magic function %mglob, which makes it easier (than the 'find' command) to collect (possibly recursive) file lists. Examples:: |
|
139 | 139 | |
|
140 | 140 | [c:/ipython]|9> mglob *.py |
|
141 | 141 | [c:/ipython]|10> mglob *.py rec:*.txt |
|
142 | 142 | [c:/ipython]|19> workfiles = %mglob !.svn/ !.hg/ !*_Data/ !*.bak rec:. |
|
143 | 143 | |
|
144 | 144 | Note that the first 2 calls will put the file list in result history (_, _9, _10), and the last one will assign it to 'workfiles'. |
|
145 | 145 | |
|
146 | 146 | |
|
147 | 147 | Prompt customization |
|
148 | 148 | ==================== |
|
149 | 149 | |
|
150 | 150 | The sh profile uses the following prompt configurations:: |
|
151 | 151 | |
|
152 | 152 | o.prompt_in1= r'\C_LightBlue[\C_LightCyan\Y2\C_LightBlue]\C_Green|\#>' |
|
153 | 153 | o.prompt_in2= r'\C_Green|\C_LightGreen\D\C_Green>' |
|
154 | 154 | |
|
155 | 155 | You can change the prompt configuration to your liking by editing |
|
156 | 156 | ipy_user_conf.py. |
|
157 | 157 | |
|
158 | 158 | String lists |
|
159 | 159 | ============ |
|
160 | 160 | |
|
161 | 161 | String lists (IPython.genutils.SList) are handy way to process output |
|
162 | 162 | from system commands. They are produced by ``var = !cmd`` syntax. |
|
163 | 163 | |
|
164 | 164 | First, we acquire the output of 'ls -l':: |
|
165 | 165 | |
|
166 | 166 | [Q:doc/examples]|2> lines = !ls -l |
|
167 | 167 | == |
|
168 | 168 | ['total 23', |
|
169 | 169 | '-rw-rw-rw- 1 ville None 1163 Sep 30 2006 example-demo.py', |
|
170 | 170 | '-rw-rw-rw- 1 ville None 1927 Sep 30 2006 example-embed-short.py', |
|
171 | 171 | '-rwxrwxrwx 1 ville None 4606 Sep 1 17:15 example-embed.py', |
|
172 | 172 | '-rwxrwxrwx 1 ville None 1017 Sep 30 2006 example-gnuplot.py', |
|
173 | 173 | '-rwxrwxrwx 1 ville None 339 Jun 11 18:01 extension.py', |
|
174 | 174 | '-rwxrwxrwx 1 ville None 113 Dec 20 2006 seteditor.py', |
|
175 | 175 | '-rwxrwxrwx 1 ville None 245 Dec 12 2006 seteditor.pyc'] |
|
176 | 176 | |
|
177 | 177 | Now, let's take a look at the contents of 'lines' (the first number is |
|
178 | 178 | the list element number):: |
|
179 | 179 | |
|
180 | 180 | [Q:doc/examples]|3> lines |
|
181 | 181 | <3> SList (.p, .n, .l, .s, .grep(), .fields() available). Value: |
|
182 | 182 | |
|
183 | 183 | 0: total 23 |
|
184 | 184 | 1: -rw-rw-rw- 1 ville None 1163 Sep 30 2006 example-demo.py |
|
185 | 185 | 2: -rw-rw-rw- 1 ville None 1927 Sep 30 2006 example-embed-short.py |
|
186 | 186 | 3: -rwxrwxrwx 1 ville None 4606 Sep 1 17:15 example-embed.py |
|
187 | 187 | 4: -rwxrwxrwx 1 ville None 1017 Sep 30 2006 example-gnuplot.py |
|
188 | 188 | 5: -rwxrwxrwx 1 ville None 339 Jun 11 18:01 extension.py |
|
189 | 189 | 6: -rwxrwxrwx 1 ville None 113 Dec 20 2006 seteditor.py |
|
190 | 190 | 7: -rwxrwxrwx 1 ville None 245 Dec 12 2006 seteditor.pyc |
|
191 | 191 | |
|
192 | 192 | Now, let's filter out the 'embed' lines:: |
|
193 | 193 | |
|
194 | 194 | [Q:doc/examples]|4> l2 = lines.grep('embed',prune=1) |
|
195 | 195 | [Q:doc/examples]|5> l2 |
|
196 | 196 | <5> SList (.p, .n, .l, .s, .grep(), .fields() available). Value: |
|
197 | 197 | |
|
198 | 198 | 0: total 23 |
|
199 | 199 | 1: -rw-rw-rw- 1 ville None 1163 Sep 30 2006 example-demo.py |
|
200 | 200 | 2: -rwxrwxrwx 1 ville None 1017 Sep 30 2006 example-gnuplot.py |
|
201 | 201 | 3: -rwxrwxrwx 1 ville None 339 Jun 11 18:01 extension.py |
|
202 | 202 | 4: -rwxrwxrwx 1 ville None 113 Dec 20 2006 seteditor.py |
|
203 | 203 | 5: -rwxrwxrwx 1 ville None 245 Dec 12 2006 seteditor.pyc |
|
204 | 204 | |
|
205 | 205 | Now, we want strings having just file names and permissions:: |
|
206 | 206 | |
|
207 | 207 | [Q:doc/examples]|6> l2.fields(8,0) |
|
208 | 208 | <6> SList (.p, .n, .l, .s, .grep(), .fields() available). Value: |
|
209 | 209 | |
|
210 | 210 | 0: total |
|
211 | 211 | 1: example-demo.py -rw-rw-rw- |
|
212 | 212 | 2: example-gnuplot.py -rwxrwxrwx |
|
213 | 213 | 3: extension.py -rwxrwxrwx |
|
214 | 214 | 4: seteditor.py -rwxrwxrwx |
|
215 | 215 | 5: seteditor.pyc -rwxrwxrwx |
|
216 | 216 | |
|
217 | 217 | Note how the line with 'total' does not raise IndexError. |
|
218 | 218 | |
|
219 | 219 | If you want to split these (yielding lists), call fields() without |
|
220 | 220 | arguments:: |
|
221 | 221 | |
|
222 | 222 | [Q:doc/examples]|7> _.fields() |
|
223 | 223 | <7> |
|
224 | 224 | [['total'], |
|
225 | 225 | ['example-demo.py', '-rw-rw-rw-'], |
|
226 | 226 | ['example-gnuplot.py', '-rwxrwxrwx'], |
|
227 | 227 | ['extension.py', '-rwxrwxrwx'], |
|
228 | 228 | ['seteditor.py', '-rwxrwxrwx'], |
|
229 | 229 | ['seteditor.pyc', '-rwxrwxrwx']] |
|
230 | 230 | |
|
231 | 231 | If you want to pass these separated with spaces to a command (typical |
|
232 | 232 | for lists if files), use the .s property:: |
|
233 | 233 | |
|
234 | 234 | |
|
235 | 235 | [Q:doc/examples]|13> files = l2.fields(8).s |
|
236 | 236 | [Q:doc/examples]|14> files |
|
237 | 237 | <14> 'example-demo.py example-gnuplot.py extension.py seteditor.py seteditor.pyc' |
|
238 | 238 | [Q:doc/examples]|15> ls $files |
|
239 | 239 | example-demo.py example-gnuplot.py extension.py seteditor.py seteditor.pyc |
|
240 | 240 | |
|
241 | 241 | SLists are inherited from normal python lists, so every list method is |
|
242 | 242 | available:: |
|
243 | 243 | |
|
244 | 244 | [Q:doc/examples]|21> lines.append('hey') |
|
245 | 245 | |
|
246 | 246 | |
|
247 | 247 | Real world example: remove all files outside version control |
|
248 | 248 | ============================================================ |
|
249 | 249 | |
|
250 | 250 | First, capture output of "hg status":: |
|
251 | 251 | |
|
252 | 252 | [Q:/ipython]|28> out = !hg status |
|
253 | 253 | == |
|
254 |
['M IPython\\ |
|
|
255 |
'M IPython\\ |
|
|
254 | ['M IPython\\extensions\\ipy_kitcfg.py', | |
|
255 | 'M IPython\\extensions\\ipy_rehashdir.py', | |
|
256 | 256 | ... |
|
257 | 257 | '? build\\lib\\IPython\\Debugger.py', |
|
258 |
'? build\\lib\\IPython\\ |
|
|
259 |
'? build\\lib\\IPython\\ |
|
|
258 | '? build\\lib\\IPython\\extensions\\InterpreterExec.py', | |
|
259 | '? build\\lib\\IPython\\extensions\\InterpreterPasteInput.py', | |
|
260 | 260 | ... |
|
261 | 261 | |
|
262 | 262 | (lines starting with ? are not under version control). |
|
263 | 263 | |
|
264 | 264 | :: |
|
265 | 265 | |
|
266 | 266 | [Q:/ipython]|35> junk = out.grep(r'^\?').fields(1) |
|
267 | 267 | [Q:/ipython]|36> junk |
|
268 | 268 | <36> SList (.p, .n, .l, .s, .grep(), .fields() availab |
|
269 | 269 | ... |
|
270 | 270 | 10: build\bdist.win32\winexe\temp\_ctypes.py |
|
271 | 271 | 11: build\bdist.win32\winexe\temp\_hashlib.py |
|
272 | 272 | 12: build\bdist.win32\winexe\temp\_socket.py |
|
273 | 273 | |
|
274 | 274 | Now we can just remove these files by doing 'rm $junk.s'. |
|
275 | 275 | |
|
276 | 276 | The .s, .n, .p properties |
|
277 | 277 | ========================= |
|
278 | 278 | |
|
279 | 279 | The '.s' property returns one string where lines are separated by |
|
280 | 280 | single space (for convenient passing to system commands). The '.n' |
|
281 | 281 | property return one string where the lines are separated by '\n' |
|
282 | 282 | (i.e. the original output of the function). If the items in string |
|
283 | 283 | list are file names, '.p' can be used to get a list of "path" objects |
|
284 | 284 | for convenient file manipulation. No newline at end of file |
@@ -1,296 +1,296 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | |
|
3 | 3 | """ |
|
4 | 4 | This module defines the things that are used in setup.py for building IPython |
|
5 | 5 | |
|
6 | 6 | This includes: |
|
7 | 7 | |
|
8 | 8 | * The basic arguments to setup |
|
9 | 9 | * Functions for finding things like packages, package data, etc. |
|
10 | 10 | * A function for checking dependencies. |
|
11 | 11 | """ |
|
12 | 12 | |
|
13 | 13 | __docformat__ = "restructuredtext en" |
|
14 | 14 | |
|
15 | 15 | #------------------------------------------------------------------------------- |
|
16 | 16 | # Copyright (C) 2008 The IPython Development Team |
|
17 | 17 | # |
|
18 | 18 | # Distributed under the terms of the BSD License. The full license is in |
|
19 | 19 | # the file COPYING, distributed as part of this software. |
|
20 | 20 | #------------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | #------------------------------------------------------------------------------- |
|
23 | 23 | # Imports |
|
24 | 24 | #------------------------------------------------------------------------------- |
|
25 | 25 | |
|
26 | 26 | import os, sys |
|
27 | 27 | |
|
28 | 28 | from glob import glob |
|
29 | 29 | |
|
30 | 30 | from setupext import install_data_ext |
|
31 | 31 | |
|
32 | 32 | #------------------------------------------------------------------------------- |
|
33 | 33 | # Useful globals and utility functions |
|
34 | 34 | #------------------------------------------------------------------------------- |
|
35 | 35 | |
|
36 | 36 | # A few handy globals |
|
37 | 37 | isfile = os.path.isfile |
|
38 | 38 | pjoin = os.path.join |
|
39 | 39 | |
|
40 | 40 | def oscmd(s): |
|
41 | 41 | print ">", s |
|
42 | 42 | os.system(s) |
|
43 | 43 | |
|
44 | 44 | # A little utility we'll need below, since glob() does NOT allow you to do |
|
45 | 45 | # exclusion on multiple endings! |
|
46 | 46 | def file_doesnt_endwith(test,endings): |
|
47 | 47 | """Return true if test is a file and its name does NOT end with any |
|
48 | 48 | of the strings listed in endings.""" |
|
49 | 49 | if not isfile(test): |
|
50 | 50 | return False |
|
51 | 51 | for e in endings: |
|
52 | 52 | if test.endswith(e): |
|
53 | 53 | return False |
|
54 | 54 | return True |
|
55 | 55 | |
|
56 | 56 | #--------------------------------------------------------------------------- |
|
57 | 57 | # Basic project information |
|
58 | 58 | #--------------------------------------------------------------------------- |
|
59 | 59 | |
|
60 | 60 | # Release.py contains version, authors, license, url, keywords, etc. |
|
61 | 61 | execfile(pjoin('IPython','core','release.py')) |
|
62 | 62 | |
|
63 | 63 | # Create a dict with the basic information |
|
64 | 64 | # This dict is eventually passed to setup after additional keys are added. |
|
65 | 65 | setup_args = dict( |
|
66 | 66 | name = name, |
|
67 | 67 | version = version, |
|
68 | 68 | description = description, |
|
69 | 69 | long_description = long_description, |
|
70 | 70 | author = author, |
|
71 | 71 | author_email = author_email, |
|
72 | 72 | url = url, |
|
73 | 73 | download_url = download_url, |
|
74 | 74 | license = license, |
|
75 | 75 | platforms = platforms, |
|
76 | 76 | keywords = keywords, |
|
77 | 77 | cmdclass = {'install_data': install_data_ext}, |
|
78 | 78 | ) |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | #--------------------------------------------------------------------------- |
|
82 | 82 | # Find packages |
|
83 | 83 | #--------------------------------------------------------------------------- |
|
84 | 84 | |
|
85 | 85 | def add_package(packages,pname,config=False,tests=False,scripts=False, |
|
86 | 86 | others=None): |
|
87 | 87 | """ |
|
88 | 88 | Add a package to the list of packages, including certain subpackages. |
|
89 | 89 | """ |
|
90 | 90 | packages.append('.'.join(['IPython',pname])) |
|
91 | 91 | if config: |
|
92 | 92 | packages.append('.'.join(['IPython',pname,'config'])) |
|
93 | 93 | if tests: |
|
94 | 94 | packages.append('.'.join(['IPython',pname,'tests'])) |
|
95 | 95 | if scripts: |
|
96 | 96 | packages.append('.'.join(['IPython',pname,'scripts'])) |
|
97 | 97 | if others is not None: |
|
98 | 98 | for o in others: |
|
99 | 99 | packages.append('.'.join(['IPython',pname,o])) |
|
100 | 100 | |
|
101 | 101 | def find_packages(): |
|
102 | 102 | """ |
|
103 | 103 | Find all of IPython's packages. |
|
104 | 104 | """ |
|
105 | 105 | packages = ['IPython'] |
|
106 | 106 | add_package(packages, 'config', tests=True) |
|
107 | 107 | add_package(packages, 'config.userconfig') |
|
108 | 108 | add_package(packages, 'core', tests=True) |
|
109 | 109 | add_package(packages, 'deathrow', tests=True) |
|
110 |
add_package(packages , ' |
|
|
110 | add_package(packages , 'extensions') | |
|
111 | 111 | add_package(packages, 'external') |
|
112 | 112 | add_package(packages, 'frontend', tests=True) |
|
113 | 113 | # Don't include the cocoa frontend for now as it is not stable |
|
114 | 114 | if sys.platform == 'darwin' and False: |
|
115 | 115 | add_package(packages, 'frontend.cocoa', tests=True, others=['plugin']) |
|
116 | 116 | add_package(packages, 'frontend.cocoa.examples') |
|
117 | 117 | add_package(packages, 'frontend.cocoa.examples.IPython1Sandbox') |
|
118 | 118 | add_package(packages, 'frontend.cocoa.examples.IPython1Sandbox.English.lproj') |
|
119 | 119 | add_package(packages, 'frontend.process') |
|
120 | 120 | add_package(packages, 'frontend.wx') |
|
121 | 121 | add_package(packages, 'gui') |
|
122 | 122 | add_package(packages, 'gui.wx') |
|
123 | 123 | add_package(packages, 'kernel', config=True, tests=True, scripts=True) |
|
124 | 124 | add_package(packages, 'kernel.core', config=True, tests=True) |
|
125 | 125 | add_package(packages, 'lib', tests=True) |
|
126 | 126 | add_package(packages, 'quarantine', tests=True) |
|
127 | 127 | add_package(packages, 'scripts') |
|
128 | 128 | add_package(packages, 'testing', tests=True) |
|
129 | 129 | add_package(packages, 'testing.plugin', tests=False) |
|
130 | 130 | add_package(packages, 'utils', tests=True) |
|
131 | 131 | return packages |
|
132 | 132 | |
|
133 | 133 | #--------------------------------------------------------------------------- |
|
134 | 134 | # Find package data |
|
135 | 135 | #--------------------------------------------------------------------------- |
|
136 | 136 | |
|
137 | 137 | def find_package_data(): |
|
138 | 138 | """ |
|
139 | 139 | Find IPython's package_data. |
|
140 | 140 | """ |
|
141 | 141 | # This is not enough for these things to appear in an sdist. |
|
142 | 142 | # We need to muck with the MANIFEST to get this to work |
|
143 | 143 | package_data = { |
|
144 | 144 | 'IPython.config.userconfig' : ['*'], |
|
145 | 145 | 'IPython.testing' : ['*.txt'] |
|
146 | 146 | } |
|
147 | 147 | return package_data |
|
148 | 148 | |
|
149 | 149 | |
|
150 | 150 | #--------------------------------------------------------------------------- |
|
151 | 151 | # Find data files |
|
152 | 152 | #--------------------------------------------------------------------------- |
|
153 | 153 | |
|
154 | 154 | def make_dir_struct(tag,base,out_base): |
|
155 | 155 | """Make the directory structure of all files below a starting dir. |
|
156 | 156 | |
|
157 | 157 | This is just a convenience routine to help build a nested directory |
|
158 | 158 | hierarchy because distutils is too stupid to do this by itself. |
|
159 | 159 | |
|
160 | 160 | XXX - this needs a proper docstring! |
|
161 | 161 | """ |
|
162 | 162 | |
|
163 | 163 | # we'll use these a lot below |
|
164 | 164 | lbase = len(base) |
|
165 | 165 | pathsep = os.path.sep |
|
166 | 166 | lpathsep = len(pathsep) |
|
167 | 167 | |
|
168 | 168 | out = [] |
|
169 | 169 | for (dirpath,dirnames,filenames) in os.walk(base): |
|
170 | 170 | # we need to strip out the dirpath from the base to map it to the |
|
171 | 171 | # output (installation) path. This requires possibly stripping the |
|
172 | 172 | # path separator, because otherwise pjoin will not work correctly |
|
173 | 173 | # (pjoin('foo/','/bar') returns '/bar'). |
|
174 | 174 | |
|
175 | 175 | dp_eff = dirpath[lbase:] |
|
176 | 176 | if dp_eff.startswith(pathsep): |
|
177 | 177 | dp_eff = dp_eff[lpathsep:] |
|
178 | 178 | # The output path must be anchored at the out_base marker |
|
179 | 179 | out_path = pjoin(out_base,dp_eff) |
|
180 | 180 | # Now we can generate the final filenames. Since os.walk only produces |
|
181 | 181 | # filenames, we must join back with the dirpath to get full valid file |
|
182 | 182 | # paths: |
|
183 | 183 | pfiles = [pjoin(dirpath,f) for f in filenames] |
|
184 | 184 | # Finally, generate the entry we need, which is a triple of (tag,output |
|
185 | 185 | # path, files) for use as a data_files parameter in install_data. |
|
186 | 186 | out.append((tag,out_path,pfiles)) |
|
187 | 187 | |
|
188 | 188 | return out |
|
189 | 189 | |
|
190 | 190 | |
|
191 | 191 | def find_data_files(): |
|
192 | 192 | """ |
|
193 | 193 | Find IPython's data_files. |
|
194 | 194 | |
|
195 | 195 | Most of these are docs. |
|
196 | 196 | """ |
|
197 | 197 | |
|
198 | 198 | docdirbase = pjoin('share', 'doc', 'ipython') |
|
199 | 199 | manpagebase = pjoin('share', 'man', 'man1') |
|
200 | 200 | |
|
201 | 201 | # Simple file lists can be made by hand |
|
202 | 202 | manpages = filter(isfile, glob(pjoin('docs','man','*.1.gz'))) |
|
203 |
igridhelpfiles = filter(isfile, glob(pjoin('IPython',' |
|
|
203 | igridhelpfiles = filter(isfile, glob(pjoin('IPython','extensions','igrid_help.*'))) | |
|
204 | 204 | |
|
205 | 205 | # For nested structures, use the utility above |
|
206 | 206 | example_files = make_dir_struct( |
|
207 | 207 | 'data', |
|
208 | 208 | pjoin('docs','examples'), |
|
209 | 209 | pjoin(docdirbase,'examples') |
|
210 | 210 | ) |
|
211 | 211 | manual_files = make_dir_struct( |
|
212 | 212 | 'data', |
|
213 | 213 | pjoin('docs','dist'), |
|
214 | 214 | pjoin(docdirbase,'manual') |
|
215 | 215 | ) |
|
216 | 216 | |
|
217 | 217 | # And assemble the entire output list |
|
218 | 218 | data_files = [ ('data',manpagebase, manpages), |
|
219 | 219 | ('data',pjoin(docdirbase,'extensions'),igridhelpfiles), |
|
220 | 220 | ] + manual_files + example_files |
|
221 | 221 | |
|
222 | 222 | ## import pprint # dbg |
|
223 | 223 | ## print '*'*80 |
|
224 | 224 | ## print 'data files' |
|
225 | 225 | ## pprint.pprint(data_files) |
|
226 | 226 | ## print '*'*80 |
|
227 | 227 | |
|
228 | 228 | return data_files |
|
229 | 229 | |
|
230 | 230 | #--------------------------------------------------------------------------- |
|
231 | 231 | # Find scripts |
|
232 | 232 | #--------------------------------------------------------------------------- |
|
233 | 233 | |
|
234 | 234 | def find_scripts(): |
|
235 | 235 | """ |
|
236 | 236 | Find IPython's scripts. |
|
237 | 237 | """ |
|
238 | 238 | kernel_scripts = pjoin('IPython','kernel','scripts') |
|
239 | 239 | main_scripts = pjoin('IPython','scripts') |
|
240 | 240 | scripts = [pjoin(kernel_scripts, 'ipengine'), |
|
241 | 241 | pjoin(kernel_scripts, 'ipcontroller'), |
|
242 | 242 | pjoin(kernel_scripts, 'ipcluster'), |
|
243 | 243 | pjoin(main_scripts, 'ipython'), |
|
244 | 244 | pjoin(main_scripts, 'ipythonx'), |
|
245 | 245 | pjoin(main_scripts, 'ipython-wx'), |
|
246 | 246 | pjoin(main_scripts, 'pycolor'), |
|
247 | 247 | pjoin(main_scripts, 'irunner'), |
|
248 | 248 | pjoin(main_scripts, 'iptest') |
|
249 | 249 | ] |
|
250 | 250 | |
|
251 | 251 | # Script to be run by the windows binary installer after the default setup |
|
252 | 252 | # routine, to add shortcuts and similar windows-only things. Windows |
|
253 | 253 | # post-install scripts MUST reside in the scripts/ dir, otherwise distutils |
|
254 | 254 | # doesn't find them. |
|
255 | 255 | if 'bdist_wininst' in sys.argv: |
|
256 | 256 | if len(sys.argv) > 2 and ('sdist' in sys.argv or 'bdist_rpm' in sys.argv): |
|
257 | 257 | print >> sys.stderr,"ERROR: bdist_wininst must be run alone. Exiting." |
|
258 | 258 | sys.exit(1) |
|
259 | 259 | scripts.append(pjoin('scripts','ipython_win_post_install.py')) |
|
260 | 260 | |
|
261 | 261 | return scripts |
|
262 | 262 | |
|
263 | 263 | #--------------------------------------------------------------------------- |
|
264 | 264 | # Verify all dependencies |
|
265 | 265 | #--------------------------------------------------------------------------- |
|
266 | 266 | |
|
267 | 267 | def check_for_dependencies(): |
|
268 | 268 | """Check for IPython's dependencies. |
|
269 | 269 | |
|
270 | 270 | This function should NOT be called if running under setuptools! |
|
271 | 271 | """ |
|
272 | 272 | from setupext.setupext import ( |
|
273 | 273 | print_line, print_raw, print_status, print_message, |
|
274 | 274 | check_for_zopeinterface, check_for_twisted, |
|
275 | 275 | check_for_foolscap, check_for_pyopenssl, |
|
276 | 276 | check_for_sphinx, check_for_pygments, |
|
277 | 277 | check_for_nose, check_for_pexpect |
|
278 | 278 | ) |
|
279 | 279 | print_line() |
|
280 | 280 | print_raw("BUILDING IPYTHON") |
|
281 | 281 | print_status('python', sys.version) |
|
282 | 282 | print_status('platform', sys.platform) |
|
283 | 283 | if sys.platform == 'win32': |
|
284 | 284 | print_status('Windows version', sys.getwindowsversion()) |
|
285 | 285 | |
|
286 | 286 | print_raw("") |
|
287 | 287 | print_raw("OPTIONAL DEPENDENCIES") |
|
288 | 288 | |
|
289 | 289 | check_for_zopeinterface() |
|
290 | 290 | check_for_twisted() |
|
291 | 291 | check_for_foolscap() |
|
292 | 292 | check_for_pyopenssl() |
|
293 | 293 | check_for_sphinx() |
|
294 | 294 | check_for_pygments() |
|
295 | 295 | check_for_nose() |
|
296 | 296 | check_for_pexpect() |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
General Comments 0
You need to be logged in to leave comments.
Login now