Show More
@@ -1,748 +1,748 b'' | |||||
1 | """ History related magics and functionality """ |
|
1 | """ History related magics and functionality """ | |
2 | #----------------------------------------------------------------------------- |
|
2 | #----------------------------------------------------------------------------- | |
3 | # Copyright (C) 2010 The IPython Development Team. |
|
3 | # Copyright (C) 2010 The IPython Development Team. | |
4 | # |
|
4 | # | |
5 | # Distributed under the terms of the BSD License. |
|
5 | # Distributed under the terms of the BSD License. | |
6 | # |
|
6 | # | |
7 | # The full license is in the file COPYING.txt, distributed with this software. |
|
7 | # The full license is in the file COPYING.txt, distributed with this software. | |
8 | #----------------------------------------------------------------------------- |
|
8 | #----------------------------------------------------------------------------- | |
9 |
|
9 | |||
10 | #----------------------------------------------------------------------------- |
|
10 | #----------------------------------------------------------------------------- | |
11 | # Imports |
|
11 | # Imports | |
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 | from __future__ import print_function |
|
13 | from __future__ import print_function | |
14 |
|
14 | |||
15 | # Stdlib imports |
|
15 | # Stdlib imports | |
16 | import datetime |
|
16 | import datetime | |
17 | import json |
|
17 | import json | |
18 | import os |
|
18 | import os | |
19 | import re |
|
19 | import re | |
20 | import sqlite3 |
|
20 | import sqlite3 | |
21 |
|
21 | |||
22 | from collections import defaultdict |
|
22 | from collections import defaultdict | |
23 |
|
23 | |||
24 | # Our own packages |
|
24 | # Our own packages | |
25 | from IPython.config.configurable import Configurable |
|
25 | from IPython.config.configurable import Configurable | |
26 | import IPython.utils.io |
|
26 | import IPython.utils.io | |
27 |
|
27 | |||
28 | from IPython.testing import decorators as testdec |
|
28 | from IPython.testing import decorators as testdec | |
29 | from IPython.utils.io import ask_yes_no |
|
29 | from IPython.utils.io import ask_yes_no | |
30 | from IPython.utils.traitlets import Bool, Dict, Instance, Int, List, Unicode |
|
30 | from IPython.utils.traitlets import Bool, Dict, Instance, Int, List, Unicode | |
31 | from IPython.utils.warn import warn |
|
31 | from IPython.utils.warn import warn | |
32 |
|
32 | |||
33 | #----------------------------------------------------------------------------- |
|
33 | #----------------------------------------------------------------------------- | |
34 | # Classes and functions |
|
34 | # Classes and functions | |
35 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
36 |
|
36 | |||
37 | class HistoryManager(Configurable): |
|
37 | class HistoryManager(Configurable): | |
38 | """A class to organize all history-related functionality in one place. |
|
38 | """A class to organize all history-related functionality in one place. | |
39 | """ |
|
39 | """ | |
40 | # Public interface |
|
40 | # Public interface | |
41 |
|
41 | |||
42 | # An instance of the IPython shell we are attached to |
|
42 | # An instance of the IPython shell we are attached to | |
43 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
43 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | |
44 | # Lists to hold processed and raw history. These start with a blank entry |
|
44 | # Lists to hold processed and raw history. These start with a blank entry | |
45 | # so that we can index them starting from 1 |
|
45 | # so that we can index them starting from 1 | |
46 | input_hist_parsed = List([""]) |
|
46 | input_hist_parsed = List([""]) | |
47 | input_hist_raw = List([""]) |
|
47 | input_hist_raw = List([""]) | |
48 | # A list of directories visited during session |
|
48 | # A list of directories visited during session | |
49 | dir_hist = List() |
|
49 | dir_hist = List() | |
50 | def _dir_hist_default(self): |
|
50 | def _dir_hist_default(self): | |
51 | try: |
|
51 | try: | |
52 | return [os.getcwd()] |
|
52 | return [os.getcwd()] | |
53 | except OSError: |
|
53 | except OSError: | |
54 | return [] |
|
54 | return [] | |
55 |
|
55 | |||
56 | # A dict of output history, keyed with ints from the shell's |
|
56 | # A dict of output history, keyed with ints from the shell's | |
57 | # execution count. If there are several outputs from one command, |
|
57 | # execution count. If there are several outputs from one command, | |
58 | # only the last one is stored. |
|
58 | # only the last one is stored. | |
59 | output_hist = Dict() |
|
59 | output_hist = Dict() | |
60 | # Contains all outputs, in lists of reprs. |
|
60 | # Contains all outputs, in lists of reprs. | |
61 | output_hist_reprs = Instance(defaultdict, args=(list,)) |
|
61 | output_hist_reprs = Instance(defaultdict, args=(list,)) | |
62 |
|
62 | |||
63 | # String holding the path to the history file |
|
63 | # String holding the path to the history file | |
64 | hist_file = Unicode(config=True) |
|
64 | hist_file = Unicode(config=True) | |
65 |
|
65 | |||
66 | # The SQLite database |
|
66 | # The SQLite database | |
67 | db = Instance(sqlite3.Connection) |
|
67 | db = Instance(sqlite3.Connection) | |
68 | # The number of the current session in the history database |
|
68 | # The number of the current session in the history database | |
69 | session_number = Int() |
|
69 | session_number = Int() | |
70 | # Should we log output to the database? (default no) |
|
70 | # Should we log output to the database? (default no) | |
71 | db_log_output = Bool(False, config=True) |
|
71 | db_log_output = Bool(False, config=True) | |
72 | # Write to database every x commands (higher values save disk access & power) |
|
72 | # Write to database every x commands (higher values save disk access & power) | |
73 | # Values of 1 or less effectively disable caching. |
|
73 | # Values of 1 or less effectively disable caching. | |
74 | db_cache_size = Int(0, config=True) |
|
74 | db_cache_size = Int(0, config=True) | |
75 | # The input and output caches |
|
75 | # The input and output caches | |
76 | db_input_cache = List() |
|
76 | db_input_cache = List() | |
77 | db_output_cache = List() |
|
77 | db_output_cache = List() | |
78 |
|
78 | |||
79 | # Private interface |
|
79 | # Private interface | |
80 | # Variables used to store the three last inputs from the user. On each new |
|
80 | # Variables used to store the three last inputs from the user. On each new | |
81 | # history update, we populate the user's namespace with these, shifted as |
|
81 | # history update, we populate the user's namespace with these, shifted as | |
82 | # necessary. |
|
82 | # necessary. | |
83 | _i00 = Unicode(u'') |
|
83 | _i00 = Unicode(u'') | |
84 | _i = Unicode(u'') |
|
84 | _i = Unicode(u'') | |
85 | _ii = Unicode(u'') |
|
85 | _ii = Unicode(u'') | |
86 | _iii = Unicode(u'') |
|
86 | _iii = Unicode(u'') | |
87 |
|
87 | |||
88 | # A set with all forms of the exit command, so that we don't store them in |
|
88 | # A set with all forms of the exit command, so that we don't store them in | |
89 | # the history (it's annoying to rewind the first entry and land on an exit |
|
89 | # the history (it's annoying to rewind the first entry and land on an exit | |
90 | # call). |
|
90 | # call). | |
91 | _exit_commands = Instance(set, args=(['Quit', 'quit', 'Exit', 'exit', |
|
91 | _exit_commands = Instance(set, args=(['Quit', 'quit', 'Exit', 'exit', | |
92 | '%Quit', '%quit', '%Exit', '%exit'],)) |
|
92 | '%Quit', '%quit', '%Exit', '%exit'],)) | |
93 |
|
93 | |||
94 | def __init__(self, shell, config=None, **traits): |
|
94 | def __init__(self, shell, config=None, **traits): | |
95 | """Create a new history manager associated with a shell instance. |
|
95 | """Create a new history manager associated with a shell instance. | |
96 | """ |
|
96 | """ | |
97 | # We need a pointer back to the shell for various tasks. |
|
97 | # We need a pointer back to the shell for various tasks. | |
98 | super(HistoryManager, self).__init__(shell=shell, config=config, |
|
98 | super(HistoryManager, self).__init__(shell=shell, config=config, | |
99 | **traits) |
|
99 | **traits) | |
100 |
|
100 | |||
101 | if self.hist_file == u'': |
|
101 | if self.hist_file == u'': | |
102 | # No one has set the hist_file, yet. |
|
102 | # No one has set the hist_file, yet. | |
103 | if shell.profile: |
|
103 | if shell.profile: | |
104 | histfname = 'history-%s' % shell.profile |
|
104 | histfname = 'history-%s' % shell.profile | |
105 | else: |
|
105 | else: | |
106 | histfname = 'history' |
|
106 | histfname = 'history' | |
107 | self.hist_file = os.path.join(shell.ipython_dir, histfname + '.sqlite') |
|
107 | self.hist_file = os.path.join(shell.ipython_dir, histfname + '.sqlite') | |
108 |
|
108 | |||
109 | try: |
|
109 | try: | |
110 | self.init_db() |
|
110 | self.init_db() | |
111 | except sqlite3.DatabaseError: |
|
111 | except sqlite3.DatabaseError: | |
112 | if os.path.isfile(self.hist_file): |
|
112 | if os.path.isfile(self.hist_file): | |
113 | # Try to move the file out of the way. |
|
113 | # Try to move the file out of the way. | |
114 | newpath = os.path.join(self.shell.ipython_dir, "hist-corrupt.sqlite") |
|
114 | newpath = os.path.join(self.shell.ipython_dir, "hist-corrupt.sqlite") | |
115 | os.rename(self.hist_file, newpath) |
|
115 | os.rename(self.hist_file, newpath) | |
116 | print("ERROR! History file wasn't a valid SQLite database.", |
|
116 | print("ERROR! History file wasn't a valid SQLite database.", | |
117 | "It was moved to %s" % newpath, "and a new file created.") |
|
117 | "It was moved to %s" % newpath, "and a new file created.") | |
118 | self.init_db() |
|
118 | self.init_db() | |
119 | else: |
|
119 | else: | |
120 | # The hist_file is probably :memory: or something else. |
|
120 | # The hist_file is probably :memory: or something else. | |
121 | raise |
|
121 | raise | |
122 |
|
122 | |||
123 | self.new_session() |
|
123 | self.new_session() | |
124 |
|
124 | |||
125 |
|
125 | |||
126 | def init_db(self): |
|
126 | def init_db(self): | |
127 | """Connect to the database, and create tables if necessary.""" |
|
127 | """Connect to the database, and create tables if necessary.""" | |
128 | self.db = sqlite3.connect(self.hist_file) |
|
128 | self.db = sqlite3.connect(self.hist_file) | |
129 | self.db.execute("""CREATE TABLE IF NOT EXISTS sessions (session integer |
|
129 | self.db.execute("""CREATE TABLE IF NOT EXISTS sessions (session integer | |
130 | primary key autoincrement, start timestamp, |
|
130 | primary key autoincrement, start timestamp, | |
131 | end timestamp, num_cmds integer, remark text)""") |
|
131 | end timestamp, num_cmds integer, remark text)""") | |
132 | self.db.execute("""CREATE TABLE IF NOT EXISTS history |
|
132 | self.db.execute("""CREATE TABLE IF NOT EXISTS history | |
133 | (session integer, line integer, source text, source_raw text, |
|
133 | (session integer, line integer, source text, source_raw text, | |
134 | PRIMARY KEY (session, line))""") |
|
134 | PRIMARY KEY (session, line))""") | |
135 | # Output history is optional, but ensure the table's there so it can be |
|
135 | # Output history is optional, but ensure the table's there so it can be | |
136 | # enabled later. |
|
136 | # enabled later. | |
137 | self.db.execute("""CREATE TABLE IF NOT EXISTS output_history |
|
137 | self.db.execute("""CREATE TABLE IF NOT EXISTS output_history | |
138 | (session integer, line integer, output text, |
|
138 | (session integer, line integer, output text, | |
139 | PRIMARY KEY (session, line))""") |
|
139 | PRIMARY KEY (session, line))""") | |
140 | self.db.commit() |
|
140 | self.db.commit() | |
141 |
|
141 | |||
142 | def new_session(self): |
|
142 | def new_session(self): | |
143 | """Get a new session number.""" |
|
143 | """Get a new session number.""" | |
144 | with self.db: |
|
144 | with self.db: | |
145 | cur = self.db.execute("""INSERT INTO sessions VALUES (NULL, ?, NULL, |
|
145 | cur = self.db.execute("""INSERT INTO sessions VALUES (NULL, ?, NULL, | |
146 | NULL, "") """, (datetime.datetime.now(),)) |
|
146 | NULL, "") """, (datetime.datetime.now(),)) | |
147 | self.session_number = cur.lastrowid |
|
147 | self.session_number = cur.lastrowid | |
148 |
|
148 | |||
149 | def end_session(self): |
|
149 | def end_session(self): | |
150 | """Close the database session, filling in the end time and line count.""" |
|
150 | """Close the database session, filling in the end time and line count.""" | |
151 | self.writeout_cache() |
|
151 | self.writeout_cache() | |
152 | with self.db: |
|
152 | with self.db: | |
153 | self.db.execute("""UPDATE sessions SET end=?, num_cmds=? WHERE |
|
153 | self.db.execute("""UPDATE sessions SET end=?, num_cmds=? WHERE | |
154 | session==?""", (datetime.datetime.now(), |
|
154 | session==?""", (datetime.datetime.now(), | |
155 | len(self.input_hist_parsed)-1, self.session_number)) |
|
155 | len(self.input_hist_parsed)-1, self.session_number)) | |
156 | self.session_number = 0 |
|
156 | self.session_number = 0 | |
157 |
|
157 | |||
158 | def name_session(self, name): |
|
158 | def name_session(self, name): | |
159 | """Give the current session a name in the history database.""" |
|
159 | """Give the current session a name in the history database.""" | |
160 | with self.db: |
|
160 | with self.db: | |
161 | self.db.execute("UPDATE sessions SET remark=? WHERE session==?", |
|
161 | self.db.execute("UPDATE sessions SET remark=? WHERE session==?", | |
162 | (name, self.session_number)) |
|
162 | (name, self.session_number)) | |
163 |
|
163 | |||
164 | def reset(self, new_session=True): |
|
164 | def reset(self, new_session=True): | |
165 | """Clear the session history, releasing all object references, and |
|
165 | """Clear the session history, releasing all object references, and | |
166 | optionally open a new session.""" |
|
166 | optionally open a new session.""" | |
167 | if self.session_number: |
|
|||
168 | self.end_session() |
|
|||
169 | self.input_hist_parsed[:] = [""] |
|
|||
170 | self.input_hist_raw[:] = [""] |
|
|||
171 | self.output_hist.clear() |
|
167 | self.output_hist.clear() | |
172 | # The directory history can't be completely empty |
|
168 | # The directory history can't be completely empty | |
173 | self.dir_hist[:] = [os.getcwd()] |
|
169 | self.dir_hist[:] = [os.getcwd()] | |
174 |
|
170 | |||
175 | if new_session: |
|
171 | if new_session: | |
|
172 | if self.session_number: | |||
|
173 | self.end_session() | |||
|
174 | self.input_hist_parsed[:] = [""] | |||
|
175 | self.input_hist_raw[:] = [""] | |||
176 | self.new_session() |
|
176 | self.new_session() | |
177 |
|
177 | |||
178 | ## ------------------------------- |
|
178 | ## ------------------------------- | |
179 | ## Methods for retrieving history: |
|
179 | ## Methods for retrieving history: | |
180 | ## ------------------------------- |
|
180 | ## ------------------------------- | |
181 | def _run_sql(self, sql, params, raw=True, output=False): |
|
181 | def _run_sql(self, sql, params, raw=True, output=False): | |
182 | """Prepares and runs an SQL query for the history database. |
|
182 | """Prepares and runs an SQL query for the history database. | |
183 |
|
183 | |||
184 | Parameters |
|
184 | Parameters | |
185 | ---------- |
|
185 | ---------- | |
186 | sql : str |
|
186 | sql : str | |
187 | Any filtering expressions to go after SELECT ... FROM ... |
|
187 | Any filtering expressions to go after SELECT ... FROM ... | |
188 | params : tuple |
|
188 | params : tuple | |
189 | Parameters passed to the SQL query (to replace "?") |
|
189 | Parameters passed to the SQL query (to replace "?") | |
190 | raw, output : bool |
|
190 | raw, output : bool | |
191 | See :meth:`get_range` |
|
191 | See :meth:`get_range` | |
192 |
|
192 | |||
193 | Returns |
|
193 | Returns | |
194 | ------- |
|
194 | ------- | |
195 | Tuples as :meth:`get_range` |
|
195 | Tuples as :meth:`get_range` | |
196 | """ |
|
196 | """ | |
197 | toget = 'source_raw' if raw else 'source' |
|
197 | toget = 'source_raw' if raw else 'source' | |
198 | sqlfrom = "history" |
|
198 | sqlfrom = "history" | |
199 | if output: |
|
199 | if output: | |
200 | sqlfrom = "history LEFT JOIN output_history USING (session, line)" |
|
200 | sqlfrom = "history LEFT JOIN output_history USING (session, line)" | |
201 | toget = "history.%s, output_history.output" % toget |
|
201 | toget = "history.%s, output_history.output" % toget | |
202 | cur = self.db.execute("SELECT session, line, %s FROM %s " %\ |
|
202 | cur = self.db.execute("SELECT session, line, %s FROM %s " %\ | |
203 | (toget, sqlfrom) + sql, params) |
|
203 | (toget, sqlfrom) + sql, params) | |
204 | if output: # Regroup into 3-tuples, and parse JSON |
|
204 | if output: # Regroup into 3-tuples, and parse JSON | |
205 | loads = lambda out: json.loads(out) if out else None |
|
205 | loads = lambda out: json.loads(out) if out else None | |
206 | return ((ses, lin, (inp, loads(out))) \ |
|
206 | return ((ses, lin, (inp, loads(out))) \ | |
207 | for ses, lin, inp, out in cur) |
|
207 | for ses, lin, inp, out in cur) | |
208 | return cur |
|
208 | return cur | |
209 |
|
209 | |||
210 |
|
210 | |||
211 | def get_tail(self, n=10, raw=True, output=False, include_latest=False): |
|
211 | def get_tail(self, n=10, raw=True, output=False, include_latest=False): | |
212 | """Get the last n lines from the history database. |
|
212 | """Get the last n lines from the history database. | |
213 |
|
213 | |||
214 | Parameters |
|
214 | Parameters | |
215 | ---------- |
|
215 | ---------- | |
216 | n : int |
|
216 | n : int | |
217 | The number of lines to get |
|
217 | The number of lines to get | |
218 | raw, output : bool |
|
218 | raw, output : bool | |
219 | See :meth:`get_range` |
|
219 | See :meth:`get_range` | |
220 | include_latest : bool |
|
220 | include_latest : bool | |
221 | If False (default), n+1 lines are fetched, and the latest one |
|
221 | If False (default), n+1 lines are fetched, and the latest one | |
222 | is discarded. This is intended to be used where the function |
|
222 | is discarded. This is intended to be used where the function | |
223 | is called by a user command, which it should not return. |
|
223 | is called by a user command, which it should not return. | |
224 |
|
224 | |||
225 | Returns |
|
225 | Returns | |
226 | ------- |
|
226 | ------- | |
227 | Tuples as :meth:`get_range` |
|
227 | Tuples as :meth:`get_range` | |
228 | """ |
|
228 | """ | |
229 | self.writeout_cache() |
|
229 | self.writeout_cache() | |
230 | if not include_latest: |
|
230 | if not include_latest: | |
231 | n += 1 |
|
231 | n += 1 | |
232 | cur = self._run_sql("ORDER BY session DESC, line DESC LIMIT ?", |
|
232 | cur = self._run_sql("ORDER BY session DESC, line DESC LIMIT ?", | |
233 | (n,), raw=raw, output=output) |
|
233 | (n,), raw=raw, output=output) | |
234 | if not include_latest: |
|
234 | if not include_latest: | |
235 | return reversed(list(cur)[1:]) |
|
235 | return reversed(list(cur)[1:]) | |
236 | return reversed(list(cur)) |
|
236 | return reversed(list(cur)) | |
237 |
|
237 | |||
238 | def search(self, pattern="*", raw=True, search_raw=True, |
|
238 | def search(self, pattern="*", raw=True, search_raw=True, | |
239 | output=False): |
|
239 | output=False): | |
240 | """Search the database using unix glob-style matching (wildcards |
|
240 | """Search the database using unix glob-style matching (wildcards | |
241 | * and ?). |
|
241 | * and ?). | |
242 |
|
242 | |||
243 | Parameters |
|
243 | Parameters | |
244 | ---------- |
|
244 | ---------- | |
245 | pattern : str |
|
245 | pattern : str | |
246 | The wildcarded pattern to match when searching |
|
246 | The wildcarded pattern to match when searching | |
247 | search_raw : bool |
|
247 | search_raw : bool | |
248 | If True, search the raw input, otherwise, the parsed input |
|
248 | If True, search the raw input, otherwise, the parsed input | |
249 | raw, output : bool |
|
249 | raw, output : bool | |
250 | See :meth:`get_range` |
|
250 | See :meth:`get_range` | |
251 |
|
251 | |||
252 | Returns |
|
252 | Returns | |
253 | ------- |
|
253 | ------- | |
254 | Tuples as :meth:`get_range` |
|
254 | Tuples as :meth:`get_range` | |
255 | """ |
|
255 | """ | |
256 | tosearch = "source_raw" if search_raw else "source" |
|
256 | tosearch = "source_raw" if search_raw else "source" | |
257 | if output: |
|
257 | if output: | |
258 | tosearch = "history." + tosearch |
|
258 | tosearch = "history." + tosearch | |
259 | self.writeout_cache() |
|
259 | self.writeout_cache() | |
260 | return self._run_sql("WHERE %s GLOB ?" % tosearch, (pattern,), |
|
260 | return self._run_sql("WHERE %s GLOB ?" % tosearch, (pattern,), | |
261 | raw=raw, output=output) |
|
261 | raw=raw, output=output) | |
262 |
|
262 | |||
263 | def _get_range_session(self, start=1, stop=None, raw=True, output=False): |
|
263 | def _get_range_session(self, start=1, stop=None, raw=True, output=False): | |
264 | """Get input and output history from the current session. Called by |
|
264 | """Get input and output history from the current session. Called by | |
265 | get_range, and takes similar parameters.""" |
|
265 | get_range, and takes similar parameters.""" | |
266 | input_hist = self.input_hist_raw if raw else self.input_hist_parsed |
|
266 | input_hist = self.input_hist_raw if raw else self.input_hist_parsed | |
267 |
|
267 | |||
268 | n = len(input_hist) |
|
268 | n = len(input_hist) | |
269 | if start < 0: |
|
269 | if start < 0: | |
270 | start += n |
|
270 | start += n | |
271 | if not stop: |
|
271 | if not stop: | |
272 | stop = n |
|
272 | stop = n | |
273 | elif stop < 0: |
|
273 | elif stop < 0: | |
274 | stop += n |
|
274 | stop += n | |
275 |
|
275 | |||
276 | for i in range(start, stop): |
|
276 | for i in range(start, stop): | |
277 | if output: |
|
277 | if output: | |
278 | line = (input_hist[i], self.output_hist_reprs.get(i)) |
|
278 | line = (input_hist[i], self.output_hist_reprs.get(i)) | |
279 | else: |
|
279 | else: | |
280 | line = input_hist[i] |
|
280 | line = input_hist[i] | |
281 | yield (0, i, line) |
|
281 | yield (0, i, line) | |
282 |
|
282 | |||
283 | def get_range(self, session=0, start=1, stop=None, raw=True,output=False): |
|
283 | def get_range(self, session=0, start=1, stop=None, raw=True,output=False): | |
284 | """Retrieve input by session. |
|
284 | """Retrieve input by session. | |
285 |
|
285 | |||
286 | Parameters |
|
286 | Parameters | |
287 | ---------- |
|
287 | ---------- | |
288 | session : int |
|
288 | session : int | |
289 | Session number to retrieve. The current session is 0, and negative |
|
289 | Session number to retrieve. The current session is 0, and negative | |
290 | numbers count back from current session, so -1 is previous session. |
|
290 | numbers count back from current session, so -1 is previous session. | |
291 | start : int |
|
291 | start : int | |
292 | First line to retrieve. |
|
292 | First line to retrieve. | |
293 | stop : int |
|
293 | stop : int | |
294 | End of line range (excluded from output itself). If None, retrieve |
|
294 | End of line range (excluded from output itself). If None, retrieve | |
295 | to the end of the session. |
|
295 | to the end of the session. | |
296 | raw : bool |
|
296 | raw : bool | |
297 | If True, return untranslated input |
|
297 | If True, return untranslated input | |
298 | output : bool |
|
298 | output : bool | |
299 | If True, attempt to include output. This will be 'real' Python |
|
299 | If True, attempt to include output. This will be 'real' Python | |
300 | objects for the current session, or text reprs from previous |
|
300 | objects for the current session, or text reprs from previous | |
301 | sessions if db_log_output was enabled at the time. Where no output |
|
301 | sessions if db_log_output was enabled at the time. Where no output | |
302 | is found, None is used. |
|
302 | is found, None is used. | |
303 |
|
303 | |||
304 | Returns |
|
304 | Returns | |
305 | ------- |
|
305 | ------- | |
306 | An iterator over the desired lines. Each line is a 3-tuple, either |
|
306 | An iterator over the desired lines. Each line is a 3-tuple, either | |
307 | (session, line, input) if output is False, or |
|
307 | (session, line, input) if output is False, or | |
308 | (session, line, (input, output)) if output is True. |
|
308 | (session, line, (input, output)) if output is True. | |
309 | """ |
|
309 | """ | |
310 | if session == 0 or session==self.session_number: # Current session |
|
310 | if session == 0 or session==self.session_number: # Current session | |
311 | return self._get_range_session(start, stop, raw, output) |
|
311 | return self._get_range_session(start, stop, raw, output) | |
312 | if session < 0: |
|
312 | if session < 0: | |
313 | session += self.session_number |
|
313 | session += self.session_number | |
314 |
|
314 | |||
315 | if stop: |
|
315 | if stop: | |
316 | lineclause = "line >= ? AND line < ?" |
|
316 | lineclause = "line >= ? AND line < ?" | |
317 | params = (session, start, stop) |
|
317 | params = (session, start, stop) | |
318 | else: |
|
318 | else: | |
319 | lineclause = "line>=?" |
|
319 | lineclause = "line>=?" | |
320 | params = (session, start) |
|
320 | params = (session, start) | |
321 |
|
321 | |||
322 | return self._run_sql("WHERE session==? AND %s""" % lineclause, |
|
322 | return self._run_sql("WHERE session==? AND %s""" % lineclause, | |
323 | params, raw=raw, output=output) |
|
323 | params, raw=raw, output=output) | |
324 |
|
324 | |||
325 | def get_range_by_str(self, rangestr, raw=True, output=False): |
|
325 | def get_range_by_str(self, rangestr, raw=True, output=False): | |
326 | """Get lines of history from a string of ranges, as used by magic |
|
326 | """Get lines of history from a string of ranges, as used by magic | |
327 | commands %hist, %save, %macro, etc. |
|
327 | commands %hist, %save, %macro, etc. | |
328 |
|
328 | |||
329 | Parameters |
|
329 | Parameters | |
330 | ---------- |
|
330 | ---------- | |
331 | rangestr : str |
|
331 | rangestr : str | |
332 | A string specifying ranges, e.g. "5 ~2/1-4". See |
|
332 | A string specifying ranges, e.g. "5 ~2/1-4". See | |
333 | :func:`magic_history` for full details. |
|
333 | :func:`magic_history` for full details. | |
334 | raw, output : bool |
|
334 | raw, output : bool | |
335 | As :meth:`get_range` |
|
335 | As :meth:`get_range` | |
336 |
|
336 | |||
337 | Returns |
|
337 | Returns | |
338 | ------- |
|
338 | ------- | |
339 | Tuples as :meth:`get_range` |
|
339 | Tuples as :meth:`get_range` | |
340 | """ |
|
340 | """ | |
341 | for sess, s, e in extract_hist_ranges(rangestr): |
|
341 | for sess, s, e in extract_hist_ranges(rangestr): | |
342 | for line in self.get_range(sess, s, e, raw=raw, output=output): |
|
342 | for line in self.get_range(sess, s, e, raw=raw, output=output): | |
343 | yield line |
|
343 | yield line | |
344 |
|
344 | |||
345 | ## ---------------------------- |
|
345 | ## ---------------------------- | |
346 | ## Methods for storing history: |
|
346 | ## Methods for storing history: | |
347 | ## ---------------------------- |
|
347 | ## ---------------------------- | |
348 | def store_inputs(self, line_num, source, source_raw=None): |
|
348 | def store_inputs(self, line_num, source, source_raw=None): | |
349 | """Store source and raw input in history and create input cache |
|
349 | """Store source and raw input in history and create input cache | |
350 | variables _i*. |
|
350 | variables _i*. | |
351 |
|
351 | |||
352 | Parameters |
|
352 | Parameters | |
353 | ---------- |
|
353 | ---------- | |
354 | line_num : int |
|
354 | line_num : int | |
355 | The prompt number of this input. |
|
355 | The prompt number of this input. | |
356 |
|
356 | |||
357 | source : str |
|
357 | source : str | |
358 | Python input. |
|
358 | Python input. | |
359 |
|
359 | |||
360 | source_raw : str, optional |
|
360 | source_raw : str, optional | |
361 | If given, this is the raw input without any IPython transformations |
|
361 | If given, this is the raw input without any IPython transformations | |
362 | applied to it. If not given, ``source`` is used. |
|
362 | applied to it. If not given, ``source`` is used. | |
363 | """ |
|
363 | """ | |
364 | if source_raw is None: |
|
364 | if source_raw is None: | |
365 | source_raw = source |
|
365 | source_raw = source | |
366 | source = source.rstrip('\n') |
|
366 | source = source.rstrip('\n') | |
367 | source_raw = source_raw.rstrip('\n') |
|
367 | source_raw = source_raw.rstrip('\n') | |
368 |
|
368 | |||
369 | # do not store exit/quit commands |
|
369 | # do not store exit/quit commands | |
370 | if source_raw.strip() in self._exit_commands: |
|
370 | if source_raw.strip() in self._exit_commands: | |
371 | return |
|
371 | return | |
372 |
|
372 | |||
373 | self.input_hist_parsed.append(source) |
|
373 | self.input_hist_parsed.append(source) | |
374 | self.input_hist_raw.append(source_raw) |
|
374 | self.input_hist_raw.append(source_raw) | |
375 |
|
375 | |||
376 | self.db_input_cache.append((line_num, source, source_raw)) |
|
376 | self.db_input_cache.append((line_num, source, source_raw)) | |
377 | # Trigger to flush cache and write to DB. |
|
377 | # Trigger to flush cache and write to DB. | |
378 | if len(self.db_input_cache) >= self.db_cache_size: |
|
378 | if len(self.db_input_cache) >= self.db_cache_size: | |
379 | self.writeout_cache() |
|
379 | self.writeout_cache() | |
380 |
|
380 | |||
381 | # update the auto _i variables |
|
381 | # update the auto _i variables | |
382 | self._iii = self._ii |
|
382 | self._iii = self._ii | |
383 | self._ii = self._i |
|
383 | self._ii = self._i | |
384 | self._i = self._i00 |
|
384 | self._i = self._i00 | |
385 | self._i00 = source_raw |
|
385 | self._i00 = source_raw | |
386 |
|
386 | |||
387 | # hackish access to user namespace to create _i1,_i2... dynamically |
|
387 | # hackish access to user namespace to create _i1,_i2... dynamically | |
388 | new_i = '_i%s' % line_num |
|
388 | new_i = '_i%s' % line_num | |
389 | to_main = {'_i': self._i, |
|
389 | to_main = {'_i': self._i, | |
390 | '_ii': self._ii, |
|
390 | '_ii': self._ii, | |
391 | '_iii': self._iii, |
|
391 | '_iii': self._iii, | |
392 | new_i : self._i00 } |
|
392 | new_i : self._i00 } | |
393 | self.shell.user_ns.update(to_main) |
|
393 | self.shell.user_ns.update(to_main) | |
394 |
|
394 | |||
395 | def store_output(self, line_num): |
|
395 | def store_output(self, line_num): | |
396 | """If database output logging is enabled, this saves all the |
|
396 | """If database output logging is enabled, this saves all the | |
397 | outputs from the indicated prompt number to the database. It's |
|
397 | outputs from the indicated prompt number to the database. It's | |
398 | called by run_cell after code has been executed. |
|
398 | called by run_cell after code has been executed. | |
399 |
|
399 | |||
400 | Parameters |
|
400 | Parameters | |
401 | ---------- |
|
401 | ---------- | |
402 | line_num : int |
|
402 | line_num : int | |
403 | The line number from which to save outputs |
|
403 | The line number from which to save outputs | |
404 | """ |
|
404 | """ | |
405 | if (not self.db_log_output) or not self.output_hist_reprs[line_num]: |
|
405 | if (not self.db_log_output) or not self.output_hist_reprs[line_num]: | |
406 | return |
|
406 | return | |
407 | output = json.dumps(self.output_hist_reprs[line_num]) |
|
407 | output = json.dumps(self.output_hist_reprs[line_num]) | |
408 |
|
408 | |||
409 | self.db_output_cache.append((line_num, output)) |
|
409 | self.db_output_cache.append((line_num, output)) | |
410 | if self.db_cache_size <= 1: |
|
410 | if self.db_cache_size <= 1: | |
411 | self.writeout_cache() |
|
411 | self.writeout_cache() | |
412 |
|
412 | |||
413 | def _writeout_input_cache(self): |
|
413 | def _writeout_input_cache(self): | |
414 | with self.db: |
|
414 | with self.db: | |
415 | for line in self.db_input_cache: |
|
415 | for line in self.db_input_cache: | |
416 | self.db.execute("INSERT INTO history VALUES (?, ?, ?, ?)", |
|
416 | self.db.execute("INSERT INTO history VALUES (?, ?, ?, ?)", | |
417 | (self.session_number,)+line) |
|
417 | (self.session_number,)+line) | |
418 |
|
418 | |||
419 | def _writeout_output_cache(self): |
|
419 | def _writeout_output_cache(self): | |
420 | with self.db: |
|
420 | with self.db: | |
421 | for line in self.db_output_cache: |
|
421 | for line in self.db_output_cache: | |
422 | self.db.execute("INSERT INTO output_history VALUES (?, ?, ?)", |
|
422 | self.db.execute("INSERT INTO output_history VALUES (?, ?, ?)", | |
423 | (self.session_number,)+line) |
|
423 | (self.session_number,)+line) | |
424 |
|
424 | |||
425 | def writeout_cache(self): |
|
425 | def writeout_cache(self): | |
426 | """Write any entries in the cache to the database.""" |
|
426 | """Write any entries in the cache to the database.""" | |
427 | try: |
|
427 | try: | |
428 | self._writeout_input_cache() |
|
428 | self._writeout_input_cache() | |
429 | except sqlite3.IntegrityError: |
|
429 | except sqlite3.IntegrityError: | |
430 | self.new_session() |
|
430 | self.new_session() | |
431 | print("ERROR! Session/line number was not unique in", |
|
431 | print("ERROR! Session/line number was not unique in", | |
432 | "database. History logging moved to new session", |
|
432 | "database. History logging moved to new session", | |
433 | self.session_number) |
|
433 | self.session_number) | |
434 | try: # Try writing to the new session. If this fails, don't recurse |
|
434 | try: # Try writing to the new session. If this fails, don't recurse | |
435 | self._writeout_input_cache() |
|
435 | self._writeout_input_cache() | |
436 | except sqlite3.IntegrityError: |
|
436 | except sqlite3.IntegrityError: | |
437 | pass |
|
437 | pass | |
438 | finally: |
|
438 | finally: | |
439 | self.db_input_cache = [] |
|
439 | self.db_input_cache = [] | |
440 |
|
440 | |||
441 | try: |
|
441 | try: | |
442 | self._writeout_output_cache() |
|
442 | self._writeout_output_cache() | |
443 | except sqlite3.IntegrityError: |
|
443 | except sqlite3.IntegrityError: | |
444 | print("!! Session/line number for output was not unique", |
|
444 | print("!! Session/line number for output was not unique", | |
445 | "in database. Output will not be stored.") |
|
445 | "in database. Output will not be stored.") | |
446 | finally: |
|
446 | finally: | |
447 | self.db_output_cache = [] |
|
447 | self.db_output_cache = [] | |
448 |
|
448 | |||
449 |
|
449 | |||
450 | # To match, e.g. ~5/8-~2/3 |
|
450 | # To match, e.g. ~5/8-~2/3 | |
451 | range_re = re.compile(r""" |
|
451 | range_re = re.compile(r""" | |
452 | ((?P<startsess>~?\d+)/)? |
|
452 | ((?P<startsess>~?\d+)/)? | |
453 | (?P<start>\d+) # Only the start line num is compulsory |
|
453 | (?P<start>\d+) # Only the start line num is compulsory | |
454 | ((?P<sep>[\-:]) |
|
454 | ((?P<sep>[\-:]) | |
455 | ((?P<endsess>~?\d+)/)? |
|
455 | ((?P<endsess>~?\d+)/)? | |
456 | (?P<end>\d+))? |
|
456 | (?P<end>\d+))? | |
457 | $""", re.VERBOSE) |
|
457 | $""", re.VERBOSE) | |
458 |
|
458 | |||
459 | def extract_hist_ranges(ranges_str): |
|
459 | def extract_hist_ranges(ranges_str): | |
460 | """Turn a string of history ranges into 3-tuples of (session, start, stop). |
|
460 | """Turn a string of history ranges into 3-tuples of (session, start, stop). | |
461 |
|
461 | |||
462 | Examples |
|
462 | Examples | |
463 | -------- |
|
463 | -------- | |
464 | list(extract_input_ranges("~8/5-~7/4 2")) |
|
464 | list(extract_input_ranges("~8/5-~7/4 2")) | |
465 | [(-8, 5, None), (-7, 1, 4), (0, 2, 3)] |
|
465 | [(-8, 5, None), (-7, 1, 4), (0, 2, 3)] | |
466 | """ |
|
466 | """ | |
467 | for range_str in ranges_str.split(): |
|
467 | for range_str in ranges_str.split(): | |
468 | rmatch = range_re.match(range_str) |
|
468 | rmatch = range_re.match(range_str) | |
469 | if not rmatch: |
|
469 | if not rmatch: | |
470 | continue |
|
470 | continue | |
471 | start = int(rmatch.group("start")) |
|
471 | start = int(rmatch.group("start")) | |
472 | end = rmatch.group("end") |
|
472 | end = rmatch.group("end") | |
473 | end = int(end) if end else start+1 # If no end specified, get (a, a+1) |
|
473 | end = int(end) if end else start+1 # If no end specified, get (a, a+1) | |
474 | if rmatch.group("sep") == "-": # 1-3 == 1:4 --> [1, 2, 3] |
|
474 | if rmatch.group("sep") == "-": # 1-3 == 1:4 --> [1, 2, 3] | |
475 | end += 1 |
|
475 | end += 1 | |
476 | startsess = rmatch.group("startsess") or "0" |
|
476 | startsess = rmatch.group("startsess") or "0" | |
477 | endsess = rmatch.group("endsess") or startsess |
|
477 | endsess = rmatch.group("endsess") or startsess | |
478 | startsess = int(startsess.replace("~","-")) |
|
478 | startsess = int(startsess.replace("~","-")) | |
479 | endsess = int(endsess.replace("~","-")) |
|
479 | endsess = int(endsess.replace("~","-")) | |
480 | assert endsess >= startsess |
|
480 | assert endsess >= startsess | |
481 |
|
481 | |||
482 | if endsess == startsess: |
|
482 | if endsess == startsess: | |
483 | yield (startsess, start, end) |
|
483 | yield (startsess, start, end) | |
484 | continue |
|
484 | continue | |
485 | # Multiple sessions in one range: |
|
485 | # Multiple sessions in one range: | |
486 | yield (startsess, start, None) |
|
486 | yield (startsess, start, None) | |
487 | for sess in range(startsess+1, endsess): |
|
487 | for sess in range(startsess+1, endsess): | |
488 | yield (sess, 1, None) |
|
488 | yield (sess, 1, None) | |
489 | yield (endsess, 1, end) |
|
489 | yield (endsess, 1, end) | |
490 |
|
490 | |||
491 | def _format_lineno(session, line): |
|
491 | def _format_lineno(session, line): | |
492 | """Helper function to format line numbers properly.""" |
|
492 | """Helper function to format line numbers properly.""" | |
493 | if session == 0: |
|
493 | if session == 0: | |
494 | return str(line) |
|
494 | return str(line) | |
495 | return "%s#%s" % (session, line) |
|
495 | return "%s#%s" % (session, line) | |
496 |
|
496 | |||
497 | @testdec.skip_doctest |
|
497 | @testdec.skip_doctest | |
498 | def magic_history(self, parameter_s = ''): |
|
498 | def magic_history(self, parameter_s = ''): | |
499 | """Print input history (_i<n> variables), with most recent last. |
|
499 | """Print input history (_i<n> variables), with most recent last. | |
500 |
|
500 | |||
501 | %history -> print at most 40 inputs (some may be multi-line)\\ |
|
501 | %history -> print at most 40 inputs (some may be multi-line)\\ | |
502 | %history n -> print at most n inputs\\ |
|
502 | %history n -> print at most n inputs\\ | |
503 | %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\\ |
|
503 | %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\\ | |
504 |
|
504 | |||
505 | By default, input history is printed without line numbers so it can be |
|
505 | By default, input history is printed without line numbers so it can be | |
506 | directly pasted into an editor. Use -n to show them. |
|
506 | directly pasted into an editor. Use -n to show them. | |
507 |
|
507 | |||
508 | Ranges of history can be indicated using the syntax: |
|
508 | Ranges of history can be indicated using the syntax: | |
509 | 4 : Line 4, current session |
|
509 | 4 : Line 4, current session | |
510 | 4-6 : Lines 4-6, current session |
|
510 | 4-6 : Lines 4-6, current session | |
511 | 243/1-5: Lines 1-5, session 243 |
|
511 | 243/1-5: Lines 1-5, session 243 | |
512 | ~2/7 : Line 7, session 2 before current |
|
512 | ~2/7 : Line 7, session 2 before current | |
513 | ~8/1-~6/5 : From the first line of 8 sessions ago, to the fifth line |
|
513 | ~8/1-~6/5 : From the first line of 8 sessions ago, to the fifth line | |
514 | of 6 sessions ago. |
|
514 | of 6 sessions ago. | |
515 | Multiple ranges can be entered, separated by spaces |
|
515 | Multiple ranges can be entered, separated by spaces | |
516 |
|
516 | |||
517 | The same syntax is used by %macro, %save, %edit, %rerun |
|
517 | The same syntax is used by %macro, %save, %edit, %rerun | |
518 |
|
518 | |||
519 | Options: |
|
519 | Options: | |
520 |
|
520 | |||
521 | -n: print line numbers for each input. |
|
521 | -n: print line numbers for each input. | |
522 | This feature is only available if numbered prompts are in use. |
|
522 | This feature is only available if numbered prompts are in use. | |
523 |
|
523 | |||
524 | -o: also print outputs for each input. |
|
524 | -o: also print outputs for each input. | |
525 |
|
525 | |||
526 | -p: print classic '>>>' python prompts before each input. This is useful |
|
526 | -p: print classic '>>>' python prompts before each input. This is useful | |
527 | for making documentation, and in conjunction with -o, for producing |
|
527 | for making documentation, and in conjunction with -o, for producing | |
528 | doctest-ready output. |
|
528 | doctest-ready output. | |
529 |
|
529 | |||
530 | -r: (default) print the 'raw' history, i.e. the actual commands you typed. |
|
530 | -r: (default) print the 'raw' history, i.e. the actual commands you typed. | |
531 |
|
531 | |||
532 | -t: print the 'translated' history, as IPython understands it. IPython |
|
532 | -t: print the 'translated' history, as IPython understands it. IPython | |
533 | filters your input and converts it all into valid Python source before |
|
533 | filters your input and converts it all into valid Python source before | |
534 | executing it (things like magics or aliases are turned into function |
|
534 | executing it (things like magics or aliases are turned into function | |
535 | calls, for example). With this option, you'll see the native history |
|
535 | calls, for example). With this option, you'll see the native history | |
536 | instead of the user-entered version: '%cd /' will be seen as |
|
536 | instead of the user-entered version: '%cd /' will be seen as | |
537 | 'get_ipython().magic("%cd /")' instead of '%cd /'. |
|
537 | 'get_ipython().magic("%cd /")' instead of '%cd /'. | |
538 |
|
538 | |||
539 | -g: treat the arg as a pattern to grep for in (full) history. |
|
539 | -g: treat the arg as a pattern to grep for in (full) history. | |
540 | This includes the saved history (almost all commands ever written). |
|
540 | This includes the saved history (almost all commands ever written). | |
541 | Use '%hist -g' to show full saved history (may be very long). |
|
541 | Use '%hist -g' to show full saved history (may be very long). | |
542 |
|
542 | |||
543 | -l: get the last n lines from all sessions. Specify n as a single arg, or |
|
543 | -l: get the last n lines from all sessions. Specify n as a single arg, or | |
544 | the default is the last 10 lines. |
|
544 | the default is the last 10 lines. | |
545 |
|
545 | |||
546 | -f FILENAME: instead of printing the output to the screen, redirect it to |
|
546 | -f FILENAME: instead of printing the output to the screen, redirect it to | |
547 | the given file. The file is always overwritten, though IPython asks for |
|
547 | the given file. The file is always overwritten, though IPython asks for | |
548 | confirmation first if it already exists. |
|
548 | confirmation first if it already exists. | |
549 |
|
549 | |||
550 | Examples |
|
550 | Examples | |
551 | -------- |
|
551 | -------- | |
552 | :: |
|
552 | :: | |
553 |
|
553 | |||
554 | In [6]: %hist -n 4 6 |
|
554 | In [6]: %hist -n 4 6 | |
555 | 4:a = 12 |
|
555 | 4:a = 12 | |
556 | 5:print a**2 |
|
556 | 5:print a**2 | |
557 |
|
557 | |||
558 | """ |
|
558 | """ | |
559 |
|
559 | |||
560 | if not self.shell.displayhook.do_full_cache: |
|
560 | if not self.shell.displayhook.do_full_cache: | |
561 | print('This feature is only available if numbered prompts are in use.') |
|
561 | print('This feature is only available if numbered prompts are in use.') | |
562 | return |
|
562 | return | |
563 | opts,args = self.parse_options(parameter_s,'noprtglf:',mode='string') |
|
563 | opts,args = self.parse_options(parameter_s,'noprtglf:',mode='string') | |
564 |
|
564 | |||
565 | # For brevity |
|
565 | # For brevity | |
566 | history_manager = self.shell.history_manager |
|
566 | history_manager = self.shell.history_manager | |
567 |
|
567 | |||
568 | def _format_lineno(session, line): |
|
568 | def _format_lineno(session, line): | |
569 | """Helper function to format line numbers properly.""" |
|
569 | """Helper function to format line numbers properly.""" | |
570 | if session in (0, history_manager.session_number): |
|
570 | if session in (0, history_manager.session_number): | |
571 | return str(line) |
|
571 | return str(line) | |
572 | return "%s/%s" % (session, line) |
|
572 | return "%s/%s" % (session, line) | |
573 |
|
573 | |||
574 | # Check if output to specific file was requested. |
|
574 | # Check if output to specific file was requested. | |
575 | try: |
|
575 | try: | |
576 | outfname = opts['f'] |
|
576 | outfname = opts['f'] | |
577 | except KeyError: |
|
577 | except KeyError: | |
578 | outfile = IPython.utils.io.Term.cout # default |
|
578 | outfile = IPython.utils.io.Term.cout # default | |
579 | # We don't want to close stdout at the end! |
|
579 | # We don't want to close stdout at the end! | |
580 | close_at_end = False |
|
580 | close_at_end = False | |
581 | else: |
|
581 | else: | |
582 | if os.path.exists(outfname): |
|
582 | if os.path.exists(outfname): | |
583 | if not ask_yes_no("File %r exists. Overwrite?" % outfname): |
|
583 | if not ask_yes_no("File %r exists. Overwrite?" % outfname): | |
584 | print('Aborting.') |
|
584 | print('Aborting.') | |
585 | return |
|
585 | return | |
586 |
|
586 | |||
587 | outfile = open(outfname,'w') |
|
587 | outfile = open(outfname,'w') | |
588 | close_at_end = True |
|
588 | close_at_end = True | |
589 |
|
589 | |||
590 | print_nums = 'n' in opts |
|
590 | print_nums = 'n' in opts | |
591 | get_output = 'o' in opts |
|
591 | get_output = 'o' in opts | |
592 | pyprompts = 'p' in opts |
|
592 | pyprompts = 'p' in opts | |
593 | # Raw history is the default |
|
593 | # Raw history is the default | |
594 | raw = not('t' in opts) |
|
594 | raw = not('t' in opts) | |
595 |
|
595 | |||
596 | default_length = 40 |
|
596 | default_length = 40 | |
597 | pattern = None |
|
597 | pattern = None | |
598 |
|
598 | |||
599 | if 'g' in opts: # Glob search |
|
599 | if 'g' in opts: # Glob search | |
600 | pattern = "*" + args + "*" if args else "*" |
|
600 | pattern = "*" + args + "*" if args else "*" | |
601 | hist = history_manager.search(pattern, raw=raw, output=get_output) |
|
601 | hist = history_manager.search(pattern, raw=raw, output=get_output) | |
602 | elif 'l' in opts: # Get 'tail' |
|
602 | elif 'l' in opts: # Get 'tail' | |
603 | try: |
|
603 | try: | |
604 | n = int(args) |
|
604 | n = int(args) | |
605 | except ValueError, IndexError: |
|
605 | except ValueError, IndexError: | |
606 | n = 10 |
|
606 | n = 10 | |
607 | hist = history_manager.get_tail(n, raw=raw, output=get_output) |
|
607 | hist = history_manager.get_tail(n, raw=raw, output=get_output) | |
608 | else: |
|
608 | else: | |
609 | if args: # Get history by ranges |
|
609 | if args: # Get history by ranges | |
610 | hist = history_manager.get_range_by_str(args, raw, get_output) |
|
610 | hist = history_manager.get_range_by_str(args, raw, get_output) | |
611 | else: # Just get history for the current session |
|
611 | else: # Just get history for the current session | |
612 | hist = history_manager.get_range(raw=raw, output=get_output) |
|
612 | hist = history_manager.get_range(raw=raw, output=get_output) | |
613 |
|
613 | |||
614 | # We could be displaying the entire history, so let's not try to pull it |
|
614 | # We could be displaying the entire history, so let's not try to pull it | |
615 | # into a list in memory. Anything that needs more space will just misalign. |
|
615 | # into a list in memory. Anything that needs more space will just misalign. | |
616 | width = 4 |
|
616 | width = 4 | |
617 |
|
617 | |||
618 | for session, lineno, inline in hist: |
|
618 | for session, lineno, inline in hist: | |
619 | # Print user history with tabs expanded to 4 spaces. The GUI clients |
|
619 | # Print user history with tabs expanded to 4 spaces. The GUI clients | |
620 | # use hard tabs for easier usability in auto-indented code, but we want |
|
620 | # use hard tabs for easier usability in auto-indented code, but we want | |
621 | # to produce PEP-8 compliant history for safe pasting into an editor. |
|
621 | # to produce PEP-8 compliant history for safe pasting into an editor. | |
622 | if get_output: |
|
622 | if get_output: | |
623 | inline, output = inline |
|
623 | inline, output = inline | |
624 | inline = inline.expandtabs(4).rstrip() |
|
624 | inline = inline.expandtabs(4).rstrip() | |
625 |
|
625 | |||
626 | multiline = "\n" in inline |
|
626 | multiline = "\n" in inline | |
627 | line_sep = '\n' if multiline else ' ' |
|
627 | line_sep = '\n' if multiline else ' ' | |
628 | if print_nums: |
|
628 | if print_nums: | |
629 | print('%s:%s' % (_format_lineno(session, lineno).rjust(width), |
|
629 | print('%s:%s' % (_format_lineno(session, lineno).rjust(width), | |
630 | line_sep), file=outfile, end='') |
|
630 | line_sep), file=outfile, end='') | |
631 | if pyprompts: |
|
631 | if pyprompts: | |
632 | print(">>> ", end="", file=outfile) |
|
632 | print(">>> ", end="", file=outfile) | |
633 | if multiline: |
|
633 | if multiline: | |
634 | inline = "\n... ".join(inline.splitlines()) + "\n..." |
|
634 | inline = "\n... ".join(inline.splitlines()) + "\n..." | |
635 | print(inline, file=outfile) |
|
635 | print(inline, file=outfile) | |
636 | if get_output and output: |
|
636 | if get_output and output: | |
637 | print("\n".join(output), file=outfile) |
|
637 | print("\n".join(output), file=outfile) | |
638 |
|
638 | |||
639 | if close_at_end: |
|
639 | if close_at_end: | |
640 | outfile.close() |
|
640 | outfile.close() | |
641 |
|
641 | |||
642 |
|
642 | |||
643 | def magic_rep(self, arg): |
|
643 | def magic_rep(self, arg): | |
644 | r""" Repeat a command, or get command to input line for editing |
|
644 | r""" Repeat a command, or get command to input line for editing | |
645 |
|
645 | |||
646 | - %rep (no arguments): |
|
646 | - %rep (no arguments): | |
647 |
|
647 | |||
648 | Place a string version of last computation result (stored in the special '_' |
|
648 | Place a string version of last computation result (stored in the special '_' | |
649 | variable) to the next input prompt. Allows you to create elaborate command |
|
649 | variable) to the next input prompt. Allows you to create elaborate command | |
650 | lines without using copy-paste:: |
|
650 | lines without using copy-paste:: | |
651 |
|
651 | |||
652 | In[1]: l = ["hei", "vaan"] |
|
652 | In[1]: l = ["hei", "vaan"] | |
653 | In[2]: "".join(l) |
|
653 | In[2]: "".join(l) | |
654 | Out[2]: heivaan |
|
654 | Out[2]: heivaan | |
655 | In[3]: %rep |
|
655 | In[3]: %rep | |
656 | In[4]: heivaan_ <== cursor blinking |
|
656 | In[4]: heivaan_ <== cursor blinking | |
657 |
|
657 | |||
658 | %rep 45 |
|
658 | %rep 45 | |
659 |
|
659 | |||
660 | Place history line 45 on the next input prompt. Use %hist to find |
|
660 | Place history line 45 on the next input prompt. Use %hist to find | |
661 | out the number. |
|
661 | out the number. | |
662 |
|
662 | |||
663 | %rep 1-4 |
|
663 | %rep 1-4 | |
664 |
|
664 | |||
665 | Combine the specified lines into one cell, and place it on the next |
|
665 | Combine the specified lines into one cell, and place it on the next | |
666 | input prompt. See %history for the slice syntax. |
|
666 | input prompt. See %history for the slice syntax. | |
667 |
|
667 | |||
668 | %rep foo+bar |
|
668 | %rep foo+bar | |
669 |
|
669 | |||
670 | If foo+bar can be evaluated in the user namespace, the result is |
|
670 | If foo+bar can be evaluated in the user namespace, the result is | |
671 | placed at the next input prompt. Otherwise, the history is searched |
|
671 | placed at the next input prompt. Otherwise, the history is searched | |
672 | for lines which contain that substring, and the most recent one is |
|
672 | for lines which contain that substring, and the most recent one is | |
673 | placed at the next input prompt. |
|
673 | placed at the next input prompt. | |
674 | """ |
|
674 | """ | |
675 | if not arg: # Last output |
|
675 | if not arg: # Last output | |
676 | self.set_next_input(str(self.shell.user_ns["_"])) |
|
676 | self.set_next_input(str(self.shell.user_ns["_"])) | |
677 | return |
|
677 | return | |
678 | # Get history range |
|
678 | # Get history range | |
679 | histlines = self.history_manager.get_range_by_str(arg) |
|
679 | histlines = self.history_manager.get_range_by_str(arg) | |
680 | cmd = "\n".join(x[2] for x in histlines) |
|
680 | cmd = "\n".join(x[2] for x in histlines) | |
681 | if cmd: |
|
681 | if cmd: | |
682 | self.set_next_input(cmd.rstrip()) |
|
682 | self.set_next_input(cmd.rstrip()) | |
683 | return |
|
683 | return | |
684 |
|
684 | |||
685 | try: # Variable in user namespace |
|
685 | try: # Variable in user namespace | |
686 | cmd = str(eval(arg, self.shell.user_ns)) |
|
686 | cmd = str(eval(arg, self.shell.user_ns)) | |
687 | except Exception: # Search for term in history |
|
687 | except Exception: # Search for term in history | |
688 | histlines = self.history_manager.search("*"+arg+"*") |
|
688 | histlines = self.history_manager.search("*"+arg+"*") | |
689 | for h in reversed([x[2] for x in histlines]): |
|
689 | for h in reversed([x[2] for x in histlines]): | |
690 | if 'rep' in h: |
|
690 | if 'rep' in h: | |
691 | continue |
|
691 | continue | |
692 | self.set_next_input(h.rstrip()) |
|
692 | self.set_next_input(h.rstrip()) | |
693 | return |
|
693 | return | |
694 | else: |
|
694 | else: | |
695 | self.set_next_input(cmd.rstrip()) |
|
695 | self.set_next_input(cmd.rstrip()) | |
696 | print("Couldn't evaluate or find in history:", arg) |
|
696 | print("Couldn't evaluate or find in history:", arg) | |
697 |
|
697 | |||
698 | def magic_rerun(self, parameter_s=''): |
|
698 | def magic_rerun(self, parameter_s=''): | |
699 | """Re-run previous input |
|
699 | """Re-run previous input | |
700 |
|
700 | |||
701 | By default, you can specify ranges of input history to be repeated |
|
701 | By default, you can specify ranges of input history to be repeated | |
702 | (as with %history). With no arguments, it will repeat the last line. |
|
702 | (as with %history). With no arguments, it will repeat the last line. | |
703 |
|
703 | |||
704 | Options: |
|
704 | Options: | |
705 |
|
705 | |||
706 | -l <n> : Repeat the last n lines of input, not including the |
|
706 | -l <n> : Repeat the last n lines of input, not including the | |
707 | current command. |
|
707 | current command. | |
708 |
|
708 | |||
709 | -g foo : Repeat the most recent line which contains foo |
|
709 | -g foo : Repeat the most recent line which contains foo | |
710 | """ |
|
710 | """ | |
711 | opts, args = self.parse_options(parameter_s, 'l:g:', mode='string') |
|
711 | opts, args = self.parse_options(parameter_s, 'l:g:', mode='string') | |
712 | if "l" in opts: # Last n lines |
|
712 | if "l" in opts: # Last n lines | |
713 | n = int(opts['l']) |
|
713 | n = int(opts['l']) | |
714 | hist = self.history_manager.get_tail(n) |
|
714 | hist = self.history_manager.get_tail(n) | |
715 | elif "g" in opts: # Search |
|
715 | elif "g" in opts: # Search | |
716 | p = "*"+opts['g']+"*" |
|
716 | p = "*"+opts['g']+"*" | |
717 | hist = list(self.history_manager.search(p)) |
|
717 | hist = list(self.history_manager.search(p)) | |
718 | for l in reversed(hist): |
|
718 | for l in reversed(hist): | |
719 | if "rerun" not in l[2]: |
|
719 | if "rerun" not in l[2]: | |
720 | hist = [l] # The last match which isn't a %rerun |
|
720 | hist = [l] # The last match which isn't a %rerun | |
721 | break |
|
721 | break | |
722 | else: |
|
722 | else: | |
723 | hist = [] # No matches except %rerun |
|
723 | hist = [] # No matches except %rerun | |
724 | elif args: # Specify history ranges |
|
724 | elif args: # Specify history ranges | |
725 | hist = self.history_manager.get_range_by_str(args) |
|
725 | hist = self.history_manager.get_range_by_str(args) | |
726 | else: # Last line |
|
726 | else: # Last line | |
727 | hist = self.history_manager.get_tail(1) |
|
727 | hist = self.history_manager.get_tail(1) | |
728 | hist = [x[2] for x in hist] |
|
728 | hist = [x[2] for x in hist] | |
729 | if not hist: |
|
729 | if not hist: | |
730 | print("No lines in history match specification") |
|
730 | print("No lines in history match specification") | |
731 | return |
|
731 | return | |
732 | histlines = "\n".join(hist) |
|
732 | histlines = "\n".join(hist) | |
733 | print("=== Executing: ===") |
|
733 | print("=== Executing: ===") | |
734 | print(histlines) |
|
734 | print(histlines) | |
735 | print("=== Output: ===") |
|
735 | print("=== Output: ===") | |
736 | self.run_cell("\n".join(hist), store_history=False) |
|
736 | self.run_cell("\n".join(hist), store_history=False) | |
737 |
|
737 | |||
738 |
|
738 | |||
739 | def init_ipython(ip): |
|
739 | def init_ipython(ip): | |
740 | ip.define_magic("rep", magic_rep) |
|
740 | ip.define_magic("rep", magic_rep) | |
741 | ip.define_magic("recall", magic_rep) |
|
741 | ip.define_magic("recall", magic_rep) | |
742 | ip.define_magic("rerun", magic_rerun) |
|
742 | ip.define_magic("rerun", magic_rerun) | |
743 | ip.define_magic("hist",magic_history) # Alternative name |
|
743 | ip.define_magic("hist",magic_history) # Alternative name | |
744 | ip.define_magic("history",magic_history) |
|
744 | ip.define_magic("history",magic_history) | |
745 |
|
745 | |||
746 | # XXX - ipy_completers are in quarantine, need to be updated to new apis |
|
746 | # XXX - ipy_completers are in quarantine, need to be updated to new apis | |
747 | #import ipy_completers |
|
747 | #import ipy_completers | |
748 | #ipy_completers.quick_completer('%hist' ,'-g -t -r -n') |
|
748 | #ipy_completers.quick_completer('%hist' ,'-g -t -r -n') |
@@ -1,2601 +1,2601 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Main IPython class.""" |
|
2 | """Main IPython class.""" | |
3 |
|
3 | |||
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
7 | # Copyright (C) 2008-2011 The IPython Development Team | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 |
|
12 | |||
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 |
|
16 | |||
17 | from __future__ import with_statement |
|
17 | from __future__ import with_statement | |
18 | from __future__ import absolute_import |
|
18 | from __future__ import absolute_import | |
19 |
|
19 | |||
20 | import __builtin__ |
|
20 | import __builtin__ | |
21 | import __future__ |
|
21 | import __future__ | |
22 | import abc |
|
22 | import abc | |
23 | import ast |
|
23 | import ast | |
24 | import atexit |
|
24 | import atexit | |
25 | import codeop |
|
25 | import codeop | |
26 | import inspect |
|
26 | import inspect | |
27 | import os |
|
27 | import os | |
28 | import re |
|
28 | import re | |
29 | import sys |
|
29 | import sys | |
30 | import tempfile |
|
30 | import tempfile | |
31 | import types |
|
31 | import types | |
32 | from contextlib import nested |
|
32 | from contextlib import nested | |
33 |
|
33 | |||
34 | from IPython.config.configurable import Configurable |
|
34 | from IPython.config.configurable import Configurable | |
35 | from IPython.core import debugger, oinspect |
|
35 | from IPython.core import debugger, oinspect | |
36 | from IPython.core import history as ipcorehist |
|
36 | from IPython.core import history as ipcorehist | |
37 | from IPython.core import page |
|
37 | from IPython.core import page | |
38 | from IPython.core import prefilter |
|
38 | from IPython.core import prefilter | |
39 | from IPython.core import shadowns |
|
39 | from IPython.core import shadowns | |
40 | from IPython.core import ultratb |
|
40 | from IPython.core import ultratb | |
41 | from IPython.core.alias import AliasManager |
|
41 | from IPython.core.alias import AliasManager | |
42 | from IPython.core.builtin_trap import BuiltinTrap |
|
42 | from IPython.core.builtin_trap import BuiltinTrap | |
43 | from IPython.core.compilerop import CachingCompiler |
|
43 | from IPython.core.compilerop import CachingCompiler | |
44 | from IPython.core.display_trap import DisplayTrap |
|
44 | from IPython.core.display_trap import DisplayTrap | |
45 | from IPython.core.displayhook import DisplayHook |
|
45 | from IPython.core.displayhook import DisplayHook | |
46 | from IPython.core.displaypub import DisplayPublisher |
|
46 | from IPython.core.displaypub import DisplayPublisher | |
47 | from IPython.core.error import TryNext, UsageError |
|
47 | from IPython.core.error import TryNext, UsageError | |
48 | from IPython.core.extensions import ExtensionManager |
|
48 | from IPython.core.extensions import ExtensionManager | |
49 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
49 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
50 | from IPython.core.formatters import DisplayFormatter |
|
50 | from IPython.core.formatters import DisplayFormatter | |
51 | from IPython.core.history import HistoryManager |
|
51 | from IPython.core.history import HistoryManager | |
52 | from IPython.core.inputsplitter import IPythonInputSplitter |
|
52 | from IPython.core.inputsplitter import IPythonInputSplitter | |
53 | from IPython.core.logger import Logger |
|
53 | from IPython.core.logger import Logger | |
54 | from IPython.core.macro import Macro |
|
54 | from IPython.core.macro import Macro | |
55 | from IPython.core.magic import Magic |
|
55 | from IPython.core.magic import Magic | |
56 | from IPython.core.payload import PayloadManager |
|
56 | from IPython.core.payload import PayloadManager | |
57 | from IPython.core.plugin import PluginManager |
|
57 | from IPython.core.plugin import PluginManager | |
58 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC |
|
58 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC | |
59 | from IPython.external.Itpl import ItplNS |
|
59 | from IPython.external.Itpl import ItplNS | |
60 | from IPython.utils import PyColorize |
|
60 | from IPython.utils import PyColorize | |
61 | from IPython.utils import io |
|
61 | from IPython.utils import io | |
62 | from IPython.utils.doctestreload import doctest_reload |
|
62 | from IPython.utils.doctestreload import doctest_reload | |
63 | from IPython.utils.io import ask_yes_no, rprint |
|
63 | from IPython.utils.io import ask_yes_no, rprint | |
64 | from IPython.utils.ipstruct import Struct |
|
64 | from IPython.utils.ipstruct import Struct | |
65 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError |
|
65 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError | |
66 | from IPython.utils.pickleshare import PickleShareDB |
|
66 | from IPython.utils.pickleshare import PickleShareDB | |
67 | from IPython.utils.process import system, getoutput |
|
67 | from IPython.utils.process import system, getoutput | |
68 | from IPython.utils.strdispatch import StrDispatch |
|
68 | from IPython.utils.strdispatch import StrDispatch | |
69 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
69 | from IPython.utils.syspathcontext import prepended_to_syspath | |
70 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList |
|
70 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList | |
71 | from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum, |
|
71 | from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum, | |
72 | List, Unicode, Instance, Type) |
|
72 | List, Unicode, Instance, Type) | |
73 | from IPython.utils.warn import warn, error, fatal |
|
73 | from IPython.utils.warn import warn, error, fatal | |
74 | import IPython.core.hooks |
|
74 | import IPython.core.hooks | |
75 |
|
75 | |||
76 | #----------------------------------------------------------------------------- |
|
76 | #----------------------------------------------------------------------------- | |
77 | # Globals |
|
77 | # Globals | |
78 | #----------------------------------------------------------------------------- |
|
78 | #----------------------------------------------------------------------------- | |
79 |
|
79 | |||
80 | # compiled regexps for autoindent management |
|
80 | # compiled regexps for autoindent management | |
81 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
81 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
82 |
|
82 | |||
83 | #----------------------------------------------------------------------------- |
|
83 | #----------------------------------------------------------------------------- | |
84 | # Utilities |
|
84 | # Utilities | |
85 | #----------------------------------------------------------------------------- |
|
85 | #----------------------------------------------------------------------------- | |
86 |
|
86 | |||
87 | # store the builtin raw_input globally, and use this always, in case user code |
|
87 | # store the builtin raw_input globally, and use this always, in case user code | |
88 | # overwrites it (like wx.py.PyShell does) |
|
88 | # overwrites it (like wx.py.PyShell does) | |
89 | raw_input_original = raw_input |
|
89 | raw_input_original = raw_input | |
90 |
|
90 | |||
91 | def softspace(file, newvalue): |
|
91 | def softspace(file, newvalue): | |
92 | """Copied from code.py, to remove the dependency""" |
|
92 | """Copied from code.py, to remove the dependency""" | |
93 |
|
93 | |||
94 | oldvalue = 0 |
|
94 | oldvalue = 0 | |
95 | try: |
|
95 | try: | |
96 | oldvalue = file.softspace |
|
96 | oldvalue = file.softspace | |
97 | except AttributeError: |
|
97 | except AttributeError: | |
98 | pass |
|
98 | pass | |
99 | try: |
|
99 | try: | |
100 | file.softspace = newvalue |
|
100 | file.softspace = newvalue | |
101 | except (AttributeError, TypeError): |
|
101 | except (AttributeError, TypeError): | |
102 | # "attribute-less object" or "read-only attributes" |
|
102 | # "attribute-less object" or "read-only attributes" | |
103 | pass |
|
103 | pass | |
104 | return oldvalue |
|
104 | return oldvalue | |
105 |
|
105 | |||
106 |
|
106 | |||
107 | def no_op(*a, **kw): pass |
|
107 | def no_op(*a, **kw): pass | |
108 |
|
108 | |||
109 | class SpaceInInput(Exception): pass |
|
109 | class SpaceInInput(Exception): pass | |
110 |
|
110 | |||
111 | class Bunch: pass |
|
111 | class Bunch: pass | |
112 |
|
112 | |||
113 |
|
113 | |||
114 | def get_default_colors(): |
|
114 | def get_default_colors(): | |
115 | if sys.platform=='darwin': |
|
115 | if sys.platform=='darwin': | |
116 | return "LightBG" |
|
116 | return "LightBG" | |
117 | elif os.name=='nt': |
|
117 | elif os.name=='nt': | |
118 | return 'Linux' |
|
118 | return 'Linux' | |
119 | else: |
|
119 | else: | |
120 | return 'Linux' |
|
120 | return 'Linux' | |
121 |
|
121 | |||
122 |
|
122 | |||
123 | class SeparateStr(Str): |
|
123 | class SeparateStr(Str): | |
124 | """A Str subclass to validate separate_in, separate_out, etc. |
|
124 | """A Str subclass to validate separate_in, separate_out, etc. | |
125 |
|
125 | |||
126 | This is a Str based trait that converts '0'->'' and '\\n'->'\n'. |
|
126 | This is a Str based trait that converts '0'->'' and '\\n'->'\n'. | |
127 | """ |
|
127 | """ | |
128 |
|
128 | |||
129 | def validate(self, obj, value): |
|
129 | def validate(self, obj, value): | |
130 | if value == '0': value = '' |
|
130 | if value == '0': value = '' | |
131 | value = value.replace('\\n','\n') |
|
131 | value = value.replace('\\n','\n') | |
132 | return super(SeparateStr, self).validate(obj, value) |
|
132 | return super(SeparateStr, self).validate(obj, value) | |
133 |
|
133 | |||
134 | class MultipleInstanceError(Exception): |
|
134 | class MultipleInstanceError(Exception): | |
135 | pass |
|
135 | pass | |
136 |
|
136 | |||
137 | class ReadlineNoRecord(object): |
|
137 | class ReadlineNoRecord(object): | |
138 | """Context manager to execute some code, then reload readline history |
|
138 | """Context manager to execute some code, then reload readline history | |
139 | so that interactive input to the code doesn't appear when pressing up.""" |
|
139 | so that interactive input to the code doesn't appear when pressing up.""" | |
140 | def __init__(self, shell): |
|
140 | def __init__(self, shell): | |
141 | self.shell = shell |
|
141 | self.shell = shell | |
142 | self._nested_level = 0 |
|
142 | self._nested_level = 0 | |
143 |
|
143 | |||
144 | def __enter__(self): |
|
144 | def __enter__(self): | |
145 | if self._nested_level == 0: |
|
145 | if self._nested_level == 0: | |
146 | self.orig_length = self.current_length() |
|
146 | self.orig_length = self.current_length() | |
147 | self.readline_tail = self.get_readline_tail() |
|
147 | self.readline_tail = self.get_readline_tail() | |
148 | self._nested_level += 1 |
|
148 | self._nested_level += 1 | |
149 |
|
149 | |||
150 | def __exit__(self, type, value, traceback): |
|
150 | def __exit__(self, type, value, traceback): | |
151 | self._nested_level -= 1 |
|
151 | self._nested_level -= 1 | |
152 | if self._nested_level == 0: |
|
152 | if self._nested_level == 0: | |
153 | # Try clipping the end if it's got longer |
|
153 | # Try clipping the end if it's got longer | |
154 | e = self.current_length() - self.orig_length |
|
154 | e = self.current_length() - self.orig_length | |
155 | if e > 0: |
|
155 | if e > 0: | |
156 | for _ in range(e): |
|
156 | for _ in range(e): | |
157 | self.shell.readline.remove_history_item(self.orig_length) |
|
157 | self.shell.readline.remove_history_item(self.orig_length) | |
158 |
|
158 | |||
159 | # If it still doesn't match, just reload readline history. |
|
159 | # If it still doesn't match, just reload readline history. | |
160 | if self.current_length() != self.orig_length \ |
|
160 | if self.current_length() != self.orig_length \ | |
161 | or self.get_readline_tail() != self.readline_tail: |
|
161 | or self.get_readline_tail() != self.readline_tail: | |
162 | self.shell.refill_readline_hist() |
|
162 | self.shell.refill_readline_hist() | |
163 | # Returning False will cause exceptions to propagate |
|
163 | # Returning False will cause exceptions to propagate | |
164 | return False |
|
164 | return False | |
165 |
|
165 | |||
166 | def current_length(self): |
|
166 | def current_length(self): | |
167 | return self.shell.readline.get_current_history_length() |
|
167 | return self.shell.readline.get_current_history_length() | |
168 |
|
168 | |||
169 | def get_readline_tail(self, n=10): |
|
169 | def get_readline_tail(self, n=10): | |
170 | """Get the last n items in readline history.""" |
|
170 | """Get the last n items in readline history.""" | |
171 | end = self.shell.readline.get_current_history_length() + 1 |
|
171 | end = self.shell.readline.get_current_history_length() + 1 | |
172 | start = max(end-n, 1) |
|
172 | start = max(end-n, 1) | |
173 | ghi = self.shell.readline.get_history_item |
|
173 | ghi = self.shell.readline.get_history_item | |
174 | return [ghi(x) for x in range(start, end)] |
|
174 | return [ghi(x) for x in range(start, end)] | |
175 |
|
175 | |||
176 |
|
176 | |||
177 | #----------------------------------------------------------------------------- |
|
177 | #----------------------------------------------------------------------------- | |
178 | # Main IPython class |
|
178 | # Main IPython class | |
179 | #----------------------------------------------------------------------------- |
|
179 | #----------------------------------------------------------------------------- | |
180 |
|
180 | |||
181 | class InteractiveShell(Configurable, Magic): |
|
181 | class InteractiveShell(Configurable, Magic): | |
182 | """An enhanced, interactive shell for Python.""" |
|
182 | """An enhanced, interactive shell for Python.""" | |
183 |
|
183 | |||
184 | _instance = None |
|
184 | _instance = None | |
185 | autocall = Enum((0,1,2), default_value=1, config=True) |
|
185 | autocall = Enum((0,1,2), default_value=1, config=True) | |
186 | # TODO: remove all autoindent logic and put into frontends. |
|
186 | # TODO: remove all autoindent logic and put into frontends. | |
187 | # We can't do this yet because even runlines uses the autoindent. |
|
187 | # We can't do this yet because even runlines uses the autoindent. | |
188 | autoindent = CBool(True, config=True) |
|
188 | autoindent = CBool(True, config=True) | |
189 | automagic = CBool(True, config=True) |
|
189 | automagic = CBool(True, config=True) | |
190 | cache_size = Int(1000, config=True) |
|
190 | cache_size = Int(1000, config=True) | |
191 | color_info = CBool(True, config=True) |
|
191 | color_info = CBool(True, config=True) | |
192 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
192 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
193 | default_value=get_default_colors(), config=True) |
|
193 | default_value=get_default_colors(), config=True) | |
194 | debug = CBool(False, config=True) |
|
194 | debug = CBool(False, config=True) | |
195 | deep_reload = CBool(False, config=True) |
|
195 | deep_reload = CBool(False, config=True) | |
196 | display_formatter = Instance(DisplayFormatter) |
|
196 | display_formatter = Instance(DisplayFormatter) | |
197 | displayhook_class = Type(DisplayHook) |
|
197 | displayhook_class = Type(DisplayHook) | |
198 | display_pub_class = Type(DisplayPublisher) |
|
198 | display_pub_class = Type(DisplayPublisher) | |
199 |
|
199 | |||
200 | exit_now = CBool(False) |
|
200 | exit_now = CBool(False) | |
201 | # Monotonically increasing execution counter |
|
201 | # Monotonically increasing execution counter | |
202 | execution_count = Int(1) |
|
202 | execution_count = Int(1) | |
203 | filename = Unicode("<ipython console>") |
|
203 | filename = Unicode("<ipython console>") | |
204 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
204 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
205 |
|
205 | |||
206 | # Input splitter, to split entire cells of input into either individual |
|
206 | # Input splitter, to split entire cells of input into either individual | |
207 | # interactive statements or whole blocks. |
|
207 | # interactive statements or whole blocks. | |
208 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
208 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
209 | (), {}) |
|
209 | (), {}) | |
210 | logstart = CBool(False, config=True) |
|
210 | logstart = CBool(False, config=True) | |
211 | logfile = Unicode('', config=True) |
|
211 | logfile = Unicode('', config=True) | |
212 | logappend = Unicode('', config=True) |
|
212 | logappend = Unicode('', config=True) | |
213 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
213 | object_info_string_level = Enum((0,1,2), default_value=0, | |
214 | config=True) |
|
214 | config=True) | |
215 | pdb = CBool(False, config=True) |
|
215 | pdb = CBool(False, config=True) | |
216 |
|
216 | |||
217 | profile = Unicode('', config=True) |
|
217 | profile = Unicode('', config=True) | |
218 | prompt_in1 = Str('In [\\#]: ', config=True) |
|
218 | prompt_in1 = Str('In [\\#]: ', config=True) | |
219 | prompt_in2 = Str(' .\\D.: ', config=True) |
|
219 | prompt_in2 = Str(' .\\D.: ', config=True) | |
220 | prompt_out = Str('Out[\\#]: ', config=True) |
|
220 | prompt_out = Str('Out[\\#]: ', config=True) | |
221 | prompts_pad_left = CBool(True, config=True) |
|
221 | prompts_pad_left = CBool(True, config=True) | |
222 | quiet = CBool(False, config=True) |
|
222 | quiet = CBool(False, config=True) | |
223 |
|
223 | |||
224 | history_length = Int(10000, config=True) |
|
224 | history_length = Int(10000, config=True) | |
225 |
|
225 | |||
226 | # The readline stuff will eventually be moved to the terminal subclass |
|
226 | # The readline stuff will eventually be moved to the terminal subclass | |
227 | # but for now, we can't do that as readline is welded in everywhere. |
|
227 | # but for now, we can't do that as readline is welded in everywhere. | |
228 | readline_use = CBool(True, config=True) |
|
228 | readline_use = CBool(True, config=True) | |
229 | readline_merge_completions = CBool(True, config=True) |
|
229 | readline_merge_completions = CBool(True, config=True) | |
230 | readline_omit__names = Enum((0,1,2), default_value=2, config=True) |
|
230 | readline_omit__names = Enum((0,1,2), default_value=2, config=True) | |
231 | readline_remove_delims = Str('-/~', config=True) |
|
231 | readline_remove_delims = Str('-/~', config=True) | |
232 | readline_parse_and_bind = List([ |
|
232 | readline_parse_and_bind = List([ | |
233 | 'tab: complete', |
|
233 | 'tab: complete', | |
234 | '"\C-l": clear-screen', |
|
234 | '"\C-l": clear-screen', | |
235 | 'set show-all-if-ambiguous on', |
|
235 | 'set show-all-if-ambiguous on', | |
236 | '"\C-o": tab-insert', |
|
236 | '"\C-o": tab-insert', | |
237 | # See bug gh-58 - with \M-i enabled, chars 0x9000-0x9fff |
|
237 | # See bug gh-58 - with \M-i enabled, chars 0x9000-0x9fff | |
238 | # crash IPython. |
|
238 | # crash IPython. | |
239 | '"\M-o": "\d\d\d\d"', |
|
239 | '"\M-o": "\d\d\d\d"', | |
240 | '"\M-I": "\d\d\d\d"', |
|
240 | '"\M-I": "\d\d\d\d"', | |
241 | '"\C-r": reverse-search-history', |
|
241 | '"\C-r": reverse-search-history', | |
242 | '"\C-s": forward-search-history', |
|
242 | '"\C-s": forward-search-history', | |
243 | '"\C-p": history-search-backward', |
|
243 | '"\C-p": history-search-backward', | |
244 | '"\C-n": history-search-forward', |
|
244 | '"\C-n": history-search-forward', | |
245 | '"\e[A": history-search-backward', |
|
245 | '"\e[A": history-search-backward', | |
246 | '"\e[B": history-search-forward', |
|
246 | '"\e[B": history-search-forward', | |
247 | '"\C-k": kill-line', |
|
247 | '"\C-k": kill-line', | |
248 | '"\C-u": unix-line-discard', |
|
248 | '"\C-u": unix-line-discard', | |
249 | ], allow_none=False, config=True) |
|
249 | ], allow_none=False, config=True) | |
250 |
|
250 | |||
251 | # TODO: this part of prompt management should be moved to the frontends. |
|
251 | # TODO: this part of prompt management should be moved to the frontends. | |
252 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
252 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
253 | separate_in = SeparateStr('\n', config=True) |
|
253 | separate_in = SeparateStr('\n', config=True) | |
254 | separate_out = SeparateStr('', config=True) |
|
254 | separate_out = SeparateStr('', config=True) | |
255 | separate_out2 = SeparateStr('', config=True) |
|
255 | separate_out2 = SeparateStr('', config=True) | |
256 | wildcards_case_sensitive = CBool(True, config=True) |
|
256 | wildcards_case_sensitive = CBool(True, config=True) | |
257 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
257 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
258 | default_value='Context', config=True) |
|
258 | default_value='Context', config=True) | |
259 |
|
259 | |||
260 | # Subcomponents of InteractiveShell |
|
260 | # Subcomponents of InteractiveShell | |
261 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
261 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
262 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
262 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
263 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
263 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
264 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
264 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
265 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
265 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
266 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
266 | plugin_manager = Instance('IPython.core.plugin.PluginManager') | |
267 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
267 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
268 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
268 | history_manager = Instance('IPython.core.history.HistoryManager') | |
269 |
|
269 | |||
270 | # Private interface |
|
270 | # Private interface | |
271 | _post_execute = set() |
|
271 | _post_execute = set() | |
272 |
|
272 | |||
273 | def __init__(self, config=None, ipython_dir=None, |
|
273 | def __init__(self, config=None, ipython_dir=None, | |
274 | user_ns=None, user_global_ns=None, |
|
274 | user_ns=None, user_global_ns=None, | |
275 | custom_exceptions=((), None)): |
|
275 | custom_exceptions=((), None)): | |
276 |
|
276 | |||
277 | # This is where traits with a config_key argument are updated |
|
277 | # This is where traits with a config_key argument are updated | |
278 | # from the values on config. |
|
278 | # from the values on config. | |
279 | super(InteractiveShell, self).__init__(config=config) |
|
279 | super(InteractiveShell, self).__init__(config=config) | |
280 |
|
280 | |||
281 | # These are relatively independent and stateless |
|
281 | # These are relatively independent and stateless | |
282 | self.init_ipython_dir(ipython_dir) |
|
282 | self.init_ipython_dir(ipython_dir) | |
283 | self.init_instance_attrs() |
|
283 | self.init_instance_attrs() | |
284 | self.init_environment() |
|
284 | self.init_environment() | |
285 |
|
285 | |||
286 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
286 | # Create namespaces (user_ns, user_global_ns, etc.) | |
287 | self.init_create_namespaces(user_ns, user_global_ns) |
|
287 | self.init_create_namespaces(user_ns, user_global_ns) | |
288 | # This has to be done after init_create_namespaces because it uses |
|
288 | # This has to be done after init_create_namespaces because it uses | |
289 | # something in self.user_ns, but before init_sys_modules, which |
|
289 | # something in self.user_ns, but before init_sys_modules, which | |
290 | # is the first thing to modify sys. |
|
290 | # is the first thing to modify sys. | |
291 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
291 | # TODO: When we override sys.stdout and sys.stderr before this class | |
292 | # is created, we are saving the overridden ones here. Not sure if this |
|
292 | # is created, we are saving the overridden ones here. Not sure if this | |
293 | # is what we want to do. |
|
293 | # is what we want to do. | |
294 | self.save_sys_module_state() |
|
294 | self.save_sys_module_state() | |
295 | self.init_sys_modules() |
|
295 | self.init_sys_modules() | |
296 |
|
296 | |||
297 | # While we're trying to have each part of the code directly access what |
|
297 | # While we're trying to have each part of the code directly access what | |
298 | # it needs without keeping redundant references to objects, we have too |
|
298 | # it needs without keeping redundant references to objects, we have too | |
299 | # much legacy code that expects ip.db to exist. |
|
299 | # much legacy code that expects ip.db to exist. | |
300 | self.db = PickleShareDB(os.path.join(self.ipython_dir, 'db')) |
|
300 | self.db = PickleShareDB(os.path.join(self.ipython_dir, 'db')) | |
301 |
|
301 | |||
302 | self.init_history() |
|
302 | self.init_history() | |
303 | self.init_encoding() |
|
303 | self.init_encoding() | |
304 | self.init_prefilter() |
|
304 | self.init_prefilter() | |
305 |
|
305 | |||
306 | Magic.__init__(self, self) |
|
306 | Magic.__init__(self, self) | |
307 |
|
307 | |||
308 | self.init_syntax_highlighting() |
|
308 | self.init_syntax_highlighting() | |
309 | self.init_hooks() |
|
309 | self.init_hooks() | |
310 | self.init_pushd_popd_magic() |
|
310 | self.init_pushd_popd_magic() | |
311 | # self.init_traceback_handlers use to be here, but we moved it below |
|
311 | # self.init_traceback_handlers use to be here, but we moved it below | |
312 | # because it and init_io have to come after init_readline. |
|
312 | # because it and init_io have to come after init_readline. | |
313 | self.init_user_ns() |
|
313 | self.init_user_ns() | |
314 | self.init_logger() |
|
314 | self.init_logger() | |
315 | self.init_alias() |
|
315 | self.init_alias() | |
316 | self.init_builtins() |
|
316 | self.init_builtins() | |
317 |
|
317 | |||
318 | # pre_config_initialization |
|
318 | # pre_config_initialization | |
319 |
|
319 | |||
320 | # The next section should contain everything that was in ipmaker. |
|
320 | # The next section should contain everything that was in ipmaker. | |
321 | self.init_logstart() |
|
321 | self.init_logstart() | |
322 |
|
322 | |||
323 | # The following was in post_config_initialization |
|
323 | # The following was in post_config_initialization | |
324 | self.init_inspector() |
|
324 | self.init_inspector() | |
325 | # init_readline() must come before init_io(), because init_io uses |
|
325 | # init_readline() must come before init_io(), because init_io uses | |
326 | # readline related things. |
|
326 | # readline related things. | |
327 | self.init_readline() |
|
327 | self.init_readline() | |
328 | # init_completer must come after init_readline, because it needs to |
|
328 | # init_completer must come after init_readline, because it needs to | |
329 | # know whether readline is present or not system-wide to configure the |
|
329 | # know whether readline is present or not system-wide to configure the | |
330 | # completers, since the completion machinery can now operate |
|
330 | # completers, since the completion machinery can now operate | |
331 | # independently of readline (e.g. over the network) |
|
331 | # independently of readline (e.g. over the network) | |
332 | self.init_completer() |
|
332 | self.init_completer() | |
333 | # TODO: init_io() needs to happen before init_traceback handlers |
|
333 | # TODO: init_io() needs to happen before init_traceback handlers | |
334 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
334 | # because the traceback handlers hardcode the stdout/stderr streams. | |
335 | # This logic in in debugger.Pdb and should eventually be changed. |
|
335 | # This logic in in debugger.Pdb and should eventually be changed. | |
336 | self.init_io() |
|
336 | self.init_io() | |
337 | self.init_traceback_handlers(custom_exceptions) |
|
337 | self.init_traceback_handlers(custom_exceptions) | |
338 | self.init_prompts() |
|
338 | self.init_prompts() | |
339 | self.init_display_formatter() |
|
339 | self.init_display_formatter() | |
340 | self.init_display_pub() |
|
340 | self.init_display_pub() | |
341 | self.init_displayhook() |
|
341 | self.init_displayhook() | |
342 | self.init_reload_doctest() |
|
342 | self.init_reload_doctest() | |
343 | self.init_magics() |
|
343 | self.init_magics() | |
344 | self.init_pdb() |
|
344 | self.init_pdb() | |
345 | self.init_extension_manager() |
|
345 | self.init_extension_manager() | |
346 | self.init_plugin_manager() |
|
346 | self.init_plugin_manager() | |
347 | self.init_payload() |
|
347 | self.init_payload() | |
348 | self.hooks.late_startup_hook() |
|
348 | self.hooks.late_startup_hook() | |
349 | atexit.register(self.atexit_operations) |
|
349 | atexit.register(self.atexit_operations) | |
350 |
|
350 | |||
351 | @classmethod |
|
351 | @classmethod | |
352 | def instance(cls, *args, **kwargs): |
|
352 | def instance(cls, *args, **kwargs): | |
353 | """Returns a global InteractiveShell instance.""" |
|
353 | """Returns a global InteractiveShell instance.""" | |
354 | if cls._instance is None: |
|
354 | if cls._instance is None: | |
355 | inst = cls(*args, **kwargs) |
|
355 | inst = cls(*args, **kwargs) | |
356 | # Now make sure that the instance will also be returned by |
|
356 | # Now make sure that the instance will also be returned by | |
357 | # the subclasses instance attribute. |
|
357 | # the subclasses instance attribute. | |
358 | for subclass in cls.mro(): |
|
358 | for subclass in cls.mro(): | |
359 | if issubclass(cls, subclass) and \ |
|
359 | if issubclass(cls, subclass) and \ | |
360 | issubclass(subclass, InteractiveShell): |
|
360 | issubclass(subclass, InteractiveShell): | |
361 | subclass._instance = inst |
|
361 | subclass._instance = inst | |
362 | else: |
|
362 | else: | |
363 | break |
|
363 | break | |
364 | if isinstance(cls._instance, cls): |
|
364 | if isinstance(cls._instance, cls): | |
365 | return cls._instance |
|
365 | return cls._instance | |
366 | else: |
|
366 | else: | |
367 | raise MultipleInstanceError( |
|
367 | raise MultipleInstanceError( | |
368 | 'Multiple incompatible subclass instances of ' |
|
368 | 'Multiple incompatible subclass instances of ' | |
369 | 'InteractiveShell are being created.' |
|
369 | 'InteractiveShell are being created.' | |
370 | ) |
|
370 | ) | |
371 |
|
371 | |||
372 | @classmethod |
|
372 | @classmethod | |
373 | def initialized(cls): |
|
373 | def initialized(cls): | |
374 | return hasattr(cls, "_instance") |
|
374 | return hasattr(cls, "_instance") | |
375 |
|
375 | |||
376 | def get_ipython(self): |
|
376 | def get_ipython(self): | |
377 | """Return the currently running IPython instance.""" |
|
377 | """Return the currently running IPython instance.""" | |
378 | return self |
|
378 | return self | |
379 |
|
379 | |||
380 | #------------------------------------------------------------------------- |
|
380 | #------------------------------------------------------------------------- | |
381 | # Trait changed handlers |
|
381 | # Trait changed handlers | |
382 | #------------------------------------------------------------------------- |
|
382 | #------------------------------------------------------------------------- | |
383 |
|
383 | |||
384 | def _ipython_dir_changed(self, name, new): |
|
384 | def _ipython_dir_changed(self, name, new): | |
385 | if not os.path.isdir(new): |
|
385 | if not os.path.isdir(new): | |
386 | os.makedirs(new, mode = 0777) |
|
386 | os.makedirs(new, mode = 0777) | |
387 |
|
387 | |||
388 | def set_autoindent(self,value=None): |
|
388 | def set_autoindent(self,value=None): | |
389 | """Set the autoindent flag, checking for readline support. |
|
389 | """Set the autoindent flag, checking for readline support. | |
390 |
|
390 | |||
391 | If called with no arguments, it acts as a toggle.""" |
|
391 | If called with no arguments, it acts as a toggle.""" | |
392 |
|
392 | |||
393 | if not self.has_readline: |
|
393 | if not self.has_readline: | |
394 | if os.name == 'posix': |
|
394 | if os.name == 'posix': | |
395 | warn("The auto-indent feature requires the readline library") |
|
395 | warn("The auto-indent feature requires the readline library") | |
396 | self.autoindent = 0 |
|
396 | self.autoindent = 0 | |
397 | return |
|
397 | return | |
398 | if value is None: |
|
398 | if value is None: | |
399 | self.autoindent = not self.autoindent |
|
399 | self.autoindent = not self.autoindent | |
400 | else: |
|
400 | else: | |
401 | self.autoindent = value |
|
401 | self.autoindent = value | |
402 |
|
402 | |||
403 | #------------------------------------------------------------------------- |
|
403 | #------------------------------------------------------------------------- | |
404 | # init_* methods called by __init__ |
|
404 | # init_* methods called by __init__ | |
405 | #------------------------------------------------------------------------- |
|
405 | #------------------------------------------------------------------------- | |
406 |
|
406 | |||
407 | def init_ipython_dir(self, ipython_dir): |
|
407 | def init_ipython_dir(self, ipython_dir): | |
408 | if ipython_dir is not None: |
|
408 | if ipython_dir is not None: | |
409 | self.ipython_dir = ipython_dir |
|
409 | self.ipython_dir = ipython_dir | |
410 | self.config.Global.ipython_dir = self.ipython_dir |
|
410 | self.config.Global.ipython_dir = self.ipython_dir | |
411 | return |
|
411 | return | |
412 |
|
412 | |||
413 | if hasattr(self.config.Global, 'ipython_dir'): |
|
413 | if hasattr(self.config.Global, 'ipython_dir'): | |
414 | self.ipython_dir = self.config.Global.ipython_dir |
|
414 | self.ipython_dir = self.config.Global.ipython_dir | |
415 | else: |
|
415 | else: | |
416 | self.ipython_dir = get_ipython_dir() |
|
416 | self.ipython_dir = get_ipython_dir() | |
417 |
|
417 | |||
418 | # All children can just read this |
|
418 | # All children can just read this | |
419 | self.config.Global.ipython_dir = self.ipython_dir |
|
419 | self.config.Global.ipython_dir = self.ipython_dir | |
420 |
|
420 | |||
421 | def init_instance_attrs(self): |
|
421 | def init_instance_attrs(self): | |
422 | self.more = False |
|
422 | self.more = False | |
423 |
|
423 | |||
424 | # command compiler |
|
424 | # command compiler | |
425 | self.compile = CachingCompiler() |
|
425 | self.compile = CachingCompiler() | |
426 |
|
426 | |||
427 | # User input buffers |
|
427 | # User input buffers | |
428 | # NOTE: these variables are slated for full removal, once we are 100% |
|
428 | # NOTE: these variables are slated for full removal, once we are 100% | |
429 | # sure that the new execution logic is solid. We will delte runlines, |
|
429 | # sure that the new execution logic is solid. We will delte runlines, | |
430 | # push_line and these buffers, as all input will be managed by the |
|
430 | # push_line and these buffers, as all input will be managed by the | |
431 | # frontends via an inputsplitter instance. |
|
431 | # frontends via an inputsplitter instance. | |
432 | self.buffer = [] |
|
432 | self.buffer = [] | |
433 | self.buffer_raw = [] |
|
433 | self.buffer_raw = [] | |
434 |
|
434 | |||
435 | # Make an empty namespace, which extension writers can rely on both |
|
435 | # Make an empty namespace, which extension writers can rely on both | |
436 | # existing and NEVER being used by ipython itself. This gives them a |
|
436 | # existing and NEVER being used by ipython itself. This gives them a | |
437 | # convenient location for storing additional information and state |
|
437 | # convenient location for storing additional information and state | |
438 | # their extensions may require, without fear of collisions with other |
|
438 | # their extensions may require, without fear of collisions with other | |
439 | # ipython names that may develop later. |
|
439 | # ipython names that may develop later. | |
440 | self.meta = Struct() |
|
440 | self.meta = Struct() | |
441 |
|
441 | |||
442 | # Object variable to store code object waiting execution. This is |
|
442 | # Object variable to store code object waiting execution. This is | |
443 | # used mainly by the multithreaded shells, but it can come in handy in |
|
443 | # used mainly by the multithreaded shells, but it can come in handy in | |
444 | # other situations. No need to use a Queue here, since it's a single |
|
444 | # other situations. No need to use a Queue here, since it's a single | |
445 | # item which gets cleared once run. |
|
445 | # item which gets cleared once run. | |
446 | self.code_to_run = None |
|
446 | self.code_to_run = None | |
447 |
|
447 | |||
448 | # Temporary files used for various purposes. Deleted at exit. |
|
448 | # Temporary files used for various purposes. Deleted at exit. | |
449 | self.tempfiles = [] |
|
449 | self.tempfiles = [] | |
450 |
|
450 | |||
451 | # Keep track of readline usage (later set by init_readline) |
|
451 | # Keep track of readline usage (later set by init_readline) | |
452 | self.has_readline = False |
|
452 | self.has_readline = False | |
453 |
|
453 | |||
454 | # keep track of where we started running (mainly for crash post-mortem) |
|
454 | # keep track of where we started running (mainly for crash post-mortem) | |
455 | # This is not being used anywhere currently. |
|
455 | # This is not being used anywhere currently. | |
456 | self.starting_dir = os.getcwd() |
|
456 | self.starting_dir = os.getcwd() | |
457 |
|
457 | |||
458 | # Indentation management |
|
458 | # Indentation management | |
459 | self.indent_current_nsp = 0 |
|
459 | self.indent_current_nsp = 0 | |
460 |
|
460 | |||
461 | def init_environment(self): |
|
461 | def init_environment(self): | |
462 | """Any changes we need to make to the user's environment.""" |
|
462 | """Any changes we need to make to the user's environment.""" | |
463 | pass |
|
463 | pass | |
464 |
|
464 | |||
465 | def init_encoding(self): |
|
465 | def init_encoding(self): | |
466 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
466 | # Get system encoding at startup time. Certain terminals (like Emacs | |
467 | # under Win32 have it set to None, and we need to have a known valid |
|
467 | # under Win32 have it set to None, and we need to have a known valid | |
468 | # encoding to use in the raw_input() method |
|
468 | # encoding to use in the raw_input() method | |
469 | try: |
|
469 | try: | |
470 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
470 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
471 | except AttributeError: |
|
471 | except AttributeError: | |
472 | self.stdin_encoding = 'ascii' |
|
472 | self.stdin_encoding = 'ascii' | |
473 |
|
473 | |||
474 | def init_syntax_highlighting(self): |
|
474 | def init_syntax_highlighting(self): | |
475 | # Python source parser/formatter for syntax highlighting |
|
475 | # Python source parser/formatter for syntax highlighting | |
476 | pyformat = PyColorize.Parser().format |
|
476 | pyformat = PyColorize.Parser().format | |
477 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
477 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
478 |
|
478 | |||
479 | def init_pushd_popd_magic(self): |
|
479 | def init_pushd_popd_magic(self): | |
480 | # for pushd/popd management |
|
480 | # for pushd/popd management | |
481 | try: |
|
481 | try: | |
482 | self.home_dir = get_home_dir() |
|
482 | self.home_dir = get_home_dir() | |
483 | except HomeDirError, msg: |
|
483 | except HomeDirError, msg: | |
484 | fatal(msg) |
|
484 | fatal(msg) | |
485 |
|
485 | |||
486 | self.dir_stack = [] |
|
486 | self.dir_stack = [] | |
487 |
|
487 | |||
488 | def init_logger(self): |
|
488 | def init_logger(self): | |
489 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
489 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
490 | logmode='rotate') |
|
490 | logmode='rotate') | |
491 |
|
491 | |||
492 | def init_logstart(self): |
|
492 | def init_logstart(self): | |
493 | """Initialize logging in case it was requested at the command line. |
|
493 | """Initialize logging in case it was requested at the command line. | |
494 | """ |
|
494 | """ | |
495 | if self.logappend: |
|
495 | if self.logappend: | |
496 | self.magic_logstart(self.logappend + ' append') |
|
496 | self.magic_logstart(self.logappend + ' append') | |
497 | elif self.logfile: |
|
497 | elif self.logfile: | |
498 | self.magic_logstart(self.logfile) |
|
498 | self.magic_logstart(self.logfile) | |
499 | elif self.logstart: |
|
499 | elif self.logstart: | |
500 | self.magic_logstart() |
|
500 | self.magic_logstart() | |
501 |
|
501 | |||
502 | def init_builtins(self): |
|
502 | def init_builtins(self): | |
503 | self.builtin_trap = BuiltinTrap(shell=self) |
|
503 | self.builtin_trap = BuiltinTrap(shell=self) | |
504 |
|
504 | |||
505 | def init_inspector(self): |
|
505 | def init_inspector(self): | |
506 | # Object inspector |
|
506 | # Object inspector | |
507 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
507 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
508 | PyColorize.ANSICodeColors, |
|
508 | PyColorize.ANSICodeColors, | |
509 | 'NoColor', |
|
509 | 'NoColor', | |
510 | self.object_info_string_level) |
|
510 | self.object_info_string_level) | |
511 |
|
511 | |||
512 | def init_io(self): |
|
512 | def init_io(self): | |
513 | # This will just use sys.stdout and sys.stderr. If you want to |
|
513 | # This will just use sys.stdout and sys.stderr. If you want to | |
514 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
514 | # override sys.stdout and sys.stderr themselves, you need to do that | |
515 | # *before* instantiating this class, because Term holds onto |
|
515 | # *before* instantiating this class, because Term holds onto | |
516 | # references to the underlying streams. |
|
516 | # references to the underlying streams. | |
517 | if sys.platform == 'win32' and self.has_readline: |
|
517 | if sys.platform == 'win32' and self.has_readline: | |
518 | Term = io.IOTerm(cout=self.readline._outputfile, |
|
518 | Term = io.IOTerm(cout=self.readline._outputfile, | |
519 | cerr=self.readline._outputfile) |
|
519 | cerr=self.readline._outputfile) | |
520 | else: |
|
520 | else: | |
521 | Term = io.IOTerm() |
|
521 | Term = io.IOTerm() | |
522 | io.Term = Term |
|
522 | io.Term = Term | |
523 |
|
523 | |||
524 | def init_prompts(self): |
|
524 | def init_prompts(self): | |
525 | # TODO: This is a pass for now because the prompts are managed inside |
|
525 | # TODO: This is a pass for now because the prompts are managed inside | |
526 | # the DisplayHook. Once there is a separate prompt manager, this |
|
526 | # the DisplayHook. Once there is a separate prompt manager, this | |
527 | # will initialize that object and all prompt related information. |
|
527 | # will initialize that object and all prompt related information. | |
528 | pass |
|
528 | pass | |
529 |
|
529 | |||
530 | def init_display_formatter(self): |
|
530 | def init_display_formatter(self): | |
531 | self.display_formatter = DisplayFormatter(config=self.config) |
|
531 | self.display_formatter = DisplayFormatter(config=self.config) | |
532 |
|
532 | |||
533 | def init_display_pub(self): |
|
533 | def init_display_pub(self): | |
534 | self.display_pub = self.display_pub_class(config=self.config) |
|
534 | self.display_pub = self.display_pub_class(config=self.config) | |
535 |
|
535 | |||
536 | def init_displayhook(self): |
|
536 | def init_displayhook(self): | |
537 | # Initialize displayhook, set in/out prompts and printing system |
|
537 | # Initialize displayhook, set in/out prompts and printing system | |
538 | self.displayhook = self.displayhook_class( |
|
538 | self.displayhook = self.displayhook_class( | |
539 | config=self.config, |
|
539 | config=self.config, | |
540 | shell=self, |
|
540 | shell=self, | |
541 | cache_size=self.cache_size, |
|
541 | cache_size=self.cache_size, | |
542 | input_sep = self.separate_in, |
|
542 | input_sep = self.separate_in, | |
543 | output_sep = self.separate_out, |
|
543 | output_sep = self.separate_out, | |
544 | output_sep2 = self.separate_out2, |
|
544 | output_sep2 = self.separate_out2, | |
545 | ps1 = self.prompt_in1, |
|
545 | ps1 = self.prompt_in1, | |
546 | ps2 = self.prompt_in2, |
|
546 | ps2 = self.prompt_in2, | |
547 | ps_out = self.prompt_out, |
|
547 | ps_out = self.prompt_out, | |
548 | pad_left = self.prompts_pad_left |
|
548 | pad_left = self.prompts_pad_left | |
549 | ) |
|
549 | ) | |
550 | # This is a context manager that installs/revmoes the displayhook at |
|
550 | # This is a context manager that installs/revmoes the displayhook at | |
551 | # the appropriate time. |
|
551 | # the appropriate time. | |
552 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
552 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
553 |
|
553 | |||
554 | def init_reload_doctest(self): |
|
554 | def init_reload_doctest(self): | |
555 | # Do a proper resetting of doctest, including the necessary displayhook |
|
555 | # Do a proper resetting of doctest, including the necessary displayhook | |
556 | # monkeypatching |
|
556 | # monkeypatching | |
557 | try: |
|
557 | try: | |
558 | doctest_reload() |
|
558 | doctest_reload() | |
559 | except ImportError: |
|
559 | except ImportError: | |
560 | warn("doctest module does not exist.") |
|
560 | warn("doctest module does not exist.") | |
561 |
|
561 | |||
562 | #------------------------------------------------------------------------- |
|
562 | #------------------------------------------------------------------------- | |
563 | # Things related to injections into the sys module |
|
563 | # Things related to injections into the sys module | |
564 | #------------------------------------------------------------------------- |
|
564 | #------------------------------------------------------------------------- | |
565 |
|
565 | |||
566 | def save_sys_module_state(self): |
|
566 | def save_sys_module_state(self): | |
567 | """Save the state of hooks in the sys module. |
|
567 | """Save the state of hooks in the sys module. | |
568 |
|
568 | |||
569 | This has to be called after self.user_ns is created. |
|
569 | This has to be called after self.user_ns is created. | |
570 | """ |
|
570 | """ | |
571 | self._orig_sys_module_state = {} |
|
571 | self._orig_sys_module_state = {} | |
572 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
572 | self._orig_sys_module_state['stdin'] = sys.stdin | |
573 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
573 | self._orig_sys_module_state['stdout'] = sys.stdout | |
574 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
574 | self._orig_sys_module_state['stderr'] = sys.stderr | |
575 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
575 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
576 | try: |
|
576 | try: | |
577 | self._orig_sys_modules_main_name = self.user_ns['__name__'] |
|
577 | self._orig_sys_modules_main_name = self.user_ns['__name__'] | |
578 | except KeyError: |
|
578 | except KeyError: | |
579 | pass |
|
579 | pass | |
580 |
|
580 | |||
581 | def restore_sys_module_state(self): |
|
581 | def restore_sys_module_state(self): | |
582 | """Restore the state of the sys module.""" |
|
582 | """Restore the state of the sys module.""" | |
583 | try: |
|
583 | try: | |
584 | for k, v in self._orig_sys_module_state.iteritems(): |
|
584 | for k, v in self._orig_sys_module_state.iteritems(): | |
585 | setattr(sys, k, v) |
|
585 | setattr(sys, k, v) | |
586 | except AttributeError: |
|
586 | except AttributeError: | |
587 | pass |
|
587 | pass | |
588 | # Reset what what done in self.init_sys_modules |
|
588 | # Reset what what done in self.init_sys_modules | |
589 | try: |
|
589 | try: | |
590 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name |
|
590 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name | |
591 | except (AttributeError, KeyError): |
|
591 | except (AttributeError, KeyError): | |
592 | pass |
|
592 | pass | |
593 |
|
593 | |||
594 | #------------------------------------------------------------------------- |
|
594 | #------------------------------------------------------------------------- | |
595 | # Things related to hooks |
|
595 | # Things related to hooks | |
596 | #------------------------------------------------------------------------- |
|
596 | #------------------------------------------------------------------------- | |
597 |
|
597 | |||
598 | def init_hooks(self): |
|
598 | def init_hooks(self): | |
599 | # hooks holds pointers used for user-side customizations |
|
599 | # hooks holds pointers used for user-side customizations | |
600 | self.hooks = Struct() |
|
600 | self.hooks = Struct() | |
601 |
|
601 | |||
602 | self.strdispatchers = {} |
|
602 | self.strdispatchers = {} | |
603 |
|
603 | |||
604 | # Set all default hooks, defined in the IPython.hooks module. |
|
604 | # Set all default hooks, defined in the IPython.hooks module. | |
605 | hooks = IPython.core.hooks |
|
605 | hooks = IPython.core.hooks | |
606 | for hook_name in hooks.__all__: |
|
606 | for hook_name in hooks.__all__: | |
607 | # default hooks have priority 100, i.e. low; user hooks should have |
|
607 | # default hooks have priority 100, i.e. low; user hooks should have | |
608 | # 0-100 priority |
|
608 | # 0-100 priority | |
609 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
609 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
610 |
|
610 | |||
611 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
611 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
612 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
612 | """set_hook(name,hook) -> sets an internal IPython hook. | |
613 |
|
613 | |||
614 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
614 | IPython exposes some of its internal API as user-modifiable hooks. By | |
615 | adding your function to one of these hooks, you can modify IPython's |
|
615 | adding your function to one of these hooks, you can modify IPython's | |
616 | behavior to call at runtime your own routines.""" |
|
616 | behavior to call at runtime your own routines.""" | |
617 |
|
617 | |||
618 | # At some point in the future, this should validate the hook before it |
|
618 | # At some point in the future, this should validate the hook before it | |
619 | # accepts it. Probably at least check that the hook takes the number |
|
619 | # accepts it. Probably at least check that the hook takes the number | |
620 | # of args it's supposed to. |
|
620 | # of args it's supposed to. | |
621 |
|
621 | |||
622 | f = types.MethodType(hook,self) |
|
622 | f = types.MethodType(hook,self) | |
623 |
|
623 | |||
624 | # check if the hook is for strdispatcher first |
|
624 | # check if the hook is for strdispatcher first | |
625 | if str_key is not None: |
|
625 | if str_key is not None: | |
626 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
626 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
627 | sdp.add_s(str_key, f, priority ) |
|
627 | sdp.add_s(str_key, f, priority ) | |
628 | self.strdispatchers[name] = sdp |
|
628 | self.strdispatchers[name] = sdp | |
629 | return |
|
629 | return | |
630 | if re_key is not None: |
|
630 | if re_key is not None: | |
631 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
631 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
632 | sdp.add_re(re.compile(re_key), f, priority ) |
|
632 | sdp.add_re(re.compile(re_key), f, priority ) | |
633 | self.strdispatchers[name] = sdp |
|
633 | self.strdispatchers[name] = sdp | |
634 | return |
|
634 | return | |
635 |
|
635 | |||
636 | dp = getattr(self.hooks, name, None) |
|
636 | dp = getattr(self.hooks, name, None) | |
637 | if name not in IPython.core.hooks.__all__: |
|
637 | if name not in IPython.core.hooks.__all__: | |
638 | print "Warning! Hook '%s' is not one of %s" % \ |
|
638 | print "Warning! Hook '%s' is not one of %s" % \ | |
639 | (name, IPython.core.hooks.__all__ ) |
|
639 | (name, IPython.core.hooks.__all__ ) | |
640 | if not dp: |
|
640 | if not dp: | |
641 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
641 | dp = IPython.core.hooks.CommandChainDispatcher() | |
642 |
|
642 | |||
643 | try: |
|
643 | try: | |
644 | dp.add(f,priority) |
|
644 | dp.add(f,priority) | |
645 | except AttributeError: |
|
645 | except AttributeError: | |
646 | # it was not commandchain, plain old func - replace |
|
646 | # it was not commandchain, plain old func - replace | |
647 | dp = f |
|
647 | dp = f | |
648 |
|
648 | |||
649 | setattr(self.hooks,name, dp) |
|
649 | setattr(self.hooks,name, dp) | |
650 |
|
650 | |||
651 | def register_post_execute(self, func): |
|
651 | def register_post_execute(self, func): | |
652 | """Register a function for calling after code execution. |
|
652 | """Register a function for calling after code execution. | |
653 | """ |
|
653 | """ | |
654 | if not callable(func): |
|
654 | if not callable(func): | |
655 | raise ValueError('argument %s must be callable' % func) |
|
655 | raise ValueError('argument %s must be callable' % func) | |
656 | self._post_execute.add(func) |
|
656 | self._post_execute.add(func) | |
657 |
|
657 | |||
658 | #------------------------------------------------------------------------- |
|
658 | #------------------------------------------------------------------------- | |
659 | # Things related to the "main" module |
|
659 | # Things related to the "main" module | |
660 | #------------------------------------------------------------------------- |
|
660 | #------------------------------------------------------------------------- | |
661 |
|
661 | |||
662 | def new_main_mod(self,ns=None): |
|
662 | def new_main_mod(self,ns=None): | |
663 | """Return a new 'main' module object for user code execution. |
|
663 | """Return a new 'main' module object for user code execution. | |
664 | """ |
|
664 | """ | |
665 | main_mod = self._user_main_module |
|
665 | main_mod = self._user_main_module | |
666 | init_fakemod_dict(main_mod,ns) |
|
666 | init_fakemod_dict(main_mod,ns) | |
667 | return main_mod |
|
667 | return main_mod | |
668 |
|
668 | |||
669 | def cache_main_mod(self,ns,fname): |
|
669 | def cache_main_mod(self,ns,fname): | |
670 | """Cache a main module's namespace. |
|
670 | """Cache a main module's namespace. | |
671 |
|
671 | |||
672 | When scripts are executed via %run, we must keep a reference to the |
|
672 | When scripts are executed via %run, we must keep a reference to the | |
673 | namespace of their __main__ module (a FakeModule instance) around so |
|
673 | namespace of their __main__ module (a FakeModule instance) around so | |
674 | that Python doesn't clear it, rendering objects defined therein |
|
674 | that Python doesn't clear it, rendering objects defined therein | |
675 | useless. |
|
675 | useless. | |
676 |
|
676 | |||
677 | This method keeps said reference in a private dict, keyed by the |
|
677 | This method keeps said reference in a private dict, keyed by the | |
678 | absolute path of the module object (which corresponds to the script |
|
678 | absolute path of the module object (which corresponds to the script | |
679 | path). This way, for multiple executions of the same script we only |
|
679 | path). This way, for multiple executions of the same script we only | |
680 | keep one copy of the namespace (the last one), thus preventing memory |
|
680 | keep one copy of the namespace (the last one), thus preventing memory | |
681 | leaks from old references while allowing the objects from the last |
|
681 | leaks from old references while allowing the objects from the last | |
682 | execution to be accessible. |
|
682 | execution to be accessible. | |
683 |
|
683 | |||
684 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
684 | Note: we can not allow the actual FakeModule instances to be deleted, | |
685 | because of how Python tears down modules (it hard-sets all their |
|
685 | because of how Python tears down modules (it hard-sets all their | |
686 | references to None without regard for reference counts). This method |
|
686 | references to None without regard for reference counts). This method | |
687 | must therefore make a *copy* of the given namespace, to allow the |
|
687 | must therefore make a *copy* of the given namespace, to allow the | |
688 | original module's __dict__ to be cleared and reused. |
|
688 | original module's __dict__ to be cleared and reused. | |
689 |
|
689 | |||
690 |
|
690 | |||
691 | Parameters |
|
691 | Parameters | |
692 | ---------- |
|
692 | ---------- | |
693 | ns : a namespace (a dict, typically) |
|
693 | ns : a namespace (a dict, typically) | |
694 |
|
694 | |||
695 | fname : str |
|
695 | fname : str | |
696 | Filename associated with the namespace. |
|
696 | Filename associated with the namespace. | |
697 |
|
697 | |||
698 | Examples |
|
698 | Examples | |
699 | -------- |
|
699 | -------- | |
700 |
|
700 | |||
701 | In [10]: import IPython |
|
701 | In [10]: import IPython | |
702 |
|
702 | |||
703 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
703 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
704 |
|
704 | |||
705 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
705 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
706 | Out[12]: True |
|
706 | Out[12]: True | |
707 | """ |
|
707 | """ | |
708 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
708 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
709 |
|
709 | |||
710 | def clear_main_mod_cache(self): |
|
710 | def clear_main_mod_cache(self): | |
711 | """Clear the cache of main modules. |
|
711 | """Clear the cache of main modules. | |
712 |
|
712 | |||
713 | Mainly for use by utilities like %reset. |
|
713 | Mainly for use by utilities like %reset. | |
714 |
|
714 | |||
715 | Examples |
|
715 | Examples | |
716 | -------- |
|
716 | -------- | |
717 |
|
717 | |||
718 | In [15]: import IPython |
|
718 | In [15]: import IPython | |
719 |
|
719 | |||
720 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
720 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
721 |
|
721 | |||
722 | In [17]: len(_ip._main_ns_cache) > 0 |
|
722 | In [17]: len(_ip._main_ns_cache) > 0 | |
723 | Out[17]: True |
|
723 | Out[17]: True | |
724 |
|
724 | |||
725 | In [18]: _ip.clear_main_mod_cache() |
|
725 | In [18]: _ip.clear_main_mod_cache() | |
726 |
|
726 | |||
727 | In [19]: len(_ip._main_ns_cache) == 0 |
|
727 | In [19]: len(_ip._main_ns_cache) == 0 | |
728 | Out[19]: True |
|
728 | Out[19]: True | |
729 | """ |
|
729 | """ | |
730 | self._main_ns_cache.clear() |
|
730 | self._main_ns_cache.clear() | |
731 |
|
731 | |||
732 | #------------------------------------------------------------------------- |
|
732 | #------------------------------------------------------------------------- | |
733 | # Things related to debugging |
|
733 | # Things related to debugging | |
734 | #------------------------------------------------------------------------- |
|
734 | #------------------------------------------------------------------------- | |
735 |
|
735 | |||
736 | def init_pdb(self): |
|
736 | def init_pdb(self): | |
737 | # Set calling of pdb on exceptions |
|
737 | # Set calling of pdb on exceptions | |
738 | # self.call_pdb is a property |
|
738 | # self.call_pdb is a property | |
739 | self.call_pdb = self.pdb |
|
739 | self.call_pdb = self.pdb | |
740 |
|
740 | |||
741 | def _get_call_pdb(self): |
|
741 | def _get_call_pdb(self): | |
742 | return self._call_pdb |
|
742 | return self._call_pdb | |
743 |
|
743 | |||
744 | def _set_call_pdb(self,val): |
|
744 | def _set_call_pdb(self,val): | |
745 |
|
745 | |||
746 | if val not in (0,1,False,True): |
|
746 | if val not in (0,1,False,True): | |
747 | raise ValueError,'new call_pdb value must be boolean' |
|
747 | raise ValueError,'new call_pdb value must be boolean' | |
748 |
|
748 | |||
749 | # store value in instance |
|
749 | # store value in instance | |
750 | self._call_pdb = val |
|
750 | self._call_pdb = val | |
751 |
|
751 | |||
752 | # notify the actual exception handlers |
|
752 | # notify the actual exception handlers | |
753 | self.InteractiveTB.call_pdb = val |
|
753 | self.InteractiveTB.call_pdb = val | |
754 |
|
754 | |||
755 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
755 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
756 | 'Control auto-activation of pdb at exceptions') |
|
756 | 'Control auto-activation of pdb at exceptions') | |
757 |
|
757 | |||
758 | def debugger(self,force=False): |
|
758 | def debugger(self,force=False): | |
759 | """Call the pydb/pdb debugger. |
|
759 | """Call the pydb/pdb debugger. | |
760 |
|
760 | |||
761 | Keywords: |
|
761 | Keywords: | |
762 |
|
762 | |||
763 | - force(False): by default, this routine checks the instance call_pdb |
|
763 | - force(False): by default, this routine checks the instance call_pdb | |
764 | flag and does not actually invoke the debugger if the flag is false. |
|
764 | flag and does not actually invoke the debugger if the flag is false. | |
765 | The 'force' option forces the debugger to activate even if the flag |
|
765 | The 'force' option forces the debugger to activate even if the flag | |
766 | is false. |
|
766 | is false. | |
767 | """ |
|
767 | """ | |
768 |
|
768 | |||
769 | if not (force or self.call_pdb): |
|
769 | if not (force or self.call_pdb): | |
770 | return |
|
770 | return | |
771 |
|
771 | |||
772 | if not hasattr(sys,'last_traceback'): |
|
772 | if not hasattr(sys,'last_traceback'): | |
773 | error('No traceback has been produced, nothing to debug.') |
|
773 | error('No traceback has been produced, nothing to debug.') | |
774 | return |
|
774 | return | |
775 |
|
775 | |||
776 | # use pydb if available |
|
776 | # use pydb if available | |
777 | if debugger.has_pydb: |
|
777 | if debugger.has_pydb: | |
778 | from pydb import pm |
|
778 | from pydb import pm | |
779 | else: |
|
779 | else: | |
780 | # fallback to our internal debugger |
|
780 | # fallback to our internal debugger | |
781 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
781 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
782 |
|
782 | |||
783 | with self.readline_no_record: |
|
783 | with self.readline_no_record: | |
784 | pm() |
|
784 | pm() | |
785 |
|
785 | |||
786 | #------------------------------------------------------------------------- |
|
786 | #------------------------------------------------------------------------- | |
787 | # Things related to IPython's various namespaces |
|
787 | # Things related to IPython's various namespaces | |
788 | #------------------------------------------------------------------------- |
|
788 | #------------------------------------------------------------------------- | |
789 |
|
789 | |||
790 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): |
|
790 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): | |
791 | # Create the namespace where the user will operate. user_ns is |
|
791 | # Create the namespace where the user will operate. user_ns is | |
792 | # normally the only one used, and it is passed to the exec calls as |
|
792 | # normally the only one used, and it is passed to the exec calls as | |
793 | # the locals argument. But we do carry a user_global_ns namespace |
|
793 | # the locals argument. But we do carry a user_global_ns namespace | |
794 | # given as the exec 'globals' argument, This is useful in embedding |
|
794 | # given as the exec 'globals' argument, This is useful in embedding | |
795 | # situations where the ipython shell opens in a context where the |
|
795 | # situations where the ipython shell opens in a context where the | |
796 | # distinction between locals and globals is meaningful. For |
|
796 | # distinction between locals and globals is meaningful. For | |
797 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
797 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
798 |
|
798 | |||
799 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
799 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
800 | # level as a dict instead of a module. This is a manual fix, but I |
|
800 | # level as a dict instead of a module. This is a manual fix, but I | |
801 | # should really track down where the problem is coming from. Alex |
|
801 | # should really track down where the problem is coming from. Alex | |
802 | # Schmolck reported this problem first. |
|
802 | # Schmolck reported this problem first. | |
803 |
|
803 | |||
804 | # A useful post by Alex Martelli on this topic: |
|
804 | # A useful post by Alex Martelli on this topic: | |
805 | # Re: inconsistent value from __builtins__ |
|
805 | # Re: inconsistent value from __builtins__ | |
806 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
806 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
807 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
807 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
808 | # Gruppen: comp.lang.python |
|
808 | # Gruppen: comp.lang.python | |
809 |
|
809 | |||
810 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
810 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
811 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
811 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
812 | # > <type 'dict'> |
|
812 | # > <type 'dict'> | |
813 | # > >>> print type(__builtins__) |
|
813 | # > >>> print type(__builtins__) | |
814 | # > <type 'module'> |
|
814 | # > <type 'module'> | |
815 | # > Is this difference in return value intentional? |
|
815 | # > Is this difference in return value intentional? | |
816 |
|
816 | |||
817 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
817 | # Well, it's documented that '__builtins__' can be either a dictionary | |
818 | # or a module, and it's been that way for a long time. Whether it's |
|
818 | # or a module, and it's been that way for a long time. Whether it's | |
819 | # intentional (or sensible), I don't know. In any case, the idea is |
|
819 | # intentional (or sensible), I don't know. In any case, the idea is | |
820 | # that if you need to access the built-in namespace directly, you |
|
820 | # that if you need to access the built-in namespace directly, you | |
821 | # should start with "import __builtin__" (note, no 's') which will |
|
821 | # should start with "import __builtin__" (note, no 's') which will | |
822 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
822 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
823 |
|
823 | |||
824 | # These routines return properly built dicts as needed by the rest of |
|
824 | # These routines return properly built dicts as needed by the rest of | |
825 | # the code, and can also be used by extension writers to generate |
|
825 | # the code, and can also be used by extension writers to generate | |
826 | # properly initialized namespaces. |
|
826 | # properly initialized namespaces. | |
827 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, |
|
827 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, | |
828 | user_global_ns) |
|
828 | user_global_ns) | |
829 |
|
829 | |||
830 | # Assign namespaces |
|
830 | # Assign namespaces | |
831 | # This is the namespace where all normal user variables live |
|
831 | # This is the namespace where all normal user variables live | |
832 | self.user_ns = user_ns |
|
832 | self.user_ns = user_ns | |
833 | self.user_global_ns = user_global_ns |
|
833 | self.user_global_ns = user_global_ns | |
834 |
|
834 | |||
835 | # An auxiliary namespace that checks what parts of the user_ns were |
|
835 | # An auxiliary namespace that checks what parts of the user_ns were | |
836 | # loaded at startup, so we can list later only variables defined in |
|
836 | # loaded at startup, so we can list later only variables defined in | |
837 | # actual interactive use. Since it is always a subset of user_ns, it |
|
837 | # actual interactive use. Since it is always a subset of user_ns, it | |
838 | # doesn't need to be separately tracked in the ns_table. |
|
838 | # doesn't need to be separately tracked in the ns_table. | |
839 | self.user_ns_hidden = {} |
|
839 | self.user_ns_hidden = {} | |
840 |
|
840 | |||
841 | # A namespace to keep track of internal data structures to prevent |
|
841 | # A namespace to keep track of internal data structures to prevent | |
842 | # them from cluttering user-visible stuff. Will be updated later |
|
842 | # them from cluttering user-visible stuff. Will be updated later | |
843 | self.internal_ns = {} |
|
843 | self.internal_ns = {} | |
844 |
|
844 | |||
845 | # Now that FakeModule produces a real module, we've run into a nasty |
|
845 | # Now that FakeModule produces a real module, we've run into a nasty | |
846 | # problem: after script execution (via %run), the module where the user |
|
846 | # problem: after script execution (via %run), the module where the user | |
847 | # code ran is deleted. Now that this object is a true module (needed |
|
847 | # code ran is deleted. Now that this object is a true module (needed | |
848 | # so docetst and other tools work correctly), the Python module |
|
848 | # so docetst and other tools work correctly), the Python module | |
849 | # teardown mechanism runs over it, and sets to None every variable |
|
849 | # teardown mechanism runs over it, and sets to None every variable | |
850 | # present in that module. Top-level references to objects from the |
|
850 | # present in that module. Top-level references to objects from the | |
851 | # script survive, because the user_ns is updated with them. However, |
|
851 | # script survive, because the user_ns is updated with them. However, | |
852 | # calling functions defined in the script that use other things from |
|
852 | # calling functions defined in the script that use other things from | |
853 | # the script will fail, because the function's closure had references |
|
853 | # the script will fail, because the function's closure had references | |
854 | # to the original objects, which are now all None. So we must protect |
|
854 | # to the original objects, which are now all None. So we must protect | |
855 | # these modules from deletion by keeping a cache. |
|
855 | # these modules from deletion by keeping a cache. | |
856 | # |
|
856 | # | |
857 | # To avoid keeping stale modules around (we only need the one from the |
|
857 | # To avoid keeping stale modules around (we only need the one from the | |
858 | # last run), we use a dict keyed with the full path to the script, so |
|
858 | # last run), we use a dict keyed with the full path to the script, so | |
859 | # only the last version of the module is held in the cache. Note, |
|
859 | # only the last version of the module is held in the cache. Note, | |
860 | # however, that we must cache the module *namespace contents* (their |
|
860 | # however, that we must cache the module *namespace contents* (their | |
861 | # __dict__). Because if we try to cache the actual modules, old ones |
|
861 | # __dict__). Because if we try to cache the actual modules, old ones | |
862 | # (uncached) could be destroyed while still holding references (such as |
|
862 | # (uncached) could be destroyed while still holding references (such as | |
863 | # those held by GUI objects that tend to be long-lived)> |
|
863 | # those held by GUI objects that tend to be long-lived)> | |
864 | # |
|
864 | # | |
865 | # The %reset command will flush this cache. See the cache_main_mod() |
|
865 | # The %reset command will flush this cache. See the cache_main_mod() | |
866 | # and clear_main_mod_cache() methods for details on use. |
|
866 | # and clear_main_mod_cache() methods for details on use. | |
867 |
|
867 | |||
868 | # This is the cache used for 'main' namespaces |
|
868 | # This is the cache used for 'main' namespaces | |
869 | self._main_ns_cache = {} |
|
869 | self._main_ns_cache = {} | |
870 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
870 | # And this is the single instance of FakeModule whose __dict__ we keep | |
871 | # copying and clearing for reuse on each %run |
|
871 | # copying and clearing for reuse on each %run | |
872 | self._user_main_module = FakeModule() |
|
872 | self._user_main_module = FakeModule() | |
873 |
|
873 | |||
874 | # A table holding all the namespaces IPython deals with, so that |
|
874 | # A table holding all the namespaces IPython deals with, so that | |
875 | # introspection facilities can search easily. |
|
875 | # introspection facilities can search easily. | |
876 | self.ns_table = {'user':user_ns, |
|
876 | self.ns_table = {'user':user_ns, | |
877 | 'user_global':user_global_ns, |
|
877 | 'user_global':user_global_ns, | |
878 | 'internal':self.internal_ns, |
|
878 | 'internal':self.internal_ns, | |
879 | 'builtin':__builtin__.__dict__ |
|
879 | 'builtin':__builtin__.__dict__ | |
880 | } |
|
880 | } | |
881 |
|
881 | |||
882 | # Similarly, track all namespaces where references can be held and that |
|
882 | # Similarly, track all namespaces where references can be held and that | |
883 | # we can safely clear (so it can NOT include builtin). This one can be |
|
883 | # we can safely clear (so it can NOT include builtin). This one can be | |
884 | # a simple list. Note that the main execution namespaces, user_ns and |
|
884 | # a simple list. Note that the main execution namespaces, user_ns and | |
885 | # user_global_ns, can NOT be listed here, as clearing them blindly |
|
885 | # user_global_ns, can NOT be listed here, as clearing them blindly | |
886 | # causes errors in object __del__ methods. Instead, the reset() method |
|
886 | # causes errors in object __del__ methods. Instead, the reset() method | |
887 | # clears them manually and carefully. |
|
887 | # clears them manually and carefully. | |
888 | self.ns_refs_table = [ self.user_ns_hidden, |
|
888 | self.ns_refs_table = [ self.user_ns_hidden, | |
889 | self.internal_ns, self._main_ns_cache ] |
|
889 | self.internal_ns, self._main_ns_cache ] | |
890 |
|
890 | |||
891 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
891 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): | |
892 | """Return a valid local and global user interactive namespaces. |
|
892 | """Return a valid local and global user interactive namespaces. | |
893 |
|
893 | |||
894 | This builds a dict with the minimal information needed to operate as a |
|
894 | This builds a dict with the minimal information needed to operate as a | |
895 | valid IPython user namespace, which you can pass to the various |
|
895 | valid IPython user namespace, which you can pass to the various | |
896 | embedding classes in ipython. The default implementation returns the |
|
896 | embedding classes in ipython. The default implementation returns the | |
897 | same dict for both the locals and the globals to allow functions to |
|
897 | same dict for both the locals and the globals to allow functions to | |
898 | refer to variables in the namespace. Customized implementations can |
|
898 | refer to variables in the namespace. Customized implementations can | |
899 | return different dicts. The locals dictionary can actually be anything |
|
899 | return different dicts. The locals dictionary can actually be anything | |
900 | following the basic mapping protocol of a dict, but the globals dict |
|
900 | following the basic mapping protocol of a dict, but the globals dict | |
901 | must be a true dict, not even a subclass. It is recommended that any |
|
901 | must be a true dict, not even a subclass. It is recommended that any | |
902 | custom object for the locals namespace synchronize with the globals |
|
902 | custom object for the locals namespace synchronize with the globals | |
903 | dict somehow. |
|
903 | dict somehow. | |
904 |
|
904 | |||
905 | Raises TypeError if the provided globals namespace is not a true dict. |
|
905 | Raises TypeError if the provided globals namespace is not a true dict. | |
906 |
|
906 | |||
907 | Parameters |
|
907 | Parameters | |
908 | ---------- |
|
908 | ---------- | |
909 | user_ns : dict-like, optional |
|
909 | user_ns : dict-like, optional | |
910 | The current user namespace. The items in this namespace should |
|
910 | The current user namespace. The items in this namespace should | |
911 | be included in the output. If None, an appropriate blank |
|
911 | be included in the output. If None, an appropriate blank | |
912 | namespace should be created. |
|
912 | namespace should be created. | |
913 | user_global_ns : dict, optional |
|
913 | user_global_ns : dict, optional | |
914 | The current user global namespace. The items in this namespace |
|
914 | The current user global namespace. The items in this namespace | |
915 | should be included in the output. If None, an appropriate |
|
915 | should be included in the output. If None, an appropriate | |
916 | blank namespace should be created. |
|
916 | blank namespace should be created. | |
917 |
|
917 | |||
918 | Returns |
|
918 | Returns | |
919 | ------- |
|
919 | ------- | |
920 | A pair of dictionary-like object to be used as the local namespace |
|
920 | A pair of dictionary-like object to be used as the local namespace | |
921 | of the interpreter and a dict to be used as the global namespace. |
|
921 | of the interpreter and a dict to be used as the global namespace. | |
922 | """ |
|
922 | """ | |
923 |
|
923 | |||
924 |
|
924 | |||
925 | # We must ensure that __builtin__ (without the final 's') is always |
|
925 | # We must ensure that __builtin__ (without the final 's') is always | |
926 | # available and pointing to the __builtin__ *module*. For more details: |
|
926 | # available and pointing to the __builtin__ *module*. For more details: | |
927 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
927 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
928 |
|
928 | |||
929 | if user_ns is None: |
|
929 | if user_ns is None: | |
930 | # Set __name__ to __main__ to better match the behavior of the |
|
930 | # Set __name__ to __main__ to better match the behavior of the | |
931 | # normal interpreter. |
|
931 | # normal interpreter. | |
932 | user_ns = {'__name__' :'__main__', |
|
932 | user_ns = {'__name__' :'__main__', | |
933 | '__builtin__' : __builtin__, |
|
933 | '__builtin__' : __builtin__, | |
934 | '__builtins__' : __builtin__, |
|
934 | '__builtins__' : __builtin__, | |
935 | } |
|
935 | } | |
936 | else: |
|
936 | else: | |
937 | user_ns.setdefault('__name__','__main__') |
|
937 | user_ns.setdefault('__name__','__main__') | |
938 | user_ns.setdefault('__builtin__',__builtin__) |
|
938 | user_ns.setdefault('__builtin__',__builtin__) | |
939 | user_ns.setdefault('__builtins__',__builtin__) |
|
939 | user_ns.setdefault('__builtins__',__builtin__) | |
940 |
|
940 | |||
941 | if user_global_ns is None: |
|
941 | if user_global_ns is None: | |
942 | user_global_ns = user_ns |
|
942 | user_global_ns = user_ns | |
943 | if type(user_global_ns) is not dict: |
|
943 | if type(user_global_ns) is not dict: | |
944 | raise TypeError("user_global_ns must be a true dict; got %r" |
|
944 | raise TypeError("user_global_ns must be a true dict; got %r" | |
945 | % type(user_global_ns)) |
|
945 | % type(user_global_ns)) | |
946 |
|
946 | |||
947 | return user_ns, user_global_ns |
|
947 | return user_ns, user_global_ns | |
948 |
|
948 | |||
949 | def init_sys_modules(self): |
|
949 | def init_sys_modules(self): | |
950 | # We need to insert into sys.modules something that looks like a |
|
950 | # We need to insert into sys.modules something that looks like a | |
951 | # module but which accesses the IPython namespace, for shelve and |
|
951 | # module but which accesses the IPython namespace, for shelve and | |
952 | # pickle to work interactively. Normally they rely on getting |
|
952 | # pickle to work interactively. Normally they rely on getting | |
953 | # everything out of __main__, but for embedding purposes each IPython |
|
953 | # everything out of __main__, but for embedding purposes each IPython | |
954 | # instance has its own private namespace, so we can't go shoving |
|
954 | # instance has its own private namespace, so we can't go shoving | |
955 | # everything into __main__. |
|
955 | # everything into __main__. | |
956 |
|
956 | |||
957 | # note, however, that we should only do this for non-embedded |
|
957 | # note, however, that we should only do this for non-embedded | |
958 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
958 | # ipythons, which really mimic the __main__.__dict__ with their own | |
959 | # namespace. Embedded instances, on the other hand, should not do |
|
959 | # namespace. Embedded instances, on the other hand, should not do | |
960 | # this because they need to manage the user local/global namespaces |
|
960 | # this because they need to manage the user local/global namespaces | |
961 | # only, but they live within a 'normal' __main__ (meaning, they |
|
961 | # only, but they live within a 'normal' __main__ (meaning, they | |
962 | # shouldn't overtake the execution environment of the script they're |
|
962 | # shouldn't overtake the execution environment of the script they're | |
963 | # embedded in). |
|
963 | # embedded in). | |
964 |
|
964 | |||
965 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
965 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
966 |
|
966 | |||
967 | try: |
|
967 | try: | |
968 | main_name = self.user_ns['__name__'] |
|
968 | main_name = self.user_ns['__name__'] | |
969 | except KeyError: |
|
969 | except KeyError: | |
970 | raise KeyError('user_ns dictionary MUST have a "__name__" key') |
|
970 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
971 | else: |
|
971 | else: | |
972 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
972 | sys.modules[main_name] = FakeModule(self.user_ns) | |
973 |
|
973 | |||
974 | def init_user_ns(self): |
|
974 | def init_user_ns(self): | |
975 | """Initialize all user-visible namespaces to their minimum defaults. |
|
975 | """Initialize all user-visible namespaces to their minimum defaults. | |
976 |
|
976 | |||
977 | Certain history lists are also initialized here, as they effectively |
|
977 | Certain history lists are also initialized here, as they effectively | |
978 | act as user namespaces. |
|
978 | act as user namespaces. | |
979 |
|
979 | |||
980 | Notes |
|
980 | Notes | |
981 | ----- |
|
981 | ----- | |
982 | All data structures here are only filled in, they are NOT reset by this |
|
982 | All data structures here are only filled in, they are NOT reset by this | |
983 | method. If they were not empty before, data will simply be added to |
|
983 | method. If they were not empty before, data will simply be added to | |
984 | therm. |
|
984 | therm. | |
985 | """ |
|
985 | """ | |
986 | # This function works in two parts: first we put a few things in |
|
986 | # This function works in two parts: first we put a few things in | |
987 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
987 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
988 | # initial variables aren't shown by %who. After the sync, we add the |
|
988 | # initial variables aren't shown by %who. After the sync, we add the | |
989 | # rest of what we *do* want the user to see with %who even on a new |
|
989 | # rest of what we *do* want the user to see with %who even on a new | |
990 | # session (probably nothing, so theye really only see their own stuff) |
|
990 | # session (probably nothing, so theye really only see their own stuff) | |
991 |
|
991 | |||
992 | # The user dict must *always* have a __builtin__ reference to the |
|
992 | # The user dict must *always* have a __builtin__ reference to the | |
993 | # Python standard __builtin__ namespace, which must be imported. |
|
993 | # Python standard __builtin__ namespace, which must be imported. | |
994 | # This is so that certain operations in prompt evaluation can be |
|
994 | # This is so that certain operations in prompt evaluation can be | |
995 | # reliably executed with builtins. Note that we can NOT use |
|
995 | # reliably executed with builtins. Note that we can NOT use | |
996 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
996 | # __builtins__ (note the 's'), because that can either be a dict or a | |
997 | # module, and can even mutate at runtime, depending on the context |
|
997 | # module, and can even mutate at runtime, depending on the context | |
998 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
998 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
999 | # always a module object, though it must be explicitly imported. |
|
999 | # always a module object, though it must be explicitly imported. | |
1000 |
|
1000 | |||
1001 | # For more details: |
|
1001 | # For more details: | |
1002 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1002 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1003 | ns = dict(__builtin__ = __builtin__) |
|
1003 | ns = dict(__builtin__ = __builtin__) | |
1004 |
|
1004 | |||
1005 | # Put 'help' in the user namespace |
|
1005 | # Put 'help' in the user namespace | |
1006 | try: |
|
1006 | try: | |
1007 | from site import _Helper |
|
1007 | from site import _Helper | |
1008 | ns['help'] = _Helper() |
|
1008 | ns['help'] = _Helper() | |
1009 | except ImportError: |
|
1009 | except ImportError: | |
1010 | warn('help() not available - check site.py') |
|
1010 | warn('help() not available - check site.py') | |
1011 |
|
1011 | |||
1012 | # make global variables for user access to the histories |
|
1012 | # make global variables for user access to the histories | |
1013 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1013 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1014 | ns['_oh'] = self.history_manager.output_hist |
|
1014 | ns['_oh'] = self.history_manager.output_hist | |
1015 | ns['_dh'] = self.history_manager.dir_hist |
|
1015 | ns['_dh'] = self.history_manager.dir_hist | |
1016 |
|
1016 | |||
1017 | ns['_sh'] = shadowns |
|
1017 | ns['_sh'] = shadowns | |
1018 |
|
1018 | |||
1019 | # user aliases to input and output histories. These shouldn't show up |
|
1019 | # user aliases to input and output histories. These shouldn't show up | |
1020 | # in %who, as they can have very large reprs. |
|
1020 | # in %who, as they can have very large reprs. | |
1021 | ns['In'] = self.history_manager.input_hist_parsed |
|
1021 | ns['In'] = self.history_manager.input_hist_parsed | |
1022 | ns['Out'] = self.history_manager.output_hist |
|
1022 | ns['Out'] = self.history_manager.output_hist | |
1023 |
|
1023 | |||
1024 | # Store myself as the public api!!! |
|
1024 | # Store myself as the public api!!! | |
1025 | ns['get_ipython'] = self.get_ipython |
|
1025 | ns['get_ipython'] = self.get_ipython | |
1026 |
|
1026 | |||
1027 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1027 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1028 | # by %who |
|
1028 | # by %who | |
1029 | self.user_ns_hidden.update(ns) |
|
1029 | self.user_ns_hidden.update(ns) | |
1030 |
|
1030 | |||
1031 | # Anything put into ns now would show up in %who. Think twice before |
|
1031 | # Anything put into ns now would show up in %who. Think twice before | |
1032 | # putting anything here, as we really want %who to show the user their |
|
1032 | # putting anything here, as we really want %who to show the user their | |
1033 | # stuff, not our variables. |
|
1033 | # stuff, not our variables. | |
1034 |
|
1034 | |||
1035 | # Finally, update the real user's namespace |
|
1035 | # Finally, update the real user's namespace | |
1036 | self.user_ns.update(ns) |
|
1036 | self.user_ns.update(ns) | |
1037 |
|
1037 | |||
1038 | def reset(self, new_session=True): |
|
1038 | def reset(self, new_session=True): | |
1039 | """Clear all internal namespaces. |
|
1039 | """Clear all internal namespaces. | |
1040 |
|
1040 | |||
1041 | Note that this is much more aggressive than %reset, since it clears |
|
1041 | Note that this is much more aggressive than %reset, since it clears | |
1042 | fully all namespaces, as well as all input/output lists. |
|
1042 | fully all namespaces, as well as all input/output lists. | |
1043 |
|
1043 | |||
1044 | If new_session is True, a new history session will be opened. |
|
1044 | If new_session is True, a new history session will be opened. | |
1045 | """ |
|
1045 | """ | |
1046 | # Clear histories |
|
1046 | # Clear histories | |
1047 | self.history_manager.reset(new_session) |
|
1047 | self.history_manager.reset(new_session) | |
|
1048 | # Reset counter used to index all histories | |||
|
1049 | if new_session: | |||
|
1050 | self.execution_count = 1 | |||
1048 |
|
1051 | |||
1049 | # Flush cached output items |
|
1052 | # Flush cached output items | |
1050 | self.displayhook.flush() |
|
1053 | self.displayhook.flush() | |
1051 |
|
||||
1052 | # Reset counter used to index all histories |
|
|||
1053 | self.execution_count = 0 |
|
|||
1054 |
|
1054 | |||
1055 | # Restore the user namespaces to minimal usability |
|
1055 | # Restore the user namespaces to minimal usability | |
1056 | for ns in self.ns_refs_table: |
|
1056 | for ns in self.ns_refs_table: | |
1057 | ns.clear() |
|
1057 | ns.clear() | |
1058 |
|
1058 | |||
1059 | # The main execution namespaces must be cleared very carefully, |
|
1059 | # The main execution namespaces must be cleared very carefully, | |
1060 | # skipping the deletion of the builtin-related keys, because doing so |
|
1060 | # skipping the deletion of the builtin-related keys, because doing so | |
1061 | # would cause errors in many object's __del__ methods. |
|
1061 | # would cause errors in many object's __del__ methods. | |
1062 | for ns in [self.user_ns, self.user_global_ns]: |
|
1062 | for ns in [self.user_ns, self.user_global_ns]: | |
1063 | drop_keys = set(ns.keys()) |
|
1063 | drop_keys = set(ns.keys()) | |
1064 | drop_keys.discard('__builtin__') |
|
1064 | drop_keys.discard('__builtin__') | |
1065 | drop_keys.discard('__builtins__') |
|
1065 | drop_keys.discard('__builtins__') | |
1066 | for k in drop_keys: |
|
1066 | for k in drop_keys: | |
1067 | del ns[k] |
|
1067 | del ns[k] | |
1068 |
|
1068 | |||
1069 | # Restore the user namespaces to minimal usability |
|
1069 | # Restore the user namespaces to minimal usability | |
1070 | self.init_user_ns() |
|
1070 | self.init_user_ns() | |
1071 |
|
1071 | |||
1072 | # Restore the default and user aliases |
|
1072 | # Restore the default and user aliases | |
1073 | self.alias_manager.clear_aliases() |
|
1073 | self.alias_manager.clear_aliases() | |
1074 | self.alias_manager.init_aliases() |
|
1074 | self.alias_manager.init_aliases() | |
1075 |
|
1075 | |||
1076 | # Flush the private list of module references kept for script |
|
1076 | # Flush the private list of module references kept for script | |
1077 | # execution protection |
|
1077 | # execution protection | |
1078 | self.clear_main_mod_cache() |
|
1078 | self.clear_main_mod_cache() | |
1079 |
|
1079 | |||
1080 | def reset_selective(self, regex=None): |
|
1080 | def reset_selective(self, regex=None): | |
1081 | """Clear selective variables from internal namespaces based on a |
|
1081 | """Clear selective variables from internal namespaces based on a | |
1082 | specified regular expression. |
|
1082 | specified regular expression. | |
1083 |
|
1083 | |||
1084 | Parameters |
|
1084 | Parameters | |
1085 | ---------- |
|
1085 | ---------- | |
1086 | regex : string or compiled pattern, optional |
|
1086 | regex : string or compiled pattern, optional | |
1087 | A regular expression pattern that will be used in searching |
|
1087 | A regular expression pattern that will be used in searching | |
1088 | variable names in the users namespaces. |
|
1088 | variable names in the users namespaces. | |
1089 | """ |
|
1089 | """ | |
1090 | if regex is not None: |
|
1090 | if regex is not None: | |
1091 | try: |
|
1091 | try: | |
1092 | m = re.compile(regex) |
|
1092 | m = re.compile(regex) | |
1093 | except TypeError: |
|
1093 | except TypeError: | |
1094 | raise TypeError('regex must be a string or compiled pattern') |
|
1094 | raise TypeError('regex must be a string or compiled pattern') | |
1095 | # Search for keys in each namespace that match the given regex |
|
1095 | # Search for keys in each namespace that match the given regex | |
1096 | # If a match is found, delete the key/value pair. |
|
1096 | # If a match is found, delete the key/value pair. | |
1097 | for ns in self.ns_refs_table: |
|
1097 | for ns in self.ns_refs_table: | |
1098 | for var in ns: |
|
1098 | for var in ns: | |
1099 | if m.search(var): |
|
1099 | if m.search(var): | |
1100 | del ns[var] |
|
1100 | del ns[var] | |
1101 |
|
1101 | |||
1102 | def push(self, variables, interactive=True): |
|
1102 | def push(self, variables, interactive=True): | |
1103 | """Inject a group of variables into the IPython user namespace. |
|
1103 | """Inject a group of variables into the IPython user namespace. | |
1104 |
|
1104 | |||
1105 | Parameters |
|
1105 | Parameters | |
1106 | ---------- |
|
1106 | ---------- | |
1107 | variables : dict, str or list/tuple of str |
|
1107 | variables : dict, str or list/tuple of str | |
1108 | The variables to inject into the user's namespace. If a dict, a |
|
1108 | The variables to inject into the user's namespace. If a dict, a | |
1109 | simple update is done. If a str, the string is assumed to have |
|
1109 | simple update is done. If a str, the string is assumed to have | |
1110 | variable names separated by spaces. A list/tuple of str can also |
|
1110 | variable names separated by spaces. A list/tuple of str can also | |
1111 | be used to give the variable names. If just the variable names are |
|
1111 | be used to give the variable names. If just the variable names are | |
1112 | give (list/tuple/str) then the variable values looked up in the |
|
1112 | give (list/tuple/str) then the variable values looked up in the | |
1113 | callers frame. |
|
1113 | callers frame. | |
1114 | interactive : bool |
|
1114 | interactive : bool | |
1115 | If True (default), the variables will be listed with the ``who`` |
|
1115 | If True (default), the variables will be listed with the ``who`` | |
1116 | magic. |
|
1116 | magic. | |
1117 | """ |
|
1117 | """ | |
1118 | vdict = None |
|
1118 | vdict = None | |
1119 |
|
1119 | |||
1120 | # We need a dict of name/value pairs to do namespace updates. |
|
1120 | # We need a dict of name/value pairs to do namespace updates. | |
1121 | if isinstance(variables, dict): |
|
1121 | if isinstance(variables, dict): | |
1122 | vdict = variables |
|
1122 | vdict = variables | |
1123 | elif isinstance(variables, (basestring, list, tuple)): |
|
1123 | elif isinstance(variables, (basestring, list, tuple)): | |
1124 | if isinstance(variables, basestring): |
|
1124 | if isinstance(variables, basestring): | |
1125 | vlist = variables.split() |
|
1125 | vlist = variables.split() | |
1126 | else: |
|
1126 | else: | |
1127 | vlist = variables |
|
1127 | vlist = variables | |
1128 | vdict = {} |
|
1128 | vdict = {} | |
1129 | cf = sys._getframe(1) |
|
1129 | cf = sys._getframe(1) | |
1130 | for name in vlist: |
|
1130 | for name in vlist: | |
1131 | try: |
|
1131 | try: | |
1132 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1132 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1133 | except: |
|
1133 | except: | |
1134 | print ('Could not get variable %s from %s' % |
|
1134 | print ('Could not get variable %s from %s' % | |
1135 | (name,cf.f_code.co_name)) |
|
1135 | (name,cf.f_code.co_name)) | |
1136 | else: |
|
1136 | else: | |
1137 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1137 | raise ValueError('variables must be a dict/str/list/tuple') | |
1138 |
|
1138 | |||
1139 | # Propagate variables to user namespace |
|
1139 | # Propagate variables to user namespace | |
1140 | self.user_ns.update(vdict) |
|
1140 | self.user_ns.update(vdict) | |
1141 |
|
1141 | |||
1142 | # And configure interactive visibility |
|
1142 | # And configure interactive visibility | |
1143 | config_ns = self.user_ns_hidden |
|
1143 | config_ns = self.user_ns_hidden | |
1144 | if interactive: |
|
1144 | if interactive: | |
1145 | for name, val in vdict.iteritems(): |
|
1145 | for name, val in vdict.iteritems(): | |
1146 | config_ns.pop(name, None) |
|
1146 | config_ns.pop(name, None) | |
1147 | else: |
|
1147 | else: | |
1148 | for name,val in vdict.iteritems(): |
|
1148 | for name,val in vdict.iteritems(): | |
1149 | config_ns[name] = val |
|
1149 | config_ns[name] = val | |
1150 |
|
1150 | |||
1151 | #------------------------------------------------------------------------- |
|
1151 | #------------------------------------------------------------------------- | |
1152 | # Things related to object introspection |
|
1152 | # Things related to object introspection | |
1153 | #------------------------------------------------------------------------- |
|
1153 | #------------------------------------------------------------------------- | |
1154 |
|
1154 | |||
1155 | def _ofind(self, oname, namespaces=None): |
|
1155 | def _ofind(self, oname, namespaces=None): | |
1156 | """Find an object in the available namespaces. |
|
1156 | """Find an object in the available namespaces. | |
1157 |
|
1157 | |||
1158 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1158 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1159 |
|
1159 | |||
1160 | Has special code to detect magic functions. |
|
1160 | Has special code to detect magic functions. | |
1161 | """ |
|
1161 | """ | |
1162 | #oname = oname.strip() |
|
1162 | #oname = oname.strip() | |
1163 | #print '1- oname: <%r>' % oname # dbg |
|
1163 | #print '1- oname: <%r>' % oname # dbg | |
1164 | try: |
|
1164 | try: | |
1165 | oname = oname.strip().encode('ascii') |
|
1165 | oname = oname.strip().encode('ascii') | |
1166 | #print '2- oname: <%r>' % oname # dbg |
|
1166 | #print '2- oname: <%r>' % oname # dbg | |
1167 | except UnicodeEncodeError: |
|
1167 | except UnicodeEncodeError: | |
1168 | print 'Python identifiers can only contain ascii characters.' |
|
1168 | print 'Python identifiers can only contain ascii characters.' | |
1169 | return dict(found=False) |
|
1169 | return dict(found=False) | |
1170 |
|
1170 | |||
1171 | alias_ns = None |
|
1171 | alias_ns = None | |
1172 | if namespaces is None: |
|
1172 | if namespaces is None: | |
1173 | # Namespaces to search in: |
|
1173 | # Namespaces to search in: | |
1174 | # Put them in a list. The order is important so that we |
|
1174 | # Put them in a list. The order is important so that we | |
1175 | # find things in the same order that Python finds them. |
|
1175 | # find things in the same order that Python finds them. | |
1176 | namespaces = [ ('Interactive', self.user_ns), |
|
1176 | namespaces = [ ('Interactive', self.user_ns), | |
1177 | ('IPython internal', self.internal_ns), |
|
1177 | ('IPython internal', self.internal_ns), | |
1178 | ('Python builtin', __builtin__.__dict__), |
|
1178 | ('Python builtin', __builtin__.__dict__), | |
1179 | ('Alias', self.alias_manager.alias_table), |
|
1179 | ('Alias', self.alias_manager.alias_table), | |
1180 | ] |
|
1180 | ] | |
1181 | alias_ns = self.alias_manager.alias_table |
|
1181 | alias_ns = self.alias_manager.alias_table | |
1182 |
|
1182 | |||
1183 | # initialize results to 'null' |
|
1183 | # initialize results to 'null' | |
1184 | found = False; obj = None; ospace = None; ds = None; |
|
1184 | found = False; obj = None; ospace = None; ds = None; | |
1185 | ismagic = False; isalias = False; parent = None |
|
1185 | ismagic = False; isalias = False; parent = None | |
1186 |
|
1186 | |||
1187 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1187 | # We need to special-case 'print', which as of python2.6 registers as a | |
1188 | # function but should only be treated as one if print_function was |
|
1188 | # function but should only be treated as one if print_function was | |
1189 | # loaded with a future import. In this case, just bail. |
|
1189 | # loaded with a future import. In this case, just bail. | |
1190 | if (oname == 'print' and not (self.compile.compiler_flags & |
|
1190 | if (oname == 'print' and not (self.compile.compiler_flags & | |
1191 | __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1191 | __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1192 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1192 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1193 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1193 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1194 |
|
1194 | |||
1195 | # Look for the given name by splitting it in parts. If the head is |
|
1195 | # Look for the given name by splitting it in parts. If the head is | |
1196 | # found, then we look for all the remaining parts as members, and only |
|
1196 | # found, then we look for all the remaining parts as members, and only | |
1197 | # declare success if we can find them all. |
|
1197 | # declare success if we can find them all. | |
1198 | oname_parts = oname.split('.') |
|
1198 | oname_parts = oname.split('.') | |
1199 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1199 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1200 | for nsname,ns in namespaces: |
|
1200 | for nsname,ns in namespaces: | |
1201 | try: |
|
1201 | try: | |
1202 | obj = ns[oname_head] |
|
1202 | obj = ns[oname_head] | |
1203 | except KeyError: |
|
1203 | except KeyError: | |
1204 | continue |
|
1204 | continue | |
1205 | else: |
|
1205 | else: | |
1206 | #print 'oname_rest:', oname_rest # dbg |
|
1206 | #print 'oname_rest:', oname_rest # dbg | |
1207 | for part in oname_rest: |
|
1207 | for part in oname_rest: | |
1208 | try: |
|
1208 | try: | |
1209 | parent = obj |
|
1209 | parent = obj | |
1210 | obj = getattr(obj,part) |
|
1210 | obj = getattr(obj,part) | |
1211 | except: |
|
1211 | except: | |
1212 | # Blanket except b/c some badly implemented objects |
|
1212 | # Blanket except b/c some badly implemented objects | |
1213 | # allow __getattr__ to raise exceptions other than |
|
1213 | # allow __getattr__ to raise exceptions other than | |
1214 | # AttributeError, which then crashes IPython. |
|
1214 | # AttributeError, which then crashes IPython. | |
1215 | break |
|
1215 | break | |
1216 | else: |
|
1216 | else: | |
1217 | # If we finish the for loop (no break), we got all members |
|
1217 | # If we finish the for loop (no break), we got all members | |
1218 | found = True |
|
1218 | found = True | |
1219 | ospace = nsname |
|
1219 | ospace = nsname | |
1220 | if ns == alias_ns: |
|
1220 | if ns == alias_ns: | |
1221 | isalias = True |
|
1221 | isalias = True | |
1222 | break # namespace loop |
|
1222 | break # namespace loop | |
1223 |
|
1223 | |||
1224 | # Try to see if it's magic |
|
1224 | # Try to see if it's magic | |
1225 | if not found: |
|
1225 | if not found: | |
1226 | if oname.startswith(ESC_MAGIC): |
|
1226 | if oname.startswith(ESC_MAGIC): | |
1227 | oname = oname[1:] |
|
1227 | oname = oname[1:] | |
1228 | obj = getattr(self,'magic_'+oname,None) |
|
1228 | obj = getattr(self,'magic_'+oname,None) | |
1229 | if obj is not None: |
|
1229 | if obj is not None: | |
1230 | found = True |
|
1230 | found = True | |
1231 | ospace = 'IPython internal' |
|
1231 | ospace = 'IPython internal' | |
1232 | ismagic = True |
|
1232 | ismagic = True | |
1233 |
|
1233 | |||
1234 | # Last try: special-case some literals like '', [], {}, etc: |
|
1234 | # Last try: special-case some literals like '', [], {}, etc: | |
1235 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1235 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1236 | obj = eval(oname_head) |
|
1236 | obj = eval(oname_head) | |
1237 | found = True |
|
1237 | found = True | |
1238 | ospace = 'Interactive' |
|
1238 | ospace = 'Interactive' | |
1239 |
|
1239 | |||
1240 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1240 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1241 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1241 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1242 |
|
1242 | |||
1243 | def _ofind_property(self, oname, info): |
|
1243 | def _ofind_property(self, oname, info): | |
1244 | """Second part of object finding, to look for property details.""" |
|
1244 | """Second part of object finding, to look for property details.""" | |
1245 | if info.found: |
|
1245 | if info.found: | |
1246 | # Get the docstring of the class property if it exists. |
|
1246 | # Get the docstring of the class property if it exists. | |
1247 | path = oname.split('.') |
|
1247 | path = oname.split('.') | |
1248 | root = '.'.join(path[:-1]) |
|
1248 | root = '.'.join(path[:-1]) | |
1249 | if info.parent is not None: |
|
1249 | if info.parent is not None: | |
1250 | try: |
|
1250 | try: | |
1251 | target = getattr(info.parent, '__class__') |
|
1251 | target = getattr(info.parent, '__class__') | |
1252 | # The object belongs to a class instance. |
|
1252 | # The object belongs to a class instance. | |
1253 | try: |
|
1253 | try: | |
1254 | target = getattr(target, path[-1]) |
|
1254 | target = getattr(target, path[-1]) | |
1255 | # The class defines the object. |
|
1255 | # The class defines the object. | |
1256 | if isinstance(target, property): |
|
1256 | if isinstance(target, property): | |
1257 | oname = root + '.__class__.' + path[-1] |
|
1257 | oname = root + '.__class__.' + path[-1] | |
1258 | info = Struct(self._ofind(oname)) |
|
1258 | info = Struct(self._ofind(oname)) | |
1259 | except AttributeError: pass |
|
1259 | except AttributeError: pass | |
1260 | except AttributeError: pass |
|
1260 | except AttributeError: pass | |
1261 |
|
1261 | |||
1262 | # We return either the new info or the unmodified input if the object |
|
1262 | # We return either the new info or the unmodified input if the object | |
1263 | # hadn't been found |
|
1263 | # hadn't been found | |
1264 | return info |
|
1264 | return info | |
1265 |
|
1265 | |||
1266 | def _object_find(self, oname, namespaces=None): |
|
1266 | def _object_find(self, oname, namespaces=None): | |
1267 | """Find an object and return a struct with info about it.""" |
|
1267 | """Find an object and return a struct with info about it.""" | |
1268 | inf = Struct(self._ofind(oname, namespaces)) |
|
1268 | inf = Struct(self._ofind(oname, namespaces)) | |
1269 | return Struct(self._ofind_property(oname, inf)) |
|
1269 | return Struct(self._ofind_property(oname, inf)) | |
1270 |
|
1270 | |||
1271 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1271 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1272 | """Generic interface to the inspector system. |
|
1272 | """Generic interface to the inspector system. | |
1273 |
|
1273 | |||
1274 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1274 | This function is meant to be called by pdef, pdoc & friends.""" | |
1275 | info = self._object_find(oname) |
|
1275 | info = self._object_find(oname) | |
1276 | if info.found: |
|
1276 | if info.found: | |
1277 | pmethod = getattr(self.inspector, meth) |
|
1277 | pmethod = getattr(self.inspector, meth) | |
1278 | formatter = format_screen if info.ismagic else None |
|
1278 | formatter = format_screen if info.ismagic else None | |
1279 | if meth == 'pdoc': |
|
1279 | if meth == 'pdoc': | |
1280 | pmethod(info.obj, oname, formatter) |
|
1280 | pmethod(info.obj, oname, formatter) | |
1281 | elif meth == 'pinfo': |
|
1281 | elif meth == 'pinfo': | |
1282 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1282 | pmethod(info.obj, oname, formatter, info, **kw) | |
1283 | else: |
|
1283 | else: | |
1284 | pmethod(info.obj, oname) |
|
1284 | pmethod(info.obj, oname) | |
1285 | else: |
|
1285 | else: | |
1286 | print 'Object `%s` not found.' % oname |
|
1286 | print 'Object `%s` not found.' % oname | |
1287 | return 'not found' # so callers can take other action |
|
1287 | return 'not found' # so callers can take other action | |
1288 |
|
1288 | |||
1289 | def object_inspect(self, oname): |
|
1289 | def object_inspect(self, oname): | |
1290 | with self.builtin_trap: |
|
1290 | with self.builtin_trap: | |
1291 | info = self._object_find(oname) |
|
1291 | info = self._object_find(oname) | |
1292 | if info.found: |
|
1292 | if info.found: | |
1293 | return self.inspector.info(info.obj, oname, info=info) |
|
1293 | return self.inspector.info(info.obj, oname, info=info) | |
1294 | else: |
|
1294 | else: | |
1295 | return oinspect.object_info(name=oname, found=False) |
|
1295 | return oinspect.object_info(name=oname, found=False) | |
1296 |
|
1296 | |||
1297 | #------------------------------------------------------------------------- |
|
1297 | #------------------------------------------------------------------------- | |
1298 | # Things related to history management |
|
1298 | # Things related to history management | |
1299 | #------------------------------------------------------------------------- |
|
1299 | #------------------------------------------------------------------------- | |
1300 |
|
1300 | |||
1301 | def init_history(self): |
|
1301 | def init_history(self): | |
1302 | """Sets up the command history, and starts regular autosaves.""" |
|
1302 | """Sets up the command history, and starts regular autosaves.""" | |
1303 | self.history_manager = HistoryManager(shell=self, config=self.config) |
|
1303 | self.history_manager = HistoryManager(shell=self, config=self.config) | |
1304 |
|
1304 | |||
1305 | #------------------------------------------------------------------------- |
|
1305 | #------------------------------------------------------------------------- | |
1306 | # Things related to exception handling and tracebacks (not debugging) |
|
1306 | # Things related to exception handling and tracebacks (not debugging) | |
1307 | #------------------------------------------------------------------------- |
|
1307 | #------------------------------------------------------------------------- | |
1308 |
|
1308 | |||
1309 | def init_traceback_handlers(self, custom_exceptions): |
|
1309 | def init_traceback_handlers(self, custom_exceptions): | |
1310 | # Syntax error handler. |
|
1310 | # Syntax error handler. | |
1311 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1311 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1312 |
|
1312 | |||
1313 | # The interactive one is initialized with an offset, meaning we always |
|
1313 | # The interactive one is initialized with an offset, meaning we always | |
1314 | # want to remove the topmost item in the traceback, which is our own |
|
1314 | # want to remove the topmost item in the traceback, which is our own | |
1315 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1315 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1316 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1316 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1317 | color_scheme='NoColor', |
|
1317 | color_scheme='NoColor', | |
1318 | tb_offset = 1, |
|
1318 | tb_offset = 1, | |
1319 | check_cache=self.compile.check_cache) |
|
1319 | check_cache=self.compile.check_cache) | |
1320 |
|
1320 | |||
1321 | # The instance will store a pointer to the system-wide exception hook, |
|
1321 | # The instance will store a pointer to the system-wide exception hook, | |
1322 | # so that runtime code (such as magics) can access it. This is because |
|
1322 | # so that runtime code (such as magics) can access it. This is because | |
1323 | # during the read-eval loop, it may get temporarily overwritten. |
|
1323 | # during the read-eval loop, it may get temporarily overwritten. | |
1324 | self.sys_excepthook = sys.excepthook |
|
1324 | self.sys_excepthook = sys.excepthook | |
1325 |
|
1325 | |||
1326 | # and add any custom exception handlers the user may have specified |
|
1326 | # and add any custom exception handlers the user may have specified | |
1327 | self.set_custom_exc(*custom_exceptions) |
|
1327 | self.set_custom_exc(*custom_exceptions) | |
1328 |
|
1328 | |||
1329 | # Set the exception mode |
|
1329 | # Set the exception mode | |
1330 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1330 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1331 |
|
1331 | |||
1332 | def set_custom_exc(self, exc_tuple, handler): |
|
1332 | def set_custom_exc(self, exc_tuple, handler): | |
1333 | """set_custom_exc(exc_tuple,handler) |
|
1333 | """set_custom_exc(exc_tuple,handler) | |
1334 |
|
1334 | |||
1335 | Set a custom exception handler, which will be called if any of the |
|
1335 | Set a custom exception handler, which will be called if any of the | |
1336 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1336 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1337 | run_code() method. |
|
1337 | run_code() method. | |
1338 |
|
1338 | |||
1339 | Inputs: |
|
1339 | Inputs: | |
1340 |
|
1340 | |||
1341 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1341 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
1342 | handler for. It is very important that you use a tuple, and NOT A |
|
1342 | handler for. It is very important that you use a tuple, and NOT A | |
1343 | LIST here, because of the way Python's except statement works. If |
|
1343 | LIST here, because of the way Python's except statement works. If | |
1344 | you only want to trap a single exception, use a singleton tuple: |
|
1344 | you only want to trap a single exception, use a singleton tuple: | |
1345 |
|
1345 | |||
1346 | exc_tuple == (MyCustomException,) |
|
1346 | exc_tuple == (MyCustomException,) | |
1347 |
|
1347 | |||
1348 | - handler: this must be defined as a function with the following |
|
1348 | - handler: this must be defined as a function with the following | |
1349 | basic interface:: |
|
1349 | basic interface:: | |
1350 |
|
1350 | |||
1351 | def my_handler(self, etype, value, tb, tb_offset=None) |
|
1351 | def my_handler(self, etype, value, tb, tb_offset=None) | |
1352 | ... |
|
1352 | ... | |
1353 | # The return value must be |
|
1353 | # The return value must be | |
1354 | return structured_traceback |
|
1354 | return structured_traceback | |
1355 |
|
1355 | |||
1356 | This will be made into an instance method (via types.MethodType) |
|
1356 | This will be made into an instance method (via types.MethodType) | |
1357 | of IPython itself, and it will be called if any of the exceptions |
|
1357 | of IPython itself, and it will be called if any of the exceptions | |
1358 | listed in the exc_tuple are caught. If the handler is None, an |
|
1358 | listed in the exc_tuple are caught. If the handler is None, an | |
1359 | internal basic one is used, which just prints basic info. |
|
1359 | internal basic one is used, which just prints basic info. | |
1360 |
|
1360 | |||
1361 | WARNING: by putting in your own exception handler into IPython's main |
|
1361 | WARNING: by putting in your own exception handler into IPython's main | |
1362 | execution loop, you run a very good chance of nasty crashes. This |
|
1362 | execution loop, you run a very good chance of nasty crashes. This | |
1363 | facility should only be used if you really know what you are doing.""" |
|
1363 | facility should only be used if you really know what you are doing.""" | |
1364 |
|
1364 | |||
1365 | assert type(exc_tuple)==type(()) , \ |
|
1365 | assert type(exc_tuple)==type(()) , \ | |
1366 | "The custom exceptions must be given AS A TUPLE." |
|
1366 | "The custom exceptions must be given AS A TUPLE." | |
1367 |
|
1367 | |||
1368 | def dummy_handler(self,etype,value,tb): |
|
1368 | def dummy_handler(self,etype,value,tb): | |
1369 | print '*** Simple custom exception handler ***' |
|
1369 | print '*** Simple custom exception handler ***' | |
1370 | print 'Exception type :',etype |
|
1370 | print 'Exception type :',etype | |
1371 | print 'Exception value:',value |
|
1371 | print 'Exception value:',value | |
1372 | print 'Traceback :',tb |
|
1372 | print 'Traceback :',tb | |
1373 | print 'Source code :','\n'.join(self.buffer) |
|
1373 | print 'Source code :','\n'.join(self.buffer) | |
1374 |
|
1374 | |||
1375 | if handler is None: handler = dummy_handler |
|
1375 | if handler is None: handler = dummy_handler | |
1376 |
|
1376 | |||
1377 | self.CustomTB = types.MethodType(handler,self) |
|
1377 | self.CustomTB = types.MethodType(handler,self) | |
1378 | self.custom_exceptions = exc_tuple |
|
1378 | self.custom_exceptions = exc_tuple | |
1379 |
|
1379 | |||
1380 | def excepthook(self, etype, value, tb): |
|
1380 | def excepthook(self, etype, value, tb): | |
1381 | """One more defense for GUI apps that call sys.excepthook. |
|
1381 | """One more defense for GUI apps that call sys.excepthook. | |
1382 |
|
1382 | |||
1383 | GUI frameworks like wxPython trap exceptions and call |
|
1383 | GUI frameworks like wxPython trap exceptions and call | |
1384 | sys.excepthook themselves. I guess this is a feature that |
|
1384 | sys.excepthook themselves. I guess this is a feature that | |
1385 | enables them to keep running after exceptions that would |
|
1385 | enables them to keep running after exceptions that would | |
1386 | otherwise kill their mainloop. This is a bother for IPython |
|
1386 | otherwise kill their mainloop. This is a bother for IPython | |
1387 | which excepts to catch all of the program exceptions with a try: |
|
1387 | which excepts to catch all of the program exceptions with a try: | |
1388 | except: statement. |
|
1388 | except: statement. | |
1389 |
|
1389 | |||
1390 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1390 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1391 | any app directly invokes sys.excepthook, it will look to the user like |
|
1391 | any app directly invokes sys.excepthook, it will look to the user like | |
1392 | IPython crashed. In order to work around this, we can disable the |
|
1392 | IPython crashed. In order to work around this, we can disable the | |
1393 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1393 | CrashHandler and replace it with this excepthook instead, which prints a | |
1394 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1394 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1395 | call sys.excepthook will generate a regular-looking exception from |
|
1395 | call sys.excepthook will generate a regular-looking exception from | |
1396 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1396 | IPython, and the CrashHandler will only be triggered by real IPython | |
1397 | crashes. |
|
1397 | crashes. | |
1398 |
|
1398 | |||
1399 | This hook should be used sparingly, only in places which are not likely |
|
1399 | This hook should be used sparingly, only in places which are not likely | |
1400 | to be true IPython errors. |
|
1400 | to be true IPython errors. | |
1401 | """ |
|
1401 | """ | |
1402 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1402 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1403 |
|
1403 | |||
1404 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1404 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
1405 | exception_only=False): |
|
1405 | exception_only=False): | |
1406 | """Display the exception that just occurred. |
|
1406 | """Display the exception that just occurred. | |
1407 |
|
1407 | |||
1408 | If nothing is known about the exception, this is the method which |
|
1408 | If nothing is known about the exception, this is the method which | |
1409 | should be used throughout the code for presenting user tracebacks, |
|
1409 | should be used throughout the code for presenting user tracebacks, | |
1410 | rather than directly invoking the InteractiveTB object. |
|
1410 | rather than directly invoking the InteractiveTB object. | |
1411 |
|
1411 | |||
1412 | A specific showsyntaxerror() also exists, but this method can take |
|
1412 | A specific showsyntaxerror() also exists, but this method can take | |
1413 | care of calling it if needed, so unless you are explicitly catching a |
|
1413 | care of calling it if needed, so unless you are explicitly catching a | |
1414 | SyntaxError exception, don't try to analyze the stack manually and |
|
1414 | SyntaxError exception, don't try to analyze the stack manually and | |
1415 | simply call this method.""" |
|
1415 | simply call this method.""" | |
1416 |
|
1416 | |||
1417 | try: |
|
1417 | try: | |
1418 | if exc_tuple is None: |
|
1418 | if exc_tuple is None: | |
1419 | etype, value, tb = sys.exc_info() |
|
1419 | etype, value, tb = sys.exc_info() | |
1420 | else: |
|
1420 | else: | |
1421 | etype, value, tb = exc_tuple |
|
1421 | etype, value, tb = exc_tuple | |
1422 |
|
1422 | |||
1423 | if etype is None: |
|
1423 | if etype is None: | |
1424 | if hasattr(sys, 'last_type'): |
|
1424 | if hasattr(sys, 'last_type'): | |
1425 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1425 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1426 | sys.last_traceback |
|
1426 | sys.last_traceback | |
1427 | else: |
|
1427 | else: | |
1428 | self.write_err('No traceback available to show.\n') |
|
1428 | self.write_err('No traceback available to show.\n') | |
1429 | return |
|
1429 | return | |
1430 |
|
1430 | |||
1431 | if etype is SyntaxError: |
|
1431 | if etype is SyntaxError: | |
1432 | # Though this won't be called by syntax errors in the input |
|
1432 | # Though this won't be called by syntax errors in the input | |
1433 | # line, there may be SyntaxError cases whith imported code. |
|
1433 | # line, there may be SyntaxError cases whith imported code. | |
1434 | self.showsyntaxerror(filename) |
|
1434 | self.showsyntaxerror(filename) | |
1435 | elif etype is UsageError: |
|
1435 | elif etype is UsageError: | |
1436 | print "UsageError:", value |
|
1436 | print "UsageError:", value | |
1437 | else: |
|
1437 | else: | |
1438 | # WARNING: these variables are somewhat deprecated and not |
|
1438 | # WARNING: these variables are somewhat deprecated and not | |
1439 | # necessarily safe to use in a threaded environment, but tools |
|
1439 | # necessarily safe to use in a threaded environment, but tools | |
1440 | # like pdb depend on their existence, so let's set them. If we |
|
1440 | # like pdb depend on their existence, so let's set them. If we | |
1441 | # find problems in the field, we'll need to revisit their use. |
|
1441 | # find problems in the field, we'll need to revisit their use. | |
1442 | sys.last_type = etype |
|
1442 | sys.last_type = etype | |
1443 | sys.last_value = value |
|
1443 | sys.last_value = value | |
1444 | sys.last_traceback = tb |
|
1444 | sys.last_traceback = tb | |
1445 | if etype in self.custom_exceptions: |
|
1445 | if etype in self.custom_exceptions: | |
1446 | # FIXME: Old custom traceback objects may just return a |
|
1446 | # FIXME: Old custom traceback objects may just return a | |
1447 | # string, in that case we just put it into a list |
|
1447 | # string, in that case we just put it into a list | |
1448 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1448 | stb = self.CustomTB(etype, value, tb, tb_offset) | |
1449 | if isinstance(ctb, basestring): |
|
1449 | if isinstance(ctb, basestring): | |
1450 | stb = [stb] |
|
1450 | stb = [stb] | |
1451 | else: |
|
1451 | else: | |
1452 | if exception_only: |
|
1452 | if exception_only: | |
1453 | stb = ['An exception has occurred, use %tb to see ' |
|
1453 | stb = ['An exception has occurred, use %tb to see ' | |
1454 | 'the full traceback.\n'] |
|
1454 | 'the full traceback.\n'] | |
1455 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1455 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1456 | value)) |
|
1456 | value)) | |
1457 | else: |
|
1457 | else: | |
1458 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1458 | stb = self.InteractiveTB.structured_traceback(etype, | |
1459 | value, tb, tb_offset=tb_offset) |
|
1459 | value, tb, tb_offset=tb_offset) | |
1460 |
|
1460 | |||
1461 | if self.call_pdb: |
|
1461 | if self.call_pdb: | |
1462 | # drop into debugger |
|
1462 | # drop into debugger | |
1463 | self.debugger(force=True) |
|
1463 | self.debugger(force=True) | |
1464 |
|
1464 | |||
1465 | # Actually show the traceback |
|
1465 | # Actually show the traceback | |
1466 | self._showtraceback(etype, value, stb) |
|
1466 | self._showtraceback(etype, value, stb) | |
1467 |
|
1467 | |||
1468 | except KeyboardInterrupt: |
|
1468 | except KeyboardInterrupt: | |
1469 | self.write_err("\nKeyboardInterrupt\n") |
|
1469 | self.write_err("\nKeyboardInterrupt\n") | |
1470 |
|
1470 | |||
1471 | def _showtraceback(self, etype, evalue, stb): |
|
1471 | def _showtraceback(self, etype, evalue, stb): | |
1472 | """Actually show a traceback. |
|
1472 | """Actually show a traceback. | |
1473 |
|
1473 | |||
1474 | Subclasses may override this method to put the traceback on a different |
|
1474 | Subclasses may override this method to put the traceback on a different | |
1475 | place, like a side channel. |
|
1475 | place, like a side channel. | |
1476 | """ |
|
1476 | """ | |
1477 | print >> io.Term.cout, self.InteractiveTB.stb2text(stb) |
|
1477 | print >> io.Term.cout, self.InteractiveTB.stb2text(stb) | |
1478 |
|
1478 | |||
1479 | def showsyntaxerror(self, filename=None): |
|
1479 | def showsyntaxerror(self, filename=None): | |
1480 | """Display the syntax error that just occurred. |
|
1480 | """Display the syntax error that just occurred. | |
1481 |
|
1481 | |||
1482 | This doesn't display a stack trace because there isn't one. |
|
1482 | This doesn't display a stack trace because there isn't one. | |
1483 |
|
1483 | |||
1484 | If a filename is given, it is stuffed in the exception instead |
|
1484 | If a filename is given, it is stuffed in the exception instead | |
1485 | of what was there before (because Python's parser always uses |
|
1485 | of what was there before (because Python's parser always uses | |
1486 | "<string>" when reading from a string). |
|
1486 | "<string>" when reading from a string). | |
1487 | """ |
|
1487 | """ | |
1488 | etype, value, last_traceback = sys.exc_info() |
|
1488 | etype, value, last_traceback = sys.exc_info() | |
1489 |
|
1489 | |||
1490 | # See note about these variables in showtraceback() above |
|
1490 | # See note about these variables in showtraceback() above | |
1491 | sys.last_type = etype |
|
1491 | sys.last_type = etype | |
1492 | sys.last_value = value |
|
1492 | sys.last_value = value | |
1493 | sys.last_traceback = last_traceback |
|
1493 | sys.last_traceback = last_traceback | |
1494 |
|
1494 | |||
1495 | if filename and etype is SyntaxError: |
|
1495 | if filename and etype is SyntaxError: | |
1496 | # Work hard to stuff the correct filename in the exception |
|
1496 | # Work hard to stuff the correct filename in the exception | |
1497 | try: |
|
1497 | try: | |
1498 | msg, (dummy_filename, lineno, offset, line) = value |
|
1498 | msg, (dummy_filename, lineno, offset, line) = value | |
1499 | except: |
|
1499 | except: | |
1500 | # Not the format we expect; leave it alone |
|
1500 | # Not the format we expect; leave it alone | |
1501 | pass |
|
1501 | pass | |
1502 | else: |
|
1502 | else: | |
1503 | # Stuff in the right filename |
|
1503 | # Stuff in the right filename | |
1504 | try: |
|
1504 | try: | |
1505 | # Assume SyntaxError is a class exception |
|
1505 | # Assume SyntaxError is a class exception | |
1506 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1506 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1507 | except: |
|
1507 | except: | |
1508 | # If that failed, assume SyntaxError is a string |
|
1508 | # If that failed, assume SyntaxError is a string | |
1509 | value = msg, (filename, lineno, offset, line) |
|
1509 | value = msg, (filename, lineno, offset, line) | |
1510 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1510 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1511 | self._showtraceback(etype, value, stb) |
|
1511 | self._showtraceback(etype, value, stb) | |
1512 |
|
1512 | |||
1513 | #------------------------------------------------------------------------- |
|
1513 | #------------------------------------------------------------------------- | |
1514 | # Things related to readline |
|
1514 | # Things related to readline | |
1515 | #------------------------------------------------------------------------- |
|
1515 | #------------------------------------------------------------------------- | |
1516 |
|
1516 | |||
1517 | def init_readline(self): |
|
1517 | def init_readline(self): | |
1518 | """Command history completion/saving/reloading.""" |
|
1518 | """Command history completion/saving/reloading.""" | |
1519 |
|
1519 | |||
1520 | if self.readline_use: |
|
1520 | if self.readline_use: | |
1521 | import IPython.utils.rlineimpl as readline |
|
1521 | import IPython.utils.rlineimpl as readline | |
1522 |
|
1522 | |||
1523 | self.rl_next_input = None |
|
1523 | self.rl_next_input = None | |
1524 | self.rl_do_indent = False |
|
1524 | self.rl_do_indent = False | |
1525 |
|
1525 | |||
1526 | if not self.readline_use or not readline.have_readline: |
|
1526 | if not self.readline_use or not readline.have_readline: | |
1527 | self.has_readline = False |
|
1527 | self.has_readline = False | |
1528 | self.readline = None |
|
1528 | self.readline = None | |
1529 | # Set a number of methods that depend on readline to be no-op |
|
1529 | # Set a number of methods that depend on readline to be no-op | |
1530 | self.set_readline_completer = no_op |
|
1530 | self.set_readline_completer = no_op | |
1531 | self.set_custom_completer = no_op |
|
1531 | self.set_custom_completer = no_op | |
1532 | self.set_completer_frame = no_op |
|
1532 | self.set_completer_frame = no_op | |
1533 | warn('Readline services not available or not loaded.') |
|
1533 | warn('Readline services not available or not loaded.') | |
1534 | else: |
|
1534 | else: | |
1535 | self.has_readline = True |
|
1535 | self.has_readline = True | |
1536 | self.readline = readline |
|
1536 | self.readline = readline | |
1537 | sys.modules['readline'] = readline |
|
1537 | sys.modules['readline'] = readline | |
1538 |
|
1538 | |||
1539 | # Platform-specific configuration |
|
1539 | # Platform-specific configuration | |
1540 | if os.name == 'nt': |
|
1540 | if os.name == 'nt': | |
1541 | # FIXME - check with Frederick to see if we can harmonize |
|
1541 | # FIXME - check with Frederick to see if we can harmonize | |
1542 | # naming conventions with pyreadline to avoid this |
|
1542 | # naming conventions with pyreadline to avoid this | |
1543 | # platform-dependent check |
|
1543 | # platform-dependent check | |
1544 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1544 | self.readline_startup_hook = readline.set_pre_input_hook | |
1545 | else: |
|
1545 | else: | |
1546 | self.readline_startup_hook = readline.set_startup_hook |
|
1546 | self.readline_startup_hook = readline.set_startup_hook | |
1547 |
|
1547 | |||
1548 | # Load user's initrc file (readline config) |
|
1548 | # Load user's initrc file (readline config) | |
1549 | # Or if libedit is used, load editrc. |
|
1549 | # Or if libedit is used, load editrc. | |
1550 | inputrc_name = os.environ.get('INPUTRC') |
|
1550 | inputrc_name = os.environ.get('INPUTRC') | |
1551 | if inputrc_name is None: |
|
1551 | if inputrc_name is None: | |
1552 | home_dir = get_home_dir() |
|
1552 | home_dir = get_home_dir() | |
1553 | if home_dir is not None: |
|
1553 | if home_dir is not None: | |
1554 | inputrc_name = '.inputrc' |
|
1554 | inputrc_name = '.inputrc' | |
1555 | if readline.uses_libedit: |
|
1555 | if readline.uses_libedit: | |
1556 | inputrc_name = '.editrc' |
|
1556 | inputrc_name = '.editrc' | |
1557 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1557 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1558 | if os.path.isfile(inputrc_name): |
|
1558 | if os.path.isfile(inputrc_name): | |
1559 | try: |
|
1559 | try: | |
1560 | readline.read_init_file(inputrc_name) |
|
1560 | readline.read_init_file(inputrc_name) | |
1561 | except: |
|
1561 | except: | |
1562 | warn('Problems reading readline initialization file <%s>' |
|
1562 | warn('Problems reading readline initialization file <%s>' | |
1563 | % inputrc_name) |
|
1563 | % inputrc_name) | |
1564 |
|
1564 | |||
1565 | # Configure readline according to user's prefs |
|
1565 | # Configure readline according to user's prefs | |
1566 | # This is only done if GNU readline is being used. If libedit |
|
1566 | # This is only done if GNU readline is being used. If libedit | |
1567 | # is being used (as on Leopard) the readline config is |
|
1567 | # is being used (as on Leopard) the readline config is | |
1568 | # not run as the syntax for libedit is different. |
|
1568 | # not run as the syntax for libedit is different. | |
1569 | if not readline.uses_libedit: |
|
1569 | if not readline.uses_libedit: | |
1570 | for rlcommand in self.readline_parse_and_bind: |
|
1570 | for rlcommand in self.readline_parse_and_bind: | |
1571 | #print "loading rl:",rlcommand # dbg |
|
1571 | #print "loading rl:",rlcommand # dbg | |
1572 | readline.parse_and_bind(rlcommand) |
|
1572 | readline.parse_and_bind(rlcommand) | |
1573 |
|
1573 | |||
1574 | # Remove some chars from the delimiters list. If we encounter |
|
1574 | # Remove some chars from the delimiters list. If we encounter | |
1575 | # unicode chars, discard them. |
|
1575 | # unicode chars, discard them. | |
1576 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1576 | delims = readline.get_completer_delims().encode("ascii", "ignore") | |
1577 | delims = delims.translate(None, self.readline_remove_delims) |
|
1577 | delims = delims.translate(None, self.readline_remove_delims) | |
1578 | delims = delims.replace(ESC_MAGIC, '') |
|
1578 | delims = delims.replace(ESC_MAGIC, '') | |
1579 | readline.set_completer_delims(delims) |
|
1579 | readline.set_completer_delims(delims) | |
1580 | # otherwise we end up with a monster history after a while: |
|
1580 | # otherwise we end up with a monster history after a while: | |
1581 | readline.set_history_length(self.history_length) |
|
1581 | readline.set_history_length(self.history_length) | |
1582 |
|
1582 | |||
1583 | self.refill_readline_hist() |
|
1583 | self.refill_readline_hist() | |
1584 | self.readline_no_record = ReadlineNoRecord(self) |
|
1584 | self.readline_no_record = ReadlineNoRecord(self) | |
1585 |
|
1585 | |||
1586 | # Configure auto-indent for all platforms |
|
1586 | # Configure auto-indent for all platforms | |
1587 | self.set_autoindent(self.autoindent) |
|
1587 | self.set_autoindent(self.autoindent) | |
1588 |
|
1588 | |||
1589 | def refill_readline_hist(self): |
|
1589 | def refill_readline_hist(self): | |
1590 | # Load the last 1000 lines from history |
|
1590 | # Load the last 1000 lines from history | |
1591 | self.readline.clear_history() |
|
1591 | self.readline.clear_history() | |
1592 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1592 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
1593 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1593 | for _, _, cell in self.history_manager.get_tail(1000, | |
1594 | include_latest=True): |
|
1594 | include_latest=True): | |
1595 | if cell.strip(): # Ignore blank lines |
|
1595 | if cell.strip(): # Ignore blank lines | |
1596 | for line in cell.splitlines(): |
|
1596 | for line in cell.splitlines(): | |
1597 | self.readline.add_history(line.encode(stdin_encoding)) |
|
1597 | self.readline.add_history(line.encode(stdin_encoding)) | |
1598 |
|
1598 | |||
1599 | def set_next_input(self, s): |
|
1599 | def set_next_input(self, s): | |
1600 | """ Sets the 'default' input string for the next command line. |
|
1600 | """ Sets the 'default' input string for the next command line. | |
1601 |
|
1601 | |||
1602 | Requires readline. |
|
1602 | Requires readline. | |
1603 |
|
1603 | |||
1604 | Example: |
|
1604 | Example: | |
1605 |
|
1605 | |||
1606 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1606 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1607 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1607 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1608 | """ |
|
1608 | """ | |
1609 |
|
1609 | |||
1610 | self.rl_next_input = s |
|
1610 | self.rl_next_input = s | |
1611 |
|
1611 | |||
1612 | # Maybe move this to the terminal subclass? |
|
1612 | # Maybe move this to the terminal subclass? | |
1613 | def pre_readline(self): |
|
1613 | def pre_readline(self): | |
1614 | """readline hook to be used at the start of each line. |
|
1614 | """readline hook to be used at the start of each line. | |
1615 |
|
1615 | |||
1616 | Currently it handles auto-indent only.""" |
|
1616 | Currently it handles auto-indent only.""" | |
1617 |
|
1617 | |||
1618 | if self.rl_do_indent: |
|
1618 | if self.rl_do_indent: | |
1619 | self.readline.insert_text(self._indent_current_str()) |
|
1619 | self.readline.insert_text(self._indent_current_str()) | |
1620 | if self.rl_next_input is not None: |
|
1620 | if self.rl_next_input is not None: | |
1621 | self.readline.insert_text(self.rl_next_input) |
|
1621 | self.readline.insert_text(self.rl_next_input) | |
1622 | self.rl_next_input = None |
|
1622 | self.rl_next_input = None | |
1623 |
|
1623 | |||
1624 | def _indent_current_str(self): |
|
1624 | def _indent_current_str(self): | |
1625 | """return the current level of indentation as a string""" |
|
1625 | """return the current level of indentation as a string""" | |
1626 | return self.input_splitter.indent_spaces * ' ' |
|
1626 | return self.input_splitter.indent_spaces * ' ' | |
1627 |
|
1627 | |||
1628 | #------------------------------------------------------------------------- |
|
1628 | #------------------------------------------------------------------------- | |
1629 | # Things related to text completion |
|
1629 | # Things related to text completion | |
1630 | #------------------------------------------------------------------------- |
|
1630 | #------------------------------------------------------------------------- | |
1631 |
|
1631 | |||
1632 | def init_completer(self): |
|
1632 | def init_completer(self): | |
1633 | """Initialize the completion machinery. |
|
1633 | """Initialize the completion machinery. | |
1634 |
|
1634 | |||
1635 | This creates completion machinery that can be used by client code, |
|
1635 | This creates completion machinery that can be used by client code, | |
1636 | either interactively in-process (typically triggered by the readline |
|
1636 | either interactively in-process (typically triggered by the readline | |
1637 | library), programatically (such as in test suites) or out-of-prcess |
|
1637 | library), programatically (such as in test suites) or out-of-prcess | |
1638 | (typically over the network by remote frontends). |
|
1638 | (typically over the network by remote frontends). | |
1639 | """ |
|
1639 | """ | |
1640 | from IPython.core.completer import IPCompleter |
|
1640 | from IPython.core.completer import IPCompleter | |
1641 | from IPython.core.completerlib import (module_completer, |
|
1641 | from IPython.core.completerlib import (module_completer, | |
1642 | magic_run_completer, cd_completer) |
|
1642 | magic_run_completer, cd_completer) | |
1643 |
|
1643 | |||
1644 | self.Completer = IPCompleter(self, |
|
1644 | self.Completer = IPCompleter(self, | |
1645 | self.user_ns, |
|
1645 | self.user_ns, | |
1646 | self.user_global_ns, |
|
1646 | self.user_global_ns, | |
1647 | self.readline_omit__names, |
|
1647 | self.readline_omit__names, | |
1648 | self.alias_manager.alias_table, |
|
1648 | self.alias_manager.alias_table, | |
1649 | self.has_readline) |
|
1649 | self.has_readline) | |
1650 |
|
1650 | |||
1651 | # Add custom completers to the basic ones built into IPCompleter |
|
1651 | # Add custom completers to the basic ones built into IPCompleter | |
1652 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1652 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1653 | self.strdispatchers['complete_command'] = sdisp |
|
1653 | self.strdispatchers['complete_command'] = sdisp | |
1654 | self.Completer.custom_completers = sdisp |
|
1654 | self.Completer.custom_completers = sdisp | |
1655 |
|
1655 | |||
1656 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1656 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1657 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1657 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1658 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1658 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1659 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1659 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1660 |
|
1660 | |||
1661 | # Only configure readline if we truly are using readline. IPython can |
|
1661 | # Only configure readline if we truly are using readline. IPython can | |
1662 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1662 | # do tab-completion over the network, in GUIs, etc, where readline | |
1663 | # itself may be absent |
|
1663 | # itself may be absent | |
1664 | if self.has_readline: |
|
1664 | if self.has_readline: | |
1665 | self.set_readline_completer() |
|
1665 | self.set_readline_completer() | |
1666 |
|
1666 | |||
1667 | def complete(self, text, line=None, cursor_pos=None): |
|
1667 | def complete(self, text, line=None, cursor_pos=None): | |
1668 | """Return the completed text and a list of completions. |
|
1668 | """Return the completed text and a list of completions. | |
1669 |
|
1669 | |||
1670 | Parameters |
|
1670 | Parameters | |
1671 | ---------- |
|
1671 | ---------- | |
1672 |
|
1672 | |||
1673 | text : string |
|
1673 | text : string | |
1674 | A string of text to be completed on. It can be given as empty and |
|
1674 | A string of text to be completed on. It can be given as empty and | |
1675 | instead a line/position pair are given. In this case, the |
|
1675 | instead a line/position pair are given. In this case, the | |
1676 | completer itself will split the line like readline does. |
|
1676 | completer itself will split the line like readline does. | |
1677 |
|
1677 | |||
1678 | line : string, optional |
|
1678 | line : string, optional | |
1679 | The complete line that text is part of. |
|
1679 | The complete line that text is part of. | |
1680 |
|
1680 | |||
1681 | cursor_pos : int, optional |
|
1681 | cursor_pos : int, optional | |
1682 | The position of the cursor on the input line. |
|
1682 | The position of the cursor on the input line. | |
1683 |
|
1683 | |||
1684 | Returns |
|
1684 | Returns | |
1685 | ------- |
|
1685 | ------- | |
1686 | text : string |
|
1686 | text : string | |
1687 | The actual text that was completed. |
|
1687 | The actual text that was completed. | |
1688 |
|
1688 | |||
1689 | matches : list |
|
1689 | matches : list | |
1690 | A sorted list with all possible completions. |
|
1690 | A sorted list with all possible completions. | |
1691 |
|
1691 | |||
1692 | The optional arguments allow the completion to take more context into |
|
1692 | The optional arguments allow the completion to take more context into | |
1693 | account, and are part of the low-level completion API. |
|
1693 | account, and are part of the low-level completion API. | |
1694 |
|
1694 | |||
1695 | This is a wrapper around the completion mechanism, similar to what |
|
1695 | This is a wrapper around the completion mechanism, similar to what | |
1696 | readline does at the command line when the TAB key is hit. By |
|
1696 | readline does at the command line when the TAB key is hit. By | |
1697 | exposing it as a method, it can be used by other non-readline |
|
1697 | exposing it as a method, it can be used by other non-readline | |
1698 | environments (such as GUIs) for text completion. |
|
1698 | environments (such as GUIs) for text completion. | |
1699 |
|
1699 | |||
1700 | Simple usage example: |
|
1700 | Simple usage example: | |
1701 |
|
1701 | |||
1702 | In [1]: x = 'hello' |
|
1702 | In [1]: x = 'hello' | |
1703 |
|
1703 | |||
1704 | In [2]: _ip.complete('x.l') |
|
1704 | In [2]: _ip.complete('x.l') | |
1705 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1705 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
1706 | """ |
|
1706 | """ | |
1707 |
|
1707 | |||
1708 | # Inject names into __builtin__ so we can complete on the added names. |
|
1708 | # Inject names into __builtin__ so we can complete on the added names. | |
1709 | with self.builtin_trap: |
|
1709 | with self.builtin_trap: | |
1710 | return self.Completer.complete(text, line, cursor_pos) |
|
1710 | return self.Completer.complete(text, line, cursor_pos) | |
1711 |
|
1711 | |||
1712 | def set_custom_completer(self, completer, pos=0): |
|
1712 | def set_custom_completer(self, completer, pos=0): | |
1713 | """Adds a new custom completer function. |
|
1713 | """Adds a new custom completer function. | |
1714 |
|
1714 | |||
1715 | The position argument (defaults to 0) is the index in the completers |
|
1715 | The position argument (defaults to 0) is the index in the completers | |
1716 | list where you want the completer to be inserted.""" |
|
1716 | list where you want the completer to be inserted.""" | |
1717 |
|
1717 | |||
1718 | newcomp = types.MethodType(completer,self.Completer) |
|
1718 | newcomp = types.MethodType(completer,self.Completer) | |
1719 | self.Completer.matchers.insert(pos,newcomp) |
|
1719 | self.Completer.matchers.insert(pos,newcomp) | |
1720 |
|
1720 | |||
1721 | def set_readline_completer(self): |
|
1721 | def set_readline_completer(self): | |
1722 | """Reset readline's completer to be our own.""" |
|
1722 | """Reset readline's completer to be our own.""" | |
1723 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1723 | self.readline.set_completer(self.Completer.rlcomplete) | |
1724 |
|
1724 | |||
1725 | def set_completer_frame(self, frame=None): |
|
1725 | def set_completer_frame(self, frame=None): | |
1726 | """Set the frame of the completer.""" |
|
1726 | """Set the frame of the completer.""" | |
1727 | if frame: |
|
1727 | if frame: | |
1728 | self.Completer.namespace = frame.f_locals |
|
1728 | self.Completer.namespace = frame.f_locals | |
1729 | self.Completer.global_namespace = frame.f_globals |
|
1729 | self.Completer.global_namespace = frame.f_globals | |
1730 | else: |
|
1730 | else: | |
1731 | self.Completer.namespace = self.user_ns |
|
1731 | self.Completer.namespace = self.user_ns | |
1732 | self.Completer.global_namespace = self.user_global_ns |
|
1732 | self.Completer.global_namespace = self.user_global_ns | |
1733 |
|
1733 | |||
1734 | #------------------------------------------------------------------------- |
|
1734 | #------------------------------------------------------------------------- | |
1735 | # Things related to magics |
|
1735 | # Things related to magics | |
1736 | #------------------------------------------------------------------------- |
|
1736 | #------------------------------------------------------------------------- | |
1737 |
|
1737 | |||
1738 | def init_magics(self): |
|
1738 | def init_magics(self): | |
1739 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1739 | # FIXME: Move the color initialization to the DisplayHook, which | |
1740 | # should be split into a prompt manager and displayhook. We probably |
|
1740 | # should be split into a prompt manager and displayhook. We probably | |
1741 | # even need a centralize colors management object. |
|
1741 | # even need a centralize colors management object. | |
1742 | self.magic_colors(self.colors) |
|
1742 | self.magic_colors(self.colors) | |
1743 | # History was moved to a separate module |
|
1743 | # History was moved to a separate module | |
1744 | from . import history |
|
1744 | from . import history | |
1745 | history.init_ipython(self) |
|
1745 | history.init_ipython(self) | |
1746 |
|
1746 | |||
1747 | def magic(self,arg_s): |
|
1747 | def magic(self,arg_s): | |
1748 | """Call a magic function by name. |
|
1748 | """Call a magic function by name. | |
1749 |
|
1749 | |||
1750 | Input: a string containing the name of the magic function to call and |
|
1750 | Input: a string containing the name of the magic function to call and | |
1751 | any additional arguments to be passed to the magic. |
|
1751 | any additional arguments to be passed to the magic. | |
1752 |
|
1752 | |||
1753 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1753 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1754 | prompt: |
|
1754 | prompt: | |
1755 |
|
1755 | |||
1756 | In[1]: %name -opt foo bar |
|
1756 | In[1]: %name -opt foo bar | |
1757 |
|
1757 | |||
1758 | To call a magic without arguments, simply use magic('name'). |
|
1758 | To call a magic without arguments, simply use magic('name'). | |
1759 |
|
1759 | |||
1760 | This provides a proper Python function to call IPython's magics in any |
|
1760 | This provides a proper Python function to call IPython's magics in any | |
1761 | valid Python code you can type at the interpreter, including loops and |
|
1761 | valid Python code you can type at the interpreter, including loops and | |
1762 | compound statements. |
|
1762 | compound statements. | |
1763 | """ |
|
1763 | """ | |
1764 | args = arg_s.split(' ',1) |
|
1764 | args = arg_s.split(' ',1) | |
1765 | magic_name = args[0] |
|
1765 | magic_name = args[0] | |
1766 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1766 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1767 |
|
1767 | |||
1768 | try: |
|
1768 | try: | |
1769 | magic_args = args[1] |
|
1769 | magic_args = args[1] | |
1770 | except IndexError: |
|
1770 | except IndexError: | |
1771 | magic_args = '' |
|
1771 | magic_args = '' | |
1772 | fn = getattr(self,'magic_'+magic_name,None) |
|
1772 | fn = getattr(self,'magic_'+magic_name,None) | |
1773 | if fn is None: |
|
1773 | if fn is None: | |
1774 | error("Magic function `%s` not found." % magic_name) |
|
1774 | error("Magic function `%s` not found." % magic_name) | |
1775 | else: |
|
1775 | else: | |
1776 | magic_args = self.var_expand(magic_args,1) |
|
1776 | magic_args = self.var_expand(magic_args,1) | |
1777 | # Grab local namespace if we need it: |
|
1777 | # Grab local namespace if we need it: | |
1778 | if getattr(fn, "needs_local_scope", False): |
|
1778 | if getattr(fn, "needs_local_scope", False): | |
1779 | self._magic_locals = sys._getframe(1).f_locals |
|
1779 | self._magic_locals = sys._getframe(1).f_locals | |
1780 | with nested(self.builtin_trap,): |
|
1780 | with nested(self.builtin_trap,): | |
1781 | result = fn(magic_args) |
|
1781 | result = fn(magic_args) | |
1782 | # Ensure we're not keeping object references around: |
|
1782 | # Ensure we're not keeping object references around: | |
1783 | self._magic_locals = {} |
|
1783 | self._magic_locals = {} | |
1784 | return result |
|
1784 | return result | |
1785 |
|
1785 | |||
1786 | def define_magic(self, magicname, func): |
|
1786 | def define_magic(self, magicname, func): | |
1787 | """Expose own function as magic function for ipython |
|
1787 | """Expose own function as magic function for ipython | |
1788 |
|
1788 | |||
1789 | def foo_impl(self,parameter_s=''): |
|
1789 | def foo_impl(self,parameter_s=''): | |
1790 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
1790 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
1791 | print 'Magic function. Passed parameter is between < >:' |
|
1791 | print 'Magic function. Passed parameter is between < >:' | |
1792 | print '<%s>' % parameter_s |
|
1792 | print '<%s>' % parameter_s | |
1793 | print 'The self object is:',self |
|
1793 | print 'The self object is:',self | |
1794 |
|
1794 | |||
1795 | self.define_magic('foo',foo_impl) |
|
1795 | self.define_magic('foo',foo_impl) | |
1796 | """ |
|
1796 | """ | |
1797 |
|
1797 | |||
1798 | import new |
|
1798 | import new | |
1799 | im = types.MethodType(func,self) |
|
1799 | im = types.MethodType(func,self) | |
1800 | old = getattr(self, "magic_" + magicname, None) |
|
1800 | old = getattr(self, "magic_" + magicname, None) | |
1801 | setattr(self, "magic_" + magicname, im) |
|
1801 | setattr(self, "magic_" + magicname, im) | |
1802 | return old |
|
1802 | return old | |
1803 |
|
1803 | |||
1804 | #------------------------------------------------------------------------- |
|
1804 | #------------------------------------------------------------------------- | |
1805 | # Things related to macros |
|
1805 | # Things related to macros | |
1806 | #------------------------------------------------------------------------- |
|
1806 | #------------------------------------------------------------------------- | |
1807 |
|
1807 | |||
1808 | def define_macro(self, name, themacro): |
|
1808 | def define_macro(self, name, themacro): | |
1809 | """Define a new macro |
|
1809 | """Define a new macro | |
1810 |
|
1810 | |||
1811 | Parameters |
|
1811 | Parameters | |
1812 | ---------- |
|
1812 | ---------- | |
1813 | name : str |
|
1813 | name : str | |
1814 | The name of the macro. |
|
1814 | The name of the macro. | |
1815 | themacro : str or Macro |
|
1815 | themacro : str or Macro | |
1816 | The action to do upon invoking the macro. If a string, a new |
|
1816 | The action to do upon invoking the macro. If a string, a new | |
1817 | Macro object is created by passing the string to it. |
|
1817 | Macro object is created by passing the string to it. | |
1818 | """ |
|
1818 | """ | |
1819 |
|
1819 | |||
1820 | from IPython.core import macro |
|
1820 | from IPython.core import macro | |
1821 |
|
1821 | |||
1822 | if isinstance(themacro, basestring): |
|
1822 | if isinstance(themacro, basestring): | |
1823 | themacro = macro.Macro(themacro) |
|
1823 | themacro = macro.Macro(themacro) | |
1824 | if not isinstance(themacro, macro.Macro): |
|
1824 | if not isinstance(themacro, macro.Macro): | |
1825 | raise ValueError('A macro must be a string or a Macro instance.') |
|
1825 | raise ValueError('A macro must be a string or a Macro instance.') | |
1826 | self.user_ns[name] = themacro |
|
1826 | self.user_ns[name] = themacro | |
1827 |
|
1827 | |||
1828 | #------------------------------------------------------------------------- |
|
1828 | #------------------------------------------------------------------------- | |
1829 | # Things related to the running of system commands |
|
1829 | # Things related to the running of system commands | |
1830 | #------------------------------------------------------------------------- |
|
1830 | #------------------------------------------------------------------------- | |
1831 |
|
1831 | |||
1832 | def system(self, cmd): |
|
1832 | def system(self, cmd): | |
1833 | """Call the given cmd in a subprocess. |
|
1833 | """Call the given cmd in a subprocess. | |
1834 |
|
1834 | |||
1835 | Parameters |
|
1835 | Parameters | |
1836 | ---------- |
|
1836 | ---------- | |
1837 | cmd : str |
|
1837 | cmd : str | |
1838 | Command to execute (can not end in '&', as bacground processes are |
|
1838 | Command to execute (can not end in '&', as bacground processes are | |
1839 | not supported. |
|
1839 | not supported. | |
1840 | """ |
|
1840 | """ | |
1841 | # We do not support backgrounding processes because we either use |
|
1841 | # We do not support backgrounding processes because we either use | |
1842 | # pexpect or pipes to read from. Users can always just call |
|
1842 | # pexpect or pipes to read from. Users can always just call | |
1843 | # os.system() if they really want a background process. |
|
1843 | # os.system() if they really want a background process. | |
1844 | if cmd.endswith('&'): |
|
1844 | if cmd.endswith('&'): | |
1845 | raise OSError("Background processes not supported.") |
|
1845 | raise OSError("Background processes not supported.") | |
1846 |
|
1846 | |||
1847 | return system(self.var_expand(cmd, depth=2)) |
|
1847 | return system(self.var_expand(cmd, depth=2)) | |
1848 |
|
1848 | |||
1849 | def getoutput(self, cmd, split=True): |
|
1849 | def getoutput(self, cmd, split=True): | |
1850 | """Get output (possibly including stderr) from a subprocess. |
|
1850 | """Get output (possibly including stderr) from a subprocess. | |
1851 |
|
1851 | |||
1852 | Parameters |
|
1852 | Parameters | |
1853 | ---------- |
|
1853 | ---------- | |
1854 | cmd : str |
|
1854 | cmd : str | |
1855 | Command to execute (can not end in '&', as background processes are |
|
1855 | Command to execute (can not end in '&', as background processes are | |
1856 | not supported. |
|
1856 | not supported. | |
1857 | split : bool, optional |
|
1857 | split : bool, optional | |
1858 |
|
1858 | |||
1859 | If True, split the output into an IPython SList. Otherwise, an |
|
1859 | If True, split the output into an IPython SList. Otherwise, an | |
1860 | IPython LSString is returned. These are objects similar to normal |
|
1860 | IPython LSString is returned. These are objects similar to normal | |
1861 | lists and strings, with a few convenience attributes for easier |
|
1861 | lists and strings, with a few convenience attributes for easier | |
1862 | manipulation of line-based output. You can use '?' on them for |
|
1862 | manipulation of line-based output. You can use '?' on them for | |
1863 | details. |
|
1863 | details. | |
1864 | """ |
|
1864 | """ | |
1865 | if cmd.endswith('&'): |
|
1865 | if cmd.endswith('&'): | |
1866 | raise OSError("Background processes not supported.") |
|
1866 | raise OSError("Background processes not supported.") | |
1867 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
1867 | out = getoutput(self.var_expand(cmd, depth=2)) | |
1868 | if split: |
|
1868 | if split: | |
1869 | out = SList(out.splitlines()) |
|
1869 | out = SList(out.splitlines()) | |
1870 | else: |
|
1870 | else: | |
1871 | out = LSString(out) |
|
1871 | out = LSString(out) | |
1872 | return out |
|
1872 | return out | |
1873 |
|
1873 | |||
1874 | #------------------------------------------------------------------------- |
|
1874 | #------------------------------------------------------------------------- | |
1875 | # Things related to aliases |
|
1875 | # Things related to aliases | |
1876 | #------------------------------------------------------------------------- |
|
1876 | #------------------------------------------------------------------------- | |
1877 |
|
1877 | |||
1878 | def init_alias(self): |
|
1878 | def init_alias(self): | |
1879 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
1879 | self.alias_manager = AliasManager(shell=self, config=self.config) | |
1880 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
1880 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
1881 |
|
1881 | |||
1882 | #------------------------------------------------------------------------- |
|
1882 | #------------------------------------------------------------------------- | |
1883 | # Things related to extensions and plugins |
|
1883 | # Things related to extensions and plugins | |
1884 | #------------------------------------------------------------------------- |
|
1884 | #------------------------------------------------------------------------- | |
1885 |
|
1885 | |||
1886 | def init_extension_manager(self): |
|
1886 | def init_extension_manager(self): | |
1887 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
1887 | self.extension_manager = ExtensionManager(shell=self, config=self.config) | |
1888 |
|
1888 | |||
1889 | def init_plugin_manager(self): |
|
1889 | def init_plugin_manager(self): | |
1890 | self.plugin_manager = PluginManager(config=self.config) |
|
1890 | self.plugin_manager = PluginManager(config=self.config) | |
1891 |
|
1891 | |||
1892 | #------------------------------------------------------------------------- |
|
1892 | #------------------------------------------------------------------------- | |
1893 | # Things related to payloads |
|
1893 | # Things related to payloads | |
1894 | #------------------------------------------------------------------------- |
|
1894 | #------------------------------------------------------------------------- | |
1895 |
|
1895 | |||
1896 | def init_payload(self): |
|
1896 | def init_payload(self): | |
1897 | self.payload_manager = PayloadManager(config=self.config) |
|
1897 | self.payload_manager = PayloadManager(config=self.config) | |
1898 |
|
1898 | |||
1899 | #------------------------------------------------------------------------- |
|
1899 | #------------------------------------------------------------------------- | |
1900 | # Things related to the prefilter |
|
1900 | # Things related to the prefilter | |
1901 | #------------------------------------------------------------------------- |
|
1901 | #------------------------------------------------------------------------- | |
1902 |
|
1902 | |||
1903 | def init_prefilter(self): |
|
1903 | def init_prefilter(self): | |
1904 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
1904 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) | |
1905 | # Ultimately this will be refactored in the new interpreter code, but |
|
1905 | # Ultimately this will be refactored in the new interpreter code, but | |
1906 | # for now, we should expose the main prefilter method (there's legacy |
|
1906 | # for now, we should expose the main prefilter method (there's legacy | |
1907 | # code out there that may rely on this). |
|
1907 | # code out there that may rely on this). | |
1908 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
1908 | self.prefilter = self.prefilter_manager.prefilter_lines | |
1909 |
|
1909 | |||
1910 | def auto_rewrite_input(self, cmd): |
|
1910 | def auto_rewrite_input(self, cmd): | |
1911 | """Print to the screen the rewritten form of the user's command. |
|
1911 | """Print to the screen the rewritten form of the user's command. | |
1912 |
|
1912 | |||
1913 | This shows visual feedback by rewriting input lines that cause |
|
1913 | This shows visual feedback by rewriting input lines that cause | |
1914 | automatic calling to kick in, like:: |
|
1914 | automatic calling to kick in, like:: | |
1915 |
|
1915 | |||
1916 | /f x |
|
1916 | /f x | |
1917 |
|
1917 | |||
1918 | into:: |
|
1918 | into:: | |
1919 |
|
1919 | |||
1920 | ------> f(x) |
|
1920 | ------> f(x) | |
1921 |
|
1921 | |||
1922 | after the user's input prompt. This helps the user understand that the |
|
1922 | after the user's input prompt. This helps the user understand that the | |
1923 | input line was transformed automatically by IPython. |
|
1923 | input line was transformed automatically by IPython. | |
1924 | """ |
|
1924 | """ | |
1925 | rw = self.displayhook.prompt1.auto_rewrite() + cmd |
|
1925 | rw = self.displayhook.prompt1.auto_rewrite() + cmd | |
1926 |
|
1926 | |||
1927 | try: |
|
1927 | try: | |
1928 | # plain ascii works better w/ pyreadline, on some machines, so |
|
1928 | # plain ascii works better w/ pyreadline, on some machines, so | |
1929 | # we use it and only print uncolored rewrite if we have unicode |
|
1929 | # we use it and only print uncolored rewrite if we have unicode | |
1930 | rw = str(rw) |
|
1930 | rw = str(rw) | |
1931 | print >> IPython.utils.io.Term.cout, rw |
|
1931 | print >> IPython.utils.io.Term.cout, rw | |
1932 | except UnicodeEncodeError: |
|
1932 | except UnicodeEncodeError: | |
1933 | print "------> " + cmd |
|
1933 | print "------> " + cmd | |
1934 |
|
1934 | |||
1935 | #------------------------------------------------------------------------- |
|
1935 | #------------------------------------------------------------------------- | |
1936 | # Things related to extracting values/expressions from kernel and user_ns |
|
1936 | # Things related to extracting values/expressions from kernel and user_ns | |
1937 | #------------------------------------------------------------------------- |
|
1937 | #------------------------------------------------------------------------- | |
1938 |
|
1938 | |||
1939 | def _simple_error(self): |
|
1939 | def _simple_error(self): | |
1940 | etype, value = sys.exc_info()[:2] |
|
1940 | etype, value = sys.exc_info()[:2] | |
1941 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
1941 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) | |
1942 |
|
1942 | |||
1943 | def user_variables(self, names): |
|
1943 | def user_variables(self, names): | |
1944 | """Get a list of variable names from the user's namespace. |
|
1944 | """Get a list of variable names from the user's namespace. | |
1945 |
|
1945 | |||
1946 | Parameters |
|
1946 | Parameters | |
1947 | ---------- |
|
1947 | ---------- | |
1948 | names : list of strings |
|
1948 | names : list of strings | |
1949 | A list of names of variables to be read from the user namespace. |
|
1949 | A list of names of variables to be read from the user namespace. | |
1950 |
|
1950 | |||
1951 | Returns |
|
1951 | Returns | |
1952 | ------- |
|
1952 | ------- | |
1953 | A dict, keyed by the input names and with the repr() of each value. |
|
1953 | A dict, keyed by the input names and with the repr() of each value. | |
1954 | """ |
|
1954 | """ | |
1955 | out = {} |
|
1955 | out = {} | |
1956 | user_ns = self.user_ns |
|
1956 | user_ns = self.user_ns | |
1957 | for varname in names: |
|
1957 | for varname in names: | |
1958 | try: |
|
1958 | try: | |
1959 | value = repr(user_ns[varname]) |
|
1959 | value = repr(user_ns[varname]) | |
1960 | except: |
|
1960 | except: | |
1961 | value = self._simple_error() |
|
1961 | value = self._simple_error() | |
1962 | out[varname] = value |
|
1962 | out[varname] = value | |
1963 | return out |
|
1963 | return out | |
1964 |
|
1964 | |||
1965 | def user_expressions(self, expressions): |
|
1965 | def user_expressions(self, expressions): | |
1966 | """Evaluate a dict of expressions in the user's namespace. |
|
1966 | """Evaluate a dict of expressions in the user's namespace. | |
1967 |
|
1967 | |||
1968 | Parameters |
|
1968 | Parameters | |
1969 | ---------- |
|
1969 | ---------- | |
1970 | expressions : dict |
|
1970 | expressions : dict | |
1971 | A dict with string keys and string values. The expression values |
|
1971 | A dict with string keys and string values. The expression values | |
1972 | should be valid Python expressions, each of which will be evaluated |
|
1972 | should be valid Python expressions, each of which will be evaluated | |
1973 | in the user namespace. |
|
1973 | in the user namespace. | |
1974 |
|
1974 | |||
1975 | Returns |
|
1975 | Returns | |
1976 | ------- |
|
1976 | ------- | |
1977 | A dict, keyed like the input expressions dict, with the repr() of each |
|
1977 | A dict, keyed like the input expressions dict, with the repr() of each | |
1978 | value. |
|
1978 | value. | |
1979 | """ |
|
1979 | """ | |
1980 | out = {} |
|
1980 | out = {} | |
1981 | user_ns = self.user_ns |
|
1981 | user_ns = self.user_ns | |
1982 | global_ns = self.user_global_ns |
|
1982 | global_ns = self.user_global_ns | |
1983 | for key, expr in expressions.iteritems(): |
|
1983 | for key, expr in expressions.iteritems(): | |
1984 | try: |
|
1984 | try: | |
1985 | value = repr(eval(expr, global_ns, user_ns)) |
|
1985 | value = repr(eval(expr, global_ns, user_ns)) | |
1986 | except: |
|
1986 | except: | |
1987 | value = self._simple_error() |
|
1987 | value = self._simple_error() | |
1988 | out[key] = value |
|
1988 | out[key] = value | |
1989 | return out |
|
1989 | return out | |
1990 |
|
1990 | |||
1991 | #------------------------------------------------------------------------- |
|
1991 | #------------------------------------------------------------------------- | |
1992 | # Things related to the running of code |
|
1992 | # Things related to the running of code | |
1993 | #------------------------------------------------------------------------- |
|
1993 | #------------------------------------------------------------------------- | |
1994 |
|
1994 | |||
1995 | def ex(self, cmd): |
|
1995 | def ex(self, cmd): | |
1996 | """Execute a normal python statement in user namespace.""" |
|
1996 | """Execute a normal python statement in user namespace.""" | |
1997 | with nested(self.builtin_trap,): |
|
1997 | with nested(self.builtin_trap,): | |
1998 | exec cmd in self.user_global_ns, self.user_ns |
|
1998 | exec cmd in self.user_global_ns, self.user_ns | |
1999 |
|
1999 | |||
2000 | def ev(self, expr): |
|
2000 | def ev(self, expr): | |
2001 | """Evaluate python expression expr in user namespace. |
|
2001 | """Evaluate python expression expr in user namespace. | |
2002 |
|
2002 | |||
2003 | Returns the result of evaluation |
|
2003 | Returns the result of evaluation | |
2004 | """ |
|
2004 | """ | |
2005 | with nested(self.builtin_trap,): |
|
2005 | with nested(self.builtin_trap,): | |
2006 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2006 | return eval(expr, self.user_global_ns, self.user_ns) | |
2007 |
|
2007 | |||
2008 | def safe_execfile(self, fname, *where, **kw): |
|
2008 | def safe_execfile(self, fname, *where, **kw): | |
2009 | """A safe version of the builtin execfile(). |
|
2009 | """A safe version of the builtin execfile(). | |
2010 |
|
2010 | |||
2011 | This version will never throw an exception, but instead print |
|
2011 | This version will never throw an exception, but instead print | |
2012 | helpful error messages to the screen. This only works on pure |
|
2012 | helpful error messages to the screen. This only works on pure | |
2013 | Python files with the .py extension. |
|
2013 | Python files with the .py extension. | |
2014 |
|
2014 | |||
2015 | Parameters |
|
2015 | Parameters | |
2016 | ---------- |
|
2016 | ---------- | |
2017 | fname : string |
|
2017 | fname : string | |
2018 | The name of the file to be executed. |
|
2018 | The name of the file to be executed. | |
2019 | where : tuple |
|
2019 | where : tuple | |
2020 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2020 | One or two namespaces, passed to execfile() as (globals,locals). | |
2021 | If only one is given, it is passed as both. |
|
2021 | If only one is given, it is passed as both. | |
2022 | exit_ignore : bool (False) |
|
2022 | exit_ignore : bool (False) | |
2023 | If True, then silence SystemExit for non-zero status (it is always |
|
2023 | If True, then silence SystemExit for non-zero status (it is always | |
2024 | silenced for zero status, as it is so common). |
|
2024 | silenced for zero status, as it is so common). | |
2025 | """ |
|
2025 | """ | |
2026 | kw.setdefault('exit_ignore', False) |
|
2026 | kw.setdefault('exit_ignore', False) | |
2027 |
|
2027 | |||
2028 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2028 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2029 | # Make sure we have a .py file |
|
2029 | # Make sure we have a .py file | |
2030 | if not fname.endswith('.py'): |
|
2030 | if not fname.endswith('.py'): | |
2031 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2031 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
2032 |
|
2032 | |||
2033 | # Make sure we can open the file |
|
2033 | # Make sure we can open the file | |
2034 | try: |
|
2034 | try: | |
2035 | with open(fname) as thefile: |
|
2035 | with open(fname) as thefile: | |
2036 | pass |
|
2036 | pass | |
2037 | except: |
|
2037 | except: | |
2038 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2038 | warn('Could not open file <%s> for safe execution.' % fname) | |
2039 | return |
|
2039 | return | |
2040 |
|
2040 | |||
2041 | # Find things also in current directory. This is needed to mimic the |
|
2041 | # Find things also in current directory. This is needed to mimic the | |
2042 | # behavior of running a script from the system command line, where |
|
2042 | # behavior of running a script from the system command line, where | |
2043 | # Python inserts the script's directory into sys.path |
|
2043 | # Python inserts the script's directory into sys.path | |
2044 | dname = os.path.dirname(fname) |
|
2044 | dname = os.path.dirname(fname) | |
2045 |
|
2045 | |||
2046 | if isinstance(fname, unicode): |
|
2046 | if isinstance(fname, unicode): | |
2047 | # execfile uses default encoding instead of filesystem encoding |
|
2047 | # execfile uses default encoding instead of filesystem encoding | |
2048 | # so unicode filenames will fail |
|
2048 | # so unicode filenames will fail | |
2049 | fname = fname.encode(sys.getfilesystemencoding() or sys.getdefaultencoding()) |
|
2049 | fname = fname.encode(sys.getfilesystemencoding() or sys.getdefaultencoding()) | |
2050 |
|
2050 | |||
2051 | with prepended_to_syspath(dname): |
|
2051 | with prepended_to_syspath(dname): | |
2052 | try: |
|
2052 | try: | |
2053 | execfile(fname,*where) |
|
2053 | execfile(fname,*where) | |
2054 | except SystemExit, status: |
|
2054 | except SystemExit, status: | |
2055 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2055 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2056 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2056 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2057 | # these are considered normal by the OS: |
|
2057 | # these are considered normal by the OS: | |
2058 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2058 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2059 | # 0 |
|
2059 | # 0 | |
2060 | # > python -c'import sys;sys.exit()'; echo $? |
|
2060 | # > python -c'import sys;sys.exit()'; echo $? | |
2061 | # 0 |
|
2061 | # 0 | |
2062 | # For other exit status, we show the exception unless |
|
2062 | # For other exit status, we show the exception unless | |
2063 | # explicitly silenced, but only in short form. |
|
2063 | # explicitly silenced, but only in short form. | |
2064 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2064 | if status.code not in (0, None) and not kw['exit_ignore']: | |
2065 | self.showtraceback(exception_only=True) |
|
2065 | self.showtraceback(exception_only=True) | |
2066 | except: |
|
2066 | except: | |
2067 | self.showtraceback() |
|
2067 | self.showtraceback() | |
2068 |
|
2068 | |||
2069 | def safe_execfile_ipy(self, fname): |
|
2069 | def safe_execfile_ipy(self, fname): | |
2070 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2070 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
2071 |
|
2071 | |||
2072 | Parameters |
|
2072 | Parameters | |
2073 | ---------- |
|
2073 | ---------- | |
2074 | fname : str |
|
2074 | fname : str | |
2075 | The name of the file to execute. The filename must have a |
|
2075 | The name of the file to execute. The filename must have a | |
2076 | .ipy extension. |
|
2076 | .ipy extension. | |
2077 | """ |
|
2077 | """ | |
2078 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2078 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2079 |
|
2079 | |||
2080 | # Make sure we have a .py file |
|
2080 | # Make sure we have a .py file | |
2081 | if not fname.endswith('.ipy'): |
|
2081 | if not fname.endswith('.ipy'): | |
2082 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2082 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
2083 |
|
2083 | |||
2084 | # Make sure we can open the file |
|
2084 | # Make sure we can open the file | |
2085 | try: |
|
2085 | try: | |
2086 | with open(fname) as thefile: |
|
2086 | with open(fname) as thefile: | |
2087 | pass |
|
2087 | pass | |
2088 | except: |
|
2088 | except: | |
2089 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2089 | warn('Could not open file <%s> for safe execution.' % fname) | |
2090 | return |
|
2090 | return | |
2091 |
|
2091 | |||
2092 | # Find things also in current directory. This is needed to mimic the |
|
2092 | # Find things also in current directory. This is needed to mimic the | |
2093 | # behavior of running a script from the system command line, where |
|
2093 | # behavior of running a script from the system command line, where | |
2094 | # Python inserts the script's directory into sys.path |
|
2094 | # Python inserts the script's directory into sys.path | |
2095 | dname = os.path.dirname(fname) |
|
2095 | dname = os.path.dirname(fname) | |
2096 |
|
2096 | |||
2097 | with prepended_to_syspath(dname): |
|
2097 | with prepended_to_syspath(dname): | |
2098 | try: |
|
2098 | try: | |
2099 | with open(fname) as thefile: |
|
2099 | with open(fname) as thefile: | |
2100 | # self.run_cell currently captures all exceptions |
|
2100 | # self.run_cell currently captures all exceptions | |
2101 | # raised in user code. It would be nice if there were |
|
2101 | # raised in user code. It would be nice if there were | |
2102 | # versions of runlines, execfile that did raise, so |
|
2102 | # versions of runlines, execfile that did raise, so | |
2103 | # we could catch the errors. |
|
2103 | # we could catch the errors. | |
2104 | self.run_cell(thefile.read(), store_history=False) |
|
2104 | self.run_cell(thefile.read(), store_history=False) | |
2105 | except: |
|
2105 | except: | |
2106 | self.showtraceback() |
|
2106 | self.showtraceback() | |
2107 | warn('Unknown failure executing file: <%s>' % fname) |
|
2107 | warn('Unknown failure executing file: <%s>' % fname) | |
2108 |
|
2108 | |||
2109 | def run_cell(self, cell, store_history=True): |
|
2109 | def run_cell(self, cell, store_history=True): | |
2110 | """Run a complete IPython cell. |
|
2110 | """Run a complete IPython cell. | |
2111 |
|
2111 | |||
2112 | Parameters |
|
2112 | Parameters | |
2113 | ---------- |
|
2113 | ---------- | |
2114 | cell : str |
|
2114 | cell : str | |
2115 | The code (including IPython code such as %magic functions) to run. |
|
2115 | The code (including IPython code such as %magic functions) to run. | |
2116 | store_history : bool |
|
2116 | store_history : bool | |
2117 | If True, the raw and translated cell will be stored in IPython's |
|
2117 | If True, the raw and translated cell will be stored in IPython's | |
2118 | history. For user code calling back into IPython's machinery, this |
|
2118 | history. For user code calling back into IPython's machinery, this | |
2119 | should be set to False. |
|
2119 | should be set to False. | |
2120 | """ |
|
2120 | """ | |
2121 | raw_cell = cell |
|
2121 | raw_cell = cell | |
2122 | with self.builtin_trap: |
|
2122 | with self.builtin_trap: | |
2123 | cell = self.prefilter_manager.prefilter_lines(cell) |
|
2123 | cell = self.prefilter_manager.prefilter_lines(cell) | |
2124 |
|
2124 | |||
2125 | # Store raw and processed history |
|
2125 | # Store raw and processed history | |
2126 | if store_history: |
|
2126 | if store_history: | |
2127 | self.history_manager.store_inputs(self.execution_count, |
|
2127 | self.history_manager.store_inputs(self.execution_count, | |
2128 | cell, raw_cell) |
|
2128 | cell, raw_cell) | |
2129 |
|
2129 | |||
2130 | self.logger.log(cell, raw_cell) |
|
2130 | self.logger.log(cell, raw_cell) | |
2131 |
|
2131 | |||
2132 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2132 | cell_name = self.compile.cache(cell, self.execution_count) | |
2133 |
|
2133 | |||
2134 | with self.display_trap: |
|
2134 | with self.display_trap: | |
2135 | try: |
|
2135 | try: | |
2136 | code_ast = ast.parse(cell, filename=cell_name) |
|
2136 | code_ast = ast.parse(cell, filename=cell_name) | |
2137 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2137 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2138 | # Case 1 |
|
2138 | # Case 1 | |
2139 | self.showsyntaxerror() |
|
2139 | self.showsyntaxerror() | |
2140 | self.execution_count += 1 |
|
2140 | self.execution_count += 1 | |
2141 | return None |
|
2141 | return None | |
2142 |
|
2142 | |||
2143 | interactivity = 'last' # Last node to be run interactive |
|
2143 | interactivity = 'last' # Last node to be run interactive | |
2144 | if len(cell.splitlines()) == 1: |
|
2144 | if len(cell.splitlines()) == 1: | |
2145 | interactivity = 'all' # Single line; run fully interactive |
|
2145 | interactivity = 'all' # Single line; run fully interactive | |
2146 |
|
2146 | |||
2147 | self.run_ast_nodes(code_ast.body, cell_name, interactivity) |
|
2147 | self.run_ast_nodes(code_ast.body, cell_name, interactivity) | |
2148 |
|
2148 | |||
2149 | if store_history: |
|
2149 | if store_history: | |
2150 | # Write output to the database. Does nothing unless |
|
2150 | # Write output to the database. Does nothing unless | |
2151 | # history output logging is enabled. |
|
2151 | # history output logging is enabled. | |
2152 | self.history_manager.store_output(self.execution_count) |
|
2152 | self.history_manager.store_output(self.execution_count) | |
2153 | # Each cell is a *single* input, regardless of how many lines it has |
|
2153 | # Each cell is a *single* input, regardless of how many lines it has | |
2154 | self.execution_count += 1 |
|
2154 | self.execution_count += 1 | |
2155 |
|
2155 | |||
2156 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last'): |
|
2156 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last'): | |
2157 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2157 | """Run a sequence of AST nodes. The execution mode depends on the | |
2158 | interactivity parameter. |
|
2158 | interactivity parameter. | |
2159 |
|
2159 | |||
2160 | Parameters |
|
2160 | Parameters | |
2161 | ---------- |
|
2161 | ---------- | |
2162 | nodelist : list |
|
2162 | nodelist : list | |
2163 | A sequence of AST nodes to run. |
|
2163 | A sequence of AST nodes to run. | |
2164 | cell_name : str |
|
2164 | cell_name : str | |
2165 | Will be passed to the compiler as the filename of the cell. Typically |
|
2165 | Will be passed to the compiler as the filename of the cell. Typically | |
2166 | the value returned by ip.compile.cache(cell). |
|
2166 | the value returned by ip.compile.cache(cell). | |
2167 | interactivity : str |
|
2167 | interactivity : str | |
2168 | 'all', 'last' or 'none', specifying which nodes should be run |
|
2168 | 'all', 'last' or 'none', specifying which nodes should be run | |
2169 | interactively (displaying output from expressions). Other values for |
|
2169 | interactively (displaying output from expressions). Other values for | |
2170 | this parameter will raise a ValueError. |
|
2170 | this parameter will raise a ValueError. | |
2171 | """ |
|
2171 | """ | |
2172 | if not nodelist: |
|
2172 | if not nodelist: | |
2173 | return |
|
2173 | return | |
2174 |
|
2174 | |||
2175 | if interactivity == 'none': |
|
2175 | if interactivity == 'none': | |
2176 | to_run_exec, to_run_interactive = nodelist, [] |
|
2176 | to_run_exec, to_run_interactive = nodelist, [] | |
2177 | elif interactivity == 'last': |
|
2177 | elif interactivity == 'last': | |
2178 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2178 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2179 | elif interactivity == 'all': |
|
2179 | elif interactivity == 'all': | |
2180 | to_run_exec, to_run_interactive = [], nodelist |
|
2180 | to_run_exec, to_run_interactive = [], nodelist | |
2181 | else: |
|
2181 | else: | |
2182 | raise ValueError("Interactivity was %r" % interactivity) |
|
2182 | raise ValueError("Interactivity was %r" % interactivity) | |
2183 |
|
2183 | |||
2184 | exec_count = self.execution_count |
|
2184 | exec_count = self.execution_count | |
2185 | if to_run_exec: |
|
2185 | if to_run_exec: | |
2186 | mod = ast.Module(to_run_exec) |
|
2186 | mod = ast.Module(to_run_exec) | |
2187 | self.code_to_run = code = self.compile(mod, cell_name, "exec") |
|
2187 | self.code_to_run = code = self.compile(mod, cell_name, "exec") | |
2188 | if self.run_code(code) == 1: |
|
2188 | if self.run_code(code) == 1: | |
2189 | return |
|
2189 | return | |
2190 |
|
2190 | |||
2191 | if to_run_interactive: |
|
2191 | if to_run_interactive: | |
2192 | mod = ast.Interactive(to_run_interactive) |
|
2192 | mod = ast.Interactive(to_run_interactive) | |
2193 | self.code_to_run = code = self.compile(mod, cell_name, "single") |
|
2193 | self.code_to_run = code = self.compile(mod, cell_name, "single") | |
2194 | return self.run_code(code) |
|
2194 | return self.run_code(code) | |
2195 |
|
2195 | |||
2196 |
|
2196 | |||
2197 | # PENDING REMOVAL: this method is slated for deletion, once our new |
|
2197 | # PENDING REMOVAL: this method is slated for deletion, once our new | |
2198 | # input logic has been 100% moved to frontends and is stable. |
|
2198 | # input logic has been 100% moved to frontends and is stable. | |
2199 | def runlines(self, lines, clean=False): |
|
2199 | def runlines(self, lines, clean=False): | |
2200 | """Run a string of one or more lines of source. |
|
2200 | """Run a string of one or more lines of source. | |
2201 |
|
2201 | |||
2202 | This method is capable of running a string containing multiple source |
|
2202 | This method is capable of running a string containing multiple source | |
2203 | lines, as if they had been entered at the IPython prompt. Since it |
|
2203 | lines, as if they had been entered at the IPython prompt. Since it | |
2204 | exposes IPython's processing machinery, the given strings can contain |
|
2204 | exposes IPython's processing machinery, the given strings can contain | |
2205 | magic calls (%magic), special shell access (!cmd), etc. |
|
2205 | magic calls (%magic), special shell access (!cmd), etc. | |
2206 | """ |
|
2206 | """ | |
2207 |
|
2207 | |||
2208 | if not isinstance(lines, (list, tuple)): |
|
2208 | if not isinstance(lines, (list, tuple)): | |
2209 | lines = lines.splitlines() |
|
2209 | lines = lines.splitlines() | |
2210 |
|
2210 | |||
2211 | if clean: |
|
2211 | if clean: | |
2212 | lines = self._cleanup_ipy_script(lines) |
|
2212 | lines = self._cleanup_ipy_script(lines) | |
2213 |
|
2213 | |||
2214 | # We must start with a clean buffer, in case this is run from an |
|
2214 | # We must start with a clean buffer, in case this is run from an | |
2215 | # interactive IPython session (via a magic, for example). |
|
2215 | # interactive IPython session (via a magic, for example). | |
2216 | self.reset_buffer() |
|
2216 | self.reset_buffer() | |
2217 |
|
2217 | |||
2218 | # Since we will prefilter all lines, store the user's raw input too |
|
2218 | # Since we will prefilter all lines, store the user's raw input too | |
2219 | # before we apply any transformations |
|
2219 | # before we apply any transformations | |
2220 | self.buffer_raw[:] = [ l+'\n' for l in lines] |
|
2220 | self.buffer_raw[:] = [ l+'\n' for l in lines] | |
2221 |
|
2221 | |||
2222 | more = False |
|
2222 | more = False | |
2223 | prefilter_lines = self.prefilter_manager.prefilter_lines |
|
2223 | prefilter_lines = self.prefilter_manager.prefilter_lines | |
2224 | with nested(self.builtin_trap, self.display_trap): |
|
2224 | with nested(self.builtin_trap, self.display_trap): | |
2225 | for line in lines: |
|
2225 | for line in lines: | |
2226 | # skip blank lines so we don't mess up the prompt counter, but |
|
2226 | # skip blank lines so we don't mess up the prompt counter, but | |
2227 | # do NOT skip even a blank line if we are in a code block (more |
|
2227 | # do NOT skip even a blank line if we are in a code block (more | |
2228 | # is true) |
|
2228 | # is true) | |
2229 |
|
2229 | |||
2230 | if line or more: |
|
2230 | if line or more: | |
2231 | more = self.push_line(prefilter_lines(line, more)) |
|
2231 | more = self.push_line(prefilter_lines(line, more)) | |
2232 | # IPython's run_source returns None if there was an error |
|
2232 | # IPython's run_source returns None if there was an error | |
2233 | # compiling the code. This allows us to stop processing |
|
2233 | # compiling the code. This allows us to stop processing | |
2234 | # right away, so the user gets the error message at the |
|
2234 | # right away, so the user gets the error message at the | |
2235 | # right place. |
|
2235 | # right place. | |
2236 | if more is None: |
|
2236 | if more is None: | |
2237 | break |
|
2237 | break | |
2238 | # final newline in case the input didn't have it, so that the code |
|
2238 | # final newline in case the input didn't have it, so that the code | |
2239 | # actually does get executed |
|
2239 | # actually does get executed | |
2240 | if more: |
|
2240 | if more: | |
2241 | self.push_line('\n') |
|
2241 | self.push_line('\n') | |
2242 |
|
2242 | |||
2243 | def run_source(self, source, filename=None, |
|
2243 | def run_source(self, source, filename=None, | |
2244 | symbol='single', post_execute=True): |
|
2244 | symbol='single', post_execute=True): | |
2245 | """Compile and run some source in the interpreter. |
|
2245 | """Compile and run some source in the interpreter. | |
2246 |
|
2246 | |||
2247 | Arguments are as for compile_command(). |
|
2247 | Arguments are as for compile_command(). | |
2248 |
|
2248 | |||
2249 | One several things can happen: |
|
2249 | One several things can happen: | |
2250 |
|
2250 | |||
2251 | 1) The input is incorrect; compile_command() raised an |
|
2251 | 1) The input is incorrect; compile_command() raised an | |
2252 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2252 | exception (SyntaxError or OverflowError). A syntax traceback | |
2253 | will be printed by calling the showsyntaxerror() method. |
|
2253 | will be printed by calling the showsyntaxerror() method. | |
2254 |
|
2254 | |||
2255 | 2) The input is incomplete, and more input is required; |
|
2255 | 2) The input is incomplete, and more input is required; | |
2256 | compile_command() returned None. Nothing happens. |
|
2256 | compile_command() returned None. Nothing happens. | |
2257 |
|
2257 | |||
2258 | 3) The input is complete; compile_command() returned a code |
|
2258 | 3) The input is complete; compile_command() returned a code | |
2259 | object. The code is executed by calling self.run_code() (which |
|
2259 | object. The code is executed by calling self.run_code() (which | |
2260 | also handles run-time exceptions, except for SystemExit). |
|
2260 | also handles run-time exceptions, except for SystemExit). | |
2261 |
|
2261 | |||
2262 | The return value is: |
|
2262 | The return value is: | |
2263 |
|
2263 | |||
2264 | - True in case 2 |
|
2264 | - True in case 2 | |
2265 |
|
2265 | |||
2266 | - False in the other cases, unless an exception is raised, where |
|
2266 | - False in the other cases, unless an exception is raised, where | |
2267 | None is returned instead. This can be used by external callers to |
|
2267 | None is returned instead. This can be used by external callers to | |
2268 | know whether to continue feeding input or not. |
|
2268 | know whether to continue feeding input or not. | |
2269 |
|
2269 | |||
2270 | The return value can be used to decide whether to use sys.ps1 or |
|
2270 | The return value can be used to decide whether to use sys.ps1 or | |
2271 | sys.ps2 to prompt the next line.""" |
|
2271 | sys.ps2 to prompt the next line.""" | |
2272 |
|
2272 | |||
2273 | # We need to ensure that the source is unicode from here on. |
|
2273 | # We need to ensure that the source is unicode from here on. | |
2274 | if type(source)==str: |
|
2274 | if type(source)==str: | |
2275 | usource = source.decode(self.stdin_encoding) |
|
2275 | usource = source.decode(self.stdin_encoding) | |
2276 | else: |
|
2276 | else: | |
2277 | usource = source |
|
2277 | usource = source | |
2278 |
|
2278 | |||
2279 | if False: # dbg |
|
2279 | if False: # dbg | |
2280 | print 'Source:', repr(source) # dbg |
|
2280 | print 'Source:', repr(source) # dbg | |
2281 | print 'USource:', repr(usource) # dbg |
|
2281 | print 'USource:', repr(usource) # dbg | |
2282 | print 'type:', type(source) # dbg |
|
2282 | print 'type:', type(source) # dbg | |
2283 | print 'encoding', self.stdin_encoding # dbg |
|
2283 | print 'encoding', self.stdin_encoding # dbg | |
2284 |
|
2284 | |||
2285 | try: |
|
2285 | try: | |
2286 | code_name = self.compile.cache(usource, self.execution_count) |
|
2286 | code_name = self.compile.cache(usource, self.execution_count) | |
2287 | code = self.compile(usource, code_name, symbol) |
|
2287 | code = self.compile(usource, code_name, symbol) | |
2288 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2288 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2289 | # Case 1 |
|
2289 | # Case 1 | |
2290 | self.showsyntaxerror(filename) |
|
2290 | self.showsyntaxerror(filename) | |
2291 | return None |
|
2291 | return None | |
2292 |
|
2292 | |||
2293 | if code is None: |
|
2293 | if code is None: | |
2294 | # Case 2 |
|
2294 | # Case 2 | |
2295 | return True |
|
2295 | return True | |
2296 |
|
2296 | |||
2297 | # Case 3 |
|
2297 | # Case 3 | |
2298 | # We store the code object so that threaded shells and |
|
2298 | # We store the code object so that threaded shells and | |
2299 | # custom exception handlers can access all this info if needed. |
|
2299 | # custom exception handlers can access all this info if needed. | |
2300 | # The source corresponding to this can be obtained from the |
|
2300 | # The source corresponding to this can be obtained from the | |
2301 | # buffer attribute as '\n'.join(self.buffer). |
|
2301 | # buffer attribute as '\n'.join(self.buffer). | |
2302 | self.code_to_run = code |
|
2302 | self.code_to_run = code | |
2303 | # now actually execute the code object |
|
2303 | # now actually execute the code object | |
2304 | if self.run_code(code, post_execute) == 0: |
|
2304 | if self.run_code(code, post_execute) == 0: | |
2305 | return False |
|
2305 | return False | |
2306 | else: |
|
2306 | else: | |
2307 | return None |
|
2307 | return None | |
2308 |
|
2308 | |||
2309 | # For backwards compatibility |
|
2309 | # For backwards compatibility | |
2310 | runsource = run_source |
|
2310 | runsource = run_source | |
2311 |
|
2311 | |||
2312 | def run_code(self, code_obj, post_execute=True): |
|
2312 | def run_code(self, code_obj, post_execute=True): | |
2313 | """Execute a code object. |
|
2313 | """Execute a code object. | |
2314 |
|
2314 | |||
2315 | When an exception occurs, self.showtraceback() is called to display a |
|
2315 | When an exception occurs, self.showtraceback() is called to display a | |
2316 | traceback. |
|
2316 | traceback. | |
2317 |
|
2317 | |||
2318 | Return value: a flag indicating whether the code to be run completed |
|
2318 | Return value: a flag indicating whether the code to be run completed | |
2319 | successfully: |
|
2319 | successfully: | |
2320 |
|
2320 | |||
2321 | - 0: successful execution. |
|
2321 | - 0: successful execution. | |
2322 | - 1: an error occurred. |
|
2322 | - 1: an error occurred. | |
2323 | """ |
|
2323 | """ | |
2324 |
|
2324 | |||
2325 | # Set our own excepthook in case the user code tries to call it |
|
2325 | # Set our own excepthook in case the user code tries to call it | |
2326 | # directly, so that the IPython crash handler doesn't get triggered |
|
2326 | # directly, so that the IPython crash handler doesn't get triggered | |
2327 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2327 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2328 |
|
2328 | |||
2329 | # we save the original sys.excepthook in the instance, in case config |
|
2329 | # we save the original sys.excepthook in the instance, in case config | |
2330 | # code (such as magics) needs access to it. |
|
2330 | # code (such as magics) needs access to it. | |
2331 | self.sys_excepthook = old_excepthook |
|
2331 | self.sys_excepthook = old_excepthook | |
2332 | outflag = 1 # happens in more places, so it's easier as default |
|
2332 | outflag = 1 # happens in more places, so it's easier as default | |
2333 | try: |
|
2333 | try: | |
2334 | try: |
|
2334 | try: | |
2335 | self.hooks.pre_run_code_hook() |
|
2335 | self.hooks.pre_run_code_hook() | |
2336 | #rprint('Running code', repr(code_obj)) # dbg |
|
2336 | #rprint('Running code', repr(code_obj)) # dbg | |
2337 | exec code_obj in self.user_global_ns, self.user_ns |
|
2337 | exec code_obj in self.user_global_ns, self.user_ns | |
2338 | finally: |
|
2338 | finally: | |
2339 | # Reset our crash handler in place |
|
2339 | # Reset our crash handler in place | |
2340 | sys.excepthook = old_excepthook |
|
2340 | sys.excepthook = old_excepthook | |
2341 | except SystemExit: |
|
2341 | except SystemExit: | |
2342 | self.reset_buffer() |
|
2342 | self.reset_buffer() | |
2343 | self.showtraceback(exception_only=True) |
|
2343 | self.showtraceback(exception_only=True) | |
2344 | warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1) |
|
2344 | warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1) | |
2345 | except self.custom_exceptions: |
|
2345 | except self.custom_exceptions: | |
2346 | etype,value,tb = sys.exc_info() |
|
2346 | etype,value,tb = sys.exc_info() | |
2347 | self.CustomTB(etype,value,tb) |
|
2347 | self.CustomTB(etype,value,tb) | |
2348 | except: |
|
2348 | except: | |
2349 | self.showtraceback() |
|
2349 | self.showtraceback() | |
2350 | else: |
|
2350 | else: | |
2351 | outflag = 0 |
|
2351 | outflag = 0 | |
2352 | if softspace(sys.stdout, 0): |
|
2352 | if softspace(sys.stdout, 0): | |
2353 |
|
2353 | |||
2354 |
|
2354 | |||
2355 | # Execute any registered post-execution functions. Here, any errors |
|
2355 | # Execute any registered post-execution functions. Here, any errors | |
2356 | # are reported only minimally and just on the terminal, because the |
|
2356 | # are reported only minimally and just on the terminal, because the | |
2357 | # main exception channel may be occupied with a user traceback. |
|
2357 | # main exception channel may be occupied with a user traceback. | |
2358 | # FIXME: we need to think this mechanism a little more carefully. |
|
2358 | # FIXME: we need to think this mechanism a little more carefully. | |
2359 | if post_execute: |
|
2359 | if post_execute: | |
2360 | for func in self._post_execute: |
|
2360 | for func in self._post_execute: | |
2361 | try: |
|
2361 | try: | |
2362 | func() |
|
2362 | func() | |
2363 | except: |
|
2363 | except: | |
2364 | head = '[ ERROR ] Evaluating post_execute function: %s' % \ |
|
2364 | head = '[ ERROR ] Evaluating post_execute function: %s' % \ | |
2365 | func |
|
2365 | func | |
2366 | print >> io.Term.cout, head |
|
2366 | print >> io.Term.cout, head | |
2367 | print >> io.Term.cout, self._simple_error() |
|
2367 | print >> io.Term.cout, self._simple_error() | |
2368 | print >> io.Term.cout, 'Removing from post_execute' |
|
2368 | print >> io.Term.cout, 'Removing from post_execute' | |
2369 | self._post_execute.remove(func) |
|
2369 | self._post_execute.remove(func) | |
2370 |
|
2370 | |||
2371 | # Flush out code object which has been run (and source) |
|
2371 | # Flush out code object which has been run (and source) | |
2372 | self.code_to_run = None |
|
2372 | self.code_to_run = None | |
2373 | return outflag |
|
2373 | return outflag | |
2374 |
|
2374 | |||
2375 | # For backwards compatibility |
|
2375 | # For backwards compatibility | |
2376 | runcode = run_code |
|
2376 | runcode = run_code | |
2377 |
|
2377 | |||
2378 | # PENDING REMOVAL: this method is slated for deletion, once our new |
|
2378 | # PENDING REMOVAL: this method is slated for deletion, once our new | |
2379 | # input logic has been 100% moved to frontends and is stable. |
|
2379 | # input logic has been 100% moved to frontends and is stable. | |
2380 | def push_line(self, line): |
|
2380 | def push_line(self, line): | |
2381 | """Push a line to the interpreter. |
|
2381 | """Push a line to the interpreter. | |
2382 |
|
2382 | |||
2383 | The line should not have a trailing newline; it may have |
|
2383 | The line should not have a trailing newline; it may have | |
2384 | internal newlines. The line is appended to a buffer and the |
|
2384 | internal newlines. The line is appended to a buffer and the | |
2385 | interpreter's run_source() method is called with the |
|
2385 | interpreter's run_source() method is called with the | |
2386 | concatenated contents of the buffer as source. If this |
|
2386 | concatenated contents of the buffer as source. If this | |
2387 | indicates that the command was executed or invalid, the buffer |
|
2387 | indicates that the command was executed or invalid, the buffer | |
2388 | is reset; otherwise, the command is incomplete, and the buffer |
|
2388 | is reset; otherwise, the command is incomplete, and the buffer | |
2389 | is left as it was after the line was appended. The return |
|
2389 | is left as it was after the line was appended. The return | |
2390 | value is 1 if more input is required, 0 if the line was dealt |
|
2390 | value is 1 if more input is required, 0 if the line was dealt | |
2391 | with in some way (this is the same as run_source()). |
|
2391 | with in some way (this is the same as run_source()). | |
2392 | """ |
|
2392 | """ | |
2393 |
|
2393 | |||
2394 | # autoindent management should be done here, and not in the |
|
2394 | # autoindent management should be done here, and not in the | |
2395 | # interactive loop, since that one is only seen by keyboard input. We |
|
2395 | # interactive loop, since that one is only seen by keyboard input. We | |
2396 | # need this done correctly even for code run via runlines (which uses |
|
2396 | # need this done correctly even for code run via runlines (which uses | |
2397 | # push). |
|
2397 | # push). | |
2398 |
|
2398 | |||
2399 | #print 'push line: <%s>' % line # dbg |
|
2399 | #print 'push line: <%s>' % line # dbg | |
2400 | self.buffer.append(line) |
|
2400 | self.buffer.append(line) | |
2401 | full_source = '\n'.join(self.buffer) |
|
2401 | full_source = '\n'.join(self.buffer) | |
2402 | more = self.run_source(full_source, self.filename) |
|
2402 | more = self.run_source(full_source, self.filename) | |
2403 | if not more: |
|
2403 | if not more: | |
2404 | self.history_manager.store_inputs(self.execution_count, |
|
2404 | self.history_manager.store_inputs(self.execution_count, | |
2405 | '\n'.join(self.buffer_raw), full_source) |
|
2405 | '\n'.join(self.buffer_raw), full_source) | |
2406 | self.reset_buffer() |
|
2406 | self.reset_buffer() | |
2407 | self.execution_count += 1 |
|
2407 | self.execution_count += 1 | |
2408 | return more |
|
2408 | return more | |
2409 |
|
2409 | |||
2410 | def reset_buffer(self): |
|
2410 | def reset_buffer(self): | |
2411 | """Reset the input buffer.""" |
|
2411 | """Reset the input buffer.""" | |
2412 | self.buffer[:] = [] |
|
2412 | self.buffer[:] = [] | |
2413 | self.buffer_raw[:] = [] |
|
2413 | self.buffer_raw[:] = [] | |
2414 | self.input_splitter.reset() |
|
2414 | self.input_splitter.reset() | |
2415 |
|
2415 | |||
2416 | # For backwards compatibility |
|
2416 | # For backwards compatibility | |
2417 | resetbuffer = reset_buffer |
|
2417 | resetbuffer = reset_buffer | |
2418 |
|
2418 | |||
2419 | def _is_secondary_block_start(self, s): |
|
2419 | def _is_secondary_block_start(self, s): | |
2420 | if not s.endswith(':'): |
|
2420 | if not s.endswith(':'): | |
2421 | return False |
|
2421 | return False | |
2422 | if (s.startswith('elif') or |
|
2422 | if (s.startswith('elif') or | |
2423 | s.startswith('else') or |
|
2423 | s.startswith('else') or | |
2424 | s.startswith('except') or |
|
2424 | s.startswith('except') or | |
2425 | s.startswith('finally')): |
|
2425 | s.startswith('finally')): | |
2426 | return True |
|
2426 | return True | |
2427 |
|
2427 | |||
2428 | def _cleanup_ipy_script(self, script): |
|
2428 | def _cleanup_ipy_script(self, script): | |
2429 | """Make a script safe for self.runlines() |
|
2429 | """Make a script safe for self.runlines() | |
2430 |
|
2430 | |||
2431 | Currently, IPython is lines based, with blocks being detected by |
|
2431 | Currently, IPython is lines based, with blocks being detected by | |
2432 | empty lines. This is a problem for block based scripts that may |
|
2432 | empty lines. This is a problem for block based scripts that may | |
2433 | not have empty lines after blocks. This script adds those empty |
|
2433 | not have empty lines after blocks. This script adds those empty | |
2434 | lines to make scripts safe for running in the current line based |
|
2434 | lines to make scripts safe for running in the current line based | |
2435 | IPython. |
|
2435 | IPython. | |
2436 | """ |
|
2436 | """ | |
2437 | res = [] |
|
2437 | res = [] | |
2438 | lines = script.splitlines() |
|
2438 | lines = script.splitlines() | |
2439 | level = 0 |
|
2439 | level = 0 | |
2440 |
|
2440 | |||
2441 | for l in lines: |
|
2441 | for l in lines: | |
2442 | lstripped = l.lstrip() |
|
2442 | lstripped = l.lstrip() | |
2443 | stripped = l.strip() |
|
2443 | stripped = l.strip() | |
2444 | if not stripped: |
|
2444 | if not stripped: | |
2445 | continue |
|
2445 | continue | |
2446 | newlevel = len(l) - len(lstripped) |
|
2446 | newlevel = len(l) - len(lstripped) | |
2447 | if level > 0 and newlevel == 0 and \ |
|
2447 | if level > 0 and newlevel == 0 and \ | |
2448 | not self._is_secondary_block_start(stripped): |
|
2448 | not self._is_secondary_block_start(stripped): | |
2449 | # add empty line |
|
2449 | # add empty line | |
2450 | res.append('') |
|
2450 | res.append('') | |
2451 | res.append(l) |
|
2451 | res.append(l) | |
2452 | level = newlevel |
|
2452 | level = newlevel | |
2453 |
|
2453 | |||
2454 | return '\n'.join(res) + '\n' |
|
2454 | return '\n'.join(res) + '\n' | |
2455 |
|
2455 | |||
2456 | #------------------------------------------------------------------------- |
|
2456 | #------------------------------------------------------------------------- | |
2457 | # Things related to GUI support and pylab |
|
2457 | # Things related to GUI support and pylab | |
2458 | #------------------------------------------------------------------------- |
|
2458 | #------------------------------------------------------------------------- | |
2459 |
|
2459 | |||
2460 | def enable_pylab(self, gui=None): |
|
2460 | def enable_pylab(self, gui=None): | |
2461 | raise NotImplementedError('Implement enable_pylab in a subclass') |
|
2461 | raise NotImplementedError('Implement enable_pylab in a subclass') | |
2462 |
|
2462 | |||
2463 | #------------------------------------------------------------------------- |
|
2463 | #------------------------------------------------------------------------- | |
2464 | # Utilities |
|
2464 | # Utilities | |
2465 | #------------------------------------------------------------------------- |
|
2465 | #------------------------------------------------------------------------- | |
2466 |
|
2466 | |||
2467 | def var_expand(self,cmd,depth=0): |
|
2467 | def var_expand(self,cmd,depth=0): | |
2468 | """Expand python variables in a string. |
|
2468 | """Expand python variables in a string. | |
2469 |
|
2469 | |||
2470 | The depth argument indicates how many frames above the caller should |
|
2470 | The depth argument indicates how many frames above the caller should | |
2471 | be walked to look for the local namespace where to expand variables. |
|
2471 | be walked to look for the local namespace where to expand variables. | |
2472 |
|
2472 | |||
2473 | The global namespace for expansion is always the user's interactive |
|
2473 | The global namespace for expansion is always the user's interactive | |
2474 | namespace. |
|
2474 | namespace. | |
2475 | """ |
|
2475 | """ | |
2476 | res = ItplNS(cmd, self.user_ns, # globals |
|
2476 | res = ItplNS(cmd, self.user_ns, # globals | |
2477 | # Skip our own frame in searching for locals: |
|
2477 | # Skip our own frame in searching for locals: | |
2478 | sys._getframe(depth+1).f_locals # locals |
|
2478 | sys._getframe(depth+1).f_locals # locals | |
2479 | ) |
|
2479 | ) | |
2480 | return str(res).decode(res.codec) |
|
2480 | return str(res).decode(res.codec) | |
2481 |
|
2481 | |||
2482 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2482 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
2483 | """Make a new tempfile and return its filename. |
|
2483 | """Make a new tempfile and return its filename. | |
2484 |
|
2484 | |||
2485 | This makes a call to tempfile.mktemp, but it registers the created |
|
2485 | This makes a call to tempfile.mktemp, but it registers the created | |
2486 | filename internally so ipython cleans it up at exit time. |
|
2486 | filename internally so ipython cleans it up at exit time. | |
2487 |
|
2487 | |||
2488 | Optional inputs: |
|
2488 | Optional inputs: | |
2489 |
|
2489 | |||
2490 | - data(None): if data is given, it gets written out to the temp file |
|
2490 | - data(None): if data is given, it gets written out to the temp file | |
2491 | immediately, and the file is closed again.""" |
|
2491 | immediately, and the file is closed again.""" | |
2492 |
|
2492 | |||
2493 | filename = tempfile.mktemp('.py', prefix) |
|
2493 | filename = tempfile.mktemp('.py', prefix) | |
2494 | self.tempfiles.append(filename) |
|
2494 | self.tempfiles.append(filename) | |
2495 |
|
2495 | |||
2496 | if data: |
|
2496 | if data: | |
2497 | tmp_file = open(filename,'w') |
|
2497 | tmp_file = open(filename,'w') | |
2498 | tmp_file.write(data) |
|
2498 | tmp_file.write(data) | |
2499 | tmp_file.close() |
|
2499 | tmp_file.close() | |
2500 | return filename |
|
2500 | return filename | |
2501 |
|
2501 | |||
2502 | # TODO: This should be removed when Term is refactored. |
|
2502 | # TODO: This should be removed when Term is refactored. | |
2503 | def write(self,data): |
|
2503 | def write(self,data): | |
2504 | """Write a string to the default output""" |
|
2504 | """Write a string to the default output""" | |
2505 | io.Term.cout.write(data) |
|
2505 | io.Term.cout.write(data) | |
2506 |
|
2506 | |||
2507 | # TODO: This should be removed when Term is refactored. |
|
2507 | # TODO: This should be removed when Term is refactored. | |
2508 | def write_err(self,data): |
|
2508 | def write_err(self,data): | |
2509 | """Write a string to the default error output""" |
|
2509 | """Write a string to the default error output""" | |
2510 | io.Term.cerr.write(data) |
|
2510 | io.Term.cerr.write(data) | |
2511 |
|
2511 | |||
2512 | def ask_yes_no(self,prompt,default=True): |
|
2512 | def ask_yes_no(self,prompt,default=True): | |
2513 | if self.quiet: |
|
2513 | if self.quiet: | |
2514 | return True |
|
2514 | return True | |
2515 | return ask_yes_no(prompt,default) |
|
2515 | return ask_yes_no(prompt,default) | |
2516 |
|
2516 | |||
2517 | def show_usage(self): |
|
2517 | def show_usage(self): | |
2518 | """Show a usage message""" |
|
2518 | """Show a usage message""" | |
2519 | page.page(IPython.core.usage.interactive_usage) |
|
2519 | page.page(IPython.core.usage.interactive_usage) | |
2520 |
|
2520 | |||
2521 | def find_user_code(self, target, raw=True): |
|
2521 | def find_user_code(self, target, raw=True): | |
2522 | """Get a code string from history, file, or a string or macro. |
|
2522 | """Get a code string from history, file, or a string or macro. | |
2523 |
|
2523 | |||
2524 | This is mainly used by magic functions. |
|
2524 | This is mainly used by magic functions. | |
2525 |
|
2525 | |||
2526 | Parameters |
|
2526 | Parameters | |
2527 | ---------- |
|
2527 | ---------- | |
2528 | target : str |
|
2528 | target : str | |
2529 | A string specifying code to retrieve. This will be tried respectively |
|
2529 | A string specifying code to retrieve. This will be tried respectively | |
2530 | as: ranges of input history (see %history for syntax), a filename, or |
|
2530 | as: ranges of input history (see %history for syntax), a filename, or | |
2531 | an expression evaluating to a string or Macro in the user namespace. |
|
2531 | an expression evaluating to a string or Macro in the user namespace. | |
2532 | raw : bool |
|
2532 | raw : bool | |
2533 | If true (default), retrieve raw history. Has no effect on the other |
|
2533 | If true (default), retrieve raw history. Has no effect on the other | |
2534 | retrieval mechanisms. |
|
2534 | retrieval mechanisms. | |
2535 |
|
2535 | |||
2536 | Returns |
|
2536 | Returns | |
2537 | ------- |
|
2537 | ------- | |
2538 | A string of code. |
|
2538 | A string of code. | |
2539 |
|
2539 | |||
2540 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
2540 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
2541 | to an object of another type. In each case, .args[0] is a printable |
|
2541 | to an object of another type. In each case, .args[0] is a printable | |
2542 | message. |
|
2542 | message. | |
2543 | """ |
|
2543 | """ | |
2544 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
2544 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
2545 | if code: |
|
2545 | if code: | |
2546 | return code |
|
2546 | return code | |
2547 | if os.path.isfile(target): # Read file |
|
2547 | if os.path.isfile(target): # Read file | |
2548 | return open(target, "r").read() |
|
2548 | return open(target, "r").read() | |
2549 |
|
2549 | |||
2550 | try: # User namespace |
|
2550 | try: # User namespace | |
2551 | codeobj = eval(target, self.user_ns) |
|
2551 | codeobj = eval(target, self.user_ns) | |
2552 | except Exception: |
|
2552 | except Exception: | |
2553 | raise ValueError(("'%s' was not found in history, as a file, nor in" |
|
2553 | raise ValueError(("'%s' was not found in history, as a file, nor in" | |
2554 | " the user namespace.") % target) |
|
2554 | " the user namespace.") % target) | |
2555 | if isinstance(codeobj, basestring): |
|
2555 | if isinstance(codeobj, basestring): | |
2556 | return codeobj |
|
2556 | return codeobj | |
2557 | elif isinstance(codeobj, Macro): |
|
2557 | elif isinstance(codeobj, Macro): | |
2558 | return codeobj.value |
|
2558 | return codeobj.value | |
2559 |
|
2559 | |||
2560 | raise TypeError("%s is neither a string nor a macro." % target, |
|
2560 | raise TypeError("%s is neither a string nor a macro." % target, | |
2561 | codeobj) |
|
2561 | codeobj) | |
2562 |
|
2562 | |||
2563 | #------------------------------------------------------------------------- |
|
2563 | #------------------------------------------------------------------------- | |
2564 | # Things related to IPython exiting |
|
2564 | # Things related to IPython exiting | |
2565 | #------------------------------------------------------------------------- |
|
2565 | #------------------------------------------------------------------------- | |
2566 | def atexit_operations(self): |
|
2566 | def atexit_operations(self): | |
2567 | """This will be executed at the time of exit. |
|
2567 | """This will be executed at the time of exit. | |
2568 |
|
2568 | |||
2569 | Cleanup operations and saving of persistent data that is done |
|
2569 | Cleanup operations and saving of persistent data that is done | |
2570 | unconditionally by IPython should be performed here. |
|
2570 | unconditionally by IPython should be performed here. | |
2571 |
|
2571 | |||
2572 | For things that may depend on startup flags or platform specifics (such |
|
2572 | For things that may depend on startup flags or platform specifics (such | |
2573 | as having readline or not), register a separate atexit function in the |
|
2573 | as having readline or not), register a separate atexit function in the | |
2574 | code that has the appropriate information, rather than trying to |
|
2574 | code that has the appropriate information, rather than trying to | |
2575 | clutter |
|
2575 | clutter | |
2576 | """ |
|
2576 | """ | |
2577 | # Cleanup all tempfiles left around |
|
2577 | # Cleanup all tempfiles left around | |
2578 | for tfile in self.tempfiles: |
|
2578 | for tfile in self.tempfiles: | |
2579 | try: |
|
2579 | try: | |
2580 | os.unlink(tfile) |
|
2580 | os.unlink(tfile) | |
2581 | except OSError: |
|
2581 | except OSError: | |
2582 | pass |
|
2582 | pass | |
2583 |
|
2583 | |||
2584 | # Close the history session (this stores the end time and line count) |
|
2584 | # Close the history session (this stores the end time and line count) | |
2585 | self.history_manager.end_session() |
|
2585 | self.history_manager.end_session() | |
2586 |
|
2586 | |||
2587 | # Clear all user namespaces to release all references cleanly. |
|
2587 | # Clear all user namespaces to release all references cleanly. | |
2588 | self.reset(new_session=False) |
|
2588 | self.reset(new_session=False) | |
2589 |
|
2589 | |||
2590 | # Run user hooks |
|
2590 | # Run user hooks | |
2591 | self.hooks.shutdown_hook() |
|
2591 | self.hooks.shutdown_hook() | |
2592 |
|
2592 | |||
2593 | def cleanup(self): |
|
2593 | def cleanup(self): | |
2594 | self.restore_sys_module_state() |
|
2594 | self.restore_sys_module_state() | |
2595 |
|
2595 | |||
2596 |
|
2596 | |||
2597 | class InteractiveShellABC(object): |
|
2597 | class InteractiveShellABC(object): | |
2598 | """An abstract base class for InteractiveShell.""" |
|
2598 | """An abstract base class for InteractiveShell.""" | |
2599 | __metaclass__ = abc.ABCMeta |
|
2599 | __metaclass__ = abc.ABCMeta | |
2600 |
|
2600 | |||
2601 | InteractiveShellABC.register(InteractiveShell) |
|
2601 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,3478 +1,3478 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """Magic functions for InteractiveShell. |
|
2 | """Magic functions for InteractiveShell. | |
3 | """ |
|
3 | """ | |
4 |
|
4 | |||
5 | #----------------------------------------------------------------------------- |
|
5 | #----------------------------------------------------------------------------- | |
6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> |
|
7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> | |
8 | # Copyright (C) 2008-2009 The IPython Development Team |
|
8 | # Copyright (C) 2008-2009 The IPython Development Team | |
9 |
|
9 | |||
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 |
|
13 | |||
14 | #----------------------------------------------------------------------------- |
|
14 | #----------------------------------------------------------------------------- | |
15 | # Imports |
|
15 | # Imports | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | import __builtin__ |
|
18 | import __builtin__ | |
19 | import __future__ |
|
19 | import __future__ | |
20 | import bdb |
|
20 | import bdb | |
21 | import inspect |
|
21 | import inspect | |
22 | import os |
|
22 | import os | |
23 | import sys |
|
23 | import sys | |
24 | import shutil |
|
24 | import shutil | |
25 | import re |
|
25 | import re | |
26 | import time |
|
26 | import time | |
27 | import textwrap |
|
27 | import textwrap | |
28 | from cStringIO import StringIO |
|
28 | from cStringIO import StringIO | |
29 | from getopt import getopt,GetoptError |
|
29 | from getopt import getopt,GetoptError | |
30 | from pprint import pformat |
|
30 | from pprint import pformat | |
31 | from xmlrpclib import ServerProxy |
|
31 | from xmlrpclib import ServerProxy | |
32 |
|
32 | |||
33 | # cProfile was added in Python2.5 |
|
33 | # cProfile was added in Python2.5 | |
34 | try: |
|
34 | try: | |
35 | import cProfile as profile |
|
35 | import cProfile as profile | |
36 | import pstats |
|
36 | import pstats | |
37 | except ImportError: |
|
37 | except ImportError: | |
38 | # profile isn't bundled by default in Debian for license reasons |
|
38 | # profile isn't bundled by default in Debian for license reasons | |
39 | try: |
|
39 | try: | |
40 | import profile,pstats |
|
40 | import profile,pstats | |
41 | except ImportError: |
|
41 | except ImportError: | |
42 | profile = pstats = None |
|
42 | profile = pstats = None | |
43 |
|
43 | |||
44 | import IPython |
|
44 | import IPython | |
45 | from IPython.core import debugger, oinspect |
|
45 | from IPython.core import debugger, oinspect | |
46 | from IPython.core.error import TryNext |
|
46 | from IPython.core.error import TryNext | |
47 | from IPython.core.error import UsageError |
|
47 | from IPython.core.error import UsageError | |
48 | from IPython.core.fakemodule import FakeModule |
|
48 | from IPython.core.fakemodule import FakeModule | |
49 | from IPython.core.macro import Macro |
|
49 | from IPython.core.macro import Macro | |
50 | from IPython.core import page |
|
50 | from IPython.core import page | |
51 | from IPython.core.prefilter import ESC_MAGIC |
|
51 | from IPython.core.prefilter import ESC_MAGIC | |
52 | from IPython.lib.pylabtools import mpl_runner |
|
52 | from IPython.lib.pylabtools import mpl_runner | |
53 | from IPython.external.Itpl import itpl, printpl |
|
53 | from IPython.external.Itpl import itpl, printpl | |
54 | from IPython.testing import decorators as testdec |
|
54 | from IPython.testing import decorators as testdec | |
55 | from IPython.utils.io import file_read, nlprint |
|
55 | from IPython.utils.io import file_read, nlprint | |
56 | import IPython.utils.io |
|
56 | import IPython.utils.io | |
57 | from IPython.utils.path import get_py_filename |
|
57 | from IPython.utils.path import get_py_filename | |
58 | from IPython.utils.process import arg_split, abbrev_cwd |
|
58 | from IPython.utils.process import arg_split, abbrev_cwd | |
59 | from IPython.utils.terminal import set_term_title |
|
59 | from IPython.utils.terminal import set_term_title | |
60 | from IPython.utils.text import LSString, SList, format_screen |
|
60 | from IPython.utils.text import LSString, SList, format_screen | |
61 | from IPython.utils.timing import clock, clock2 |
|
61 | from IPython.utils.timing import clock, clock2 | |
62 | from IPython.utils.warn import warn, error |
|
62 | from IPython.utils.warn import warn, error | |
63 | from IPython.utils.ipstruct import Struct |
|
63 | from IPython.utils.ipstruct import Struct | |
64 | import IPython.utils.generics |
|
64 | import IPython.utils.generics | |
65 |
|
65 | |||
66 | #----------------------------------------------------------------------------- |
|
66 | #----------------------------------------------------------------------------- | |
67 | # Utility functions |
|
67 | # Utility functions | |
68 | #----------------------------------------------------------------------------- |
|
68 | #----------------------------------------------------------------------------- | |
69 |
|
69 | |||
70 | def on_off(tag): |
|
70 | def on_off(tag): | |
71 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
71 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" | |
72 | return ['OFF','ON'][tag] |
|
72 | return ['OFF','ON'][tag] | |
73 |
|
73 | |||
74 | class Bunch: pass |
|
74 | class Bunch: pass | |
75 |
|
75 | |||
76 | def compress_dhist(dh): |
|
76 | def compress_dhist(dh): | |
77 | head, tail = dh[:-10], dh[-10:] |
|
77 | head, tail = dh[:-10], dh[-10:] | |
78 |
|
78 | |||
79 | newhead = [] |
|
79 | newhead = [] | |
80 | done = set() |
|
80 | done = set() | |
81 | for h in head: |
|
81 | for h in head: | |
82 | if h in done: |
|
82 | if h in done: | |
83 | continue |
|
83 | continue | |
84 | newhead.append(h) |
|
84 | newhead.append(h) | |
85 | done.add(h) |
|
85 | done.add(h) | |
86 |
|
86 | |||
87 | return newhead + tail |
|
87 | return newhead + tail | |
88 |
|
88 | |||
89 | def needs_local_scope(func): |
|
89 | def needs_local_scope(func): | |
90 | """Decorator to mark magic functions which need to local scope to run.""" |
|
90 | """Decorator to mark magic functions which need to local scope to run.""" | |
91 | func.needs_local_scope = True |
|
91 | func.needs_local_scope = True | |
92 | return func |
|
92 | return func | |
93 |
|
93 | |||
94 | #*************************************************************************** |
|
94 | #*************************************************************************** | |
95 | # Main class implementing Magic functionality |
|
95 | # Main class implementing Magic functionality | |
96 |
|
96 | |||
97 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors |
|
97 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors | |
98 | # on construction of the main InteractiveShell object. Something odd is going |
|
98 | # on construction of the main InteractiveShell object. Something odd is going | |
99 | # on with super() calls, Configurable and the MRO... For now leave it as-is, but |
|
99 | # on with super() calls, Configurable and the MRO... For now leave it as-is, but | |
100 | # eventually this needs to be clarified. |
|
100 | # eventually this needs to be clarified. | |
101 | # BG: This is because InteractiveShell inherits from this, but is itself a |
|
101 | # BG: This is because InteractiveShell inherits from this, but is itself a | |
102 | # Configurable. This messes up the MRO in some way. The fix is that we need to |
|
102 | # Configurable. This messes up the MRO in some way. The fix is that we need to | |
103 | # make Magic a configurable that InteractiveShell does not subclass. |
|
103 | # make Magic a configurable that InteractiveShell does not subclass. | |
104 |
|
104 | |||
105 | class Magic: |
|
105 | class Magic: | |
106 | """Magic functions for InteractiveShell. |
|
106 | """Magic functions for InteractiveShell. | |
107 |
|
107 | |||
108 | Shell functions which can be reached as %function_name. All magic |
|
108 | Shell functions which can be reached as %function_name. All magic | |
109 | functions should accept a string, which they can parse for their own |
|
109 | functions should accept a string, which they can parse for their own | |
110 | needs. This can make some functions easier to type, eg `%cd ../` |
|
110 | needs. This can make some functions easier to type, eg `%cd ../` | |
111 | vs. `%cd("../")` |
|
111 | vs. `%cd("../")` | |
112 |
|
112 | |||
113 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
113 | ALL definitions MUST begin with the prefix magic_. The user won't need it | |
114 | at the command line, but it is is needed in the definition. """ |
|
114 | at the command line, but it is is needed in the definition. """ | |
115 |
|
115 | |||
116 | # class globals |
|
116 | # class globals | |
117 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
117 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', | |
118 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
118 | 'Automagic is ON, % prefix NOT needed for magic functions.'] | |
119 |
|
119 | |||
120 | #...................................................................... |
|
120 | #...................................................................... | |
121 | # some utility functions |
|
121 | # some utility functions | |
122 |
|
122 | |||
123 | def __init__(self,shell): |
|
123 | def __init__(self,shell): | |
124 |
|
124 | |||
125 | self.options_table = {} |
|
125 | self.options_table = {} | |
126 | if profile is None: |
|
126 | if profile is None: | |
127 | self.magic_prun = self.profile_missing_notice |
|
127 | self.magic_prun = self.profile_missing_notice | |
128 | self.shell = shell |
|
128 | self.shell = shell | |
129 |
|
129 | |||
130 | # namespace for holding state we may need |
|
130 | # namespace for holding state we may need | |
131 | self._magic_state = Bunch() |
|
131 | self._magic_state = Bunch() | |
132 |
|
132 | |||
133 | def profile_missing_notice(self, *args, **kwargs): |
|
133 | def profile_missing_notice(self, *args, **kwargs): | |
134 | error("""\ |
|
134 | error("""\ | |
135 | The profile module could not be found. It has been removed from the standard |
|
135 | The profile module could not be found. It has been removed from the standard | |
136 | python packages because of its non-free license. To use profiling, install the |
|
136 | python packages because of its non-free license. To use profiling, install the | |
137 | python-profiler package from non-free.""") |
|
137 | python-profiler package from non-free.""") | |
138 |
|
138 | |||
139 | def default_option(self,fn,optstr): |
|
139 | def default_option(self,fn,optstr): | |
140 | """Make an entry in the options_table for fn, with value optstr""" |
|
140 | """Make an entry in the options_table for fn, with value optstr""" | |
141 |
|
141 | |||
142 | if fn not in self.lsmagic(): |
|
142 | if fn not in self.lsmagic(): | |
143 | error("%s is not a magic function" % fn) |
|
143 | error("%s is not a magic function" % fn) | |
144 | self.options_table[fn] = optstr |
|
144 | self.options_table[fn] = optstr | |
145 |
|
145 | |||
146 | def lsmagic(self): |
|
146 | def lsmagic(self): | |
147 | """Return a list of currently available magic functions. |
|
147 | """Return a list of currently available magic functions. | |
148 |
|
148 | |||
149 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
149 | Gives a list of the bare names after mangling (['ls','cd', ...], not | |
150 | ['magic_ls','magic_cd',...]""" |
|
150 | ['magic_ls','magic_cd',...]""" | |
151 |
|
151 | |||
152 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
152 | # FIXME. This needs a cleanup, in the way the magics list is built. | |
153 |
|
153 | |||
154 | # magics in class definition |
|
154 | # magics in class definition | |
155 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
155 | class_magic = lambda fn: fn.startswith('magic_') and \ | |
156 | callable(Magic.__dict__[fn]) |
|
156 | callable(Magic.__dict__[fn]) | |
157 | # in instance namespace (run-time user additions) |
|
157 | # in instance namespace (run-time user additions) | |
158 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
158 | inst_magic = lambda fn: fn.startswith('magic_') and \ | |
159 | callable(self.__dict__[fn]) |
|
159 | callable(self.__dict__[fn]) | |
160 | # and bound magics by user (so they can access self): |
|
160 | # and bound magics by user (so they can access self): | |
161 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
161 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ | |
162 | callable(self.__class__.__dict__[fn]) |
|
162 | callable(self.__class__.__dict__[fn]) | |
163 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
163 | magics = filter(class_magic,Magic.__dict__.keys()) + \ | |
164 | filter(inst_magic,self.__dict__.keys()) + \ |
|
164 | filter(inst_magic,self.__dict__.keys()) + \ | |
165 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
165 | filter(inst_bound_magic,self.__class__.__dict__.keys()) | |
166 | out = [] |
|
166 | out = [] | |
167 | for fn in set(magics): |
|
167 | for fn in set(magics): | |
168 | out.append(fn.replace('magic_','',1)) |
|
168 | out.append(fn.replace('magic_','',1)) | |
169 | out.sort() |
|
169 | out.sort() | |
170 | return out |
|
170 | return out | |
171 |
|
171 | |||
172 | def extract_input_lines(self, range_str, raw=False): |
|
172 | def extract_input_lines(self, range_str, raw=False): | |
173 | """Return as a string a set of input history slices. |
|
173 | """Return as a string a set of input history slices. | |
174 |
|
174 | |||
175 | Inputs: |
|
175 | Inputs: | |
176 |
|
176 | |||
177 | - range_str: the set of slices is given as a string, like |
|
177 | - range_str: the set of slices is given as a string, like | |
178 | "~5/6-~4/2 4:8 9", since this function is for use by magic functions |
|
178 | "~5/6-~4/2 4:8 9", since this function is for use by magic functions | |
179 | which get their arguments as strings. The number before the / is the |
|
179 | which get their arguments as strings. The number before the / is the | |
180 | session number: ~n goes n back from the current session. |
|
180 | session number: ~n goes n back from the current session. | |
181 |
|
181 | |||
182 | Optional inputs: |
|
182 | Optional inputs: | |
183 |
|
183 | |||
184 | - raw(False): by default, the processed input is used. If this is |
|
184 | - raw(False): by default, the processed input is used. If this is | |
185 | true, the raw input history is used instead. |
|
185 | true, the raw input history is used instead. | |
186 |
|
186 | |||
187 | Note that slices can be called with two notations: |
|
187 | Note that slices can be called with two notations: | |
188 |
|
188 | |||
189 | N:M -> standard python form, means including items N...(M-1). |
|
189 | N:M -> standard python form, means including items N...(M-1). | |
190 |
|
190 | |||
191 | N-M -> include items N..M (closed endpoint).""" |
|
191 | N-M -> include items N..M (closed endpoint).""" | |
192 | lines = self.shell.history_manager.\ |
|
192 | lines = self.shell.history_manager.\ | |
193 | get_range_by_str(range_str, raw=raw) |
|
193 | get_range_by_str(range_str, raw=raw) | |
194 | return "\n".join(x for _, _, x in lines) |
|
194 | return "\n".join(x for _, _, x in lines) | |
195 |
|
195 | |||
196 | def arg_err(self,func): |
|
196 | def arg_err(self,func): | |
197 | """Print docstring if incorrect arguments were passed""" |
|
197 | """Print docstring if incorrect arguments were passed""" | |
198 | print 'Error in arguments:' |
|
198 | print 'Error in arguments:' | |
199 | print oinspect.getdoc(func) |
|
199 | print oinspect.getdoc(func) | |
200 |
|
200 | |||
201 | def format_latex(self,strng): |
|
201 | def format_latex(self,strng): | |
202 | """Format a string for latex inclusion.""" |
|
202 | """Format a string for latex inclusion.""" | |
203 |
|
203 | |||
204 | # Characters that need to be escaped for latex: |
|
204 | # Characters that need to be escaped for latex: | |
205 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
205 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) | |
206 | # Magic command names as headers: |
|
206 | # Magic command names as headers: | |
207 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, |
|
207 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, | |
208 | re.MULTILINE) |
|
208 | re.MULTILINE) | |
209 | # Magic commands |
|
209 | # Magic commands | |
210 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, |
|
210 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, | |
211 | re.MULTILINE) |
|
211 | re.MULTILINE) | |
212 | # Paragraph continue |
|
212 | # Paragraph continue | |
213 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
213 | par_re = re.compile(r'\\$',re.MULTILINE) | |
214 |
|
214 | |||
215 | # The "\n" symbol |
|
215 | # The "\n" symbol | |
216 | newline_re = re.compile(r'\\n') |
|
216 | newline_re = re.compile(r'\\n') | |
217 |
|
217 | |||
218 | # Now build the string for output: |
|
218 | # Now build the string for output: | |
219 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
219 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) | |
220 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
220 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', | |
221 | strng) |
|
221 | strng) | |
222 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
222 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) | |
223 | strng = par_re.sub(r'\\\\',strng) |
|
223 | strng = par_re.sub(r'\\\\',strng) | |
224 | strng = escape_re.sub(r'\\\1',strng) |
|
224 | strng = escape_re.sub(r'\\\1',strng) | |
225 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
225 | strng = newline_re.sub(r'\\textbackslash{}n',strng) | |
226 | return strng |
|
226 | return strng | |
227 |
|
227 | |||
228 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
228 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): | |
229 | """Parse options passed to an argument string. |
|
229 | """Parse options passed to an argument string. | |
230 |
|
230 | |||
231 | The interface is similar to that of getopt(), but it returns back a |
|
231 | The interface is similar to that of getopt(), but it returns back a | |
232 | Struct with the options as keys and the stripped argument string still |
|
232 | Struct with the options as keys and the stripped argument string still | |
233 | as a string. |
|
233 | as a string. | |
234 |
|
234 | |||
235 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
235 | arg_str is quoted as a true sys.argv vector by using shlex.split. | |
236 | This allows us to easily expand variables, glob files, quote |
|
236 | This allows us to easily expand variables, glob files, quote | |
237 | arguments, etc. |
|
237 | arguments, etc. | |
238 |
|
238 | |||
239 | Options: |
|
239 | Options: | |
240 | -mode: default 'string'. If given as 'list', the argument string is |
|
240 | -mode: default 'string'. If given as 'list', the argument string is | |
241 | returned as a list (split on whitespace) instead of a string. |
|
241 | returned as a list (split on whitespace) instead of a string. | |
242 |
|
242 | |||
243 | -list_all: put all option values in lists. Normally only options |
|
243 | -list_all: put all option values in lists. Normally only options | |
244 | appearing more than once are put in a list. |
|
244 | appearing more than once are put in a list. | |
245 |
|
245 | |||
246 | -posix (True): whether to split the input line in POSIX mode or not, |
|
246 | -posix (True): whether to split the input line in POSIX mode or not, | |
247 | as per the conventions outlined in the shlex module from the |
|
247 | as per the conventions outlined in the shlex module from the | |
248 | standard library.""" |
|
248 | standard library.""" | |
249 |
|
249 | |||
250 | # inject default options at the beginning of the input line |
|
250 | # inject default options at the beginning of the input line | |
251 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
251 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') | |
252 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
252 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) | |
253 |
|
253 | |||
254 | mode = kw.get('mode','string') |
|
254 | mode = kw.get('mode','string') | |
255 | if mode not in ['string','list']: |
|
255 | if mode not in ['string','list']: | |
256 | raise ValueError,'incorrect mode given: %s' % mode |
|
256 | raise ValueError,'incorrect mode given: %s' % mode | |
257 | # Get options |
|
257 | # Get options | |
258 | list_all = kw.get('list_all',0) |
|
258 | list_all = kw.get('list_all',0) | |
259 | posix = kw.get('posix', os.name == 'posix') |
|
259 | posix = kw.get('posix', os.name == 'posix') | |
260 |
|
260 | |||
261 | # Check if we have more than one argument to warrant extra processing: |
|
261 | # Check if we have more than one argument to warrant extra processing: | |
262 | odict = {} # Dictionary with options |
|
262 | odict = {} # Dictionary with options | |
263 | args = arg_str.split() |
|
263 | args = arg_str.split() | |
264 | if len(args) >= 1: |
|
264 | if len(args) >= 1: | |
265 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
265 | # If the list of inputs only has 0 or 1 thing in it, there's no | |
266 | # need to look for options |
|
266 | # need to look for options | |
267 | argv = arg_split(arg_str,posix) |
|
267 | argv = arg_split(arg_str,posix) | |
268 | # Do regular option processing |
|
268 | # Do regular option processing | |
269 | try: |
|
269 | try: | |
270 | opts,args = getopt(argv,opt_str,*long_opts) |
|
270 | opts,args = getopt(argv,opt_str,*long_opts) | |
271 | except GetoptError,e: |
|
271 | except GetoptError,e: | |
272 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
272 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, | |
273 | " ".join(long_opts))) |
|
273 | " ".join(long_opts))) | |
274 | for o,a in opts: |
|
274 | for o,a in opts: | |
275 | if o.startswith('--'): |
|
275 | if o.startswith('--'): | |
276 | o = o[2:] |
|
276 | o = o[2:] | |
277 | else: |
|
277 | else: | |
278 | o = o[1:] |
|
278 | o = o[1:] | |
279 | try: |
|
279 | try: | |
280 | odict[o].append(a) |
|
280 | odict[o].append(a) | |
281 | except AttributeError: |
|
281 | except AttributeError: | |
282 | odict[o] = [odict[o],a] |
|
282 | odict[o] = [odict[o],a] | |
283 | except KeyError: |
|
283 | except KeyError: | |
284 | if list_all: |
|
284 | if list_all: | |
285 | odict[o] = [a] |
|
285 | odict[o] = [a] | |
286 | else: |
|
286 | else: | |
287 | odict[o] = a |
|
287 | odict[o] = a | |
288 |
|
288 | |||
289 | # Prepare opts,args for return |
|
289 | # Prepare opts,args for return | |
290 | opts = Struct(odict) |
|
290 | opts = Struct(odict) | |
291 | if mode == 'string': |
|
291 | if mode == 'string': | |
292 | args = ' '.join(args) |
|
292 | args = ' '.join(args) | |
293 |
|
293 | |||
294 | return opts,args |
|
294 | return opts,args | |
295 |
|
295 | |||
296 | #...................................................................... |
|
296 | #...................................................................... | |
297 | # And now the actual magic functions |
|
297 | # And now the actual magic functions | |
298 |
|
298 | |||
299 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
299 | # Functions for IPython shell work (vars,funcs, config, etc) | |
300 | def magic_lsmagic(self, parameter_s = ''): |
|
300 | def magic_lsmagic(self, parameter_s = ''): | |
301 | """List currently available magic functions.""" |
|
301 | """List currently available magic functions.""" | |
302 | mesc = ESC_MAGIC |
|
302 | mesc = ESC_MAGIC | |
303 | print 'Available magic functions:\n'+mesc+\ |
|
303 | print 'Available magic functions:\n'+mesc+\ | |
304 | (' '+mesc).join(self.lsmagic()) |
|
304 | (' '+mesc).join(self.lsmagic()) | |
305 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
305 | print '\n' + Magic.auto_status[self.shell.automagic] | |
306 | return None |
|
306 | return None | |
307 |
|
307 | |||
308 | def magic_magic(self, parameter_s = ''): |
|
308 | def magic_magic(self, parameter_s = ''): | |
309 | """Print information about the magic function system. |
|
309 | """Print information about the magic function system. | |
310 |
|
310 | |||
311 | Supported formats: -latex, -brief, -rest |
|
311 | Supported formats: -latex, -brief, -rest | |
312 | """ |
|
312 | """ | |
313 |
|
313 | |||
314 | mode = '' |
|
314 | mode = '' | |
315 | try: |
|
315 | try: | |
316 | if parameter_s.split()[0] == '-latex': |
|
316 | if parameter_s.split()[0] == '-latex': | |
317 | mode = 'latex' |
|
317 | mode = 'latex' | |
318 | if parameter_s.split()[0] == '-brief': |
|
318 | if parameter_s.split()[0] == '-brief': | |
319 | mode = 'brief' |
|
319 | mode = 'brief' | |
320 | if parameter_s.split()[0] == '-rest': |
|
320 | if parameter_s.split()[0] == '-rest': | |
321 | mode = 'rest' |
|
321 | mode = 'rest' | |
322 | rest_docs = [] |
|
322 | rest_docs = [] | |
323 | except: |
|
323 | except: | |
324 | pass |
|
324 | pass | |
325 |
|
325 | |||
326 | magic_docs = [] |
|
326 | magic_docs = [] | |
327 | for fname in self.lsmagic(): |
|
327 | for fname in self.lsmagic(): | |
328 | mname = 'magic_' + fname |
|
328 | mname = 'magic_' + fname | |
329 | for space in (Magic,self,self.__class__): |
|
329 | for space in (Magic,self,self.__class__): | |
330 | try: |
|
330 | try: | |
331 | fn = space.__dict__[mname] |
|
331 | fn = space.__dict__[mname] | |
332 | except KeyError: |
|
332 | except KeyError: | |
333 | pass |
|
333 | pass | |
334 | else: |
|
334 | else: | |
335 | break |
|
335 | break | |
336 | if mode == 'brief': |
|
336 | if mode == 'brief': | |
337 | # only first line |
|
337 | # only first line | |
338 | if fn.__doc__: |
|
338 | if fn.__doc__: | |
339 | fndoc = fn.__doc__.split('\n',1)[0] |
|
339 | fndoc = fn.__doc__.split('\n',1)[0] | |
340 | else: |
|
340 | else: | |
341 | fndoc = 'No documentation' |
|
341 | fndoc = 'No documentation' | |
342 | else: |
|
342 | else: | |
343 | if fn.__doc__: |
|
343 | if fn.__doc__: | |
344 | fndoc = fn.__doc__.rstrip() |
|
344 | fndoc = fn.__doc__.rstrip() | |
345 | else: |
|
345 | else: | |
346 | fndoc = 'No documentation' |
|
346 | fndoc = 'No documentation' | |
347 |
|
347 | |||
348 |
|
348 | |||
349 | if mode == 'rest': |
|
349 | if mode == 'rest': | |
350 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC, |
|
350 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC, | |
351 | fname,fndoc)) |
|
351 | fname,fndoc)) | |
352 |
|
352 | |||
353 | else: |
|
353 | else: | |
354 | magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC, |
|
354 | magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC, | |
355 | fname,fndoc)) |
|
355 | fname,fndoc)) | |
356 |
|
356 | |||
357 | magic_docs = ''.join(magic_docs) |
|
357 | magic_docs = ''.join(magic_docs) | |
358 |
|
358 | |||
359 | if mode == 'rest': |
|
359 | if mode == 'rest': | |
360 | return "".join(rest_docs) |
|
360 | return "".join(rest_docs) | |
361 |
|
361 | |||
362 | if mode == 'latex': |
|
362 | if mode == 'latex': | |
363 | print self.format_latex(magic_docs) |
|
363 | print self.format_latex(magic_docs) | |
364 | return |
|
364 | return | |
365 | else: |
|
365 | else: | |
366 | magic_docs = format_screen(magic_docs) |
|
366 | magic_docs = format_screen(magic_docs) | |
367 | if mode == 'brief': |
|
367 | if mode == 'brief': | |
368 | return magic_docs |
|
368 | return magic_docs | |
369 |
|
369 | |||
370 | outmsg = """ |
|
370 | outmsg = """ | |
371 | IPython's 'magic' functions |
|
371 | IPython's 'magic' functions | |
372 | =========================== |
|
372 | =========================== | |
373 |
|
373 | |||
374 | The magic function system provides a series of functions which allow you to |
|
374 | The magic function system provides a series of functions which allow you to | |
375 | control the behavior of IPython itself, plus a lot of system-type |
|
375 | control the behavior of IPython itself, plus a lot of system-type | |
376 | features. All these functions are prefixed with a % character, but parameters |
|
376 | features. All these functions are prefixed with a % character, but parameters | |
377 | are given without parentheses or quotes. |
|
377 | are given without parentheses or quotes. | |
378 |
|
378 | |||
379 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
379 | NOTE: If you have 'automagic' enabled (via the command line option or with the | |
380 | %automagic function), you don't need to type in the % explicitly. By default, |
|
380 | %automagic function), you don't need to type in the % explicitly. By default, | |
381 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
381 | IPython ships with automagic on, so you should only rarely need the % escape. | |
382 |
|
382 | |||
383 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
383 | Example: typing '%cd mydir' (without the quotes) changes you working directory | |
384 | to 'mydir', if it exists. |
|
384 | to 'mydir', if it exists. | |
385 |
|
385 | |||
386 | You can define your own magic functions to extend the system. See the supplied |
|
386 | You can define your own magic functions to extend the system. See the supplied | |
387 | ipythonrc and example-magic.py files for details (in your ipython |
|
387 | ipythonrc and example-magic.py files for details (in your ipython | |
388 | configuration directory, typically $HOME/.config/ipython on Linux or $HOME/.ipython elsewhere). |
|
388 | configuration directory, typically $HOME/.config/ipython on Linux or $HOME/.ipython elsewhere). | |
389 |
|
389 | |||
390 | You can also define your own aliased names for magic functions. In your |
|
390 | You can also define your own aliased names for magic functions. In your | |
391 | ipythonrc file, placing a line like: |
|
391 | ipythonrc file, placing a line like: | |
392 |
|
392 | |||
393 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile |
|
393 | execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile | |
394 |
|
394 | |||
395 | will define %pf as a new name for %profile. |
|
395 | will define %pf as a new name for %profile. | |
396 |
|
396 | |||
397 | You can also call magics in code using the magic() function, which IPython |
|
397 | You can also call magics in code using the magic() function, which IPython | |
398 | automatically adds to the builtin namespace. Type 'magic?' for details. |
|
398 | automatically adds to the builtin namespace. Type 'magic?' for details. | |
399 |
|
399 | |||
400 | For a list of the available magic functions, use %lsmagic. For a description |
|
400 | For a list of the available magic functions, use %lsmagic. For a description | |
401 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
401 | of any of them, type %magic_name?, e.g. '%cd?'. | |
402 |
|
402 | |||
403 | Currently the magic system has the following functions:\n""" |
|
403 | Currently the magic system has the following functions:\n""" | |
404 |
|
404 | |||
405 | mesc = ESC_MAGIC |
|
405 | mesc = ESC_MAGIC | |
406 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
406 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" | |
407 | "\n\n%s%s\n\n%s" % (outmsg, |
|
407 | "\n\n%s%s\n\n%s" % (outmsg, | |
408 | magic_docs,mesc,mesc, |
|
408 | magic_docs,mesc,mesc, | |
409 | (' '+mesc).join(self.lsmagic()), |
|
409 | (' '+mesc).join(self.lsmagic()), | |
410 | Magic.auto_status[self.shell.automagic] ) ) |
|
410 | Magic.auto_status[self.shell.automagic] ) ) | |
411 | page.page(outmsg) |
|
411 | page.page(outmsg) | |
412 |
|
412 | |||
413 | def magic_automagic(self, parameter_s = ''): |
|
413 | def magic_automagic(self, parameter_s = ''): | |
414 | """Make magic functions callable without having to type the initial %. |
|
414 | """Make magic functions callable without having to type the initial %. | |
415 |
|
415 | |||
416 | Without argumentsl toggles on/off (when off, you must call it as |
|
416 | Without argumentsl toggles on/off (when off, you must call it as | |
417 | %automagic, of course). With arguments it sets the value, and you can |
|
417 | %automagic, of course). With arguments it sets the value, and you can | |
418 | use any of (case insensitive): |
|
418 | use any of (case insensitive): | |
419 |
|
419 | |||
420 | - on,1,True: to activate |
|
420 | - on,1,True: to activate | |
421 |
|
421 | |||
422 | - off,0,False: to deactivate. |
|
422 | - off,0,False: to deactivate. | |
423 |
|
423 | |||
424 | Note that magic functions have lowest priority, so if there's a |
|
424 | Note that magic functions have lowest priority, so if there's a | |
425 | variable whose name collides with that of a magic fn, automagic won't |
|
425 | variable whose name collides with that of a magic fn, automagic won't | |
426 | work for that function (you get the variable instead). However, if you |
|
426 | work for that function (you get the variable instead). However, if you | |
427 | delete the variable (del var), the previously shadowed magic function |
|
427 | delete the variable (del var), the previously shadowed magic function | |
428 | becomes visible to automagic again.""" |
|
428 | becomes visible to automagic again.""" | |
429 |
|
429 | |||
430 | arg = parameter_s.lower() |
|
430 | arg = parameter_s.lower() | |
431 | if parameter_s in ('on','1','true'): |
|
431 | if parameter_s in ('on','1','true'): | |
432 | self.shell.automagic = True |
|
432 | self.shell.automagic = True | |
433 | elif parameter_s in ('off','0','false'): |
|
433 | elif parameter_s in ('off','0','false'): | |
434 | self.shell.automagic = False |
|
434 | self.shell.automagic = False | |
435 | else: |
|
435 | else: | |
436 | self.shell.automagic = not self.shell.automagic |
|
436 | self.shell.automagic = not self.shell.automagic | |
437 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
437 | print '\n' + Magic.auto_status[self.shell.automagic] | |
438 |
|
438 | |||
439 | @testdec.skip_doctest |
|
439 | @testdec.skip_doctest | |
440 | def magic_autocall(self, parameter_s = ''): |
|
440 | def magic_autocall(self, parameter_s = ''): | |
441 | """Make functions callable without having to type parentheses. |
|
441 | """Make functions callable without having to type parentheses. | |
442 |
|
442 | |||
443 | Usage: |
|
443 | Usage: | |
444 |
|
444 | |||
445 | %autocall [mode] |
|
445 | %autocall [mode] | |
446 |
|
446 | |||
447 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the |
|
447 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the | |
448 | value is toggled on and off (remembering the previous state). |
|
448 | value is toggled on and off (remembering the previous state). | |
449 |
|
449 | |||
450 | In more detail, these values mean: |
|
450 | In more detail, these values mean: | |
451 |
|
451 | |||
452 | 0 -> fully disabled |
|
452 | 0 -> fully disabled | |
453 |
|
453 | |||
454 | 1 -> active, but do not apply if there are no arguments on the line. |
|
454 | 1 -> active, but do not apply if there are no arguments on the line. | |
455 |
|
455 | |||
456 | In this mode, you get: |
|
456 | In this mode, you get: | |
457 |
|
457 | |||
458 | In [1]: callable |
|
458 | In [1]: callable | |
459 | Out[1]: <built-in function callable> |
|
459 | Out[1]: <built-in function callable> | |
460 |
|
460 | |||
461 | In [2]: callable 'hello' |
|
461 | In [2]: callable 'hello' | |
462 | ------> callable('hello') |
|
462 | ------> callable('hello') | |
463 | Out[2]: False |
|
463 | Out[2]: False | |
464 |
|
464 | |||
465 | 2 -> Active always. Even if no arguments are present, the callable |
|
465 | 2 -> Active always. Even if no arguments are present, the callable | |
466 | object is called: |
|
466 | object is called: | |
467 |
|
467 | |||
468 | In [2]: float |
|
468 | In [2]: float | |
469 | ------> float() |
|
469 | ------> float() | |
470 | Out[2]: 0.0 |
|
470 | Out[2]: 0.0 | |
471 |
|
471 | |||
472 | Note that even with autocall off, you can still use '/' at the start of |
|
472 | Note that even with autocall off, you can still use '/' at the start of | |
473 | a line to treat the first argument on the command line as a function |
|
473 | a line to treat the first argument on the command line as a function | |
474 | and add parentheses to it: |
|
474 | and add parentheses to it: | |
475 |
|
475 | |||
476 | In [8]: /str 43 |
|
476 | In [8]: /str 43 | |
477 | ------> str(43) |
|
477 | ------> str(43) | |
478 | Out[8]: '43' |
|
478 | Out[8]: '43' | |
479 |
|
479 | |||
480 | # all-random (note for auto-testing) |
|
480 | # all-random (note for auto-testing) | |
481 | """ |
|
481 | """ | |
482 |
|
482 | |||
483 | if parameter_s: |
|
483 | if parameter_s: | |
484 | arg = int(parameter_s) |
|
484 | arg = int(parameter_s) | |
485 | else: |
|
485 | else: | |
486 | arg = 'toggle' |
|
486 | arg = 'toggle' | |
487 |
|
487 | |||
488 | if not arg in (0,1,2,'toggle'): |
|
488 | if not arg in (0,1,2,'toggle'): | |
489 | error('Valid modes: (0->Off, 1->Smart, 2->Full') |
|
489 | error('Valid modes: (0->Off, 1->Smart, 2->Full') | |
490 | return |
|
490 | return | |
491 |
|
491 | |||
492 | if arg in (0,1,2): |
|
492 | if arg in (0,1,2): | |
493 | self.shell.autocall = arg |
|
493 | self.shell.autocall = arg | |
494 | else: # toggle |
|
494 | else: # toggle | |
495 | if self.shell.autocall: |
|
495 | if self.shell.autocall: | |
496 | self._magic_state.autocall_save = self.shell.autocall |
|
496 | self._magic_state.autocall_save = self.shell.autocall | |
497 | self.shell.autocall = 0 |
|
497 | self.shell.autocall = 0 | |
498 | else: |
|
498 | else: | |
499 | try: |
|
499 | try: | |
500 | self.shell.autocall = self._magic_state.autocall_save |
|
500 | self.shell.autocall = self._magic_state.autocall_save | |
501 | except AttributeError: |
|
501 | except AttributeError: | |
502 | self.shell.autocall = self._magic_state.autocall_save = 1 |
|
502 | self.shell.autocall = self._magic_state.autocall_save = 1 | |
503 |
|
503 | |||
504 | print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall] |
|
504 | print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall] | |
505 |
|
505 | |||
506 |
|
506 | |||
507 | def magic_page(self, parameter_s=''): |
|
507 | def magic_page(self, parameter_s=''): | |
508 | """Pretty print the object and display it through a pager. |
|
508 | """Pretty print the object and display it through a pager. | |
509 |
|
509 | |||
510 | %page [options] OBJECT |
|
510 | %page [options] OBJECT | |
511 |
|
511 | |||
512 | If no object is given, use _ (last output). |
|
512 | If no object is given, use _ (last output). | |
513 |
|
513 | |||
514 | Options: |
|
514 | Options: | |
515 |
|
515 | |||
516 | -r: page str(object), don't pretty-print it.""" |
|
516 | -r: page str(object), don't pretty-print it.""" | |
517 |
|
517 | |||
518 | # After a function contributed by Olivier Aubert, slightly modified. |
|
518 | # After a function contributed by Olivier Aubert, slightly modified. | |
519 |
|
519 | |||
520 | # Process options/args |
|
520 | # Process options/args | |
521 | opts,args = self.parse_options(parameter_s,'r') |
|
521 | opts,args = self.parse_options(parameter_s,'r') | |
522 | raw = 'r' in opts |
|
522 | raw = 'r' in opts | |
523 |
|
523 | |||
524 | oname = args and args or '_' |
|
524 | oname = args and args or '_' | |
525 | info = self._ofind(oname) |
|
525 | info = self._ofind(oname) | |
526 | if info['found']: |
|
526 | if info['found']: | |
527 | txt = (raw and str or pformat)( info['obj'] ) |
|
527 | txt = (raw and str or pformat)( info['obj'] ) | |
528 | page.page(txt) |
|
528 | page.page(txt) | |
529 | else: |
|
529 | else: | |
530 | print 'Object `%s` not found' % oname |
|
530 | print 'Object `%s` not found' % oname | |
531 |
|
531 | |||
532 | def magic_profile(self, parameter_s=''): |
|
532 | def magic_profile(self, parameter_s=''): | |
533 | """Print your currently active IPython profile.""" |
|
533 | """Print your currently active IPython profile.""" | |
534 | if self.shell.profile: |
|
534 | if self.shell.profile: | |
535 | printpl('Current IPython profile: $self.shell.profile.') |
|
535 | printpl('Current IPython profile: $self.shell.profile.') | |
536 | else: |
|
536 | else: | |
537 | print 'No profile active.' |
|
537 | print 'No profile active.' | |
538 |
|
538 | |||
539 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
539 | def magic_pinfo(self, parameter_s='', namespaces=None): | |
540 | """Provide detailed information about an object. |
|
540 | """Provide detailed information about an object. | |
541 |
|
541 | |||
542 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
542 | '%pinfo object' is just a synonym for object? or ?object.""" | |
543 |
|
543 | |||
544 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
544 | #print 'pinfo par: <%s>' % parameter_s # dbg | |
545 |
|
545 | |||
546 |
|
546 | |||
547 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
547 | # detail_level: 0 -> obj? , 1 -> obj?? | |
548 | detail_level = 0 |
|
548 | detail_level = 0 | |
549 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
549 | # We need to detect if we got called as 'pinfo pinfo foo', which can | |
550 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
550 | # happen if the user types 'pinfo foo?' at the cmd line. | |
551 | pinfo,qmark1,oname,qmark2 = \ |
|
551 | pinfo,qmark1,oname,qmark2 = \ | |
552 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
552 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() | |
553 | if pinfo or qmark1 or qmark2: |
|
553 | if pinfo or qmark1 or qmark2: | |
554 | detail_level = 1 |
|
554 | detail_level = 1 | |
555 | if "*" in oname: |
|
555 | if "*" in oname: | |
556 | self.magic_psearch(oname) |
|
556 | self.magic_psearch(oname) | |
557 | else: |
|
557 | else: | |
558 | self.shell._inspect('pinfo', oname, detail_level=detail_level, |
|
558 | self.shell._inspect('pinfo', oname, detail_level=detail_level, | |
559 | namespaces=namespaces) |
|
559 | namespaces=namespaces) | |
560 |
|
560 | |||
561 | def magic_pinfo2(self, parameter_s='', namespaces=None): |
|
561 | def magic_pinfo2(self, parameter_s='', namespaces=None): | |
562 | """Provide extra detailed information about an object. |
|
562 | """Provide extra detailed information about an object. | |
563 |
|
563 | |||
564 | '%pinfo2 object' is just a synonym for object?? or ??object.""" |
|
564 | '%pinfo2 object' is just a synonym for object?? or ??object.""" | |
565 | self.shell._inspect('pinfo', parameter_s, detail_level=1, |
|
565 | self.shell._inspect('pinfo', parameter_s, detail_level=1, | |
566 | namespaces=namespaces) |
|
566 | namespaces=namespaces) | |
567 |
|
567 | |||
568 | @testdec.skip_doctest |
|
568 | @testdec.skip_doctest | |
569 | def magic_pdef(self, parameter_s='', namespaces=None): |
|
569 | def magic_pdef(self, parameter_s='', namespaces=None): | |
570 | """Print the definition header for any callable object. |
|
570 | """Print the definition header for any callable object. | |
571 |
|
571 | |||
572 | If the object is a class, print the constructor information. |
|
572 | If the object is a class, print the constructor information. | |
573 |
|
573 | |||
574 | Examples |
|
574 | Examples | |
575 | -------- |
|
575 | -------- | |
576 | :: |
|
576 | :: | |
577 |
|
577 | |||
578 | In [3]: %pdef urllib.urlopen |
|
578 | In [3]: %pdef urllib.urlopen | |
579 | urllib.urlopen(url, data=None, proxies=None) |
|
579 | urllib.urlopen(url, data=None, proxies=None) | |
580 | """ |
|
580 | """ | |
581 | self._inspect('pdef',parameter_s, namespaces) |
|
581 | self._inspect('pdef',parameter_s, namespaces) | |
582 |
|
582 | |||
583 | def magic_pdoc(self, parameter_s='', namespaces=None): |
|
583 | def magic_pdoc(self, parameter_s='', namespaces=None): | |
584 | """Print the docstring for an object. |
|
584 | """Print the docstring for an object. | |
585 |
|
585 | |||
586 | If the given object is a class, it will print both the class and the |
|
586 | If the given object is a class, it will print both the class and the | |
587 | constructor docstrings.""" |
|
587 | constructor docstrings.""" | |
588 | self._inspect('pdoc',parameter_s, namespaces) |
|
588 | self._inspect('pdoc',parameter_s, namespaces) | |
589 |
|
589 | |||
590 | def magic_psource(self, parameter_s='', namespaces=None): |
|
590 | def magic_psource(self, parameter_s='', namespaces=None): | |
591 | """Print (or run through pager) the source code for an object.""" |
|
591 | """Print (or run through pager) the source code for an object.""" | |
592 | self._inspect('psource',parameter_s, namespaces) |
|
592 | self._inspect('psource',parameter_s, namespaces) | |
593 |
|
593 | |||
594 | def magic_pfile(self, parameter_s=''): |
|
594 | def magic_pfile(self, parameter_s=''): | |
595 | """Print (or run through pager) the file where an object is defined. |
|
595 | """Print (or run through pager) the file where an object is defined. | |
596 |
|
596 | |||
597 | The file opens at the line where the object definition begins. IPython |
|
597 | The file opens at the line where the object definition begins. IPython | |
598 | will honor the environment variable PAGER if set, and otherwise will |
|
598 | will honor the environment variable PAGER if set, and otherwise will | |
599 | do its best to print the file in a convenient form. |
|
599 | do its best to print the file in a convenient form. | |
600 |
|
600 | |||
601 | If the given argument is not an object currently defined, IPython will |
|
601 | If the given argument is not an object currently defined, IPython will | |
602 | try to interpret it as a filename (automatically adding a .py extension |
|
602 | try to interpret it as a filename (automatically adding a .py extension | |
603 | if needed). You can thus use %pfile as a syntax highlighting code |
|
603 | if needed). You can thus use %pfile as a syntax highlighting code | |
604 | viewer.""" |
|
604 | viewer.""" | |
605 |
|
605 | |||
606 | # first interpret argument as an object name |
|
606 | # first interpret argument as an object name | |
607 | out = self._inspect('pfile',parameter_s) |
|
607 | out = self._inspect('pfile',parameter_s) | |
608 | # if not, try the input as a filename |
|
608 | # if not, try the input as a filename | |
609 | if out == 'not found': |
|
609 | if out == 'not found': | |
610 | try: |
|
610 | try: | |
611 | filename = get_py_filename(parameter_s) |
|
611 | filename = get_py_filename(parameter_s) | |
612 | except IOError,msg: |
|
612 | except IOError,msg: | |
613 | print msg |
|
613 | print msg | |
614 | return |
|
614 | return | |
615 | page.page(self.shell.inspector.format(file(filename).read())) |
|
615 | page.page(self.shell.inspector.format(file(filename).read())) | |
616 |
|
616 | |||
617 | def magic_psearch(self, parameter_s=''): |
|
617 | def magic_psearch(self, parameter_s=''): | |
618 | """Search for object in namespaces by wildcard. |
|
618 | """Search for object in namespaces by wildcard. | |
619 |
|
619 | |||
620 | %psearch [options] PATTERN [OBJECT TYPE] |
|
620 | %psearch [options] PATTERN [OBJECT TYPE] | |
621 |
|
621 | |||
622 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
622 | Note: ? can be used as a synonym for %psearch, at the beginning or at | |
623 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
623 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the | |
624 | rest of the command line must be unchanged (options come first), so |
|
624 | rest of the command line must be unchanged (options come first), so | |
625 | for example the following forms are equivalent |
|
625 | for example the following forms are equivalent | |
626 |
|
626 | |||
627 | %psearch -i a* function |
|
627 | %psearch -i a* function | |
628 | -i a* function? |
|
628 | -i a* function? | |
629 | ?-i a* function |
|
629 | ?-i a* function | |
630 |
|
630 | |||
631 | Arguments: |
|
631 | Arguments: | |
632 |
|
632 | |||
633 | PATTERN |
|
633 | PATTERN | |
634 |
|
634 | |||
635 | where PATTERN is a string containing * as a wildcard similar to its |
|
635 | where PATTERN is a string containing * as a wildcard similar to its | |
636 | use in a shell. The pattern is matched in all namespaces on the |
|
636 | use in a shell. The pattern is matched in all namespaces on the | |
637 | search path. By default objects starting with a single _ are not |
|
637 | search path. By default objects starting with a single _ are not | |
638 | matched, many IPython generated objects have a single |
|
638 | matched, many IPython generated objects have a single | |
639 | underscore. The default is case insensitive matching. Matching is |
|
639 | underscore. The default is case insensitive matching. Matching is | |
640 | also done on the attributes of objects and not only on the objects |
|
640 | also done on the attributes of objects and not only on the objects | |
641 | in a module. |
|
641 | in a module. | |
642 |
|
642 | |||
643 | [OBJECT TYPE] |
|
643 | [OBJECT TYPE] | |
644 |
|
644 | |||
645 | Is the name of a python type from the types module. The name is |
|
645 | Is the name of a python type from the types module. The name is | |
646 | given in lowercase without the ending type, ex. StringType is |
|
646 | given in lowercase without the ending type, ex. StringType is | |
647 | written string. By adding a type here only objects matching the |
|
647 | written string. By adding a type here only objects matching the | |
648 | given type are matched. Using all here makes the pattern match all |
|
648 | given type are matched. Using all here makes the pattern match all | |
649 | types (this is the default). |
|
649 | types (this is the default). | |
650 |
|
650 | |||
651 | Options: |
|
651 | Options: | |
652 |
|
652 | |||
653 | -a: makes the pattern match even objects whose names start with a |
|
653 | -a: makes the pattern match even objects whose names start with a | |
654 | single underscore. These names are normally ommitted from the |
|
654 | single underscore. These names are normally ommitted from the | |
655 | search. |
|
655 | search. | |
656 |
|
656 | |||
657 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
657 | -i/-c: make the pattern case insensitive/sensitive. If neither of | |
658 | these options is given, the default is read from your ipythonrc |
|
658 | these options is given, the default is read from your ipythonrc | |
659 | file. The option name which sets this value is |
|
659 | file. The option name which sets this value is | |
660 | 'wildcards_case_sensitive'. If this option is not specified in your |
|
660 | 'wildcards_case_sensitive'. If this option is not specified in your | |
661 | ipythonrc file, IPython's internal default is to do a case sensitive |
|
661 | ipythonrc file, IPython's internal default is to do a case sensitive | |
662 | search. |
|
662 | search. | |
663 |
|
663 | |||
664 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
664 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you | |
665 | specifiy can be searched in any of the following namespaces: |
|
665 | specifiy can be searched in any of the following namespaces: | |
666 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
666 | 'builtin', 'user', 'user_global','internal', 'alias', where | |
667 | 'builtin' and 'user' are the search defaults. Note that you should |
|
667 | 'builtin' and 'user' are the search defaults. Note that you should | |
668 | not use quotes when specifying namespaces. |
|
668 | not use quotes when specifying namespaces. | |
669 |
|
669 | |||
670 | 'Builtin' contains the python module builtin, 'user' contains all |
|
670 | 'Builtin' contains the python module builtin, 'user' contains all | |
671 | user data, 'alias' only contain the shell aliases and no python |
|
671 | user data, 'alias' only contain the shell aliases and no python | |
672 | objects, 'internal' contains objects used by IPython. The |
|
672 | objects, 'internal' contains objects used by IPython. The | |
673 | 'user_global' namespace is only used by embedded IPython instances, |
|
673 | 'user_global' namespace is only used by embedded IPython instances, | |
674 | and it contains module-level globals. You can add namespaces to the |
|
674 | and it contains module-level globals. You can add namespaces to the | |
675 | search with -s or exclude them with -e (these options can be given |
|
675 | search with -s or exclude them with -e (these options can be given | |
676 | more than once). |
|
676 | more than once). | |
677 |
|
677 | |||
678 | Examples: |
|
678 | Examples: | |
679 |
|
679 | |||
680 | %psearch a* -> objects beginning with an a |
|
680 | %psearch a* -> objects beginning with an a | |
681 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
681 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a | |
682 | %psearch a* function -> all functions beginning with an a |
|
682 | %psearch a* function -> all functions beginning with an a | |
683 | %psearch re.e* -> objects beginning with an e in module re |
|
683 | %psearch re.e* -> objects beginning with an e in module re | |
684 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
684 | %psearch r*.e* -> objects that start with e in modules starting in r | |
685 | %psearch r*.* string -> all strings in modules beginning with r |
|
685 | %psearch r*.* string -> all strings in modules beginning with r | |
686 |
|
686 | |||
687 | Case sensitve search: |
|
687 | Case sensitve search: | |
688 |
|
688 | |||
689 | %psearch -c a* list all object beginning with lower case a |
|
689 | %psearch -c a* list all object beginning with lower case a | |
690 |
|
690 | |||
691 | Show objects beginning with a single _: |
|
691 | Show objects beginning with a single _: | |
692 |
|
692 | |||
693 | %psearch -a _* list objects beginning with a single underscore""" |
|
693 | %psearch -a _* list objects beginning with a single underscore""" | |
694 | try: |
|
694 | try: | |
695 | parameter_s = parameter_s.encode('ascii') |
|
695 | parameter_s = parameter_s.encode('ascii') | |
696 | except UnicodeEncodeError: |
|
696 | except UnicodeEncodeError: | |
697 | print 'Python identifiers can only contain ascii characters.' |
|
697 | print 'Python identifiers can only contain ascii characters.' | |
698 | return |
|
698 | return | |
699 |
|
699 | |||
700 | # default namespaces to be searched |
|
700 | # default namespaces to be searched | |
701 | def_search = ['user','builtin'] |
|
701 | def_search = ['user','builtin'] | |
702 |
|
702 | |||
703 | # Process options/args |
|
703 | # Process options/args | |
704 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
704 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) | |
705 | opt = opts.get |
|
705 | opt = opts.get | |
706 | shell = self.shell |
|
706 | shell = self.shell | |
707 | psearch = shell.inspector.psearch |
|
707 | psearch = shell.inspector.psearch | |
708 |
|
708 | |||
709 | # select case options |
|
709 | # select case options | |
710 | if opts.has_key('i'): |
|
710 | if opts.has_key('i'): | |
711 | ignore_case = True |
|
711 | ignore_case = True | |
712 | elif opts.has_key('c'): |
|
712 | elif opts.has_key('c'): | |
713 | ignore_case = False |
|
713 | ignore_case = False | |
714 | else: |
|
714 | else: | |
715 | ignore_case = not shell.wildcards_case_sensitive |
|
715 | ignore_case = not shell.wildcards_case_sensitive | |
716 |
|
716 | |||
717 | # Build list of namespaces to search from user options |
|
717 | # Build list of namespaces to search from user options | |
718 | def_search.extend(opt('s',[])) |
|
718 | def_search.extend(opt('s',[])) | |
719 | ns_exclude = ns_exclude=opt('e',[]) |
|
719 | ns_exclude = ns_exclude=opt('e',[]) | |
720 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
720 | ns_search = [nm for nm in def_search if nm not in ns_exclude] | |
721 |
|
721 | |||
722 | # Call the actual search |
|
722 | # Call the actual search | |
723 | try: |
|
723 | try: | |
724 | psearch(args,shell.ns_table,ns_search, |
|
724 | psearch(args,shell.ns_table,ns_search, | |
725 | show_all=opt('a'),ignore_case=ignore_case) |
|
725 | show_all=opt('a'),ignore_case=ignore_case) | |
726 | except: |
|
726 | except: | |
727 | shell.showtraceback() |
|
727 | shell.showtraceback() | |
728 |
|
728 | |||
729 | @testdec.skip_doctest |
|
729 | @testdec.skip_doctest | |
730 | def magic_who_ls(self, parameter_s=''): |
|
730 | def magic_who_ls(self, parameter_s=''): | |
731 | """Return a sorted list of all interactive variables. |
|
731 | """Return a sorted list of all interactive variables. | |
732 |
|
732 | |||
733 | If arguments are given, only variables of types matching these |
|
733 | If arguments are given, only variables of types matching these | |
734 | arguments are returned. |
|
734 | arguments are returned. | |
735 |
|
735 | |||
736 | Examples |
|
736 | Examples | |
737 | -------- |
|
737 | -------- | |
738 |
|
738 | |||
739 | Define two variables and list them with who_ls:: |
|
739 | Define two variables and list them with who_ls:: | |
740 |
|
740 | |||
741 | In [1]: alpha = 123 |
|
741 | In [1]: alpha = 123 | |
742 |
|
742 | |||
743 | In [2]: beta = 'test' |
|
743 | In [2]: beta = 'test' | |
744 |
|
744 | |||
745 | In [3]: %who_ls |
|
745 | In [3]: %who_ls | |
746 | Out[3]: ['alpha', 'beta'] |
|
746 | Out[3]: ['alpha', 'beta'] | |
747 |
|
747 | |||
748 | In [4]: %who_ls int |
|
748 | In [4]: %who_ls int | |
749 | Out[4]: ['alpha'] |
|
749 | Out[4]: ['alpha'] | |
750 |
|
750 | |||
751 | In [5]: %who_ls str |
|
751 | In [5]: %who_ls str | |
752 | Out[5]: ['beta'] |
|
752 | Out[5]: ['beta'] | |
753 | """ |
|
753 | """ | |
754 |
|
754 | |||
755 | user_ns = self.shell.user_ns |
|
755 | user_ns = self.shell.user_ns | |
756 | internal_ns = self.shell.internal_ns |
|
756 | internal_ns = self.shell.internal_ns | |
757 | user_ns_hidden = self.shell.user_ns_hidden |
|
757 | user_ns_hidden = self.shell.user_ns_hidden | |
758 | out = [ i for i in user_ns |
|
758 | out = [ i for i in user_ns | |
759 | if not i.startswith('_') \ |
|
759 | if not i.startswith('_') \ | |
760 | and not (i in internal_ns or i in user_ns_hidden) ] |
|
760 | and not (i in internal_ns or i in user_ns_hidden) ] | |
761 |
|
761 | |||
762 | typelist = parameter_s.split() |
|
762 | typelist = parameter_s.split() | |
763 | if typelist: |
|
763 | if typelist: | |
764 | typeset = set(typelist) |
|
764 | typeset = set(typelist) | |
765 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] |
|
765 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] | |
766 |
|
766 | |||
767 | out.sort() |
|
767 | out.sort() | |
768 | return out |
|
768 | return out | |
769 |
|
769 | |||
770 | @testdec.skip_doctest |
|
770 | @testdec.skip_doctest | |
771 | def magic_who(self, parameter_s=''): |
|
771 | def magic_who(self, parameter_s=''): | |
772 | """Print all interactive variables, with some minimal formatting. |
|
772 | """Print all interactive variables, with some minimal formatting. | |
773 |
|
773 | |||
774 | If any arguments are given, only variables whose type matches one of |
|
774 | If any arguments are given, only variables whose type matches one of | |
775 | these are printed. For example: |
|
775 | these are printed. For example: | |
776 |
|
776 | |||
777 | %who function str |
|
777 | %who function str | |
778 |
|
778 | |||
779 | will only list functions and strings, excluding all other types of |
|
779 | will only list functions and strings, excluding all other types of | |
780 | variables. To find the proper type names, simply use type(var) at a |
|
780 | variables. To find the proper type names, simply use type(var) at a | |
781 | command line to see how python prints type names. For example: |
|
781 | command line to see how python prints type names. For example: | |
782 |
|
782 | |||
783 | In [1]: type('hello')\\ |
|
783 | In [1]: type('hello')\\ | |
784 | Out[1]: <type 'str'> |
|
784 | Out[1]: <type 'str'> | |
785 |
|
785 | |||
786 | indicates that the type name for strings is 'str'. |
|
786 | indicates that the type name for strings is 'str'. | |
787 |
|
787 | |||
788 | %who always excludes executed names loaded through your configuration |
|
788 | %who always excludes executed names loaded through your configuration | |
789 | file and things which are internal to IPython. |
|
789 | file and things which are internal to IPython. | |
790 |
|
790 | |||
791 | This is deliberate, as typically you may load many modules and the |
|
791 | This is deliberate, as typically you may load many modules and the | |
792 | purpose of %who is to show you only what you've manually defined. |
|
792 | purpose of %who is to show you only what you've manually defined. | |
793 |
|
793 | |||
794 | Examples |
|
794 | Examples | |
795 | -------- |
|
795 | -------- | |
796 |
|
796 | |||
797 | Define two variables and list them with who:: |
|
797 | Define two variables and list them with who:: | |
798 |
|
798 | |||
799 | In [1]: alpha = 123 |
|
799 | In [1]: alpha = 123 | |
800 |
|
800 | |||
801 | In [2]: beta = 'test' |
|
801 | In [2]: beta = 'test' | |
802 |
|
802 | |||
803 | In [3]: %who |
|
803 | In [3]: %who | |
804 | alpha beta |
|
804 | alpha beta | |
805 |
|
805 | |||
806 | In [4]: %who int |
|
806 | In [4]: %who int | |
807 | alpha |
|
807 | alpha | |
808 |
|
808 | |||
809 | In [5]: %who str |
|
809 | In [5]: %who str | |
810 | beta |
|
810 | beta | |
811 | """ |
|
811 | """ | |
812 |
|
812 | |||
813 | varlist = self.magic_who_ls(parameter_s) |
|
813 | varlist = self.magic_who_ls(parameter_s) | |
814 | if not varlist: |
|
814 | if not varlist: | |
815 | if parameter_s: |
|
815 | if parameter_s: | |
816 | print 'No variables match your requested type.' |
|
816 | print 'No variables match your requested type.' | |
817 | else: |
|
817 | else: | |
818 | print 'Interactive namespace is empty.' |
|
818 | print 'Interactive namespace is empty.' | |
819 | return |
|
819 | return | |
820 |
|
820 | |||
821 | # if we have variables, move on... |
|
821 | # if we have variables, move on... | |
822 | count = 0 |
|
822 | count = 0 | |
823 | for i in varlist: |
|
823 | for i in varlist: | |
824 | print i+'\t', |
|
824 | print i+'\t', | |
825 | count += 1 |
|
825 | count += 1 | |
826 | if count > 8: |
|
826 | if count > 8: | |
827 | count = 0 |
|
827 | count = 0 | |
828 |
|
828 | |||
829 |
|
829 | |||
830 |
|
830 | |||
831 | @testdec.skip_doctest |
|
831 | @testdec.skip_doctest | |
832 | def magic_whos(self, parameter_s=''): |
|
832 | def magic_whos(self, parameter_s=''): | |
833 | """Like %who, but gives some extra information about each variable. |
|
833 | """Like %who, but gives some extra information about each variable. | |
834 |
|
834 | |||
835 | The same type filtering of %who can be applied here. |
|
835 | The same type filtering of %who can be applied here. | |
836 |
|
836 | |||
837 | For all variables, the type is printed. Additionally it prints: |
|
837 | For all variables, the type is printed. Additionally it prints: | |
838 |
|
838 | |||
839 | - For {},[],(): their length. |
|
839 | - For {},[],(): their length. | |
840 |
|
840 | |||
841 | - For numpy arrays, a summary with shape, number of |
|
841 | - For numpy arrays, a summary with shape, number of | |
842 | elements, typecode and size in memory. |
|
842 | elements, typecode and size in memory. | |
843 |
|
843 | |||
844 | - Everything else: a string representation, snipping their middle if |
|
844 | - Everything else: a string representation, snipping their middle if | |
845 | too long. |
|
845 | too long. | |
846 |
|
846 | |||
847 | Examples |
|
847 | Examples | |
848 | -------- |
|
848 | -------- | |
849 |
|
849 | |||
850 | Define two variables and list them with whos:: |
|
850 | Define two variables and list them with whos:: | |
851 |
|
851 | |||
852 | In [1]: alpha = 123 |
|
852 | In [1]: alpha = 123 | |
853 |
|
853 | |||
854 | In [2]: beta = 'test' |
|
854 | In [2]: beta = 'test' | |
855 |
|
855 | |||
856 | In [3]: %whos |
|
856 | In [3]: %whos | |
857 | Variable Type Data/Info |
|
857 | Variable Type Data/Info | |
858 | -------------------------------- |
|
858 | -------------------------------- | |
859 | alpha int 123 |
|
859 | alpha int 123 | |
860 | beta str test |
|
860 | beta str test | |
861 | """ |
|
861 | """ | |
862 |
|
862 | |||
863 | varnames = self.magic_who_ls(parameter_s) |
|
863 | varnames = self.magic_who_ls(parameter_s) | |
864 | if not varnames: |
|
864 | if not varnames: | |
865 | if parameter_s: |
|
865 | if parameter_s: | |
866 | print 'No variables match your requested type.' |
|
866 | print 'No variables match your requested type.' | |
867 | else: |
|
867 | else: | |
868 | print 'Interactive namespace is empty.' |
|
868 | print 'Interactive namespace is empty.' | |
869 | return |
|
869 | return | |
870 |
|
870 | |||
871 | # if we have variables, move on... |
|
871 | # if we have variables, move on... | |
872 |
|
872 | |||
873 | # for these types, show len() instead of data: |
|
873 | # for these types, show len() instead of data: | |
874 | seq_types = ['dict', 'list', 'tuple'] |
|
874 | seq_types = ['dict', 'list', 'tuple'] | |
875 |
|
875 | |||
876 | # for numpy/Numeric arrays, display summary info |
|
876 | # for numpy/Numeric arrays, display summary info | |
877 | try: |
|
877 | try: | |
878 | import numpy |
|
878 | import numpy | |
879 | except ImportError: |
|
879 | except ImportError: | |
880 | ndarray_type = None |
|
880 | ndarray_type = None | |
881 | else: |
|
881 | else: | |
882 | ndarray_type = numpy.ndarray.__name__ |
|
882 | ndarray_type = numpy.ndarray.__name__ | |
883 | try: |
|
883 | try: | |
884 | import Numeric |
|
884 | import Numeric | |
885 | except ImportError: |
|
885 | except ImportError: | |
886 | array_type = None |
|
886 | array_type = None | |
887 | else: |
|
887 | else: | |
888 | array_type = Numeric.ArrayType.__name__ |
|
888 | array_type = Numeric.ArrayType.__name__ | |
889 |
|
889 | |||
890 | # Find all variable names and types so we can figure out column sizes |
|
890 | # Find all variable names and types so we can figure out column sizes | |
891 | def get_vars(i): |
|
891 | def get_vars(i): | |
892 | return self.shell.user_ns[i] |
|
892 | return self.shell.user_ns[i] | |
893 |
|
893 | |||
894 | # some types are well known and can be shorter |
|
894 | # some types are well known and can be shorter | |
895 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} |
|
895 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} | |
896 | def type_name(v): |
|
896 | def type_name(v): | |
897 | tn = type(v).__name__ |
|
897 | tn = type(v).__name__ | |
898 | return abbrevs.get(tn,tn) |
|
898 | return abbrevs.get(tn,tn) | |
899 |
|
899 | |||
900 | varlist = map(get_vars,varnames) |
|
900 | varlist = map(get_vars,varnames) | |
901 |
|
901 | |||
902 | typelist = [] |
|
902 | typelist = [] | |
903 | for vv in varlist: |
|
903 | for vv in varlist: | |
904 | tt = type_name(vv) |
|
904 | tt = type_name(vv) | |
905 |
|
905 | |||
906 | if tt=='instance': |
|
906 | if tt=='instance': | |
907 | typelist.append( abbrevs.get(str(vv.__class__), |
|
907 | typelist.append( abbrevs.get(str(vv.__class__), | |
908 | str(vv.__class__))) |
|
908 | str(vv.__class__))) | |
909 | else: |
|
909 | else: | |
910 | typelist.append(tt) |
|
910 | typelist.append(tt) | |
911 |
|
911 | |||
912 | # column labels and # of spaces as separator |
|
912 | # column labels and # of spaces as separator | |
913 | varlabel = 'Variable' |
|
913 | varlabel = 'Variable' | |
914 | typelabel = 'Type' |
|
914 | typelabel = 'Type' | |
915 | datalabel = 'Data/Info' |
|
915 | datalabel = 'Data/Info' | |
916 | colsep = 3 |
|
916 | colsep = 3 | |
917 | # variable format strings |
|
917 | # variable format strings | |
918 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" |
|
918 | vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)" | |
919 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' |
|
919 | vfmt_short = '$vstr[:25]<...>$vstr[-25:]' | |
920 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
920 | aformat = "%s: %s elems, type `%s`, %s bytes" | |
921 | # find the size of the columns to format the output nicely |
|
921 | # find the size of the columns to format the output nicely | |
922 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
922 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep | |
923 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
923 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep | |
924 | # table header |
|
924 | # table header | |
925 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
925 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ | |
926 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
926 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) | |
927 | # and the table itself |
|
927 | # and the table itself | |
928 | kb = 1024 |
|
928 | kb = 1024 | |
929 | Mb = 1048576 # kb**2 |
|
929 | Mb = 1048576 # kb**2 | |
930 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
930 | for vname,var,vtype in zip(varnames,varlist,typelist): | |
931 | print itpl(vformat), |
|
931 | print itpl(vformat), | |
932 | if vtype in seq_types: |
|
932 | if vtype in seq_types: | |
933 | print "n="+str(len(var)) |
|
933 | print "n="+str(len(var)) | |
934 | elif vtype in [array_type,ndarray_type]: |
|
934 | elif vtype in [array_type,ndarray_type]: | |
935 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
935 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] | |
936 | if vtype==ndarray_type: |
|
936 | if vtype==ndarray_type: | |
937 | # numpy |
|
937 | # numpy | |
938 | vsize = var.size |
|
938 | vsize = var.size | |
939 | vbytes = vsize*var.itemsize |
|
939 | vbytes = vsize*var.itemsize | |
940 | vdtype = var.dtype |
|
940 | vdtype = var.dtype | |
941 | else: |
|
941 | else: | |
942 | # Numeric |
|
942 | # Numeric | |
943 | vsize = Numeric.size(var) |
|
943 | vsize = Numeric.size(var) | |
944 | vbytes = vsize*var.itemsize() |
|
944 | vbytes = vsize*var.itemsize() | |
945 | vdtype = var.typecode() |
|
945 | vdtype = var.typecode() | |
946 |
|
946 | |||
947 | if vbytes < 100000: |
|
947 | if vbytes < 100000: | |
948 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
948 | print aformat % (vshape,vsize,vdtype,vbytes) | |
949 | else: |
|
949 | else: | |
950 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
950 | print aformat % (vshape,vsize,vdtype,vbytes), | |
951 | if vbytes < Mb: |
|
951 | if vbytes < Mb: | |
952 | print '(%s kb)' % (vbytes/kb,) |
|
952 | print '(%s kb)' % (vbytes/kb,) | |
953 | else: |
|
953 | else: | |
954 | print '(%s Mb)' % (vbytes/Mb,) |
|
954 | print '(%s Mb)' % (vbytes/Mb,) | |
955 | else: |
|
955 | else: | |
956 | try: |
|
956 | try: | |
957 | vstr = str(var) |
|
957 | vstr = str(var) | |
958 | except UnicodeEncodeError: |
|
958 | except UnicodeEncodeError: | |
959 | vstr = unicode(var).encode(sys.getdefaultencoding(), |
|
959 | vstr = unicode(var).encode(sys.getdefaultencoding(), | |
960 | 'backslashreplace') |
|
960 | 'backslashreplace') | |
961 | vstr = vstr.replace('\n','\\n') |
|
961 | vstr = vstr.replace('\n','\\n') | |
962 | if len(vstr) < 50: |
|
962 | if len(vstr) < 50: | |
963 | print vstr |
|
963 | print vstr | |
964 | else: |
|
964 | else: | |
965 | printpl(vfmt_short) |
|
965 | printpl(vfmt_short) | |
966 |
|
966 | |||
967 | def magic_reset(self, parameter_s=''): |
|
967 | def magic_reset(self, parameter_s=''): | |
968 | """Resets the namespace by removing all names defined by the user. |
|
968 | """Resets the namespace by removing all names defined by the user. | |
969 |
|
969 | |||
970 | Parameters |
|
970 | Parameters | |
971 | ---------- |
|
971 | ---------- | |
972 | -f : force reset without asking for confirmation. |
|
972 | -f : force reset without asking for confirmation. | |
973 |
|
973 | |||
974 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. |
|
974 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. | |
975 | References to objects may be kept. By default (without this option), |
|
975 | References to objects may be kept. By default (without this option), | |
976 | we do a 'hard' reset, giving you a new session and removing all |
|
976 | we do a 'hard' reset, giving you a new session and removing all | |
977 | references to objects from the current session. |
|
977 | references to objects from the current session. | |
978 |
|
978 | |||
979 | Examples |
|
979 | Examples | |
980 | -------- |
|
980 | -------- | |
981 | In [6]: a = 1 |
|
981 | In [6]: a = 1 | |
982 |
|
982 | |||
983 | In [7]: a |
|
983 | In [7]: a | |
984 | Out[7]: 1 |
|
984 | Out[7]: 1 | |
985 |
|
985 | |||
986 | In [8]: 'a' in _ip.user_ns |
|
986 | In [8]: 'a' in _ip.user_ns | |
987 | Out[8]: True |
|
987 | Out[8]: True | |
988 |
|
988 | |||
989 | In [9]: %reset -f |
|
989 | In [9]: %reset -f | |
990 |
|
990 | |||
991 | In [1]: 'a' in _ip.user_ns |
|
991 | In [1]: 'a' in _ip.user_ns | |
992 | Out[1]: False |
|
992 | Out[1]: False | |
993 | """ |
|
993 | """ | |
994 | opts, args = self.parse_options(parameter_s,'sf') |
|
994 | opts, args = self.parse_options(parameter_s,'sf') | |
995 | if 'f' in opts: |
|
995 | if 'f' in opts: | |
996 | ans = True |
|
996 | ans = True | |
997 | else: |
|
997 | else: | |
998 | ans = self.shell.ask_yes_no( |
|
998 | ans = self.shell.ask_yes_no( | |
999 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
999 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") | |
1000 | if not ans: |
|
1000 | if not ans: | |
1001 | print 'Nothing done.' |
|
1001 | print 'Nothing done.' | |
1002 | return |
|
1002 | return | |
1003 |
|
1003 | |||
1004 | if 's' in opts: # Soft reset |
|
1004 | if 's' in opts: # Soft reset | |
1005 | user_ns = self.shell.user_ns |
|
1005 | user_ns = self.shell.user_ns | |
1006 | for i in self.magic_who_ls(): |
|
1006 | for i in self.magic_who_ls(): | |
1007 | del(user_ns[i]) |
|
1007 | del(user_ns[i]) | |
1008 |
|
1008 | |||
1009 | else: # Hard reset |
|
1009 | else: # Hard reset | |
1010 |
self.shell.reset(new_session = |
|
1010 | self.shell.reset(new_session = False) | |
1011 |
|
1011 | |||
1012 |
|
1012 | |||
1013 |
|
1013 | |||
1014 | def magic_reset_selective(self, parameter_s=''): |
|
1014 | def magic_reset_selective(self, parameter_s=''): | |
1015 | """Resets the namespace by removing names defined by the user. |
|
1015 | """Resets the namespace by removing names defined by the user. | |
1016 |
|
1016 | |||
1017 | Input/Output history are left around in case you need them. |
|
1017 | Input/Output history are left around in case you need them. | |
1018 |
|
1018 | |||
1019 | %reset_selective [-f] regex |
|
1019 | %reset_selective [-f] regex | |
1020 |
|
1020 | |||
1021 | No action is taken if regex is not included |
|
1021 | No action is taken if regex is not included | |
1022 |
|
1022 | |||
1023 | Options |
|
1023 | Options | |
1024 | -f : force reset without asking for confirmation. |
|
1024 | -f : force reset without asking for confirmation. | |
1025 |
|
1025 | |||
1026 | Examples |
|
1026 | Examples | |
1027 | -------- |
|
1027 | -------- | |
1028 |
|
1028 | |||
1029 | We first fully reset the namespace so your output looks identical to |
|
1029 | We first fully reset the namespace so your output looks identical to | |
1030 | this example for pedagogical reasons; in practice you do not need a |
|
1030 | this example for pedagogical reasons; in practice you do not need a | |
1031 | full reset. |
|
1031 | full reset. | |
1032 |
|
1032 | |||
1033 | In [1]: %reset -f |
|
1033 | In [1]: %reset -f | |
1034 |
|
1034 | |||
1035 | Now, with a clean namespace we can make a few variables and use |
|
1035 | Now, with a clean namespace we can make a few variables and use | |
1036 | %reset_selective to only delete names that match our regexp: |
|
1036 | %reset_selective to only delete names that match our regexp: | |
1037 |
|
1037 | |||
1038 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 |
|
1038 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 | |
1039 |
|
1039 | |||
1040 | In [3]: who_ls |
|
1040 | In [3]: who_ls | |
1041 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] |
|
1041 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] | |
1042 |
|
1042 | |||
1043 | In [4]: %reset_selective -f b[2-3]m |
|
1043 | In [4]: %reset_selective -f b[2-3]m | |
1044 |
|
1044 | |||
1045 | In [5]: who_ls |
|
1045 | In [5]: who_ls | |
1046 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1046 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] | |
1047 |
|
1047 | |||
1048 | In [6]: %reset_selective -f d |
|
1048 | In [6]: %reset_selective -f d | |
1049 |
|
1049 | |||
1050 | In [7]: who_ls |
|
1050 | In [7]: who_ls | |
1051 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1051 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] | |
1052 |
|
1052 | |||
1053 | In [8]: %reset_selective -f c |
|
1053 | In [8]: %reset_selective -f c | |
1054 |
|
1054 | |||
1055 | In [9]: who_ls |
|
1055 | In [9]: who_ls | |
1056 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] |
|
1056 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] | |
1057 |
|
1057 | |||
1058 | In [10]: %reset_selective -f b |
|
1058 | In [10]: %reset_selective -f b | |
1059 |
|
1059 | |||
1060 | In [11]: who_ls |
|
1060 | In [11]: who_ls | |
1061 | Out[11]: ['a'] |
|
1061 | Out[11]: ['a'] | |
1062 | """ |
|
1062 | """ | |
1063 |
|
1063 | |||
1064 | opts, regex = self.parse_options(parameter_s,'f') |
|
1064 | opts, regex = self.parse_options(parameter_s,'f') | |
1065 |
|
1065 | |||
1066 | if opts.has_key('f'): |
|
1066 | if opts.has_key('f'): | |
1067 | ans = True |
|
1067 | ans = True | |
1068 | else: |
|
1068 | else: | |
1069 | ans = self.shell.ask_yes_no( |
|
1069 | ans = self.shell.ask_yes_no( | |
1070 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") |
|
1070 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ") | |
1071 | if not ans: |
|
1071 | if not ans: | |
1072 | print 'Nothing done.' |
|
1072 | print 'Nothing done.' | |
1073 | return |
|
1073 | return | |
1074 | user_ns = self.shell.user_ns |
|
1074 | user_ns = self.shell.user_ns | |
1075 | if not regex: |
|
1075 | if not regex: | |
1076 | print 'No regex pattern specified. Nothing done.' |
|
1076 | print 'No regex pattern specified. Nothing done.' | |
1077 | return |
|
1077 | return | |
1078 | else: |
|
1078 | else: | |
1079 | try: |
|
1079 | try: | |
1080 | m = re.compile(regex) |
|
1080 | m = re.compile(regex) | |
1081 | except TypeError: |
|
1081 | except TypeError: | |
1082 | raise TypeError('regex must be a string or compiled pattern') |
|
1082 | raise TypeError('regex must be a string or compiled pattern') | |
1083 | for i in self.magic_who_ls(): |
|
1083 | for i in self.magic_who_ls(): | |
1084 | if m.search(i): |
|
1084 | if m.search(i): | |
1085 | del(user_ns[i]) |
|
1085 | del(user_ns[i]) | |
1086 |
|
1086 | |||
1087 | def magic_logstart(self,parameter_s=''): |
|
1087 | def magic_logstart(self,parameter_s=''): | |
1088 | """Start logging anywhere in a session. |
|
1088 | """Start logging anywhere in a session. | |
1089 |
|
1089 | |||
1090 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
1090 | %logstart [-o|-r|-t] [log_name [log_mode]] | |
1091 |
|
1091 | |||
1092 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
1092 | If no name is given, it defaults to a file named 'ipython_log.py' in your | |
1093 | current directory, in 'rotate' mode (see below). |
|
1093 | current directory, in 'rotate' mode (see below). | |
1094 |
|
1094 | |||
1095 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
1095 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your | |
1096 | history up to that point and then continues logging. |
|
1096 | history up to that point and then continues logging. | |
1097 |
|
1097 | |||
1098 | %logstart takes a second optional parameter: logging mode. This can be one |
|
1098 | %logstart takes a second optional parameter: logging mode. This can be one | |
1099 | of (note that the modes are given unquoted):\\ |
|
1099 | of (note that the modes are given unquoted):\\ | |
1100 | append: well, that says it.\\ |
|
1100 | append: well, that says it.\\ | |
1101 | backup: rename (if exists) to name~ and start name.\\ |
|
1101 | backup: rename (if exists) to name~ and start name.\\ | |
1102 | global: single logfile in your home dir, appended to.\\ |
|
1102 | global: single logfile in your home dir, appended to.\\ | |
1103 | over : overwrite existing log.\\ |
|
1103 | over : overwrite existing log.\\ | |
1104 | rotate: create rotating logs name.1~, name.2~, etc. |
|
1104 | rotate: create rotating logs name.1~, name.2~, etc. | |
1105 |
|
1105 | |||
1106 | Options: |
|
1106 | Options: | |
1107 |
|
1107 | |||
1108 | -o: log also IPython's output. In this mode, all commands which |
|
1108 | -o: log also IPython's output. In this mode, all commands which | |
1109 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
1109 | generate an Out[NN] prompt are recorded to the logfile, right after | |
1110 | their corresponding input line. The output lines are always |
|
1110 | their corresponding input line. The output lines are always | |
1111 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
1111 | prepended with a '#[Out]# ' marker, so that the log remains valid | |
1112 | Python code. |
|
1112 | Python code. | |
1113 |
|
1113 | |||
1114 | Since this marker is always the same, filtering only the output from |
|
1114 | Since this marker is always the same, filtering only the output from | |
1115 | a log is very easy, using for example a simple awk call: |
|
1115 | a log is very easy, using for example a simple awk call: | |
1116 |
|
1116 | |||
1117 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
1117 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py | |
1118 |
|
1118 | |||
1119 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
1119 | -r: log 'raw' input. Normally, IPython's logs contain the processed | |
1120 | input, so that user lines are logged in their final form, converted |
|
1120 | input, so that user lines are logged in their final form, converted | |
1121 | into valid Python. For example, %Exit is logged as |
|
1121 | into valid Python. For example, %Exit is logged as | |
1122 | '_ip.magic("Exit"). If the -r flag is given, all input is logged |
|
1122 | '_ip.magic("Exit"). If the -r flag is given, all input is logged | |
1123 | exactly as typed, with no transformations applied. |
|
1123 | exactly as typed, with no transformations applied. | |
1124 |
|
1124 | |||
1125 | -t: put timestamps before each input line logged (these are put in |
|
1125 | -t: put timestamps before each input line logged (these are put in | |
1126 | comments).""" |
|
1126 | comments).""" | |
1127 |
|
1127 | |||
1128 | opts,par = self.parse_options(parameter_s,'ort') |
|
1128 | opts,par = self.parse_options(parameter_s,'ort') | |
1129 | log_output = 'o' in opts |
|
1129 | log_output = 'o' in opts | |
1130 | log_raw_input = 'r' in opts |
|
1130 | log_raw_input = 'r' in opts | |
1131 | timestamp = 't' in opts |
|
1131 | timestamp = 't' in opts | |
1132 |
|
1132 | |||
1133 | logger = self.shell.logger |
|
1133 | logger = self.shell.logger | |
1134 |
|
1134 | |||
1135 | # if no args are given, the defaults set in the logger constructor by |
|
1135 | # if no args are given, the defaults set in the logger constructor by | |
1136 | # ipytohn remain valid |
|
1136 | # ipytohn remain valid | |
1137 | if par: |
|
1137 | if par: | |
1138 | try: |
|
1138 | try: | |
1139 | logfname,logmode = par.split() |
|
1139 | logfname,logmode = par.split() | |
1140 | except: |
|
1140 | except: | |
1141 | logfname = par |
|
1141 | logfname = par | |
1142 | logmode = 'backup' |
|
1142 | logmode = 'backup' | |
1143 | else: |
|
1143 | else: | |
1144 | logfname = logger.logfname |
|
1144 | logfname = logger.logfname | |
1145 | logmode = logger.logmode |
|
1145 | logmode = logger.logmode | |
1146 | # put logfname into rc struct as if it had been called on the command |
|
1146 | # put logfname into rc struct as if it had been called on the command | |
1147 | # line, so it ends up saved in the log header Save it in case we need |
|
1147 | # line, so it ends up saved in the log header Save it in case we need | |
1148 | # to restore it... |
|
1148 | # to restore it... | |
1149 | old_logfile = self.shell.logfile |
|
1149 | old_logfile = self.shell.logfile | |
1150 | if logfname: |
|
1150 | if logfname: | |
1151 | logfname = os.path.expanduser(logfname) |
|
1151 | logfname = os.path.expanduser(logfname) | |
1152 | self.shell.logfile = logfname |
|
1152 | self.shell.logfile = logfname | |
1153 |
|
1153 | |||
1154 | loghead = '# IPython log file\n\n' |
|
1154 | loghead = '# IPython log file\n\n' | |
1155 | try: |
|
1155 | try: | |
1156 | started = logger.logstart(logfname,loghead,logmode, |
|
1156 | started = logger.logstart(logfname,loghead,logmode, | |
1157 | log_output,timestamp,log_raw_input) |
|
1157 | log_output,timestamp,log_raw_input) | |
1158 | except: |
|
1158 | except: | |
1159 | self.shell.logfile = old_logfile |
|
1159 | self.shell.logfile = old_logfile | |
1160 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1160 | warn("Couldn't start log: %s" % sys.exc_info()[1]) | |
1161 | else: |
|
1161 | else: | |
1162 | # log input history up to this point, optionally interleaving |
|
1162 | # log input history up to this point, optionally interleaving | |
1163 | # output if requested |
|
1163 | # output if requested | |
1164 |
|
1164 | |||
1165 | if timestamp: |
|
1165 | if timestamp: | |
1166 | # disable timestamping for the previous history, since we've |
|
1166 | # disable timestamping for the previous history, since we've | |
1167 | # lost those already (no time machine here). |
|
1167 | # lost those already (no time machine here). | |
1168 | logger.timestamp = False |
|
1168 | logger.timestamp = False | |
1169 |
|
1169 | |||
1170 | if log_raw_input: |
|
1170 | if log_raw_input: | |
1171 | input_hist = self.shell.history_manager.input_hist_raw |
|
1171 | input_hist = self.shell.history_manager.input_hist_raw | |
1172 | else: |
|
1172 | else: | |
1173 | input_hist = self.shell.history_manager.input_hist_parsed |
|
1173 | input_hist = self.shell.history_manager.input_hist_parsed | |
1174 |
|
1174 | |||
1175 | if log_output: |
|
1175 | if log_output: | |
1176 | log_write = logger.log_write |
|
1176 | log_write = logger.log_write | |
1177 | output_hist = self.shell.history_manager.output_hist |
|
1177 | output_hist = self.shell.history_manager.output_hist | |
1178 | for n in range(1,len(input_hist)-1): |
|
1178 | for n in range(1,len(input_hist)-1): | |
1179 | log_write(input_hist[n].rstrip()) |
|
1179 | log_write(input_hist[n].rstrip()) | |
1180 | if n in output_hist: |
|
1180 | if n in output_hist: | |
1181 | log_write(repr(output_hist[n]),'output') |
|
1181 | log_write(repr(output_hist[n]),'output') | |
1182 | else: |
|
1182 | else: | |
1183 | logger.log_write(''.join(input_hist[1:])) |
|
1183 | logger.log_write(''.join(input_hist[1:])) | |
1184 | if timestamp: |
|
1184 | if timestamp: | |
1185 | # re-enable timestamping |
|
1185 | # re-enable timestamping | |
1186 | logger.timestamp = True |
|
1186 | logger.timestamp = True | |
1187 |
|
1187 | |||
1188 | print ('Activating auto-logging. ' |
|
1188 | print ('Activating auto-logging. ' | |
1189 | 'Current session state plus future input saved.') |
|
1189 | 'Current session state plus future input saved.') | |
1190 | logger.logstate() |
|
1190 | logger.logstate() | |
1191 |
|
1191 | |||
1192 | def magic_logstop(self,parameter_s=''): |
|
1192 | def magic_logstop(self,parameter_s=''): | |
1193 | """Fully stop logging and close log file. |
|
1193 | """Fully stop logging and close log file. | |
1194 |
|
1194 | |||
1195 | In order to start logging again, a new %logstart call needs to be made, |
|
1195 | In order to start logging again, a new %logstart call needs to be made, | |
1196 | possibly (though not necessarily) with a new filename, mode and other |
|
1196 | possibly (though not necessarily) with a new filename, mode and other | |
1197 | options.""" |
|
1197 | options.""" | |
1198 | self.logger.logstop() |
|
1198 | self.logger.logstop() | |
1199 |
|
1199 | |||
1200 | def magic_logoff(self,parameter_s=''): |
|
1200 | def magic_logoff(self,parameter_s=''): | |
1201 | """Temporarily stop logging. |
|
1201 | """Temporarily stop logging. | |
1202 |
|
1202 | |||
1203 | You must have previously started logging.""" |
|
1203 | You must have previously started logging.""" | |
1204 | self.shell.logger.switch_log(0) |
|
1204 | self.shell.logger.switch_log(0) | |
1205 |
|
1205 | |||
1206 | def magic_logon(self,parameter_s=''): |
|
1206 | def magic_logon(self,parameter_s=''): | |
1207 | """Restart logging. |
|
1207 | """Restart logging. | |
1208 |
|
1208 | |||
1209 | This function is for restarting logging which you've temporarily |
|
1209 | This function is for restarting logging which you've temporarily | |
1210 | stopped with %logoff. For starting logging for the first time, you |
|
1210 | stopped with %logoff. For starting logging for the first time, you | |
1211 | must use the %logstart function, which allows you to specify an |
|
1211 | must use the %logstart function, which allows you to specify an | |
1212 | optional log filename.""" |
|
1212 | optional log filename.""" | |
1213 |
|
1213 | |||
1214 | self.shell.logger.switch_log(1) |
|
1214 | self.shell.logger.switch_log(1) | |
1215 |
|
1215 | |||
1216 | def magic_logstate(self,parameter_s=''): |
|
1216 | def magic_logstate(self,parameter_s=''): | |
1217 | """Print the status of the logging system.""" |
|
1217 | """Print the status of the logging system.""" | |
1218 |
|
1218 | |||
1219 | self.shell.logger.logstate() |
|
1219 | self.shell.logger.logstate() | |
1220 |
|
1220 | |||
1221 | def magic_pdb(self, parameter_s=''): |
|
1221 | def magic_pdb(self, parameter_s=''): | |
1222 | """Control the automatic calling of the pdb interactive debugger. |
|
1222 | """Control the automatic calling of the pdb interactive debugger. | |
1223 |
|
1223 | |||
1224 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1224 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without | |
1225 | argument it works as a toggle. |
|
1225 | argument it works as a toggle. | |
1226 |
|
1226 | |||
1227 | When an exception is triggered, IPython can optionally call the |
|
1227 | When an exception is triggered, IPython can optionally call the | |
1228 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1228 | interactive pdb debugger after the traceback printout. %pdb toggles | |
1229 | this feature on and off. |
|
1229 | this feature on and off. | |
1230 |
|
1230 | |||
1231 | The initial state of this feature is set in your ipythonrc |
|
1231 | The initial state of this feature is set in your ipythonrc | |
1232 | configuration file (the variable is called 'pdb'). |
|
1232 | configuration file (the variable is called 'pdb'). | |
1233 |
|
1233 | |||
1234 | If you want to just activate the debugger AFTER an exception has fired, |
|
1234 | If you want to just activate the debugger AFTER an exception has fired, | |
1235 | without having to type '%pdb on' and rerunning your code, you can use |
|
1235 | without having to type '%pdb on' and rerunning your code, you can use | |
1236 | the %debug magic.""" |
|
1236 | the %debug magic.""" | |
1237 |
|
1237 | |||
1238 | par = parameter_s.strip().lower() |
|
1238 | par = parameter_s.strip().lower() | |
1239 |
|
1239 | |||
1240 | if par: |
|
1240 | if par: | |
1241 | try: |
|
1241 | try: | |
1242 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1242 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] | |
1243 | except KeyError: |
|
1243 | except KeyError: | |
1244 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1244 | print ('Incorrect argument. Use on/1, off/0, ' | |
1245 | 'or nothing for a toggle.') |
|
1245 | 'or nothing for a toggle.') | |
1246 | return |
|
1246 | return | |
1247 | else: |
|
1247 | else: | |
1248 | # toggle |
|
1248 | # toggle | |
1249 | new_pdb = not self.shell.call_pdb |
|
1249 | new_pdb = not self.shell.call_pdb | |
1250 |
|
1250 | |||
1251 | # set on the shell |
|
1251 | # set on the shell | |
1252 | self.shell.call_pdb = new_pdb |
|
1252 | self.shell.call_pdb = new_pdb | |
1253 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1253 | print 'Automatic pdb calling has been turned',on_off(new_pdb) | |
1254 |
|
1254 | |||
1255 | def magic_debug(self, parameter_s=''): |
|
1255 | def magic_debug(self, parameter_s=''): | |
1256 | """Activate the interactive debugger in post-mortem mode. |
|
1256 | """Activate the interactive debugger in post-mortem mode. | |
1257 |
|
1257 | |||
1258 | If an exception has just occurred, this lets you inspect its stack |
|
1258 | If an exception has just occurred, this lets you inspect its stack | |
1259 | frames interactively. Note that this will always work only on the last |
|
1259 | frames interactively. Note that this will always work only on the last | |
1260 | traceback that occurred, so you must call this quickly after an |
|
1260 | traceback that occurred, so you must call this quickly after an | |
1261 | exception that you wish to inspect has fired, because if another one |
|
1261 | exception that you wish to inspect has fired, because if another one | |
1262 | occurs, it clobbers the previous one. |
|
1262 | occurs, it clobbers the previous one. | |
1263 |
|
1263 | |||
1264 | If you want IPython to automatically do this on every exception, see |
|
1264 | If you want IPython to automatically do this on every exception, see | |
1265 | the %pdb magic for more details. |
|
1265 | the %pdb magic for more details. | |
1266 | """ |
|
1266 | """ | |
1267 | self.shell.debugger(force=True) |
|
1267 | self.shell.debugger(force=True) | |
1268 |
|
1268 | |||
1269 | @testdec.skip_doctest |
|
1269 | @testdec.skip_doctest | |
1270 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1270 | def magic_prun(self, parameter_s ='',user_mode=1, | |
1271 | opts=None,arg_lst=None,prog_ns=None): |
|
1271 | opts=None,arg_lst=None,prog_ns=None): | |
1272 |
|
1272 | |||
1273 | """Run a statement through the python code profiler. |
|
1273 | """Run a statement through the python code profiler. | |
1274 |
|
1274 | |||
1275 | Usage: |
|
1275 | Usage: | |
1276 | %prun [options] statement |
|
1276 | %prun [options] statement | |
1277 |
|
1277 | |||
1278 | The given statement (which doesn't require quote marks) is run via the |
|
1278 | The given statement (which doesn't require quote marks) is run via the | |
1279 | python profiler in a manner similar to the profile.run() function. |
|
1279 | python profiler in a manner similar to the profile.run() function. | |
1280 | Namespaces are internally managed to work correctly; profile.run |
|
1280 | Namespaces are internally managed to work correctly; profile.run | |
1281 | cannot be used in IPython because it makes certain assumptions about |
|
1281 | cannot be used in IPython because it makes certain assumptions about | |
1282 | namespaces which do not hold under IPython. |
|
1282 | namespaces which do not hold under IPython. | |
1283 |
|
1283 | |||
1284 | Options: |
|
1284 | Options: | |
1285 |
|
1285 | |||
1286 | -l <limit>: you can place restrictions on what or how much of the |
|
1286 | -l <limit>: you can place restrictions on what or how much of the | |
1287 | profile gets printed. The limit value can be: |
|
1287 | profile gets printed. The limit value can be: | |
1288 |
|
1288 | |||
1289 | * A string: only information for function names containing this string |
|
1289 | * A string: only information for function names containing this string | |
1290 | is printed. |
|
1290 | is printed. | |
1291 |
|
1291 | |||
1292 | * An integer: only these many lines are printed. |
|
1292 | * An integer: only these many lines are printed. | |
1293 |
|
1293 | |||
1294 | * A float (between 0 and 1): this fraction of the report is printed |
|
1294 | * A float (between 0 and 1): this fraction of the report is printed | |
1295 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1295 | (for example, use a limit of 0.4 to see the topmost 40% only). | |
1296 |
|
1296 | |||
1297 | You can combine several limits with repeated use of the option. For |
|
1297 | You can combine several limits with repeated use of the option. For | |
1298 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1298 | example, '-l __init__ -l 5' will print only the topmost 5 lines of | |
1299 | information about class constructors. |
|
1299 | information about class constructors. | |
1300 |
|
1300 | |||
1301 | -r: return the pstats.Stats object generated by the profiling. This |
|
1301 | -r: return the pstats.Stats object generated by the profiling. This | |
1302 | object has all the information about the profile in it, and you can |
|
1302 | object has all the information about the profile in it, and you can | |
1303 | later use it for further analysis or in other functions. |
|
1303 | later use it for further analysis or in other functions. | |
1304 |
|
1304 | |||
1305 | -s <key>: sort profile by given key. You can provide more than one key |
|
1305 | -s <key>: sort profile by given key. You can provide more than one key | |
1306 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1306 | by using the option several times: '-s key1 -s key2 -s key3...'. The | |
1307 | default sorting key is 'time'. |
|
1307 | default sorting key is 'time'. | |
1308 |
|
1308 | |||
1309 | The following is copied verbatim from the profile documentation |
|
1309 | The following is copied verbatim from the profile documentation | |
1310 | referenced below: |
|
1310 | referenced below: | |
1311 |
|
1311 | |||
1312 | When more than one key is provided, additional keys are used as |
|
1312 | When more than one key is provided, additional keys are used as | |
1313 | secondary criteria when the there is equality in all keys selected |
|
1313 | secondary criteria when the there is equality in all keys selected | |
1314 | before them. |
|
1314 | before them. | |
1315 |
|
1315 | |||
1316 | Abbreviations can be used for any key names, as long as the |
|
1316 | Abbreviations can be used for any key names, as long as the | |
1317 | abbreviation is unambiguous. The following are the keys currently |
|
1317 | abbreviation is unambiguous. The following are the keys currently | |
1318 | defined: |
|
1318 | defined: | |
1319 |
|
1319 | |||
1320 | Valid Arg Meaning |
|
1320 | Valid Arg Meaning | |
1321 | "calls" call count |
|
1321 | "calls" call count | |
1322 | "cumulative" cumulative time |
|
1322 | "cumulative" cumulative time | |
1323 | "file" file name |
|
1323 | "file" file name | |
1324 | "module" file name |
|
1324 | "module" file name | |
1325 | "pcalls" primitive call count |
|
1325 | "pcalls" primitive call count | |
1326 | "line" line number |
|
1326 | "line" line number | |
1327 | "name" function name |
|
1327 | "name" function name | |
1328 | "nfl" name/file/line |
|
1328 | "nfl" name/file/line | |
1329 | "stdname" standard name |
|
1329 | "stdname" standard name | |
1330 | "time" internal time |
|
1330 | "time" internal time | |
1331 |
|
1331 | |||
1332 | Note that all sorts on statistics are in descending order (placing |
|
1332 | Note that all sorts on statistics are in descending order (placing | |
1333 | most time consuming items first), where as name, file, and line number |
|
1333 | most time consuming items first), where as name, file, and line number | |
1334 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1334 | searches are in ascending order (i.e., alphabetical). The subtle | |
1335 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1335 | distinction between "nfl" and "stdname" is that the standard name is a | |
1336 | sort of the name as printed, which means that the embedded line |
|
1336 | sort of the name as printed, which means that the embedded line | |
1337 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1337 | numbers get compared in an odd way. For example, lines 3, 20, and 40 | |
1338 | would (if the file names were the same) appear in the string order |
|
1338 | would (if the file names were the same) appear in the string order | |
1339 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1339 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the | |
1340 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1340 | line numbers. In fact, sort_stats("nfl") is the same as | |
1341 | sort_stats("name", "file", "line"). |
|
1341 | sort_stats("name", "file", "line"). | |
1342 |
|
1342 | |||
1343 | -T <filename>: save profile results as shown on screen to a text |
|
1343 | -T <filename>: save profile results as shown on screen to a text | |
1344 | file. The profile is still shown on screen. |
|
1344 | file. The profile is still shown on screen. | |
1345 |
|
1345 | |||
1346 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1346 | -D <filename>: save (via dump_stats) profile statistics to given | |
1347 | filename. This data is in a format understod by the pstats module, and |
|
1347 | filename. This data is in a format understod by the pstats module, and | |
1348 | is generated by a call to the dump_stats() method of profile |
|
1348 | is generated by a call to the dump_stats() method of profile | |
1349 | objects. The profile is still shown on screen. |
|
1349 | objects. The profile is still shown on screen. | |
1350 |
|
1350 | |||
1351 | If you want to run complete programs under the profiler's control, use |
|
1351 | If you want to run complete programs under the profiler's control, use | |
1352 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1352 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts | |
1353 | contains profiler specific options as described here. |
|
1353 | contains profiler specific options as described here. | |
1354 |
|
1354 | |||
1355 | You can read the complete documentation for the profile module with:: |
|
1355 | You can read the complete documentation for the profile module with:: | |
1356 |
|
1356 | |||
1357 | In [1]: import profile; profile.help() |
|
1357 | In [1]: import profile; profile.help() | |
1358 | """ |
|
1358 | """ | |
1359 |
|
1359 | |||
1360 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1360 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) | |
1361 | # protect user quote marks |
|
1361 | # protect user quote marks | |
1362 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") |
|
1362 | parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'") | |
1363 |
|
1363 | |||
1364 | if user_mode: # regular user call |
|
1364 | if user_mode: # regular user call | |
1365 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', |
|
1365 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:', | |
1366 | list_all=1) |
|
1366 | list_all=1) | |
1367 | namespace = self.shell.user_ns |
|
1367 | namespace = self.shell.user_ns | |
1368 | else: # called to run a program by %run -p |
|
1368 | else: # called to run a program by %run -p | |
1369 | try: |
|
1369 | try: | |
1370 | filename = get_py_filename(arg_lst[0]) |
|
1370 | filename = get_py_filename(arg_lst[0]) | |
1371 | except IOError,msg: |
|
1371 | except IOError,msg: | |
1372 | error(msg) |
|
1372 | error(msg) | |
1373 | return |
|
1373 | return | |
1374 |
|
1374 | |||
1375 | arg_str = 'execfile(filename,prog_ns)' |
|
1375 | arg_str = 'execfile(filename,prog_ns)' | |
1376 | namespace = locals() |
|
1376 | namespace = locals() | |
1377 |
|
1377 | |||
1378 | opts.merge(opts_def) |
|
1378 | opts.merge(opts_def) | |
1379 |
|
1379 | |||
1380 | prof = profile.Profile() |
|
1380 | prof = profile.Profile() | |
1381 | try: |
|
1381 | try: | |
1382 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1382 | prof = prof.runctx(arg_str,namespace,namespace) | |
1383 | sys_exit = '' |
|
1383 | sys_exit = '' | |
1384 | except SystemExit: |
|
1384 | except SystemExit: | |
1385 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1385 | sys_exit = """*** SystemExit exception caught in code being profiled.""" | |
1386 |
|
1386 | |||
1387 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1387 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) | |
1388 |
|
1388 | |||
1389 | lims = opts.l |
|
1389 | lims = opts.l | |
1390 | if lims: |
|
1390 | if lims: | |
1391 | lims = [] # rebuild lims with ints/floats/strings |
|
1391 | lims = [] # rebuild lims with ints/floats/strings | |
1392 | for lim in opts.l: |
|
1392 | for lim in opts.l: | |
1393 | try: |
|
1393 | try: | |
1394 | lims.append(int(lim)) |
|
1394 | lims.append(int(lim)) | |
1395 | except ValueError: |
|
1395 | except ValueError: | |
1396 | try: |
|
1396 | try: | |
1397 | lims.append(float(lim)) |
|
1397 | lims.append(float(lim)) | |
1398 | except ValueError: |
|
1398 | except ValueError: | |
1399 | lims.append(lim) |
|
1399 | lims.append(lim) | |
1400 |
|
1400 | |||
1401 | # Trap output. |
|
1401 | # Trap output. | |
1402 | stdout_trap = StringIO() |
|
1402 | stdout_trap = StringIO() | |
1403 |
|
1403 | |||
1404 | if hasattr(stats,'stream'): |
|
1404 | if hasattr(stats,'stream'): | |
1405 | # In newer versions of python, the stats object has a 'stream' |
|
1405 | # In newer versions of python, the stats object has a 'stream' | |
1406 | # attribute to write into. |
|
1406 | # attribute to write into. | |
1407 | stats.stream = stdout_trap |
|
1407 | stats.stream = stdout_trap | |
1408 | stats.print_stats(*lims) |
|
1408 | stats.print_stats(*lims) | |
1409 | else: |
|
1409 | else: | |
1410 | # For older versions, we manually redirect stdout during printing |
|
1410 | # For older versions, we manually redirect stdout during printing | |
1411 | sys_stdout = sys.stdout |
|
1411 | sys_stdout = sys.stdout | |
1412 | try: |
|
1412 | try: | |
1413 | sys.stdout = stdout_trap |
|
1413 | sys.stdout = stdout_trap | |
1414 | stats.print_stats(*lims) |
|
1414 | stats.print_stats(*lims) | |
1415 | finally: |
|
1415 | finally: | |
1416 | sys.stdout = sys_stdout |
|
1416 | sys.stdout = sys_stdout | |
1417 |
|
1417 | |||
1418 | output = stdout_trap.getvalue() |
|
1418 | output = stdout_trap.getvalue() | |
1419 | output = output.rstrip() |
|
1419 | output = output.rstrip() | |
1420 |
|
1420 | |||
1421 | page.page(output) |
|
1421 | page.page(output) | |
1422 | print sys_exit, |
|
1422 | print sys_exit, | |
1423 |
|
1423 | |||
1424 | dump_file = opts.D[0] |
|
1424 | dump_file = opts.D[0] | |
1425 | text_file = opts.T[0] |
|
1425 | text_file = opts.T[0] | |
1426 | if dump_file: |
|
1426 | if dump_file: | |
1427 | prof.dump_stats(dump_file) |
|
1427 | prof.dump_stats(dump_file) | |
1428 | print '\n*** Profile stats marshalled to file',\ |
|
1428 | print '\n*** Profile stats marshalled to file',\ | |
1429 | `dump_file`+'.',sys_exit |
|
1429 | `dump_file`+'.',sys_exit | |
1430 | if text_file: |
|
1430 | if text_file: | |
1431 | pfile = file(text_file,'w') |
|
1431 | pfile = file(text_file,'w') | |
1432 | pfile.write(output) |
|
1432 | pfile.write(output) | |
1433 | pfile.close() |
|
1433 | pfile.close() | |
1434 | print '\n*** Profile printout saved to text file',\ |
|
1434 | print '\n*** Profile printout saved to text file',\ | |
1435 | `text_file`+'.',sys_exit |
|
1435 | `text_file`+'.',sys_exit | |
1436 |
|
1436 | |||
1437 | if opts.has_key('r'): |
|
1437 | if opts.has_key('r'): | |
1438 | return stats |
|
1438 | return stats | |
1439 | else: |
|
1439 | else: | |
1440 | return None |
|
1440 | return None | |
1441 |
|
1441 | |||
1442 | @testdec.skip_doctest |
|
1442 | @testdec.skip_doctest | |
1443 | def magic_run(self, parameter_s ='',runner=None, |
|
1443 | def magic_run(self, parameter_s ='',runner=None, | |
1444 | file_finder=get_py_filename): |
|
1444 | file_finder=get_py_filename): | |
1445 | """Run the named file inside IPython as a program. |
|
1445 | """Run the named file inside IPython as a program. | |
1446 |
|
1446 | |||
1447 | Usage:\\ |
|
1447 | Usage:\\ | |
1448 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1448 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] | |
1449 |
|
1449 | |||
1450 | Parameters after the filename are passed as command-line arguments to |
|
1450 | Parameters after the filename are passed as command-line arguments to | |
1451 | the program (put in sys.argv). Then, control returns to IPython's |
|
1451 | the program (put in sys.argv). Then, control returns to IPython's | |
1452 | prompt. |
|
1452 | prompt. | |
1453 |
|
1453 | |||
1454 | This is similar to running at a system prompt:\\ |
|
1454 | This is similar to running at a system prompt:\\ | |
1455 | $ python file args\\ |
|
1455 | $ python file args\\ | |
1456 | but with the advantage of giving you IPython's tracebacks, and of |
|
1456 | but with the advantage of giving you IPython's tracebacks, and of | |
1457 | loading all variables into your interactive namespace for further use |
|
1457 | loading all variables into your interactive namespace for further use | |
1458 | (unless -p is used, see below). |
|
1458 | (unless -p is used, see below). | |
1459 |
|
1459 | |||
1460 | The file is executed in a namespace initially consisting only of |
|
1460 | The file is executed in a namespace initially consisting only of | |
1461 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1461 | __name__=='__main__' and sys.argv constructed as indicated. It thus | |
1462 | sees its environment as if it were being run as a stand-alone program |
|
1462 | sees its environment as if it were being run as a stand-alone program | |
1463 | (except for sharing global objects such as previously imported |
|
1463 | (except for sharing global objects such as previously imported | |
1464 | modules). But after execution, the IPython interactive namespace gets |
|
1464 | modules). But after execution, the IPython interactive namespace gets | |
1465 | updated with all variables defined in the program (except for __name__ |
|
1465 | updated with all variables defined in the program (except for __name__ | |
1466 | and sys.argv). This allows for very convenient loading of code for |
|
1466 | and sys.argv). This allows for very convenient loading of code for | |
1467 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1467 | interactive work, while giving each program a 'clean sheet' to run in. | |
1468 |
|
1468 | |||
1469 | Options: |
|
1469 | Options: | |
1470 |
|
1470 | |||
1471 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1471 | -n: __name__ is NOT set to '__main__', but to the running file's name | |
1472 | without extension (as python does under import). This allows running |
|
1472 | without extension (as python does under import). This allows running | |
1473 | scripts and reloading the definitions in them without calling code |
|
1473 | scripts and reloading the definitions in them without calling code | |
1474 | protected by an ' if __name__ == "__main__" ' clause. |
|
1474 | protected by an ' if __name__ == "__main__" ' clause. | |
1475 |
|
1475 | |||
1476 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1476 | -i: run the file in IPython's namespace instead of an empty one. This | |
1477 | is useful if you are experimenting with code written in a text editor |
|
1477 | is useful if you are experimenting with code written in a text editor | |
1478 | which depends on variables defined interactively. |
|
1478 | which depends on variables defined interactively. | |
1479 |
|
1479 | |||
1480 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1480 | -e: ignore sys.exit() calls or SystemExit exceptions in the script | |
1481 | being run. This is particularly useful if IPython is being used to |
|
1481 | being run. This is particularly useful if IPython is being used to | |
1482 | run unittests, which always exit with a sys.exit() call. In such |
|
1482 | run unittests, which always exit with a sys.exit() call. In such | |
1483 | cases you are interested in the output of the test results, not in |
|
1483 | cases you are interested in the output of the test results, not in | |
1484 | seeing a traceback of the unittest module. |
|
1484 | seeing a traceback of the unittest module. | |
1485 |
|
1485 | |||
1486 | -t: print timing information at the end of the run. IPython will give |
|
1486 | -t: print timing information at the end of the run. IPython will give | |
1487 | you an estimated CPU time consumption for your script, which under |
|
1487 | you an estimated CPU time consumption for your script, which under | |
1488 | Unix uses the resource module to avoid the wraparound problems of |
|
1488 | Unix uses the resource module to avoid the wraparound problems of | |
1489 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1489 | time.clock(). Under Unix, an estimate of time spent on system tasks | |
1490 | is also given (for Windows platforms this is reported as 0.0). |
|
1490 | is also given (for Windows platforms this is reported as 0.0). | |
1491 |
|
1491 | |||
1492 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1492 | If -t is given, an additional -N<N> option can be given, where <N> | |
1493 | must be an integer indicating how many times you want the script to |
|
1493 | must be an integer indicating how many times you want the script to | |
1494 | run. The final timing report will include total and per run results. |
|
1494 | run. The final timing report will include total and per run results. | |
1495 |
|
1495 | |||
1496 | For example (testing the script uniq_stable.py): |
|
1496 | For example (testing the script uniq_stable.py): | |
1497 |
|
1497 | |||
1498 | In [1]: run -t uniq_stable |
|
1498 | In [1]: run -t uniq_stable | |
1499 |
|
1499 | |||
1500 | IPython CPU timings (estimated):\\ |
|
1500 | IPython CPU timings (estimated):\\ | |
1501 | User : 0.19597 s.\\ |
|
1501 | User : 0.19597 s.\\ | |
1502 | System: 0.0 s.\\ |
|
1502 | System: 0.0 s.\\ | |
1503 |
|
1503 | |||
1504 | In [2]: run -t -N5 uniq_stable |
|
1504 | In [2]: run -t -N5 uniq_stable | |
1505 |
|
1505 | |||
1506 | IPython CPU timings (estimated):\\ |
|
1506 | IPython CPU timings (estimated):\\ | |
1507 | Total runs performed: 5\\ |
|
1507 | Total runs performed: 5\\ | |
1508 | Times : Total Per run\\ |
|
1508 | Times : Total Per run\\ | |
1509 | User : 0.910862 s, 0.1821724 s.\\ |
|
1509 | User : 0.910862 s, 0.1821724 s.\\ | |
1510 | System: 0.0 s, 0.0 s. |
|
1510 | System: 0.0 s, 0.0 s. | |
1511 |
|
1511 | |||
1512 | -d: run your program under the control of pdb, the Python debugger. |
|
1512 | -d: run your program under the control of pdb, the Python debugger. | |
1513 | This allows you to execute your program step by step, watch variables, |
|
1513 | This allows you to execute your program step by step, watch variables, | |
1514 | etc. Internally, what IPython does is similar to calling: |
|
1514 | etc. Internally, what IPython does is similar to calling: | |
1515 |
|
1515 | |||
1516 | pdb.run('execfile("YOURFILENAME")') |
|
1516 | pdb.run('execfile("YOURFILENAME")') | |
1517 |
|
1517 | |||
1518 | with a breakpoint set on line 1 of your file. You can change the line |
|
1518 | with a breakpoint set on line 1 of your file. You can change the line | |
1519 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1519 | number for this automatic breakpoint to be <N> by using the -bN option | |
1520 | (where N must be an integer). For example: |
|
1520 | (where N must be an integer). For example: | |
1521 |
|
1521 | |||
1522 | %run -d -b40 myscript |
|
1522 | %run -d -b40 myscript | |
1523 |
|
1523 | |||
1524 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1524 | will set the first breakpoint at line 40 in myscript.py. Note that | |
1525 | the first breakpoint must be set on a line which actually does |
|
1525 | the first breakpoint must be set on a line which actually does | |
1526 | something (not a comment or docstring) for it to stop execution. |
|
1526 | something (not a comment or docstring) for it to stop execution. | |
1527 |
|
1527 | |||
1528 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1528 | When the pdb debugger starts, you will see a (Pdb) prompt. You must | |
1529 | first enter 'c' (without qoutes) to start execution up to the first |
|
1529 | first enter 'c' (without qoutes) to start execution up to the first | |
1530 | breakpoint. |
|
1530 | breakpoint. | |
1531 |
|
1531 | |||
1532 | Entering 'help' gives information about the use of the debugger. You |
|
1532 | Entering 'help' gives information about the use of the debugger. You | |
1533 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1533 | can easily see pdb's full documentation with "import pdb;pdb.help()" | |
1534 | at a prompt. |
|
1534 | at a prompt. | |
1535 |
|
1535 | |||
1536 | -p: run program under the control of the Python profiler module (which |
|
1536 | -p: run program under the control of the Python profiler module (which | |
1537 | prints a detailed report of execution times, function calls, etc). |
|
1537 | prints a detailed report of execution times, function calls, etc). | |
1538 |
|
1538 | |||
1539 | You can pass other options after -p which affect the behavior of the |
|
1539 | You can pass other options after -p which affect the behavior of the | |
1540 | profiler itself. See the docs for %prun for details. |
|
1540 | profiler itself. See the docs for %prun for details. | |
1541 |
|
1541 | |||
1542 | In this mode, the program's variables do NOT propagate back to the |
|
1542 | In this mode, the program's variables do NOT propagate back to the | |
1543 | IPython interactive namespace (because they remain in the namespace |
|
1543 | IPython interactive namespace (because they remain in the namespace | |
1544 | where the profiler executes them). |
|
1544 | where the profiler executes them). | |
1545 |
|
1545 | |||
1546 | Internally this triggers a call to %prun, see its documentation for |
|
1546 | Internally this triggers a call to %prun, see its documentation for | |
1547 | details on the options available specifically for profiling. |
|
1547 | details on the options available specifically for profiling. | |
1548 |
|
1548 | |||
1549 | There is one special usage for which the text above doesn't apply: |
|
1549 | There is one special usage for which the text above doesn't apply: | |
1550 | if the filename ends with .ipy, the file is run as ipython script, |
|
1550 | if the filename ends with .ipy, the file is run as ipython script, | |
1551 | just as if the commands were written on IPython prompt. |
|
1551 | just as if the commands were written on IPython prompt. | |
1552 | """ |
|
1552 | """ | |
1553 |
|
1553 | |||
1554 | # get arguments and set sys.argv for program to be run. |
|
1554 | # get arguments and set sys.argv for program to be run. | |
1555 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', |
|
1555 | opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e', | |
1556 | mode='list',list_all=1) |
|
1556 | mode='list',list_all=1) | |
1557 |
|
1557 | |||
1558 | try: |
|
1558 | try: | |
1559 | filename = file_finder(arg_lst[0]) |
|
1559 | filename = file_finder(arg_lst[0]) | |
1560 | except IndexError: |
|
1560 | except IndexError: | |
1561 | warn('you must provide at least a filename.') |
|
1561 | warn('you must provide at least a filename.') | |
1562 | print '\n%run:\n',oinspect.getdoc(self.magic_run) |
|
1562 | print '\n%run:\n',oinspect.getdoc(self.magic_run) | |
1563 | return |
|
1563 | return | |
1564 | except IOError,msg: |
|
1564 | except IOError,msg: | |
1565 | error(msg) |
|
1565 | error(msg) | |
1566 | return |
|
1566 | return | |
1567 |
|
1567 | |||
1568 | if filename.lower().endswith('.ipy'): |
|
1568 | if filename.lower().endswith('.ipy'): | |
1569 | self.shell.safe_execfile_ipy(filename) |
|
1569 | self.shell.safe_execfile_ipy(filename) | |
1570 | return |
|
1570 | return | |
1571 |
|
1571 | |||
1572 | # Control the response to exit() calls made by the script being run |
|
1572 | # Control the response to exit() calls made by the script being run | |
1573 | exit_ignore = opts.has_key('e') |
|
1573 | exit_ignore = opts.has_key('e') | |
1574 |
|
1574 | |||
1575 | # Make sure that the running script gets a proper sys.argv as if it |
|
1575 | # Make sure that the running script gets a proper sys.argv as if it | |
1576 | # were run from a system shell. |
|
1576 | # were run from a system shell. | |
1577 | save_argv = sys.argv # save it for later restoring |
|
1577 | save_argv = sys.argv # save it for later restoring | |
1578 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename |
|
1578 | sys.argv = [filename]+ arg_lst[1:] # put in the proper filename | |
1579 |
|
1579 | |||
1580 | if opts.has_key('i'): |
|
1580 | if opts.has_key('i'): | |
1581 | # Run in user's interactive namespace |
|
1581 | # Run in user's interactive namespace | |
1582 | prog_ns = self.shell.user_ns |
|
1582 | prog_ns = self.shell.user_ns | |
1583 | __name__save = self.shell.user_ns['__name__'] |
|
1583 | __name__save = self.shell.user_ns['__name__'] | |
1584 | prog_ns['__name__'] = '__main__' |
|
1584 | prog_ns['__name__'] = '__main__' | |
1585 | main_mod = self.shell.new_main_mod(prog_ns) |
|
1585 | main_mod = self.shell.new_main_mod(prog_ns) | |
1586 | else: |
|
1586 | else: | |
1587 | # Run in a fresh, empty namespace |
|
1587 | # Run in a fresh, empty namespace | |
1588 | if opts.has_key('n'): |
|
1588 | if opts.has_key('n'): | |
1589 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1589 | name = os.path.splitext(os.path.basename(filename))[0] | |
1590 | else: |
|
1590 | else: | |
1591 | name = '__main__' |
|
1591 | name = '__main__' | |
1592 |
|
1592 | |||
1593 | main_mod = self.shell.new_main_mod() |
|
1593 | main_mod = self.shell.new_main_mod() | |
1594 | prog_ns = main_mod.__dict__ |
|
1594 | prog_ns = main_mod.__dict__ | |
1595 | prog_ns['__name__'] = name |
|
1595 | prog_ns['__name__'] = name | |
1596 |
|
1596 | |||
1597 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1597 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must | |
1598 | # set the __file__ global in the script's namespace |
|
1598 | # set the __file__ global in the script's namespace | |
1599 | prog_ns['__file__'] = filename |
|
1599 | prog_ns['__file__'] = filename | |
1600 |
|
1600 | |||
1601 | # pickle fix. See interactiveshell for an explanation. But we need to make sure |
|
1601 | # pickle fix. See interactiveshell for an explanation. But we need to make sure | |
1602 | # that, if we overwrite __main__, we replace it at the end |
|
1602 | # that, if we overwrite __main__, we replace it at the end | |
1603 | main_mod_name = prog_ns['__name__'] |
|
1603 | main_mod_name = prog_ns['__name__'] | |
1604 |
|
1604 | |||
1605 | if main_mod_name == '__main__': |
|
1605 | if main_mod_name == '__main__': | |
1606 | restore_main = sys.modules['__main__'] |
|
1606 | restore_main = sys.modules['__main__'] | |
1607 | else: |
|
1607 | else: | |
1608 | restore_main = False |
|
1608 | restore_main = False | |
1609 |
|
1609 | |||
1610 | # This needs to be undone at the end to prevent holding references to |
|
1610 | # This needs to be undone at the end to prevent holding references to | |
1611 | # every single object ever created. |
|
1611 | # every single object ever created. | |
1612 | sys.modules[main_mod_name] = main_mod |
|
1612 | sys.modules[main_mod_name] = main_mod | |
1613 |
|
1613 | |||
1614 | try: |
|
1614 | try: | |
1615 | stats = None |
|
1615 | stats = None | |
1616 | with self.readline_no_record: |
|
1616 | with self.readline_no_record: | |
1617 | if opts.has_key('p'): |
|
1617 | if opts.has_key('p'): | |
1618 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) |
|
1618 | stats = self.magic_prun('',0,opts,arg_lst,prog_ns) | |
1619 | else: |
|
1619 | else: | |
1620 | if opts.has_key('d'): |
|
1620 | if opts.has_key('d'): | |
1621 | deb = debugger.Pdb(self.shell.colors) |
|
1621 | deb = debugger.Pdb(self.shell.colors) | |
1622 | # reset Breakpoint state, which is moronically kept |
|
1622 | # reset Breakpoint state, which is moronically kept | |
1623 | # in a class |
|
1623 | # in a class | |
1624 | bdb.Breakpoint.next = 1 |
|
1624 | bdb.Breakpoint.next = 1 | |
1625 | bdb.Breakpoint.bplist = {} |
|
1625 | bdb.Breakpoint.bplist = {} | |
1626 | bdb.Breakpoint.bpbynumber = [None] |
|
1626 | bdb.Breakpoint.bpbynumber = [None] | |
1627 | # Set an initial breakpoint to stop execution |
|
1627 | # Set an initial breakpoint to stop execution | |
1628 | maxtries = 10 |
|
1628 | maxtries = 10 | |
1629 | bp = int(opts.get('b',[1])[0]) |
|
1629 | bp = int(opts.get('b',[1])[0]) | |
1630 | checkline = deb.checkline(filename,bp) |
|
1630 | checkline = deb.checkline(filename,bp) | |
1631 | if not checkline: |
|
1631 | if not checkline: | |
1632 | for bp in range(bp+1,bp+maxtries+1): |
|
1632 | for bp in range(bp+1,bp+maxtries+1): | |
1633 | if deb.checkline(filename,bp): |
|
1633 | if deb.checkline(filename,bp): | |
1634 | break |
|
1634 | break | |
1635 | else: |
|
1635 | else: | |
1636 | msg = ("\nI failed to find a valid line to set " |
|
1636 | msg = ("\nI failed to find a valid line to set " | |
1637 | "a breakpoint\n" |
|
1637 | "a breakpoint\n" | |
1638 | "after trying up to line: %s.\n" |
|
1638 | "after trying up to line: %s.\n" | |
1639 | "Please set a valid breakpoint manually " |
|
1639 | "Please set a valid breakpoint manually " | |
1640 | "with the -b option." % bp) |
|
1640 | "with the -b option." % bp) | |
1641 | error(msg) |
|
1641 | error(msg) | |
1642 | return |
|
1642 | return | |
1643 | # if we find a good linenumber, set the breakpoint |
|
1643 | # if we find a good linenumber, set the breakpoint | |
1644 | deb.do_break('%s:%s' % (filename,bp)) |
|
1644 | deb.do_break('%s:%s' % (filename,bp)) | |
1645 | # Start file run |
|
1645 | # Start file run | |
1646 | print "NOTE: Enter 'c' at the", |
|
1646 | print "NOTE: Enter 'c' at the", | |
1647 | print "%s prompt to start your script." % deb.prompt |
|
1647 | print "%s prompt to start your script." % deb.prompt | |
1648 | try: |
|
1648 | try: | |
1649 | deb.run('execfile("%s")' % filename,prog_ns) |
|
1649 | deb.run('execfile("%s")' % filename,prog_ns) | |
1650 |
|
1650 | |||
1651 | except: |
|
1651 | except: | |
1652 | etype, value, tb = sys.exc_info() |
|
1652 | etype, value, tb = sys.exc_info() | |
1653 | # Skip three frames in the traceback: the %run one, |
|
1653 | # Skip three frames in the traceback: the %run one, | |
1654 | # one inside bdb.py, and the command-line typed by the |
|
1654 | # one inside bdb.py, and the command-line typed by the | |
1655 | # user (run by exec in pdb itself). |
|
1655 | # user (run by exec in pdb itself). | |
1656 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) |
|
1656 | self.shell.InteractiveTB(etype,value,tb,tb_offset=3) | |
1657 | else: |
|
1657 | else: | |
1658 | if runner is None: |
|
1658 | if runner is None: | |
1659 | runner = self.shell.safe_execfile |
|
1659 | runner = self.shell.safe_execfile | |
1660 | if opts.has_key('t'): |
|
1660 | if opts.has_key('t'): | |
1661 | # timed execution |
|
1661 | # timed execution | |
1662 | try: |
|
1662 | try: | |
1663 | nruns = int(opts['N'][0]) |
|
1663 | nruns = int(opts['N'][0]) | |
1664 | if nruns < 1: |
|
1664 | if nruns < 1: | |
1665 | error('Number of runs must be >=1') |
|
1665 | error('Number of runs must be >=1') | |
1666 | return |
|
1666 | return | |
1667 | except (KeyError): |
|
1667 | except (KeyError): | |
1668 | nruns = 1 |
|
1668 | nruns = 1 | |
1669 | if nruns == 1: |
|
1669 | if nruns == 1: | |
1670 | t0 = clock2() |
|
1670 | t0 = clock2() | |
1671 | runner(filename,prog_ns,prog_ns, |
|
1671 | runner(filename,prog_ns,prog_ns, | |
1672 | exit_ignore=exit_ignore) |
|
1672 | exit_ignore=exit_ignore) | |
1673 | t1 = clock2() |
|
1673 | t1 = clock2() | |
1674 | t_usr = t1[0]-t0[0] |
|
1674 | t_usr = t1[0]-t0[0] | |
1675 | t_sys = t1[1]-t0[1] |
|
1675 | t_sys = t1[1]-t0[1] | |
1676 | print "\nIPython CPU timings (estimated):" |
|
1676 | print "\nIPython CPU timings (estimated):" | |
1677 | print " User : %10s s." % t_usr |
|
1677 | print " User : %10s s." % t_usr | |
1678 | print " System: %10s s." % t_sys |
|
1678 | print " System: %10s s." % t_sys | |
1679 | else: |
|
1679 | else: | |
1680 | runs = range(nruns) |
|
1680 | runs = range(nruns) | |
1681 | t0 = clock2() |
|
1681 | t0 = clock2() | |
1682 | for nr in runs: |
|
1682 | for nr in runs: | |
1683 | runner(filename,prog_ns,prog_ns, |
|
1683 | runner(filename,prog_ns,prog_ns, | |
1684 | exit_ignore=exit_ignore) |
|
1684 | exit_ignore=exit_ignore) | |
1685 | t1 = clock2() |
|
1685 | t1 = clock2() | |
1686 | t_usr = t1[0]-t0[0] |
|
1686 | t_usr = t1[0]-t0[0] | |
1687 | t_sys = t1[1]-t0[1] |
|
1687 | t_sys = t1[1]-t0[1] | |
1688 | print "\nIPython CPU timings (estimated):" |
|
1688 | print "\nIPython CPU timings (estimated):" | |
1689 | print "Total runs performed:",nruns |
|
1689 | print "Total runs performed:",nruns | |
1690 | print " Times : %10s %10s" % ('Total','Per run') |
|
1690 | print " Times : %10s %10s" % ('Total','Per run') | |
1691 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) |
|
1691 | print " User : %10s s, %10s s." % (t_usr,t_usr/nruns) | |
1692 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) |
|
1692 | print " System: %10s s, %10s s." % (t_sys,t_sys/nruns) | |
1693 |
|
1693 | |||
1694 | else: |
|
1694 | else: | |
1695 | # regular execution |
|
1695 | # regular execution | |
1696 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) |
|
1696 | runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore) | |
1697 |
|
1697 | |||
1698 | if opts.has_key('i'): |
|
1698 | if opts.has_key('i'): | |
1699 | self.shell.user_ns['__name__'] = __name__save |
|
1699 | self.shell.user_ns['__name__'] = __name__save | |
1700 | else: |
|
1700 | else: | |
1701 | # The shell MUST hold a reference to prog_ns so after %run |
|
1701 | # The shell MUST hold a reference to prog_ns so after %run | |
1702 | # exits, the python deletion mechanism doesn't zero it out |
|
1702 | # exits, the python deletion mechanism doesn't zero it out | |
1703 | # (leaving dangling references). |
|
1703 | # (leaving dangling references). | |
1704 | self.shell.cache_main_mod(prog_ns,filename) |
|
1704 | self.shell.cache_main_mod(prog_ns,filename) | |
1705 | # update IPython interactive namespace |
|
1705 | # update IPython interactive namespace | |
1706 |
|
1706 | |||
1707 | # Some forms of read errors on the file may mean the |
|
1707 | # Some forms of read errors on the file may mean the | |
1708 | # __name__ key was never set; using pop we don't have to |
|
1708 | # __name__ key was never set; using pop we don't have to | |
1709 | # worry about a possible KeyError. |
|
1709 | # worry about a possible KeyError. | |
1710 | prog_ns.pop('__name__', None) |
|
1710 | prog_ns.pop('__name__', None) | |
1711 |
|
1711 | |||
1712 | self.shell.user_ns.update(prog_ns) |
|
1712 | self.shell.user_ns.update(prog_ns) | |
1713 | finally: |
|
1713 | finally: | |
1714 | # It's a bit of a mystery why, but __builtins__ can change from |
|
1714 | # It's a bit of a mystery why, but __builtins__ can change from | |
1715 | # being a module to becoming a dict missing some key data after |
|
1715 | # being a module to becoming a dict missing some key data after | |
1716 | # %run. As best I can see, this is NOT something IPython is doing |
|
1716 | # %run. As best I can see, this is NOT something IPython is doing | |
1717 | # at all, and similar problems have been reported before: |
|
1717 | # at all, and similar problems have been reported before: | |
1718 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
1718 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html | |
1719 | # Since this seems to be done by the interpreter itself, the best |
|
1719 | # Since this seems to be done by the interpreter itself, the best | |
1720 | # we can do is to at least restore __builtins__ for the user on |
|
1720 | # we can do is to at least restore __builtins__ for the user on | |
1721 | # exit. |
|
1721 | # exit. | |
1722 | self.shell.user_ns['__builtins__'] = __builtin__ |
|
1722 | self.shell.user_ns['__builtins__'] = __builtin__ | |
1723 |
|
1723 | |||
1724 | # Ensure key global structures are restored |
|
1724 | # Ensure key global structures are restored | |
1725 | sys.argv = save_argv |
|
1725 | sys.argv = save_argv | |
1726 | if restore_main: |
|
1726 | if restore_main: | |
1727 | sys.modules['__main__'] = restore_main |
|
1727 | sys.modules['__main__'] = restore_main | |
1728 | else: |
|
1728 | else: | |
1729 | # Remove from sys.modules the reference to main_mod we'd |
|
1729 | # Remove from sys.modules the reference to main_mod we'd | |
1730 | # added. Otherwise it will trap references to objects |
|
1730 | # added. Otherwise it will trap references to objects | |
1731 | # contained therein. |
|
1731 | # contained therein. | |
1732 | del sys.modules[main_mod_name] |
|
1732 | del sys.modules[main_mod_name] | |
1733 |
|
1733 | |||
1734 | return stats |
|
1734 | return stats | |
1735 |
|
1735 | |||
1736 | @testdec.skip_doctest |
|
1736 | @testdec.skip_doctest | |
1737 | def magic_timeit(self, parameter_s =''): |
|
1737 | def magic_timeit(self, parameter_s =''): | |
1738 | """Time execution of a Python statement or expression |
|
1738 | """Time execution of a Python statement or expression | |
1739 |
|
1739 | |||
1740 | Usage:\\ |
|
1740 | Usage:\\ | |
1741 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1741 | %timeit [-n<N> -r<R> [-t|-c]] statement | |
1742 |
|
1742 | |||
1743 | Time execution of a Python statement or expression using the timeit |
|
1743 | Time execution of a Python statement or expression using the timeit | |
1744 | module. |
|
1744 | module. | |
1745 |
|
1745 | |||
1746 | Options: |
|
1746 | Options: | |
1747 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1747 | -n<N>: execute the given statement <N> times in a loop. If this value | |
1748 | is not given, a fitting value is chosen. |
|
1748 | is not given, a fitting value is chosen. | |
1749 |
|
1749 | |||
1750 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1750 | -r<R>: repeat the loop iteration <R> times and take the best result. | |
1751 | Default: 3 |
|
1751 | Default: 3 | |
1752 |
|
1752 | |||
1753 | -t: use time.time to measure the time, which is the default on Unix. |
|
1753 | -t: use time.time to measure the time, which is the default on Unix. | |
1754 | This function measures wall time. |
|
1754 | This function measures wall time. | |
1755 |
|
1755 | |||
1756 | -c: use time.clock to measure the time, which is the default on |
|
1756 | -c: use time.clock to measure the time, which is the default on | |
1757 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1757 | Windows and measures wall time. On Unix, resource.getrusage is used | |
1758 | instead and returns the CPU user time. |
|
1758 | instead and returns the CPU user time. | |
1759 |
|
1759 | |||
1760 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1760 | -p<P>: use a precision of <P> digits to display the timing result. | |
1761 | Default: 3 |
|
1761 | Default: 3 | |
1762 |
|
1762 | |||
1763 |
|
1763 | |||
1764 | Examples: |
|
1764 | Examples: | |
1765 |
|
1765 | |||
1766 | In [1]: %timeit pass |
|
1766 | In [1]: %timeit pass | |
1767 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1767 | 10000000 loops, best of 3: 53.3 ns per loop | |
1768 |
|
1768 | |||
1769 | In [2]: u = None |
|
1769 | In [2]: u = None | |
1770 |
|
1770 | |||
1771 | In [3]: %timeit u is None |
|
1771 | In [3]: %timeit u is None | |
1772 | 10000000 loops, best of 3: 184 ns per loop |
|
1772 | 10000000 loops, best of 3: 184 ns per loop | |
1773 |
|
1773 | |||
1774 | In [4]: %timeit -r 4 u == None |
|
1774 | In [4]: %timeit -r 4 u == None | |
1775 | 1000000 loops, best of 4: 242 ns per loop |
|
1775 | 1000000 loops, best of 4: 242 ns per loop | |
1776 |
|
1776 | |||
1777 | In [5]: import time |
|
1777 | In [5]: import time | |
1778 |
|
1778 | |||
1779 | In [6]: %timeit -n1 time.sleep(2) |
|
1779 | In [6]: %timeit -n1 time.sleep(2) | |
1780 | 1 loops, best of 3: 2 s per loop |
|
1780 | 1 loops, best of 3: 2 s per loop | |
1781 |
|
1781 | |||
1782 |
|
1782 | |||
1783 | The times reported by %timeit will be slightly higher than those |
|
1783 | The times reported by %timeit will be slightly higher than those | |
1784 | reported by the timeit.py script when variables are accessed. This is |
|
1784 | reported by the timeit.py script when variables are accessed. This is | |
1785 | due to the fact that %timeit executes the statement in the namespace |
|
1785 | due to the fact that %timeit executes the statement in the namespace | |
1786 | of the shell, compared with timeit.py, which uses a single setup |
|
1786 | of the shell, compared with timeit.py, which uses a single setup | |
1787 | statement to import function or create variables. Generally, the bias |
|
1787 | statement to import function or create variables. Generally, the bias | |
1788 | does not matter as long as results from timeit.py are not mixed with |
|
1788 | does not matter as long as results from timeit.py are not mixed with | |
1789 | those from %timeit.""" |
|
1789 | those from %timeit.""" | |
1790 |
|
1790 | |||
1791 | import timeit |
|
1791 | import timeit | |
1792 | import math |
|
1792 | import math | |
1793 |
|
1793 | |||
1794 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in |
|
1794 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in | |
1795 | # certain terminals. Until we figure out a robust way of |
|
1795 | # certain terminals. Until we figure out a robust way of | |
1796 | # auto-detecting if the terminal can deal with it, use plain 'us' for |
|
1796 | # auto-detecting if the terminal can deal with it, use plain 'us' for | |
1797 | # microseconds. I am really NOT happy about disabling the proper |
|
1797 | # microseconds. I am really NOT happy about disabling the proper | |
1798 | # 'micro' prefix, but crashing is worse... If anyone knows what the |
|
1798 | # 'micro' prefix, but crashing is worse... If anyone knows what the | |
1799 | # right solution for this is, I'm all ears... |
|
1799 | # right solution for this is, I'm all ears... | |
1800 | # |
|
1800 | # | |
1801 | # Note: using |
|
1801 | # Note: using | |
1802 | # |
|
1802 | # | |
1803 | # s = u'\xb5' |
|
1803 | # s = u'\xb5' | |
1804 | # s.encode(sys.getdefaultencoding()) |
|
1804 | # s.encode(sys.getdefaultencoding()) | |
1805 | # |
|
1805 | # | |
1806 | # is not sufficient, as I've seen terminals where that fails but |
|
1806 | # is not sufficient, as I've seen terminals where that fails but | |
1807 | # print s |
|
1807 | # print s | |
1808 | # |
|
1808 | # | |
1809 | # succeeds |
|
1809 | # succeeds | |
1810 | # |
|
1810 | # | |
1811 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1811 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 | |
1812 |
|
1812 | |||
1813 | #units = [u"s", u"ms",u'\xb5',"ns"] |
|
1813 | #units = [u"s", u"ms",u'\xb5',"ns"] | |
1814 | units = [u"s", u"ms",u'us',"ns"] |
|
1814 | units = [u"s", u"ms",u'us',"ns"] | |
1815 |
|
1815 | |||
1816 | scaling = [1, 1e3, 1e6, 1e9] |
|
1816 | scaling = [1, 1e3, 1e6, 1e9] | |
1817 |
|
1817 | |||
1818 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1818 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', | |
1819 | posix=False) |
|
1819 | posix=False) | |
1820 | if stmt == "": |
|
1820 | if stmt == "": | |
1821 | return |
|
1821 | return | |
1822 | timefunc = timeit.default_timer |
|
1822 | timefunc = timeit.default_timer | |
1823 | number = int(getattr(opts, "n", 0)) |
|
1823 | number = int(getattr(opts, "n", 0)) | |
1824 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1824 | repeat = int(getattr(opts, "r", timeit.default_repeat)) | |
1825 | precision = int(getattr(opts, "p", 3)) |
|
1825 | precision = int(getattr(opts, "p", 3)) | |
1826 | if hasattr(opts, "t"): |
|
1826 | if hasattr(opts, "t"): | |
1827 | timefunc = time.time |
|
1827 | timefunc = time.time | |
1828 | if hasattr(opts, "c"): |
|
1828 | if hasattr(opts, "c"): | |
1829 | timefunc = clock |
|
1829 | timefunc = clock | |
1830 |
|
1830 | |||
1831 | timer = timeit.Timer(timer=timefunc) |
|
1831 | timer = timeit.Timer(timer=timefunc) | |
1832 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1832 | # this code has tight coupling to the inner workings of timeit.Timer, | |
1833 | # but is there a better way to achieve that the code stmt has access |
|
1833 | # but is there a better way to achieve that the code stmt has access | |
1834 | # to the shell namespace? |
|
1834 | # to the shell namespace? | |
1835 |
|
1835 | |||
1836 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1836 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), | |
1837 | 'setup': "pass"} |
|
1837 | 'setup': "pass"} | |
1838 | # Track compilation time so it can be reported if too long |
|
1838 | # Track compilation time so it can be reported if too long | |
1839 | # Minimum time above which compilation time will be reported |
|
1839 | # Minimum time above which compilation time will be reported | |
1840 | tc_min = 0.1 |
|
1840 | tc_min = 0.1 | |
1841 |
|
1841 | |||
1842 | t0 = clock() |
|
1842 | t0 = clock() | |
1843 | code = compile(src, "<magic-timeit>", "exec") |
|
1843 | code = compile(src, "<magic-timeit>", "exec") | |
1844 | tc = clock()-t0 |
|
1844 | tc = clock()-t0 | |
1845 |
|
1845 | |||
1846 | ns = {} |
|
1846 | ns = {} | |
1847 | exec code in self.shell.user_ns, ns |
|
1847 | exec code in self.shell.user_ns, ns | |
1848 | timer.inner = ns["inner"] |
|
1848 | timer.inner = ns["inner"] | |
1849 |
|
1849 | |||
1850 | if number == 0: |
|
1850 | if number == 0: | |
1851 | # determine number so that 0.2 <= total time < 2.0 |
|
1851 | # determine number so that 0.2 <= total time < 2.0 | |
1852 | number = 1 |
|
1852 | number = 1 | |
1853 | for i in range(1, 10): |
|
1853 | for i in range(1, 10): | |
1854 | if timer.timeit(number) >= 0.2: |
|
1854 | if timer.timeit(number) >= 0.2: | |
1855 | break |
|
1855 | break | |
1856 | number *= 10 |
|
1856 | number *= 10 | |
1857 |
|
1857 | |||
1858 | best = min(timer.repeat(repeat, number)) / number |
|
1858 | best = min(timer.repeat(repeat, number)) / number | |
1859 |
|
1859 | |||
1860 | if best > 0.0 and best < 1000.0: |
|
1860 | if best > 0.0 and best < 1000.0: | |
1861 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
1861 | order = min(-int(math.floor(math.log10(best)) // 3), 3) | |
1862 | elif best >= 1000.0: |
|
1862 | elif best >= 1000.0: | |
1863 | order = 0 |
|
1863 | order = 0 | |
1864 | else: |
|
1864 | else: | |
1865 | order = 3 |
|
1865 | order = 3 | |
1866 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
1866 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, | |
1867 | precision, |
|
1867 | precision, | |
1868 | best * scaling[order], |
|
1868 | best * scaling[order], | |
1869 | units[order]) |
|
1869 | units[order]) | |
1870 | if tc > tc_min: |
|
1870 | if tc > tc_min: | |
1871 | print "Compiler time: %.2f s" % tc |
|
1871 | print "Compiler time: %.2f s" % tc | |
1872 |
|
1872 | |||
1873 | @testdec.skip_doctest |
|
1873 | @testdec.skip_doctest | |
1874 | @needs_local_scope |
|
1874 | @needs_local_scope | |
1875 | def magic_time(self,parameter_s = ''): |
|
1875 | def magic_time(self,parameter_s = ''): | |
1876 | """Time execution of a Python statement or expression. |
|
1876 | """Time execution of a Python statement or expression. | |
1877 |
|
1877 | |||
1878 | The CPU and wall clock times are printed, and the value of the |
|
1878 | The CPU and wall clock times are printed, and the value of the | |
1879 | expression (if any) is returned. Note that under Win32, system time |
|
1879 | expression (if any) is returned. Note that under Win32, system time | |
1880 | is always reported as 0, since it can not be measured. |
|
1880 | is always reported as 0, since it can not be measured. | |
1881 |
|
1881 | |||
1882 | This function provides very basic timing functionality. In Python |
|
1882 | This function provides very basic timing functionality. In Python | |
1883 | 2.3, the timeit module offers more control and sophistication, so this |
|
1883 | 2.3, the timeit module offers more control and sophistication, so this | |
1884 | could be rewritten to use it (patches welcome). |
|
1884 | could be rewritten to use it (patches welcome). | |
1885 |
|
1885 | |||
1886 | Some examples: |
|
1886 | Some examples: | |
1887 |
|
1887 | |||
1888 | In [1]: time 2**128 |
|
1888 | In [1]: time 2**128 | |
1889 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1889 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1890 | Wall time: 0.00 |
|
1890 | Wall time: 0.00 | |
1891 | Out[1]: 340282366920938463463374607431768211456L |
|
1891 | Out[1]: 340282366920938463463374607431768211456L | |
1892 |
|
1892 | |||
1893 | In [2]: n = 1000000 |
|
1893 | In [2]: n = 1000000 | |
1894 |
|
1894 | |||
1895 | In [3]: time sum(range(n)) |
|
1895 | In [3]: time sum(range(n)) | |
1896 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1896 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s | |
1897 | Wall time: 1.37 |
|
1897 | Wall time: 1.37 | |
1898 | Out[3]: 499999500000L |
|
1898 | Out[3]: 499999500000L | |
1899 |
|
1899 | |||
1900 | In [4]: time print 'hello world' |
|
1900 | In [4]: time print 'hello world' | |
1901 | hello world |
|
1901 | hello world | |
1902 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1902 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1903 | Wall time: 0.00 |
|
1903 | Wall time: 0.00 | |
1904 |
|
1904 | |||
1905 | Note that the time needed by Python to compile the given expression |
|
1905 | Note that the time needed by Python to compile the given expression | |
1906 | will be reported if it is more than 0.1s. In this example, the |
|
1906 | will be reported if it is more than 0.1s. In this example, the | |
1907 | actual exponentiation is done by Python at compilation time, so while |
|
1907 | actual exponentiation is done by Python at compilation time, so while | |
1908 | the expression can take a noticeable amount of time to compute, that |
|
1908 | the expression can take a noticeable amount of time to compute, that | |
1909 | time is purely due to the compilation: |
|
1909 | time is purely due to the compilation: | |
1910 |
|
1910 | |||
1911 | In [5]: time 3**9999; |
|
1911 | In [5]: time 3**9999; | |
1912 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1912 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1913 | Wall time: 0.00 s |
|
1913 | Wall time: 0.00 s | |
1914 |
|
1914 | |||
1915 | In [6]: time 3**999999; |
|
1915 | In [6]: time 3**999999; | |
1916 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1916 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
1917 | Wall time: 0.00 s |
|
1917 | Wall time: 0.00 s | |
1918 | Compiler : 0.78 s |
|
1918 | Compiler : 0.78 s | |
1919 | """ |
|
1919 | """ | |
1920 |
|
1920 | |||
1921 | # fail immediately if the given expression can't be compiled |
|
1921 | # fail immediately if the given expression can't be compiled | |
1922 |
|
1922 | |||
1923 | expr = self.shell.prefilter(parameter_s,False) |
|
1923 | expr = self.shell.prefilter(parameter_s,False) | |
1924 |
|
1924 | |||
1925 | # Minimum time above which compilation time will be reported |
|
1925 | # Minimum time above which compilation time will be reported | |
1926 | tc_min = 0.1 |
|
1926 | tc_min = 0.1 | |
1927 |
|
1927 | |||
1928 | try: |
|
1928 | try: | |
1929 | mode = 'eval' |
|
1929 | mode = 'eval' | |
1930 | t0 = clock() |
|
1930 | t0 = clock() | |
1931 | code = compile(expr,'<timed eval>',mode) |
|
1931 | code = compile(expr,'<timed eval>',mode) | |
1932 | tc = clock()-t0 |
|
1932 | tc = clock()-t0 | |
1933 | except SyntaxError: |
|
1933 | except SyntaxError: | |
1934 | mode = 'exec' |
|
1934 | mode = 'exec' | |
1935 | t0 = clock() |
|
1935 | t0 = clock() | |
1936 | code = compile(expr,'<timed exec>',mode) |
|
1936 | code = compile(expr,'<timed exec>',mode) | |
1937 | tc = clock()-t0 |
|
1937 | tc = clock()-t0 | |
1938 | # skew measurement as little as possible |
|
1938 | # skew measurement as little as possible | |
1939 | glob = self.shell.user_ns |
|
1939 | glob = self.shell.user_ns | |
1940 | locs = self._magic_locals |
|
1940 | locs = self._magic_locals | |
1941 | clk = clock2 |
|
1941 | clk = clock2 | |
1942 | wtime = time.time |
|
1942 | wtime = time.time | |
1943 | # time execution |
|
1943 | # time execution | |
1944 | wall_st = wtime() |
|
1944 | wall_st = wtime() | |
1945 | if mode=='eval': |
|
1945 | if mode=='eval': | |
1946 | st = clk() |
|
1946 | st = clk() | |
1947 | out = eval(code, glob, locs) |
|
1947 | out = eval(code, glob, locs) | |
1948 | end = clk() |
|
1948 | end = clk() | |
1949 | else: |
|
1949 | else: | |
1950 | st = clk() |
|
1950 | st = clk() | |
1951 | exec code in glob, locs |
|
1951 | exec code in glob, locs | |
1952 | end = clk() |
|
1952 | end = clk() | |
1953 | out = None |
|
1953 | out = None | |
1954 | wall_end = wtime() |
|
1954 | wall_end = wtime() | |
1955 | # Compute actual times and report |
|
1955 | # Compute actual times and report | |
1956 | wall_time = wall_end-wall_st |
|
1956 | wall_time = wall_end-wall_st | |
1957 | cpu_user = end[0]-st[0] |
|
1957 | cpu_user = end[0]-st[0] | |
1958 | cpu_sys = end[1]-st[1] |
|
1958 | cpu_sys = end[1]-st[1] | |
1959 | cpu_tot = cpu_user+cpu_sys |
|
1959 | cpu_tot = cpu_user+cpu_sys | |
1960 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
1960 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ | |
1961 | (cpu_user,cpu_sys,cpu_tot) |
|
1961 | (cpu_user,cpu_sys,cpu_tot) | |
1962 | print "Wall time: %.2f s" % wall_time |
|
1962 | print "Wall time: %.2f s" % wall_time | |
1963 | if tc > tc_min: |
|
1963 | if tc > tc_min: | |
1964 | print "Compiler : %.2f s" % tc |
|
1964 | print "Compiler : %.2f s" % tc | |
1965 | return out |
|
1965 | return out | |
1966 |
|
1966 | |||
1967 | @testdec.skip_doctest |
|
1967 | @testdec.skip_doctest | |
1968 | def magic_macro(self,parameter_s = ''): |
|
1968 | def magic_macro(self,parameter_s = ''): | |
1969 | """Define a macro for future re-execution. It accepts ranges of history, |
|
1969 | """Define a macro for future re-execution. It accepts ranges of history, | |
1970 | filenames or string objects. |
|
1970 | filenames or string objects. | |
1971 |
|
1971 | |||
1972 | Usage:\\ |
|
1972 | Usage:\\ | |
1973 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1973 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... | |
1974 |
|
1974 | |||
1975 | Options: |
|
1975 | Options: | |
1976 |
|
1976 | |||
1977 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1977 | -r: use 'raw' input. By default, the 'processed' history is used, | |
1978 | so that magics are loaded in their transformed version to valid |
|
1978 | so that magics are loaded in their transformed version to valid | |
1979 | Python. If this option is given, the raw input as typed as the |
|
1979 | Python. If this option is given, the raw input as typed as the | |
1980 | command line is used instead. |
|
1980 | command line is used instead. | |
1981 |
|
1981 | |||
1982 | This will define a global variable called `name` which is a string |
|
1982 | This will define a global variable called `name` which is a string | |
1983 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1983 | made of joining the slices and lines you specify (n1,n2,... numbers | |
1984 | above) from your input history into a single string. This variable |
|
1984 | above) from your input history into a single string. This variable | |
1985 | acts like an automatic function which re-executes those lines as if |
|
1985 | acts like an automatic function which re-executes those lines as if | |
1986 | you had typed them. You just type 'name' at the prompt and the code |
|
1986 | you had typed them. You just type 'name' at the prompt and the code | |
1987 | executes. |
|
1987 | executes. | |
1988 |
|
1988 | |||
1989 | The syntax for indicating input ranges is described in %history. |
|
1989 | The syntax for indicating input ranges is described in %history. | |
1990 |
|
1990 | |||
1991 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1991 | Note: as a 'hidden' feature, you can also use traditional python slice | |
1992 | notation, where N:M means numbers N through M-1. |
|
1992 | notation, where N:M means numbers N through M-1. | |
1993 |
|
1993 | |||
1994 | For example, if your history contains (%hist prints it): |
|
1994 | For example, if your history contains (%hist prints it): | |
1995 |
|
1995 | |||
1996 | 44: x=1 |
|
1996 | 44: x=1 | |
1997 | 45: y=3 |
|
1997 | 45: y=3 | |
1998 | 46: z=x+y |
|
1998 | 46: z=x+y | |
1999 | 47: print x |
|
1999 | 47: print x | |
2000 | 48: a=5 |
|
2000 | 48: a=5 | |
2001 | 49: print 'x',x,'y',y |
|
2001 | 49: print 'x',x,'y',y | |
2002 |
|
2002 | |||
2003 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
2003 | you can create a macro with lines 44 through 47 (included) and line 49 | |
2004 | called my_macro with: |
|
2004 | called my_macro with: | |
2005 |
|
2005 | |||
2006 | In [55]: %macro my_macro 44-47 49 |
|
2006 | In [55]: %macro my_macro 44-47 49 | |
2007 |
|
2007 | |||
2008 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
2008 | Now, typing `my_macro` (without quotes) will re-execute all this code | |
2009 | in one pass. |
|
2009 | in one pass. | |
2010 |
|
2010 | |||
2011 | You don't need to give the line-numbers in order, and any given line |
|
2011 | You don't need to give the line-numbers in order, and any given line | |
2012 | number can appear multiple times. You can assemble macros with any |
|
2012 | number can appear multiple times. You can assemble macros with any | |
2013 | lines from your input history in any order. |
|
2013 | lines from your input history in any order. | |
2014 |
|
2014 | |||
2015 | The macro is a simple object which holds its value in an attribute, |
|
2015 | The macro is a simple object which holds its value in an attribute, | |
2016 | but IPython's display system checks for macros and executes them as |
|
2016 | but IPython's display system checks for macros and executes them as | |
2017 | code instead of printing them when you type their name. |
|
2017 | code instead of printing them when you type their name. | |
2018 |
|
2018 | |||
2019 | You can view a macro's contents by explicitly printing it with: |
|
2019 | You can view a macro's contents by explicitly printing it with: | |
2020 |
|
2020 | |||
2021 | 'print macro_name'. |
|
2021 | 'print macro_name'. | |
2022 |
|
2022 | |||
2023 | """ |
|
2023 | """ | |
2024 |
|
2024 | |||
2025 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2025 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
2026 | if not args: # List existing macros |
|
2026 | if not args: # List existing macros | |
2027 | return sorted(k for k,v in self.shell.user_ns.iteritems() if\ |
|
2027 | return sorted(k for k,v in self.shell.user_ns.iteritems() if\ | |
2028 | isinstance(v, Macro)) |
|
2028 | isinstance(v, Macro)) | |
2029 | if len(args) == 1: |
|
2029 | if len(args) == 1: | |
2030 | raise UsageError( |
|
2030 | raise UsageError( | |
2031 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
2031 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") | |
2032 | name, codefrom = args[0], " ".join(args[1:]) |
|
2032 | name, codefrom = args[0], " ".join(args[1:]) | |
2033 |
|
2033 | |||
2034 | #print 'rng',ranges # dbg |
|
2034 | #print 'rng',ranges # dbg | |
2035 | try: |
|
2035 | try: | |
2036 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2036 | lines = self.shell.find_user_code(codefrom, 'r' in opts) | |
2037 | except (ValueError, TypeError) as e: |
|
2037 | except (ValueError, TypeError) as e: | |
2038 | print e.args[0] |
|
2038 | print e.args[0] | |
2039 | return |
|
2039 | return | |
2040 | macro = Macro(lines) |
|
2040 | macro = Macro(lines) | |
2041 | self.shell.define_macro(name, macro) |
|
2041 | self.shell.define_macro(name, macro) | |
2042 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
2042 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name | |
2043 | print '=== Macro contents: ===' |
|
2043 | print '=== Macro contents: ===' | |
2044 | print macro, |
|
2044 | print macro, | |
2045 |
|
2045 | |||
2046 | def magic_save(self,parameter_s = ''): |
|
2046 | def magic_save(self,parameter_s = ''): | |
2047 | """Save a set of lines or a macro to a given filename. |
|
2047 | """Save a set of lines or a macro to a given filename. | |
2048 |
|
2048 | |||
2049 | Usage:\\ |
|
2049 | Usage:\\ | |
2050 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
2050 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... | |
2051 |
|
2051 | |||
2052 | Options: |
|
2052 | Options: | |
2053 |
|
2053 | |||
2054 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2054 | -r: use 'raw' input. By default, the 'processed' history is used, | |
2055 | so that magics are loaded in their transformed version to valid |
|
2055 | so that magics are loaded in their transformed version to valid | |
2056 | Python. If this option is given, the raw input as typed as the |
|
2056 | Python. If this option is given, the raw input as typed as the | |
2057 | command line is used instead. |
|
2057 | command line is used instead. | |
2058 |
|
2058 | |||
2059 | This function uses the same syntax as %history for input ranges, |
|
2059 | This function uses the same syntax as %history for input ranges, | |
2060 | then saves the lines to the filename you specify. |
|
2060 | then saves the lines to the filename you specify. | |
2061 |
|
2061 | |||
2062 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
2062 | It adds a '.py' extension to the file if you don't do so yourself, and | |
2063 | it asks for confirmation before overwriting existing files.""" |
|
2063 | it asks for confirmation before overwriting existing files.""" | |
2064 |
|
2064 | |||
2065 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2065 | opts,args = self.parse_options(parameter_s,'r',mode='list') | |
2066 | fname, codefrom = args[0], " ".join(args[1:]) |
|
2066 | fname, codefrom = args[0], " ".join(args[1:]) | |
2067 | if not fname.endswith('.py'): |
|
2067 | if not fname.endswith('.py'): | |
2068 | fname += '.py' |
|
2068 | fname += '.py' | |
2069 | if os.path.isfile(fname): |
|
2069 | if os.path.isfile(fname): | |
2070 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
2070 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) | |
2071 | if ans.lower() not in ['y','yes']: |
|
2071 | if ans.lower() not in ['y','yes']: | |
2072 | print 'Operation cancelled.' |
|
2072 | print 'Operation cancelled.' | |
2073 | return |
|
2073 | return | |
2074 | try: |
|
2074 | try: | |
2075 | cmds = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2075 | cmds = self.shell.find_user_code(codefrom, 'r' in opts) | |
2076 | except (TypeError, ValueError) as e: |
|
2076 | except (TypeError, ValueError) as e: | |
2077 | print e.args[0] |
|
2077 | print e.args[0] | |
2078 | return |
|
2078 | return | |
2079 | if isinstance(cmds, unicode): |
|
2079 | if isinstance(cmds, unicode): | |
2080 | cmds = cmds.encode("utf-8") |
|
2080 | cmds = cmds.encode("utf-8") | |
2081 | with open(fname,'w') as f: |
|
2081 | with open(fname,'w') as f: | |
2082 | f.write("# coding: utf-8\n") |
|
2082 | f.write("# coding: utf-8\n") | |
2083 | f.write(cmds) |
|
2083 | f.write(cmds) | |
2084 | print 'The following commands were written to file `%s`:' % fname |
|
2084 | print 'The following commands were written to file `%s`:' % fname | |
2085 | print cmds |
|
2085 | print cmds | |
2086 |
|
2086 | |||
2087 | def magic_pastebin(self, parameter_s = ''): |
|
2087 | def magic_pastebin(self, parameter_s = ''): | |
2088 | """Upload code to the 'Lodge it' paste bin, returning the URL.""" |
|
2088 | """Upload code to the 'Lodge it' paste bin, returning the URL.""" | |
2089 | try: |
|
2089 | try: | |
2090 | code = self.shell.find_user_code(parameter_s) |
|
2090 | code = self.shell.find_user_code(parameter_s) | |
2091 | except (ValueError, TypeError) as e: |
|
2091 | except (ValueError, TypeError) as e: | |
2092 | print e.args[0] |
|
2092 | print e.args[0] | |
2093 | return |
|
2093 | return | |
2094 | pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/') |
|
2094 | pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/') | |
2095 | id = pbserver.pastes.newPaste("python", code) |
|
2095 | id = pbserver.pastes.newPaste("python", code) | |
2096 | return "http://paste.pocoo.org/show/" + id |
|
2096 | return "http://paste.pocoo.org/show/" + id | |
2097 |
|
2097 | |||
2098 | def _edit_macro(self,mname,macro): |
|
2098 | def _edit_macro(self,mname,macro): | |
2099 | """open an editor with the macro data in a file""" |
|
2099 | """open an editor with the macro data in a file""" | |
2100 | filename = self.shell.mktempfile(macro.value) |
|
2100 | filename = self.shell.mktempfile(macro.value) | |
2101 | self.shell.hooks.editor(filename) |
|
2101 | self.shell.hooks.editor(filename) | |
2102 |
|
2102 | |||
2103 | # and make a new macro object, to replace the old one |
|
2103 | # and make a new macro object, to replace the old one | |
2104 | mfile = open(filename) |
|
2104 | mfile = open(filename) | |
2105 | mvalue = mfile.read() |
|
2105 | mvalue = mfile.read() | |
2106 | mfile.close() |
|
2106 | mfile.close() | |
2107 | self.shell.user_ns[mname] = Macro(mvalue) |
|
2107 | self.shell.user_ns[mname] = Macro(mvalue) | |
2108 |
|
2108 | |||
2109 | def magic_ed(self,parameter_s=''): |
|
2109 | def magic_ed(self,parameter_s=''): | |
2110 | """Alias to %edit.""" |
|
2110 | """Alias to %edit.""" | |
2111 | return self.magic_edit(parameter_s) |
|
2111 | return self.magic_edit(parameter_s) | |
2112 |
|
2112 | |||
2113 | @testdec.skip_doctest |
|
2113 | @testdec.skip_doctest | |
2114 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
2114 | def magic_edit(self,parameter_s='',last_call=['','']): | |
2115 | """Bring up an editor and execute the resulting code. |
|
2115 | """Bring up an editor and execute the resulting code. | |
2116 |
|
2116 | |||
2117 | Usage: |
|
2117 | Usage: | |
2118 | %edit [options] [args] |
|
2118 | %edit [options] [args] | |
2119 |
|
2119 | |||
2120 | %edit runs IPython's editor hook. The default version of this hook is |
|
2120 | %edit runs IPython's editor hook. The default version of this hook is | |
2121 | set to call the __IPYTHON__.rc.editor command. This is read from your |
|
2121 | set to call the __IPYTHON__.rc.editor command. This is read from your | |
2122 | environment variable $EDITOR. If this isn't found, it will default to |
|
2122 | environment variable $EDITOR. If this isn't found, it will default to | |
2123 | vi under Linux/Unix and to notepad under Windows. See the end of this |
|
2123 | vi under Linux/Unix and to notepad under Windows. See the end of this | |
2124 | docstring for how to change the editor hook. |
|
2124 | docstring for how to change the editor hook. | |
2125 |
|
2125 | |||
2126 | You can also set the value of this editor via the command line option |
|
2126 | You can also set the value of this editor via the command line option | |
2127 | '-editor' or in your ipythonrc file. This is useful if you wish to use |
|
2127 | '-editor' or in your ipythonrc file. This is useful if you wish to use | |
2128 | specifically for IPython an editor different from your typical default |
|
2128 | specifically for IPython an editor different from your typical default | |
2129 | (and for Windows users who typically don't set environment variables). |
|
2129 | (and for Windows users who typically don't set environment variables). | |
2130 |
|
2130 | |||
2131 | This command allows you to conveniently edit multi-line code right in |
|
2131 | This command allows you to conveniently edit multi-line code right in | |
2132 | your IPython session. |
|
2132 | your IPython session. | |
2133 |
|
2133 | |||
2134 | If called without arguments, %edit opens up an empty editor with a |
|
2134 | If called without arguments, %edit opens up an empty editor with a | |
2135 | temporary file and will execute the contents of this file when you |
|
2135 | temporary file and will execute the contents of this file when you | |
2136 | close it (don't forget to save it!). |
|
2136 | close it (don't forget to save it!). | |
2137 |
|
2137 | |||
2138 |
|
2138 | |||
2139 | Options: |
|
2139 | Options: | |
2140 |
|
2140 | |||
2141 | -n <number>: open the editor at a specified line number. By default, |
|
2141 | -n <number>: open the editor at a specified line number. By default, | |
2142 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
2142 | the IPython editor hook uses the unix syntax 'editor +N filename', but | |
2143 | you can configure this by providing your own modified hook if your |
|
2143 | you can configure this by providing your own modified hook if your | |
2144 | favorite editor supports line-number specifications with a different |
|
2144 | favorite editor supports line-number specifications with a different | |
2145 | syntax. |
|
2145 | syntax. | |
2146 |
|
2146 | |||
2147 | -p: this will call the editor with the same data as the previous time |
|
2147 | -p: this will call the editor with the same data as the previous time | |
2148 | it was used, regardless of how long ago (in your current session) it |
|
2148 | it was used, regardless of how long ago (in your current session) it | |
2149 | was. |
|
2149 | was. | |
2150 |
|
2150 | |||
2151 | -r: use 'raw' input. This option only applies to input taken from the |
|
2151 | -r: use 'raw' input. This option only applies to input taken from the | |
2152 | user's history. By default, the 'processed' history is used, so that |
|
2152 | user's history. By default, the 'processed' history is used, so that | |
2153 | magics are loaded in their transformed version to valid Python. If |
|
2153 | magics are loaded in their transformed version to valid Python. If | |
2154 | this option is given, the raw input as typed as the command line is |
|
2154 | this option is given, the raw input as typed as the command line is | |
2155 | used instead. When you exit the editor, it will be executed by |
|
2155 | used instead. When you exit the editor, it will be executed by | |
2156 | IPython's own processor. |
|
2156 | IPython's own processor. | |
2157 |
|
2157 | |||
2158 | -x: do not execute the edited code immediately upon exit. This is |
|
2158 | -x: do not execute the edited code immediately upon exit. This is | |
2159 | mainly useful if you are editing programs which need to be called with |
|
2159 | mainly useful if you are editing programs which need to be called with | |
2160 | command line arguments, which you can then do using %run. |
|
2160 | command line arguments, which you can then do using %run. | |
2161 |
|
2161 | |||
2162 |
|
2162 | |||
2163 | Arguments: |
|
2163 | Arguments: | |
2164 |
|
2164 | |||
2165 | If arguments are given, the following possibilites exist: |
|
2165 | If arguments are given, the following possibilites exist: | |
2166 |
|
2166 | |||
2167 | - If the argument is a filename, IPython will load that into the |
|
2167 | - If the argument is a filename, IPython will load that into the | |
2168 | editor. It will execute its contents with execfile() when you exit, |
|
2168 | editor. It will execute its contents with execfile() when you exit, | |
2169 | loading any code in the file into your interactive namespace. |
|
2169 | loading any code in the file into your interactive namespace. | |
2170 |
|
2170 | |||
2171 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". |
|
2171 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". | |
2172 | The syntax is the same as in the %history magic. |
|
2172 | The syntax is the same as in the %history magic. | |
2173 |
|
2173 | |||
2174 | - If the argument is a string variable, its contents are loaded |
|
2174 | - If the argument is a string variable, its contents are loaded | |
2175 | into the editor. You can thus edit any string which contains |
|
2175 | into the editor. You can thus edit any string which contains | |
2176 | python code (including the result of previous edits). |
|
2176 | python code (including the result of previous edits). | |
2177 |
|
2177 | |||
2178 | - If the argument is the name of an object (other than a string), |
|
2178 | - If the argument is the name of an object (other than a string), | |
2179 | IPython will try to locate the file where it was defined and open the |
|
2179 | IPython will try to locate the file where it was defined and open the | |
2180 | editor at the point where it is defined. You can use `%edit function` |
|
2180 | editor at the point where it is defined. You can use `%edit function` | |
2181 | to load an editor exactly at the point where 'function' is defined, |
|
2181 | to load an editor exactly at the point where 'function' is defined, | |
2182 | edit it and have the file be executed automatically. |
|
2182 | edit it and have the file be executed automatically. | |
2183 |
|
2183 | |||
2184 | If the object is a macro (see %macro for details), this opens up your |
|
2184 | If the object is a macro (see %macro for details), this opens up your | |
2185 | specified editor with a temporary file containing the macro's data. |
|
2185 | specified editor with a temporary file containing the macro's data. | |
2186 | Upon exit, the macro is reloaded with the contents of the file. |
|
2186 | Upon exit, the macro is reloaded with the contents of the file. | |
2187 |
|
2187 | |||
2188 | Note: opening at an exact line is only supported under Unix, and some |
|
2188 | Note: opening at an exact line is only supported under Unix, and some | |
2189 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
2189 | editors (like kedit and gedit up to Gnome 2.8) do not understand the | |
2190 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
2190 | '+NUMBER' parameter necessary for this feature. Good editors like | |
2191 | (X)Emacs, vi, jed, pico and joe all do. |
|
2191 | (X)Emacs, vi, jed, pico and joe all do. | |
2192 |
|
2192 | |||
2193 | After executing your code, %edit will return as output the code you |
|
2193 | After executing your code, %edit will return as output the code you | |
2194 | typed in the editor (except when it was an existing file). This way |
|
2194 | typed in the editor (except when it was an existing file). This way | |
2195 | you can reload the code in further invocations of %edit as a variable, |
|
2195 | you can reload the code in further invocations of %edit as a variable, | |
2196 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
2196 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of | |
2197 | the output. |
|
2197 | the output. | |
2198 |
|
2198 | |||
2199 | Note that %edit is also available through the alias %ed. |
|
2199 | Note that %edit is also available through the alias %ed. | |
2200 |
|
2200 | |||
2201 | This is an example of creating a simple function inside the editor and |
|
2201 | This is an example of creating a simple function inside the editor and | |
2202 | then modifying it. First, start up the editor: |
|
2202 | then modifying it. First, start up the editor: | |
2203 |
|
2203 | |||
2204 | In [1]: ed |
|
2204 | In [1]: ed | |
2205 | Editing... done. Executing edited code... |
|
2205 | Editing... done. Executing edited code... | |
2206 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' |
|
2206 | Out[1]: 'def foo():n print "foo() was defined in an editing session"n' | |
2207 |
|
2207 | |||
2208 | We can then call the function foo(): |
|
2208 | We can then call the function foo(): | |
2209 |
|
2209 | |||
2210 | In [2]: foo() |
|
2210 | In [2]: foo() | |
2211 | foo() was defined in an editing session |
|
2211 | foo() was defined in an editing session | |
2212 |
|
2212 | |||
2213 | Now we edit foo. IPython automatically loads the editor with the |
|
2213 | Now we edit foo. IPython automatically loads the editor with the | |
2214 | (temporary) file where foo() was previously defined: |
|
2214 | (temporary) file where foo() was previously defined: | |
2215 |
|
2215 | |||
2216 | In [3]: ed foo |
|
2216 | In [3]: ed foo | |
2217 | Editing... done. Executing edited code... |
|
2217 | Editing... done. Executing edited code... | |
2218 |
|
2218 | |||
2219 | And if we call foo() again we get the modified version: |
|
2219 | And if we call foo() again we get the modified version: | |
2220 |
|
2220 | |||
2221 | In [4]: foo() |
|
2221 | In [4]: foo() | |
2222 | foo() has now been changed! |
|
2222 | foo() has now been changed! | |
2223 |
|
2223 | |||
2224 | Here is an example of how to edit a code snippet successive |
|
2224 | Here is an example of how to edit a code snippet successive | |
2225 | times. First we call the editor: |
|
2225 | times. First we call the editor: | |
2226 |
|
2226 | |||
2227 | In [5]: ed |
|
2227 | In [5]: ed | |
2228 | Editing... done. Executing edited code... |
|
2228 | Editing... done. Executing edited code... | |
2229 | hello |
|
2229 | hello | |
2230 | Out[5]: "print 'hello'n" |
|
2230 | Out[5]: "print 'hello'n" | |
2231 |
|
2231 | |||
2232 | Now we call it again with the previous output (stored in _): |
|
2232 | Now we call it again with the previous output (stored in _): | |
2233 |
|
2233 | |||
2234 | In [6]: ed _ |
|
2234 | In [6]: ed _ | |
2235 | Editing... done. Executing edited code... |
|
2235 | Editing... done. Executing edited code... | |
2236 | hello world |
|
2236 | hello world | |
2237 | Out[6]: "print 'hello world'n" |
|
2237 | Out[6]: "print 'hello world'n" | |
2238 |
|
2238 | |||
2239 | Now we call it with the output #8 (stored in _8, also as Out[8]): |
|
2239 | Now we call it with the output #8 (stored in _8, also as Out[8]): | |
2240 |
|
2240 | |||
2241 | In [7]: ed _8 |
|
2241 | In [7]: ed _8 | |
2242 | Editing... done. Executing edited code... |
|
2242 | Editing... done. Executing edited code... | |
2243 | hello again |
|
2243 | hello again | |
2244 | Out[7]: "print 'hello again'n" |
|
2244 | Out[7]: "print 'hello again'n" | |
2245 |
|
2245 | |||
2246 |
|
2246 | |||
2247 | Changing the default editor hook: |
|
2247 | Changing the default editor hook: | |
2248 |
|
2248 | |||
2249 | If you wish to write your own editor hook, you can put it in a |
|
2249 | If you wish to write your own editor hook, you can put it in a | |
2250 | configuration file which you load at startup time. The default hook |
|
2250 | configuration file which you load at startup time. The default hook | |
2251 | is defined in the IPython.core.hooks module, and you can use that as a |
|
2251 | is defined in the IPython.core.hooks module, and you can use that as a | |
2252 | starting example for further modifications. That file also has |
|
2252 | starting example for further modifications. That file also has | |
2253 | general instructions on how to set a new hook for use once you've |
|
2253 | general instructions on how to set a new hook for use once you've | |
2254 | defined it.""" |
|
2254 | defined it.""" | |
2255 |
|
2255 | |||
2256 | # FIXME: This function has become a convoluted mess. It needs a |
|
2256 | # FIXME: This function has become a convoluted mess. It needs a | |
2257 | # ground-up rewrite with clean, simple logic. |
|
2257 | # ground-up rewrite with clean, simple logic. | |
2258 |
|
2258 | |||
2259 | def make_filename(arg): |
|
2259 | def make_filename(arg): | |
2260 | "Make a filename from the given args" |
|
2260 | "Make a filename from the given args" | |
2261 | try: |
|
2261 | try: | |
2262 | filename = get_py_filename(arg) |
|
2262 | filename = get_py_filename(arg) | |
2263 | except IOError: |
|
2263 | except IOError: | |
2264 | if args.endswith('.py'): |
|
2264 | if args.endswith('.py'): | |
2265 | filename = arg |
|
2265 | filename = arg | |
2266 | else: |
|
2266 | else: | |
2267 | filename = None |
|
2267 | filename = None | |
2268 | return filename |
|
2268 | return filename | |
2269 |
|
2269 | |||
2270 | # custom exceptions |
|
2270 | # custom exceptions | |
2271 | class DataIsObject(Exception): pass |
|
2271 | class DataIsObject(Exception): pass | |
2272 |
|
2272 | |||
2273 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
2273 | opts,args = self.parse_options(parameter_s,'prxn:') | |
2274 | # Set a few locals from the options for convenience: |
|
2274 | # Set a few locals from the options for convenience: | |
2275 | opts_prev = 'p' in opts |
|
2275 | opts_prev = 'p' in opts | |
2276 | opts_raw = 'r' in opts |
|
2276 | opts_raw = 'r' in opts | |
2277 |
|
2277 | |||
2278 | # Default line number value |
|
2278 | # Default line number value | |
2279 | lineno = opts.get('n',None) |
|
2279 | lineno = opts.get('n',None) | |
2280 |
|
2280 | |||
2281 | if opts_prev: |
|
2281 | if opts_prev: | |
2282 | args = '_%s' % last_call[0] |
|
2282 | args = '_%s' % last_call[0] | |
2283 | if not self.shell.user_ns.has_key(args): |
|
2283 | if not self.shell.user_ns.has_key(args): | |
2284 | args = last_call[1] |
|
2284 | args = last_call[1] | |
2285 |
|
2285 | |||
2286 | # use last_call to remember the state of the previous call, but don't |
|
2286 | # use last_call to remember the state of the previous call, but don't | |
2287 | # let it be clobbered by successive '-p' calls. |
|
2287 | # let it be clobbered by successive '-p' calls. | |
2288 | try: |
|
2288 | try: | |
2289 | last_call[0] = self.shell.displayhook.prompt_count |
|
2289 | last_call[0] = self.shell.displayhook.prompt_count | |
2290 | if not opts_prev: |
|
2290 | if not opts_prev: | |
2291 | last_call[1] = parameter_s |
|
2291 | last_call[1] = parameter_s | |
2292 | except: |
|
2292 | except: | |
2293 | pass |
|
2293 | pass | |
2294 |
|
2294 | |||
2295 | # by default this is done with temp files, except when the given |
|
2295 | # by default this is done with temp files, except when the given | |
2296 | # arg is a filename |
|
2296 | # arg is a filename | |
2297 | use_temp = True |
|
2297 | use_temp = True | |
2298 |
|
2298 | |||
2299 | data = '' |
|
2299 | data = '' | |
2300 | if args.endswith('.py'): |
|
2300 | if args.endswith('.py'): | |
2301 | filename = make_filename(args) |
|
2301 | filename = make_filename(args) | |
2302 | use_temp = False |
|
2302 | use_temp = False | |
2303 | elif args: |
|
2303 | elif args: | |
2304 | # Mode where user specifies ranges of lines, like in %macro. |
|
2304 | # Mode where user specifies ranges of lines, like in %macro. | |
2305 | data = self.extract_input_lines(args, opts_raw) |
|
2305 | data = self.extract_input_lines(args, opts_raw) | |
2306 | if not data: |
|
2306 | if not data: | |
2307 | try: |
|
2307 | try: | |
2308 | # Load the parameter given as a variable. If not a string, |
|
2308 | # Load the parameter given as a variable. If not a string, | |
2309 | # process it as an object instead (below) |
|
2309 | # process it as an object instead (below) | |
2310 |
|
2310 | |||
2311 | #print '*** args',args,'type',type(args) # dbg |
|
2311 | #print '*** args',args,'type',type(args) # dbg | |
2312 | data = eval(args, self.shell.user_ns) |
|
2312 | data = eval(args, self.shell.user_ns) | |
2313 | if not isinstance(data, basestring): |
|
2313 | if not isinstance(data, basestring): | |
2314 | raise DataIsObject |
|
2314 | raise DataIsObject | |
2315 |
|
2315 | |||
2316 | except (NameError,SyntaxError): |
|
2316 | except (NameError,SyntaxError): | |
2317 | # given argument is not a variable, try as a filename |
|
2317 | # given argument is not a variable, try as a filename | |
2318 | filename = make_filename(args) |
|
2318 | filename = make_filename(args) | |
2319 | if filename is None: |
|
2319 | if filename is None: | |
2320 | warn("Argument given (%s) can't be found as a variable " |
|
2320 | warn("Argument given (%s) can't be found as a variable " | |
2321 | "or as a filename." % args) |
|
2321 | "or as a filename." % args) | |
2322 | return |
|
2322 | return | |
2323 | use_temp = False |
|
2323 | use_temp = False | |
2324 |
|
2324 | |||
2325 | except DataIsObject: |
|
2325 | except DataIsObject: | |
2326 | # macros have a special edit function |
|
2326 | # macros have a special edit function | |
2327 | if isinstance(data, Macro): |
|
2327 | if isinstance(data, Macro): | |
2328 | self._edit_macro(args,data) |
|
2328 | self._edit_macro(args,data) | |
2329 | return |
|
2329 | return | |
2330 |
|
2330 | |||
2331 | # For objects, try to edit the file where they are defined |
|
2331 | # For objects, try to edit the file where they are defined | |
2332 | try: |
|
2332 | try: | |
2333 | filename = inspect.getabsfile(data) |
|
2333 | filename = inspect.getabsfile(data) | |
2334 | if 'fakemodule' in filename.lower() and inspect.isclass(data): |
|
2334 | if 'fakemodule' in filename.lower() and inspect.isclass(data): | |
2335 | # class created by %edit? Try to find source |
|
2335 | # class created by %edit? Try to find source | |
2336 | # by looking for method definitions instead, the |
|
2336 | # by looking for method definitions instead, the | |
2337 | # __module__ in those classes is FakeModule. |
|
2337 | # __module__ in those classes is FakeModule. | |
2338 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
2338 | attrs = [getattr(data, aname) for aname in dir(data)] | |
2339 | for attr in attrs: |
|
2339 | for attr in attrs: | |
2340 | if not inspect.ismethod(attr): |
|
2340 | if not inspect.ismethod(attr): | |
2341 | continue |
|
2341 | continue | |
2342 | filename = inspect.getabsfile(attr) |
|
2342 | filename = inspect.getabsfile(attr) | |
2343 | if filename and 'fakemodule' not in filename.lower(): |
|
2343 | if filename and 'fakemodule' not in filename.lower(): | |
2344 | # change the attribute to be the edit target instead |
|
2344 | # change the attribute to be the edit target instead | |
2345 | data = attr |
|
2345 | data = attr | |
2346 | break |
|
2346 | break | |
2347 |
|
2347 | |||
2348 | datafile = 1 |
|
2348 | datafile = 1 | |
2349 | except TypeError: |
|
2349 | except TypeError: | |
2350 | filename = make_filename(args) |
|
2350 | filename = make_filename(args) | |
2351 | datafile = 1 |
|
2351 | datafile = 1 | |
2352 | warn('Could not find file where `%s` is defined.\n' |
|
2352 | warn('Could not find file where `%s` is defined.\n' | |
2353 | 'Opening a file named `%s`' % (args,filename)) |
|
2353 | 'Opening a file named `%s`' % (args,filename)) | |
2354 | # Now, make sure we can actually read the source (if it was in |
|
2354 | # Now, make sure we can actually read the source (if it was in | |
2355 | # a temp file it's gone by now). |
|
2355 | # a temp file it's gone by now). | |
2356 | if datafile: |
|
2356 | if datafile: | |
2357 | try: |
|
2357 | try: | |
2358 | if lineno is None: |
|
2358 | if lineno is None: | |
2359 | lineno = inspect.getsourcelines(data)[1] |
|
2359 | lineno = inspect.getsourcelines(data)[1] | |
2360 | except IOError: |
|
2360 | except IOError: | |
2361 | filename = make_filename(args) |
|
2361 | filename = make_filename(args) | |
2362 | if filename is None: |
|
2362 | if filename is None: | |
2363 | warn('The file `%s` where `%s` was defined cannot ' |
|
2363 | warn('The file `%s` where `%s` was defined cannot ' | |
2364 | 'be read.' % (filename,data)) |
|
2364 | 'be read.' % (filename,data)) | |
2365 | return |
|
2365 | return | |
2366 | use_temp = False |
|
2366 | use_temp = False | |
2367 |
|
2367 | |||
2368 | if use_temp: |
|
2368 | if use_temp: | |
2369 | filename = self.shell.mktempfile(data) |
|
2369 | filename = self.shell.mktempfile(data) | |
2370 | print 'IPython will make a temporary file named:',filename |
|
2370 | print 'IPython will make a temporary file named:',filename | |
2371 |
|
2371 | |||
2372 | # do actual editing here |
|
2372 | # do actual editing here | |
2373 | print 'Editing...', |
|
2373 | print 'Editing...', | |
2374 | sys.stdout.flush() |
|
2374 | sys.stdout.flush() | |
2375 | try: |
|
2375 | try: | |
2376 | # Quote filenames that may have spaces in them |
|
2376 | # Quote filenames that may have spaces in them | |
2377 | if ' ' in filename: |
|
2377 | if ' ' in filename: | |
2378 | filename = "%s" % filename |
|
2378 | filename = "%s" % filename | |
2379 | self.shell.hooks.editor(filename,lineno) |
|
2379 | self.shell.hooks.editor(filename,lineno) | |
2380 | except TryNext: |
|
2380 | except TryNext: | |
2381 | warn('Could not open editor') |
|
2381 | warn('Could not open editor') | |
2382 | return |
|
2382 | return | |
2383 |
|
2383 | |||
2384 | # XXX TODO: should this be generalized for all string vars? |
|
2384 | # XXX TODO: should this be generalized for all string vars? | |
2385 | # For now, this is special-cased to blocks created by cpaste |
|
2385 | # For now, this is special-cased to blocks created by cpaste | |
2386 | if args.strip() == 'pasted_block': |
|
2386 | if args.strip() == 'pasted_block': | |
2387 | self.shell.user_ns['pasted_block'] = file_read(filename) |
|
2387 | self.shell.user_ns['pasted_block'] = file_read(filename) | |
2388 |
|
2388 | |||
2389 | if 'x' in opts: # -x prevents actual execution |
|
2389 | if 'x' in opts: # -x prevents actual execution | |
2390 |
|
2390 | |||
2391 | else: |
|
2391 | else: | |
2392 | print 'done. Executing edited code...' |
|
2392 | print 'done. Executing edited code...' | |
2393 | if opts_raw: |
|
2393 | if opts_raw: | |
2394 | self.shell.run_cell(file_read(filename), |
|
2394 | self.shell.run_cell(file_read(filename), | |
2395 | store_history=False) |
|
2395 | store_history=False) | |
2396 | else: |
|
2396 | else: | |
2397 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2397 | self.shell.safe_execfile(filename,self.shell.user_ns, | |
2398 | self.shell.user_ns) |
|
2398 | self.shell.user_ns) | |
2399 |
|
2399 | |||
2400 |
|
2400 | |||
2401 | if use_temp: |
|
2401 | if use_temp: | |
2402 | try: |
|
2402 | try: | |
2403 | return open(filename).read() |
|
2403 | return open(filename).read() | |
2404 | except IOError,msg: |
|
2404 | except IOError,msg: | |
2405 | if msg.filename == filename: |
|
2405 | if msg.filename == filename: | |
2406 | warn('File not found. Did you forget to save?') |
|
2406 | warn('File not found. Did you forget to save?') | |
2407 | return |
|
2407 | return | |
2408 | else: |
|
2408 | else: | |
2409 | self.shell.showtraceback() |
|
2409 | self.shell.showtraceback() | |
2410 |
|
2410 | |||
2411 | def magic_xmode(self,parameter_s = ''): |
|
2411 | def magic_xmode(self,parameter_s = ''): | |
2412 | """Switch modes for the exception handlers. |
|
2412 | """Switch modes for the exception handlers. | |
2413 |
|
2413 | |||
2414 | Valid modes: Plain, Context and Verbose. |
|
2414 | Valid modes: Plain, Context and Verbose. | |
2415 |
|
2415 | |||
2416 | If called without arguments, acts as a toggle.""" |
|
2416 | If called without arguments, acts as a toggle.""" | |
2417 |
|
2417 | |||
2418 | def xmode_switch_err(name): |
|
2418 | def xmode_switch_err(name): | |
2419 | warn('Error changing %s exception modes.\n%s' % |
|
2419 | warn('Error changing %s exception modes.\n%s' % | |
2420 | (name,sys.exc_info()[1])) |
|
2420 | (name,sys.exc_info()[1])) | |
2421 |
|
2421 | |||
2422 | shell = self.shell |
|
2422 | shell = self.shell | |
2423 | new_mode = parameter_s.strip().capitalize() |
|
2423 | new_mode = parameter_s.strip().capitalize() | |
2424 | try: |
|
2424 | try: | |
2425 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2425 | shell.InteractiveTB.set_mode(mode=new_mode) | |
2426 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2426 | print 'Exception reporting mode:',shell.InteractiveTB.mode | |
2427 | except: |
|
2427 | except: | |
2428 | xmode_switch_err('user') |
|
2428 | xmode_switch_err('user') | |
2429 |
|
2429 | |||
2430 | def magic_colors(self,parameter_s = ''): |
|
2430 | def magic_colors(self,parameter_s = ''): | |
2431 | """Switch color scheme for prompts, info system and exception handlers. |
|
2431 | """Switch color scheme for prompts, info system and exception handlers. | |
2432 |
|
2432 | |||
2433 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2433 | Currently implemented schemes: NoColor, Linux, LightBG. | |
2434 |
|
2434 | |||
2435 | Color scheme names are not case-sensitive. |
|
2435 | Color scheme names are not case-sensitive. | |
2436 |
|
2436 | |||
2437 | Examples |
|
2437 | Examples | |
2438 | -------- |
|
2438 | -------- | |
2439 | To get a plain black and white terminal:: |
|
2439 | To get a plain black and white terminal:: | |
2440 |
|
2440 | |||
2441 | %colors nocolor |
|
2441 | %colors nocolor | |
2442 | """ |
|
2442 | """ | |
2443 |
|
2443 | |||
2444 | def color_switch_err(name): |
|
2444 | def color_switch_err(name): | |
2445 | warn('Error changing %s color schemes.\n%s' % |
|
2445 | warn('Error changing %s color schemes.\n%s' % | |
2446 | (name,sys.exc_info()[1])) |
|
2446 | (name,sys.exc_info()[1])) | |
2447 |
|
2447 | |||
2448 |
|
2448 | |||
2449 | new_scheme = parameter_s.strip() |
|
2449 | new_scheme = parameter_s.strip() | |
2450 | if not new_scheme: |
|
2450 | if not new_scheme: | |
2451 | raise UsageError( |
|
2451 | raise UsageError( | |
2452 | "%colors: you must specify a color scheme. See '%colors?'") |
|
2452 | "%colors: you must specify a color scheme. See '%colors?'") | |
2453 | return |
|
2453 | return | |
2454 | # local shortcut |
|
2454 | # local shortcut | |
2455 | shell = self.shell |
|
2455 | shell = self.shell | |
2456 |
|
2456 | |||
2457 | import IPython.utils.rlineimpl as readline |
|
2457 | import IPython.utils.rlineimpl as readline | |
2458 |
|
2458 | |||
2459 | if not readline.have_readline and sys.platform == "win32": |
|
2459 | if not readline.have_readline and sys.platform == "win32": | |
2460 | msg = """\ |
|
2460 | msg = """\ | |
2461 | Proper color support under MS Windows requires the pyreadline library. |
|
2461 | Proper color support under MS Windows requires the pyreadline library. | |
2462 | You can find it at: |
|
2462 | You can find it at: | |
2463 | http://ipython.scipy.org/moin/PyReadline/Intro |
|
2463 | http://ipython.scipy.org/moin/PyReadline/Intro | |
2464 | Gary's readline needs the ctypes module, from: |
|
2464 | Gary's readline needs the ctypes module, from: | |
2465 | http://starship.python.net/crew/theller/ctypes |
|
2465 | http://starship.python.net/crew/theller/ctypes | |
2466 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2466 | (Note that ctypes is already part of Python versions 2.5 and newer). | |
2467 |
|
2467 | |||
2468 | Defaulting color scheme to 'NoColor'""" |
|
2468 | Defaulting color scheme to 'NoColor'""" | |
2469 | new_scheme = 'NoColor' |
|
2469 | new_scheme = 'NoColor' | |
2470 | warn(msg) |
|
2470 | warn(msg) | |
2471 |
|
2471 | |||
2472 | # readline option is 0 |
|
2472 | # readline option is 0 | |
2473 | if not shell.has_readline: |
|
2473 | if not shell.has_readline: | |
2474 | new_scheme = 'NoColor' |
|
2474 | new_scheme = 'NoColor' | |
2475 |
|
2475 | |||
2476 | # Set prompt colors |
|
2476 | # Set prompt colors | |
2477 | try: |
|
2477 | try: | |
2478 | shell.displayhook.set_colors(new_scheme) |
|
2478 | shell.displayhook.set_colors(new_scheme) | |
2479 | except: |
|
2479 | except: | |
2480 | color_switch_err('prompt') |
|
2480 | color_switch_err('prompt') | |
2481 | else: |
|
2481 | else: | |
2482 | shell.colors = \ |
|
2482 | shell.colors = \ | |
2483 | shell.displayhook.color_table.active_scheme_name |
|
2483 | shell.displayhook.color_table.active_scheme_name | |
2484 | # Set exception colors |
|
2484 | # Set exception colors | |
2485 | try: |
|
2485 | try: | |
2486 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2486 | shell.InteractiveTB.set_colors(scheme = new_scheme) | |
2487 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2487 | shell.SyntaxTB.set_colors(scheme = new_scheme) | |
2488 | except: |
|
2488 | except: | |
2489 | color_switch_err('exception') |
|
2489 | color_switch_err('exception') | |
2490 |
|
2490 | |||
2491 | # Set info (for 'object?') colors |
|
2491 | # Set info (for 'object?') colors | |
2492 | if shell.color_info: |
|
2492 | if shell.color_info: | |
2493 | try: |
|
2493 | try: | |
2494 | shell.inspector.set_active_scheme(new_scheme) |
|
2494 | shell.inspector.set_active_scheme(new_scheme) | |
2495 | except: |
|
2495 | except: | |
2496 | color_switch_err('object inspector') |
|
2496 | color_switch_err('object inspector') | |
2497 | else: |
|
2497 | else: | |
2498 | shell.inspector.set_active_scheme('NoColor') |
|
2498 | shell.inspector.set_active_scheme('NoColor') | |
2499 |
|
2499 | |||
2500 | def magic_pprint(self, parameter_s=''): |
|
2500 | def magic_pprint(self, parameter_s=''): | |
2501 | """Toggle pretty printing on/off.""" |
|
2501 | """Toggle pretty printing on/off.""" | |
2502 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
2502 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
2503 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
2503 | ptformatter.pprint = bool(1 - ptformatter.pprint) | |
2504 | print 'Pretty printing has been turned', \ |
|
2504 | print 'Pretty printing has been turned', \ | |
2505 | ['OFF','ON'][ptformatter.pprint] |
|
2505 | ['OFF','ON'][ptformatter.pprint] | |
2506 |
|
2506 | |||
2507 | def magic_Exit(self, parameter_s=''): |
|
2507 | def magic_Exit(self, parameter_s=''): | |
2508 | """Exit IPython.""" |
|
2508 | """Exit IPython.""" | |
2509 |
|
2509 | |||
2510 | self.shell.ask_exit() |
|
2510 | self.shell.ask_exit() | |
2511 |
|
2511 | |||
2512 | # Add aliases as magics so all common forms work: exit, quit, Exit, Quit. |
|
2512 | # Add aliases as magics so all common forms work: exit, quit, Exit, Quit. | |
2513 | magic_exit = magic_quit = magic_Quit = magic_Exit |
|
2513 | magic_exit = magic_quit = magic_Quit = magic_Exit | |
2514 |
|
2514 | |||
2515 | #...................................................................... |
|
2515 | #...................................................................... | |
2516 | # Functions to implement unix shell-type things |
|
2516 | # Functions to implement unix shell-type things | |
2517 |
|
2517 | |||
2518 | @testdec.skip_doctest |
|
2518 | @testdec.skip_doctest | |
2519 | def magic_alias(self, parameter_s = ''): |
|
2519 | def magic_alias(self, parameter_s = ''): | |
2520 | """Define an alias for a system command. |
|
2520 | """Define an alias for a system command. | |
2521 |
|
2521 | |||
2522 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2522 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' | |
2523 |
|
2523 | |||
2524 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2524 | Then, typing 'alias_name params' will execute the system command 'cmd | |
2525 | params' (from your underlying operating system). |
|
2525 | params' (from your underlying operating system). | |
2526 |
|
2526 | |||
2527 | Aliases have lower precedence than magic functions and Python normal |
|
2527 | Aliases have lower precedence than magic functions and Python normal | |
2528 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2528 | variables, so if 'foo' is both a Python variable and an alias, the | |
2529 | alias can not be executed until 'del foo' removes the Python variable. |
|
2529 | alias can not be executed until 'del foo' removes the Python variable. | |
2530 |
|
2530 | |||
2531 | You can use the %l specifier in an alias definition to represent the |
|
2531 | You can use the %l specifier in an alias definition to represent the | |
2532 | whole line when the alias is called. For example: |
|
2532 | whole line when the alias is called. For example: | |
2533 |
|
2533 | |||
2534 | In [2]: alias bracket echo "Input in brackets: <%l>" |
|
2534 | In [2]: alias bracket echo "Input in brackets: <%l>" | |
2535 | In [3]: bracket hello world |
|
2535 | In [3]: bracket hello world | |
2536 | Input in brackets: <hello world> |
|
2536 | Input in brackets: <hello world> | |
2537 |
|
2537 | |||
2538 | You can also define aliases with parameters using %s specifiers (one |
|
2538 | You can also define aliases with parameters using %s specifiers (one | |
2539 | per parameter): |
|
2539 | per parameter): | |
2540 |
|
2540 | |||
2541 | In [1]: alias parts echo first %s second %s |
|
2541 | In [1]: alias parts echo first %s second %s | |
2542 | In [2]: %parts A B |
|
2542 | In [2]: %parts A B | |
2543 | first A second B |
|
2543 | first A second B | |
2544 | In [3]: %parts A |
|
2544 | In [3]: %parts A | |
2545 | Incorrect number of arguments: 2 expected. |
|
2545 | Incorrect number of arguments: 2 expected. | |
2546 | parts is an alias to: 'echo first %s second %s' |
|
2546 | parts is an alias to: 'echo first %s second %s' | |
2547 |
|
2547 | |||
2548 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2548 | Note that %l and %s are mutually exclusive. You can only use one or | |
2549 | the other in your aliases. |
|
2549 | the other in your aliases. | |
2550 |
|
2550 | |||
2551 | Aliases expand Python variables just like system calls using ! or !! |
|
2551 | Aliases expand Python variables just like system calls using ! or !! | |
2552 | do: all expressions prefixed with '$' get expanded. For details of |
|
2552 | do: all expressions prefixed with '$' get expanded. For details of | |
2553 | the semantic rules, see PEP-215: |
|
2553 | the semantic rules, see PEP-215: | |
2554 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2554 | http://www.python.org/peps/pep-0215.html. This is the library used by | |
2555 | IPython for variable expansion. If you want to access a true shell |
|
2555 | IPython for variable expansion. If you want to access a true shell | |
2556 | variable, an extra $ is necessary to prevent its expansion by IPython: |
|
2556 | variable, an extra $ is necessary to prevent its expansion by IPython: | |
2557 |
|
2557 | |||
2558 | In [6]: alias show echo |
|
2558 | In [6]: alias show echo | |
2559 | In [7]: PATH='A Python string' |
|
2559 | In [7]: PATH='A Python string' | |
2560 | In [8]: show $PATH |
|
2560 | In [8]: show $PATH | |
2561 | A Python string |
|
2561 | A Python string | |
2562 | In [9]: show $$PATH |
|
2562 | In [9]: show $$PATH | |
2563 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2563 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... | |
2564 |
|
2564 | |||
2565 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2565 | You can use the alias facility to acess all of $PATH. See the %rehash | |
2566 | and %rehashx functions, which automatically create aliases for the |
|
2566 | and %rehashx functions, which automatically create aliases for the | |
2567 | contents of your $PATH. |
|
2567 | contents of your $PATH. | |
2568 |
|
2568 | |||
2569 | If called with no parameters, %alias prints the current alias table.""" |
|
2569 | If called with no parameters, %alias prints the current alias table.""" | |
2570 |
|
2570 | |||
2571 | par = parameter_s.strip() |
|
2571 | par = parameter_s.strip() | |
2572 | if not par: |
|
2572 | if not par: | |
2573 | stored = self.db.get('stored_aliases', {} ) |
|
2573 | stored = self.db.get('stored_aliases', {} ) | |
2574 | aliases = sorted(self.shell.alias_manager.aliases) |
|
2574 | aliases = sorted(self.shell.alias_manager.aliases) | |
2575 | # for k, v in stored: |
|
2575 | # for k, v in stored: | |
2576 | # atab.append(k, v[0]) |
|
2576 | # atab.append(k, v[0]) | |
2577 |
|
2577 | |||
2578 | print "Total number of aliases:", len(aliases) |
|
2578 | print "Total number of aliases:", len(aliases) | |
2579 | sys.stdout.flush() |
|
2579 | sys.stdout.flush() | |
2580 | return aliases |
|
2580 | return aliases | |
2581 |
|
2581 | |||
2582 | # Now try to define a new one |
|
2582 | # Now try to define a new one | |
2583 | try: |
|
2583 | try: | |
2584 | alias,cmd = par.split(None, 1) |
|
2584 | alias,cmd = par.split(None, 1) | |
2585 | except: |
|
2585 | except: | |
2586 | print oinspect.getdoc(self.magic_alias) |
|
2586 | print oinspect.getdoc(self.magic_alias) | |
2587 | else: |
|
2587 | else: | |
2588 | self.shell.alias_manager.soft_define_alias(alias, cmd) |
|
2588 | self.shell.alias_manager.soft_define_alias(alias, cmd) | |
2589 | # end magic_alias |
|
2589 | # end magic_alias | |
2590 |
|
2590 | |||
2591 | def magic_unalias(self, parameter_s = ''): |
|
2591 | def magic_unalias(self, parameter_s = ''): | |
2592 | """Remove an alias""" |
|
2592 | """Remove an alias""" | |
2593 |
|
2593 | |||
2594 | aname = parameter_s.strip() |
|
2594 | aname = parameter_s.strip() | |
2595 | self.shell.alias_manager.undefine_alias(aname) |
|
2595 | self.shell.alias_manager.undefine_alias(aname) | |
2596 | stored = self.db.get('stored_aliases', {} ) |
|
2596 | stored = self.db.get('stored_aliases', {} ) | |
2597 | if aname in stored: |
|
2597 | if aname in stored: | |
2598 | print "Removing %stored alias",aname |
|
2598 | print "Removing %stored alias",aname | |
2599 | del stored[aname] |
|
2599 | del stored[aname] | |
2600 | self.db['stored_aliases'] = stored |
|
2600 | self.db['stored_aliases'] = stored | |
2601 |
|
2601 | |||
2602 | def magic_rehashx(self, parameter_s = ''): |
|
2602 | def magic_rehashx(self, parameter_s = ''): | |
2603 | """Update the alias table with all executable files in $PATH. |
|
2603 | """Update the alias table with all executable files in $PATH. | |
2604 |
|
2604 | |||
2605 | This version explicitly checks that every entry in $PATH is a file |
|
2605 | This version explicitly checks that every entry in $PATH is a file | |
2606 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2606 | with execute access (os.X_OK), so it is much slower than %rehash. | |
2607 |
|
2607 | |||
2608 | Under Windows, it checks executability as a match agains a |
|
2608 | Under Windows, it checks executability as a match agains a | |
2609 | '|'-separated string of extensions, stored in the IPython config |
|
2609 | '|'-separated string of extensions, stored in the IPython config | |
2610 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2610 | variable win_exec_ext. This defaults to 'exe|com|bat'. | |
2611 |
|
2611 | |||
2612 | This function also resets the root module cache of module completer, |
|
2612 | This function also resets the root module cache of module completer, | |
2613 | used on slow filesystems. |
|
2613 | used on slow filesystems. | |
2614 | """ |
|
2614 | """ | |
2615 | from IPython.core.alias import InvalidAliasError |
|
2615 | from IPython.core.alias import InvalidAliasError | |
2616 |
|
2616 | |||
2617 | # for the benefit of module completer in ipy_completers.py |
|
2617 | # for the benefit of module completer in ipy_completers.py | |
2618 | del self.db['rootmodules'] |
|
2618 | del self.db['rootmodules'] | |
2619 |
|
2619 | |||
2620 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2620 | path = [os.path.abspath(os.path.expanduser(p)) for p in | |
2621 | os.environ.get('PATH','').split(os.pathsep)] |
|
2621 | os.environ.get('PATH','').split(os.pathsep)] | |
2622 | path = filter(os.path.isdir,path) |
|
2622 | path = filter(os.path.isdir,path) | |
2623 |
|
2623 | |||
2624 | syscmdlist = [] |
|
2624 | syscmdlist = [] | |
2625 | # Now define isexec in a cross platform manner. |
|
2625 | # Now define isexec in a cross platform manner. | |
2626 | if os.name == 'posix': |
|
2626 | if os.name == 'posix': | |
2627 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2627 | isexec = lambda fname:os.path.isfile(fname) and \ | |
2628 | os.access(fname,os.X_OK) |
|
2628 | os.access(fname,os.X_OK) | |
2629 | else: |
|
2629 | else: | |
2630 | try: |
|
2630 | try: | |
2631 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2631 | winext = os.environ['pathext'].replace(';','|').replace('.','') | |
2632 | except KeyError: |
|
2632 | except KeyError: | |
2633 | winext = 'exe|com|bat|py' |
|
2633 | winext = 'exe|com|bat|py' | |
2634 | if 'py' not in winext: |
|
2634 | if 'py' not in winext: | |
2635 | winext += '|py' |
|
2635 | winext += '|py' | |
2636 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2636 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) | |
2637 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2637 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) | |
2638 | savedir = os.getcwd() |
|
2638 | savedir = os.getcwd() | |
2639 |
|
2639 | |||
2640 | # Now walk the paths looking for executables to alias. |
|
2640 | # Now walk the paths looking for executables to alias. | |
2641 | try: |
|
2641 | try: | |
2642 | # write the whole loop for posix/Windows so we don't have an if in |
|
2642 | # write the whole loop for posix/Windows so we don't have an if in | |
2643 | # the innermost part |
|
2643 | # the innermost part | |
2644 | if os.name == 'posix': |
|
2644 | if os.name == 'posix': | |
2645 | for pdir in path: |
|
2645 | for pdir in path: | |
2646 | os.chdir(pdir) |
|
2646 | os.chdir(pdir) | |
2647 | for ff in os.listdir(pdir): |
|
2647 | for ff in os.listdir(pdir): | |
2648 | if isexec(ff): |
|
2648 | if isexec(ff): | |
2649 | try: |
|
2649 | try: | |
2650 | # Removes dots from the name since ipython |
|
2650 | # Removes dots from the name since ipython | |
2651 | # will assume names with dots to be python. |
|
2651 | # will assume names with dots to be python. | |
2652 | self.shell.alias_manager.define_alias( |
|
2652 | self.shell.alias_manager.define_alias( | |
2653 | ff.replace('.',''), ff) |
|
2653 | ff.replace('.',''), ff) | |
2654 | except InvalidAliasError: |
|
2654 | except InvalidAliasError: | |
2655 | pass |
|
2655 | pass | |
2656 | else: |
|
2656 | else: | |
2657 | syscmdlist.append(ff) |
|
2657 | syscmdlist.append(ff) | |
2658 | else: |
|
2658 | else: | |
2659 | no_alias = self.shell.alias_manager.no_alias |
|
2659 | no_alias = self.shell.alias_manager.no_alias | |
2660 | for pdir in path: |
|
2660 | for pdir in path: | |
2661 | os.chdir(pdir) |
|
2661 | os.chdir(pdir) | |
2662 | for ff in os.listdir(pdir): |
|
2662 | for ff in os.listdir(pdir): | |
2663 | base, ext = os.path.splitext(ff) |
|
2663 | base, ext = os.path.splitext(ff) | |
2664 | if isexec(ff) and base.lower() not in no_alias: |
|
2664 | if isexec(ff) and base.lower() not in no_alias: | |
2665 | if ext.lower() == '.exe': |
|
2665 | if ext.lower() == '.exe': | |
2666 | ff = base |
|
2666 | ff = base | |
2667 | try: |
|
2667 | try: | |
2668 | # Removes dots from the name since ipython |
|
2668 | # Removes dots from the name since ipython | |
2669 | # will assume names with dots to be python. |
|
2669 | # will assume names with dots to be python. | |
2670 | self.shell.alias_manager.define_alias( |
|
2670 | self.shell.alias_manager.define_alias( | |
2671 | base.lower().replace('.',''), ff) |
|
2671 | base.lower().replace('.',''), ff) | |
2672 | except InvalidAliasError: |
|
2672 | except InvalidAliasError: | |
2673 | pass |
|
2673 | pass | |
2674 | syscmdlist.append(ff) |
|
2674 | syscmdlist.append(ff) | |
2675 | db = self.db |
|
2675 | db = self.db | |
2676 | db['syscmdlist'] = syscmdlist |
|
2676 | db['syscmdlist'] = syscmdlist | |
2677 | finally: |
|
2677 | finally: | |
2678 | os.chdir(savedir) |
|
2678 | os.chdir(savedir) | |
2679 |
|
2679 | |||
2680 | @testdec.skip_doctest |
|
2680 | @testdec.skip_doctest | |
2681 | def magic_pwd(self, parameter_s = ''): |
|
2681 | def magic_pwd(self, parameter_s = ''): | |
2682 | """Return the current working directory path. |
|
2682 | """Return the current working directory path. | |
2683 |
|
2683 | |||
2684 | Examples |
|
2684 | Examples | |
2685 | -------- |
|
2685 | -------- | |
2686 | :: |
|
2686 | :: | |
2687 |
|
2687 | |||
2688 | In [9]: pwd |
|
2688 | In [9]: pwd | |
2689 | Out[9]: '/home/tsuser/sprint/ipython' |
|
2689 | Out[9]: '/home/tsuser/sprint/ipython' | |
2690 | """ |
|
2690 | """ | |
2691 | return os.getcwd() |
|
2691 | return os.getcwd() | |
2692 |
|
2692 | |||
2693 | @testdec.skip_doctest |
|
2693 | @testdec.skip_doctest | |
2694 | def magic_cd(self, parameter_s=''): |
|
2694 | def magic_cd(self, parameter_s=''): | |
2695 | """Change the current working directory. |
|
2695 | """Change the current working directory. | |
2696 |
|
2696 | |||
2697 | This command automatically maintains an internal list of directories |
|
2697 | This command automatically maintains an internal list of directories | |
2698 | you visit during your IPython session, in the variable _dh. The |
|
2698 | you visit during your IPython session, in the variable _dh. The | |
2699 | command %dhist shows this history nicely formatted. You can also |
|
2699 | command %dhist shows this history nicely formatted. You can also | |
2700 | do 'cd -<tab>' to see directory history conveniently. |
|
2700 | do 'cd -<tab>' to see directory history conveniently. | |
2701 |
|
2701 | |||
2702 | Usage: |
|
2702 | Usage: | |
2703 |
|
2703 | |||
2704 | cd 'dir': changes to directory 'dir'. |
|
2704 | cd 'dir': changes to directory 'dir'. | |
2705 |
|
2705 | |||
2706 | cd -: changes to the last visited directory. |
|
2706 | cd -: changes to the last visited directory. | |
2707 |
|
2707 | |||
2708 | cd -<n>: changes to the n-th directory in the directory history. |
|
2708 | cd -<n>: changes to the n-th directory in the directory history. | |
2709 |
|
2709 | |||
2710 | cd --foo: change to directory that matches 'foo' in history |
|
2710 | cd --foo: change to directory that matches 'foo' in history | |
2711 |
|
2711 | |||
2712 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2712 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark | |
2713 | (note: cd <bookmark_name> is enough if there is no |
|
2713 | (note: cd <bookmark_name> is enough if there is no | |
2714 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2714 | directory <bookmark_name>, but a bookmark with the name exists.) | |
2715 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2715 | 'cd -b <tab>' allows you to tab-complete bookmark names. | |
2716 |
|
2716 | |||
2717 | Options: |
|
2717 | Options: | |
2718 |
|
2718 | |||
2719 | -q: quiet. Do not print the working directory after the cd command is |
|
2719 | -q: quiet. Do not print the working directory after the cd command is | |
2720 | executed. By default IPython's cd command does print this directory, |
|
2720 | executed. By default IPython's cd command does print this directory, | |
2721 | since the default prompts do not display path information. |
|
2721 | since the default prompts do not display path information. | |
2722 |
|
2722 | |||
2723 | Note that !cd doesn't work for this purpose because the shell where |
|
2723 | Note that !cd doesn't work for this purpose because the shell where | |
2724 | !command runs is immediately discarded after executing 'command'. |
|
2724 | !command runs is immediately discarded after executing 'command'. | |
2725 |
|
2725 | |||
2726 | Examples |
|
2726 | Examples | |
2727 | -------- |
|
2727 | -------- | |
2728 | :: |
|
2728 | :: | |
2729 |
|
2729 | |||
2730 | In [10]: cd parent/child |
|
2730 | In [10]: cd parent/child | |
2731 | /home/tsuser/parent/child |
|
2731 | /home/tsuser/parent/child | |
2732 | """ |
|
2732 | """ | |
2733 |
|
2733 | |||
2734 | parameter_s = parameter_s.strip() |
|
2734 | parameter_s = parameter_s.strip() | |
2735 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2735 | #bkms = self.shell.persist.get("bookmarks",{}) | |
2736 |
|
2736 | |||
2737 | oldcwd = os.getcwd() |
|
2737 | oldcwd = os.getcwd() | |
2738 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2738 | numcd = re.match(r'(-)(\d+)$',parameter_s) | |
2739 | # jump in directory history by number |
|
2739 | # jump in directory history by number | |
2740 | if numcd: |
|
2740 | if numcd: | |
2741 | nn = int(numcd.group(2)) |
|
2741 | nn = int(numcd.group(2)) | |
2742 | try: |
|
2742 | try: | |
2743 | ps = self.shell.user_ns['_dh'][nn] |
|
2743 | ps = self.shell.user_ns['_dh'][nn] | |
2744 | except IndexError: |
|
2744 | except IndexError: | |
2745 | print 'The requested directory does not exist in history.' |
|
2745 | print 'The requested directory does not exist in history.' | |
2746 | return |
|
2746 | return | |
2747 | else: |
|
2747 | else: | |
2748 | opts = {} |
|
2748 | opts = {} | |
2749 | elif parameter_s.startswith('--'): |
|
2749 | elif parameter_s.startswith('--'): | |
2750 | ps = None |
|
2750 | ps = None | |
2751 | fallback = None |
|
2751 | fallback = None | |
2752 | pat = parameter_s[2:] |
|
2752 | pat = parameter_s[2:] | |
2753 | dh = self.shell.user_ns['_dh'] |
|
2753 | dh = self.shell.user_ns['_dh'] | |
2754 | # first search only by basename (last component) |
|
2754 | # first search only by basename (last component) | |
2755 | for ent in reversed(dh): |
|
2755 | for ent in reversed(dh): | |
2756 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
2756 | if pat in os.path.basename(ent) and os.path.isdir(ent): | |
2757 | ps = ent |
|
2757 | ps = ent | |
2758 | break |
|
2758 | break | |
2759 |
|
2759 | |||
2760 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
2760 | if fallback is None and pat in ent and os.path.isdir(ent): | |
2761 | fallback = ent |
|
2761 | fallback = ent | |
2762 |
|
2762 | |||
2763 | # if we have no last part match, pick the first full path match |
|
2763 | # if we have no last part match, pick the first full path match | |
2764 | if ps is None: |
|
2764 | if ps is None: | |
2765 | ps = fallback |
|
2765 | ps = fallback | |
2766 |
|
2766 | |||
2767 | if ps is None: |
|
2767 | if ps is None: | |
2768 | print "No matching entry in directory history" |
|
2768 | print "No matching entry in directory history" | |
2769 | return |
|
2769 | return | |
2770 | else: |
|
2770 | else: | |
2771 | opts = {} |
|
2771 | opts = {} | |
2772 |
|
2772 | |||
2773 |
|
2773 | |||
2774 | else: |
|
2774 | else: | |
2775 | #turn all non-space-escaping backslashes to slashes, |
|
2775 | #turn all non-space-escaping backslashes to slashes, | |
2776 | # for c:\windows\directory\names\ |
|
2776 | # for c:\windows\directory\names\ | |
2777 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2777 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) | |
2778 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2778 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') | |
2779 | # jump to previous |
|
2779 | # jump to previous | |
2780 | if ps == '-': |
|
2780 | if ps == '-': | |
2781 | try: |
|
2781 | try: | |
2782 | ps = self.shell.user_ns['_dh'][-2] |
|
2782 | ps = self.shell.user_ns['_dh'][-2] | |
2783 | except IndexError: |
|
2783 | except IndexError: | |
2784 | raise UsageError('%cd -: No previous directory to change to.') |
|
2784 | raise UsageError('%cd -: No previous directory to change to.') | |
2785 | # jump to bookmark if needed |
|
2785 | # jump to bookmark if needed | |
2786 | else: |
|
2786 | else: | |
2787 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2787 | if not os.path.isdir(ps) or opts.has_key('b'): | |
2788 | bkms = self.db.get('bookmarks', {}) |
|
2788 | bkms = self.db.get('bookmarks', {}) | |
2789 |
|
2789 | |||
2790 | if bkms.has_key(ps): |
|
2790 | if bkms.has_key(ps): | |
2791 | target = bkms[ps] |
|
2791 | target = bkms[ps] | |
2792 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2792 | print '(bookmark:%s) -> %s' % (ps,target) | |
2793 | ps = target |
|
2793 | ps = target | |
2794 | else: |
|
2794 | else: | |
2795 | if opts.has_key('b'): |
|
2795 | if opts.has_key('b'): | |
2796 | raise UsageError("Bookmark '%s' not found. " |
|
2796 | raise UsageError("Bookmark '%s' not found. " | |
2797 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2797 | "Use '%%bookmark -l' to see your bookmarks." % ps) | |
2798 |
|
2798 | |||
2799 | # at this point ps should point to the target dir |
|
2799 | # at this point ps should point to the target dir | |
2800 | if ps: |
|
2800 | if ps: | |
2801 | try: |
|
2801 | try: | |
2802 | os.chdir(os.path.expanduser(ps)) |
|
2802 | os.chdir(os.path.expanduser(ps)) | |
2803 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2803 | if hasattr(self.shell, 'term_title') and self.shell.term_title: | |
2804 | set_term_title('IPython: ' + abbrev_cwd()) |
|
2804 | set_term_title('IPython: ' + abbrev_cwd()) | |
2805 | except OSError: |
|
2805 | except OSError: | |
2806 | print sys.exc_info()[1] |
|
2806 | print sys.exc_info()[1] | |
2807 | else: |
|
2807 | else: | |
2808 | cwd = os.getcwd() |
|
2808 | cwd = os.getcwd() | |
2809 | dhist = self.shell.user_ns['_dh'] |
|
2809 | dhist = self.shell.user_ns['_dh'] | |
2810 | if oldcwd != cwd: |
|
2810 | if oldcwd != cwd: | |
2811 | dhist.append(cwd) |
|
2811 | dhist.append(cwd) | |
2812 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2812 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2813 |
|
2813 | |||
2814 | else: |
|
2814 | else: | |
2815 | os.chdir(self.shell.home_dir) |
|
2815 | os.chdir(self.shell.home_dir) | |
2816 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2816 | if hasattr(self.shell, 'term_title') and self.shell.term_title: | |
2817 | set_term_title('IPython: ' + '~') |
|
2817 | set_term_title('IPython: ' + '~') | |
2818 | cwd = os.getcwd() |
|
2818 | cwd = os.getcwd() | |
2819 | dhist = self.shell.user_ns['_dh'] |
|
2819 | dhist = self.shell.user_ns['_dh'] | |
2820 |
|
2820 | |||
2821 | if oldcwd != cwd: |
|
2821 | if oldcwd != cwd: | |
2822 | dhist.append(cwd) |
|
2822 | dhist.append(cwd) | |
2823 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2823 | self.db['dhist'] = compress_dhist(dhist)[-100:] | |
2824 | if not 'q' in opts and self.shell.user_ns['_dh']: |
|
2824 | if not 'q' in opts and self.shell.user_ns['_dh']: | |
2825 | print self.shell.user_ns['_dh'][-1] |
|
2825 | print self.shell.user_ns['_dh'][-1] | |
2826 |
|
2826 | |||
2827 |
|
2827 | |||
2828 | def magic_env(self, parameter_s=''): |
|
2828 | def magic_env(self, parameter_s=''): | |
2829 | """List environment variables.""" |
|
2829 | """List environment variables.""" | |
2830 |
|
2830 | |||
2831 | return os.environ.data |
|
2831 | return os.environ.data | |
2832 |
|
2832 | |||
2833 | def magic_pushd(self, parameter_s=''): |
|
2833 | def magic_pushd(self, parameter_s=''): | |
2834 | """Place the current dir on stack and change directory. |
|
2834 | """Place the current dir on stack and change directory. | |
2835 |
|
2835 | |||
2836 | Usage:\\ |
|
2836 | Usage:\\ | |
2837 | %pushd ['dirname'] |
|
2837 | %pushd ['dirname'] | |
2838 | """ |
|
2838 | """ | |
2839 |
|
2839 | |||
2840 | dir_s = self.shell.dir_stack |
|
2840 | dir_s = self.shell.dir_stack | |
2841 | tgt = os.path.expanduser(parameter_s) |
|
2841 | tgt = os.path.expanduser(parameter_s) | |
2842 | cwd = os.getcwd().replace(self.home_dir,'~') |
|
2842 | cwd = os.getcwd().replace(self.home_dir,'~') | |
2843 | if tgt: |
|
2843 | if tgt: | |
2844 | self.magic_cd(parameter_s) |
|
2844 | self.magic_cd(parameter_s) | |
2845 | dir_s.insert(0,cwd) |
|
2845 | dir_s.insert(0,cwd) | |
2846 | return self.magic_dirs() |
|
2846 | return self.magic_dirs() | |
2847 |
|
2847 | |||
2848 | def magic_popd(self, parameter_s=''): |
|
2848 | def magic_popd(self, parameter_s=''): | |
2849 | """Change to directory popped off the top of the stack. |
|
2849 | """Change to directory popped off the top of the stack. | |
2850 | """ |
|
2850 | """ | |
2851 | if not self.shell.dir_stack: |
|
2851 | if not self.shell.dir_stack: | |
2852 | raise UsageError("%popd on empty stack") |
|
2852 | raise UsageError("%popd on empty stack") | |
2853 | top = self.shell.dir_stack.pop(0) |
|
2853 | top = self.shell.dir_stack.pop(0) | |
2854 | self.magic_cd(top) |
|
2854 | self.magic_cd(top) | |
2855 | print "popd ->",top |
|
2855 | print "popd ->",top | |
2856 |
|
2856 | |||
2857 | def magic_dirs(self, parameter_s=''): |
|
2857 | def magic_dirs(self, parameter_s=''): | |
2858 | """Return the current directory stack.""" |
|
2858 | """Return the current directory stack.""" | |
2859 |
|
2859 | |||
2860 | return self.shell.dir_stack |
|
2860 | return self.shell.dir_stack | |
2861 |
|
2861 | |||
2862 | def magic_dhist(self, parameter_s=''): |
|
2862 | def magic_dhist(self, parameter_s=''): | |
2863 | """Print your history of visited directories. |
|
2863 | """Print your history of visited directories. | |
2864 |
|
2864 | |||
2865 | %dhist -> print full history\\ |
|
2865 | %dhist -> print full history\\ | |
2866 | %dhist n -> print last n entries only\\ |
|
2866 | %dhist n -> print last n entries only\\ | |
2867 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ |
|
2867 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ | |
2868 |
|
2868 | |||
2869 | This history is automatically maintained by the %cd command, and |
|
2869 | This history is automatically maintained by the %cd command, and | |
2870 | always available as the global list variable _dh. You can use %cd -<n> |
|
2870 | always available as the global list variable _dh. You can use %cd -<n> | |
2871 | to go to directory number <n>. |
|
2871 | to go to directory number <n>. | |
2872 |
|
2872 | |||
2873 | Note that most of time, you should view directory history by entering |
|
2873 | Note that most of time, you should view directory history by entering | |
2874 | cd -<TAB>. |
|
2874 | cd -<TAB>. | |
2875 |
|
2875 | |||
2876 | """ |
|
2876 | """ | |
2877 |
|
2877 | |||
2878 | dh = self.shell.user_ns['_dh'] |
|
2878 | dh = self.shell.user_ns['_dh'] | |
2879 | if parameter_s: |
|
2879 | if parameter_s: | |
2880 | try: |
|
2880 | try: | |
2881 | args = map(int,parameter_s.split()) |
|
2881 | args = map(int,parameter_s.split()) | |
2882 | except: |
|
2882 | except: | |
2883 | self.arg_err(Magic.magic_dhist) |
|
2883 | self.arg_err(Magic.magic_dhist) | |
2884 | return |
|
2884 | return | |
2885 | if len(args) == 1: |
|
2885 | if len(args) == 1: | |
2886 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
2886 | ini,fin = max(len(dh)-(args[0]),0),len(dh) | |
2887 | elif len(args) == 2: |
|
2887 | elif len(args) == 2: | |
2888 | ini,fin = args |
|
2888 | ini,fin = args | |
2889 | else: |
|
2889 | else: | |
2890 | self.arg_err(Magic.magic_dhist) |
|
2890 | self.arg_err(Magic.magic_dhist) | |
2891 | return |
|
2891 | return | |
2892 | else: |
|
2892 | else: | |
2893 | ini,fin = 0,len(dh) |
|
2893 | ini,fin = 0,len(dh) | |
2894 | nlprint(dh, |
|
2894 | nlprint(dh, | |
2895 | header = 'Directory history (kept in _dh)', |
|
2895 | header = 'Directory history (kept in _dh)', | |
2896 | start=ini,stop=fin) |
|
2896 | start=ini,stop=fin) | |
2897 |
|
2897 | |||
2898 | @testdec.skip_doctest |
|
2898 | @testdec.skip_doctest | |
2899 | def magic_sc(self, parameter_s=''): |
|
2899 | def magic_sc(self, parameter_s=''): | |
2900 | """Shell capture - execute a shell command and capture its output. |
|
2900 | """Shell capture - execute a shell command and capture its output. | |
2901 |
|
2901 | |||
2902 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
2902 | DEPRECATED. Suboptimal, retained for backwards compatibility. | |
2903 |
|
2903 | |||
2904 | You should use the form 'var = !command' instead. Example: |
|
2904 | You should use the form 'var = !command' instead. Example: | |
2905 |
|
2905 | |||
2906 | "%sc -l myfiles = ls ~" should now be written as |
|
2906 | "%sc -l myfiles = ls ~" should now be written as | |
2907 |
|
2907 | |||
2908 | "myfiles = !ls ~" |
|
2908 | "myfiles = !ls ~" | |
2909 |
|
2909 | |||
2910 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
2910 | myfiles.s, myfiles.l and myfiles.n still apply as documented | |
2911 | below. |
|
2911 | below. | |
2912 |
|
2912 | |||
2913 | -- |
|
2913 | -- | |
2914 | %sc [options] varname=command |
|
2914 | %sc [options] varname=command | |
2915 |
|
2915 | |||
2916 | IPython will run the given command using commands.getoutput(), and |
|
2916 | IPython will run the given command using commands.getoutput(), and | |
2917 | will then update the user's interactive namespace with a variable |
|
2917 | will then update the user's interactive namespace with a variable | |
2918 | called varname, containing the value of the call. Your command can |
|
2918 | called varname, containing the value of the call. Your command can | |
2919 | contain shell wildcards, pipes, etc. |
|
2919 | contain shell wildcards, pipes, etc. | |
2920 |
|
2920 | |||
2921 | The '=' sign in the syntax is mandatory, and the variable name you |
|
2921 | The '=' sign in the syntax is mandatory, and the variable name you | |
2922 | supply must follow Python's standard conventions for valid names. |
|
2922 | supply must follow Python's standard conventions for valid names. | |
2923 |
|
2923 | |||
2924 | (A special format without variable name exists for internal use) |
|
2924 | (A special format without variable name exists for internal use) | |
2925 |
|
2925 | |||
2926 | Options: |
|
2926 | Options: | |
2927 |
|
2927 | |||
2928 | -l: list output. Split the output on newlines into a list before |
|
2928 | -l: list output. Split the output on newlines into a list before | |
2929 | assigning it to the given variable. By default the output is stored |
|
2929 | assigning it to the given variable. By default the output is stored | |
2930 | as a single string. |
|
2930 | as a single string. | |
2931 |
|
2931 | |||
2932 | -v: verbose. Print the contents of the variable. |
|
2932 | -v: verbose. Print the contents of the variable. | |
2933 |
|
2933 | |||
2934 | In most cases you should not need to split as a list, because the |
|
2934 | In most cases you should not need to split as a list, because the | |
2935 | returned value is a special type of string which can automatically |
|
2935 | returned value is a special type of string which can automatically | |
2936 | provide its contents either as a list (split on newlines) or as a |
|
2936 | provide its contents either as a list (split on newlines) or as a | |
2937 | space-separated string. These are convenient, respectively, either |
|
2937 | space-separated string. These are convenient, respectively, either | |
2938 | for sequential processing or to be passed to a shell command. |
|
2938 | for sequential processing or to be passed to a shell command. | |
2939 |
|
2939 | |||
2940 | For example: |
|
2940 | For example: | |
2941 |
|
2941 | |||
2942 | # all-random |
|
2942 | # all-random | |
2943 |
|
2943 | |||
2944 | # Capture into variable a |
|
2944 | # Capture into variable a | |
2945 | In [1]: sc a=ls *py |
|
2945 | In [1]: sc a=ls *py | |
2946 |
|
2946 | |||
2947 | # a is a string with embedded newlines |
|
2947 | # a is a string with embedded newlines | |
2948 | In [2]: a |
|
2948 | In [2]: a | |
2949 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
2949 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' | |
2950 |
|
2950 | |||
2951 | # which can be seen as a list: |
|
2951 | # which can be seen as a list: | |
2952 | In [3]: a.l |
|
2952 | In [3]: a.l | |
2953 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
2953 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] | |
2954 |
|
2954 | |||
2955 | # or as a whitespace-separated string: |
|
2955 | # or as a whitespace-separated string: | |
2956 | In [4]: a.s |
|
2956 | In [4]: a.s | |
2957 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
2957 | Out[4]: 'setup.py win32_manual_post_install.py' | |
2958 |
|
2958 | |||
2959 | # a.s is useful to pass as a single command line: |
|
2959 | # a.s is useful to pass as a single command line: | |
2960 | In [5]: !wc -l $a.s |
|
2960 | In [5]: !wc -l $a.s | |
2961 | 146 setup.py |
|
2961 | 146 setup.py | |
2962 | 130 win32_manual_post_install.py |
|
2962 | 130 win32_manual_post_install.py | |
2963 | 276 total |
|
2963 | 276 total | |
2964 |
|
2964 | |||
2965 | # while the list form is useful to loop over: |
|
2965 | # while the list form is useful to loop over: | |
2966 | In [6]: for f in a.l: |
|
2966 | In [6]: for f in a.l: | |
2967 | ...: !wc -l $f |
|
2967 | ...: !wc -l $f | |
2968 | ...: |
|
2968 | ...: | |
2969 | 146 setup.py |
|
2969 | 146 setup.py | |
2970 | 130 win32_manual_post_install.py |
|
2970 | 130 win32_manual_post_install.py | |
2971 |
|
2971 | |||
2972 | Similiarly, the lists returned by the -l option are also special, in |
|
2972 | Similiarly, the lists returned by the -l option are also special, in | |
2973 | the sense that you can equally invoke the .s attribute on them to |
|
2973 | the sense that you can equally invoke the .s attribute on them to | |
2974 | automatically get a whitespace-separated string from their contents: |
|
2974 | automatically get a whitespace-separated string from their contents: | |
2975 |
|
2975 | |||
2976 | In [7]: sc -l b=ls *py |
|
2976 | In [7]: sc -l b=ls *py | |
2977 |
|
2977 | |||
2978 | In [8]: b |
|
2978 | In [8]: b | |
2979 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
2979 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] | |
2980 |
|
2980 | |||
2981 | In [9]: b.s |
|
2981 | In [9]: b.s | |
2982 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
2982 | Out[9]: 'setup.py win32_manual_post_install.py' | |
2983 |
|
2983 | |||
2984 | In summary, both the lists and strings used for ouptut capture have |
|
2984 | In summary, both the lists and strings used for ouptut capture have | |
2985 | the following special attributes: |
|
2985 | the following special attributes: | |
2986 |
|
2986 | |||
2987 | .l (or .list) : value as list. |
|
2987 | .l (or .list) : value as list. | |
2988 | .n (or .nlstr): value as newline-separated string. |
|
2988 | .n (or .nlstr): value as newline-separated string. | |
2989 | .s (or .spstr): value as space-separated string. |
|
2989 | .s (or .spstr): value as space-separated string. | |
2990 | """ |
|
2990 | """ | |
2991 |
|
2991 | |||
2992 | opts,args = self.parse_options(parameter_s,'lv') |
|
2992 | opts,args = self.parse_options(parameter_s,'lv') | |
2993 | # Try to get a variable name and command to run |
|
2993 | # Try to get a variable name and command to run | |
2994 | try: |
|
2994 | try: | |
2995 | # the variable name must be obtained from the parse_options |
|
2995 | # the variable name must be obtained from the parse_options | |
2996 | # output, which uses shlex.split to strip options out. |
|
2996 | # output, which uses shlex.split to strip options out. | |
2997 | var,_ = args.split('=',1) |
|
2997 | var,_ = args.split('=',1) | |
2998 | var = var.strip() |
|
2998 | var = var.strip() | |
2999 | # But the the command has to be extracted from the original input |
|
2999 | # But the the command has to be extracted from the original input | |
3000 | # parameter_s, not on what parse_options returns, to avoid the |
|
3000 | # parameter_s, not on what parse_options returns, to avoid the | |
3001 | # quote stripping which shlex.split performs on it. |
|
3001 | # quote stripping which shlex.split performs on it. | |
3002 | _,cmd = parameter_s.split('=',1) |
|
3002 | _,cmd = parameter_s.split('=',1) | |
3003 | except ValueError: |
|
3003 | except ValueError: | |
3004 | var,cmd = '','' |
|
3004 | var,cmd = '','' | |
3005 | # If all looks ok, proceed |
|
3005 | # If all looks ok, proceed | |
3006 | split = 'l' in opts |
|
3006 | split = 'l' in opts | |
3007 | out = self.shell.getoutput(cmd, split=split) |
|
3007 | out = self.shell.getoutput(cmd, split=split) | |
3008 | if opts.has_key('v'): |
|
3008 | if opts.has_key('v'): | |
3009 | print '%s ==\n%s' % (var,pformat(out)) |
|
3009 | print '%s ==\n%s' % (var,pformat(out)) | |
3010 | if var: |
|
3010 | if var: | |
3011 | self.shell.user_ns.update({var:out}) |
|
3011 | self.shell.user_ns.update({var:out}) | |
3012 | else: |
|
3012 | else: | |
3013 | return out |
|
3013 | return out | |
3014 |
|
3014 | |||
3015 | def magic_sx(self, parameter_s=''): |
|
3015 | def magic_sx(self, parameter_s=''): | |
3016 | """Shell execute - run a shell command and capture its output. |
|
3016 | """Shell execute - run a shell command and capture its output. | |
3017 |
|
3017 | |||
3018 | %sx command |
|
3018 | %sx command | |
3019 |
|
3019 | |||
3020 | IPython will run the given command using commands.getoutput(), and |
|
3020 | IPython will run the given command using commands.getoutput(), and | |
3021 | return the result formatted as a list (split on '\\n'). Since the |
|
3021 | return the result formatted as a list (split on '\\n'). Since the | |
3022 | output is _returned_, it will be stored in ipython's regular output |
|
3022 | output is _returned_, it will be stored in ipython's regular output | |
3023 | cache Out[N] and in the '_N' automatic variables. |
|
3023 | cache Out[N] and in the '_N' automatic variables. | |
3024 |
|
3024 | |||
3025 | Notes: |
|
3025 | Notes: | |
3026 |
|
3026 | |||
3027 | 1) If an input line begins with '!!', then %sx is automatically |
|
3027 | 1) If an input line begins with '!!', then %sx is automatically | |
3028 | invoked. That is, while: |
|
3028 | invoked. That is, while: | |
3029 | !ls |
|
3029 | !ls | |
3030 | causes ipython to simply issue system('ls'), typing |
|
3030 | causes ipython to simply issue system('ls'), typing | |
3031 | !!ls |
|
3031 | !!ls | |
3032 | is a shorthand equivalent to: |
|
3032 | is a shorthand equivalent to: | |
3033 | %sx ls |
|
3033 | %sx ls | |
3034 |
|
3034 | |||
3035 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
3035 | 2) %sx differs from %sc in that %sx automatically splits into a list, | |
3036 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
3036 | like '%sc -l'. The reason for this is to make it as easy as possible | |
3037 | to process line-oriented shell output via further python commands. |
|
3037 | to process line-oriented shell output via further python commands. | |
3038 | %sc is meant to provide much finer control, but requires more |
|
3038 | %sc is meant to provide much finer control, but requires more | |
3039 | typing. |
|
3039 | typing. | |
3040 |
|
3040 | |||
3041 | 3) Just like %sc -l, this is a list with special attributes: |
|
3041 | 3) Just like %sc -l, this is a list with special attributes: | |
3042 |
|
3042 | |||
3043 | .l (or .list) : value as list. |
|
3043 | .l (or .list) : value as list. | |
3044 | .n (or .nlstr): value as newline-separated string. |
|
3044 | .n (or .nlstr): value as newline-separated string. | |
3045 | .s (or .spstr): value as whitespace-separated string. |
|
3045 | .s (or .spstr): value as whitespace-separated string. | |
3046 |
|
3046 | |||
3047 | This is very useful when trying to use such lists as arguments to |
|
3047 | This is very useful when trying to use such lists as arguments to | |
3048 | system commands.""" |
|
3048 | system commands.""" | |
3049 |
|
3049 | |||
3050 | if parameter_s: |
|
3050 | if parameter_s: | |
3051 | return self.shell.getoutput(parameter_s) |
|
3051 | return self.shell.getoutput(parameter_s) | |
3052 |
|
3052 | |||
3053 |
|
3053 | |||
3054 | def magic_bookmark(self, parameter_s=''): |
|
3054 | def magic_bookmark(self, parameter_s=''): | |
3055 | """Manage IPython's bookmark system. |
|
3055 | """Manage IPython's bookmark system. | |
3056 |
|
3056 | |||
3057 | %bookmark <name> - set bookmark to current dir |
|
3057 | %bookmark <name> - set bookmark to current dir | |
3058 | %bookmark <name> <dir> - set bookmark to <dir> |
|
3058 | %bookmark <name> <dir> - set bookmark to <dir> | |
3059 | %bookmark -l - list all bookmarks |
|
3059 | %bookmark -l - list all bookmarks | |
3060 | %bookmark -d <name> - remove bookmark |
|
3060 | %bookmark -d <name> - remove bookmark | |
3061 | %bookmark -r - remove all bookmarks |
|
3061 | %bookmark -r - remove all bookmarks | |
3062 |
|
3062 | |||
3063 | You can later on access a bookmarked folder with: |
|
3063 | You can later on access a bookmarked folder with: | |
3064 | %cd -b <name> |
|
3064 | %cd -b <name> | |
3065 | or simply '%cd <name>' if there is no directory called <name> AND |
|
3065 | or simply '%cd <name>' if there is no directory called <name> AND | |
3066 | there is such a bookmark defined. |
|
3066 | there is such a bookmark defined. | |
3067 |
|
3067 | |||
3068 | Your bookmarks persist through IPython sessions, but they are |
|
3068 | Your bookmarks persist through IPython sessions, but they are | |
3069 | associated with each profile.""" |
|
3069 | associated with each profile.""" | |
3070 |
|
3070 | |||
3071 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
3071 | opts,args = self.parse_options(parameter_s,'drl',mode='list') | |
3072 | if len(args) > 2: |
|
3072 | if len(args) > 2: | |
3073 | raise UsageError("%bookmark: too many arguments") |
|
3073 | raise UsageError("%bookmark: too many arguments") | |
3074 |
|
3074 | |||
3075 | bkms = self.db.get('bookmarks',{}) |
|
3075 | bkms = self.db.get('bookmarks',{}) | |
3076 |
|
3076 | |||
3077 | if opts.has_key('d'): |
|
3077 | if opts.has_key('d'): | |
3078 | try: |
|
3078 | try: | |
3079 | todel = args[0] |
|
3079 | todel = args[0] | |
3080 | except IndexError: |
|
3080 | except IndexError: | |
3081 | raise UsageError( |
|
3081 | raise UsageError( | |
3082 | "%bookmark -d: must provide a bookmark to delete") |
|
3082 | "%bookmark -d: must provide a bookmark to delete") | |
3083 | else: |
|
3083 | else: | |
3084 | try: |
|
3084 | try: | |
3085 | del bkms[todel] |
|
3085 | del bkms[todel] | |
3086 | except KeyError: |
|
3086 | except KeyError: | |
3087 | raise UsageError( |
|
3087 | raise UsageError( | |
3088 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) |
|
3088 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) | |
3089 |
|
3089 | |||
3090 | elif opts.has_key('r'): |
|
3090 | elif opts.has_key('r'): | |
3091 | bkms = {} |
|
3091 | bkms = {} | |
3092 | elif opts.has_key('l'): |
|
3092 | elif opts.has_key('l'): | |
3093 | bks = bkms.keys() |
|
3093 | bks = bkms.keys() | |
3094 | bks.sort() |
|
3094 | bks.sort() | |
3095 | if bks: |
|
3095 | if bks: | |
3096 | size = max(map(len,bks)) |
|
3096 | size = max(map(len,bks)) | |
3097 | else: |
|
3097 | else: | |
3098 | size = 0 |
|
3098 | size = 0 | |
3099 | fmt = '%-'+str(size)+'s -> %s' |
|
3099 | fmt = '%-'+str(size)+'s -> %s' | |
3100 | print 'Current bookmarks:' |
|
3100 | print 'Current bookmarks:' | |
3101 | for bk in bks: |
|
3101 | for bk in bks: | |
3102 | print fmt % (bk,bkms[bk]) |
|
3102 | print fmt % (bk,bkms[bk]) | |
3103 | else: |
|
3103 | else: | |
3104 | if not args: |
|
3104 | if not args: | |
3105 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
3105 | raise UsageError("%bookmark: You must specify the bookmark name") | |
3106 | elif len(args)==1: |
|
3106 | elif len(args)==1: | |
3107 | bkms[args[0]] = os.getcwd() |
|
3107 | bkms[args[0]] = os.getcwd() | |
3108 | elif len(args)==2: |
|
3108 | elif len(args)==2: | |
3109 | bkms[args[0]] = args[1] |
|
3109 | bkms[args[0]] = args[1] | |
3110 | self.db['bookmarks'] = bkms |
|
3110 | self.db['bookmarks'] = bkms | |
3111 |
|
3111 | |||
3112 | def magic_pycat(self, parameter_s=''): |
|
3112 | def magic_pycat(self, parameter_s=''): | |
3113 | """Show a syntax-highlighted file through a pager. |
|
3113 | """Show a syntax-highlighted file through a pager. | |
3114 |
|
3114 | |||
3115 | This magic is similar to the cat utility, but it will assume the file |
|
3115 | This magic is similar to the cat utility, but it will assume the file | |
3116 | to be Python source and will show it with syntax highlighting. """ |
|
3116 | to be Python source and will show it with syntax highlighting. """ | |
3117 |
|
3117 | |||
3118 | try: |
|
3118 | try: | |
3119 | filename = get_py_filename(parameter_s) |
|
3119 | filename = get_py_filename(parameter_s) | |
3120 | cont = file_read(filename) |
|
3120 | cont = file_read(filename) | |
3121 | except IOError: |
|
3121 | except IOError: | |
3122 | try: |
|
3122 | try: | |
3123 | cont = eval(parameter_s,self.user_ns) |
|
3123 | cont = eval(parameter_s,self.user_ns) | |
3124 | except NameError: |
|
3124 | except NameError: | |
3125 | cont = None |
|
3125 | cont = None | |
3126 | if cont is None: |
|
3126 | if cont is None: | |
3127 | print "Error: no such file or variable" |
|
3127 | print "Error: no such file or variable" | |
3128 | return |
|
3128 | return | |
3129 |
|
3129 | |||
3130 | page.page(self.shell.pycolorize(cont)) |
|
3130 | page.page(self.shell.pycolorize(cont)) | |
3131 |
|
3131 | |||
3132 | def _rerun_pasted(self): |
|
3132 | def _rerun_pasted(self): | |
3133 | """ Rerun a previously pasted command. |
|
3133 | """ Rerun a previously pasted command. | |
3134 | """ |
|
3134 | """ | |
3135 | b = self.user_ns.get('pasted_block', None) |
|
3135 | b = self.user_ns.get('pasted_block', None) | |
3136 | if b is None: |
|
3136 | if b is None: | |
3137 | raise UsageError('No previous pasted block available') |
|
3137 | raise UsageError('No previous pasted block available') | |
3138 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) |
|
3138 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) | |
3139 | exec b in self.user_ns |
|
3139 | exec b in self.user_ns | |
3140 |
|
3140 | |||
3141 | def _get_pasted_lines(self, sentinel): |
|
3141 | def _get_pasted_lines(self, sentinel): | |
3142 | """ Yield pasted lines until the user enters the given sentinel value. |
|
3142 | """ Yield pasted lines until the user enters the given sentinel value. | |
3143 | """ |
|
3143 | """ | |
3144 | from IPython.core import interactiveshell |
|
3144 | from IPython.core import interactiveshell | |
3145 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel |
|
3145 | print "Pasting code; enter '%s' alone on the line to stop." % sentinel | |
3146 | while True: |
|
3146 | while True: | |
3147 | l = interactiveshell.raw_input_original(':') |
|
3147 | l = interactiveshell.raw_input_original(':') | |
3148 | if l == sentinel: |
|
3148 | if l == sentinel: | |
3149 | return |
|
3149 | return | |
3150 | else: |
|
3150 | else: | |
3151 | yield l |
|
3151 | yield l | |
3152 |
|
3152 | |||
3153 | def _strip_pasted_lines_for_code(self, raw_lines): |
|
3153 | def _strip_pasted_lines_for_code(self, raw_lines): | |
3154 | """ Strip non-code parts of a sequence of lines to return a block of |
|
3154 | """ Strip non-code parts of a sequence of lines to return a block of | |
3155 | code. |
|
3155 | code. | |
3156 | """ |
|
3156 | """ | |
3157 | # Regular expressions that declare text we strip from the input: |
|
3157 | # Regular expressions that declare text we strip from the input: | |
3158 | strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt |
|
3158 | strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt | |
3159 | r'^\s*(\s?>)+', # Python input prompt |
|
3159 | r'^\s*(\s?>)+', # Python input prompt | |
3160 | r'^\s*\.{3,}', # Continuation prompts |
|
3160 | r'^\s*\.{3,}', # Continuation prompts | |
3161 | r'^\++', |
|
3161 | r'^\++', | |
3162 | ] |
|
3162 | ] | |
3163 |
|
3163 | |||
3164 | strip_from_start = map(re.compile,strip_re) |
|
3164 | strip_from_start = map(re.compile,strip_re) | |
3165 |
|
3165 | |||
3166 | lines = [] |
|
3166 | lines = [] | |
3167 | for l in raw_lines: |
|
3167 | for l in raw_lines: | |
3168 | for pat in strip_from_start: |
|
3168 | for pat in strip_from_start: | |
3169 | l = pat.sub('',l) |
|
3169 | l = pat.sub('',l) | |
3170 | lines.append(l) |
|
3170 | lines.append(l) | |
3171 |
|
3171 | |||
3172 | block = "\n".join(lines) + '\n' |
|
3172 | block = "\n".join(lines) + '\n' | |
3173 | #print "block:\n",block |
|
3173 | #print "block:\n",block | |
3174 | return block |
|
3174 | return block | |
3175 |
|
3175 | |||
3176 | def _execute_block(self, block, par): |
|
3176 | def _execute_block(self, block, par): | |
3177 | """ Execute a block, or store it in a variable, per the user's request. |
|
3177 | """ Execute a block, or store it in a variable, per the user's request. | |
3178 | """ |
|
3178 | """ | |
3179 | if not par: |
|
3179 | if not par: | |
3180 | b = textwrap.dedent(block) |
|
3180 | b = textwrap.dedent(block) | |
3181 | self.user_ns['pasted_block'] = b |
|
3181 | self.user_ns['pasted_block'] = b | |
3182 | exec b in self.user_ns |
|
3182 | exec b in self.user_ns | |
3183 | else: |
|
3183 | else: | |
3184 | self.user_ns[par] = SList(block.splitlines()) |
|
3184 | self.user_ns[par] = SList(block.splitlines()) | |
3185 | print "Block assigned to '%s'" % par |
|
3185 | print "Block assigned to '%s'" % par | |
3186 |
|
3186 | |||
3187 | def magic_quickref(self,arg): |
|
3187 | def magic_quickref(self,arg): | |
3188 | """ Show a quick reference sheet """ |
|
3188 | """ Show a quick reference sheet """ | |
3189 | import IPython.core.usage |
|
3189 | import IPython.core.usage | |
3190 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') |
|
3190 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') | |
3191 |
|
3191 | |||
3192 | page.page(qr) |
|
3192 | page.page(qr) | |
3193 |
|
3193 | |||
3194 | def magic_doctest_mode(self,parameter_s=''): |
|
3194 | def magic_doctest_mode(self,parameter_s=''): | |
3195 | """Toggle doctest mode on and off. |
|
3195 | """Toggle doctest mode on and off. | |
3196 |
|
3196 | |||
3197 | This mode is intended to make IPython behave as much as possible like a |
|
3197 | This mode is intended to make IPython behave as much as possible like a | |
3198 | plain Python shell, from the perspective of how its prompts, exceptions |
|
3198 | plain Python shell, from the perspective of how its prompts, exceptions | |
3199 | and output look. This makes it easy to copy and paste parts of a |
|
3199 | and output look. This makes it easy to copy and paste parts of a | |
3200 | session into doctests. It does so by: |
|
3200 | session into doctests. It does so by: | |
3201 |
|
3201 | |||
3202 | - Changing the prompts to the classic ``>>>`` ones. |
|
3202 | - Changing the prompts to the classic ``>>>`` ones. | |
3203 | - Changing the exception reporting mode to 'Plain'. |
|
3203 | - Changing the exception reporting mode to 'Plain'. | |
3204 | - Disabling pretty-printing of output. |
|
3204 | - Disabling pretty-printing of output. | |
3205 |
|
3205 | |||
3206 | Note that IPython also supports the pasting of code snippets that have |
|
3206 | Note that IPython also supports the pasting of code snippets that have | |
3207 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
3207 | leading '>>>' and '...' prompts in them. This means that you can paste | |
3208 | doctests from files or docstrings (even if they have leading |
|
3208 | doctests from files or docstrings (even if they have leading | |
3209 | whitespace), and the code will execute correctly. You can then use |
|
3209 | whitespace), and the code will execute correctly. You can then use | |
3210 | '%history -t' to see the translated history; this will give you the |
|
3210 | '%history -t' to see the translated history; this will give you the | |
3211 | input after removal of all the leading prompts and whitespace, which |
|
3211 | input after removal of all the leading prompts and whitespace, which | |
3212 | can be pasted back into an editor. |
|
3212 | can be pasted back into an editor. | |
3213 |
|
3213 | |||
3214 | With these features, you can switch into this mode easily whenever you |
|
3214 | With these features, you can switch into this mode easily whenever you | |
3215 | need to do testing and changes to doctests, without having to leave |
|
3215 | need to do testing and changes to doctests, without having to leave | |
3216 | your existing IPython session. |
|
3216 | your existing IPython session. | |
3217 | """ |
|
3217 | """ | |
3218 |
|
3218 | |||
3219 | from IPython.utils.ipstruct import Struct |
|
3219 | from IPython.utils.ipstruct import Struct | |
3220 |
|
3220 | |||
3221 | # Shorthands |
|
3221 | # Shorthands | |
3222 | shell = self.shell |
|
3222 | shell = self.shell | |
3223 | oc = shell.displayhook |
|
3223 | oc = shell.displayhook | |
3224 | meta = shell.meta |
|
3224 | meta = shell.meta | |
3225 | disp_formatter = self.shell.display_formatter |
|
3225 | disp_formatter = self.shell.display_formatter | |
3226 | ptformatter = disp_formatter.formatters['text/plain'] |
|
3226 | ptformatter = disp_formatter.formatters['text/plain'] | |
3227 | # dstore is a data store kept in the instance metadata bag to track any |
|
3227 | # dstore is a data store kept in the instance metadata bag to track any | |
3228 | # changes we make, so we can undo them later. |
|
3228 | # changes we make, so we can undo them later. | |
3229 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
3229 | dstore = meta.setdefault('doctest_mode',Struct()) | |
3230 | save_dstore = dstore.setdefault |
|
3230 | save_dstore = dstore.setdefault | |
3231 |
|
3231 | |||
3232 | # save a few values we'll need to recover later |
|
3232 | # save a few values we'll need to recover later | |
3233 | mode = save_dstore('mode',False) |
|
3233 | mode = save_dstore('mode',False) | |
3234 | save_dstore('rc_pprint',ptformatter.pprint) |
|
3234 | save_dstore('rc_pprint',ptformatter.pprint) | |
3235 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
3235 | save_dstore('xmode',shell.InteractiveTB.mode) | |
3236 | save_dstore('rc_separate_out',shell.separate_out) |
|
3236 | save_dstore('rc_separate_out',shell.separate_out) | |
3237 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
3237 | save_dstore('rc_separate_out2',shell.separate_out2) | |
3238 | save_dstore('rc_prompts_pad_left',shell.prompts_pad_left) |
|
3238 | save_dstore('rc_prompts_pad_left',shell.prompts_pad_left) | |
3239 | save_dstore('rc_separate_in',shell.separate_in) |
|
3239 | save_dstore('rc_separate_in',shell.separate_in) | |
3240 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) |
|
3240 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) | |
3241 |
|
3241 | |||
3242 | if mode == False: |
|
3242 | if mode == False: | |
3243 | # turn on |
|
3243 | # turn on | |
3244 | oc.prompt1.p_template = '>>> ' |
|
3244 | oc.prompt1.p_template = '>>> ' | |
3245 | oc.prompt2.p_template = '... ' |
|
3245 | oc.prompt2.p_template = '... ' | |
3246 | oc.prompt_out.p_template = '' |
|
3246 | oc.prompt_out.p_template = '' | |
3247 |
|
3247 | |||
3248 | # Prompt separators like plain python |
|
3248 | # Prompt separators like plain python | |
3249 | oc.input_sep = oc.prompt1.sep = '' |
|
3249 | oc.input_sep = oc.prompt1.sep = '' | |
3250 | oc.output_sep = '' |
|
3250 | oc.output_sep = '' | |
3251 | oc.output_sep2 = '' |
|
3251 | oc.output_sep2 = '' | |
3252 |
|
3252 | |||
3253 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3253 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
3254 | oc.prompt_out.pad_left = False |
|
3254 | oc.prompt_out.pad_left = False | |
3255 |
|
3255 | |||
3256 | ptformatter.pprint = False |
|
3256 | ptformatter.pprint = False | |
3257 | disp_formatter.plain_text_only = True |
|
3257 | disp_formatter.plain_text_only = True | |
3258 |
|
3258 | |||
3259 | shell.magic_xmode('Plain') |
|
3259 | shell.magic_xmode('Plain') | |
3260 | else: |
|
3260 | else: | |
3261 | # turn off |
|
3261 | # turn off | |
3262 | oc.prompt1.p_template = shell.prompt_in1 |
|
3262 | oc.prompt1.p_template = shell.prompt_in1 | |
3263 | oc.prompt2.p_template = shell.prompt_in2 |
|
3263 | oc.prompt2.p_template = shell.prompt_in2 | |
3264 | oc.prompt_out.p_template = shell.prompt_out |
|
3264 | oc.prompt_out.p_template = shell.prompt_out | |
3265 |
|
3265 | |||
3266 | oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in |
|
3266 | oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in | |
3267 |
|
3267 | |||
3268 | oc.output_sep = dstore.rc_separate_out |
|
3268 | oc.output_sep = dstore.rc_separate_out | |
3269 | oc.output_sep2 = dstore.rc_separate_out2 |
|
3269 | oc.output_sep2 = dstore.rc_separate_out2 | |
3270 |
|
3270 | |||
3271 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3271 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ | |
3272 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
3272 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left | |
3273 |
|
3273 | |||
3274 | ptformatter.pprint = dstore.rc_pprint |
|
3274 | ptformatter.pprint = dstore.rc_pprint | |
3275 | disp_formatter.plain_text_only = dstore.rc_plain_text_only |
|
3275 | disp_formatter.plain_text_only = dstore.rc_plain_text_only | |
3276 |
|
3276 | |||
3277 | shell.magic_xmode(dstore.xmode) |
|
3277 | shell.magic_xmode(dstore.xmode) | |
3278 |
|
3278 | |||
3279 | # Store new mode and inform |
|
3279 | # Store new mode and inform | |
3280 | dstore.mode = bool(1-int(mode)) |
|
3280 | dstore.mode = bool(1-int(mode)) | |
3281 | mode_label = ['OFF','ON'][dstore.mode] |
|
3281 | mode_label = ['OFF','ON'][dstore.mode] | |
3282 | print 'Doctest mode is:', mode_label |
|
3282 | print 'Doctest mode is:', mode_label | |
3283 |
|
3283 | |||
3284 | def magic_gui(self, parameter_s=''): |
|
3284 | def magic_gui(self, parameter_s=''): | |
3285 | """Enable or disable IPython GUI event loop integration. |
|
3285 | """Enable or disable IPython GUI event loop integration. | |
3286 |
|
3286 | |||
3287 | %gui [GUINAME] |
|
3287 | %gui [GUINAME] | |
3288 |
|
3288 | |||
3289 | This magic replaces IPython's threaded shells that were activated |
|
3289 | This magic replaces IPython's threaded shells that were activated | |
3290 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
3290 | using the (pylab/wthread/etc.) command line flags. GUI toolkits | |
3291 | can now be enabled, disabled and swtiched at runtime and keyboard |
|
3291 | can now be enabled, disabled and swtiched at runtime and keyboard | |
3292 | interrupts should work without any problems. The following toolkits |
|
3292 | interrupts should work without any problems. The following toolkits | |
3293 | are supported: wxPython, PyQt4, PyGTK, and Tk:: |
|
3293 | are supported: wxPython, PyQt4, PyGTK, and Tk:: | |
3294 |
|
3294 | |||
3295 | %gui wx # enable wxPython event loop integration |
|
3295 | %gui wx # enable wxPython event loop integration | |
3296 | %gui qt4|qt # enable PyQt4 event loop integration |
|
3296 | %gui qt4|qt # enable PyQt4 event loop integration | |
3297 | %gui gtk # enable PyGTK event loop integration |
|
3297 | %gui gtk # enable PyGTK event loop integration | |
3298 | %gui tk # enable Tk event loop integration |
|
3298 | %gui tk # enable Tk event loop integration | |
3299 | %gui # disable all event loop integration |
|
3299 | %gui # disable all event loop integration | |
3300 |
|
3300 | |||
3301 | WARNING: after any of these has been called you can simply create |
|
3301 | WARNING: after any of these has been called you can simply create | |
3302 | an application object, but DO NOT start the event loop yourself, as |
|
3302 | an application object, but DO NOT start the event loop yourself, as | |
3303 | we have already handled that. |
|
3303 | we have already handled that. | |
3304 | """ |
|
3304 | """ | |
3305 | from IPython.lib.inputhook import enable_gui |
|
3305 | from IPython.lib.inputhook import enable_gui | |
3306 | opts, arg = self.parse_options(parameter_s, '') |
|
3306 | opts, arg = self.parse_options(parameter_s, '') | |
3307 | if arg=='': arg = None |
|
3307 | if arg=='': arg = None | |
3308 | return enable_gui(arg) |
|
3308 | return enable_gui(arg) | |
3309 |
|
3309 | |||
3310 | def magic_load_ext(self, module_str): |
|
3310 | def magic_load_ext(self, module_str): | |
3311 | """Load an IPython extension by its module name.""" |
|
3311 | """Load an IPython extension by its module name.""" | |
3312 | return self.extension_manager.load_extension(module_str) |
|
3312 | return self.extension_manager.load_extension(module_str) | |
3313 |
|
3313 | |||
3314 | def magic_unload_ext(self, module_str): |
|
3314 | def magic_unload_ext(self, module_str): | |
3315 | """Unload an IPython extension by its module name.""" |
|
3315 | """Unload an IPython extension by its module name.""" | |
3316 | self.extension_manager.unload_extension(module_str) |
|
3316 | self.extension_manager.unload_extension(module_str) | |
3317 |
|
3317 | |||
3318 | def magic_reload_ext(self, module_str): |
|
3318 | def magic_reload_ext(self, module_str): | |
3319 | """Reload an IPython extension by its module name.""" |
|
3319 | """Reload an IPython extension by its module name.""" | |
3320 | self.extension_manager.reload_extension(module_str) |
|
3320 | self.extension_manager.reload_extension(module_str) | |
3321 |
|
3321 | |||
3322 | @testdec.skip_doctest |
|
3322 | @testdec.skip_doctest | |
3323 | def magic_install_profiles(self, s): |
|
3323 | def magic_install_profiles(self, s): | |
3324 | """Install the default IPython profiles into the .ipython dir. |
|
3324 | """Install the default IPython profiles into the .ipython dir. | |
3325 |
|
3325 | |||
3326 | If the default profiles have already been installed, they will not |
|
3326 | If the default profiles have already been installed, they will not | |
3327 | be overwritten. You can force overwriting them by using the ``-o`` |
|
3327 | be overwritten. You can force overwriting them by using the ``-o`` | |
3328 | option:: |
|
3328 | option:: | |
3329 |
|
3329 | |||
3330 | In [1]: %install_profiles -o |
|
3330 | In [1]: %install_profiles -o | |
3331 | """ |
|
3331 | """ | |
3332 | if '-o' in s: |
|
3332 | if '-o' in s: | |
3333 | overwrite = True |
|
3333 | overwrite = True | |
3334 | else: |
|
3334 | else: | |
3335 | overwrite = False |
|
3335 | overwrite = False | |
3336 | from IPython.config import profile |
|
3336 | from IPython.config import profile | |
3337 | profile_dir = os.path.split(profile.__file__)[0] |
|
3337 | profile_dir = os.path.split(profile.__file__)[0] | |
3338 | ipython_dir = self.ipython_dir |
|
3338 | ipython_dir = self.ipython_dir | |
3339 | files = os.listdir(profile_dir) |
|
3339 | files = os.listdir(profile_dir) | |
3340 |
|
3340 | |||
3341 | to_install = [] |
|
3341 | to_install = [] | |
3342 | for f in files: |
|
3342 | for f in files: | |
3343 | if f.startswith('ipython_config'): |
|
3343 | if f.startswith('ipython_config'): | |
3344 | src = os.path.join(profile_dir, f) |
|
3344 | src = os.path.join(profile_dir, f) | |
3345 | dst = os.path.join(ipython_dir, f) |
|
3345 | dst = os.path.join(ipython_dir, f) | |
3346 | if (not os.path.isfile(dst)) or overwrite: |
|
3346 | if (not os.path.isfile(dst)) or overwrite: | |
3347 | to_install.append((f, src, dst)) |
|
3347 | to_install.append((f, src, dst)) | |
3348 | if len(to_install)>0: |
|
3348 | if len(to_install)>0: | |
3349 | print "Installing profiles to: ", ipython_dir |
|
3349 | print "Installing profiles to: ", ipython_dir | |
3350 | for (f, src, dst) in to_install: |
|
3350 | for (f, src, dst) in to_install: | |
3351 | shutil.copy(src, dst) |
|
3351 | shutil.copy(src, dst) | |
3352 | print " %s" % f |
|
3352 | print " %s" % f | |
3353 |
|
3353 | |||
3354 | def magic_install_default_config(self, s): |
|
3354 | def magic_install_default_config(self, s): | |
3355 | """Install IPython's default config file into the .ipython dir. |
|
3355 | """Install IPython's default config file into the .ipython dir. | |
3356 |
|
3356 | |||
3357 | If the default config file (:file:`ipython_config.py`) is already |
|
3357 | If the default config file (:file:`ipython_config.py`) is already | |
3358 | installed, it will not be overwritten. You can force overwriting |
|
3358 | installed, it will not be overwritten. You can force overwriting | |
3359 | by using the ``-o`` option:: |
|
3359 | by using the ``-o`` option:: | |
3360 |
|
3360 | |||
3361 | In [1]: %install_default_config |
|
3361 | In [1]: %install_default_config | |
3362 | """ |
|
3362 | """ | |
3363 | if '-o' in s: |
|
3363 | if '-o' in s: | |
3364 | overwrite = True |
|
3364 | overwrite = True | |
3365 | else: |
|
3365 | else: | |
3366 | overwrite = False |
|
3366 | overwrite = False | |
3367 | from IPython.config import default |
|
3367 | from IPython.config import default | |
3368 | config_dir = os.path.split(default.__file__)[0] |
|
3368 | config_dir = os.path.split(default.__file__)[0] | |
3369 | ipython_dir = self.ipython_dir |
|
3369 | ipython_dir = self.ipython_dir | |
3370 | default_config_file_name = 'ipython_config.py' |
|
3370 | default_config_file_name = 'ipython_config.py' | |
3371 | src = os.path.join(config_dir, default_config_file_name) |
|
3371 | src = os.path.join(config_dir, default_config_file_name) | |
3372 | dst = os.path.join(ipython_dir, default_config_file_name) |
|
3372 | dst = os.path.join(ipython_dir, default_config_file_name) | |
3373 | if (not os.path.isfile(dst)) or overwrite: |
|
3373 | if (not os.path.isfile(dst)) or overwrite: | |
3374 | shutil.copy(src, dst) |
|
3374 | shutil.copy(src, dst) | |
3375 | print "Installing default config file: %s" % dst |
|
3375 | print "Installing default config file: %s" % dst | |
3376 |
|
3376 | |||
3377 | # Pylab support: simple wrappers that activate pylab, load gui input |
|
3377 | # Pylab support: simple wrappers that activate pylab, load gui input | |
3378 | # handling and modify slightly %run |
|
3378 | # handling and modify slightly %run | |
3379 |
|
3379 | |||
3380 | @testdec.skip_doctest |
|
3380 | @testdec.skip_doctest | |
3381 | def _pylab_magic_run(self, parameter_s=''): |
|
3381 | def _pylab_magic_run(self, parameter_s=''): | |
3382 | Magic.magic_run(self, parameter_s, |
|
3382 | Magic.magic_run(self, parameter_s, | |
3383 | runner=mpl_runner(self.shell.safe_execfile)) |
|
3383 | runner=mpl_runner(self.shell.safe_execfile)) | |
3384 |
|
3384 | |||
3385 | _pylab_magic_run.__doc__ = magic_run.__doc__ |
|
3385 | _pylab_magic_run.__doc__ = magic_run.__doc__ | |
3386 |
|
3386 | |||
3387 | @testdec.skip_doctest |
|
3387 | @testdec.skip_doctest | |
3388 | def magic_pylab(self, s): |
|
3388 | def magic_pylab(self, s): | |
3389 | """Load numpy and matplotlib to work interactively. |
|
3389 | """Load numpy and matplotlib to work interactively. | |
3390 |
|
3390 | |||
3391 | %pylab [GUINAME] |
|
3391 | %pylab [GUINAME] | |
3392 |
|
3392 | |||
3393 | This function lets you activate pylab (matplotlib, numpy and |
|
3393 | This function lets you activate pylab (matplotlib, numpy and | |
3394 | interactive support) at any point during an IPython session. |
|
3394 | interactive support) at any point during an IPython session. | |
3395 |
|
3395 | |||
3396 | It will import at the top level numpy as np, pyplot as plt, matplotlib, |
|
3396 | It will import at the top level numpy as np, pyplot as plt, matplotlib, | |
3397 | pylab and mlab, as well as all names from numpy and pylab. |
|
3397 | pylab and mlab, as well as all names from numpy and pylab. | |
3398 |
|
3398 | |||
3399 | Parameters |
|
3399 | Parameters | |
3400 | ---------- |
|
3400 | ---------- | |
3401 | guiname : optional |
|
3401 | guiname : optional | |
3402 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or |
|
3402 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or | |
3403 | 'tk'). If given, the corresponding Matplotlib backend is used, |
|
3403 | 'tk'). If given, the corresponding Matplotlib backend is used, | |
3404 | otherwise matplotlib's default (which you can override in your |
|
3404 | otherwise matplotlib's default (which you can override in your | |
3405 | matplotlib config file) is used. |
|
3405 | matplotlib config file) is used. | |
3406 |
|
3406 | |||
3407 | Examples |
|
3407 | Examples | |
3408 | -------- |
|
3408 | -------- | |
3409 | In this case, where the MPL default is TkAgg: |
|
3409 | In this case, where the MPL default is TkAgg: | |
3410 | In [2]: %pylab |
|
3410 | In [2]: %pylab | |
3411 |
|
3411 | |||
3412 | Welcome to pylab, a matplotlib-based Python environment. |
|
3412 | Welcome to pylab, a matplotlib-based Python environment. | |
3413 | Backend in use: TkAgg |
|
3413 | Backend in use: TkAgg | |
3414 | For more information, type 'help(pylab)'. |
|
3414 | For more information, type 'help(pylab)'. | |
3415 |
|
3415 | |||
3416 | But you can explicitly request a different backend: |
|
3416 | But you can explicitly request a different backend: | |
3417 | In [3]: %pylab qt |
|
3417 | In [3]: %pylab qt | |
3418 |
|
3418 | |||
3419 | Welcome to pylab, a matplotlib-based Python environment. |
|
3419 | Welcome to pylab, a matplotlib-based Python environment. | |
3420 | Backend in use: Qt4Agg |
|
3420 | Backend in use: Qt4Agg | |
3421 | For more information, type 'help(pylab)'. |
|
3421 | For more information, type 'help(pylab)'. | |
3422 | """ |
|
3422 | """ | |
3423 | self.shell.enable_pylab(s) |
|
3423 | self.shell.enable_pylab(s) | |
3424 |
|
3424 | |||
3425 | def magic_tb(self, s): |
|
3425 | def magic_tb(self, s): | |
3426 | """Print the last traceback with the currently active exception mode. |
|
3426 | """Print the last traceback with the currently active exception mode. | |
3427 |
|
3427 | |||
3428 | See %xmode for changing exception reporting modes.""" |
|
3428 | See %xmode for changing exception reporting modes.""" | |
3429 | self.shell.showtraceback() |
|
3429 | self.shell.showtraceback() | |
3430 |
|
3430 | |||
3431 | @testdec.skip_doctest |
|
3431 | @testdec.skip_doctest | |
3432 | def magic_precision(self, s=''): |
|
3432 | def magic_precision(self, s=''): | |
3433 | """Set floating point precision for pretty printing. |
|
3433 | """Set floating point precision for pretty printing. | |
3434 |
|
3434 | |||
3435 | Can set either integer precision or a format string. |
|
3435 | Can set either integer precision or a format string. | |
3436 |
|
3436 | |||
3437 | If numpy has been imported and precision is an int, |
|
3437 | If numpy has been imported and precision is an int, | |
3438 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
3438 | numpy display precision will also be set, via ``numpy.set_printoptions``. | |
3439 |
|
3439 | |||
3440 | If no argument is given, defaults will be restored. |
|
3440 | If no argument is given, defaults will be restored. | |
3441 |
|
3441 | |||
3442 | Examples |
|
3442 | Examples | |
3443 | -------- |
|
3443 | -------- | |
3444 | :: |
|
3444 | :: | |
3445 |
|
3445 | |||
3446 | In [1]: from math import pi |
|
3446 | In [1]: from math import pi | |
3447 |
|
3447 | |||
3448 | In [2]: %precision 3 |
|
3448 | In [2]: %precision 3 | |
3449 | Out[2]: '%.3f' |
|
3449 | Out[2]: '%.3f' | |
3450 |
|
3450 | |||
3451 | In [3]: pi |
|
3451 | In [3]: pi | |
3452 | Out[3]: 3.142 |
|
3452 | Out[3]: 3.142 | |
3453 |
|
3453 | |||
3454 | In [4]: %precision %i |
|
3454 | In [4]: %precision %i | |
3455 | Out[4]: '%i' |
|
3455 | Out[4]: '%i' | |
3456 |
|
3456 | |||
3457 | In [5]: pi |
|
3457 | In [5]: pi | |
3458 | Out[5]: 3 |
|
3458 | Out[5]: 3 | |
3459 |
|
3459 | |||
3460 | In [6]: %precision %e |
|
3460 | In [6]: %precision %e | |
3461 | Out[6]: '%e' |
|
3461 | Out[6]: '%e' | |
3462 |
|
3462 | |||
3463 | In [7]: pi**10 |
|
3463 | In [7]: pi**10 | |
3464 | Out[7]: 9.364805e+04 |
|
3464 | Out[7]: 9.364805e+04 | |
3465 |
|
3465 | |||
3466 | In [8]: %precision |
|
3466 | In [8]: %precision | |
3467 | Out[8]: '%r' |
|
3467 | Out[8]: '%r' | |
3468 |
|
3468 | |||
3469 | In [9]: pi**10 |
|
3469 | In [9]: pi**10 | |
3470 | Out[9]: 93648.047476082982 |
|
3470 | Out[9]: 93648.047476082982 | |
3471 |
|
3471 | |||
3472 | """ |
|
3472 | """ | |
3473 |
|
3473 | |||
3474 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
3474 | ptformatter = self.shell.display_formatter.formatters['text/plain'] | |
3475 | ptformatter.float_precision = s |
|
3475 | ptformatter.float_precision = s | |
3476 | return ptformatter.float_format |
|
3476 | return ptformatter.float_format | |
3477 |
|
3477 | |||
3478 | # end Magic |
|
3478 | # end Magic |
General Comments 0
You need to be logged in to leave comments.
Login now