Show More
@@ -1,254 +1,254 b'' | |||
|
1 | 1 | """Tests for the key interactiveshell module, where the main ipython class is defined. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Module imports |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | |
|
7 | 7 | # third party |
|
8 | 8 | import nose.tools as nt |
|
9 | 9 | |
|
10 | 10 | # our own packages |
|
11 | 11 | from IPython.testing.globalipapp import get_ipython |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Globals |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | # Get the public instance of IPython |
|
18 | 18 | ip = get_ipython() |
|
19 | 19 | |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | # Test functions |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | |
|
24 | 24 | def test_reset(): |
|
25 | 25 | """reset must clear most namespaces.""" |
|
26 | 26 | |
|
27 | 27 | # Check that reset runs without error |
|
28 | 28 | ip.reset() |
|
29 | 29 | |
|
30 | 30 | # Once we've reset it (to clear of any junk that might have been there from |
|
31 | 31 | # other tests, we can count how many variables are in the user's namespace |
|
32 | 32 | nvars_user_ns = len(ip.user_ns) |
|
33 | 33 | nvars_hidden = len(ip.user_ns_hidden) |
|
34 | 34 | |
|
35 | 35 | # Now add a few variables to user_ns, and check that reset clears them |
|
36 | 36 | ip.user_ns['x'] = 1 |
|
37 | 37 | ip.user_ns['y'] = 1 |
|
38 | 38 | ip.reset() |
|
39 | 39 | |
|
40 | 40 | # Finally, check that all namespaces have only as many variables as we |
|
41 | 41 | # expect to find in them: |
|
42 | 42 | nt.assert_equal(len(ip.user_ns), nvars_user_ns) |
|
43 | 43 | nt.assert_equal(len(ip.user_ns_hidden), nvars_hidden) |
|
44 | 44 | |
|
45 | 45 | |
|
46 | 46 | # Tests for reporting of exceptions in various modes, handling of SystemExit, |
|
47 | 47 | # and %tb functionality. This is really a mix of testing ultraTB and interactiveshell. |
|
48 | 48 | |
|
49 | 49 | def doctest_tb_plain(): |
|
50 | 50 | """ |
|
51 | 51 | In [18]: xmode plain |
|
52 | 52 | Exception reporting mode: Plain |
|
53 | 53 | |
|
54 | 54 | In [19]: run simpleerr.py |
|
55 | 55 | Traceback (most recent call last): |
|
56 | 56 | ...line 32, in <module> |
|
57 | 57 | bar(mode) |
|
58 | 58 | ...line 16, in bar |
|
59 | 59 | div0() |
|
60 | 60 | ...line 8, in div0 |
|
61 | 61 | x/y |
|
62 | 62 | ZeroDivisionError: ... |
|
63 | 63 | """ |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | def doctest_tb_context(): |
|
67 | 67 | """ |
|
68 | 68 | In [3]: xmode context |
|
69 | 69 | Exception reporting mode: Context |
|
70 | 70 | |
|
71 | 71 | In [4]: run simpleerr.py |
|
72 | 72 | --------------------------------------------------------------------------- |
|
73 | 73 | ZeroDivisionError Traceback (most recent call last) |
|
74 | 74 | <BLANKLINE> |
|
75 |
... in <module> |
|
|
75 | ... in <module> | |
|
76 | 76 | 30 mode = 'div' |
|
77 | 77 | 31 |
|
78 | 78 | ---> 32 bar(mode) |
|
79 | 79 | <BLANKLINE> |
|
80 | 80 | ... in bar(mode) |
|
81 | 81 | 14 "bar" |
|
82 | 82 | 15 if mode=='div': |
|
83 | 83 | ---> 16 div0() |
|
84 | 84 | 17 elif mode=='exit': |
|
85 | 85 | 18 try: |
|
86 | 86 | <BLANKLINE> |
|
87 | 87 | ... in div0() |
|
88 | 88 | 6 x = 1 |
|
89 | 89 | 7 y = 0 |
|
90 | 90 | ----> 8 x/y |
|
91 | 91 | 9 |
|
92 | 92 | 10 def sysexit(stat, mode): |
|
93 | 93 | <BLANKLINE> |
|
94 | 94 | ZeroDivisionError: ... |
|
95 | 95 | """ |
|
96 | 96 | |
|
97 | 97 | |
|
98 | 98 | def doctest_tb_verbose(): |
|
99 | 99 | """ |
|
100 | 100 | In [5]: xmode verbose |
|
101 | 101 | Exception reporting mode: Verbose |
|
102 | 102 | |
|
103 | 103 | In [6]: run simpleerr.py |
|
104 | 104 | --------------------------------------------------------------------------- |
|
105 | 105 | ZeroDivisionError Traceback (most recent call last) |
|
106 | 106 | <BLANKLINE> |
|
107 |
... in <module> |
|
|
107 | ... in <module> | |
|
108 | 108 | 30 mode = 'div' |
|
109 | 109 | 31 |
|
110 | 110 | ---> 32 bar(mode) |
|
111 | 111 | global bar = <function bar at ...> |
|
112 | 112 | global mode = 'div' |
|
113 | 113 | <BLANKLINE> |
|
114 | 114 | ... in bar(mode='div') |
|
115 | 115 | 14 "bar" |
|
116 | 116 | 15 if mode=='div': |
|
117 | 117 | ---> 16 div0() |
|
118 | 118 | global div0 = <function div0 at ...> |
|
119 | 119 | 17 elif mode=='exit': |
|
120 | 120 | 18 try: |
|
121 | 121 | <BLANKLINE> |
|
122 | 122 | ... in div0() |
|
123 | 123 | 6 x = 1 |
|
124 | 124 | 7 y = 0 |
|
125 | 125 | ----> 8 x/y |
|
126 | 126 | x = 1 |
|
127 | 127 | y = 0 |
|
128 | 128 | 9 |
|
129 | 129 | 10 def sysexit(stat, mode): |
|
130 | 130 | <BLANKLINE> |
|
131 | 131 | ZeroDivisionError: ... |
|
132 | 132 | """ |
|
133 | 133 | |
|
134 | 134 | def doctest_tb_sysexit(): |
|
135 | 135 | """ |
|
136 | 136 | In [17]: %xmode plain |
|
137 | 137 | Exception reporting mode: Plain |
|
138 | 138 | |
|
139 | 139 | In [18]: %run simpleerr.py exit |
|
140 | 140 | An exception has occurred, use %tb to see the full traceback. |
|
141 | 141 | SystemExit: (1, 'Mode = exit') |
|
142 | 142 | |
|
143 | 143 | In [19]: %run simpleerr.py exit 2 |
|
144 | 144 | An exception has occurred, use %tb to see the full traceback. |
|
145 | 145 | SystemExit: (2, 'Mode = exit') |
|
146 | 146 | |
|
147 | 147 | In [20]: %tb |
|
148 | 148 | Traceback (most recent call last): |
|
149 | 149 | File ... in <module> |
|
150 | 150 | bar(mode) |
|
151 | 151 | File ... line 22, in bar |
|
152 | 152 | sysexit(stat, mode) |
|
153 | 153 | File ... line 11, in sysexit |
|
154 | 154 | raise SystemExit(stat, 'Mode = %s' % mode) |
|
155 | 155 | SystemExit: (2, 'Mode = exit') |
|
156 | 156 | |
|
157 | 157 | In [21]: %xmode context |
|
158 | 158 | Exception reporting mode: Context |
|
159 | 159 | |
|
160 | 160 | In [22]: %tb |
|
161 | 161 | --------------------------------------------------------------------------- |
|
162 | 162 | SystemExit Traceback (most recent call last) |
|
163 | 163 | <BLANKLINE> |
|
164 |
...<module> |
|
|
164 | ...<module> | |
|
165 | 165 | 30 mode = 'div' |
|
166 | 166 | 31 |
|
167 | 167 | ---> 32 bar(mode) |
|
168 | 168 | <BLANKLINE> |
|
169 | 169 | ...bar(mode) |
|
170 | 170 | 20 except: |
|
171 | 171 | 21 stat = 1 |
|
172 | 172 | ---> 22 sysexit(stat, mode) |
|
173 | 173 | 23 else: |
|
174 | 174 | 24 raise ValueError('Unknown mode') |
|
175 | 175 | <BLANKLINE> |
|
176 | 176 | ...sysexit(stat, mode) |
|
177 | 177 | 9 |
|
178 | 178 | 10 def sysexit(stat, mode): |
|
179 | 179 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) |
|
180 | 180 | 12 |
|
181 | 181 | 13 def bar(mode): |
|
182 | 182 | <BLANKLINE> |
|
183 | 183 | SystemExit: (2, 'Mode = exit') |
|
184 | 184 | |
|
185 | 185 | In [23]: %xmode verbose |
|
186 | 186 | Exception reporting mode: Verbose |
|
187 | 187 | |
|
188 | 188 | In [24]: %tb |
|
189 | 189 | --------------------------------------------------------------------------- |
|
190 | 190 | SystemExit Traceback (most recent call last) |
|
191 | 191 | <BLANKLINE> |
|
192 |
... in <module> |
|
|
192 | ... in <module> | |
|
193 | 193 | 30 mode = 'div' |
|
194 | 194 | 31 |
|
195 | 195 | ---> 32 bar(mode) |
|
196 | 196 | global bar = <function bar at ...> |
|
197 | 197 | global mode = 'exit' |
|
198 | 198 | <BLANKLINE> |
|
199 | 199 | ... in bar(mode='exit') |
|
200 | 200 | 20 except: |
|
201 | 201 | 21 stat = 1 |
|
202 | 202 | ---> 22 sysexit(stat, mode) |
|
203 | 203 | global sysexit = <function sysexit at ...> |
|
204 | 204 | stat = 2 |
|
205 | 205 | mode = 'exit' |
|
206 | 206 | 23 else: |
|
207 | 207 | 24 raise ValueError('Unknown mode') |
|
208 | 208 | <BLANKLINE> |
|
209 | 209 | ... in sysexit(stat=2, mode='exit') |
|
210 | 210 | 9 |
|
211 | 211 | 10 def sysexit(stat, mode): |
|
212 | 212 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) |
|
213 | 213 | global SystemExit = undefined |
|
214 | 214 | stat = 2 |
|
215 | 215 | mode = 'exit' |
|
216 | 216 | 12 |
|
217 | 217 | 13 def bar(mode): |
|
218 | 218 | <BLANKLINE> |
|
219 | 219 | SystemExit: (2, 'Mode = exit') |
|
220 | 220 | """ |
|
221 | 221 | |
|
222 | 222 | |
|
223 | 223 | def test_run_cell(): |
|
224 | 224 | import textwrap |
|
225 | 225 | ip.run_cell('a = 10\na+=1') |
|
226 | 226 | ip.run_cell('assert a == 11\nassert 1') |
|
227 | 227 | |
|
228 | 228 | nt.assert_equal(ip.user_ns['a'], 11) |
|
229 | 229 | complex = textwrap.dedent(""" |
|
230 | 230 | if 1: |
|
231 | 231 | print "hello" |
|
232 | 232 | if 1: |
|
233 | 233 | print "world" |
|
234 | 234 | |
|
235 | 235 | if 2: |
|
236 | 236 | print "foo" |
|
237 | 237 | |
|
238 | 238 | if 3: |
|
239 | 239 | print "bar" |
|
240 | 240 | |
|
241 | 241 | if 4: |
|
242 | 242 | print "bar" |
|
243 | 243 | |
|
244 | 244 | """) |
|
245 | 245 | # Simply verifies that this kind of input is run |
|
246 | 246 | ip.run_cell(complex) |
|
247 | 247 | |
|
248 | 248 | |
|
249 | 249 | def test_db(): |
|
250 | 250 | """Test the internal database used for variable persistence.""" |
|
251 | 251 | ip.db['__unittest_'] = 12 |
|
252 | 252 | nt.assert_equal(ip.db['__unittest_'], 12) |
|
253 | 253 | del ip.db['__unittest_'] |
|
254 | 254 | assert '__unittest_' not in ip.db |
@@ -1,1458 +1,1460 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | Verbose and colourful traceback formatting. |
|
4 | 4 | |
|
5 | 5 | **ColorTB** |
|
6 | 6 | |
|
7 | 7 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
8 | 8 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
9 | 9 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
10 | 10 | text editor. |
|
11 | 11 | |
|
12 | 12 | Installation instructions for ColorTB:: |
|
13 | 13 | |
|
14 | 14 | import sys,ultratb |
|
15 | 15 | sys.excepthook = ultratb.ColorTB() |
|
16 | 16 | |
|
17 | 17 | **VerboseTB** |
|
18 | 18 | |
|
19 | 19 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
20 | 20 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
21 | 21 | and intended it for CGI programmers, but why should they have all the fun? I |
|
22 | 22 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
23 | 23 | but kind of neat, and maybe useful for long-running programs that you believe |
|
24 | 24 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
25 | 25 | Give it a shot--you'll love it or you'll hate it. |
|
26 | 26 | |
|
27 | 27 | .. note:: |
|
28 | 28 | |
|
29 | 29 | The Verbose mode prints the variables currently visible where the exception |
|
30 | 30 | happened (shortening their strings if too long). This can potentially be |
|
31 | 31 | very slow, if you happen to have a huge data structure whose string |
|
32 | 32 | representation is complex to compute. Your computer may appear to freeze for |
|
33 | 33 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
34 | 34 | with Ctrl-C (maybe hitting it more than once). |
|
35 | 35 | |
|
36 | 36 | If you encounter this kind of situation often, you may want to use the |
|
37 | 37 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
38 | 38 | variables (but otherwise includes the information and context given by |
|
39 | 39 | Verbose). |
|
40 | 40 | |
|
41 | 41 | .. note:: |
|
42 | 42 | |
|
43 | 43 | The verbose mode print all variables in the stack, which means it can |
|
44 | 44 | potentially leak sensitive information like access keys, or unencryted |
|
45 | 45 | password. |
|
46 | 46 | |
|
47 | 47 | Installation instructions for VerboseTB:: |
|
48 | 48 | |
|
49 | 49 | import sys,ultratb |
|
50 | 50 | sys.excepthook = ultratb.VerboseTB() |
|
51 | 51 | |
|
52 | 52 | Note: Much of the code in this module was lifted verbatim from the standard |
|
53 | 53 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
54 | 54 | |
|
55 | 55 | Color schemes |
|
56 | 56 | ------------- |
|
57 | 57 | |
|
58 | 58 | The colors are defined in the class TBTools through the use of the |
|
59 | 59 | ColorSchemeTable class. Currently the following exist: |
|
60 | 60 | |
|
61 | 61 | - NoColor: allows all of this module to be used in any terminal (the color |
|
62 | 62 | escapes are just dummy blank strings). |
|
63 | 63 | |
|
64 | 64 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
65 | 65 | or very dark background). |
|
66 | 66 | |
|
67 | 67 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
68 | 68 | in light background terminals. |
|
69 | 69 | |
|
70 | 70 | - Neutral: a neutral color scheme that should be readable on both light and |
|
71 | 71 | dark background |
|
72 | 72 | |
|
73 | 73 | You can implement other color schemes easily, the syntax is fairly |
|
74 | 74 | self-explanatory. Please send back new schemes you develop to the author for |
|
75 | 75 | possible inclusion in future releases. |
|
76 | 76 | |
|
77 | 77 | Inheritance diagram: |
|
78 | 78 | |
|
79 | 79 | .. inheritance-diagram:: IPython.core.ultratb |
|
80 | 80 | :parts: 3 |
|
81 | 81 | """ |
|
82 | 82 | |
|
83 | 83 | #***************************************************************************** |
|
84 | 84 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
85 | 85 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
86 | 86 | # |
|
87 | 87 | # Distributed under the terms of the BSD License. The full license is in |
|
88 | 88 | # the file COPYING, distributed as part of this software. |
|
89 | 89 | #***************************************************************************** |
|
90 | 90 | |
|
91 | 91 | |
|
92 | 92 | import dis |
|
93 | 93 | import inspect |
|
94 | 94 | import keyword |
|
95 | 95 | import linecache |
|
96 | 96 | import os |
|
97 | 97 | import pydoc |
|
98 | 98 | import re |
|
99 | 99 | import sys |
|
100 | 100 | import time |
|
101 | 101 | import tokenize |
|
102 | 102 | import traceback |
|
103 | 103 | |
|
104 | 104 | try: # Python 2 |
|
105 | 105 | generate_tokens = tokenize.generate_tokens |
|
106 | 106 | except AttributeError: # Python 3 |
|
107 | 107 | generate_tokens = tokenize.tokenize |
|
108 | 108 | |
|
109 | 109 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
110 | 110 | from inspect import getsourcefile, getfile, getmodule, \ |
|
111 | 111 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
112 | 112 | |
|
113 | 113 | # IPython's own modules |
|
114 | 114 | from IPython import get_ipython |
|
115 | 115 | from IPython.core import debugger |
|
116 | 116 | from IPython.core.display_trap import DisplayTrap |
|
117 | 117 | from IPython.core.excolors import exception_colors |
|
118 | 118 | from IPython.utils import PyColorize |
|
119 | 119 | from IPython.utils import openpy |
|
120 | 120 | from IPython.utils import path as util_path |
|
121 | 121 | from IPython.utils import py3compat |
|
122 | 122 | from IPython.utils.data import uniq_stable |
|
123 | 123 | from IPython.utils.terminal import get_terminal_size |
|
124 | 124 | |
|
125 | 125 | from logging import info, error, debug |
|
126 | 126 | |
|
127 | 127 | import IPython.utils.colorable as colorable |
|
128 | 128 | |
|
129 | 129 | # Globals |
|
130 | 130 | # amount of space to put line numbers before verbose tracebacks |
|
131 | 131 | INDENT_SIZE = 8 |
|
132 | 132 | |
|
133 | 133 | # Default color scheme. This is used, for example, by the traceback |
|
134 | 134 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
135 | 135 | # value is used, but having a module global makes this functionality available |
|
136 | 136 | # to users of ultratb who are NOT running inside ipython. |
|
137 | 137 | DEFAULT_SCHEME = 'NoColor' |
|
138 | 138 | |
|
139 | 139 | # --------------------------------------------------------------------------- |
|
140 | 140 | # Code begins |
|
141 | 141 | |
|
142 | 142 | # Utility functions |
|
143 | 143 | def inspect_error(): |
|
144 | 144 | """Print a message about internal inspect errors. |
|
145 | 145 | |
|
146 | 146 | These are unfortunately quite common.""" |
|
147 | 147 | |
|
148 | 148 | error('Internal Python error in the inspect module.\n' |
|
149 | 149 | 'Below is the traceback from this internal error.\n') |
|
150 | 150 | |
|
151 | 151 | |
|
152 | 152 | # This function is a monkeypatch we apply to the Python inspect module. We have |
|
153 | 153 | # now found when it's needed (see discussion on issue gh-1456), and we have a |
|
154 | 154 | # test case (IPython.core.tests.test_ultratb.ChangedPyFileTest) that fails if |
|
155 | 155 | # the monkeypatch is not applied. TK, Aug 2012. |
|
156 | 156 | def findsource(object): |
|
157 | 157 | """Return the entire source file and starting line number for an object. |
|
158 | 158 | |
|
159 | 159 | The argument may be a module, class, method, function, traceback, frame, |
|
160 | 160 | or code object. The source code is returned as a list of all the lines |
|
161 | 161 | in the file and the line number indexes a line in that list. An IOError |
|
162 | 162 | is raised if the source code cannot be retrieved. |
|
163 | 163 | |
|
164 | 164 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
165 | 165 | |
|
166 | 166 | file = getsourcefile(object) or getfile(object) |
|
167 | 167 | # If the object is a frame, then trying to get the globals dict from its |
|
168 | 168 | # module won't work. Instead, the frame object itself has the globals |
|
169 | 169 | # dictionary. |
|
170 | 170 | globals_dict = None |
|
171 | 171 | if inspect.isframe(object): |
|
172 | 172 | # XXX: can this ever be false? |
|
173 | 173 | globals_dict = object.f_globals |
|
174 | 174 | else: |
|
175 | 175 | module = getmodule(object, file) |
|
176 | 176 | if module: |
|
177 | 177 | globals_dict = module.__dict__ |
|
178 | 178 | lines = linecache.getlines(file, globals_dict) |
|
179 | 179 | if not lines: |
|
180 | 180 | raise IOError('could not get source code') |
|
181 | 181 | |
|
182 | 182 | if ismodule(object): |
|
183 | 183 | return lines, 0 |
|
184 | 184 | |
|
185 | 185 | if isclass(object): |
|
186 | 186 | name = object.__name__ |
|
187 | 187 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
188 | 188 | # make some effort to find the best matching class definition: |
|
189 | 189 | # use the one with the least indentation, which is the one |
|
190 | 190 | # that's most probably not inside a function definition. |
|
191 | 191 | candidates = [] |
|
192 | 192 | for i, line in enumerate(lines): |
|
193 | 193 | match = pat.match(line) |
|
194 | 194 | if match: |
|
195 | 195 | # if it's at toplevel, it's already the best one |
|
196 | 196 | if line[0] == 'c': |
|
197 | 197 | return lines, i |
|
198 | 198 | # else add whitespace to candidate list |
|
199 | 199 | candidates.append((match.group(1), i)) |
|
200 | 200 | if candidates: |
|
201 | 201 | # this will sort by whitespace, and by line number, |
|
202 | 202 | # less whitespace first |
|
203 | 203 | candidates.sort() |
|
204 | 204 | return lines, candidates[0][1] |
|
205 | 205 | else: |
|
206 | 206 | raise IOError('could not find class definition') |
|
207 | 207 | |
|
208 | 208 | if ismethod(object): |
|
209 | 209 | object = object.__func__ |
|
210 | 210 | if isfunction(object): |
|
211 | 211 | object = object.__code__ |
|
212 | 212 | if istraceback(object): |
|
213 | 213 | object = object.tb_frame |
|
214 | 214 | if isframe(object): |
|
215 | 215 | object = object.f_code |
|
216 | 216 | if iscode(object): |
|
217 | 217 | if not hasattr(object, 'co_firstlineno'): |
|
218 | 218 | raise IOError('could not find function definition') |
|
219 | 219 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
220 | 220 | pmatch = pat.match |
|
221 | 221 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
222 | 222 | # the length of lines, which causes an error. Safeguard against that. |
|
223 | 223 | lnum = min(object.co_firstlineno, len(lines)) - 1 |
|
224 | 224 | while lnum > 0: |
|
225 | 225 | if pmatch(lines[lnum]): |
|
226 | 226 | break |
|
227 | 227 | lnum -= 1 |
|
228 | 228 | |
|
229 | 229 | return lines, lnum |
|
230 | 230 | raise IOError('could not find code object') |
|
231 | 231 | |
|
232 | 232 | |
|
233 | 233 | # This is a patched version of inspect.getargs that applies the (unmerged) |
|
234 | 234 | # patch for http://bugs.python.org/issue14611 by Stefano Taschini. This fixes |
|
235 | 235 | # https://github.com/ipython/ipython/issues/8205 and |
|
236 | 236 | # https://github.com/ipython/ipython/issues/8293 |
|
237 | 237 | def getargs(co): |
|
238 | 238 | """Get information about the arguments accepted by a code object. |
|
239 | 239 | |
|
240 | 240 | Three things are returned: (args, varargs, varkw), where 'args' is |
|
241 | 241 | a list of argument names (possibly containing nested lists), and |
|
242 | 242 | 'varargs' and 'varkw' are the names of the * and ** arguments or None.""" |
|
243 | 243 | if not iscode(co): |
|
244 | 244 | raise TypeError('{!r} is not a code object'.format(co)) |
|
245 | 245 | |
|
246 | 246 | nargs = co.co_argcount |
|
247 | 247 | names = co.co_varnames |
|
248 | 248 | args = list(names[:nargs]) |
|
249 | 249 | step = 0 |
|
250 | 250 | |
|
251 | 251 | # The following acrobatics are for anonymous (tuple) arguments. |
|
252 | 252 | for i in range(nargs): |
|
253 | 253 | if args[i][:1] in ('', '.'): |
|
254 | 254 | stack, remain, count = [], [], [] |
|
255 | 255 | while step < len(co.co_code): |
|
256 | 256 | op = ord(co.co_code[step]) |
|
257 | 257 | step = step + 1 |
|
258 | 258 | if op >= dis.HAVE_ARGUMENT: |
|
259 | 259 | opname = dis.opname[op] |
|
260 | 260 | value = ord(co.co_code[step]) + ord(co.co_code[step+1])*256 |
|
261 | 261 | step = step + 2 |
|
262 | 262 | if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'): |
|
263 | 263 | remain.append(value) |
|
264 | 264 | count.append(value) |
|
265 | 265 | elif opname in ('STORE_FAST', 'STORE_DEREF'): |
|
266 | 266 | if op in dis.haslocal: |
|
267 | 267 | stack.append(co.co_varnames[value]) |
|
268 | 268 | elif op in dis.hasfree: |
|
269 | 269 | stack.append((co.co_cellvars + co.co_freevars)[value]) |
|
270 | 270 | # Special case for sublists of length 1: def foo((bar)) |
|
271 | 271 | # doesn't generate the UNPACK_TUPLE bytecode, so if |
|
272 | 272 | # `remain` is empty here, we have such a sublist. |
|
273 | 273 | if not remain: |
|
274 | 274 | stack[0] = [stack[0]] |
|
275 | 275 | break |
|
276 | 276 | else: |
|
277 | 277 | remain[-1] = remain[-1] - 1 |
|
278 | 278 | while remain[-1] == 0: |
|
279 | 279 | remain.pop() |
|
280 | 280 | size = count.pop() |
|
281 | 281 | stack[-size:] = [stack[-size:]] |
|
282 | 282 | if not remain: |
|
283 | 283 | break |
|
284 | 284 | remain[-1] = remain[-1] - 1 |
|
285 | 285 | if not remain: |
|
286 | 286 | break |
|
287 | 287 | args[i] = stack[0] |
|
288 | 288 | |
|
289 | 289 | varargs = None |
|
290 | 290 | if co.co_flags & inspect.CO_VARARGS: |
|
291 | 291 | varargs = co.co_varnames[nargs] |
|
292 | 292 | nargs = nargs + 1 |
|
293 | 293 | varkw = None |
|
294 | 294 | if co.co_flags & inspect.CO_VARKEYWORDS: |
|
295 | 295 | varkw = co.co_varnames[nargs] |
|
296 | 296 | return inspect.Arguments(args, varargs, varkw) |
|
297 | 297 | |
|
298 | 298 | |
|
299 | 299 | # Monkeypatch inspect to apply our bugfix. |
|
300 | 300 | def with_patch_inspect(f): |
|
301 | 301 | """ |
|
302 | 302 | Deprecated since IPython 6.0 |
|
303 | 303 | decorator for monkeypatching inspect.findsource |
|
304 | 304 | """ |
|
305 | 305 | |
|
306 | 306 | def wrapped(*args, **kwargs): |
|
307 | 307 | save_findsource = inspect.findsource |
|
308 | 308 | save_getargs = inspect.getargs |
|
309 | 309 | inspect.findsource = findsource |
|
310 | 310 | inspect.getargs = getargs |
|
311 | 311 | try: |
|
312 | 312 | return f(*args, **kwargs) |
|
313 | 313 | finally: |
|
314 | 314 | inspect.findsource = save_findsource |
|
315 | 315 | inspect.getargs = save_getargs |
|
316 | 316 | |
|
317 | 317 | return wrapped |
|
318 | 318 | |
|
319 | 319 | |
|
320 | 320 | def fix_frame_records_filenames(records): |
|
321 | 321 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
322 | 322 | |
|
323 | 323 | Particularly, modules loaded from within zip files have useless filenames |
|
324 | 324 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
325 | 325 | """ |
|
326 | 326 | fixed_records = [] |
|
327 | 327 | for frame, filename, line_no, func_name, lines, index in records: |
|
328 | 328 | # Look inside the frame's globals dictionary for __file__, |
|
329 | 329 | # which should be better. However, keep Cython filenames since |
|
330 | 330 | # we prefer the source filenames over the compiled .so file. |
|
331 | 331 | if not filename.endswith(('.pyx', '.pxd', '.pxi')): |
|
332 | 332 | better_fn = frame.f_globals.get('__file__', None) |
|
333 | 333 | if isinstance(better_fn, str): |
|
334 | 334 | # Check the type just in case someone did something weird with |
|
335 | 335 | # __file__. It might also be None if the error occurred during |
|
336 | 336 | # import. |
|
337 | 337 | filename = better_fn |
|
338 | 338 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
339 | 339 | return fixed_records |
|
340 | 340 | |
|
341 | 341 | |
|
342 | 342 | @with_patch_inspect |
|
343 | 343 | def _fixed_getinnerframes(etb, context=1, tb_offset=0): |
|
344 | 344 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
345 | 345 | |
|
346 | 346 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
347 | 347 | # If the error is at the console, don't build any context, since it would |
|
348 | 348 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
349 | 349 | # console) |
|
350 | 350 | rec_check = records[tb_offset:] |
|
351 | 351 | try: |
|
352 | 352 | rname = rec_check[0][1] |
|
353 | 353 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
354 | 354 | return rec_check |
|
355 | 355 | except IndexError: |
|
356 | 356 | pass |
|
357 | 357 | |
|
358 | 358 | aux = traceback.extract_tb(etb) |
|
359 | 359 | assert len(records) == len(aux) |
|
360 | 360 | for i, (file, lnum, _, _) in enumerate(aux): |
|
361 | 361 | maybeStart = lnum - 1 - context // 2 |
|
362 | 362 | start = max(maybeStart, 0) |
|
363 | 363 | end = start + context |
|
364 | 364 | lines = linecache.getlines(file)[start:end] |
|
365 | 365 | buf = list(records[i]) |
|
366 | 366 | buf[LNUM_POS] = lnum |
|
367 | 367 | buf[INDEX_POS] = lnum - 1 - start |
|
368 | 368 | buf[LINES_POS] = lines |
|
369 | 369 | records[i] = tuple(buf) |
|
370 | 370 | return records[tb_offset:] |
|
371 | 371 | |
|
372 | 372 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
373 | 373 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
374 | 374 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
375 | 375 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
376 | 376 | |
|
377 | 377 | |
|
378 | 378 | def _format_traceback_lines(lnum, index, lines, Colors, lvals, _line_format): |
|
379 | 379 | """ |
|
380 | 380 | Format tracebacks lines with pointing arrow, leading numbers... |
|
381 | 381 | |
|
382 | 382 | Parameters |
|
383 | 383 | ========== |
|
384 | 384 | |
|
385 | 385 | lnum: int |
|
386 | 386 | index: int |
|
387 | 387 | lines: list[string] |
|
388 | 388 | Colors: |
|
389 | 389 | ColorScheme used. |
|
390 | 390 | lvals: bytes |
|
391 | 391 | Values of local variables, already colored, to inject just after the error line. |
|
392 | 392 | _line_format: f (str) -> (str, bool) |
|
393 | 393 | return (colorized version of str, failure to do so) |
|
394 | 394 | """ |
|
395 | 395 | numbers_width = INDENT_SIZE - 1 |
|
396 | 396 | res = [] |
|
397 | 397 | |
|
398 | 398 | for i,line in enumerate(lines, lnum-index): |
|
399 | 399 | line = py3compat.cast_unicode(line) |
|
400 | 400 | |
|
401 | 401 | new_line, err = _line_format(line, 'str') |
|
402 | 402 | if not err: |
|
403 | 403 | line = new_line |
|
404 | 404 | |
|
405 | 405 | if i == lnum: |
|
406 | 406 | # This is the line with the error |
|
407 | 407 | pad = numbers_width - len(str(i)) |
|
408 | 408 | num = '%s%s' % (debugger.make_arrow(pad), str(lnum)) |
|
409 | 409 | line = '%s%s%s %s%s' % (Colors.linenoEm, num, |
|
410 | 410 | Colors.line, line, Colors.Normal) |
|
411 | 411 | else: |
|
412 | 412 | num = '%*s' % (numbers_width, i) |
|
413 | 413 | line = '%s%s%s %s' % (Colors.lineno, num, |
|
414 | 414 | Colors.Normal, line) |
|
415 | 415 | |
|
416 | 416 | res.append(line) |
|
417 | 417 | if lvals and i == lnum: |
|
418 | 418 | res.append(lvals + '\n') |
|
419 | 419 | return res |
|
420 | 420 | |
|
421 | 421 | def is_recursion_error(etype, value, records): |
|
422 | 422 | try: |
|
423 | 423 | # RecursionError is new in Python 3.5 |
|
424 | 424 | recursion_error_type = RecursionError |
|
425 | 425 | except NameError: |
|
426 | 426 | recursion_error_type = RuntimeError |
|
427 | 427 | |
|
428 | 428 | # The default recursion limit is 1000, but some of that will be taken up |
|
429 | 429 | # by stack frames in IPython itself. >500 frames probably indicates |
|
430 | 430 | # a recursion error. |
|
431 | 431 | return (etype is recursion_error_type) \ |
|
432 | 432 | and "recursion" in str(value).lower() \ |
|
433 | 433 | and len(records) > 500 |
|
434 | 434 | |
|
435 | 435 | def find_recursion(etype, value, records): |
|
436 | 436 | """Identify the repeating stack frames from a RecursionError traceback |
|
437 | 437 | |
|
438 | 438 | 'records' is a list as returned by VerboseTB.get_records() |
|
439 | 439 | |
|
440 | 440 | Returns (last_unique, repeat_length) |
|
441 | 441 | """ |
|
442 | 442 | # This involves a bit of guesswork - we want to show enough of the traceback |
|
443 | 443 | # to indicate where the recursion is occurring. We guess that the innermost |
|
444 | 444 | # quarter of the traceback (250 frames by default) is repeats, and find the |
|
445 | 445 | # first frame (from in to out) that looks different. |
|
446 | 446 | if not is_recursion_error(etype, value, records): |
|
447 | 447 | return len(records), 0 |
|
448 | 448 | |
|
449 | 449 | # Select filename, lineno, func_name to track frames with |
|
450 | 450 | records = [r[1:4] for r in records] |
|
451 | 451 | inner_frames = records[-(len(records)//4):] |
|
452 | 452 | frames_repeated = set(inner_frames) |
|
453 | 453 | |
|
454 | 454 | last_seen_at = {} |
|
455 | 455 | longest_repeat = 0 |
|
456 | 456 | i = len(records) |
|
457 | 457 | for frame in reversed(records): |
|
458 | 458 | i -= 1 |
|
459 | 459 | if frame not in frames_repeated: |
|
460 | 460 | last_unique = i |
|
461 | 461 | break |
|
462 | 462 | |
|
463 | 463 | if frame in last_seen_at: |
|
464 | 464 | distance = last_seen_at[frame] - i |
|
465 | 465 | longest_repeat = max(longest_repeat, distance) |
|
466 | 466 | |
|
467 | 467 | last_seen_at[frame] = i |
|
468 | 468 | else: |
|
469 | 469 | last_unique = 0 # The whole traceback was recursion |
|
470 | 470 | |
|
471 | 471 | return last_unique, longest_repeat |
|
472 | 472 | |
|
473 | 473 | #--------------------------------------------------------------------------- |
|
474 | 474 | # Module classes |
|
475 | 475 | class TBTools(colorable.Colorable): |
|
476 | 476 | """Basic tools used by all traceback printer classes.""" |
|
477 | 477 | |
|
478 | 478 | # Number of frames to skip when reporting tracebacks |
|
479 | 479 | tb_offset = 0 |
|
480 | 480 | |
|
481 | 481 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
482 | 482 | # Whether to call the interactive pdb debugger after printing |
|
483 | 483 | # tracebacks or not |
|
484 | 484 | super(TBTools, self).__init__(parent=parent, config=config) |
|
485 | 485 | self.call_pdb = call_pdb |
|
486 | 486 | |
|
487 | 487 | # Output stream to write to. Note that we store the original value in |
|
488 | 488 | # a private attribute and then make the public ostream a property, so |
|
489 | 489 | # that we can delay accessing sys.stdout until runtime. The way |
|
490 | 490 | # things are written now, the sys.stdout object is dynamically managed |
|
491 | 491 | # so a reference to it should NEVER be stored statically. This |
|
492 | 492 | # property approach confines this detail to a single location, and all |
|
493 | 493 | # subclasses can simply access self.ostream for writing. |
|
494 | 494 | self._ostream = ostream |
|
495 | 495 | |
|
496 | 496 | # Create color table |
|
497 | 497 | self.color_scheme_table = exception_colors() |
|
498 | 498 | |
|
499 | 499 | self.set_colors(color_scheme) |
|
500 | 500 | self.old_scheme = color_scheme # save initial value for toggles |
|
501 | 501 | |
|
502 | 502 | if call_pdb: |
|
503 | 503 | self.pdb = debugger.Pdb() |
|
504 | 504 | else: |
|
505 | 505 | self.pdb = None |
|
506 | 506 | |
|
507 | 507 | def _get_ostream(self): |
|
508 | 508 | """Output stream that exceptions are written to. |
|
509 | 509 | |
|
510 | 510 | Valid values are: |
|
511 | 511 | |
|
512 | 512 | - None: the default, which means that IPython will dynamically resolve |
|
513 | 513 | to sys.stdout. This ensures compatibility with most tools, including |
|
514 | 514 | Windows (where plain stdout doesn't recognize ANSI escapes). |
|
515 | 515 | |
|
516 | 516 | - Any object with 'write' and 'flush' attributes. |
|
517 | 517 | """ |
|
518 | 518 | return sys.stdout if self._ostream is None else self._ostream |
|
519 | 519 | |
|
520 | 520 | def _set_ostream(self, val): |
|
521 | 521 | assert val is None or (hasattr(val, 'write') and hasattr(val, 'flush')) |
|
522 | 522 | self._ostream = val |
|
523 | 523 | |
|
524 | 524 | ostream = property(_get_ostream, _set_ostream) |
|
525 | 525 | |
|
526 | 526 | def set_colors(self, *args, **kw): |
|
527 | 527 | """Shorthand access to the color table scheme selector method.""" |
|
528 | 528 | |
|
529 | 529 | # Set own color table |
|
530 | 530 | self.color_scheme_table.set_active_scheme(*args, **kw) |
|
531 | 531 | # for convenience, set Colors to the active scheme |
|
532 | 532 | self.Colors = self.color_scheme_table.active_colors |
|
533 | 533 | # Also set colors of debugger |
|
534 | 534 | if hasattr(self, 'pdb') and self.pdb is not None: |
|
535 | 535 | self.pdb.set_colors(*args, **kw) |
|
536 | 536 | |
|
537 | 537 | def color_toggle(self): |
|
538 | 538 | """Toggle between the currently active color scheme and NoColor.""" |
|
539 | 539 | |
|
540 | 540 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
541 | 541 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
542 | 542 | self.Colors = self.color_scheme_table.active_colors |
|
543 | 543 | else: |
|
544 | 544 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
545 | 545 | self.color_scheme_table.set_active_scheme('NoColor') |
|
546 | 546 | self.Colors = self.color_scheme_table.active_colors |
|
547 | 547 | |
|
548 | 548 | def stb2text(self, stb): |
|
549 | 549 | """Convert a structured traceback (a list) to a string.""" |
|
550 | 550 | return '\n'.join(stb) |
|
551 | 551 | |
|
552 | 552 | def text(self, etype, value, tb, tb_offset=None, context=5): |
|
553 | 553 | """Return formatted traceback. |
|
554 | 554 | |
|
555 | 555 | Subclasses may override this if they add extra arguments. |
|
556 | 556 | """ |
|
557 | 557 | tb_list = self.structured_traceback(etype, value, tb, |
|
558 | 558 | tb_offset, context) |
|
559 | 559 | return self.stb2text(tb_list) |
|
560 | 560 | |
|
561 | 561 | def structured_traceback(self, etype, evalue, tb, tb_offset=None, |
|
562 | 562 | context=5, mode=None): |
|
563 | 563 | """Return a list of traceback frames. |
|
564 | 564 | |
|
565 | 565 | Must be implemented by each class. |
|
566 | 566 | """ |
|
567 | 567 | raise NotImplementedError() |
|
568 | 568 | |
|
569 | 569 | |
|
570 | 570 | #--------------------------------------------------------------------------- |
|
571 | 571 | class ListTB(TBTools): |
|
572 | 572 | """Print traceback information from a traceback list, with optional color. |
|
573 | 573 | |
|
574 | 574 | Calling requires 3 arguments: (etype, evalue, elist) |
|
575 | 575 | as would be obtained by:: |
|
576 | 576 | |
|
577 | 577 | etype, evalue, tb = sys.exc_info() |
|
578 | 578 | if tb: |
|
579 | 579 | elist = traceback.extract_tb(tb) |
|
580 | 580 | else: |
|
581 | 581 | elist = None |
|
582 | 582 | |
|
583 | 583 | It can thus be used by programs which need to process the traceback before |
|
584 | 584 | printing (such as console replacements based on the code module from the |
|
585 | 585 | standard library). |
|
586 | 586 | |
|
587 | 587 | Because they are meant to be called without a full traceback (only a |
|
588 | 588 | list), instances of this class can't call the interactive pdb debugger.""" |
|
589 | 589 | |
|
590 | 590 | def __init__(self, color_scheme='NoColor', call_pdb=False, ostream=None, parent=None, config=None): |
|
591 | 591 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
592 | 592 | ostream=ostream, parent=parent,config=config) |
|
593 | 593 | |
|
594 | 594 | def __call__(self, etype, value, elist): |
|
595 | 595 | self.ostream.flush() |
|
596 | 596 | self.ostream.write(self.text(etype, value, elist)) |
|
597 | 597 | self.ostream.write('\n') |
|
598 | 598 | |
|
599 | 599 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
600 | 600 | context=5): |
|
601 | 601 | """Return a color formatted string with the traceback info. |
|
602 | 602 | |
|
603 | 603 | Parameters |
|
604 | 604 | ---------- |
|
605 | 605 | etype : exception type |
|
606 | 606 | Type of the exception raised. |
|
607 | 607 | |
|
608 | 608 | value : object |
|
609 | 609 | Data stored in the exception |
|
610 | 610 | |
|
611 | 611 | elist : list |
|
612 | 612 | List of frames, see class docstring for details. |
|
613 | 613 | |
|
614 | 614 | tb_offset : int, optional |
|
615 | 615 | Number of frames in the traceback to skip. If not given, the |
|
616 | 616 | instance value is used (set in constructor). |
|
617 | 617 | |
|
618 | 618 | context : int, optional |
|
619 | 619 | Number of lines of context information to print. |
|
620 | 620 | |
|
621 | 621 | Returns |
|
622 | 622 | ------- |
|
623 | 623 | String with formatted exception. |
|
624 | 624 | """ |
|
625 | 625 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
626 | 626 | Colors = self.Colors |
|
627 | 627 | out_list = [] |
|
628 | 628 | if elist: |
|
629 | 629 | |
|
630 | 630 | if tb_offset and len(elist) > tb_offset: |
|
631 | 631 | elist = elist[tb_offset:] |
|
632 | 632 | |
|
633 | 633 | out_list.append('Traceback %s(most recent call last)%s:' % |
|
634 | 634 | (Colors.normalEm, Colors.Normal) + '\n') |
|
635 | 635 | out_list.extend(self._format_list(elist)) |
|
636 | 636 | # The exception info should be a single entry in the list. |
|
637 | 637 | lines = ''.join(self._format_exception_only(etype, value)) |
|
638 | 638 | out_list.append(lines) |
|
639 | 639 | |
|
640 | 640 | return out_list |
|
641 | 641 | |
|
642 | 642 | def _format_list(self, extracted_list): |
|
643 | 643 | """Format a list of traceback entry tuples for printing. |
|
644 | 644 | |
|
645 | 645 | Given a list of tuples as returned by extract_tb() or |
|
646 | 646 | extract_stack(), return a list of strings ready for printing. |
|
647 | 647 | Each string in the resulting list corresponds to the item with the |
|
648 | 648 | same index in the argument list. Each string ends in a newline; |
|
649 | 649 | the strings may contain internal newlines as well, for those items |
|
650 | 650 | whose source text line is not None. |
|
651 | 651 | |
|
652 | 652 | Lifted almost verbatim from traceback.py |
|
653 | 653 | """ |
|
654 | 654 | |
|
655 | 655 | Colors = self.Colors |
|
656 | 656 | list = [] |
|
657 | 657 | for filename, lineno, name, line in extracted_list[:-1]: |
|
658 | 658 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
659 | 659 | (Colors.filename, filename, Colors.Normal, |
|
660 | 660 | Colors.lineno, lineno, Colors.Normal, |
|
661 | 661 | Colors.name, name, Colors.Normal) |
|
662 | 662 | if line: |
|
663 | 663 | item += ' %s\n' % line.strip() |
|
664 | 664 | list.append(item) |
|
665 | 665 | # Emphasize the last entry |
|
666 | 666 | filename, lineno, name, line = extracted_list[-1] |
|
667 | 667 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
668 | 668 | (Colors.normalEm, |
|
669 | 669 | Colors.filenameEm, filename, Colors.normalEm, |
|
670 | 670 | Colors.linenoEm, lineno, Colors.normalEm, |
|
671 | 671 | Colors.nameEm, name, Colors.normalEm, |
|
672 | 672 | Colors.Normal) |
|
673 | 673 | if line: |
|
674 | 674 | item += '%s %s%s\n' % (Colors.line, line.strip(), |
|
675 | 675 | Colors.Normal) |
|
676 | 676 | list.append(item) |
|
677 | 677 | return list |
|
678 | 678 | |
|
679 | 679 | def _format_exception_only(self, etype, value): |
|
680 | 680 | """Format the exception part of a traceback. |
|
681 | 681 | |
|
682 | 682 | The arguments are the exception type and value such as given by |
|
683 | 683 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
684 | 684 | in a newline. Normally, the list contains a single string; however, |
|
685 | 685 | for SyntaxError exceptions, it contains several lines that (when |
|
686 | 686 | printed) display detailed information about where the syntax error |
|
687 | 687 | occurred. The message indicating which exception occurred is the |
|
688 | 688 | always last string in the list. |
|
689 | 689 | |
|
690 | 690 | Also lifted nearly verbatim from traceback.py |
|
691 | 691 | """ |
|
692 | 692 | have_filedata = False |
|
693 | 693 | Colors = self.Colors |
|
694 | 694 | list = [] |
|
695 | 695 | stype = py3compat.cast_unicode(Colors.excName + etype.__name__ + Colors.Normal) |
|
696 | 696 | if value is None: |
|
697 | 697 | # Not sure if this can still happen in Python 2.6 and above |
|
698 | 698 | list.append(stype + '\n') |
|
699 | 699 | else: |
|
700 | 700 | if issubclass(etype, SyntaxError): |
|
701 | 701 | have_filedata = True |
|
702 | 702 | if not value.filename: value.filename = "<string>" |
|
703 | 703 | if value.lineno: |
|
704 | 704 | lineno = value.lineno |
|
705 | 705 | textline = linecache.getline(value.filename, value.lineno) |
|
706 | 706 | else: |
|
707 | 707 | lineno = 'unknown' |
|
708 | 708 | textline = '' |
|
709 | 709 | list.append('%s File %s"%s"%s, line %s%s%s\n' % \ |
|
710 | 710 | (Colors.normalEm, |
|
711 | 711 | Colors.filenameEm, py3compat.cast_unicode(value.filename), Colors.normalEm, |
|
712 | 712 | Colors.linenoEm, lineno, Colors.Normal )) |
|
713 | 713 | if textline == '': |
|
714 | 714 | textline = py3compat.cast_unicode(value.text, "utf-8") |
|
715 | 715 | |
|
716 | 716 | if textline is not None: |
|
717 | 717 | i = 0 |
|
718 | 718 | while i < len(textline) and textline[i].isspace(): |
|
719 | 719 | i += 1 |
|
720 | 720 | list.append('%s %s%s\n' % (Colors.line, |
|
721 | 721 | textline.strip(), |
|
722 | 722 | Colors.Normal)) |
|
723 | 723 | if value.offset is not None: |
|
724 | 724 | s = ' ' |
|
725 | 725 | for c in textline[i:value.offset - 1]: |
|
726 | 726 | if c.isspace(): |
|
727 | 727 | s += c |
|
728 | 728 | else: |
|
729 | 729 | s += ' ' |
|
730 | 730 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
731 | 731 | Colors.Normal)) |
|
732 | 732 | |
|
733 | 733 | try: |
|
734 | 734 | s = value.msg |
|
735 | 735 | except Exception: |
|
736 | 736 | s = self._some_str(value) |
|
737 | 737 | if s: |
|
738 | 738 | list.append('%s%s:%s %s\n' % (stype, Colors.excName, |
|
739 | 739 | Colors.Normal, s)) |
|
740 | 740 | else: |
|
741 | 741 | list.append('%s\n' % stype) |
|
742 | 742 | |
|
743 | 743 | # sync with user hooks |
|
744 | 744 | if have_filedata: |
|
745 | 745 | ipinst = get_ipython() |
|
746 | 746 | if ipinst is not None: |
|
747 | 747 | ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0) |
|
748 | 748 | |
|
749 | 749 | return list |
|
750 | 750 | |
|
751 | 751 | def get_exception_only(self, etype, value): |
|
752 | 752 | """Only print the exception type and message, without a traceback. |
|
753 | 753 | |
|
754 | 754 | Parameters |
|
755 | 755 | ---------- |
|
756 | 756 | etype : exception type |
|
757 | 757 | value : exception value |
|
758 | 758 | """ |
|
759 | 759 | return ListTB.structured_traceback(self, etype, value, []) |
|
760 | 760 | |
|
761 | 761 | def show_exception_only(self, etype, evalue): |
|
762 | 762 | """Only print the exception type and message, without a traceback. |
|
763 | 763 | |
|
764 | 764 | Parameters |
|
765 | 765 | ---------- |
|
766 | 766 | etype : exception type |
|
767 | 767 | value : exception value |
|
768 | 768 | """ |
|
769 | 769 | # This method needs to use __call__ from *this* class, not the one from |
|
770 | 770 | # a subclass whose signature or behavior may be different |
|
771 | 771 | ostream = self.ostream |
|
772 | 772 | ostream.flush() |
|
773 | 773 | ostream.write('\n'.join(self.get_exception_only(etype, evalue))) |
|
774 | 774 | ostream.flush() |
|
775 | 775 | |
|
776 | 776 | def _some_str(self, value): |
|
777 | 777 | # Lifted from traceback.py |
|
778 | 778 | try: |
|
779 | 779 | return py3compat.cast_unicode(str(value)) |
|
780 | 780 | except: |
|
781 | 781 | return u'<unprintable %s object>' % type(value).__name__ |
|
782 | 782 | |
|
783 | 783 | |
|
784 | 784 | #---------------------------------------------------------------------------- |
|
785 | 785 | class VerboseTB(TBTools): |
|
786 | 786 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
787 | 787 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
788 | 788 | |
|
789 | 789 | Modified version which optionally strips the topmost entries from the |
|
790 | 790 | traceback, to be used with alternate interpreters (because their own code |
|
791 | 791 | would appear in the traceback).""" |
|
792 | 792 | |
|
793 | 793 | def __init__(self, color_scheme='Linux', call_pdb=False, ostream=None, |
|
794 | 794 | tb_offset=0, long_header=False, include_vars=True, |
|
795 | 795 | check_cache=None, debugger_cls = None, |
|
796 | 796 | parent=None, config=None): |
|
797 | 797 | """Specify traceback offset, headers and color scheme. |
|
798 | 798 | |
|
799 | 799 | Define how many frames to drop from the tracebacks. Calling it with |
|
800 | 800 | tb_offset=1 allows use of this handler in interpreters which will have |
|
801 | 801 | their own code at the top of the traceback (VerboseTB will first |
|
802 | 802 | remove that frame before printing the traceback info).""" |
|
803 | 803 | TBTools.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
804 | 804 | ostream=ostream, parent=parent, config=config) |
|
805 | 805 | self.tb_offset = tb_offset |
|
806 | 806 | self.long_header = long_header |
|
807 | 807 | self.include_vars = include_vars |
|
808 | 808 | # By default we use linecache.checkcache, but the user can provide a |
|
809 | 809 | # different check_cache implementation. This is used by the IPython |
|
810 | 810 | # kernel to provide tracebacks for interactive code that is cached, |
|
811 | 811 | # by a compiler instance that flushes the linecache but preserves its |
|
812 | 812 | # own code cache. |
|
813 | 813 | if check_cache is None: |
|
814 | 814 | check_cache = linecache.checkcache |
|
815 | 815 | self.check_cache = check_cache |
|
816 | 816 | |
|
817 | 817 | self.debugger_cls = debugger_cls or debugger.Pdb |
|
818 | 818 | |
|
819 | 819 | def format_records(self, records, last_unique, recursion_repeat): |
|
820 | 820 | """Format the stack frames of the traceback""" |
|
821 | 821 | frames = [] |
|
822 | 822 | for r in records[:last_unique+recursion_repeat+1]: |
|
823 | 823 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
824 | 824 | frames.append(self.format_record(*r)) |
|
825 | 825 | |
|
826 | 826 | if recursion_repeat: |
|
827 | 827 | frames.append('... last %d frames repeated, from the frame below ...\n' % recursion_repeat) |
|
828 | 828 | frames.append(self.format_record(*records[last_unique+recursion_repeat+1])) |
|
829 | 829 | |
|
830 | 830 | return frames |
|
831 | 831 | |
|
832 | 832 | def format_record(self, frame, file, lnum, func, lines, index): |
|
833 | 833 | """Format a single stack frame""" |
|
834 | 834 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
835 | 835 | ColorsNormal = Colors.Normal # used a lot |
|
836 | 836 | col_scheme = self.color_scheme_table.active_scheme_name |
|
837 | 837 | indent = ' ' * INDENT_SIZE |
|
838 | 838 | em_normal = '%s\n%s%s' % (Colors.valEm, indent, ColorsNormal) |
|
839 | 839 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
840 | 840 | tpl_link = '%s%%s%s' % (Colors.filenameEm, ColorsNormal) |
|
841 | 841 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
842 | 842 | ColorsNormal) |
|
843 | 843 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
844 | 844 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
845 | 845 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
846 | 846 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
847 | 847 | Colors.vName, ColorsNormal) |
|
848 | 848 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
849 | 849 | |
|
850 | 850 | if not file: |
|
851 | 851 | file = '?' |
|
852 | 852 | elif file.startswith(str("<")) and file.endswith(str(">")): |
|
853 | 853 | # Not a real filename, no problem... |
|
854 | 854 | pass |
|
855 | 855 | elif not os.path.isabs(file): |
|
856 | 856 | # Try to make the filename absolute by trying all |
|
857 | 857 | # sys.path entries (which is also what linecache does) |
|
858 | 858 | for dirname in sys.path: |
|
859 | 859 | try: |
|
860 | 860 | fullname = os.path.join(dirname, file) |
|
861 | 861 | if os.path.isfile(fullname): |
|
862 | 862 | file = os.path.abspath(fullname) |
|
863 | 863 | break |
|
864 | 864 | except Exception: |
|
865 | 865 | # Just in case that sys.path contains very |
|
866 | 866 | # strange entries... |
|
867 | 867 | pass |
|
868 | 868 | |
|
869 | 869 | file = py3compat.cast_unicode(file, util_path.fs_encoding) |
|
870 | 870 | link = tpl_link % util_path.compress_user(file) |
|
871 | 871 | args, varargs, varkw, locals_ = inspect.getargvalues(frame) |
|
872 | 872 | |
|
873 | 873 | if func == '?': |
|
874 | 874 | call = '' |
|
875 | elif func == '<module>': | |
|
876 | call = tpl_call % (func, '') | |
|
875 | 877 | else: |
|
876 | 878 | # Decide whether to include variable details or not |
|
877 | 879 | var_repr = eqrepr if self.include_vars else nullrepr |
|
878 | 880 | try: |
|
879 | 881 | call = tpl_call % (func, inspect.formatargvalues(args, |
|
880 | 882 | varargs, varkw, |
|
881 | 883 | locals_, formatvalue=var_repr)) |
|
882 | 884 | except KeyError: |
|
883 | 885 | # This happens in situations like errors inside generator |
|
884 | 886 | # expressions, where local variables are listed in the |
|
885 | 887 | # line, but can't be extracted from the frame. I'm not |
|
886 | 888 | # 100% sure this isn't actually a bug in inspect itself, |
|
887 | 889 | # but since there's no info for us to compute with, the |
|
888 | 890 | # best we can do is report the failure and move on. Here |
|
889 | 891 | # we must *not* call any traceback construction again, |
|
890 | 892 | # because that would mess up use of %debug later on. So we |
|
891 | 893 | # simply report the failure and move on. The only |
|
892 | 894 | # limitation will be that this frame won't have locals |
|
893 | 895 | # listed in the call signature. Quite subtle problem... |
|
894 | 896 | # I can't think of a good way to validate this in a unit |
|
895 | 897 | # test, but running a script consisting of: |
|
896 | 898 | # dict( (k,v.strip()) for (k,v) in range(10) ) |
|
897 | 899 | # will illustrate the error, if this exception catch is |
|
898 | 900 | # disabled. |
|
899 | 901 | call = tpl_call_fail % func |
|
900 | 902 | |
|
901 | 903 | # Don't attempt to tokenize binary files. |
|
902 | 904 | if file.endswith(('.so', '.pyd', '.dll')): |
|
903 | 905 | return '%s %s\n' % (link, call) |
|
904 | 906 | |
|
905 | 907 | elif file.endswith(('.pyc', '.pyo')): |
|
906 | 908 | # Look up the corresponding source file. |
|
907 | 909 | try: |
|
908 | 910 | file = openpy.source_from_cache(file) |
|
909 | 911 | except ValueError: |
|
910 | 912 | # Failed to get the source file for some reason |
|
911 | 913 | # E.g. https://github.com/ipython/ipython/issues/9486 |
|
912 | 914 | return '%s %s\n' % (link, call) |
|
913 | 915 | |
|
914 | 916 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): |
|
915 | 917 | line = getline(file, lnum[0]) |
|
916 | 918 | lnum[0] += 1 |
|
917 | 919 | return line |
|
918 | 920 | |
|
919 | 921 | # Build the list of names on this line of code where the exception |
|
920 | 922 | # occurred. |
|
921 | 923 | try: |
|
922 | 924 | names = [] |
|
923 | 925 | name_cont = False |
|
924 | 926 | |
|
925 | 927 | for token_type, token, start, end, line in generate_tokens(linereader): |
|
926 | 928 | # build composite names |
|
927 | 929 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
928 | 930 | if name_cont: |
|
929 | 931 | # Continuation of a dotted name |
|
930 | 932 | try: |
|
931 | 933 | names[-1].append(token) |
|
932 | 934 | except IndexError: |
|
933 | 935 | names.append([token]) |
|
934 | 936 | name_cont = False |
|
935 | 937 | else: |
|
936 | 938 | # Regular new names. We append everything, the caller |
|
937 | 939 | # will be responsible for pruning the list later. It's |
|
938 | 940 | # very tricky to try to prune as we go, b/c composite |
|
939 | 941 | # names can fool us. The pruning at the end is easy |
|
940 | 942 | # to do (or the caller can print a list with repeated |
|
941 | 943 | # names if so desired. |
|
942 | 944 | names.append([token]) |
|
943 | 945 | elif token == '.': |
|
944 | 946 | name_cont = True |
|
945 | 947 | elif token_type == tokenize.NEWLINE: |
|
946 | 948 | break |
|
947 | 949 | |
|
948 | 950 | except (IndexError, UnicodeDecodeError, SyntaxError): |
|
949 | 951 | # signals exit of tokenizer |
|
950 | 952 | # SyntaxError can occur if the file is not actually Python |
|
951 | 953 | # - see gh-6300 |
|
952 | 954 | pass |
|
953 | 955 | except tokenize.TokenError as msg: |
|
954 | 956 | # Tokenizing may fail for various reasons, many of which are |
|
955 | 957 | # harmless. (A good example is when the line in question is the |
|
956 | 958 | # close of a triple-quoted string, cf gh-6864). We don't want to |
|
957 | 959 | # show this to users, but want make it available for debugging |
|
958 | 960 | # purposes. |
|
959 | 961 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
960 | 962 | "The following traceback may be corrupted or invalid\n" |
|
961 | 963 | "The error message is: %s\n" % msg) |
|
962 | 964 | debug(_m) |
|
963 | 965 | |
|
964 | 966 | # Join composite names (e.g. "dict.fromkeys") |
|
965 | 967 | names = ['.'.join(n) for n in names] |
|
966 | 968 | # prune names list of duplicates, but keep the right order |
|
967 | 969 | unique_names = uniq_stable(names) |
|
968 | 970 | |
|
969 | 971 | # Start loop over vars |
|
970 | 972 | lvals = '' |
|
971 | 973 | lvals_list = [] |
|
972 | 974 | if self.include_vars: |
|
973 | 975 | for name_full in unique_names: |
|
974 | 976 | name_base = name_full.split('.', 1)[0] |
|
975 | 977 | if name_base in frame.f_code.co_varnames: |
|
976 | 978 | if name_base in locals_: |
|
977 | 979 | try: |
|
978 | 980 | value = repr(eval(name_full, locals_)) |
|
979 | 981 | except: |
|
980 | 982 | value = undefined |
|
981 | 983 | else: |
|
982 | 984 | value = undefined |
|
983 | 985 | name = tpl_local_var % name_full |
|
984 | 986 | else: |
|
985 | 987 | if name_base in frame.f_globals: |
|
986 | 988 | try: |
|
987 | 989 | value = repr(eval(name_full, frame.f_globals)) |
|
988 | 990 | except: |
|
989 | 991 | value = undefined |
|
990 | 992 | else: |
|
991 | 993 | value = undefined |
|
992 | 994 | name = tpl_global_var % name_full |
|
993 | 995 | lvals_list.append(tpl_name_val % (name, value)) |
|
994 | 996 | if lvals_list: |
|
995 | 997 | lvals = '%s%s' % (indent, em_normal.join(lvals_list)) |
|
996 | 998 | |
|
997 | 999 | level = '%s %s\n' % (link, call) |
|
998 | 1000 | |
|
999 | 1001 | if index is None: |
|
1000 | 1002 | return level |
|
1001 | 1003 | else: |
|
1002 | 1004 | _line_format = PyColorize.Parser(style=col_scheme, parent=self).format2 |
|
1003 | 1005 | return '%s%s' % (level, ''.join( |
|
1004 | 1006 | _format_traceback_lines(lnum, index, lines, Colors, lvals, |
|
1005 | 1007 | _line_format))) |
|
1006 | 1008 | |
|
1007 | 1009 | def prepare_chained_exception_message(self, cause): |
|
1008 | 1010 | direct_cause = "\nThe above exception was the direct cause of the following exception:\n" |
|
1009 | 1011 | exception_during_handling = "\nDuring handling of the above exception, another exception occurred:\n" |
|
1010 | 1012 | |
|
1011 | 1013 | if cause: |
|
1012 | 1014 | message = [[direct_cause]] |
|
1013 | 1015 | else: |
|
1014 | 1016 | message = [[exception_during_handling]] |
|
1015 | 1017 | return message |
|
1016 | 1018 | |
|
1017 | 1019 | def prepare_header(self, etype, long_version=False): |
|
1018 | 1020 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1019 | 1021 | colorsnormal = colors.Normal # used a lot |
|
1020 | 1022 | exc = '%s%s%s' % (colors.excName, etype, colorsnormal) |
|
1021 | 1023 | width = min(75, get_terminal_size()[0]) |
|
1022 | 1024 | if long_version: |
|
1023 | 1025 | # Header with the exception type, python version, and date |
|
1024 | 1026 | pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable |
|
1025 | 1027 | date = time.ctime(time.time()) |
|
1026 | 1028 | |
|
1027 | 1029 | head = '%s%s%s\n%s%s%s\n%s' % (colors.topline, '-' * width, colorsnormal, |
|
1028 | 1030 | exc, ' ' * (width - len(str(etype)) - len(pyver)), |
|
1029 | 1031 | pyver, date.rjust(width) ) |
|
1030 | 1032 | head += "\nA problem occurred executing Python code. Here is the sequence of function" \ |
|
1031 | 1033 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
1032 | 1034 | else: |
|
1033 | 1035 | # Simplified header |
|
1034 | 1036 | head = '%s%s' % (exc, 'Traceback (most recent call last)'. \ |
|
1035 | 1037 | rjust(width - len(str(etype))) ) |
|
1036 | 1038 | |
|
1037 | 1039 | return head |
|
1038 | 1040 | |
|
1039 | 1041 | def format_exception(self, etype, evalue): |
|
1040 | 1042 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1041 | 1043 | colorsnormal = colors.Normal # used a lot |
|
1042 | 1044 | # Get (safely) a string form of the exception info |
|
1043 | 1045 | try: |
|
1044 | 1046 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
1045 | 1047 | except: |
|
1046 | 1048 | # User exception is improperly defined. |
|
1047 | 1049 | etype, evalue = str, sys.exc_info()[:2] |
|
1048 | 1050 | etype_str, evalue_str = map(str, (etype, evalue)) |
|
1049 | 1051 | # ... and format it |
|
1050 | 1052 | return ['%s%s%s: %s' % (colors.excName, etype_str, |
|
1051 | 1053 | colorsnormal, py3compat.cast_unicode(evalue_str))] |
|
1052 | 1054 | |
|
1053 | 1055 | def format_exception_as_a_whole(self, etype, evalue, etb, number_of_lines_of_context, tb_offset): |
|
1054 | 1056 | """Formats the header, traceback and exception message for a single exception. |
|
1055 | 1057 | |
|
1056 | 1058 | This may be called multiple times by Python 3 exception chaining |
|
1057 | 1059 | (PEP 3134). |
|
1058 | 1060 | """ |
|
1059 | 1061 | # some locals |
|
1060 | 1062 | orig_etype = etype |
|
1061 | 1063 | try: |
|
1062 | 1064 | etype = etype.__name__ |
|
1063 | 1065 | except AttributeError: |
|
1064 | 1066 | pass |
|
1065 | 1067 | |
|
1066 | 1068 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
1067 | 1069 | head = self.prepare_header(etype, self.long_header) |
|
1068 | 1070 | records = self.get_records(etb, number_of_lines_of_context, tb_offset) |
|
1069 | 1071 | |
|
1070 | 1072 | if records is None: |
|
1071 | 1073 | return "" |
|
1072 | 1074 | |
|
1073 | 1075 | last_unique, recursion_repeat = find_recursion(orig_etype, evalue, records) |
|
1074 | 1076 | |
|
1075 | 1077 | frames = self.format_records(records, last_unique, recursion_repeat) |
|
1076 | 1078 | |
|
1077 | 1079 | formatted_exception = self.format_exception(etype, evalue) |
|
1078 | 1080 | if records: |
|
1079 | 1081 | filepath, lnum = records[-1][1:3] |
|
1080 | 1082 | filepath = os.path.abspath(filepath) |
|
1081 | 1083 | ipinst = get_ipython() |
|
1082 | 1084 | if ipinst is not None: |
|
1083 | 1085 | ipinst.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
1084 | 1086 | |
|
1085 | 1087 | return [[head] + frames + [''.join(formatted_exception[0])]] |
|
1086 | 1088 | |
|
1087 | 1089 | def get_records(self, etb, number_of_lines_of_context, tb_offset): |
|
1088 | 1090 | try: |
|
1089 | 1091 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
1090 | 1092 | # problems, but it generates empty tracebacks for console errors |
|
1091 | 1093 | # (5 blanks lines) where none should be returned. |
|
1092 | 1094 | return _fixed_getinnerframes(etb, number_of_lines_of_context, tb_offset) |
|
1093 | 1095 | except UnicodeDecodeError: |
|
1094 | 1096 | # This can occur if a file's encoding magic comment is wrong. |
|
1095 | 1097 | # I can't see a way to recover without duplicating a bunch of code |
|
1096 | 1098 | # from the stdlib traceback module. --TK |
|
1097 | 1099 | error('\nUnicodeDecodeError while processing traceback.\n') |
|
1098 | 1100 | return None |
|
1099 | 1101 | except: |
|
1100 | 1102 | # FIXME: I've been getting many crash reports from python 2.3 |
|
1101 | 1103 | # users, traceable to inspect.py. If I can find a small test-case |
|
1102 | 1104 | # to reproduce this, I should either write a better workaround or |
|
1103 | 1105 | # file a bug report against inspect (if that's the real problem). |
|
1104 | 1106 | # So far, I haven't been able to find an isolated example to |
|
1105 | 1107 | # reproduce the problem. |
|
1106 | 1108 | inspect_error() |
|
1107 | 1109 | traceback.print_exc(file=self.ostream) |
|
1108 | 1110 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
1109 | 1111 | return None |
|
1110 | 1112 | |
|
1111 | 1113 | def get_parts_of_chained_exception(self, evalue): |
|
1112 | 1114 | def get_chained_exception(exception_value): |
|
1113 | 1115 | cause = getattr(exception_value, '__cause__', None) |
|
1114 | 1116 | if cause: |
|
1115 | 1117 | return cause |
|
1116 | 1118 | if getattr(exception_value, '__suppress_context__', False): |
|
1117 | 1119 | return None |
|
1118 | 1120 | return getattr(exception_value, '__context__', None) |
|
1119 | 1121 | |
|
1120 | 1122 | chained_evalue = get_chained_exception(evalue) |
|
1121 | 1123 | |
|
1122 | 1124 | if chained_evalue: |
|
1123 | 1125 | return chained_evalue.__class__, chained_evalue, chained_evalue.__traceback__ |
|
1124 | 1126 | |
|
1125 | 1127 | def structured_traceback(self, etype, evalue, etb, tb_offset=None, |
|
1126 | 1128 | number_of_lines_of_context=5): |
|
1127 | 1129 | """Return a nice text document describing the traceback.""" |
|
1128 | 1130 | |
|
1129 | 1131 | formatted_exception = self.format_exception_as_a_whole(etype, evalue, etb, number_of_lines_of_context, |
|
1130 | 1132 | tb_offset) |
|
1131 | 1133 | |
|
1132 | 1134 | colors = self.Colors # just a shorthand + quicker name lookup |
|
1133 | 1135 | colorsnormal = colors.Normal # used a lot |
|
1134 | 1136 | head = '%s%s%s' % (colors.topline, '-' * min(75, get_terminal_size()[0]), colorsnormal) |
|
1135 | 1137 | structured_traceback_parts = [head] |
|
1136 | 1138 | chained_exceptions_tb_offset = 0 |
|
1137 | 1139 | lines_of_context = 3 |
|
1138 | 1140 | formatted_exceptions = formatted_exception |
|
1139 | 1141 | exception = self.get_parts_of_chained_exception(evalue) |
|
1140 | 1142 | if exception: |
|
1141 | 1143 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
1142 | 1144 | etype, evalue, etb = exception |
|
1143 | 1145 | else: |
|
1144 | 1146 | evalue = None |
|
1145 | 1147 | chained_exc_ids = set() |
|
1146 | 1148 | while evalue: |
|
1147 | 1149 | formatted_exceptions += self.format_exception_as_a_whole(etype, evalue, etb, lines_of_context, |
|
1148 | 1150 | chained_exceptions_tb_offset) |
|
1149 | 1151 | exception = self.get_parts_of_chained_exception(evalue) |
|
1150 | 1152 | |
|
1151 | 1153 | if exception and not id(exception[1]) in chained_exc_ids: |
|
1152 | 1154 | chained_exc_ids.add(id(exception[1])) # trace exception to avoid infinite 'cause' loop |
|
1153 | 1155 | formatted_exceptions += self.prepare_chained_exception_message(evalue.__cause__) |
|
1154 | 1156 | etype, evalue, etb = exception |
|
1155 | 1157 | else: |
|
1156 | 1158 | evalue = None |
|
1157 | 1159 | |
|
1158 | 1160 | # we want to see exceptions in a reversed order: |
|
1159 | 1161 | # the first exception should be on top |
|
1160 | 1162 | for formatted_exception in reversed(formatted_exceptions): |
|
1161 | 1163 | structured_traceback_parts += formatted_exception |
|
1162 | 1164 | |
|
1163 | 1165 | return structured_traceback_parts |
|
1164 | 1166 | |
|
1165 | 1167 | def debugger(self, force=False): |
|
1166 | 1168 | """Call up the pdb debugger if desired, always clean up the tb |
|
1167 | 1169 | reference. |
|
1168 | 1170 | |
|
1169 | 1171 | Keywords: |
|
1170 | 1172 | |
|
1171 | 1173 | - force(False): by default, this routine checks the instance call_pdb |
|
1172 | 1174 | flag and does not actually invoke the debugger if the flag is false. |
|
1173 | 1175 | The 'force' option forces the debugger to activate even if the flag |
|
1174 | 1176 | is false. |
|
1175 | 1177 | |
|
1176 | 1178 | If the call_pdb flag is set, the pdb interactive debugger is |
|
1177 | 1179 | invoked. In all cases, the self.tb reference to the current traceback |
|
1178 | 1180 | is deleted to prevent lingering references which hamper memory |
|
1179 | 1181 | management. |
|
1180 | 1182 | |
|
1181 | 1183 | Note that each call to pdb() does an 'import readline', so if your app |
|
1182 | 1184 | requires a special setup for the readline completers, you'll have to |
|
1183 | 1185 | fix that by hand after invoking the exception handler.""" |
|
1184 | 1186 | |
|
1185 | 1187 | if force or self.call_pdb: |
|
1186 | 1188 | if self.pdb is None: |
|
1187 | 1189 | self.pdb = self.debugger_cls() |
|
1188 | 1190 | # the system displayhook may have changed, restore the original |
|
1189 | 1191 | # for pdb |
|
1190 | 1192 | display_trap = DisplayTrap(hook=sys.__displayhook__) |
|
1191 | 1193 | with display_trap: |
|
1192 | 1194 | self.pdb.reset() |
|
1193 | 1195 | # Find the right frame so we don't pop up inside ipython itself |
|
1194 | 1196 | if hasattr(self, 'tb') and self.tb is not None: |
|
1195 | 1197 | etb = self.tb |
|
1196 | 1198 | else: |
|
1197 | 1199 | etb = self.tb = sys.last_traceback |
|
1198 | 1200 | while self.tb is not None and self.tb.tb_next is not None: |
|
1199 | 1201 | self.tb = self.tb.tb_next |
|
1200 | 1202 | if etb and etb.tb_next: |
|
1201 | 1203 | etb = etb.tb_next |
|
1202 | 1204 | self.pdb.botframe = etb.tb_frame |
|
1203 | 1205 | self.pdb.interaction(self.tb.tb_frame, self.tb) |
|
1204 | 1206 | |
|
1205 | 1207 | if hasattr(self, 'tb'): |
|
1206 | 1208 | del self.tb |
|
1207 | 1209 | |
|
1208 | 1210 | def handler(self, info=None): |
|
1209 | 1211 | (etype, evalue, etb) = info or sys.exc_info() |
|
1210 | 1212 | self.tb = etb |
|
1211 | 1213 | ostream = self.ostream |
|
1212 | 1214 | ostream.flush() |
|
1213 | 1215 | ostream.write(self.text(etype, evalue, etb)) |
|
1214 | 1216 | ostream.write('\n') |
|
1215 | 1217 | ostream.flush() |
|
1216 | 1218 | |
|
1217 | 1219 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
1218 | 1220 | # out the right info on its own. |
|
1219 | 1221 | def __call__(self, etype=None, evalue=None, etb=None): |
|
1220 | 1222 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
1221 | 1223 | if etb is None: |
|
1222 | 1224 | self.handler() |
|
1223 | 1225 | else: |
|
1224 | 1226 | self.handler((etype, evalue, etb)) |
|
1225 | 1227 | try: |
|
1226 | 1228 | self.debugger() |
|
1227 | 1229 | except KeyboardInterrupt: |
|
1228 | 1230 | print("\nKeyboardInterrupt") |
|
1229 | 1231 | |
|
1230 | 1232 | |
|
1231 | 1233 | #---------------------------------------------------------------------------- |
|
1232 | 1234 | class FormattedTB(VerboseTB, ListTB): |
|
1233 | 1235 | """Subclass ListTB but allow calling with a traceback. |
|
1234 | 1236 | |
|
1235 | 1237 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
1236 | 1238 | |
|
1237 | 1239 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
1238 | 1240 | |
|
1239 | 1241 | Allows a tb_offset to be specified. This is useful for situations where |
|
1240 | 1242 | one needs to remove a number of topmost frames from the traceback (such as |
|
1241 | 1243 | occurs with python programs that themselves execute other python code, |
|
1242 | 1244 | like Python shells). """ |
|
1243 | 1245 | |
|
1244 | 1246 | def __init__(self, mode='Plain', color_scheme='Linux', call_pdb=False, |
|
1245 | 1247 | ostream=None, |
|
1246 | 1248 | tb_offset=0, long_header=False, include_vars=False, |
|
1247 | 1249 | check_cache=None, debugger_cls=None, |
|
1248 | 1250 | parent=None, config=None): |
|
1249 | 1251 | |
|
1250 | 1252 | # NEVER change the order of this list. Put new modes at the end: |
|
1251 | 1253 | self.valid_modes = ['Plain', 'Context', 'Verbose'] |
|
1252 | 1254 | self.verbose_modes = self.valid_modes[1:3] |
|
1253 | 1255 | |
|
1254 | 1256 | VerboseTB.__init__(self, color_scheme=color_scheme, call_pdb=call_pdb, |
|
1255 | 1257 | ostream=ostream, tb_offset=tb_offset, |
|
1256 | 1258 | long_header=long_header, include_vars=include_vars, |
|
1257 | 1259 | check_cache=check_cache, debugger_cls=debugger_cls, |
|
1258 | 1260 | parent=parent, config=config) |
|
1259 | 1261 | |
|
1260 | 1262 | # Different types of tracebacks are joined with different separators to |
|
1261 | 1263 | # form a single string. They are taken from this dict |
|
1262 | 1264 | self._join_chars = dict(Plain='', Context='\n', Verbose='\n') |
|
1263 | 1265 | # set_mode also sets the tb_join_char attribute |
|
1264 | 1266 | self.set_mode(mode) |
|
1265 | 1267 | |
|
1266 | 1268 | def _extract_tb(self, tb): |
|
1267 | 1269 | if tb: |
|
1268 | 1270 | return traceback.extract_tb(tb) |
|
1269 | 1271 | else: |
|
1270 | 1272 | return None |
|
1271 | 1273 | |
|
1272 | 1274 | def structured_traceback(self, etype, value, tb, tb_offset=None, number_of_lines_of_context=5): |
|
1273 | 1275 | tb_offset = self.tb_offset if tb_offset is None else tb_offset |
|
1274 | 1276 | mode = self.mode |
|
1275 | 1277 | if mode in self.verbose_modes: |
|
1276 | 1278 | # Verbose modes need a full traceback |
|
1277 | 1279 | return VerboseTB.structured_traceback( |
|
1278 | 1280 | self, etype, value, tb, tb_offset, number_of_lines_of_context |
|
1279 | 1281 | ) |
|
1280 | 1282 | else: |
|
1281 | 1283 | # We must check the source cache because otherwise we can print |
|
1282 | 1284 | # out-of-date source code. |
|
1283 | 1285 | self.check_cache() |
|
1284 | 1286 | # Now we can extract and format the exception |
|
1285 | 1287 | elist = self._extract_tb(tb) |
|
1286 | 1288 | return ListTB.structured_traceback( |
|
1287 | 1289 | self, etype, value, elist, tb_offset, number_of_lines_of_context |
|
1288 | 1290 | ) |
|
1289 | 1291 | |
|
1290 | 1292 | def stb2text(self, stb): |
|
1291 | 1293 | """Convert a structured traceback (a list) to a string.""" |
|
1292 | 1294 | return self.tb_join_char.join(stb) |
|
1293 | 1295 | |
|
1294 | 1296 | |
|
1295 | 1297 | def set_mode(self, mode=None): |
|
1296 | 1298 | """Switch to the desired mode. |
|
1297 | 1299 | |
|
1298 | 1300 | If mode is not specified, cycles through the available modes.""" |
|
1299 | 1301 | |
|
1300 | 1302 | if not mode: |
|
1301 | 1303 | new_idx = (self.valid_modes.index(self.mode) + 1 ) % \ |
|
1302 | 1304 | len(self.valid_modes) |
|
1303 | 1305 | self.mode = self.valid_modes[new_idx] |
|
1304 | 1306 | elif mode not in self.valid_modes: |
|
1305 | 1307 | raise ValueError('Unrecognized mode in FormattedTB: <' + mode + '>\n' |
|
1306 | 1308 | 'Valid modes: ' + str(self.valid_modes)) |
|
1307 | 1309 | else: |
|
1308 | 1310 | self.mode = mode |
|
1309 | 1311 | # include variable details only in 'Verbose' mode |
|
1310 | 1312 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
1311 | 1313 | # Set the join character for generating text tracebacks |
|
1312 | 1314 | self.tb_join_char = self._join_chars[self.mode] |
|
1313 | 1315 | |
|
1314 | 1316 | # some convenient shortcuts |
|
1315 | 1317 | def plain(self): |
|
1316 | 1318 | self.set_mode(self.valid_modes[0]) |
|
1317 | 1319 | |
|
1318 | 1320 | def context(self): |
|
1319 | 1321 | self.set_mode(self.valid_modes[1]) |
|
1320 | 1322 | |
|
1321 | 1323 | def verbose(self): |
|
1322 | 1324 | self.set_mode(self.valid_modes[2]) |
|
1323 | 1325 | |
|
1324 | 1326 | |
|
1325 | 1327 | #---------------------------------------------------------------------------- |
|
1326 | 1328 | class AutoFormattedTB(FormattedTB): |
|
1327 | 1329 | """A traceback printer which can be called on the fly. |
|
1328 | 1330 | |
|
1329 | 1331 | It will find out about exceptions by itself. |
|
1330 | 1332 | |
|
1331 | 1333 | A brief example:: |
|
1332 | 1334 | |
|
1333 | 1335 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
1334 | 1336 | try: |
|
1335 | 1337 | ... |
|
1336 | 1338 | except: |
|
1337 | 1339 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
1338 | 1340 | """ |
|
1339 | 1341 | |
|
1340 | 1342 | def __call__(self, etype=None, evalue=None, etb=None, |
|
1341 | 1343 | out=None, tb_offset=None): |
|
1342 | 1344 | """Print out a formatted exception traceback. |
|
1343 | 1345 | |
|
1344 | 1346 | Optional arguments: |
|
1345 | 1347 | - out: an open file-like object to direct output to. |
|
1346 | 1348 | |
|
1347 | 1349 | - tb_offset: the number of frames to skip over in the stack, on a |
|
1348 | 1350 | per-call basis (this overrides temporarily the instance's tb_offset |
|
1349 | 1351 | given at initialization time. """ |
|
1350 | 1352 | |
|
1351 | 1353 | if out is None: |
|
1352 | 1354 | out = self.ostream |
|
1353 | 1355 | out.flush() |
|
1354 | 1356 | out.write(self.text(etype, evalue, etb, tb_offset)) |
|
1355 | 1357 | out.write('\n') |
|
1356 | 1358 | out.flush() |
|
1357 | 1359 | # FIXME: we should remove the auto pdb behavior from here and leave |
|
1358 | 1360 | # that to the clients. |
|
1359 | 1361 | try: |
|
1360 | 1362 | self.debugger() |
|
1361 | 1363 | except KeyboardInterrupt: |
|
1362 | 1364 | print("\nKeyboardInterrupt") |
|
1363 | 1365 | |
|
1364 | 1366 | def structured_traceback(self, etype=None, value=None, tb=None, |
|
1365 | 1367 | tb_offset=None, number_of_lines_of_context=5): |
|
1366 | 1368 | if etype is None: |
|
1367 | 1369 | etype, value, tb = sys.exc_info() |
|
1368 | 1370 | self.tb = tb |
|
1369 | 1371 | return FormattedTB.structured_traceback( |
|
1370 | 1372 | self, etype, value, tb, tb_offset, number_of_lines_of_context) |
|
1371 | 1373 | |
|
1372 | 1374 | |
|
1373 | 1375 | #--------------------------------------------------------------------------- |
|
1374 | 1376 | |
|
1375 | 1377 | # A simple class to preserve Nathan's original functionality. |
|
1376 | 1378 | class ColorTB(FormattedTB): |
|
1377 | 1379 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1378 | 1380 | |
|
1379 | 1381 | def __init__(self, color_scheme='Linux', call_pdb=0, **kwargs): |
|
1380 | 1382 | FormattedTB.__init__(self, color_scheme=color_scheme, |
|
1381 | 1383 | call_pdb=call_pdb, **kwargs) |
|
1382 | 1384 | |
|
1383 | 1385 | |
|
1384 | 1386 | class SyntaxTB(ListTB): |
|
1385 | 1387 | """Extension which holds some state: the last exception value""" |
|
1386 | 1388 | |
|
1387 | 1389 | def __init__(self, color_scheme='NoColor', parent=None, config=None): |
|
1388 | 1390 | ListTB.__init__(self, color_scheme, parent=parent, config=config) |
|
1389 | 1391 | self.last_syntax_error = None |
|
1390 | 1392 | |
|
1391 | 1393 | def __call__(self, etype, value, elist): |
|
1392 | 1394 | self.last_syntax_error = value |
|
1393 | 1395 | |
|
1394 | 1396 | ListTB.__call__(self, etype, value, elist) |
|
1395 | 1397 | |
|
1396 | 1398 | def structured_traceback(self, etype, value, elist, tb_offset=None, |
|
1397 | 1399 | context=5): |
|
1398 | 1400 | # If the source file has been edited, the line in the syntax error can |
|
1399 | 1401 | # be wrong (retrieved from an outdated cache). This replaces it with |
|
1400 | 1402 | # the current value. |
|
1401 | 1403 | if isinstance(value, SyntaxError) \ |
|
1402 | 1404 | and isinstance(value.filename, str) \ |
|
1403 | 1405 | and isinstance(value.lineno, int): |
|
1404 | 1406 | linecache.checkcache(value.filename) |
|
1405 | 1407 | newtext = linecache.getline(value.filename, value.lineno) |
|
1406 | 1408 | if newtext: |
|
1407 | 1409 | value.text = newtext |
|
1408 | 1410 | self.last_syntax_error = value |
|
1409 | 1411 | return super(SyntaxTB, self).structured_traceback(etype, value, elist, |
|
1410 | 1412 | tb_offset=tb_offset, context=context) |
|
1411 | 1413 | |
|
1412 | 1414 | def clear_err_state(self): |
|
1413 | 1415 | """Return the current error state and clear it""" |
|
1414 | 1416 | e = self.last_syntax_error |
|
1415 | 1417 | self.last_syntax_error = None |
|
1416 | 1418 | return e |
|
1417 | 1419 | |
|
1418 | 1420 | def stb2text(self, stb): |
|
1419 | 1421 | """Convert a structured traceback (a list) to a string.""" |
|
1420 | 1422 | return ''.join(stb) |
|
1421 | 1423 | |
|
1422 | 1424 | |
|
1423 | 1425 | # some internal-use functions |
|
1424 | 1426 | def text_repr(value): |
|
1425 | 1427 | """Hopefully pretty robust repr equivalent.""" |
|
1426 | 1428 | # this is pretty horrible but should always return *something* |
|
1427 | 1429 | try: |
|
1428 | 1430 | return pydoc.text.repr(value) |
|
1429 | 1431 | except KeyboardInterrupt: |
|
1430 | 1432 | raise |
|
1431 | 1433 | except: |
|
1432 | 1434 | try: |
|
1433 | 1435 | return repr(value) |
|
1434 | 1436 | except KeyboardInterrupt: |
|
1435 | 1437 | raise |
|
1436 | 1438 | except: |
|
1437 | 1439 | try: |
|
1438 | 1440 | # all still in an except block so we catch |
|
1439 | 1441 | # getattr raising |
|
1440 | 1442 | name = getattr(value, '__name__', None) |
|
1441 | 1443 | if name: |
|
1442 | 1444 | # ick, recursion |
|
1443 | 1445 | return text_repr(name) |
|
1444 | 1446 | klass = getattr(value, '__class__', None) |
|
1445 | 1447 | if klass: |
|
1446 | 1448 | return '%s instance' % text_repr(klass) |
|
1447 | 1449 | except KeyboardInterrupt: |
|
1448 | 1450 | raise |
|
1449 | 1451 | except: |
|
1450 | 1452 | return 'UNRECOVERABLE REPR FAILURE' |
|
1451 | 1453 | |
|
1452 | 1454 | |
|
1453 | 1455 | def eqrepr(value, repr=text_repr): |
|
1454 | 1456 | return '=%s' % repr(value) |
|
1455 | 1457 | |
|
1456 | 1458 | |
|
1457 | 1459 | def nullrepr(value, repr=text_repr): |
|
1458 | 1460 | return '' |
@@ -1,531 +1,531 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | Defines a variety of Pygments lexers for highlighting IPython code. |
|
4 | 4 | |
|
5 | 5 | This includes: |
|
6 | 6 | |
|
7 | 7 | IPythonLexer, IPython3Lexer |
|
8 | 8 | Lexers for pure IPython (python + magic/shell commands) |
|
9 | 9 | |
|
10 | 10 | IPythonPartialTracebackLexer, IPythonTracebackLexer |
|
11 | 11 | Supports 2.x and 3.x via keyword `python3`. The partial traceback |
|
12 | 12 | lexer reads everything but the Python code appearing in a traceback. |
|
13 | 13 | The full lexer combines the partial lexer with an IPython lexer. |
|
14 | 14 | |
|
15 | 15 | IPythonConsoleLexer |
|
16 | 16 | A lexer for IPython console sessions, with support for tracebacks. |
|
17 | 17 | |
|
18 | 18 | IPyLexer |
|
19 | 19 | A friendly lexer which examines the first line of text and from it, |
|
20 | 20 | decides whether to use an IPython lexer or an IPython console lexer. |
|
21 | 21 | This is probably the only lexer that needs to be explicitly added |
|
22 | 22 | to Pygments. |
|
23 | 23 | |
|
24 | 24 | """ |
|
25 | 25 | #----------------------------------------------------------------------------- |
|
26 | 26 | # Copyright (c) 2013, the IPython Development Team. |
|
27 | 27 | # |
|
28 | 28 | # Distributed under the terms of the Modified BSD License. |
|
29 | 29 | # |
|
30 | 30 | # The full license is in the file COPYING.txt, distributed with this software. |
|
31 | 31 | #----------------------------------------------------------------------------- |
|
32 | 32 | |
|
33 | 33 | # Standard library |
|
34 | 34 | import re |
|
35 | 35 | |
|
36 | 36 | # Third party |
|
37 | 37 | from pygments.lexers import ( |
|
38 | 38 | BashLexer, HtmlLexer, JavascriptLexer, RubyLexer, PerlLexer, PythonLexer, |
|
39 | 39 | Python3Lexer, TexLexer) |
|
40 | 40 | from pygments.lexer import ( |
|
41 | 41 | Lexer, DelegatingLexer, RegexLexer, do_insertions, bygroups, using, |
|
42 | 42 | ) |
|
43 | 43 | from pygments.token import ( |
|
44 | 44 | Generic, Keyword, Literal, Name, Operator, Other, Text, Error, |
|
45 | 45 | ) |
|
46 | 46 | from pygments.util import get_bool_opt |
|
47 | 47 | |
|
48 | 48 | # Local |
|
49 | 49 | |
|
50 | 50 | line_re = re.compile('.*?\n') |
|
51 | 51 | |
|
52 | 52 | __all__ = ['build_ipy_lexer', 'IPython3Lexer', 'IPythonLexer', |
|
53 | 53 | 'IPythonPartialTracebackLexer', 'IPythonTracebackLexer', |
|
54 | 54 | 'IPythonConsoleLexer', 'IPyLexer'] |
|
55 | 55 | |
|
56 | 56 | |
|
57 | 57 | def build_ipy_lexer(python3): |
|
58 | 58 | """Builds IPython lexers depending on the value of `python3`. |
|
59 | 59 | |
|
60 | 60 | The lexer inherits from an appropriate Python lexer and then adds |
|
61 | 61 | information about IPython specific keywords (i.e. magic commands, |
|
62 | 62 | shell commands, etc.) |
|
63 | 63 | |
|
64 | 64 | Parameters |
|
65 | 65 | ---------- |
|
66 | 66 | python3 : bool |
|
67 | 67 | If `True`, then build an IPython lexer from a Python 3 lexer. |
|
68 | 68 | |
|
69 | 69 | """ |
|
70 | 70 | # It would be nice to have a single IPython lexer class which takes |
|
71 | 71 | # a boolean `python3`. But since there are two Python lexer classes, |
|
72 | 72 | # we will also have two IPython lexer classes. |
|
73 | 73 | if python3: |
|
74 | 74 | PyLexer = Python3Lexer |
|
75 | 75 | name = 'IPython3' |
|
76 | 76 | aliases = ['ipython3'] |
|
77 | 77 | doc = """IPython3 Lexer""" |
|
78 | 78 | else: |
|
79 | 79 | PyLexer = PythonLexer |
|
80 | 80 | name = 'IPython' |
|
81 | 81 | aliases = ['ipython2', 'ipython'] |
|
82 | 82 | doc = """IPython Lexer""" |
|
83 | 83 | |
|
84 | 84 | ipython_tokens = [ |
|
85 | 85 | (r'(?s)(\s*)(%%capture)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
86 | 86 | (r'(?s)(\s*)(%%debug)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
87 | 87 | (r'(?is)(\s*)(%%html)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(HtmlLexer))), |
|
88 | 88 | (r'(?s)(\s*)(%%javascript)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(JavascriptLexer))), |
|
89 | 89 | (r'(?s)(\s*)(%%js)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(JavascriptLexer))), |
|
90 | 90 | (r'(?s)(\s*)(%%latex)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(TexLexer))), |
|
91 | 91 | (r'(?s)(\s*)(%%pypy)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PerlLexer))), |
|
92 | 92 | (r'(?s)(\s*)(%%prun)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
93 | 93 | (r'(?s)(\s*)(%%pypy)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
94 | 94 | (r'(?s)(\s*)(%%python)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
95 | 95 | (r'(?s)(\s*)(%%python2)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PythonLexer))), |
|
96 | 96 | (r'(?s)(\s*)(%%python3)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(Python3Lexer))), |
|
97 | 97 | (r'(?s)(\s*)(%%ruby)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(RubyLexer))), |
|
98 | 98 | (r'(?s)(\s*)(%%time)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
99 | 99 | (r'(?s)(\s*)(%%timeit)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
100 | 100 | (r'(?s)(\s*)(%%writefile)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(PyLexer))), |
|
101 | 101 | (r"(?s)(\s*)(%%)(\w+)(.*)", bygroups(Text, Operator, Keyword, Text)), |
|
102 | 102 | (r'(?s)(^\s*)(%%!)([^\n]*\n)(.*)', bygroups(Text, Operator, Text, using(BashLexer))), |
|
103 | 103 | (r"(%%?)(\w+)(\?\??)$", bygroups(Operator, Keyword, Operator)), |
|
104 | 104 | (r"\b(\?\??)(\s*)$", bygroups(Operator, Text)), |
|
105 | 105 | (r'(%)(sx|sc|system)(.*)(\n)', bygroups(Operator, Keyword, |
|
106 | 106 | using(BashLexer), Text)), |
|
107 | 107 | (r'(%)(\w+)(.*\n)', bygroups(Operator, Keyword, Text)), |
|
108 | 108 | (r'^(!!)(.+)(\n)', bygroups(Operator, using(BashLexer), Text)), |
|
109 | 109 | (r'(!)(?!=)(.+)(\n)', bygroups(Operator, using(BashLexer), Text)), |
|
110 | 110 | (r'^(\s*)(\?\??)(\s*%{0,2}[\w\.\*]*)', bygroups(Text, Operator, Text)), |
|
111 | 111 | (r'(\s*%{0,2}[\w\.\*]*)(\?\??)(\s*)$', bygroups(Text, Operator, Text)), |
|
112 | 112 | ] |
|
113 | 113 | |
|
114 | 114 | tokens = PyLexer.tokens.copy() |
|
115 | 115 | tokens['root'] = ipython_tokens + tokens['root'] |
|
116 | 116 | |
|
117 | 117 | attrs = {'name': name, 'aliases': aliases, 'filenames': [], |
|
118 | 118 | '__doc__': doc, 'tokens': tokens} |
|
119 | 119 | |
|
120 | 120 | return type(name, (PyLexer,), attrs) |
|
121 | 121 | |
|
122 | 122 | |
|
123 | 123 | IPython3Lexer = build_ipy_lexer(python3=True) |
|
124 | 124 | IPythonLexer = build_ipy_lexer(python3=False) |
|
125 | 125 | |
|
126 | 126 | |
|
127 | 127 | class IPythonPartialTracebackLexer(RegexLexer): |
|
128 | 128 | """ |
|
129 | 129 | Partial lexer for IPython tracebacks. |
|
130 | 130 | |
|
131 | 131 | Handles all the non-python output. This works for both Python 2.x and 3.x. |
|
132 | 132 | |
|
133 | 133 | """ |
|
134 | 134 | name = 'IPython Partial Traceback' |
|
135 | 135 | |
|
136 | 136 | tokens = { |
|
137 | 137 | 'root': [ |
|
138 | 138 | # Tracebacks for syntax errors have a different style. |
|
139 | 139 | # For both types of tracebacks, we mark the first line with |
|
140 | 140 | # Generic.Traceback. For syntax errors, we mark the filename |
|
141 | 141 | # as we mark the filenames for non-syntax tracebacks. |
|
142 | 142 | # |
|
143 | 143 | # These two regexps define how IPythonConsoleLexer finds a |
|
144 | 144 | # traceback. |
|
145 | 145 | # |
|
146 | 146 | ## Non-syntax traceback |
|
147 | 147 | (r'^(\^C)?(-+\n)', bygroups(Error, Generic.Traceback)), |
|
148 | 148 | ## Syntax traceback |
|
149 | 149 | (r'^( File)(.*)(, line )(\d+\n)', |
|
150 | 150 | bygroups(Generic.Traceback, Name.Namespace, |
|
151 | 151 | Generic.Traceback, Literal.Number.Integer)), |
|
152 | 152 | |
|
153 | 153 | # (Exception Identifier)(Whitespace)(Traceback Message) |
|
154 | 154 | (r'(?u)(^[^\d\W]\w*)(\s*)(Traceback.*?\n)', |
|
155 | 155 | bygroups(Name.Exception, Generic.Whitespace, Text)), |
|
156 | 156 | # (Module/Filename)(Text)(Callee)(Function Signature) |
|
157 | 157 | # Better options for callee and function signature? |
|
158 | 158 | (r'(.*)( in )(.*)(\(.*\)\n)', |
|
159 | 159 | bygroups(Name.Namespace, Text, Name.Entity, Name.Tag)), |
|
160 | 160 | # Regular line: (Whitespace)(Line Number)(Python Code) |
|
161 | 161 | (r'(\s*?)(\d+)(.*?\n)', |
|
162 | 162 | bygroups(Generic.Whitespace, Literal.Number.Integer, Other)), |
|
163 | 163 | # Emphasized line: (Arrow)(Line Number)(Python Code) |
|
164 | 164 | # Using Exception token so arrow color matches the Exception. |
|
165 | 165 | (r'(-*>?\s?)(\d+)(.*?\n)', |
|
166 | 166 | bygroups(Name.Exception, Literal.Number.Integer, Other)), |
|
167 | 167 | # (Exception Identifier)(Message) |
|
168 | 168 | (r'(?u)(^[^\d\W]\w*)(:.*?\n)', |
|
169 | 169 | bygroups(Name.Exception, Text)), |
|
170 | 170 | # Tag everything else as Other, will be handled later. |
|
171 | 171 | (r'.*\n', Other), |
|
172 | 172 | ], |
|
173 | 173 | } |
|
174 | 174 | |
|
175 | 175 | |
|
176 | 176 | class IPythonTracebackLexer(DelegatingLexer): |
|
177 | 177 | """ |
|
178 | 178 | IPython traceback lexer. |
|
179 | 179 | |
|
180 | 180 | For doctests, the tracebacks can be snipped as much as desired with the |
|
181 | 181 | exception to the lines that designate a traceback. For non-syntax error |
|
182 | 182 | tracebacks, this is the line of hyphens. For syntax error tracebacks, |
|
183 | 183 | this is the line which lists the File and line number. |
|
184 | 184 | |
|
185 | 185 | """ |
|
186 | 186 | # The lexer inherits from DelegatingLexer. The "root" lexer is an |
|
187 | 187 | # appropriate IPython lexer, which depends on the value of the boolean |
|
188 | 188 | # `python3`. First, we parse with the partial IPython traceback lexer. |
|
189 | 189 | # Then, any code marked with the "Other" token is delegated to the root |
|
190 | 190 | # lexer. |
|
191 | 191 | # |
|
192 | 192 | name = 'IPython Traceback' |
|
193 | 193 | aliases = ['ipythontb'] |
|
194 | 194 | |
|
195 | 195 | def __init__(self, **options): |
|
196 | 196 | self.python3 = get_bool_opt(options, 'python3', False) |
|
197 | 197 | if self.python3: |
|
198 | 198 | self.aliases = ['ipython3tb'] |
|
199 | 199 | else: |
|
200 | 200 | self.aliases = ['ipython2tb', 'ipythontb'] |
|
201 | 201 | |
|
202 | 202 | if self.python3: |
|
203 | 203 | IPyLexer = IPython3Lexer |
|
204 | 204 | else: |
|
205 | 205 | IPyLexer = IPythonLexer |
|
206 | 206 | |
|
207 | 207 | DelegatingLexer.__init__(self, IPyLexer, |
|
208 | 208 | IPythonPartialTracebackLexer, **options) |
|
209 | 209 | |
|
210 | 210 | class IPythonConsoleLexer(Lexer): |
|
211 | 211 | """ |
|
212 | 212 | An IPython console lexer for IPython code-blocks and doctests, such as: |
|
213 | 213 | |
|
214 | 214 | .. code-block:: rst |
|
215 | 215 | |
|
216 | 216 | .. code-block:: ipythonconsole |
|
217 | 217 | |
|
218 | 218 | In [1]: a = 'foo' |
|
219 | 219 | |
|
220 | 220 | In [2]: a |
|
221 | 221 | Out[2]: 'foo' |
|
222 | 222 | |
|
223 | 223 | In [3]: print a |
|
224 | 224 | foo |
|
225 | 225 | |
|
226 | 226 | In [4]: 1 / 0 |
|
227 | 227 | |
|
228 | 228 | |
|
229 | 229 | Support is also provided for IPython exceptions: |
|
230 | 230 | |
|
231 | 231 | .. code-block:: rst |
|
232 | 232 | |
|
233 | 233 | .. code-block:: ipythonconsole |
|
234 | 234 | |
|
235 | 235 | In [1]: raise Exception |
|
236 | 236 | |
|
237 | 237 | --------------------------------------------------------------------------- |
|
238 | 238 | Exception Traceback (most recent call last) |
|
239 |
<ipython-input-1-fca2ab0ca76b> in <module> |
|
|
239 | <ipython-input-1-fca2ab0ca76b> in <module> | |
|
240 | 240 | ----> 1 raise Exception |
|
241 | 241 | |
|
242 | 242 | Exception: |
|
243 | 243 | |
|
244 | 244 | """ |
|
245 | 245 | name = 'IPython console session' |
|
246 | 246 | aliases = ['ipythonconsole'] |
|
247 | 247 | mimetypes = ['text/x-ipython-console'] |
|
248 | 248 | |
|
249 | 249 | # The regexps used to determine what is input and what is output. |
|
250 | 250 | # The default prompts for IPython are: |
|
251 | 251 | # |
|
252 | 252 | # in = 'In [#]: ' |
|
253 | 253 | # continuation = ' .D.: ' |
|
254 | 254 | # template = 'Out[#]: ' |
|
255 | 255 | # |
|
256 | 256 | # Where '#' is the 'prompt number' or 'execution count' and 'D' |
|
257 | 257 | # D is a number of dots matching the width of the execution count |
|
258 | 258 | # |
|
259 | 259 | in1_regex = r'In \[[0-9]+\]: ' |
|
260 | 260 | in2_regex = r' \.\.+\.: ' |
|
261 | 261 | out_regex = r'Out\[[0-9]+\]: ' |
|
262 | 262 | |
|
263 | 263 | #: The regex to determine when a traceback starts. |
|
264 | 264 | ipytb_start = re.compile(r'^(\^C)?(-+\n)|^( File)(.*)(, line )(\d+\n)') |
|
265 | 265 | |
|
266 | 266 | def __init__(self, **options): |
|
267 | 267 | """Initialize the IPython console lexer. |
|
268 | 268 | |
|
269 | 269 | Parameters |
|
270 | 270 | ---------- |
|
271 | 271 | python3 : bool |
|
272 | 272 | If `True`, then the console inputs are parsed using a Python 3 |
|
273 | 273 | lexer. Otherwise, they are parsed using a Python 2 lexer. |
|
274 | 274 | in1_regex : RegexObject |
|
275 | 275 | The compiled regular expression used to detect the start |
|
276 | 276 | of inputs. Although the IPython configuration setting may have a |
|
277 | 277 | trailing whitespace, do not include it in the regex. If `None`, |
|
278 | 278 | then the default input prompt is assumed. |
|
279 | 279 | in2_regex : RegexObject |
|
280 | 280 | The compiled regular expression used to detect the continuation |
|
281 | 281 | of inputs. Although the IPython configuration setting may have a |
|
282 | 282 | trailing whitespace, do not include it in the regex. If `None`, |
|
283 | 283 | then the default input prompt is assumed. |
|
284 | 284 | out_regex : RegexObject |
|
285 | 285 | The compiled regular expression used to detect outputs. If `None`, |
|
286 | 286 | then the default output prompt is assumed. |
|
287 | 287 | |
|
288 | 288 | """ |
|
289 | 289 | self.python3 = get_bool_opt(options, 'python3', False) |
|
290 | 290 | if self.python3: |
|
291 | 291 | self.aliases = ['ipython3console'] |
|
292 | 292 | else: |
|
293 | 293 | self.aliases = ['ipython2console', 'ipythonconsole'] |
|
294 | 294 | |
|
295 | 295 | in1_regex = options.get('in1_regex', self.in1_regex) |
|
296 | 296 | in2_regex = options.get('in2_regex', self.in2_regex) |
|
297 | 297 | out_regex = options.get('out_regex', self.out_regex) |
|
298 | 298 | |
|
299 | 299 | # So that we can work with input and output prompts which have been |
|
300 | 300 | # rstrip'd (possibly by editors) we also need rstrip'd variants. If |
|
301 | 301 | # we do not do this, then such prompts will be tagged as 'output'. |
|
302 | 302 | # The reason can't just use the rstrip'd variants instead is because |
|
303 | 303 | # we want any whitespace associated with the prompt to be inserted |
|
304 | 304 | # with the token. This allows formatted code to be modified so as hide |
|
305 | 305 | # the appearance of prompts, with the whitespace included. One example |
|
306 | 306 | # use of this is in copybutton.js from the standard lib Python docs. |
|
307 | 307 | in1_regex_rstrip = in1_regex.rstrip() + '\n' |
|
308 | 308 | in2_regex_rstrip = in2_regex.rstrip() + '\n' |
|
309 | 309 | out_regex_rstrip = out_regex.rstrip() + '\n' |
|
310 | 310 | |
|
311 | 311 | # Compile and save them all. |
|
312 | 312 | attrs = ['in1_regex', 'in2_regex', 'out_regex', |
|
313 | 313 | 'in1_regex_rstrip', 'in2_regex_rstrip', 'out_regex_rstrip'] |
|
314 | 314 | for attr in attrs: |
|
315 | 315 | self.__setattr__(attr, re.compile(locals()[attr])) |
|
316 | 316 | |
|
317 | 317 | Lexer.__init__(self, **options) |
|
318 | 318 | |
|
319 | 319 | if self.python3: |
|
320 | 320 | pylexer = IPython3Lexer |
|
321 | 321 | tblexer = IPythonTracebackLexer |
|
322 | 322 | else: |
|
323 | 323 | pylexer = IPythonLexer |
|
324 | 324 | tblexer = IPythonTracebackLexer |
|
325 | 325 | |
|
326 | 326 | self.pylexer = pylexer(**options) |
|
327 | 327 | self.tblexer = tblexer(**options) |
|
328 | 328 | |
|
329 | 329 | self.reset() |
|
330 | 330 | |
|
331 | 331 | def reset(self): |
|
332 | 332 | self.mode = 'output' |
|
333 | 333 | self.index = 0 |
|
334 | 334 | self.buffer = u'' |
|
335 | 335 | self.insertions = [] |
|
336 | 336 | |
|
337 | 337 | def buffered_tokens(self): |
|
338 | 338 | """ |
|
339 | 339 | Generator of unprocessed tokens after doing insertions and before |
|
340 | 340 | changing to a new state. |
|
341 | 341 | |
|
342 | 342 | """ |
|
343 | 343 | if self.mode == 'output': |
|
344 | 344 | tokens = [(0, Generic.Output, self.buffer)] |
|
345 | 345 | elif self.mode == 'input': |
|
346 | 346 | tokens = self.pylexer.get_tokens_unprocessed(self.buffer) |
|
347 | 347 | else: # traceback |
|
348 | 348 | tokens = self.tblexer.get_tokens_unprocessed(self.buffer) |
|
349 | 349 | |
|
350 | 350 | for i, t, v in do_insertions(self.insertions, tokens): |
|
351 | 351 | # All token indexes are relative to the buffer. |
|
352 | 352 | yield self.index + i, t, v |
|
353 | 353 | |
|
354 | 354 | # Clear it all |
|
355 | 355 | self.index += len(self.buffer) |
|
356 | 356 | self.buffer = u'' |
|
357 | 357 | self.insertions = [] |
|
358 | 358 | |
|
359 | 359 | def get_mci(self, line): |
|
360 | 360 | """ |
|
361 | 361 | Parses the line and returns a 3-tuple: (mode, code, insertion). |
|
362 | 362 | |
|
363 | 363 | `mode` is the next mode (or state) of the lexer, and is always equal |
|
364 | 364 | to 'input', 'output', or 'tb'. |
|
365 | 365 | |
|
366 | 366 | `code` is a portion of the line that should be added to the buffer |
|
367 | 367 | corresponding to the next mode and eventually lexed by another lexer. |
|
368 | 368 | For example, `code` could be Python code if `mode` were 'input'. |
|
369 | 369 | |
|
370 | 370 | `insertion` is a 3-tuple (index, token, text) representing an |
|
371 | 371 | unprocessed "token" that will be inserted into the stream of tokens |
|
372 | 372 | that are created from the buffer once we change modes. This is usually |
|
373 | 373 | the input or output prompt. |
|
374 | 374 | |
|
375 | 375 | In general, the next mode depends on current mode and on the contents |
|
376 | 376 | of `line`. |
|
377 | 377 | |
|
378 | 378 | """ |
|
379 | 379 | # To reduce the number of regex match checks, we have multiple |
|
380 | 380 | # 'if' blocks instead of 'if-elif' blocks. |
|
381 | 381 | |
|
382 | 382 | # Check for possible end of input |
|
383 | 383 | in2_match = self.in2_regex.match(line) |
|
384 | 384 | in2_match_rstrip = self.in2_regex_rstrip.match(line) |
|
385 | 385 | if (in2_match and in2_match.group().rstrip() == line.rstrip()) or \ |
|
386 | 386 | in2_match_rstrip: |
|
387 | 387 | end_input = True |
|
388 | 388 | else: |
|
389 | 389 | end_input = False |
|
390 | 390 | if end_input and self.mode != 'tb': |
|
391 | 391 | # Only look for an end of input when not in tb mode. |
|
392 | 392 | # An ellipsis could appear within the traceback. |
|
393 | 393 | mode = 'output' |
|
394 | 394 | code = u'' |
|
395 | 395 | insertion = (0, Generic.Prompt, line) |
|
396 | 396 | return mode, code, insertion |
|
397 | 397 | |
|
398 | 398 | # Check for output prompt |
|
399 | 399 | out_match = self.out_regex.match(line) |
|
400 | 400 | out_match_rstrip = self.out_regex_rstrip.match(line) |
|
401 | 401 | if out_match or out_match_rstrip: |
|
402 | 402 | mode = 'output' |
|
403 | 403 | if out_match: |
|
404 | 404 | idx = out_match.end() |
|
405 | 405 | else: |
|
406 | 406 | idx = out_match_rstrip.end() |
|
407 | 407 | code = line[idx:] |
|
408 | 408 | # Use the 'heading' token for output. We cannot use Generic.Error |
|
409 | 409 | # since it would conflict with exceptions. |
|
410 | 410 | insertion = (0, Generic.Heading, line[:idx]) |
|
411 | 411 | return mode, code, insertion |
|
412 | 412 | |
|
413 | 413 | |
|
414 | 414 | # Check for input or continuation prompt (non stripped version) |
|
415 | 415 | in1_match = self.in1_regex.match(line) |
|
416 | 416 | if in1_match or (in2_match and self.mode != 'tb'): |
|
417 | 417 | # New input or when not in tb, continued input. |
|
418 | 418 | # We do not check for continued input when in tb since it is |
|
419 | 419 | # allowable to replace a long stack with an ellipsis. |
|
420 | 420 | mode = 'input' |
|
421 | 421 | if in1_match: |
|
422 | 422 | idx = in1_match.end() |
|
423 | 423 | else: # in2_match |
|
424 | 424 | idx = in2_match.end() |
|
425 | 425 | code = line[idx:] |
|
426 | 426 | insertion = (0, Generic.Prompt, line[:idx]) |
|
427 | 427 | return mode, code, insertion |
|
428 | 428 | |
|
429 | 429 | # Check for input or continuation prompt (stripped version) |
|
430 | 430 | in1_match_rstrip = self.in1_regex_rstrip.match(line) |
|
431 | 431 | if in1_match_rstrip or (in2_match_rstrip and self.mode != 'tb'): |
|
432 | 432 | # New input or when not in tb, continued input. |
|
433 | 433 | # We do not check for continued input when in tb since it is |
|
434 | 434 | # allowable to replace a long stack with an ellipsis. |
|
435 | 435 | mode = 'input' |
|
436 | 436 | if in1_match_rstrip: |
|
437 | 437 | idx = in1_match_rstrip.end() |
|
438 | 438 | else: # in2_match |
|
439 | 439 | idx = in2_match_rstrip.end() |
|
440 | 440 | code = line[idx:] |
|
441 | 441 | insertion = (0, Generic.Prompt, line[:idx]) |
|
442 | 442 | return mode, code, insertion |
|
443 | 443 | |
|
444 | 444 | # Check for traceback |
|
445 | 445 | if self.ipytb_start.match(line): |
|
446 | 446 | mode = 'tb' |
|
447 | 447 | code = line |
|
448 | 448 | insertion = None |
|
449 | 449 | return mode, code, insertion |
|
450 | 450 | |
|
451 | 451 | # All other stuff... |
|
452 | 452 | if self.mode in ('input', 'output'): |
|
453 | 453 | # We assume all other text is output. Multiline input that |
|
454 | 454 | # does not use the continuation marker cannot be detected. |
|
455 | 455 | # For example, the 3 in the following is clearly output: |
|
456 | 456 | # |
|
457 | 457 | # In [1]: print 3 |
|
458 | 458 | # 3 |
|
459 | 459 | # |
|
460 | 460 | # But the following second line is part of the input: |
|
461 | 461 | # |
|
462 | 462 | # In [2]: while True: |
|
463 | 463 | # print True |
|
464 | 464 | # |
|
465 | 465 | # In both cases, the 2nd line will be 'output'. |
|
466 | 466 | # |
|
467 | 467 | mode = 'output' |
|
468 | 468 | else: |
|
469 | 469 | mode = 'tb' |
|
470 | 470 | |
|
471 | 471 | code = line |
|
472 | 472 | insertion = None |
|
473 | 473 | |
|
474 | 474 | return mode, code, insertion |
|
475 | 475 | |
|
476 | 476 | def get_tokens_unprocessed(self, text): |
|
477 | 477 | self.reset() |
|
478 | 478 | for match in line_re.finditer(text): |
|
479 | 479 | line = match.group() |
|
480 | 480 | mode, code, insertion = self.get_mci(line) |
|
481 | 481 | |
|
482 | 482 | if mode != self.mode: |
|
483 | 483 | # Yield buffered tokens before transitioning to new mode. |
|
484 | 484 | for token in self.buffered_tokens(): |
|
485 | 485 | yield token |
|
486 | 486 | self.mode = mode |
|
487 | 487 | |
|
488 | 488 | if insertion: |
|
489 | 489 | self.insertions.append((len(self.buffer), [insertion])) |
|
490 | 490 | self.buffer += code |
|
491 | 491 | |
|
492 | 492 | for token in self.buffered_tokens(): |
|
493 | 493 | yield token |
|
494 | 494 | |
|
495 | 495 | class IPyLexer(Lexer): |
|
496 | 496 | """ |
|
497 | 497 | Primary lexer for all IPython-like code. |
|
498 | 498 | |
|
499 | 499 | This is a simple helper lexer. If the first line of the text begins with |
|
500 | 500 | "In \[[0-9]+\]:", then the entire text is parsed with an IPython console |
|
501 | 501 | lexer. If not, then the entire text is parsed with an IPython lexer. |
|
502 | 502 | |
|
503 | 503 | The goal is to reduce the number of lexers that are registered |
|
504 | 504 | with Pygments. |
|
505 | 505 | |
|
506 | 506 | """ |
|
507 | 507 | name = 'IPy session' |
|
508 | 508 | aliases = ['ipy'] |
|
509 | 509 | |
|
510 | 510 | def __init__(self, **options): |
|
511 | 511 | self.python3 = get_bool_opt(options, 'python3', False) |
|
512 | 512 | if self.python3: |
|
513 | 513 | self.aliases = ['ipy3'] |
|
514 | 514 | else: |
|
515 | 515 | self.aliases = ['ipy2', 'ipy'] |
|
516 | 516 | |
|
517 | 517 | Lexer.__init__(self, **options) |
|
518 | 518 | |
|
519 | 519 | self.IPythonLexer = IPythonLexer(**options) |
|
520 | 520 | self.IPythonConsoleLexer = IPythonConsoleLexer(**options) |
|
521 | 521 | |
|
522 | 522 | def get_tokens_unprocessed(self, text): |
|
523 | 523 | # Search for the input prompt anywhere...this allows code blocks to |
|
524 | 524 | # begin with comments as well. |
|
525 | 525 | if re.match(r'.*(In \[[0-9]+\]:)', text.strip(), re.DOTALL): |
|
526 | 526 | lex = self.IPythonConsoleLexer |
|
527 | 527 | else: |
|
528 | 528 | lex = self.IPythonLexer |
|
529 | 529 | for token in lex.get_tokens_unprocessed(text): |
|
530 | 530 | yield token |
|
531 | 531 |
@@ -1,1037 +1,1037 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 and |
|
15 | 15 | exits. If you add the ``-i`` flag, it drops you into the interpreter while still |
|
16 | 16 | acknowledging any options you may have set in your ``ipython_config.py``. This |
|
17 | 17 | behavior is different from standard Python, which when called as python ``-i`` |
|
18 | 18 | will only execute one file and ignore your configuration setup. |
|
19 | 19 | |
|
20 | 20 | Please note that some of the configuration options are not available at the |
|
21 | 21 | command line, simply because they are not practical here. Look into your |
|
22 | 22 | configuration files for details on those. There are separate configuration files |
|
23 | 23 | for each profile, and the files look like :file:`ipython_config.py` or |
|
24 | 24 | :file:`ipython_config_{frontendname}.py`. Profile directories look like |
|
25 | 25 | :file:`profile_{profilename}` and are typically installed in the |
|
26 | 26 | :envvar:`IPYTHONDIR` directory, which defaults to :file:`$HOME/.ipython`. For |
|
27 | 27 | Windows users, :envvar:`HOME` resolves to :file:`C:\\Users\\{YourUserName}` in |
|
28 | 28 | most instances. |
|
29 | 29 | |
|
30 | 30 | Command-line Options |
|
31 | 31 | -------------------- |
|
32 | 32 | |
|
33 | 33 | To see the options IPython accepts, use ``ipython --help`` (and you probably |
|
34 | 34 | should run the output through a pager such as ``ipython --help | less`` for |
|
35 | 35 | more convenient reading). This shows all the options that have a single-word |
|
36 | 36 | alias to control them, but IPython lets you configure all of its objects from |
|
37 | 37 | the command-line by passing the full class name and a corresponding value; type |
|
38 | 38 | ``ipython --help-all`` to see this full list. For example:: |
|
39 | 39 | |
|
40 | 40 | $ ipython --help-all |
|
41 | 41 | <...snip...> |
|
42 | 42 | --matplotlib=<CaselessStrEnum> (InteractiveShellApp.matplotlib) |
|
43 | 43 | Default: None |
|
44 | 44 | Choices: ['auto', 'gtk', 'gtk3', 'inline', 'nbagg', 'notebook', 'osx', 'qt', 'qt4', 'qt5', 'tk', 'wx'] |
|
45 | 45 | Configure matplotlib for interactive use with the default matplotlib |
|
46 | 46 | backend. |
|
47 | 47 | <...snip...> |
|
48 | 48 | |
|
49 | 49 | |
|
50 | 50 | Indicate that the following:: |
|
51 | 51 | |
|
52 | 52 | $ ipython --matplotlib qt |
|
53 | 53 | |
|
54 | 54 | |
|
55 | 55 | is equivalent to:: |
|
56 | 56 | |
|
57 | 57 | $ ipython --TerminalIPythonApp.matplotlib='qt' |
|
58 | 58 | |
|
59 | 59 | Note that in the second form, you *must* use the equal sign, as the expression |
|
60 | 60 | is evaluated as an actual Python assignment. While in the above example the |
|
61 | 61 | short form is more convenient, only the most common options have a short form, |
|
62 | 62 | while any configurable variable in IPython can be set at the command-line by |
|
63 | 63 | using the long form. This long form is the same syntax used in the |
|
64 | 64 | configuration files, if you want to set these options permanently. |
|
65 | 65 | |
|
66 | 66 | |
|
67 | 67 | Interactive use |
|
68 | 68 | =============== |
|
69 | 69 | |
|
70 | 70 | IPython is meant to work as a drop-in replacement for the standard interactive |
|
71 | 71 | interpreter. As such, any code which is valid python should execute normally |
|
72 | 72 | under IPython (cases where this is not true should be reported as bugs). It |
|
73 | 73 | does, however, offer many features which are not available at a standard python |
|
74 | 74 | prompt. What follows is a list of these. |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | Caution for Windows users |
|
78 | 78 | ------------------------- |
|
79 | 79 | |
|
80 | 80 | Windows, unfortunately, uses the '\\' character as a path separator. This is a |
|
81 | 81 | terrible choice, because '\\' also represents the escape character in most |
|
82 | 82 | modern programming languages, including Python. For this reason, using '/' |
|
83 | 83 | character is recommended if you have problems with ``\``. However, in Windows |
|
84 | 84 | commands '/' flags options, so you can not use it for the root directory. This |
|
85 | 85 | means that paths beginning at the root must be typed in a contrived manner |
|
86 | 86 | like: ``%copy \opt/foo/bar.txt \tmp`` |
|
87 | 87 | |
|
88 | 88 | .. _magic: |
|
89 | 89 | |
|
90 | 90 | Magic command system |
|
91 | 91 | -------------------- |
|
92 | 92 | |
|
93 | 93 | IPython will treat any line whose first character is a % as a special |
|
94 | 94 | call to a 'magic' function. These allow you to control the behavior of |
|
95 | 95 | IPython itself, plus a lot of system-type features. They are all |
|
96 | 96 | prefixed with a % character, but parameters are given without |
|
97 | 97 | parentheses or quotes. |
|
98 | 98 | |
|
99 | 99 | Lines that begin with ``%%`` signal a *cell magic*: they take as arguments not |
|
100 | 100 | only the rest of the current line, but all lines below them as well, in the |
|
101 | 101 | current execution block. Cell magics can in fact make arbitrary modifications |
|
102 | 102 | to the input they receive, which need not even be valid Python code at all. |
|
103 | 103 | They receive the whole block as a single string. |
|
104 | 104 | |
|
105 | 105 | As a line magic example, the :magic:`cd` magic works just like the OS command of |
|
106 | 106 | the same name:: |
|
107 | 107 | |
|
108 | 108 | In [8]: %cd |
|
109 | 109 | /home/fperez |
|
110 | 110 | |
|
111 | 111 | The following uses the builtin :magic:`timeit` in cell mode:: |
|
112 | 112 | |
|
113 | 113 | In [10]: %%timeit x = range(10000) |
|
114 | 114 | ...: min(x) |
|
115 | 115 | ...: max(x) |
|
116 | 116 | ...: |
|
117 | 117 | 1000 loops, best of 3: 438 us per loop |
|
118 | 118 | |
|
119 | 119 | In this case, ``x = range(10000)`` is called as the line argument, and the |
|
120 | 120 | block with ``min(x)`` and ``max(x)`` is called as the cell body. The |
|
121 | 121 | :magic:`timeit` magic receives both. |
|
122 | 122 | |
|
123 | 123 | If you have 'automagic' enabled (as it is by default), you don't need to type in |
|
124 | 124 | the single ``%`` explicitly for line magics; IPython will scan its internal |
|
125 | 125 | list of magic functions and call one if it exists. With automagic on you can |
|
126 | 126 | then just type ``cd mydir`` to go to directory 'mydir':: |
|
127 | 127 | |
|
128 | 128 | In [9]: cd mydir |
|
129 | 129 | /home/fperez/mydir |
|
130 | 130 | |
|
131 | 131 | Cell magics *always* require an explicit ``%%`` prefix, automagic |
|
132 | 132 | calling only works for line magics. |
|
133 | 133 | |
|
134 | 134 | The automagic system has the lowest possible precedence in name searches, so |
|
135 | 135 | you can freely use variables with the same names as magic commands. If a magic |
|
136 | 136 | command is 'shadowed' by a variable, you will need the explicit ``%`` prefix to |
|
137 | 137 | use it: |
|
138 | 138 | |
|
139 | 139 | .. sourcecode:: ipython |
|
140 | 140 | |
|
141 | 141 | In [1]: cd ipython # %cd is called by automagic |
|
142 | 142 | /home/fperez/ipython |
|
143 | 143 | |
|
144 | 144 | In [2]: cd=1 # now cd is just a variable |
|
145 | 145 | |
|
146 | 146 | In [3]: cd .. # and doesn't work as a function anymore |
|
147 | 147 | File "<ipython-input-3-9fedb3aff56c>", line 1 |
|
148 | 148 | cd .. |
|
149 | 149 | ^ |
|
150 | 150 | SyntaxError: invalid syntax |
|
151 | 151 | |
|
152 | 152 | |
|
153 | 153 | In [4]: %cd .. # but %cd always works |
|
154 | 154 | /home/fperez |
|
155 | 155 | |
|
156 | 156 | In [5]: del cd # if you remove the cd variable, automagic works again |
|
157 | 157 | |
|
158 | 158 | In [6]: cd ipython |
|
159 | 159 | |
|
160 | 160 | /home/fperez/ipython |
|
161 | 161 | |
|
162 | 162 | Line magics, if they return a value, can be assigned to a variable using the |
|
163 | 163 | syntax ``l = %sx ls`` (which in this particular case returns the result of `ls` |
|
164 | 164 | as a python list). See :ref:`below <manual_capture>` for more information. |
|
165 | 165 | |
|
166 | 166 | Type ``%magic`` for more information, including a list of all available magic |
|
167 | 167 | functions at any time and their docstrings. You can also type |
|
168 | 168 | ``%magic_function_name?`` (see :ref:`below <dynamic_object_info>` for |
|
169 | 169 | information on the '?' system) to get information about any particular magic |
|
170 | 170 | function you are interested in. |
|
171 | 171 | |
|
172 | 172 | The API documentation for the :mod:`IPython.core.magic` module contains the full |
|
173 | 173 | docstrings of all currently available magic commands. |
|
174 | 174 | |
|
175 | 175 | .. seealso:: |
|
176 | 176 | |
|
177 | 177 | :doc:`magics` |
|
178 | 178 | A list of the line and cell magics available in IPython by default |
|
179 | 179 | |
|
180 | 180 | :ref:`defining_magics` |
|
181 | 181 | How to define and register additional magic functions |
|
182 | 182 | |
|
183 | 183 | |
|
184 | 184 | Access to the standard Python help |
|
185 | 185 | ---------------------------------- |
|
186 | 186 | |
|
187 | 187 | Simply type ``help()`` to access Python's standard help system. You can |
|
188 | 188 | also type ``help(object)`` for information about a given object, or |
|
189 | 189 | ``help('keyword')`` for information on a keyword. You may need to configure your |
|
190 | 190 | PYTHONDOCS environment variable for this feature to work correctly. |
|
191 | 191 | |
|
192 | 192 | .. _dynamic_object_info: |
|
193 | 193 | |
|
194 | 194 | Dynamic object information |
|
195 | 195 | -------------------------- |
|
196 | 196 | |
|
197 | 197 | Typing ``?word`` or ``word?`` prints detailed information about an object. If |
|
198 | 198 | certain strings in the object are too long (e.g. function signatures) they get |
|
199 | 199 | snipped in the center for brevity. This system gives access variable types and |
|
200 | 200 | values, docstrings, function prototypes and other useful information. |
|
201 | 201 | |
|
202 | 202 | If the information will not fit in the terminal, it is displayed in a pager |
|
203 | 203 | (``less`` if available, otherwise a basic internal pager). |
|
204 | 204 | |
|
205 | 205 | Typing ``??word`` or ``word??`` gives access to the full information, including |
|
206 | 206 | the source code where possible. Long strings are not snipped. |
|
207 | 207 | |
|
208 | 208 | The following magic functions are particularly useful for gathering |
|
209 | 209 | information about your working environment: |
|
210 | 210 | |
|
211 | 211 | * :magic:`pdoc` **<object>**: Print (or run through a pager if too long) the |
|
212 | 212 | docstring for an object. If the given object is a class, it will |
|
213 | 213 | print both the class and the constructor docstrings. |
|
214 | 214 | * :magic:`pdef` **<object>**: Print the call signature for any callable |
|
215 | 215 | object. If the object is a class, print the constructor information. |
|
216 | 216 | * :magic:`psource` **<object>**: Print (or run through a pager if too long) |
|
217 | 217 | the source code for an object. |
|
218 | 218 | * :magic:`pfile` **<object>**: Show the entire source file where an object was |
|
219 | 219 | defined via a pager, opening it at the line where the object |
|
220 | 220 | definition begins. |
|
221 | 221 | * :magic:`who`/:magic:`whos`: These functions give information about identifiers |
|
222 | 222 | you have defined interactively (not things you loaded or defined |
|
223 | 223 | in your configuration files). %who just prints a list of |
|
224 | 224 | identifiers and %whos prints a table with some basic details about |
|
225 | 225 | each identifier. |
|
226 | 226 | |
|
227 | 227 | The dynamic object information functions (?/??, ``%pdoc``, |
|
228 | 228 | ``%pfile``, ``%pdef``, ``%psource``) work on object attributes, as well as |
|
229 | 229 | directly on variables. For example, after doing ``import os``, you can use |
|
230 | 230 | ``os.path.abspath??``. |
|
231 | 231 | |
|
232 | 232 | |
|
233 | 233 | Command line completion |
|
234 | 234 | +++++++++++++++++++++++ |
|
235 | 235 | |
|
236 | 236 | At any time, hitting TAB will complete any available python commands or |
|
237 | 237 | variable names, and show you a list of the possible completions if |
|
238 | 238 | there's no unambiguous one. It will also complete filenames in the |
|
239 | 239 | current directory if no python names match what you've typed so far. |
|
240 | 240 | |
|
241 | 241 | |
|
242 | 242 | Search command history |
|
243 | 243 | ++++++++++++++++++++++ |
|
244 | 244 | |
|
245 | 245 | IPython provides two ways for searching through previous input and thus |
|
246 | 246 | reduce the need for repetitive typing: |
|
247 | 247 | |
|
248 | 248 | 1. Start typing, and then use the up and down arrow keys (or :kbd:`Ctrl-p` |
|
249 | 249 | and :kbd:`Ctrl-n`) to search through only the history items that match |
|
250 | 250 | what you've typed so far. |
|
251 | 251 | 2. Hit :kbd:`Ctrl-r`: to open a search prompt. Begin typing and the system |
|
252 | 252 | searches your history for lines that contain what you've typed so |
|
253 | 253 | far, completing as much as it can. |
|
254 | 254 | |
|
255 | 255 | IPython will save your input history when it leaves and reload it next |
|
256 | 256 | time you restart it. By default, the history file is named |
|
257 | 257 | :file:`.ipython/profile_{name}/history.sqlite`. |
|
258 | 258 | |
|
259 | 259 | Autoindent |
|
260 | 260 | ++++++++++ |
|
261 | 261 | |
|
262 | 262 | Starting with 5.0, IPython uses `prompt_toolkit` in place of ``readline``, |
|
263 | 263 | it thus can recognize lines ending in ':' and indent the next line, |
|
264 | 264 | while also un-indenting automatically after 'raise' or 'return', |
|
265 | 265 | and support real multi-line editing as well as syntactic coloration |
|
266 | 266 | during edition. |
|
267 | 267 | |
|
268 | 268 | This feature does not use the ``readline`` library anymore, so it will |
|
269 | 269 | not honor your :file:`~/.inputrc` configuration (or whatever |
|
270 | 270 | file your :envvar:`INPUTRC` environment variable points to). |
|
271 | 271 | |
|
272 | 272 | In particular if you want to change the input mode to ``vi``, you will need to |
|
273 | 273 | set the ``TerminalInteractiveShell.editing_mode`` configuration option of IPython. |
|
274 | 274 | |
|
275 | 275 | Session logging and restoring |
|
276 | 276 | ----------------------------- |
|
277 | 277 | |
|
278 | 278 | You can log all input from a session either by starting IPython with the |
|
279 | 279 | command line switch ``--logfile=foo.py`` (see :ref:`here <command_line_options>`) |
|
280 | 280 | or by activating the logging at any moment with the magic function :magic:`logstart`. |
|
281 | 281 | |
|
282 | 282 | Log files can later be reloaded by running them as scripts and IPython |
|
283 | 283 | will attempt to 'replay' the log by executing all the lines in it, thus |
|
284 | 284 | restoring the state of a previous session. This feature is not quite |
|
285 | 285 | perfect, but can still be useful in many cases. |
|
286 | 286 | |
|
287 | 287 | The log files can also be used as a way to have a permanent record of |
|
288 | 288 | any code you wrote while experimenting. Log files are regular text files |
|
289 | 289 | which you can later open in your favorite text editor to extract code or |
|
290 | 290 | to 'clean them up' before using them to replay a session. |
|
291 | 291 | |
|
292 | 292 | The :magic:`logstart` function for activating logging in mid-session is used as |
|
293 | 293 | follows:: |
|
294 | 294 | |
|
295 | 295 | %logstart [log_name [log_mode]] |
|
296 | 296 | |
|
297 | 297 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
298 | 298 | current working directory, in 'rotate' mode (see below). |
|
299 | 299 | |
|
300 | 300 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
301 | 301 | history up to that point and then continues logging. |
|
302 | 302 | |
|
303 | 303 | %logstart takes a second optional parameter: logging mode. This can be |
|
304 | 304 | one of (note that the modes are given unquoted): |
|
305 | 305 | |
|
306 | 306 | * [over:] overwrite existing log_name. |
|
307 | 307 | * [backup:] rename (if exists) to log_name~ and start log_name. |
|
308 | 308 | * [append:] well, that says it. |
|
309 | 309 | * [rotate:] create rotating logs log_name.1~, log_name.2~, etc. |
|
310 | 310 | |
|
311 | 311 | The :magic:`logoff` and :magic:`logon` functions allow you to temporarily stop and |
|
312 | 312 | resume logging to a file which had previously been started with |
|
313 | 313 | %logstart. They will fail (with an explanation) if you try to use them |
|
314 | 314 | before logging has been started. |
|
315 | 315 | |
|
316 | 316 | .. _system_shell_access: |
|
317 | 317 | |
|
318 | 318 | System shell access |
|
319 | 319 | ------------------- |
|
320 | 320 | |
|
321 | 321 | Any input line beginning with a ``!`` character is passed verbatim (minus |
|
322 | 322 | the ``!``, of course) to the underlying operating system. For example, |
|
323 | 323 | typing ``!ls`` will run 'ls' in the current directory. |
|
324 | 324 | |
|
325 | 325 | .. _manual_capture: |
|
326 | 326 | |
|
327 | 327 | Manual capture of command output and magic output |
|
328 | 328 | ------------------------------------------------- |
|
329 | 329 | |
|
330 | 330 | You can assign the result of a system command to a Python variable with the |
|
331 | 331 | syntax ``myfiles = !ls``. Similarly, the result of a magic (as long as it returns |
|
332 | 332 | a value) can be assigned to a variable. For example, the syntax ``myfiles = %sx ls`` |
|
333 | 333 | is equivalent to the above system command example (the :magic:`sx` magic runs a shell command |
|
334 | 334 | and captures the output). Each of these gets machine |
|
335 | 335 | readable output from stdout (e.g. without colours), and splits on newlines. To |
|
336 | 336 | explicitly get this sort of output without assigning to a variable, use two |
|
337 | 337 | exclamation marks (``!!ls``) or the :magic:`sx` magic command without an assignment. |
|
338 | 338 | (However, ``!!`` commands cannot be assigned to a variable.) |
|
339 | 339 | |
|
340 | 340 | The captured list in this example has some convenience features. ``myfiles.n`` or ``myfiles.s`` |
|
341 | 341 | returns a string delimited by newlines or spaces, respectively. ``myfiles.p`` |
|
342 | 342 | produces `path objects <http://pypi.python.org/pypi/path.py>`_ from the list items. |
|
343 | 343 | See :ref:`string_lists` for details. |
|
344 | 344 | |
|
345 | 345 | IPython also allows you to expand the value of python variables when |
|
346 | 346 | making system calls. Wrap variables or expressions in {braces}:: |
|
347 | 347 | |
|
348 | 348 | In [1]: pyvar = 'Hello world' |
|
349 | 349 | In [2]: !echo "A python variable: {pyvar}" |
|
350 | 350 | A python variable: Hello world |
|
351 | 351 | In [3]: import math |
|
352 | 352 | In [4]: x = 8 |
|
353 | 353 | In [5]: !echo {math.factorial(x)} |
|
354 | 354 | 40320 |
|
355 | 355 | |
|
356 | 356 | For simple cases, you can alternatively prepend $ to a variable name:: |
|
357 | 357 | |
|
358 | 358 | In [6]: !echo $sys.argv |
|
359 | 359 | [/home/fperez/usr/bin/ipython] |
|
360 | 360 | In [7]: !echo "A system variable: $$HOME" # Use $$ for literal $ |
|
361 | 361 | A system variable: /home/fperez |
|
362 | 362 | |
|
363 | 363 | Note that `$$` is used to represent a literal `$`. |
|
364 | 364 | |
|
365 | 365 | System command aliases |
|
366 | 366 | ---------------------- |
|
367 | 367 | |
|
368 | 368 | The :magic:`alias` magic function allows you to define magic functions which are in fact |
|
369 | 369 | system shell commands. These aliases can have parameters. |
|
370 | 370 | |
|
371 | 371 | ``%alias alias_name cmd`` defines 'alias_name' as an alias for 'cmd' |
|
372 | 372 | |
|
373 | 373 | Then, typing ``alias_name params`` will execute the system command 'cmd |
|
374 | 374 | params' (from your underlying operating system). |
|
375 | 375 | |
|
376 | 376 | You can also define aliases with parameters using ``%s`` specifiers (one per |
|
377 | 377 | parameter). The following example defines the parts function as an |
|
378 | 378 | alias to the command ``echo first %s second %s`` where each ``%s`` will be |
|
379 | 379 | replaced by a positional parameter to the call to %parts:: |
|
380 | 380 | |
|
381 | 381 | In [1]: %alias parts echo first %s second %s |
|
382 | 382 | In [2]: parts A B |
|
383 | 383 | first A second B |
|
384 | 384 | In [3]: parts A |
|
385 | 385 | ERROR: Alias <parts> requires 2 arguments, 1 given. |
|
386 | 386 | |
|
387 | 387 | If called with no parameters, :magic:`alias` prints the table of currently |
|
388 | 388 | defined aliases. |
|
389 | 389 | |
|
390 | 390 | The :magic:`rehashx` magic allows you to load your entire $PATH as |
|
391 | 391 | ipython aliases. See its docstring for further details. |
|
392 | 392 | |
|
393 | 393 | |
|
394 | 394 | .. _dreload: |
|
395 | 395 | |
|
396 | 396 | Recursive reload |
|
397 | 397 | ---------------- |
|
398 | 398 | |
|
399 | 399 | The :mod:`IPython.lib.deepreload` module allows you to recursively reload a |
|
400 | 400 | module: changes made to any of its dependencies will be reloaded without |
|
401 | 401 | having to exit. To start using it, do:: |
|
402 | 402 | |
|
403 | 403 | from IPython.lib.deepreload import reload as dreload |
|
404 | 404 | |
|
405 | 405 | |
|
406 | 406 | Verbose and colored exception traceback printouts |
|
407 | 407 | ------------------------------------------------- |
|
408 | 408 | |
|
409 | 409 | IPython provides the option to see very detailed exception tracebacks, |
|
410 | 410 | which can be especially useful when debugging large programs. You can |
|
411 | 411 | run any Python file with the %run function to benefit from these |
|
412 | 412 | detailed tracebacks. Furthermore, both normal and verbose tracebacks can |
|
413 | 413 | be colored (if your terminal supports it) which makes them much easier |
|
414 | 414 | to parse visually. |
|
415 | 415 | |
|
416 | 416 | See the magic :magic:`xmode` and :magic:`colors` functions for details. |
|
417 | 417 | |
|
418 | 418 | These features are basically a terminal version of Ka-Ping Yee's cgitb |
|
419 | 419 | module, now part of the standard Python library. |
|
420 | 420 | |
|
421 | 421 | |
|
422 | 422 | .. _input_caching: |
|
423 | 423 | |
|
424 | 424 | Input caching system |
|
425 | 425 | -------------------- |
|
426 | 426 | |
|
427 | 427 | IPython offers numbered prompts (In/Out) with input and output caching |
|
428 | 428 | (also referred to as 'input history'). All input is saved and can be |
|
429 | 429 | retrieved as variables (besides the usual arrow key recall), in |
|
430 | 430 | addition to the :magic:`rep` magic command that brings a history entry |
|
431 | 431 | up for editing on the next command line. |
|
432 | 432 | |
|
433 | 433 | The following variables always exist: |
|
434 | 434 | |
|
435 | 435 | * ``_i``, ``_ii``, ``_iii``: store previous, next previous and next-next |
|
436 | 436 | previous inputs. |
|
437 | 437 | |
|
438 | 438 | * ``In``, ``_ih`` : a list of all inputs; ``_ih[n]`` is the input from line |
|
439 | 439 | ``n``. If you overwrite In with a variable of your own, you can remake the |
|
440 | 440 | assignment to the internal list with a simple ``In=_ih``. |
|
441 | 441 | |
|
442 | 442 | Additionally, global variables named ``_i<n>`` are dynamically created (``<n>`` |
|
443 | 443 | being the prompt counter), so ``_i<n> == _ih[<n>] == In[<n>]``. |
|
444 | 444 | |
|
445 | 445 | For example, what you typed at prompt 14 is available as ``_i14``, ``_ih[14]`` |
|
446 | 446 | and ``In[14]``. |
|
447 | 447 | |
|
448 | 448 | This allows you to easily cut and paste multi line interactive prompts |
|
449 | 449 | by printing them out: they print like a clean string, without prompt |
|
450 | 450 | characters. You can also manipulate them like regular variables (they |
|
451 | 451 | are strings), modify or exec them. |
|
452 | 452 | |
|
453 | 453 | You can also re-execute multiple lines of input easily by using the magic |
|
454 | 454 | :magic:`rerun` or :magic:`macro` functions. The macro system also allows you to |
|
455 | 455 | re-execute previous lines which include magic function calls (which require |
|
456 | 456 | special processing). Type %macro? for more details on the macro system. |
|
457 | 457 | |
|
458 | 458 | A history function :magic:`history` allows you to see any part of your input |
|
459 | 459 | history by printing a range of the _i variables. |
|
460 | 460 | |
|
461 | 461 | You can also search ('grep') through your history by typing |
|
462 | 462 | ``%hist -g somestring``. This is handy for searching for URLs, IP addresses, |
|
463 | 463 | etc. You can bring history entries listed by '%hist -g' up for editing |
|
464 | 464 | with the %recall command, or run them immediately with :magic:`rerun`. |
|
465 | 465 | |
|
466 | 466 | .. _output_caching: |
|
467 | 467 | |
|
468 | 468 | Output caching system |
|
469 | 469 | --------------------- |
|
470 | 470 | |
|
471 | 471 | For output that is returned from actions, a system similar to the input |
|
472 | 472 | cache exists but using _ instead of _i. Only actions that produce a |
|
473 | 473 | result (NOT assignments, for example) are cached. If you are familiar |
|
474 | 474 | with Mathematica, IPython's _ variables behave exactly like |
|
475 | 475 | Mathematica's % variables. |
|
476 | 476 | |
|
477 | 477 | The following variables always exist: |
|
478 | 478 | |
|
479 | 479 | * [_] (a single underscore): stores previous output, like Python's |
|
480 | 480 | default interpreter. |
|
481 | 481 | * [__] (two underscores): next previous. |
|
482 | 482 | * [___] (three underscores): next-next previous. |
|
483 | 483 | |
|
484 | 484 | Additionally, global variables named _<n> are dynamically created (<n> |
|
485 | 485 | being the prompt counter), such that the result of output <n> is always |
|
486 | 486 | available as _<n> (don't use the angle brackets, just the number, e.g. |
|
487 | 487 | ``_21``). |
|
488 | 488 | |
|
489 | 489 | These variables are also stored in a global dictionary (not a |
|
490 | 490 | list, since it only has entries for lines which returned a result) |
|
491 | 491 | available under the names _oh and Out (similar to _ih and In). So the |
|
492 | 492 | output from line 12 can be obtained as ``_12``, ``Out[12]`` or ``_oh[12]``. If you |
|
493 | 493 | accidentally overwrite the Out variable you can recover it by typing |
|
494 | 494 | ``Out=_oh`` at the prompt. |
|
495 | 495 | |
|
496 | 496 | This system obviously can potentially put heavy memory demands on your |
|
497 | 497 | system, since it prevents Python's garbage collector from removing any |
|
498 | 498 | previously computed results. You can control how many results are kept |
|
499 | 499 | in memory with the configuration option ``InteractiveShell.cache_size``. |
|
500 | 500 | If you set it to 0, output caching is disabled. You can also use the :magic:`reset` |
|
501 | 501 | and :magic:`xdel` magics to clear large items from memory. |
|
502 | 502 | |
|
503 | 503 | Directory history |
|
504 | 504 | ----------------- |
|
505 | 505 | |
|
506 | 506 | Your history of visited directories is kept in the global list _dh, and |
|
507 | 507 | the magic :magic:`cd` command can be used to go to any entry in that list. The |
|
508 | 508 | :magic:`dhist` command allows you to view this history. Do ``cd -<TAB>`` to |
|
509 | 509 | conveniently view the directory history. |
|
510 | 510 | |
|
511 | 511 | |
|
512 | 512 | Automatic parentheses and quotes |
|
513 | 513 | -------------------------------- |
|
514 | 514 | |
|
515 | 515 | These features were adapted from Nathan Gray's LazyPython. They are |
|
516 | 516 | meant to allow less typing for common situations. |
|
517 | 517 | |
|
518 | 518 | Callable objects (i.e. functions, methods, etc) can be invoked like this |
|
519 | 519 | (notice the commas between the arguments):: |
|
520 | 520 | |
|
521 | 521 | In [1]: callable_ob arg1, arg2, arg3 |
|
522 | 522 | ------> callable_ob(arg1, arg2, arg3) |
|
523 | 523 | |
|
524 | 524 | .. note:: |
|
525 | 525 | This feature is disabled by default. To enable it, use the ``%autocall`` |
|
526 | 526 | magic command. The commands below with special prefixes will always work, |
|
527 | 527 | however. |
|
528 | 528 | |
|
529 | 529 | You can force automatic parentheses by using '/' as the first character |
|
530 | 530 | of a line. For example:: |
|
531 | 531 | |
|
532 | 532 | In [2]: /globals # becomes 'globals()' |
|
533 | 533 | |
|
534 | 534 | Note that the '/' MUST be the first character on the line! This won't work:: |
|
535 | 535 | |
|
536 | 536 | In [3]: print /globals # syntax error |
|
537 | 537 | |
|
538 | 538 | In most cases the automatic algorithm should work, so you should rarely |
|
539 | 539 | need to explicitly invoke /. One notable exception is if you are trying |
|
540 | 540 | to call a function with a list of tuples as arguments (the parenthesis |
|
541 | 541 | will confuse IPython):: |
|
542 | 542 | |
|
543 | 543 | In [4]: zip (1,2,3),(4,5,6) # won't work |
|
544 | 544 | |
|
545 | 545 | but this will work:: |
|
546 | 546 | |
|
547 | 547 | In [5]: /zip (1,2,3),(4,5,6) |
|
548 | 548 | ------> zip ((1,2,3),(4,5,6)) |
|
549 | 549 | Out[5]: [(1, 4), (2, 5), (3, 6)] |
|
550 | 550 | |
|
551 | 551 | IPython tells you that it has altered your command line by displaying |
|
552 | 552 | the new command line preceded by ``--->``. |
|
553 | 553 | |
|
554 | 554 | You can force automatic quoting of a function's arguments by using ``,`` |
|
555 | 555 | or ``;`` as the first character of a line. For example:: |
|
556 | 556 | |
|
557 | 557 | In [1]: ,my_function /home/me # becomes my_function("/home/me") |
|
558 | 558 | |
|
559 | 559 | If you use ';' the whole argument is quoted as a single string, while ',' splits |
|
560 | 560 | on whitespace:: |
|
561 | 561 | |
|
562 | 562 | In [2]: ,my_function a b c # becomes my_function("a","b","c") |
|
563 | 563 | |
|
564 | 564 | In [3]: ;my_function a b c # becomes my_function("a b c") |
|
565 | 565 | |
|
566 | 566 | Note that the ',' or ';' MUST be the first character on the line! This |
|
567 | 567 | won't work:: |
|
568 | 568 | |
|
569 | 569 | In [4]: x = ,my_function /home/me # syntax error |
|
570 | 570 | |
|
571 | 571 | IPython as your default Python environment |
|
572 | 572 | ========================================== |
|
573 | 573 | |
|
574 | 574 | Python honors the environment variable :envvar:`PYTHONSTARTUP` and will |
|
575 | 575 | execute at startup the file referenced by this variable. If you put the |
|
576 | 576 | following code at the end of that file, then IPython will be your working |
|
577 | 577 | environment anytime you start Python:: |
|
578 | 578 | |
|
579 | 579 | import os, IPython |
|
580 | 580 | os.environ['PYTHONSTARTUP'] = '' # Prevent running this again |
|
581 | 581 | IPython.start_ipython() |
|
582 | 582 | raise SystemExit |
|
583 | 583 | |
|
584 | 584 | The ``raise SystemExit`` is needed to exit Python when |
|
585 | 585 | it finishes, otherwise you'll be back at the normal Python ``>>>`` |
|
586 | 586 | prompt. |
|
587 | 587 | |
|
588 | 588 | This is probably useful to developers who manage multiple Python |
|
589 | 589 | versions and don't want to have correspondingly multiple IPython |
|
590 | 590 | versions. Note that in this mode, there is no way to pass IPython any |
|
591 | 591 | command-line options, as those are trapped first by Python itself. |
|
592 | 592 | |
|
593 | 593 | .. _Embedding: |
|
594 | 594 | |
|
595 | 595 | Embedding IPython |
|
596 | 596 | ================= |
|
597 | 597 | |
|
598 | 598 | You can start a regular IPython session with |
|
599 | 599 | |
|
600 | 600 | .. sourcecode:: python |
|
601 | 601 | |
|
602 | 602 | import IPython |
|
603 | 603 | IPython.start_ipython(argv=[]) |
|
604 | 604 | |
|
605 | 605 | at any point in your program. This will load IPython configuration, |
|
606 | 606 | startup files, and everything, just as if it were a normal IPython session. |
|
607 | 607 | For information on setting configuration options when running IPython from |
|
608 | 608 | python, see :ref:`configure_start_ipython`. |
|
609 | 609 | |
|
610 | 610 | It is also possible to embed an IPython shell in a namespace in your Python |
|
611 | 611 | code. This allows you to evaluate dynamically the state of your code, operate |
|
612 | 612 | with your variables, analyze them, etc. For example, if you run the following |
|
613 | 613 | code snippet:: |
|
614 | 614 | |
|
615 | 615 | import IPython |
|
616 | 616 | |
|
617 | 617 | a = 42 |
|
618 | 618 | IPython.embed() |
|
619 | 619 | |
|
620 | 620 | and within the IPython shell, you reassign `a` to `23` to do further testing of |
|
621 | 621 | some sort, you can then exit:: |
|
622 | 622 | |
|
623 | 623 | >>> IPython.embed() |
|
624 | 624 | Python 3.6.2 (default, Jul 17 2017, 16:44:45) |
|
625 | 625 | Type 'copyright', 'credits' or 'license' for more information |
|
626 | 626 | IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help. |
|
627 | 627 | |
|
628 | 628 | In [1]: a = 23 |
|
629 | 629 | |
|
630 | 630 | In [2]: exit() |
|
631 | 631 | |
|
632 | 632 | Once you exit and print `a`, the value 23 will be shown:: |
|
633 | 633 | |
|
634 | 634 | |
|
635 | 635 | In: print(a) |
|
636 | 636 | 23 |
|
637 | 637 | |
|
638 | 638 | It's important to note that the code run in the embedded IPython shell will |
|
639 | 639 | *not* change the state of your code and variables, **unless** the shell is |
|
640 | 640 | contained within the global namespace. In the above example, `a` is changed |
|
641 | 641 | because this is true. |
|
642 | 642 | |
|
643 | 643 | To further exemplify this, consider the following example:: |
|
644 | 644 | |
|
645 | 645 | import IPython |
|
646 | 646 | def do(): |
|
647 | 647 | a = 42 |
|
648 | 648 | print(a) |
|
649 | 649 | IPython.embed() |
|
650 | 650 | print(a) |
|
651 | 651 | |
|
652 | 652 | Now if call the function and complete the state changes as we did above, the |
|
653 | 653 | value `42` will be printed. Again, this is because it's not in the global |
|
654 | 654 | namespace:: |
|
655 | 655 | |
|
656 | 656 | do() |
|
657 | 657 | |
|
658 | 658 | Running a file with the above code can lead to the following session:: |
|
659 | 659 | |
|
660 | 660 | >>> do() |
|
661 | 661 | 42 |
|
662 | 662 | Python 3.6.2 (default, Jul 17 2017, 16:44:45) |
|
663 | 663 | Type 'copyright', 'credits' or 'license' for more information |
|
664 | 664 | IPython 6.2.0.dev -- An enhanced Interactive Python. Type '?' for help. |
|
665 | 665 | |
|
666 | 666 | In [1]: a = 23 |
|
667 | 667 | |
|
668 | 668 | In [2]: exit() |
|
669 | 669 | 42 |
|
670 | 670 | |
|
671 | 671 | .. note:: |
|
672 | 672 | |
|
673 | 673 | At present, embedding IPython cannot be done from inside IPython. |
|
674 | 674 | Run the code samples below outside IPython. |
|
675 | 675 | |
|
676 | 676 | This feature allows you to easily have a fully functional python |
|
677 | 677 | environment for doing object introspection anywhere in your code with a |
|
678 | 678 | simple function call. In some cases a simple print statement is enough, |
|
679 | 679 | but if you need to do more detailed analysis of a code fragment this |
|
680 | 680 | feature can be very valuable. |
|
681 | 681 | |
|
682 | 682 | It can also be useful in scientific computing situations where it is |
|
683 | 683 | common to need to do some automatic, computationally intensive part and |
|
684 | 684 | then stop to look at data, plots, etc. |
|
685 | 685 | Opening an IPython instance will give you full access to your data and |
|
686 | 686 | functions, and you can resume program execution once you are done with |
|
687 | 687 | the interactive part (perhaps to stop again later, as many times as |
|
688 | 688 | needed). |
|
689 | 689 | |
|
690 | 690 | The following code snippet is the bare minimum you need to include in |
|
691 | 691 | your Python programs for this to work (detailed examples follow later):: |
|
692 | 692 | |
|
693 | 693 | from IPython import embed |
|
694 | 694 | |
|
695 | 695 | embed() # this call anywhere in your program will start IPython |
|
696 | 696 | |
|
697 | 697 | You can also embed an IPython *kernel*, for use with qtconsole, etc. via |
|
698 | 698 | ``IPython.embed_kernel()``. This should function work the same way, but you can |
|
699 | 699 | connect an external frontend (``ipython qtconsole`` or ``ipython console``), |
|
700 | 700 | rather than interacting with it in the terminal. |
|
701 | 701 | |
|
702 | 702 | You can run embedded instances even in code which is itself being run at |
|
703 | 703 | the IPython interactive prompt with '%run <filename>'. Since it's easy |
|
704 | 704 | to get lost as to where you are (in your top-level IPython or in your |
|
705 | 705 | embedded one), it's a good idea in such cases to set the in/out prompts |
|
706 | 706 | to something different for the embedded instances. The code examples |
|
707 | 707 | below illustrate this. |
|
708 | 708 | |
|
709 | 709 | You can also have multiple IPython instances in your program and open |
|
710 | 710 | them separately, for example with different options for data |
|
711 | 711 | presentation. If you close and open the same instance multiple times, |
|
712 | 712 | its prompt counters simply continue from each execution to the next. |
|
713 | 713 | |
|
714 | 714 | Please look at the docstrings in the :mod:`~IPython.frontend.terminal.embed` |
|
715 | 715 | module for more details on the use of this system. |
|
716 | 716 | |
|
717 | 717 | The following sample file illustrating how to use the embedding |
|
718 | 718 | functionality is provided in the examples directory as embed_class_long.py. |
|
719 | 719 | It should be fairly self-explanatory: |
|
720 | 720 | |
|
721 | 721 | .. literalinclude:: ../../../examples/Embedding/embed_class_long.py |
|
722 | 722 | :language: python |
|
723 | 723 | |
|
724 | 724 | Once you understand how the system functions, you can use the following |
|
725 | 725 | code fragments in your programs which are ready for cut and paste: |
|
726 | 726 | |
|
727 | 727 | .. literalinclude:: ../../../examples/Embedding/embed_class_short.py |
|
728 | 728 | :language: python |
|
729 | 729 | |
|
730 | 730 | Using the Python debugger (pdb) |
|
731 | 731 | =============================== |
|
732 | 732 | |
|
733 | 733 | Running entire programs via pdb |
|
734 | 734 | ------------------------------- |
|
735 | 735 | |
|
736 | 736 | pdb, the Python debugger, is a powerful interactive debugger which |
|
737 | 737 | allows you to step through code, set breakpoints, watch variables, |
|
738 | 738 | etc. IPython makes it very easy to start any script under the control |
|
739 | 739 | of pdb, regardless of whether you have wrapped it into a 'main()' |
|
740 | 740 | function or not. For this, simply type ``%run -d myscript`` at an |
|
741 | 741 | IPython prompt. See the :magic:`run` command's documentation for more details, including |
|
742 | 742 | how to control where pdb will stop execution first. |
|
743 | 743 | |
|
744 | 744 | For more information on the use of the pdb debugger, see :ref:`debugger-commands` |
|
745 | 745 | in the Python documentation. |
|
746 | 746 | |
|
747 | 747 | IPython extends the debugger with a few useful additions, like coloring of |
|
748 | 748 | tracebacks. The debugger will adopt the color scheme selected for IPython. |
|
749 | 749 | |
|
750 | 750 | The ``where`` command has also been extended to take as argument the number of |
|
751 | 751 | context line to show. This allows to a many line of context on shallow stack trace: |
|
752 | 752 | |
|
753 | 753 | .. code:: |
|
754 | 754 | |
|
755 | 755 | In [5]: def foo(x): |
|
756 | 756 | ...: 1 |
|
757 | 757 | ...: 2 |
|
758 | 758 | ...: 3 |
|
759 | 759 | ...: return 1/x+foo(x-1) |
|
760 | 760 | ...: 5 |
|
761 | 761 | ...: 6 |
|
762 | 762 | ...: 7 |
|
763 | 763 | ...: |
|
764 | 764 | |
|
765 | 765 | In[6]: foo(1) |
|
766 | 766 | # ... |
|
767 | 767 | ipdb> where 8 |
|
768 |
<ipython-input-6-9e45007b2b59>(1)<module> |
|
|
768 | <ipython-input-6-9e45007b2b59>(1)<module> | |
|
769 | 769 | ----> 1 foo(1) |
|
770 | 770 | |
|
771 | 771 | <ipython-input-5-7baadc3d1465>(5)foo() |
|
772 | 772 | 1 def foo(x): |
|
773 | 773 | 2 1 |
|
774 | 774 | 3 2 |
|
775 | 775 | 4 3 |
|
776 | 776 | ----> 5 return 1/x+foo(x-1) |
|
777 | 777 | 6 5 |
|
778 | 778 | 7 6 |
|
779 | 779 | 8 7 |
|
780 | 780 | |
|
781 | 781 | > <ipython-input-5-7baadc3d1465>(5)foo() |
|
782 | 782 | 1 def foo(x): |
|
783 | 783 | 2 1 |
|
784 | 784 | 3 2 |
|
785 | 785 | 4 3 |
|
786 | 786 | ----> 5 return 1/x+foo(x-1) |
|
787 | 787 | 6 5 |
|
788 | 788 | 7 6 |
|
789 | 789 | 8 7 |
|
790 | 790 | |
|
791 | 791 | |
|
792 | 792 | And less context on shallower Stack Trace: |
|
793 | 793 | |
|
794 | 794 | .. code:: |
|
795 | 795 | |
|
796 | 796 | ipdb> where 1 |
|
797 |
<ipython-input-13-afa180a57233>(1)<module> |
|
|
797 | <ipython-input-13-afa180a57233>(1)<module> | |
|
798 | 798 | ----> 1 foo(7) |
|
799 | 799 | |
|
800 | 800 | <ipython-input-5-7baadc3d1465>(5)foo() |
|
801 | 801 | ----> 5 return 1/x+foo(x-1) |
|
802 | 802 | |
|
803 | 803 | <ipython-input-5-7baadc3d1465>(5)foo() |
|
804 | 804 | ----> 5 return 1/x+foo(x-1) |
|
805 | 805 | |
|
806 | 806 | <ipython-input-5-7baadc3d1465>(5)foo() |
|
807 | 807 | ----> 5 return 1/x+foo(x-1) |
|
808 | 808 | |
|
809 | 809 | <ipython-input-5-7baadc3d1465>(5)foo() |
|
810 | 810 | ----> 5 return 1/x+foo(x-1) |
|
811 | 811 | |
|
812 | 812 | |
|
813 | 813 | Post-mortem debugging |
|
814 | 814 | --------------------- |
|
815 | 815 | |
|
816 | 816 | Going into a debugger when an exception occurs can be |
|
817 | 817 | extremely useful in order to find the origin of subtle bugs, because pdb |
|
818 | 818 | opens up at the point in your code which triggered the exception, and |
|
819 | 819 | while your program is at this point 'dead', all the data is still |
|
820 | 820 | available and you can walk up and down the stack frame and understand |
|
821 | 821 | the origin of the problem. |
|
822 | 822 | |
|
823 | 823 | You can use the :magic:`debug` magic after an exception has occurred to start |
|
824 | 824 | post-mortem debugging. IPython can also call debugger every time your code |
|
825 | 825 | triggers an uncaught exception. This feature can be toggled with the :magic:`pdb` magic |
|
826 | 826 | command, or you can start IPython with the ``--pdb`` option. |
|
827 | 827 | |
|
828 | 828 | For a post-mortem debugger in your programs outside IPython, |
|
829 | 829 | put the following lines toward the top of your 'main' routine:: |
|
830 | 830 | |
|
831 | 831 | import sys |
|
832 | 832 | from IPython.core import ultratb |
|
833 | 833 | sys.excepthook = ultratb.FormattedTB(mode='Verbose', |
|
834 | 834 | color_scheme='Linux', call_pdb=1) |
|
835 | 835 | |
|
836 | 836 | The mode keyword can be either 'Verbose' or 'Plain', giving either very |
|
837 | 837 | detailed or normal tracebacks respectively. The color_scheme keyword can |
|
838 | 838 | be one of 'NoColor', 'Linux' (default) or 'LightBG'. These are the same |
|
839 | 839 | options which can be set in IPython with ``--colors`` and ``--xmode``. |
|
840 | 840 | |
|
841 | 841 | This will give any of your programs detailed, colored tracebacks with |
|
842 | 842 | automatic invocation of pdb. |
|
843 | 843 | |
|
844 | 844 | .. _pasting_with_prompts: |
|
845 | 845 | |
|
846 | 846 | Pasting of code starting with Python or IPython prompts |
|
847 | 847 | ======================================================= |
|
848 | 848 | |
|
849 | 849 | IPython is smart enough to filter out input prompts, be they plain Python ones |
|
850 | 850 | (``>>>`` and ``...``) or IPython ones (``In [N]:`` and ``...:``). You can |
|
851 | 851 | therefore copy and paste from existing interactive sessions without worry. |
|
852 | 852 | |
|
853 | 853 | The following is a 'screenshot' of how things work, copying an example from the |
|
854 | 854 | standard Python tutorial:: |
|
855 | 855 | |
|
856 | 856 | In [1]: >>> # Fibonacci series: |
|
857 | 857 | |
|
858 | 858 | In [2]: ... # the sum of two elements defines the next |
|
859 | 859 | |
|
860 | 860 | In [3]: ... a, b = 0, 1 |
|
861 | 861 | |
|
862 | 862 | In [4]: >>> while b < 10: |
|
863 | 863 | ...: ... print(b) |
|
864 | 864 | ...: ... a, b = b, a+b |
|
865 | 865 | ...: |
|
866 | 866 | 1 |
|
867 | 867 | 1 |
|
868 | 868 | 2 |
|
869 | 869 | 3 |
|
870 | 870 | 5 |
|
871 | 871 | 8 |
|
872 | 872 | |
|
873 | 873 | And pasting from IPython sessions works equally well:: |
|
874 | 874 | |
|
875 | 875 | In [1]: In [5]: def f(x): |
|
876 | 876 | ...: ...: "A simple function" |
|
877 | 877 | ...: ...: return x**2 |
|
878 | 878 | ...: ...: |
|
879 | 879 | |
|
880 | 880 | In [2]: f(3) |
|
881 | 881 | Out[2]: 9 |
|
882 | 882 | |
|
883 | 883 | .. _gui_support: |
|
884 | 884 | |
|
885 | 885 | GUI event loop support |
|
886 | 886 | ====================== |
|
887 | 887 | |
|
888 | 888 | IPython has excellent support for working interactively with Graphical User |
|
889 | 889 | Interface (GUI) toolkits, such as wxPython, PyQt4/PySide, PyGTK and Tk. This is |
|
890 | 890 | implemented by running the toolkit's event loop while IPython is waiting for |
|
891 | 891 | input. |
|
892 | 892 | |
|
893 | 893 | For users, enabling GUI event loop integration is simple. You simple use the |
|
894 | 894 | :magic:`gui` magic as follows:: |
|
895 | 895 | |
|
896 | 896 | %gui [GUINAME] |
|
897 | 897 | |
|
898 | 898 | With no arguments, ``%gui`` removes all GUI support. Valid ``GUINAME`` |
|
899 | 899 | arguments include ``wx``, ``qt``, ``qt5``, ``gtk``, ``gtk3`` and ``tk``. |
|
900 | 900 | |
|
901 | 901 | Thus, to use wxPython interactively and create a running :class:`wx.App` |
|
902 | 902 | object, do:: |
|
903 | 903 | |
|
904 | 904 | %gui wx |
|
905 | 905 | |
|
906 | 906 | You can also start IPython with an event loop set up using the `--gui` |
|
907 | 907 | flag:: |
|
908 | 908 | |
|
909 | 909 | $ ipython --gui=qt |
|
910 | 910 | |
|
911 | 911 | For information on IPython's matplotlib_ integration (and the ``matplotlib`` |
|
912 | 912 | mode) see :ref:`this section <matplotlib_support>`. |
|
913 | 913 | |
|
914 | 914 | For developers that want to integrate additional event loops with IPython, see |
|
915 | 915 | :doc:`/config/eventloops`. |
|
916 | 916 | |
|
917 | 917 | When running inside IPython with an integrated event loop, a GUI application |
|
918 | 918 | should *not* start its own event loop. This means that applications that are |
|
919 | 919 | meant to be used both |
|
920 | 920 | in IPython and as standalone apps need to have special code to detects how the |
|
921 | 921 | application is being run. We highly recommend using IPython's support for this. |
|
922 | 922 | Since the details vary slightly between toolkits, we point you to the various |
|
923 | 923 | examples in our source directory :file:`examples/IPython Kernel/gui/` that |
|
924 | 924 | demonstrate these capabilities. |
|
925 | 925 | |
|
926 | 926 | PyQt and PySide |
|
927 | 927 | --------------- |
|
928 | 928 | |
|
929 | 929 | .. attempt at explanation of the complete mess that is Qt support |
|
930 | 930 | |
|
931 | 931 | When you use ``--gui=qt`` or ``--matplotlib=qt``, IPython can work with either |
|
932 | 932 | PyQt4 or PySide. There are three options for configuration here, because |
|
933 | 933 | PyQt4 has two APIs for QString and QVariant: v1, which is the default on |
|
934 | 934 | Python 2, and the more natural v2, which is the only API supported by PySide. |
|
935 | 935 | v2 is also the default for PyQt4 on Python 3. IPython's code for the QtConsole |
|
936 | 936 | uses v2, but you can still use any interface in your code, since the |
|
937 | 937 | Qt frontend is in a different process. |
|
938 | 938 | |
|
939 | 939 | The default will be to import PyQt4 without configuration of the APIs, thus |
|
940 | 940 | matching what most applications would expect. It will fall back to PySide if |
|
941 | 941 | PyQt4 is unavailable. |
|
942 | 942 | |
|
943 | 943 | If specified, IPython will respect the environment variable ``QT_API`` used |
|
944 | 944 | by ETS. ETS 4.0 also works with both PyQt4 and PySide, but it requires |
|
945 | 945 | PyQt4 to use its v2 API. So if ``QT_API=pyside`` PySide will be used, |
|
946 | 946 | and if ``QT_API=pyqt`` then PyQt4 will be used *with the v2 API* for |
|
947 | 947 | QString and QVariant, so ETS codes like MayaVi will also work with IPython. |
|
948 | 948 | |
|
949 | 949 | If you launch IPython in matplotlib mode with ``ipython --matplotlib=qt``, |
|
950 | 950 | then IPython will ask matplotlib which Qt library to use (only if QT_API is |
|
951 | 951 | *not set*), via the 'backend.qt4' rcParam. If matplotlib is version 1.0.1 or |
|
952 | 952 | older, then IPython will always use PyQt4 without setting the v2 APIs, since |
|
953 | 953 | neither v2 PyQt nor PySide work. |
|
954 | 954 | |
|
955 | 955 | .. warning:: |
|
956 | 956 | |
|
957 | 957 | Note that this means for ETS 4 to work with PyQt4, ``QT_API`` *must* be set |
|
958 | 958 | to work with IPython's qt integration, because otherwise PyQt4 will be |
|
959 | 959 | loaded in an incompatible mode. |
|
960 | 960 | |
|
961 | 961 | It also means that you must *not* have ``QT_API`` set if you want to |
|
962 | 962 | use ``--gui=qt`` with code that requires PyQt4 API v1. |
|
963 | 963 | |
|
964 | 964 | |
|
965 | 965 | .. _matplotlib_support: |
|
966 | 966 | |
|
967 | 967 | Plotting with matplotlib |
|
968 | 968 | ======================== |
|
969 | 969 | |
|
970 | 970 | matplotlib_ provides high quality 2D and 3D plotting for Python. matplotlib_ |
|
971 | 971 | can produce plots on screen using a variety of GUI toolkits, including Tk, |
|
972 | 972 | PyGTK, PyQt4 and wxPython. It also provides a number of commands useful for |
|
973 | 973 | scientific computing, all with a syntax compatible with that of the popular |
|
974 | 974 | Matlab program. |
|
975 | 975 | |
|
976 | 976 | To start IPython with matplotlib support, use the ``--matplotlib`` switch. If |
|
977 | 977 | IPython is already running, you can run the :magic:`matplotlib` magic. If no |
|
978 | 978 | arguments are given, IPython will automatically detect your choice of |
|
979 | 979 | matplotlib backend. You can also request a specific backend with |
|
980 | 980 | ``%matplotlib backend``, where ``backend`` must be one of: 'tk', 'qt', 'wx', |
|
981 | 981 | 'gtk', 'osx'. In the web notebook and Qt console, 'inline' is also a valid |
|
982 | 982 | backend value, which produces static figures inlined inside the application |
|
983 | 983 | window instead of matplotlib's interactive figures that live in separate |
|
984 | 984 | windows. |
|
985 | 985 | |
|
986 | 986 | .. _interactive_demos: |
|
987 | 987 | |
|
988 | 988 | Interactive demos with IPython |
|
989 | 989 | ============================== |
|
990 | 990 | |
|
991 | 991 | IPython ships with a basic system for running scripts interactively in |
|
992 | 992 | sections, useful when presenting code to audiences. A few tags embedded |
|
993 | 993 | in comments (so that the script remains valid Python code) divide a file |
|
994 | 994 | into separate blocks, and the demo can be run one block at a time, with |
|
995 | 995 | IPython printing (with syntax highlighting) the block before executing |
|
996 | 996 | it, and returning to the interactive prompt after each block. The |
|
997 | 997 | interactive namespace is updated after each block is run with the |
|
998 | 998 | contents of the demo's namespace. |
|
999 | 999 | |
|
1000 | 1000 | This allows you to show a piece of code, run it and then execute |
|
1001 | 1001 | interactively commands based on the variables just created. Once you |
|
1002 | 1002 | want to continue, you simply execute the next block of the demo. The |
|
1003 | 1003 | following listing shows the markup necessary for dividing a script into |
|
1004 | 1004 | sections for execution as a demo: |
|
1005 | 1005 | |
|
1006 | 1006 | .. literalinclude:: ../../../examples/IPython Kernel/example-demo.py |
|
1007 | 1007 | :language: python |
|
1008 | 1008 | |
|
1009 | 1009 | In order to run a file as a demo, you must first make a Demo object out |
|
1010 | 1010 | of it. If the file is named myscript.py, the following code will make a |
|
1011 | 1011 | demo:: |
|
1012 | 1012 | |
|
1013 | 1013 | from IPython.lib.demo import Demo |
|
1014 | 1014 | |
|
1015 | 1015 | mydemo = Demo('myscript.py') |
|
1016 | 1016 | |
|
1017 | 1017 | This creates the mydemo object, whose blocks you run one at a time by |
|
1018 | 1018 | simply calling the object with no arguments. Then call it to run each step |
|
1019 | 1019 | of the demo:: |
|
1020 | 1020 | |
|
1021 | 1021 | mydemo() |
|
1022 | 1022 | |
|
1023 | 1023 | Demo objects can be |
|
1024 | 1024 | restarted, you can move forward or back skipping blocks, re-execute the |
|
1025 | 1025 | last block, etc. See the :mod:`IPython.lib.demo` module and the |
|
1026 | 1026 | :class:`~IPython.lib.demo.Demo` class for details. |
|
1027 | 1027 | |
|
1028 | 1028 | Limitations: These demos are limited to |
|
1029 | 1029 | fairly simple uses. In particular, you cannot break up sections within |
|
1030 | 1030 | indented code (loops, if statements, function definitions, etc.) |
|
1031 | 1031 | Supporting something like this would basically require tracking the |
|
1032 | 1032 | internal execution state of the Python interpreter, so only top-level |
|
1033 | 1033 | divisions are allowed. If you want to be able to open an IPython |
|
1034 | 1034 | instance at an arbitrary point in a program, you can use IPython's |
|
1035 | 1035 | :ref:`embedding facilities <Embedding>`. |
|
1036 | 1036 | |
|
1037 | 1037 | .. include:: ../links.txt |
General Comments 0
You need to be logged in to leave comments.
Login now