Show More
@@ -0,0 +1,19 b'' | |||
|
1 | Empty History Ranges | |
|
2 | ==================== | |
|
3 | ||
|
4 | A number of magics that take history ranges can now be used with an empty | |
|
5 | range. These magics are: | |
|
6 | ||
|
7 | * ``%save`` | |
|
8 | * ``%load`` | |
|
9 | * ``%pastebin`` | |
|
10 | * ``%pycat`` | |
|
11 | ||
|
12 | Using them this way will make them take the history of the current session up | |
|
13 | to the point of the magic call (such that the magic itself will not be | |
|
14 | included). | |
|
15 | ||
|
16 | Therefore it is now possible to save the whole history to a file using simple | |
|
17 | ``%save <filename>``, load and edit it using ``%load`` (makes for a nice usage | |
|
18 | when followed with :kbd:`F2`), send it to dpaste.org using ``%pastebin``, or | |
|
19 | view the whole thing syntax-highlighted with a single ``%pycat``. |
@@ -1,897 +1,907 b'' | |||
|
1 | 1 | """ History related magics and functionality """ |
|
2 | 2 | |
|
3 | 3 | # Copyright (c) IPython Development Team. |
|
4 | 4 | # Distributed under the terms of the Modified BSD License. |
|
5 | 5 | |
|
6 | 6 | |
|
7 | 7 | import atexit |
|
8 | 8 | import datetime |
|
9 | 9 | from pathlib import Path |
|
10 | 10 | import re |
|
11 | 11 | import sqlite3 |
|
12 | 12 | import threading |
|
13 | 13 | |
|
14 | 14 | from traitlets.config.configurable import LoggingConfigurable |
|
15 | 15 | from decorator import decorator |
|
16 | 16 | from IPython.utils.decorators import undoc |
|
17 | 17 | from IPython.paths import locate_profile |
|
18 | 18 | from traitlets import ( |
|
19 | 19 | Any, |
|
20 | 20 | Bool, |
|
21 | 21 | Dict, |
|
22 | 22 | Instance, |
|
23 | 23 | Integer, |
|
24 | 24 | List, |
|
25 | 25 | Unicode, |
|
26 | 26 | Union, |
|
27 | 27 | TraitError, |
|
28 | 28 | default, |
|
29 | 29 | observe, |
|
30 | 30 | ) |
|
31 | 31 | |
|
32 | 32 | #----------------------------------------------------------------------------- |
|
33 | 33 | # Classes and functions |
|
34 | 34 | #----------------------------------------------------------------------------- |
|
35 | 35 | |
|
36 | 36 | @undoc |
|
37 | 37 | class DummyDB(object): |
|
38 | 38 | """Dummy DB that will act as a black hole for history. |
|
39 | 39 | |
|
40 | 40 | Only used in the absence of sqlite""" |
|
41 | 41 | def execute(*args, **kwargs): |
|
42 | 42 | return [] |
|
43 | 43 | |
|
44 | 44 | def commit(self, *args, **kwargs): |
|
45 | 45 | pass |
|
46 | 46 | |
|
47 | 47 | def __enter__(self, *args, **kwargs): |
|
48 | 48 | pass |
|
49 | 49 | |
|
50 | 50 | def __exit__(self, *args, **kwargs): |
|
51 | 51 | pass |
|
52 | 52 | |
|
53 | 53 | |
|
54 | 54 | @decorator |
|
55 | 55 | def only_when_enabled(f, self, *a, **kw): |
|
56 | 56 | """Decorator: return an empty list in the absence of sqlite.""" |
|
57 | 57 | if not self.enabled: |
|
58 | 58 | return [] |
|
59 | 59 | else: |
|
60 | 60 | return f(self, *a, **kw) |
|
61 | 61 | |
|
62 | 62 | |
|
63 | 63 | # use 16kB as threshold for whether a corrupt history db should be saved |
|
64 | 64 | # that should be at least 100 entries or so |
|
65 | 65 | _SAVE_DB_SIZE = 16384 |
|
66 | 66 | |
|
67 | 67 | @decorator |
|
68 | 68 | def catch_corrupt_db(f, self, *a, **kw): |
|
69 | 69 | """A decorator which wraps HistoryAccessor method calls to catch errors from |
|
70 | 70 | a corrupt SQLite database, move the old database out of the way, and create |
|
71 | 71 | a new one. |
|
72 | 72 | |
|
73 | 73 | We avoid clobbering larger databases because this may be triggered due to filesystem issues, |
|
74 | 74 | not just a corrupt file. |
|
75 | 75 | """ |
|
76 | 76 | try: |
|
77 | 77 | return f(self, *a, **kw) |
|
78 | 78 | except (sqlite3.DatabaseError, sqlite3.OperationalError) as e: |
|
79 | 79 | self._corrupt_db_counter += 1 |
|
80 | 80 | self.log.error("Failed to open SQLite history %s (%s).", self.hist_file, e) |
|
81 | 81 | if self.hist_file != ':memory:': |
|
82 | 82 | if self._corrupt_db_counter > self._corrupt_db_limit: |
|
83 | 83 | self.hist_file = ':memory:' |
|
84 | 84 | self.log.error("Failed to load history too many times, history will not be saved.") |
|
85 | 85 | elif self.hist_file.is_file(): |
|
86 | 86 | # move the file out of the way |
|
87 | 87 | base = str(self.hist_file.parent / self.hist_file.stem) |
|
88 | 88 | ext = self.hist_file.suffix |
|
89 | 89 | size = self.hist_file.stat().st_size |
|
90 | 90 | if size >= _SAVE_DB_SIZE: |
|
91 | 91 | # if there's significant content, avoid clobbering |
|
92 | 92 | now = datetime.datetime.now().isoformat().replace(':', '.') |
|
93 | 93 | newpath = base + '-corrupt-' + now + ext |
|
94 | 94 | # don't clobber previous corrupt backups |
|
95 | 95 | for i in range(100): |
|
96 | 96 | if not Path(newpath).exists(): |
|
97 | 97 | break |
|
98 | 98 | else: |
|
99 | 99 | newpath = base + '-corrupt-' + now + (u'-%i' % i) + ext |
|
100 | 100 | else: |
|
101 | 101 | # not much content, possibly empty; don't worry about clobbering |
|
102 | 102 | # maybe we should just delete it? |
|
103 | 103 | newpath = base + '-corrupt' + ext |
|
104 | 104 | self.hist_file.rename(newpath) |
|
105 | 105 | self.log.error("History file was moved to %s and a new file created.", newpath) |
|
106 | 106 | self.init_db() |
|
107 | 107 | return [] |
|
108 | 108 | else: |
|
109 | 109 | # Failed with :memory:, something serious is wrong |
|
110 | 110 | raise |
|
111 | 111 | |
|
112 | 112 | |
|
113 | 113 | class HistoryAccessorBase(LoggingConfigurable): |
|
114 | 114 | """An abstract class for History Accessors """ |
|
115 | 115 | |
|
116 | 116 | def get_tail(self, n=10, raw=True, output=False, include_latest=False): |
|
117 | 117 | raise NotImplementedError |
|
118 | 118 | |
|
119 | 119 | def search(self, pattern="*", raw=True, search_raw=True, |
|
120 | 120 | output=False, n=None, unique=False): |
|
121 | 121 | raise NotImplementedError |
|
122 | 122 | |
|
123 | 123 | def get_range(self, session, start=1, stop=None, raw=True,output=False): |
|
124 | 124 | raise NotImplementedError |
|
125 | 125 | |
|
126 | 126 | def get_range_by_str(self, rangestr, raw=True, output=False): |
|
127 | 127 | raise NotImplementedError |
|
128 | 128 | |
|
129 | 129 | |
|
130 | 130 | class HistoryAccessor(HistoryAccessorBase): |
|
131 | 131 | """Access the history database without adding to it. |
|
132 | 132 | |
|
133 | 133 | This is intended for use by standalone history tools. IPython shells use |
|
134 | 134 | HistoryManager, below, which is a subclass of this.""" |
|
135 | 135 | |
|
136 | 136 | # counter for init_db retries, so we don't keep trying over and over |
|
137 | 137 | _corrupt_db_counter = 0 |
|
138 | 138 | # after two failures, fallback on :memory: |
|
139 | 139 | _corrupt_db_limit = 2 |
|
140 | 140 | |
|
141 | 141 | # String holding the path to the history file |
|
142 | 142 | hist_file = Union( |
|
143 | 143 | [Instance(Path), Unicode()], |
|
144 | 144 | help="""Path to file to use for SQLite history database. |
|
145 | 145 | |
|
146 | 146 | By default, IPython will put the history database in the IPython |
|
147 | 147 | profile directory. If you would rather share one history among |
|
148 | 148 | profiles, you can set this value in each, so that they are consistent. |
|
149 | 149 | |
|
150 | 150 | Due to an issue with fcntl, SQLite is known to misbehave on some NFS |
|
151 | 151 | mounts. If you see IPython hanging, try setting this to something on a |
|
152 | 152 | local disk, e.g:: |
|
153 | 153 | |
|
154 | 154 | ipython --HistoryManager.hist_file=/tmp/ipython_hist.sqlite |
|
155 | 155 | |
|
156 | 156 | you can also use the specific value `:memory:` (including the colon |
|
157 | 157 | at both end but not the back ticks), to avoid creating an history file. |
|
158 | 158 | |
|
159 | 159 | """, |
|
160 | 160 | ).tag(config=True) |
|
161 | 161 | |
|
162 | 162 | enabled = Bool(True, |
|
163 | 163 | help="""enable the SQLite history |
|
164 | 164 | |
|
165 | 165 | set enabled=False to disable the SQLite history, |
|
166 | 166 | in which case there will be no stored history, no SQLite connection, |
|
167 | 167 | and no background saving thread. This may be necessary in some |
|
168 | 168 | threaded environments where IPython is embedded. |
|
169 | 169 | """ |
|
170 | 170 | ).tag(config=True) |
|
171 | 171 | |
|
172 | 172 | connection_options = Dict( |
|
173 | 173 | help="""Options for configuring the SQLite connection |
|
174 | 174 | |
|
175 | 175 | These options are passed as keyword args to sqlite3.connect |
|
176 | 176 | when establishing database connections. |
|
177 | 177 | """ |
|
178 | 178 | ).tag(config=True) |
|
179 | 179 | |
|
180 | 180 | # The SQLite database |
|
181 | 181 | db = Any() |
|
182 | 182 | @observe('db') |
|
183 | 183 | def _db_changed(self, change): |
|
184 | 184 | """validate the db, since it can be an Instance of two different types""" |
|
185 | 185 | new = change['new'] |
|
186 | 186 | connection_types = (DummyDB, sqlite3.Connection) |
|
187 | 187 | if not isinstance(new, connection_types): |
|
188 | 188 | msg = "%s.db must be sqlite3 Connection or DummyDB, not %r" % \ |
|
189 | 189 | (self.__class__.__name__, new) |
|
190 | 190 | raise TraitError(msg) |
|
191 | 191 | |
|
192 | 192 | def __init__(self, profile="default", hist_file="", **traits): |
|
193 | 193 | """Create a new history accessor. |
|
194 | 194 | |
|
195 | 195 | Parameters |
|
196 | 196 | ---------- |
|
197 | 197 | profile : str |
|
198 | 198 | The name of the profile from which to open history. |
|
199 | 199 | hist_file : str |
|
200 | 200 | Path to an SQLite history database stored by IPython. If specified, |
|
201 | 201 | hist_file overrides profile. |
|
202 | 202 | config : :class:`~traitlets.config.loader.Config` |
|
203 | 203 | Config object. hist_file can also be set through this. |
|
204 | 204 | """ |
|
205 | 205 | # We need a pointer back to the shell for various tasks. |
|
206 | 206 | super(HistoryAccessor, self).__init__(**traits) |
|
207 | 207 | # defer setting hist_file from kwarg until after init, |
|
208 | 208 | # otherwise the default kwarg value would clobber any value |
|
209 | 209 | # set by config |
|
210 | 210 | if hist_file: |
|
211 | 211 | self.hist_file = hist_file |
|
212 | 212 | |
|
213 | 213 | try: |
|
214 | 214 | self.hist_file |
|
215 | 215 | except TraitError: |
|
216 | 216 | # No one has set the hist_file, yet. |
|
217 | 217 | self.hist_file = self._get_hist_file_name(profile) |
|
218 | 218 | |
|
219 | 219 | self.init_db() |
|
220 | 220 | |
|
221 | 221 | def _get_hist_file_name(self, profile='default'): |
|
222 | 222 | """Find the history file for the given profile name. |
|
223 | 223 | |
|
224 | 224 | This is overridden by the HistoryManager subclass, to use the shell's |
|
225 | 225 | active profile. |
|
226 | 226 | |
|
227 | 227 | Parameters |
|
228 | 228 | ---------- |
|
229 | 229 | profile : str |
|
230 | 230 | The name of a profile which has a history file. |
|
231 | 231 | """ |
|
232 | 232 | return Path(locate_profile(profile)) / "history.sqlite" |
|
233 | 233 | |
|
234 | 234 | @catch_corrupt_db |
|
235 | 235 | def init_db(self): |
|
236 | 236 | """Connect to the database, and create tables if necessary.""" |
|
237 | 237 | if not self.enabled: |
|
238 | 238 | self.db = DummyDB() |
|
239 | 239 | return |
|
240 | 240 | |
|
241 | 241 | # use detect_types so that timestamps return datetime objects |
|
242 | 242 | kwargs = dict(detect_types=sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES) |
|
243 | 243 | kwargs.update(self.connection_options) |
|
244 | 244 | self.db = sqlite3.connect(str(self.hist_file), **kwargs) |
|
245 | 245 | self.db.execute("""CREATE TABLE IF NOT EXISTS sessions (session integer |
|
246 | 246 | primary key autoincrement, start timestamp, |
|
247 | 247 | end timestamp, num_cmds integer, remark text)""") |
|
248 | 248 | self.db.execute("""CREATE TABLE IF NOT EXISTS history |
|
249 | 249 | (session integer, line integer, source text, source_raw text, |
|
250 | 250 | PRIMARY KEY (session, line))""") |
|
251 | 251 | # Output history is optional, but ensure the table's there so it can be |
|
252 | 252 | # enabled later. |
|
253 | 253 | self.db.execute("""CREATE TABLE IF NOT EXISTS output_history |
|
254 | 254 | (session integer, line integer, output text, |
|
255 | 255 | PRIMARY KEY (session, line))""") |
|
256 | 256 | self.db.commit() |
|
257 | 257 | # success! reset corrupt db count |
|
258 | 258 | self._corrupt_db_counter = 0 |
|
259 | 259 | |
|
260 | 260 | def writeout_cache(self): |
|
261 | 261 | """Overridden by HistoryManager to dump the cache before certain |
|
262 | 262 | database lookups.""" |
|
263 | 263 | pass |
|
264 | 264 | |
|
265 | 265 | ## ------------------------------- |
|
266 | 266 | ## Methods for retrieving history: |
|
267 | 267 | ## ------------------------------- |
|
268 | 268 | def _run_sql(self, sql, params, raw=True, output=False): |
|
269 | 269 | """Prepares and runs an SQL query for the history database. |
|
270 | 270 | |
|
271 | 271 | Parameters |
|
272 | 272 | ---------- |
|
273 | 273 | sql : str |
|
274 | 274 | Any filtering expressions to go after SELECT ... FROM ... |
|
275 | 275 | params : tuple |
|
276 | 276 | Parameters passed to the SQL query (to replace "?") |
|
277 | 277 | raw, output : bool |
|
278 | 278 | See :meth:`get_range` |
|
279 | 279 | |
|
280 | 280 | Returns |
|
281 | 281 | ------- |
|
282 | 282 | Tuples as :meth:`get_range` |
|
283 | 283 | """ |
|
284 | 284 | toget = 'source_raw' if raw else 'source' |
|
285 | 285 | sqlfrom = "history" |
|
286 | 286 | if output: |
|
287 | 287 | sqlfrom = "history LEFT JOIN output_history USING (session, line)" |
|
288 | 288 | toget = "history.%s, output_history.output" % toget |
|
289 | 289 | cur = self.db.execute("SELECT session, line, %s FROM %s " %\ |
|
290 | 290 | (toget, sqlfrom) + sql, params) |
|
291 | 291 | if output: # Regroup into 3-tuples, and parse JSON |
|
292 | 292 | return ((ses, lin, (inp, out)) for ses, lin, inp, out in cur) |
|
293 | 293 | return cur |
|
294 | 294 | |
|
295 | 295 | @only_when_enabled |
|
296 | 296 | @catch_corrupt_db |
|
297 | 297 | def get_session_info(self, session): |
|
298 | 298 | """Get info about a session. |
|
299 | 299 | |
|
300 | 300 | Parameters |
|
301 | 301 | ---------- |
|
302 | 302 | |
|
303 | 303 | session : int |
|
304 | 304 | Session number to retrieve. |
|
305 | 305 | |
|
306 | 306 | Returns |
|
307 | 307 | ------- |
|
308 | 308 | |
|
309 | 309 | session_id : int |
|
310 | 310 | Session ID number |
|
311 | 311 | start : datetime |
|
312 | 312 | Timestamp for the start of the session. |
|
313 | 313 | end : datetime |
|
314 | 314 | Timestamp for the end of the session, or None if IPython crashed. |
|
315 | 315 | num_cmds : int |
|
316 | 316 | Number of commands run, or None if IPython crashed. |
|
317 | 317 | remark : unicode |
|
318 | 318 | A manually set description. |
|
319 | 319 | """ |
|
320 | 320 | query = "SELECT * from sessions where session == ?" |
|
321 | 321 | return self.db.execute(query, (session,)).fetchone() |
|
322 | 322 | |
|
323 | 323 | @catch_corrupt_db |
|
324 | 324 | def get_last_session_id(self): |
|
325 | 325 | """Get the last session ID currently in the database. |
|
326 | 326 | |
|
327 | 327 | Within IPython, this should be the same as the value stored in |
|
328 | 328 | :attr:`HistoryManager.session_number`. |
|
329 | 329 | """ |
|
330 | 330 | for record in self.get_tail(n=1, include_latest=True): |
|
331 | 331 | return record[0] |
|
332 | 332 | |
|
333 | 333 | @catch_corrupt_db |
|
334 | 334 | def get_tail(self, n=10, raw=True, output=False, include_latest=False): |
|
335 | 335 | """Get the last n lines from the history database. |
|
336 | 336 | |
|
337 | 337 | Parameters |
|
338 | 338 | ---------- |
|
339 | 339 | n : int |
|
340 | 340 | The number of lines to get |
|
341 | 341 | raw, output : bool |
|
342 | 342 | See :meth:`get_range` |
|
343 | 343 | include_latest : bool |
|
344 | 344 | If False (default), n+1 lines are fetched, and the latest one |
|
345 | 345 | is discarded. This is intended to be used where the function |
|
346 | 346 | is called by a user command, which it should not return. |
|
347 | 347 | |
|
348 | 348 | Returns |
|
349 | 349 | ------- |
|
350 | 350 | Tuples as :meth:`get_range` |
|
351 | 351 | """ |
|
352 | 352 | self.writeout_cache() |
|
353 | 353 | if not include_latest: |
|
354 | 354 | n += 1 |
|
355 | 355 | cur = self._run_sql("ORDER BY session DESC, line DESC LIMIT ?", |
|
356 | 356 | (n,), raw=raw, output=output) |
|
357 | 357 | if not include_latest: |
|
358 | 358 | return reversed(list(cur)[1:]) |
|
359 | 359 | return reversed(list(cur)) |
|
360 | 360 | |
|
361 | 361 | @catch_corrupt_db |
|
362 | 362 | def search(self, pattern="*", raw=True, search_raw=True, |
|
363 | 363 | output=False, n=None, unique=False): |
|
364 | 364 | """Search the database using unix glob-style matching (wildcards |
|
365 | 365 | * and ?). |
|
366 | 366 | |
|
367 | 367 | Parameters |
|
368 | 368 | ---------- |
|
369 | 369 | pattern : str |
|
370 | 370 | The wildcarded pattern to match when searching |
|
371 | 371 | search_raw : bool |
|
372 | 372 | If True, search the raw input, otherwise, the parsed input |
|
373 | 373 | raw, output : bool |
|
374 | 374 | See :meth:`get_range` |
|
375 | 375 | n : None or int |
|
376 | 376 | If an integer is given, it defines the limit of |
|
377 | 377 | returned entries. |
|
378 | 378 | unique : bool |
|
379 | 379 | When it is true, return only unique entries. |
|
380 | 380 | |
|
381 | 381 | Returns |
|
382 | 382 | ------- |
|
383 | 383 | Tuples as :meth:`get_range` |
|
384 | 384 | """ |
|
385 | 385 | tosearch = "source_raw" if search_raw else "source" |
|
386 | 386 | if output: |
|
387 | 387 | tosearch = "history." + tosearch |
|
388 | 388 | self.writeout_cache() |
|
389 | 389 | sqlform = "WHERE %s GLOB ?" % tosearch |
|
390 | 390 | params = (pattern,) |
|
391 | 391 | if unique: |
|
392 | 392 | sqlform += ' GROUP BY {0}'.format(tosearch) |
|
393 | 393 | if n is not None: |
|
394 | 394 | sqlform += " ORDER BY session DESC, line DESC LIMIT ?" |
|
395 | 395 | params += (n,) |
|
396 | 396 | elif unique: |
|
397 | 397 | sqlform += " ORDER BY session, line" |
|
398 | 398 | cur = self._run_sql(sqlform, params, raw=raw, output=output) |
|
399 | 399 | if n is not None: |
|
400 | 400 | return reversed(list(cur)) |
|
401 | 401 | return cur |
|
402 | 402 | |
|
403 | 403 | @catch_corrupt_db |
|
404 | 404 | def get_range(self, session, start=1, stop=None, raw=True,output=False): |
|
405 | 405 | """Retrieve input by session. |
|
406 | 406 | |
|
407 | 407 | Parameters |
|
408 | 408 | ---------- |
|
409 | 409 | session : int |
|
410 | 410 | Session number to retrieve. |
|
411 | 411 | start : int |
|
412 | 412 | First line to retrieve. |
|
413 | 413 | stop : int |
|
414 | 414 | End of line range (excluded from output itself). If None, retrieve |
|
415 | 415 | to the end of the session. |
|
416 | 416 | raw : bool |
|
417 | 417 | If True, return untranslated input |
|
418 | 418 | output : bool |
|
419 | 419 | If True, attempt to include output. This will be 'real' Python |
|
420 | 420 | objects for the current session, or text reprs from previous |
|
421 | 421 | sessions if db_log_output was enabled at the time. Where no output |
|
422 | 422 | is found, None is used. |
|
423 | 423 | |
|
424 | 424 | Returns |
|
425 | 425 | ------- |
|
426 | 426 | entries |
|
427 | 427 | An iterator over the desired lines. Each line is a 3-tuple, either |
|
428 | 428 | (session, line, input) if output is False, or |
|
429 | 429 | (session, line, (input, output)) if output is True. |
|
430 | 430 | """ |
|
431 | 431 | if stop: |
|
432 | 432 | lineclause = "line >= ? AND line < ?" |
|
433 | 433 | params = (session, start, stop) |
|
434 | 434 | else: |
|
435 | 435 | lineclause = "line>=?" |
|
436 | 436 | params = (session, start) |
|
437 | 437 | |
|
438 | 438 | return self._run_sql("WHERE session==? AND %s" % lineclause, |
|
439 | 439 | params, raw=raw, output=output) |
|
440 | 440 | |
|
441 | 441 | def get_range_by_str(self, rangestr, raw=True, output=False): |
|
442 | 442 | """Get lines of history from a string of ranges, as used by magic |
|
443 | 443 | commands %hist, %save, %macro, etc. |
|
444 | 444 | |
|
445 | 445 | Parameters |
|
446 | 446 | ---------- |
|
447 | 447 | rangestr : str |
|
448 |
A string specifying ranges, e.g. "5 ~2/1-4". |
|
|
449 | :func:`magic_history` for full details. | |
|
448 | A string specifying ranges, e.g. "5 ~2/1-4". If empty string is used, | |
|
449 | this will return everything from current session's history. | |
|
450 | ||
|
451 | See the documentation of :func:`%history` for the full details. | |
|
452 | ||
|
450 | 453 | raw, output : bool |
|
451 | 454 | As :meth:`get_range` |
|
452 | 455 | |
|
453 | 456 | Returns |
|
454 | 457 | ------- |
|
455 | 458 | Tuples as :meth:`get_range` |
|
456 | 459 | """ |
|
457 | 460 | for sess, s, e in extract_hist_ranges(rangestr): |
|
458 | 461 | for line in self.get_range(sess, s, e, raw=raw, output=output): |
|
459 | 462 | yield line |
|
460 | 463 | |
|
461 | 464 | |
|
462 | 465 | class HistoryManager(HistoryAccessor): |
|
463 | 466 | """A class to organize all history-related functionality in one place. |
|
464 | 467 | """ |
|
465 | 468 | # Public interface |
|
466 | 469 | |
|
467 | 470 | # An instance of the IPython shell we are attached to |
|
468 | 471 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', |
|
469 | 472 | allow_none=True) |
|
470 | 473 | # Lists to hold processed and raw history. These start with a blank entry |
|
471 | 474 | # so that we can index them starting from 1 |
|
472 | 475 | input_hist_parsed = List([""]) |
|
473 | 476 | input_hist_raw = List([""]) |
|
474 | 477 | # A list of directories visited during session |
|
475 | 478 | dir_hist = List() |
|
476 | 479 | @default('dir_hist') |
|
477 | 480 | def _dir_hist_default(self): |
|
478 | 481 | try: |
|
479 | 482 | return [Path.cwd()] |
|
480 | 483 | except OSError: |
|
481 | 484 | return [] |
|
482 | 485 | |
|
483 | 486 | # A dict of output history, keyed with ints from the shell's |
|
484 | 487 | # execution count. |
|
485 | 488 | output_hist = Dict() |
|
486 | 489 | # The text/plain repr of outputs. |
|
487 | 490 | output_hist_reprs = Dict() |
|
488 | 491 | |
|
489 | 492 | # The number of the current session in the history database |
|
490 | 493 | session_number = Integer() |
|
491 | 494 | |
|
492 | 495 | db_log_output = Bool(False, |
|
493 | 496 | help="Should the history database include output? (default: no)" |
|
494 | 497 | ).tag(config=True) |
|
495 | 498 | db_cache_size = Integer(0, |
|
496 | 499 | help="Write to database every x commands (higher values save disk access & power).\n" |
|
497 | 500 | "Values of 1 or less effectively disable caching." |
|
498 | 501 | ).tag(config=True) |
|
499 | 502 | # The input and output caches |
|
500 | 503 | db_input_cache = List() |
|
501 | 504 | db_output_cache = List() |
|
502 | 505 | |
|
503 | 506 | # History saving in separate thread |
|
504 | 507 | save_thread = Instance('IPython.core.history.HistorySavingThread', |
|
505 | 508 | allow_none=True) |
|
506 | 509 | save_flag = Instance(threading.Event, allow_none=True) |
|
507 | 510 | |
|
508 | 511 | # Private interface |
|
509 | 512 | # Variables used to store the three last inputs from the user. On each new |
|
510 | 513 | # history update, we populate the user's namespace with these, shifted as |
|
511 | 514 | # necessary. |
|
512 | 515 | _i00 = Unicode(u'') |
|
513 | 516 | _i = Unicode(u'') |
|
514 | 517 | _ii = Unicode(u'') |
|
515 | 518 | _iii = Unicode(u'') |
|
516 | 519 | |
|
517 | 520 | # A regex matching all forms of the exit command, so that we don't store |
|
518 | 521 | # them in the history (it's annoying to rewind the first entry and land on |
|
519 | 522 | # an exit call). |
|
520 | 523 | _exit_re = re.compile(r"(exit|quit)(\s*\(.*\))?$") |
|
521 | 524 | |
|
522 | 525 | def __init__(self, shell=None, config=None, **traits): |
|
523 | 526 | """Create a new history manager associated with a shell instance. |
|
524 | 527 | """ |
|
525 | 528 | # We need a pointer back to the shell for various tasks. |
|
526 | 529 | super(HistoryManager, self).__init__(shell=shell, config=config, |
|
527 | 530 | **traits) |
|
528 | 531 | self.save_flag = threading.Event() |
|
529 | 532 | self.db_input_cache_lock = threading.Lock() |
|
530 | 533 | self.db_output_cache_lock = threading.Lock() |
|
531 | 534 | |
|
532 | 535 | try: |
|
533 | 536 | self.new_session() |
|
534 | 537 | except sqlite3.OperationalError: |
|
535 | 538 | self.log.error("Failed to create history session in %s. History will not be saved.", |
|
536 | 539 | self.hist_file, exc_info=True) |
|
537 | 540 | self.hist_file = ':memory:' |
|
538 | 541 | |
|
539 | 542 | if self.enabled and self.hist_file != ':memory:': |
|
540 | 543 | self.save_thread = HistorySavingThread(self) |
|
541 | 544 | self.save_thread.start() |
|
542 | 545 | |
|
543 | 546 | def _get_hist_file_name(self, profile=None): |
|
544 | 547 | """Get default history file name based on the Shell's profile. |
|
545 | 548 | |
|
546 | 549 | The profile parameter is ignored, but must exist for compatibility with |
|
547 | 550 | the parent class.""" |
|
548 | 551 | profile_dir = self.shell.profile_dir.location |
|
549 | 552 | return Path(profile_dir) / "history.sqlite" |
|
550 | 553 | |
|
551 | 554 | @only_when_enabled |
|
552 | 555 | def new_session(self, conn=None): |
|
553 | 556 | """Get a new session number.""" |
|
554 | 557 | if conn is None: |
|
555 | 558 | conn = self.db |
|
556 | 559 | |
|
557 | 560 | with conn: |
|
558 | 561 | cur = conn.execute("""INSERT INTO sessions VALUES (NULL, ?, NULL, |
|
559 | 562 | NULL, "") """, (datetime.datetime.now(),)) |
|
560 | 563 | self.session_number = cur.lastrowid |
|
561 | 564 | |
|
562 | 565 | def end_session(self): |
|
563 | 566 | """Close the database session, filling in the end time and line count.""" |
|
564 | 567 | self.writeout_cache() |
|
565 | 568 | with self.db: |
|
566 | 569 | self.db.execute("""UPDATE sessions SET end=?, num_cmds=? WHERE |
|
567 | 570 | session==?""", (datetime.datetime.now(), |
|
568 | 571 | len(self.input_hist_parsed)-1, self.session_number)) |
|
569 | 572 | self.session_number = 0 |
|
570 | 573 | |
|
571 | 574 | def name_session(self, name): |
|
572 | 575 | """Give the current session a name in the history database.""" |
|
573 | 576 | with self.db: |
|
574 | 577 | self.db.execute("UPDATE sessions SET remark=? WHERE session==?", |
|
575 | 578 | (name, self.session_number)) |
|
576 | 579 | |
|
577 | 580 | def reset(self, new_session=True): |
|
578 | 581 | """Clear the session history, releasing all object references, and |
|
579 | 582 | optionally open a new session.""" |
|
580 | 583 | self.output_hist.clear() |
|
581 | 584 | # The directory history can't be completely empty |
|
582 | 585 | self.dir_hist[:] = [Path.cwd()] |
|
583 | 586 | |
|
584 | 587 | if new_session: |
|
585 | 588 | if self.session_number: |
|
586 | 589 | self.end_session() |
|
587 | 590 | self.input_hist_parsed[:] = [""] |
|
588 | 591 | self.input_hist_raw[:] = [""] |
|
589 | 592 | self.new_session() |
|
590 | 593 | |
|
591 | 594 | # ------------------------------ |
|
592 | 595 | # Methods for retrieving history |
|
593 | 596 | # ------------------------------ |
|
594 | 597 | def get_session_info(self, session=0): |
|
595 | 598 | """Get info about a session. |
|
596 | 599 | |
|
597 | 600 | Parameters |
|
598 | 601 | ---------- |
|
599 | 602 | |
|
600 | 603 | session : int |
|
601 | 604 | Session number to retrieve. The current session is 0, and negative |
|
602 | 605 | numbers count back from current session, so -1 is the previous session. |
|
603 | 606 | |
|
604 | 607 | Returns |
|
605 | 608 | ------- |
|
606 | 609 | |
|
607 | 610 | session_id : int |
|
608 | 611 | Session ID number |
|
609 | 612 | start : datetime |
|
610 | 613 | Timestamp for the start of the session. |
|
611 | 614 | end : datetime |
|
612 | 615 | Timestamp for the end of the session, or None if IPython crashed. |
|
613 | 616 | num_cmds : int |
|
614 | 617 | Number of commands run, or None if IPython crashed. |
|
615 | 618 | remark : unicode |
|
616 | 619 | A manually set description. |
|
617 | 620 | """ |
|
618 | 621 | if session <= 0: |
|
619 | 622 | session += self.session_number |
|
620 | 623 | |
|
621 | 624 | return super(HistoryManager, self).get_session_info(session=session) |
|
622 | 625 | |
|
623 | 626 | def _get_range_session(self, start=1, stop=None, raw=True, output=False): |
|
624 | 627 | """Get input and output history from the current session. Called by |
|
625 | 628 | get_range, and takes similar parameters.""" |
|
626 | 629 | input_hist = self.input_hist_raw if raw else self.input_hist_parsed |
|
627 | 630 | |
|
628 | 631 | n = len(input_hist) |
|
629 | 632 | if start < 0: |
|
630 | 633 | start += n |
|
631 | 634 | if not stop or (stop > n): |
|
632 | 635 | stop = n |
|
633 | 636 | elif stop < 0: |
|
634 | 637 | stop += n |
|
635 | 638 | |
|
636 | 639 | for i in range(start, stop): |
|
637 | 640 | if output: |
|
638 | 641 | line = (input_hist[i], self.output_hist_reprs.get(i)) |
|
639 | 642 | else: |
|
640 | 643 | line = input_hist[i] |
|
641 | 644 | yield (0, i, line) |
|
642 | 645 | |
|
643 | 646 | def get_range(self, session=0, start=1, stop=None, raw=True,output=False): |
|
644 | 647 | """Retrieve input by session. |
|
645 | 648 | |
|
646 | 649 | Parameters |
|
647 | 650 | ---------- |
|
648 | 651 | session : int |
|
649 | 652 | Session number to retrieve. The current session is 0, and negative |
|
650 | 653 | numbers count back from current session, so -1 is previous session. |
|
651 | 654 | start : int |
|
652 | 655 | First line to retrieve. |
|
653 | 656 | stop : int |
|
654 | 657 | End of line range (excluded from output itself). If None, retrieve |
|
655 | 658 | to the end of the session. |
|
656 | 659 | raw : bool |
|
657 | 660 | If True, return untranslated input |
|
658 | 661 | output : bool |
|
659 | 662 | If True, attempt to include output. This will be 'real' Python |
|
660 | 663 | objects for the current session, or text reprs from previous |
|
661 | 664 | sessions if db_log_output was enabled at the time. Where no output |
|
662 | 665 | is found, None is used. |
|
663 | 666 | |
|
664 | 667 | Returns |
|
665 | 668 | ------- |
|
666 | 669 | entries |
|
667 | 670 | An iterator over the desired lines. Each line is a 3-tuple, either |
|
668 | 671 | (session, line, input) if output is False, or |
|
669 | 672 | (session, line, (input, output)) if output is True. |
|
670 | 673 | """ |
|
671 | 674 | if session <= 0: |
|
672 | 675 | session += self.session_number |
|
673 | 676 | if session==self.session_number: # Current session |
|
674 | 677 | return self._get_range_session(start, stop, raw, output) |
|
675 | 678 | return super(HistoryManager, self).get_range(session, start, stop, raw, |
|
676 | 679 | output) |
|
677 | 680 | |
|
678 | 681 | ## ---------------------------- |
|
679 | 682 | ## Methods for storing history: |
|
680 | 683 | ## ---------------------------- |
|
681 | 684 | def store_inputs(self, line_num, source, source_raw=None): |
|
682 | 685 | """Store source and raw input in history and create input cache |
|
683 | 686 | variables ``_i*``. |
|
684 | 687 | |
|
685 | 688 | Parameters |
|
686 | 689 | ---------- |
|
687 | 690 | line_num : int |
|
688 | 691 | The prompt number of this input. |
|
689 | 692 | |
|
690 | 693 | source : str |
|
691 | 694 | Python input. |
|
692 | 695 | |
|
693 | 696 | source_raw : str, optional |
|
694 | 697 | If given, this is the raw input without any IPython transformations |
|
695 | 698 | applied to it. If not given, ``source`` is used. |
|
696 | 699 | """ |
|
697 | 700 | if source_raw is None: |
|
698 | 701 | source_raw = source |
|
699 | 702 | source = source.rstrip('\n') |
|
700 | 703 | source_raw = source_raw.rstrip('\n') |
|
701 | 704 | |
|
702 | 705 | # do not store exit/quit commands |
|
703 | 706 | if self._exit_re.match(source_raw.strip()): |
|
704 | 707 | return |
|
705 | 708 | |
|
706 | 709 | self.input_hist_parsed.append(source) |
|
707 | 710 | self.input_hist_raw.append(source_raw) |
|
708 | 711 | |
|
709 | 712 | with self.db_input_cache_lock: |
|
710 | 713 | self.db_input_cache.append((line_num, source, source_raw)) |
|
711 | 714 | # Trigger to flush cache and write to DB. |
|
712 | 715 | if len(self.db_input_cache) >= self.db_cache_size: |
|
713 | 716 | self.save_flag.set() |
|
714 | 717 | |
|
715 | 718 | # update the auto _i variables |
|
716 | 719 | self._iii = self._ii |
|
717 | 720 | self._ii = self._i |
|
718 | 721 | self._i = self._i00 |
|
719 | 722 | self._i00 = source_raw |
|
720 | 723 | |
|
721 | 724 | # hackish access to user namespace to create _i1,_i2... dynamically |
|
722 | 725 | new_i = '_i%s' % line_num |
|
723 | 726 | to_main = {'_i': self._i, |
|
724 | 727 | '_ii': self._ii, |
|
725 | 728 | '_iii': self._iii, |
|
726 | 729 | new_i : self._i00 } |
|
727 | 730 | |
|
728 | 731 | if self.shell is not None: |
|
729 | 732 | self.shell.push(to_main, interactive=False) |
|
730 | 733 | |
|
731 | 734 | def store_output(self, line_num): |
|
732 | 735 | """If database output logging is enabled, this saves all the |
|
733 | 736 | outputs from the indicated prompt number to the database. It's |
|
734 | 737 | called by run_cell after code has been executed. |
|
735 | 738 | |
|
736 | 739 | Parameters |
|
737 | 740 | ---------- |
|
738 | 741 | line_num : int |
|
739 | 742 | The line number from which to save outputs |
|
740 | 743 | """ |
|
741 | 744 | if (not self.db_log_output) or (line_num not in self.output_hist_reprs): |
|
742 | 745 | return |
|
743 | 746 | output = self.output_hist_reprs[line_num] |
|
744 | 747 | |
|
745 | 748 | with self.db_output_cache_lock: |
|
746 | 749 | self.db_output_cache.append((line_num, output)) |
|
747 | 750 | if self.db_cache_size <= 1: |
|
748 | 751 | self.save_flag.set() |
|
749 | 752 | |
|
750 | 753 | def _writeout_input_cache(self, conn): |
|
751 | 754 | with conn: |
|
752 | 755 | for line in self.db_input_cache: |
|
753 | 756 | conn.execute("INSERT INTO history VALUES (?, ?, ?, ?)", |
|
754 | 757 | (self.session_number,)+line) |
|
755 | 758 | |
|
756 | 759 | def _writeout_output_cache(self, conn): |
|
757 | 760 | with conn: |
|
758 | 761 | for line in self.db_output_cache: |
|
759 | 762 | conn.execute("INSERT INTO output_history VALUES (?, ?, ?)", |
|
760 | 763 | (self.session_number,)+line) |
|
761 | 764 | |
|
762 | 765 | @only_when_enabled |
|
763 | 766 | def writeout_cache(self, conn=None): |
|
764 | 767 | """Write any entries in the cache to the database.""" |
|
765 | 768 | if conn is None: |
|
766 | 769 | conn = self.db |
|
767 | 770 | |
|
768 | 771 | with self.db_input_cache_lock: |
|
769 | 772 | try: |
|
770 | 773 | self._writeout_input_cache(conn) |
|
771 | 774 | except sqlite3.IntegrityError: |
|
772 | 775 | self.new_session(conn) |
|
773 | 776 | print("ERROR! Session/line number was not unique in", |
|
774 | 777 | "database. History logging moved to new session", |
|
775 | 778 | self.session_number) |
|
776 | 779 | try: |
|
777 | 780 | # Try writing to the new session. If this fails, don't |
|
778 | 781 | # recurse |
|
779 | 782 | self._writeout_input_cache(conn) |
|
780 | 783 | except sqlite3.IntegrityError: |
|
781 | 784 | pass |
|
782 | 785 | finally: |
|
783 | 786 | self.db_input_cache = [] |
|
784 | 787 | |
|
785 | 788 | with self.db_output_cache_lock: |
|
786 | 789 | try: |
|
787 | 790 | self._writeout_output_cache(conn) |
|
788 | 791 | except sqlite3.IntegrityError: |
|
789 | 792 | print("!! Session/line number for output was not unique", |
|
790 | 793 | "in database. Output will not be stored.") |
|
791 | 794 | finally: |
|
792 | 795 | self.db_output_cache = [] |
|
793 | 796 | |
|
794 | 797 | |
|
795 | 798 | class HistorySavingThread(threading.Thread): |
|
796 | 799 | """This thread takes care of writing history to the database, so that |
|
797 | 800 | the UI isn't held up while that happens. |
|
798 | 801 | |
|
799 | 802 | It waits for the HistoryManager's save_flag to be set, then writes out |
|
800 | 803 | the history cache. The main thread is responsible for setting the flag when |
|
801 | 804 | the cache size reaches a defined threshold.""" |
|
802 | 805 | daemon = True |
|
803 | 806 | stop_now = False |
|
804 | 807 | enabled = True |
|
805 | 808 | def __init__(self, history_manager): |
|
806 | 809 | super(HistorySavingThread, self).__init__(name="IPythonHistorySavingThread") |
|
807 | 810 | self.history_manager = history_manager |
|
808 | 811 | self.enabled = history_manager.enabled |
|
809 | 812 | atexit.register(self.stop) |
|
810 | 813 | |
|
811 | 814 | @only_when_enabled |
|
812 | 815 | def run(self): |
|
813 | 816 | # We need a separate db connection per thread: |
|
814 | 817 | try: |
|
815 | 818 | self.db = sqlite3.connect( |
|
816 | 819 | str(self.history_manager.hist_file), |
|
817 | 820 | **self.history_manager.connection_options |
|
818 | 821 | ) |
|
819 | 822 | while True: |
|
820 | 823 | self.history_manager.save_flag.wait() |
|
821 | 824 | if self.stop_now: |
|
822 | 825 | self.db.close() |
|
823 | 826 | return |
|
824 | 827 | self.history_manager.save_flag.clear() |
|
825 | 828 | self.history_manager.writeout_cache(self.db) |
|
826 | 829 | except Exception as e: |
|
827 | 830 | print(("The history saving thread hit an unexpected error (%s)." |
|
828 | 831 | "History will not be written to the database.") % repr(e)) |
|
829 | 832 | |
|
830 | 833 | def stop(self): |
|
831 | 834 | """This can be called from the main thread to safely stop this thread. |
|
832 | 835 | |
|
833 | 836 | Note that it does not attempt to write out remaining history before |
|
834 | 837 | exiting. That should be done by calling the HistoryManager's |
|
835 | 838 | end_session method.""" |
|
836 | 839 | self.stop_now = True |
|
837 | 840 | self.history_manager.save_flag.set() |
|
838 | 841 | self.join() |
|
839 | 842 | |
|
840 | 843 | |
|
841 | 844 | # To match, e.g. ~5/8-~2/3 |
|
842 | 845 | range_re = re.compile(r""" |
|
843 | 846 | ((?P<startsess>~?\d+)/)? |
|
844 | 847 | (?P<start>\d+)? |
|
845 | 848 | ((?P<sep>[\-:]) |
|
846 | 849 | ((?P<endsess>~?\d+)/)? |
|
847 | 850 | (?P<end>\d+))? |
|
848 | 851 | $""", re.VERBOSE) |
|
849 | 852 | |
|
850 | 853 | |
|
851 | 854 | def extract_hist_ranges(ranges_str): |
|
852 | 855 | """Turn a string of history ranges into 3-tuples of (session, start, stop). |
|
853 | 856 | |
|
857 | Empty string results in a `[(0, 1, None)]`, i.e. "everything from current | |
|
858 | session". | |
|
859 | ||
|
854 | 860 | Examples |
|
855 | 861 | -------- |
|
856 | 862 | >>> list(extract_hist_ranges("~8/5-~7/4 2")) |
|
857 | 863 | [(-8, 5, None), (-7, 1, 5), (0, 2, 3)] |
|
858 | 864 | """ |
|
865 | if ranges_str == "": | |
|
866 | yield (0, 1, None) # Everything from current session | |
|
867 | return | |
|
868 | ||
|
859 | 869 | for range_str in ranges_str.split(): |
|
860 | 870 | rmatch = range_re.match(range_str) |
|
861 | 871 | if not rmatch: |
|
862 | 872 | continue |
|
863 | 873 | start = rmatch.group("start") |
|
864 | 874 | if start: |
|
865 | 875 | start = int(start) |
|
866 | 876 | end = rmatch.group("end") |
|
867 | 877 | # If no end specified, get (a, a + 1) |
|
868 | 878 | end = int(end) if end else start + 1 |
|
869 | 879 | else: # start not specified |
|
870 | 880 | if not rmatch.group('startsess'): # no startsess |
|
871 | 881 | continue |
|
872 | 882 | start = 1 |
|
873 | 883 | end = None # provide the entire session hist |
|
874 | 884 | |
|
875 | 885 | if rmatch.group("sep") == "-": # 1-3 == 1:4 --> [1, 2, 3] |
|
876 | 886 | end += 1 |
|
877 | 887 | startsess = rmatch.group("startsess") or "0" |
|
878 | 888 | endsess = rmatch.group("endsess") or startsess |
|
879 | 889 | startsess = int(startsess.replace("~","-")) |
|
880 | 890 | endsess = int(endsess.replace("~","-")) |
|
881 | 891 | assert endsess >= startsess, "start session must be earlier than end session" |
|
882 | 892 | |
|
883 | 893 | if endsess == startsess: |
|
884 | 894 | yield (startsess, start, end) |
|
885 | 895 | continue |
|
886 | 896 | # Multiple sessions in one range: |
|
887 | 897 | yield (startsess, start, None) |
|
888 | 898 | for sess in range(startsess+1, endsess): |
|
889 | 899 | yield (sess, 1, None) |
|
890 | 900 | yield (endsess, 1, end) |
|
891 | 901 | |
|
892 | 902 | |
|
893 | 903 | def _format_lineno(session, line): |
|
894 | 904 | """Helper function to format line numbers properly.""" |
|
895 | 905 | if session == 0: |
|
896 | 906 | return str(line) |
|
897 | 907 | return "%s#%s" % (session, line) |
@@ -1,3867 +1,3880 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Main IPython class.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | |
|
14 | 14 | import abc |
|
15 | 15 | import ast |
|
16 | 16 | import atexit |
|
17 | 17 | import builtins as builtin_mod |
|
18 | 18 | import functools |
|
19 | 19 | import inspect |
|
20 | 20 | import os |
|
21 | 21 | import re |
|
22 | 22 | import runpy |
|
23 | 23 | import sys |
|
24 | 24 | import tempfile |
|
25 | 25 | import traceback |
|
26 | 26 | import types |
|
27 | 27 | import subprocess |
|
28 | 28 | import warnings |
|
29 | 29 | from io import open as io_open |
|
30 | 30 | |
|
31 | 31 | from pathlib import Path |
|
32 | 32 | from pickleshare import PickleShareDB |
|
33 | 33 | |
|
34 | 34 | from traitlets.config.configurable import SingletonConfigurable |
|
35 | 35 | from traitlets.utils.importstring import import_item |
|
36 | 36 | from IPython.core import oinspect |
|
37 | 37 | from IPython.core import magic |
|
38 | 38 | from IPython.core import page |
|
39 | 39 | from IPython.core import prefilter |
|
40 | 40 | from IPython.core import ultratb |
|
41 | 41 | from IPython.core.alias import Alias, AliasManager |
|
42 | 42 | from IPython.core.autocall import ExitAutocall |
|
43 | 43 | from IPython.core.builtin_trap import BuiltinTrap |
|
44 | 44 | from IPython.core.events import EventManager, available_events |
|
45 | 45 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
46 | 46 | from IPython.core.debugger import Pdb |
|
47 | 47 | from IPython.core.display_trap import DisplayTrap |
|
48 | 48 | from IPython.core.displayhook import DisplayHook |
|
49 | 49 | from IPython.core.displaypub import DisplayPublisher |
|
50 | 50 | from IPython.core.error import InputRejected, UsageError |
|
51 | 51 | from IPython.core.extensions import ExtensionManager |
|
52 | 52 | from IPython.core.formatters import DisplayFormatter |
|
53 | 53 | from IPython.core.history import HistoryManager |
|
54 | 54 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
55 | 55 | from IPython.core.logger import Logger |
|
56 | 56 | from IPython.core.macro import Macro |
|
57 | 57 | from IPython.core.payload import PayloadManager |
|
58 | 58 | from IPython.core.prefilter import PrefilterManager |
|
59 | 59 | from IPython.core.profiledir import ProfileDir |
|
60 | 60 | from IPython.core.usage import default_banner |
|
61 | 61 | from IPython.display import display |
|
62 | 62 | from IPython.testing.skipdoctest import skip_doctest |
|
63 | 63 | from IPython.utils import PyColorize |
|
64 | 64 | from IPython.utils import io |
|
65 | 65 | from IPython.utils import py3compat |
|
66 | 66 | from IPython.utils import openpy |
|
67 | 67 | from IPython.utils.decorators import undoc |
|
68 | 68 | from IPython.utils.io import ask_yes_no |
|
69 | 69 | from IPython.utils.ipstruct import Struct |
|
70 | 70 | from IPython.paths import get_ipython_dir |
|
71 | 71 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
72 | 72 | from IPython.utils.process import system, getoutput |
|
73 | 73 | from IPython.utils.strdispatch import StrDispatch |
|
74 | 74 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
75 | 75 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
76 | 76 | from IPython.utils.tempdir import TemporaryDirectory |
|
77 | 77 | from traitlets import ( |
|
78 | 78 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
79 | 79 | observe, default, validate, Any |
|
80 | 80 | ) |
|
81 | 81 | from warnings import warn |
|
82 | 82 | from logging import error |
|
83 | 83 | import IPython.core.hooks |
|
84 | 84 | |
|
85 | 85 | from typing import List as ListType, Tuple, Optional |
|
86 | 86 | from ast import AST |
|
87 | 87 | |
|
88 | 88 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
89 | 89 | # See https://github.com/ipython/ipykernel/issues/157 |
|
90 | 90 | # (2016, let's try to remove than in IPython 8.0) |
|
91 | 91 | from IPython.utils.contexts import NoOpContext |
|
92 | 92 | |
|
93 | 93 | try: |
|
94 | 94 | import docrepr.sphinxify as sphx |
|
95 | 95 | |
|
96 | 96 | def sphinxify(doc): |
|
97 | 97 | with TemporaryDirectory() as dirname: |
|
98 | 98 | return { |
|
99 | 99 | 'text/html': sphx.sphinxify(doc, dirname), |
|
100 | 100 | 'text/plain': doc |
|
101 | 101 | } |
|
102 | 102 | except ImportError: |
|
103 | 103 | sphinxify = None |
|
104 | 104 | |
|
105 | 105 | |
|
106 | 106 | class ProvisionalWarning(DeprecationWarning): |
|
107 | 107 | """ |
|
108 | 108 | Warning class for unstable features |
|
109 | 109 | """ |
|
110 | 110 | pass |
|
111 | 111 | |
|
112 | 112 | if sys.version_info > (3,8): |
|
113 | 113 | from ast import Module |
|
114 | 114 | else : |
|
115 | 115 | # mock the new API, ignore second argument |
|
116 | 116 | # see https://github.com/ipython/ipython/issues/11590 |
|
117 | 117 | from ast import Module as OriginalModule |
|
118 | 118 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
119 | 119 | |
|
120 | 120 | if sys.version_info > (3,6): |
|
121 | 121 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
122 | 122 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
123 | 123 | else: |
|
124 | 124 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
125 | 125 | _single_targets_nodes = (ast.AugAssign, ) |
|
126 | 126 | |
|
127 | 127 | #----------------------------------------------------------------------------- |
|
128 | 128 | # Await Helpers |
|
129 | 129 | #----------------------------------------------------------------------------- |
|
130 | 130 | |
|
131 | 131 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: |
|
132 | 132 | """Return a function that do not create a new local scope. |
|
133 | 133 | |
|
134 | 134 | Given a function, create a clone of this function where the co_newlocal flag |
|
135 | 135 | has been removed, making this function code actually run in the sourounding |
|
136 | 136 | scope. |
|
137 | 137 | |
|
138 | 138 | We need this in order to run asynchronous code in user level namespace. |
|
139 | 139 | """ |
|
140 | 140 | from types import CodeType, FunctionType |
|
141 | 141 | CO_NEWLOCALS = 0x0002 |
|
142 | 142 | code = function.__code__ |
|
143 | 143 | new_co_flags = code.co_flags & ~CO_NEWLOCALS |
|
144 | 144 | if sys.version_info > (3, 8, 0, 'alpha', 3): |
|
145 | 145 | new_code = code.replace(co_flags=new_co_flags) |
|
146 | 146 | else: |
|
147 | 147 | new_code = CodeType( |
|
148 | 148 | code.co_argcount, |
|
149 | 149 | code.co_kwonlyargcount, |
|
150 | 150 | code.co_nlocals, |
|
151 | 151 | code.co_stacksize, |
|
152 | 152 | new_co_flags, |
|
153 | 153 | code.co_code, |
|
154 | 154 | code.co_consts, |
|
155 | 155 | code.co_names, |
|
156 | 156 | code.co_varnames, |
|
157 | 157 | code.co_filename, |
|
158 | 158 | code.co_name, |
|
159 | 159 | code.co_firstlineno, |
|
160 | 160 | code.co_lnotab, |
|
161 | 161 | code.co_freevars, |
|
162 | 162 | code.co_cellvars |
|
163 | 163 | ) |
|
164 | 164 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | # we still need to run things using the asyncio eventloop, but there is no |
|
168 | 168 | # async integration |
|
169 | 169 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) |
|
170 | 170 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: |
|
174 | 174 | """ |
|
175 | 175 | Parse a cell with top-level await and modify the AST to be able to run it later. |
|
176 | 176 | |
|
177 | 177 | Parameters |
|
178 | 178 | ---------- |
|
179 | 179 | cell: str |
|
180 | 180 | The code cell to asyncronify |
|
181 | 181 | wrapper_name: str |
|
182 | 182 | The name of the function to be used to wrap the passed `cell`. It is |
|
183 | 183 | advised to **not** use a python identifier in order to not pollute the |
|
184 | 184 | global namespace in which the function will be ran. |
|
185 | 185 | |
|
186 | 186 | Returns |
|
187 | 187 | ------- |
|
188 | 188 | ModuleType: |
|
189 | 189 | A module object AST containing **one** function named `wrapper_name`. |
|
190 | 190 | |
|
191 | 191 | The given code is wrapped in a async-def function, parsed into an AST, and |
|
192 | 192 | the resulting function definition AST is modified to return the last |
|
193 | 193 | expression. |
|
194 | 194 | |
|
195 | 195 | The last expression or await node is moved into a return statement at the |
|
196 | 196 | end of the function, and removed from its original location. If the last |
|
197 | 197 | node is not Expr or Await nothing is done. |
|
198 | 198 | |
|
199 | 199 | The function `__code__` will need to be later modified (by |
|
200 | 200 | ``removed_co_newlocals``) in a subsequent step to not create new `locals()` |
|
201 | 201 | meaning that the local and global scope are the same, ie as if the body of |
|
202 | 202 | the function was at module level. |
|
203 | 203 | |
|
204 | 204 | Lastly a call to `locals()` is made just before the last expression of the |
|
205 | 205 | function, or just after the last assignment or statement to make sure the |
|
206 | 206 | global dict is updated as python function work with a local fast cache which |
|
207 | 207 | is updated only on `local()` calls. |
|
208 | 208 | """ |
|
209 | 209 | |
|
210 | 210 | from ast import Expr, Await, Return |
|
211 | 211 | if sys.version_info >= (3,8): |
|
212 | 212 | return ast.parse(cell) |
|
213 | 213 | tree = ast.parse(_asyncify(cell)) |
|
214 | 214 | |
|
215 | 215 | function_def = tree.body[0] |
|
216 | 216 | function_def.name = wrapper_name |
|
217 | 217 | try_block = function_def.body[0] |
|
218 | 218 | lastexpr = try_block.body[-1] |
|
219 | 219 | if isinstance(lastexpr, (Expr, Await)): |
|
220 | 220 | try_block.body[-1] = Return(lastexpr.value) |
|
221 | 221 | ast.fix_missing_locations(tree) |
|
222 | 222 | return tree |
|
223 | 223 | #----------------------------------------------------------------------------- |
|
224 | 224 | # Globals |
|
225 | 225 | #----------------------------------------------------------------------------- |
|
226 | 226 | |
|
227 | 227 | # compiled regexps for autoindent management |
|
228 | 228 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
229 | 229 | |
|
230 | 230 | #----------------------------------------------------------------------------- |
|
231 | 231 | # Utilities |
|
232 | 232 | #----------------------------------------------------------------------------- |
|
233 | 233 | |
|
234 | 234 | @undoc |
|
235 | 235 | def softspace(file, newvalue): |
|
236 | 236 | """Copied from code.py, to remove the dependency""" |
|
237 | 237 | |
|
238 | 238 | oldvalue = 0 |
|
239 | 239 | try: |
|
240 | 240 | oldvalue = file.softspace |
|
241 | 241 | except AttributeError: |
|
242 | 242 | pass |
|
243 | 243 | try: |
|
244 | 244 | file.softspace = newvalue |
|
245 | 245 | except (AttributeError, TypeError): |
|
246 | 246 | # "attribute-less object" or "read-only attributes" |
|
247 | 247 | pass |
|
248 | 248 | return oldvalue |
|
249 | 249 | |
|
250 | 250 | @undoc |
|
251 | 251 | def no_op(*a, **kw): |
|
252 | 252 | pass |
|
253 | 253 | |
|
254 | 254 | |
|
255 | 255 | class SpaceInInput(Exception): pass |
|
256 | 256 | |
|
257 | 257 | |
|
258 | 258 | def get_default_colors(): |
|
259 | 259 | "DEPRECATED" |
|
260 | 260 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', |
|
261 | 261 | DeprecationWarning, stacklevel=2) |
|
262 | 262 | return 'Neutral' |
|
263 | 263 | |
|
264 | 264 | |
|
265 | 265 | class SeparateUnicode(Unicode): |
|
266 | 266 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
267 | 267 | |
|
268 | 268 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
269 | 269 | """ |
|
270 | 270 | |
|
271 | 271 | def validate(self, obj, value): |
|
272 | 272 | if value == '0': value = '' |
|
273 | 273 | value = value.replace('\\n','\n') |
|
274 | 274 | return super(SeparateUnicode, self).validate(obj, value) |
|
275 | 275 | |
|
276 | 276 | |
|
277 | 277 | @undoc |
|
278 | 278 | class DummyMod(object): |
|
279 | 279 | """A dummy module used for IPython's interactive module when |
|
280 | 280 | a namespace must be assigned to the module's __dict__.""" |
|
281 | 281 | __spec__ = None |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | class ExecutionInfo(object): |
|
285 | 285 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` |
|
286 | 286 | |
|
287 | 287 | Stores information about what is going to happen. |
|
288 | 288 | """ |
|
289 | 289 | raw_cell = None |
|
290 | 290 | store_history = False |
|
291 | 291 | silent = False |
|
292 | 292 | shell_futures = True |
|
293 | 293 | |
|
294 | 294 | def __init__(self, raw_cell, store_history, silent, shell_futures): |
|
295 | 295 | self.raw_cell = raw_cell |
|
296 | 296 | self.store_history = store_history |
|
297 | 297 | self.silent = silent |
|
298 | 298 | self.shell_futures = shell_futures |
|
299 | 299 | |
|
300 | 300 | def __repr__(self): |
|
301 | 301 | name = self.__class__.__qualname__ |
|
302 | 302 | raw_cell = ((self.raw_cell[:50] + '..') |
|
303 | 303 | if len(self.raw_cell) > 50 else self.raw_cell) |
|
304 | 304 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ |
|
305 | 305 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) |
|
306 | 306 | |
|
307 | 307 | |
|
308 | 308 | class ExecutionResult(object): |
|
309 | 309 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
310 | 310 | |
|
311 | 311 | Stores information about what took place. |
|
312 | 312 | """ |
|
313 | 313 | execution_count = None |
|
314 | 314 | error_before_exec = None |
|
315 | 315 | error_in_exec = None |
|
316 | 316 | info = None |
|
317 | 317 | result = None |
|
318 | 318 | |
|
319 | 319 | def __init__(self, info): |
|
320 | 320 | self.info = info |
|
321 | 321 | |
|
322 | 322 | @property |
|
323 | 323 | def success(self): |
|
324 | 324 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
325 | 325 | |
|
326 | 326 | def raise_error(self): |
|
327 | 327 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
328 | 328 | if self.error_before_exec is not None: |
|
329 | 329 | raise self.error_before_exec |
|
330 | 330 | if self.error_in_exec is not None: |
|
331 | 331 | raise self.error_in_exec |
|
332 | 332 | |
|
333 | 333 | def __repr__(self): |
|
334 | 334 | name = self.__class__.__qualname__ |
|
335 | 335 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ |
|
336 | 336 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) |
|
337 | 337 | |
|
338 | 338 | |
|
339 | 339 | class InteractiveShell(SingletonConfigurable): |
|
340 | 340 | """An enhanced, interactive shell for Python.""" |
|
341 | 341 | |
|
342 | 342 | _instance = None |
|
343 | 343 | |
|
344 | 344 | ast_transformers = List([], help= |
|
345 | 345 | """ |
|
346 | 346 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
347 | 347 | to user input before code is run. |
|
348 | 348 | """ |
|
349 | 349 | ).tag(config=True) |
|
350 | 350 | |
|
351 | 351 | autocall = Enum((0,1,2), default_value=0, help= |
|
352 | 352 | """ |
|
353 | 353 | Make IPython automatically call any callable object even if you didn't |
|
354 | 354 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
355 | 355 | automatically. The value can be '0' to disable the feature, '1' for |
|
356 | 356 | 'smart' autocall, where it is not applied if there are no more |
|
357 | 357 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
358 | 358 | objects are automatically called (even if no arguments are present). |
|
359 | 359 | """ |
|
360 | 360 | ).tag(config=True) |
|
361 | 361 | |
|
362 | 362 | autoindent = Bool(True, help= |
|
363 | 363 | """ |
|
364 | 364 | Autoindent IPython code entered interactively. |
|
365 | 365 | """ |
|
366 | 366 | ).tag(config=True) |
|
367 | 367 | |
|
368 | 368 | autoawait = Bool(True, help= |
|
369 | 369 | """ |
|
370 | 370 | Automatically run await statement in the top level repl. |
|
371 | 371 | """ |
|
372 | 372 | ).tag(config=True) |
|
373 | 373 | |
|
374 | 374 | loop_runner_map ={ |
|
375 | 375 | 'asyncio':(_asyncio_runner, True), |
|
376 | 376 | 'curio':(_curio_runner, True), |
|
377 | 377 | 'trio':(_trio_runner, True), |
|
378 | 378 | 'sync': (_pseudo_sync_runner, False) |
|
379 | 379 | } |
|
380 | 380 | |
|
381 | 381 | loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner", |
|
382 | 382 | allow_none=True, |
|
383 | 383 | help="""Select the loop runner that will be used to execute top-level asynchronous code""" |
|
384 | 384 | ).tag(config=True) |
|
385 | 385 | |
|
386 | 386 | @default('loop_runner') |
|
387 | 387 | def _default_loop_runner(self): |
|
388 | 388 | return import_item("IPython.core.interactiveshell._asyncio_runner") |
|
389 | 389 | |
|
390 | 390 | @validate('loop_runner') |
|
391 | 391 | def _import_runner(self, proposal): |
|
392 | 392 | if isinstance(proposal.value, str): |
|
393 | 393 | if proposal.value in self.loop_runner_map: |
|
394 | 394 | runner, autoawait = self.loop_runner_map[proposal.value] |
|
395 | 395 | self.autoawait = autoawait |
|
396 | 396 | return runner |
|
397 | 397 | runner = import_item(proposal.value) |
|
398 | 398 | if not callable(runner): |
|
399 | 399 | raise ValueError('loop_runner must be callable') |
|
400 | 400 | return runner |
|
401 | 401 | if not callable(proposal.value): |
|
402 | 402 | raise ValueError('loop_runner must be callable') |
|
403 | 403 | return proposal.value |
|
404 | 404 | |
|
405 | 405 | automagic = Bool(True, help= |
|
406 | 406 | """ |
|
407 | 407 | Enable magic commands to be called without the leading %. |
|
408 | 408 | """ |
|
409 | 409 | ).tag(config=True) |
|
410 | 410 | |
|
411 | 411 | banner1 = Unicode(default_banner, |
|
412 | 412 | help="""The part of the banner to be printed before the profile""" |
|
413 | 413 | ).tag(config=True) |
|
414 | 414 | banner2 = Unicode('', |
|
415 | 415 | help="""The part of the banner to be printed after the profile""" |
|
416 | 416 | ).tag(config=True) |
|
417 | 417 | |
|
418 | 418 | cache_size = Integer(1000, help= |
|
419 | 419 | """ |
|
420 | 420 | Set the size of the output cache. The default is 1000, you can |
|
421 | 421 | change it permanently in your config file. Setting it to 0 completely |
|
422 | 422 | disables the caching system, and the minimum value accepted is 3 (if |
|
423 | 423 | you provide a value less than 3, it is reset to 0 and a warning is |
|
424 | 424 | issued). This limit is defined because otherwise you'll spend more |
|
425 | 425 | time re-flushing a too small cache than working |
|
426 | 426 | """ |
|
427 | 427 | ).tag(config=True) |
|
428 | 428 | color_info = Bool(True, help= |
|
429 | 429 | """ |
|
430 | 430 | Use colors for displaying information about objects. Because this |
|
431 | 431 | information is passed through a pager (like 'less'), and some pagers |
|
432 | 432 | get confused with color codes, this capability can be turned off. |
|
433 | 433 | """ |
|
434 | 434 | ).tag(config=True) |
|
435 | 435 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
436 | 436 | default_value='Neutral', |
|
437 | 437 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
438 | 438 | ).tag(config=True) |
|
439 | 439 | debug = Bool(False).tag(config=True) |
|
440 | 440 | disable_failing_post_execute = Bool(False, |
|
441 | 441 | help="Don't call post-execute functions that have failed in the past." |
|
442 | 442 | ).tag(config=True) |
|
443 | 443 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
444 | 444 | displayhook_class = Type(DisplayHook) |
|
445 | 445 | display_pub_class = Type(DisplayPublisher) |
|
446 | 446 | compiler_class = Type(CachingCompiler) |
|
447 | 447 | |
|
448 | 448 | sphinxify_docstring = Bool(False, help= |
|
449 | 449 | """ |
|
450 | 450 | Enables rich html representation of docstrings. (This requires the |
|
451 | 451 | docrepr module). |
|
452 | 452 | """).tag(config=True) |
|
453 | 453 | |
|
454 | 454 | @observe("sphinxify_docstring") |
|
455 | 455 | def _sphinxify_docstring_changed(self, change): |
|
456 | 456 | if change['new']: |
|
457 | 457 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
458 | 458 | |
|
459 | 459 | enable_html_pager = Bool(False, help= |
|
460 | 460 | """ |
|
461 | 461 | (Provisional API) enables html representation in mime bundles sent |
|
462 | 462 | to pagers. |
|
463 | 463 | """).tag(config=True) |
|
464 | 464 | |
|
465 | 465 | @observe("enable_html_pager") |
|
466 | 466 | def _enable_html_pager_changed(self, change): |
|
467 | 467 | if change['new']: |
|
468 | 468 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
469 | 469 | |
|
470 | 470 | data_pub_class = None |
|
471 | 471 | |
|
472 | 472 | exit_now = Bool(False) |
|
473 | 473 | exiter = Instance(ExitAutocall) |
|
474 | 474 | @default('exiter') |
|
475 | 475 | def _exiter_default(self): |
|
476 | 476 | return ExitAutocall(self) |
|
477 | 477 | # Monotonically increasing execution counter |
|
478 | 478 | execution_count = Integer(1) |
|
479 | 479 | filename = Unicode("<ipython console>") |
|
480 | 480 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
481 | 481 | |
|
482 | 482 | # Used to transform cells before running them, and check whether code is complete |
|
483 | 483 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', |
|
484 | 484 | ()) |
|
485 | 485 | |
|
486 | 486 | @property |
|
487 | 487 | def input_transformers_cleanup(self): |
|
488 | 488 | return self.input_transformer_manager.cleanup_transforms |
|
489 | 489 | |
|
490 | 490 | input_transformers_post = List([], |
|
491 | 491 | help="A list of string input transformers, to be applied after IPython's " |
|
492 | 492 | "own input transformations." |
|
493 | 493 | ) |
|
494 | 494 | |
|
495 | 495 | @property |
|
496 | 496 | def input_splitter(self): |
|
497 | 497 | """Make this available for backward compatibility (pre-7.0 release) with existing code. |
|
498 | 498 | |
|
499 | 499 | For example, ipykernel ipykernel currently uses |
|
500 | 500 | `shell.input_splitter.check_complete` |
|
501 | 501 | """ |
|
502 | 502 | from warnings import warn |
|
503 | 503 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", |
|
504 | 504 | DeprecationWarning, stacklevel=2 |
|
505 | 505 | ) |
|
506 | 506 | return self.input_transformer_manager |
|
507 | 507 | |
|
508 | 508 | logstart = Bool(False, help= |
|
509 | 509 | """ |
|
510 | 510 | Start logging to the default log file in overwrite mode. |
|
511 | 511 | Use `logappend` to specify a log file to **append** logs to. |
|
512 | 512 | """ |
|
513 | 513 | ).tag(config=True) |
|
514 | 514 | logfile = Unicode('', help= |
|
515 | 515 | """ |
|
516 | 516 | The name of the logfile to use. |
|
517 | 517 | """ |
|
518 | 518 | ).tag(config=True) |
|
519 | 519 | logappend = Unicode('', help= |
|
520 | 520 | """ |
|
521 | 521 | Start logging to the given file in append mode. |
|
522 | 522 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
523 | 523 | """ |
|
524 | 524 | ).tag(config=True) |
|
525 | 525 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
526 | 526 | ).tag(config=True) |
|
527 | 527 | pdb = Bool(False, help= |
|
528 | 528 | """ |
|
529 | 529 | Automatically call the pdb debugger after every exception. |
|
530 | 530 | """ |
|
531 | 531 | ).tag(config=True) |
|
532 | 532 | display_page = Bool(False, |
|
533 | 533 | help="""If True, anything that would be passed to the pager |
|
534 | 534 | will be displayed as regular output instead.""" |
|
535 | 535 | ).tag(config=True) |
|
536 | 536 | |
|
537 | 537 | # deprecated prompt traits: |
|
538 | 538 | |
|
539 | 539 | prompt_in1 = Unicode('In [\\#]: ', |
|
540 | 540 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
541 | 541 | ).tag(config=True) |
|
542 | 542 | prompt_in2 = Unicode(' .\\D.: ', |
|
543 | 543 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
544 | 544 | ).tag(config=True) |
|
545 | 545 | prompt_out = Unicode('Out[\\#]: ', |
|
546 | 546 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
547 | 547 | ).tag(config=True) |
|
548 | 548 | prompts_pad_left = Bool(True, |
|
549 | 549 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
550 | 550 | ).tag(config=True) |
|
551 | 551 | |
|
552 | 552 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
553 | 553 | def _prompt_trait_changed(self, change): |
|
554 | 554 | name = change['name'] |
|
555 | 555 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
556 | 556 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
557 | 557 | " object directly.".format(name=name)) |
|
558 | 558 | |
|
559 | 559 | # protect against weird cases where self.config may not exist: |
|
560 | 560 | |
|
561 | 561 | show_rewritten_input = Bool(True, |
|
562 | 562 | help="Show rewritten input, e.g. for autocall." |
|
563 | 563 | ).tag(config=True) |
|
564 | 564 | |
|
565 | 565 | quiet = Bool(False).tag(config=True) |
|
566 | 566 | |
|
567 | 567 | history_length = Integer(10000, |
|
568 | 568 | help='Total length of command history' |
|
569 | 569 | ).tag(config=True) |
|
570 | 570 | |
|
571 | 571 | history_load_length = Integer(1000, help= |
|
572 | 572 | """ |
|
573 | 573 | The number of saved history entries to be loaded |
|
574 | 574 | into the history buffer at startup. |
|
575 | 575 | """ |
|
576 | 576 | ).tag(config=True) |
|
577 | 577 | |
|
578 | 578 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
579 | 579 | default_value='last_expr', |
|
580 | 580 | help=""" |
|
581 | 581 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
582 | 582 | which nodes should be run interactively (displaying output from expressions). |
|
583 | 583 | """ |
|
584 | 584 | ).tag(config=True) |
|
585 | 585 | |
|
586 | 586 | # TODO: this part of prompt management should be moved to the frontends. |
|
587 | 587 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
588 | 588 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
589 | 589 | separate_out = SeparateUnicode('').tag(config=True) |
|
590 | 590 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
591 | 591 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
592 | 592 | xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'), |
|
593 | 593 | default_value='Context', |
|
594 | 594 | help="Switch modes for the IPython exception handlers." |
|
595 | 595 | ).tag(config=True) |
|
596 | 596 | |
|
597 | 597 | # Subcomponents of InteractiveShell |
|
598 | 598 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
599 | 599 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
600 | 600 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
601 | 601 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
602 | 602 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
603 | 603 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
604 | 604 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
605 | 605 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
606 | 606 | |
|
607 | 607 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
608 | 608 | @property |
|
609 | 609 | def profile(self): |
|
610 | 610 | if self.profile_dir is not None: |
|
611 | 611 | name = os.path.basename(self.profile_dir.location) |
|
612 | 612 | return name.replace('profile_','') |
|
613 | 613 | |
|
614 | 614 | |
|
615 | 615 | # Private interface |
|
616 | 616 | _post_execute = Dict() |
|
617 | 617 | |
|
618 | 618 | # Tracks any GUI loop loaded for pylab |
|
619 | 619 | pylab_gui_select = None |
|
620 | 620 | |
|
621 | 621 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
622 | 622 | |
|
623 | 623 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
624 | 624 | |
|
625 | 625 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
626 | 626 | user_module=None, user_ns=None, |
|
627 | 627 | custom_exceptions=((), None), **kwargs): |
|
628 | 628 | |
|
629 | 629 | # This is where traits with a config_key argument are updated |
|
630 | 630 | # from the values on config. |
|
631 | 631 | super(InteractiveShell, self).__init__(**kwargs) |
|
632 | 632 | if 'PromptManager' in self.config: |
|
633 | 633 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
634 | 634 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
635 | 635 | self.configurables = [self] |
|
636 | 636 | |
|
637 | 637 | # These are relatively independent and stateless |
|
638 | 638 | self.init_ipython_dir(ipython_dir) |
|
639 | 639 | self.init_profile_dir(profile_dir) |
|
640 | 640 | self.init_instance_attrs() |
|
641 | 641 | self.init_environment() |
|
642 | 642 | |
|
643 | 643 | # Check if we're in a virtualenv, and set up sys.path. |
|
644 | 644 | self.init_virtualenv() |
|
645 | 645 | |
|
646 | 646 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
647 | 647 | self.init_create_namespaces(user_module, user_ns) |
|
648 | 648 | # This has to be done after init_create_namespaces because it uses |
|
649 | 649 | # something in self.user_ns, but before init_sys_modules, which |
|
650 | 650 | # is the first thing to modify sys. |
|
651 | 651 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
652 | 652 | # is created, we are saving the overridden ones here. Not sure if this |
|
653 | 653 | # is what we want to do. |
|
654 | 654 | self.save_sys_module_state() |
|
655 | 655 | self.init_sys_modules() |
|
656 | 656 | |
|
657 | 657 | # While we're trying to have each part of the code directly access what |
|
658 | 658 | # it needs without keeping redundant references to objects, we have too |
|
659 | 659 | # much legacy code that expects ip.db to exist. |
|
660 | 660 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
661 | 661 | |
|
662 | 662 | self.init_history() |
|
663 | 663 | self.init_encoding() |
|
664 | 664 | self.init_prefilter() |
|
665 | 665 | |
|
666 | 666 | self.init_syntax_highlighting() |
|
667 | 667 | self.init_hooks() |
|
668 | 668 | self.init_events() |
|
669 | 669 | self.init_pushd_popd_magic() |
|
670 | 670 | self.init_user_ns() |
|
671 | 671 | self.init_logger() |
|
672 | 672 | self.init_builtins() |
|
673 | 673 | |
|
674 | 674 | # The following was in post_config_initialization |
|
675 | 675 | self.init_inspector() |
|
676 | 676 | self.raw_input_original = input |
|
677 | 677 | self.init_completer() |
|
678 | 678 | # TODO: init_io() needs to happen before init_traceback handlers |
|
679 | 679 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
680 | 680 | # This logic in in debugger.Pdb and should eventually be changed. |
|
681 | 681 | self.init_io() |
|
682 | 682 | self.init_traceback_handlers(custom_exceptions) |
|
683 | 683 | self.init_prompts() |
|
684 | 684 | self.init_display_formatter() |
|
685 | 685 | self.init_display_pub() |
|
686 | 686 | self.init_data_pub() |
|
687 | 687 | self.init_displayhook() |
|
688 | 688 | self.init_magics() |
|
689 | 689 | self.init_alias() |
|
690 | 690 | self.init_logstart() |
|
691 | 691 | self.init_pdb() |
|
692 | 692 | self.init_extension_manager() |
|
693 | 693 | self.init_payload() |
|
694 | 694 | self.init_deprecation_warnings() |
|
695 | 695 | self.hooks.late_startup_hook() |
|
696 | 696 | self.events.trigger('shell_initialized', self) |
|
697 | 697 | atexit.register(self.atexit_operations) |
|
698 | 698 | |
|
699 | 699 | # The trio runner is used for running Trio in the foreground thread. It |
|
700 | 700 | # is different from `_trio_runner(async_fn)` in `async_helpers.py` |
|
701 | 701 | # which calls `trio.run()` for every cell. This runner runs all cells |
|
702 | 702 | # inside a single Trio event loop. If used, it is set from |
|
703 | 703 | # `ipykernel.kernelapp`. |
|
704 | 704 | self.trio_runner = None |
|
705 | 705 | |
|
706 | 706 | def get_ipython(self): |
|
707 | 707 | """Return the currently running IPython instance.""" |
|
708 | 708 | return self |
|
709 | 709 | |
|
710 | 710 | #------------------------------------------------------------------------- |
|
711 | 711 | # Trait changed handlers |
|
712 | 712 | #------------------------------------------------------------------------- |
|
713 | 713 | @observe('ipython_dir') |
|
714 | 714 | def _ipython_dir_changed(self, change): |
|
715 | 715 | ensure_dir_exists(change['new']) |
|
716 | 716 | |
|
717 | 717 | def set_autoindent(self,value=None): |
|
718 | 718 | """Set the autoindent flag. |
|
719 | 719 | |
|
720 | 720 | If called with no arguments, it acts as a toggle.""" |
|
721 | 721 | if value is None: |
|
722 | 722 | self.autoindent = not self.autoindent |
|
723 | 723 | else: |
|
724 | 724 | self.autoindent = value |
|
725 | 725 | |
|
726 | 726 | def set_trio_runner(self, tr): |
|
727 | 727 | self.trio_runner = tr |
|
728 | 728 | |
|
729 | 729 | #------------------------------------------------------------------------- |
|
730 | 730 | # init_* methods called by __init__ |
|
731 | 731 | #------------------------------------------------------------------------- |
|
732 | 732 | |
|
733 | 733 | def init_ipython_dir(self, ipython_dir): |
|
734 | 734 | if ipython_dir is not None: |
|
735 | 735 | self.ipython_dir = ipython_dir |
|
736 | 736 | return |
|
737 | 737 | |
|
738 | 738 | self.ipython_dir = get_ipython_dir() |
|
739 | 739 | |
|
740 | 740 | def init_profile_dir(self, profile_dir): |
|
741 | 741 | if profile_dir is not None: |
|
742 | 742 | self.profile_dir = profile_dir |
|
743 | 743 | return |
|
744 | 744 | self.profile_dir = ProfileDir.create_profile_dir_by_name( |
|
745 | 745 | self.ipython_dir, "default" |
|
746 | 746 | ) |
|
747 | 747 | |
|
748 | 748 | def init_instance_attrs(self): |
|
749 | 749 | self.more = False |
|
750 | 750 | |
|
751 | 751 | # command compiler |
|
752 | 752 | self.compile = self.compiler_class() |
|
753 | 753 | |
|
754 | 754 | # Make an empty namespace, which extension writers can rely on both |
|
755 | 755 | # existing and NEVER being used by ipython itself. This gives them a |
|
756 | 756 | # convenient location for storing additional information and state |
|
757 | 757 | # their extensions may require, without fear of collisions with other |
|
758 | 758 | # ipython names that may develop later. |
|
759 | 759 | self.meta = Struct() |
|
760 | 760 | |
|
761 | 761 | # Temporary files used for various purposes. Deleted at exit. |
|
762 | 762 | # The files here are stored with Path from Pathlib |
|
763 | 763 | self.tempfiles = [] |
|
764 | 764 | self.tempdirs = [] |
|
765 | 765 | |
|
766 | 766 | # keep track of where we started running (mainly for crash post-mortem) |
|
767 | 767 | # This is not being used anywhere currently. |
|
768 | 768 | self.starting_dir = os.getcwd() |
|
769 | 769 | |
|
770 | 770 | # Indentation management |
|
771 | 771 | self.indent_current_nsp = 0 |
|
772 | 772 | |
|
773 | 773 | # Dict to track post-execution functions that have been registered |
|
774 | 774 | self._post_execute = {} |
|
775 | 775 | |
|
776 | 776 | def init_environment(self): |
|
777 | 777 | """Any changes we need to make to the user's environment.""" |
|
778 | 778 | pass |
|
779 | 779 | |
|
780 | 780 | def init_encoding(self): |
|
781 | 781 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
782 | 782 | # under Win32 have it set to None, and we need to have a known valid |
|
783 | 783 | # encoding to use in the raw_input() method |
|
784 | 784 | try: |
|
785 | 785 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
786 | 786 | except AttributeError: |
|
787 | 787 | self.stdin_encoding = 'ascii' |
|
788 | 788 | |
|
789 | 789 | |
|
790 | 790 | @observe('colors') |
|
791 | 791 | def init_syntax_highlighting(self, changes=None): |
|
792 | 792 | # Python source parser/formatter for syntax highlighting |
|
793 | 793 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
794 | 794 | self.pycolorize = lambda src: pyformat(src,'str') |
|
795 | 795 | |
|
796 | 796 | def refresh_style(self): |
|
797 | 797 | # No-op here, used in subclass |
|
798 | 798 | pass |
|
799 | 799 | |
|
800 | 800 | def init_pushd_popd_magic(self): |
|
801 | 801 | # for pushd/popd management |
|
802 | 802 | self.home_dir = get_home_dir() |
|
803 | 803 | |
|
804 | 804 | self.dir_stack = [] |
|
805 | 805 | |
|
806 | 806 | def init_logger(self): |
|
807 | 807 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
808 | 808 | logmode='rotate') |
|
809 | 809 | |
|
810 | 810 | def init_logstart(self): |
|
811 | 811 | """Initialize logging in case it was requested at the command line. |
|
812 | 812 | """ |
|
813 | 813 | if self.logappend: |
|
814 | 814 | self.magic('logstart %s append' % self.logappend) |
|
815 | 815 | elif self.logfile: |
|
816 | 816 | self.magic('logstart %s' % self.logfile) |
|
817 | 817 | elif self.logstart: |
|
818 | 818 | self.magic('logstart') |
|
819 | 819 | |
|
820 | 820 | def init_deprecation_warnings(self): |
|
821 | 821 | """ |
|
822 | 822 | register default filter for deprecation warning. |
|
823 | 823 | |
|
824 | 824 | This will allow deprecation warning of function used interactively to show |
|
825 | 825 | warning to users, and still hide deprecation warning from libraries import. |
|
826 | 826 | """ |
|
827 | 827 | if sys.version_info < (3,7): |
|
828 | 828 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
829 | 829 | |
|
830 | 830 | |
|
831 | 831 | def init_builtins(self): |
|
832 | 832 | # A single, static flag that we set to True. Its presence indicates |
|
833 | 833 | # that an IPython shell has been created, and we make no attempts at |
|
834 | 834 | # removing on exit or representing the existence of more than one |
|
835 | 835 | # IPython at a time. |
|
836 | 836 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
837 | 837 | builtin_mod.__dict__['display'] = display |
|
838 | 838 | |
|
839 | 839 | self.builtin_trap = BuiltinTrap(shell=self) |
|
840 | 840 | |
|
841 | 841 | @observe('colors') |
|
842 | 842 | def init_inspector(self, changes=None): |
|
843 | 843 | # Object inspector |
|
844 | 844 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
845 | 845 | PyColorize.ANSICodeColors, |
|
846 | 846 | self.colors, |
|
847 | 847 | self.object_info_string_level) |
|
848 | 848 | |
|
849 | 849 | def init_io(self): |
|
850 | 850 | # This will just use sys.stdout and sys.stderr. If you want to |
|
851 | 851 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
852 | 852 | # *before* instantiating this class, because io holds onto |
|
853 | 853 | # references to the underlying streams. |
|
854 | 854 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
855 | 855 | # during initialization of the deprecated API. |
|
856 | 856 | with warnings.catch_warnings(): |
|
857 | 857 | warnings.simplefilter('ignore', DeprecationWarning) |
|
858 | 858 | io.stdout = io.IOStream(sys.stdout) |
|
859 | 859 | io.stderr = io.IOStream(sys.stderr) |
|
860 | 860 | |
|
861 | 861 | def init_prompts(self): |
|
862 | 862 | # Set system prompts, so that scripts can decide if they are running |
|
863 | 863 | # interactively. |
|
864 | 864 | sys.ps1 = 'In : ' |
|
865 | 865 | sys.ps2 = '...: ' |
|
866 | 866 | sys.ps3 = 'Out: ' |
|
867 | 867 | |
|
868 | 868 | def init_display_formatter(self): |
|
869 | 869 | self.display_formatter = DisplayFormatter(parent=self) |
|
870 | 870 | self.configurables.append(self.display_formatter) |
|
871 | 871 | |
|
872 | 872 | def init_display_pub(self): |
|
873 | 873 | self.display_pub = self.display_pub_class(parent=self, shell=self) |
|
874 | 874 | self.configurables.append(self.display_pub) |
|
875 | 875 | |
|
876 | 876 | def init_data_pub(self): |
|
877 | 877 | if not self.data_pub_class: |
|
878 | 878 | self.data_pub = None |
|
879 | 879 | return |
|
880 | 880 | self.data_pub = self.data_pub_class(parent=self) |
|
881 | 881 | self.configurables.append(self.data_pub) |
|
882 | 882 | |
|
883 | 883 | def init_displayhook(self): |
|
884 | 884 | # Initialize displayhook, set in/out prompts and printing system |
|
885 | 885 | self.displayhook = self.displayhook_class( |
|
886 | 886 | parent=self, |
|
887 | 887 | shell=self, |
|
888 | 888 | cache_size=self.cache_size, |
|
889 | 889 | ) |
|
890 | 890 | self.configurables.append(self.displayhook) |
|
891 | 891 | # This is a context manager that installs/revmoes the displayhook at |
|
892 | 892 | # the appropriate time. |
|
893 | 893 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
894 | 894 | |
|
895 | 895 | def init_virtualenv(self): |
|
896 | 896 | """Add the current virtualenv to sys.path so the user can import modules from it. |
|
897 | 897 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
898 | 898 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
899 | 899 | warning will appear suggesting the user installs IPython in the |
|
900 | 900 | virtualenv, but for many cases, it probably works well enough. |
|
901 | 901 | |
|
902 | 902 | Adapted from code snippets online. |
|
903 | 903 | |
|
904 | 904 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
905 | 905 | """ |
|
906 | 906 | if 'VIRTUAL_ENV' not in os.environ: |
|
907 | 907 | # Not in a virtualenv |
|
908 | 908 | return |
|
909 | 909 | elif os.environ["VIRTUAL_ENV"] == "": |
|
910 | 910 | warn("Virtual env path set to '', please check if this is intended.") |
|
911 | 911 | return |
|
912 | 912 | |
|
913 | 913 | p = Path(sys.executable) |
|
914 | 914 | p_venv = Path(os.environ["VIRTUAL_ENV"]) |
|
915 | 915 | |
|
916 | 916 | # fallback venv detection: |
|
917 | 917 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
918 | 918 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
919 | 919 | # So we just check every item in the symlink tree (generally <= 3) |
|
920 | 920 | paths = [p] |
|
921 | 921 | while p.is_symlink(): |
|
922 | 922 | p = Path(os.readlink(p)) |
|
923 | 923 | paths.append(p.resolve()) |
|
924 | 924 | |
|
925 | 925 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
926 | 926 | if str(p_venv).startswith("\\cygdrive"): |
|
927 | 927 | p_venv = Path(str(p_venv)[11:]) |
|
928 | 928 | elif len(str(p_venv)) >= 2 and str(p_venv)[1] == ":": |
|
929 | 929 | p_venv = Path(str(p_venv)[2:]) |
|
930 | 930 | |
|
931 | 931 | if any(os.fspath(p_venv) in os.fspath(p) for p in paths): |
|
932 | 932 | # Our exe is inside or has access to the virtualenv, don't need to do anything. |
|
933 | 933 | return |
|
934 | 934 | |
|
935 | 935 | if sys.platform == "win32": |
|
936 | 936 | virtual_env = Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages") |
|
937 | 937 | else: |
|
938 | 938 | virtual_env_path = Path( |
|
939 | 939 | os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages" |
|
940 | 940 | ) |
|
941 | 941 | p_ver = sys.version_info[:2] |
|
942 | 942 | |
|
943 | 943 | # Predict version from py[thon]-x.x in the $VIRTUAL_ENV |
|
944 | 944 | re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"]) |
|
945 | 945 | if re_m: |
|
946 | 946 | predicted_path = Path(str(virtual_env_path).format(*re_m.groups())) |
|
947 | 947 | if predicted_path.exists(): |
|
948 | 948 | p_ver = re_m.groups() |
|
949 | 949 | |
|
950 | 950 | virtual_env = str(virtual_env_path).format(*p_ver) |
|
951 | 951 | |
|
952 | 952 | warn( |
|
953 | 953 | "Attempting to work in a virtualenv. If you encounter problems, " |
|
954 | 954 | "please install IPython inside the virtualenv." |
|
955 | 955 | ) |
|
956 | 956 | import site |
|
957 | 957 | sys.path.insert(0, virtual_env) |
|
958 | 958 | site.addsitedir(virtual_env) |
|
959 | 959 | |
|
960 | 960 | #------------------------------------------------------------------------- |
|
961 | 961 | # Things related to injections into the sys module |
|
962 | 962 | #------------------------------------------------------------------------- |
|
963 | 963 | |
|
964 | 964 | def save_sys_module_state(self): |
|
965 | 965 | """Save the state of hooks in the sys module. |
|
966 | 966 | |
|
967 | 967 | This has to be called after self.user_module is created. |
|
968 | 968 | """ |
|
969 | 969 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
970 | 970 | 'stdout': sys.stdout, |
|
971 | 971 | 'stderr': sys.stderr, |
|
972 | 972 | 'excepthook': sys.excepthook} |
|
973 | 973 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
974 | 974 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
975 | 975 | |
|
976 | 976 | def restore_sys_module_state(self): |
|
977 | 977 | """Restore the state of the sys module.""" |
|
978 | 978 | try: |
|
979 | 979 | for k, v in self._orig_sys_module_state.items(): |
|
980 | 980 | setattr(sys, k, v) |
|
981 | 981 | except AttributeError: |
|
982 | 982 | pass |
|
983 | 983 | # Reset what what done in self.init_sys_modules |
|
984 | 984 | if self._orig_sys_modules_main_mod is not None: |
|
985 | 985 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
986 | 986 | |
|
987 | 987 | #------------------------------------------------------------------------- |
|
988 | 988 | # Things related to the banner |
|
989 | 989 | #------------------------------------------------------------------------- |
|
990 | 990 | |
|
991 | 991 | @property |
|
992 | 992 | def banner(self): |
|
993 | 993 | banner = self.banner1 |
|
994 | 994 | if self.profile and self.profile != 'default': |
|
995 | 995 | banner += '\nIPython profile: %s\n' % self.profile |
|
996 | 996 | if self.banner2: |
|
997 | 997 | banner += '\n' + self.banner2 |
|
998 | 998 | return banner |
|
999 | 999 | |
|
1000 | 1000 | def show_banner(self, banner=None): |
|
1001 | 1001 | if banner is None: |
|
1002 | 1002 | banner = self.banner |
|
1003 | 1003 | sys.stdout.write(banner) |
|
1004 | 1004 | |
|
1005 | 1005 | #------------------------------------------------------------------------- |
|
1006 | 1006 | # Things related to hooks |
|
1007 | 1007 | #------------------------------------------------------------------------- |
|
1008 | 1008 | |
|
1009 | 1009 | def init_hooks(self): |
|
1010 | 1010 | # hooks holds pointers used for user-side customizations |
|
1011 | 1011 | self.hooks = Struct() |
|
1012 | 1012 | |
|
1013 | 1013 | self.strdispatchers = {} |
|
1014 | 1014 | |
|
1015 | 1015 | # Set all default hooks, defined in the IPython.hooks module. |
|
1016 | 1016 | hooks = IPython.core.hooks |
|
1017 | 1017 | for hook_name in hooks.__all__: |
|
1018 | 1018 | # default hooks have priority 100, i.e. low; user hooks should have |
|
1019 | 1019 | # 0-100 priority |
|
1020 | 1020 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
1021 | 1021 | |
|
1022 | 1022 | if self.display_page: |
|
1023 | 1023 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
1024 | 1024 | |
|
1025 | 1025 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
1026 | 1026 | _warn_deprecated=True): |
|
1027 | 1027 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1028 | 1028 | |
|
1029 | 1029 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1030 | 1030 | adding your function to one of these hooks, you can modify IPython's |
|
1031 | 1031 | behavior to call at runtime your own routines.""" |
|
1032 | 1032 | |
|
1033 | 1033 | # At some point in the future, this should validate the hook before it |
|
1034 | 1034 | # accepts it. Probably at least check that the hook takes the number |
|
1035 | 1035 | # of args it's supposed to. |
|
1036 | 1036 | |
|
1037 | 1037 | f = types.MethodType(hook,self) |
|
1038 | 1038 | |
|
1039 | 1039 | # check if the hook is for strdispatcher first |
|
1040 | 1040 | if str_key is not None: |
|
1041 | 1041 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1042 | 1042 | sdp.add_s(str_key, f, priority ) |
|
1043 | 1043 | self.strdispatchers[name] = sdp |
|
1044 | 1044 | return |
|
1045 | 1045 | if re_key is not None: |
|
1046 | 1046 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1047 | 1047 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1048 | 1048 | self.strdispatchers[name] = sdp |
|
1049 | 1049 | return |
|
1050 | 1050 | |
|
1051 | 1051 | dp = getattr(self.hooks, name, None) |
|
1052 | 1052 | if name not in IPython.core.hooks.__all__: |
|
1053 | 1053 | print("Warning! Hook '%s' is not one of %s" % \ |
|
1054 | 1054 | (name, IPython.core.hooks.__all__ )) |
|
1055 | 1055 | |
|
1056 | 1056 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
1057 | 1057 | alternative = IPython.core.hooks.deprecated[name] |
|
1058 | 1058 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
1059 | 1059 | |
|
1060 | 1060 | if not dp: |
|
1061 | 1061 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1062 | 1062 | |
|
1063 | 1063 | try: |
|
1064 | 1064 | dp.add(f,priority) |
|
1065 | 1065 | except AttributeError: |
|
1066 | 1066 | # it was not commandchain, plain old func - replace |
|
1067 | 1067 | dp = f |
|
1068 | 1068 | |
|
1069 | 1069 | setattr(self.hooks,name, dp) |
|
1070 | 1070 | |
|
1071 | 1071 | #------------------------------------------------------------------------- |
|
1072 | 1072 | # Things related to events |
|
1073 | 1073 | #------------------------------------------------------------------------- |
|
1074 | 1074 | |
|
1075 | 1075 | def init_events(self): |
|
1076 | 1076 | self.events = EventManager(self, available_events) |
|
1077 | 1077 | |
|
1078 | 1078 | self.events.register("pre_execute", self._clear_warning_registry) |
|
1079 | 1079 | |
|
1080 | 1080 | def register_post_execute(self, func): |
|
1081 | 1081 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
1082 | 1082 | |
|
1083 | 1083 | Register a function for calling after code execution. |
|
1084 | 1084 | """ |
|
1085 | 1085 | warn("ip.register_post_execute is deprecated, use " |
|
1086 | 1086 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
1087 | 1087 | self.events.register('post_run_cell', func) |
|
1088 | 1088 | |
|
1089 | 1089 | def _clear_warning_registry(self): |
|
1090 | 1090 | # clear the warning registry, so that different code blocks with |
|
1091 | 1091 | # overlapping line number ranges don't cause spurious suppression of |
|
1092 | 1092 | # warnings (see gh-6611 for details) |
|
1093 | 1093 | if "__warningregistry__" in self.user_global_ns: |
|
1094 | 1094 | del self.user_global_ns["__warningregistry__"] |
|
1095 | 1095 | |
|
1096 | 1096 | #------------------------------------------------------------------------- |
|
1097 | 1097 | # Things related to the "main" module |
|
1098 | 1098 | #------------------------------------------------------------------------- |
|
1099 | 1099 | |
|
1100 | 1100 | def new_main_mod(self, filename, modname): |
|
1101 | 1101 | """Return a new 'main' module object for user code execution. |
|
1102 | 1102 | |
|
1103 | 1103 | ``filename`` should be the path of the script which will be run in the |
|
1104 | 1104 | module. Requests with the same filename will get the same module, with |
|
1105 | 1105 | its namespace cleared. |
|
1106 | 1106 | |
|
1107 | 1107 | ``modname`` should be the module name - normally either '__main__' or |
|
1108 | 1108 | the basename of the file without the extension. |
|
1109 | 1109 | |
|
1110 | 1110 | When scripts are executed via %run, we must keep a reference to their |
|
1111 | 1111 | __main__ module around so that Python doesn't |
|
1112 | 1112 | clear it, rendering references to module globals useless. |
|
1113 | 1113 | |
|
1114 | 1114 | This method keeps said reference in a private dict, keyed by the |
|
1115 | 1115 | absolute path of the script. This way, for multiple executions of the |
|
1116 | 1116 | same script we only keep one copy of the namespace (the last one), |
|
1117 | 1117 | thus preventing memory leaks from old references while allowing the |
|
1118 | 1118 | objects from the last execution to be accessible. |
|
1119 | 1119 | """ |
|
1120 | 1120 | filename = os.path.abspath(filename) |
|
1121 | 1121 | try: |
|
1122 | 1122 | main_mod = self._main_mod_cache[filename] |
|
1123 | 1123 | except KeyError: |
|
1124 | 1124 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
1125 | 1125 | modname, |
|
1126 | 1126 | doc="Module created for script run in IPython") |
|
1127 | 1127 | else: |
|
1128 | 1128 | main_mod.__dict__.clear() |
|
1129 | 1129 | main_mod.__name__ = modname |
|
1130 | 1130 | |
|
1131 | 1131 | main_mod.__file__ = filename |
|
1132 | 1132 | # It seems pydoc (and perhaps others) needs any module instance to |
|
1133 | 1133 | # implement a __nonzero__ method |
|
1134 | 1134 | main_mod.__nonzero__ = lambda : True |
|
1135 | 1135 | |
|
1136 | 1136 | return main_mod |
|
1137 | 1137 | |
|
1138 | 1138 | def clear_main_mod_cache(self): |
|
1139 | 1139 | """Clear the cache of main modules. |
|
1140 | 1140 | |
|
1141 | 1141 | Mainly for use by utilities like %reset. |
|
1142 | 1142 | |
|
1143 | 1143 | Examples |
|
1144 | 1144 | -------- |
|
1145 | 1145 | In [15]: import IPython |
|
1146 | 1146 | |
|
1147 | 1147 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
1148 | 1148 | |
|
1149 | 1149 | In [17]: len(_ip._main_mod_cache) > 0 |
|
1150 | 1150 | Out[17]: True |
|
1151 | 1151 | |
|
1152 | 1152 | In [18]: _ip.clear_main_mod_cache() |
|
1153 | 1153 | |
|
1154 | 1154 | In [19]: len(_ip._main_mod_cache) == 0 |
|
1155 | 1155 | Out[19]: True |
|
1156 | 1156 | """ |
|
1157 | 1157 | self._main_mod_cache.clear() |
|
1158 | 1158 | |
|
1159 | 1159 | #------------------------------------------------------------------------- |
|
1160 | 1160 | # Things related to debugging |
|
1161 | 1161 | #------------------------------------------------------------------------- |
|
1162 | 1162 | |
|
1163 | 1163 | def init_pdb(self): |
|
1164 | 1164 | # Set calling of pdb on exceptions |
|
1165 | 1165 | # self.call_pdb is a property |
|
1166 | 1166 | self.call_pdb = self.pdb |
|
1167 | 1167 | |
|
1168 | 1168 | def _get_call_pdb(self): |
|
1169 | 1169 | return self._call_pdb |
|
1170 | 1170 | |
|
1171 | 1171 | def _set_call_pdb(self,val): |
|
1172 | 1172 | |
|
1173 | 1173 | if val not in (0,1,False,True): |
|
1174 | 1174 | raise ValueError('new call_pdb value must be boolean') |
|
1175 | 1175 | |
|
1176 | 1176 | # store value in instance |
|
1177 | 1177 | self._call_pdb = val |
|
1178 | 1178 | |
|
1179 | 1179 | # notify the actual exception handlers |
|
1180 | 1180 | self.InteractiveTB.call_pdb = val |
|
1181 | 1181 | |
|
1182 | 1182 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1183 | 1183 | 'Control auto-activation of pdb at exceptions') |
|
1184 | 1184 | |
|
1185 | 1185 | def debugger(self,force=False): |
|
1186 | 1186 | """Call the pdb debugger. |
|
1187 | 1187 | |
|
1188 | 1188 | Keywords: |
|
1189 | 1189 | |
|
1190 | 1190 | - force(False): by default, this routine checks the instance call_pdb |
|
1191 | 1191 | flag and does not actually invoke the debugger if the flag is false. |
|
1192 | 1192 | The 'force' option forces the debugger to activate even if the flag |
|
1193 | 1193 | is false. |
|
1194 | 1194 | """ |
|
1195 | 1195 | |
|
1196 | 1196 | if not (force or self.call_pdb): |
|
1197 | 1197 | return |
|
1198 | 1198 | |
|
1199 | 1199 | if not hasattr(sys,'last_traceback'): |
|
1200 | 1200 | error('No traceback has been produced, nothing to debug.') |
|
1201 | 1201 | return |
|
1202 | 1202 | |
|
1203 | 1203 | self.InteractiveTB.debugger(force=True) |
|
1204 | 1204 | |
|
1205 | 1205 | #------------------------------------------------------------------------- |
|
1206 | 1206 | # Things related to IPython's various namespaces |
|
1207 | 1207 | #------------------------------------------------------------------------- |
|
1208 | 1208 | default_user_namespaces = True |
|
1209 | 1209 | |
|
1210 | 1210 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1211 | 1211 | # Create the namespace where the user will operate. user_ns is |
|
1212 | 1212 | # normally the only one used, and it is passed to the exec calls as |
|
1213 | 1213 | # the locals argument. But we do carry a user_global_ns namespace |
|
1214 | 1214 | # given as the exec 'globals' argument, This is useful in embedding |
|
1215 | 1215 | # situations where the ipython shell opens in a context where the |
|
1216 | 1216 | # distinction between locals and globals is meaningful. For |
|
1217 | 1217 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1218 | 1218 | |
|
1219 | 1219 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1220 | 1220 | # level as a dict instead of a module. This is a manual fix, but I |
|
1221 | 1221 | # should really track down where the problem is coming from. Alex |
|
1222 | 1222 | # Schmolck reported this problem first. |
|
1223 | 1223 | |
|
1224 | 1224 | # A useful post by Alex Martelli on this topic: |
|
1225 | 1225 | # Re: inconsistent value from __builtins__ |
|
1226 | 1226 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1227 | 1227 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1228 | 1228 | # Gruppen: comp.lang.python |
|
1229 | 1229 | |
|
1230 | 1230 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1231 | 1231 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1232 | 1232 | # > <type 'dict'> |
|
1233 | 1233 | # > >>> print type(__builtins__) |
|
1234 | 1234 | # > <type 'module'> |
|
1235 | 1235 | # > Is this difference in return value intentional? |
|
1236 | 1236 | |
|
1237 | 1237 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1238 | 1238 | # or a module, and it's been that way for a long time. Whether it's |
|
1239 | 1239 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1240 | 1240 | # that if you need to access the built-in namespace directly, you |
|
1241 | 1241 | # should start with "import __builtin__" (note, no 's') which will |
|
1242 | 1242 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1243 | 1243 | |
|
1244 | 1244 | # These routines return a properly built module and dict as needed by |
|
1245 | 1245 | # the rest of the code, and can also be used by extension writers to |
|
1246 | 1246 | # generate properly initialized namespaces. |
|
1247 | 1247 | if (user_ns is not None) or (user_module is not None): |
|
1248 | 1248 | self.default_user_namespaces = False |
|
1249 | 1249 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1250 | 1250 | |
|
1251 | 1251 | # A record of hidden variables we have added to the user namespace, so |
|
1252 | 1252 | # we can list later only variables defined in actual interactive use. |
|
1253 | 1253 | self.user_ns_hidden = {} |
|
1254 | 1254 | |
|
1255 | 1255 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1256 | 1256 | # problem: after script execution (via %run), the module where the user |
|
1257 | 1257 | # code ran is deleted. Now that this object is a true module (needed |
|
1258 | 1258 | # so doctest and other tools work correctly), the Python module |
|
1259 | 1259 | # teardown mechanism runs over it, and sets to None every variable |
|
1260 | 1260 | # present in that module. Top-level references to objects from the |
|
1261 | 1261 | # script survive, because the user_ns is updated with them. However, |
|
1262 | 1262 | # calling functions defined in the script that use other things from |
|
1263 | 1263 | # the script will fail, because the function's closure had references |
|
1264 | 1264 | # to the original objects, which are now all None. So we must protect |
|
1265 | 1265 | # these modules from deletion by keeping a cache. |
|
1266 | 1266 | # |
|
1267 | 1267 | # To avoid keeping stale modules around (we only need the one from the |
|
1268 | 1268 | # last run), we use a dict keyed with the full path to the script, so |
|
1269 | 1269 | # only the last version of the module is held in the cache. Note, |
|
1270 | 1270 | # however, that we must cache the module *namespace contents* (their |
|
1271 | 1271 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1272 | 1272 | # (uncached) could be destroyed while still holding references (such as |
|
1273 | 1273 | # those held by GUI objects that tend to be long-lived)> |
|
1274 | 1274 | # |
|
1275 | 1275 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1276 | 1276 | # and clear_main_mod_cache() methods for details on use. |
|
1277 | 1277 | |
|
1278 | 1278 | # This is the cache used for 'main' namespaces |
|
1279 | 1279 | self._main_mod_cache = {} |
|
1280 | 1280 | |
|
1281 | 1281 | # A table holding all the namespaces IPython deals with, so that |
|
1282 | 1282 | # introspection facilities can search easily. |
|
1283 | 1283 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1284 | 1284 | 'user_local':self.user_ns, |
|
1285 | 1285 | 'builtin':builtin_mod.__dict__ |
|
1286 | 1286 | } |
|
1287 | 1287 | |
|
1288 | 1288 | @property |
|
1289 | 1289 | def user_global_ns(self): |
|
1290 | 1290 | return self.user_module.__dict__ |
|
1291 | 1291 | |
|
1292 | 1292 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1293 | 1293 | """Prepare the module and namespace in which user code will be run. |
|
1294 | 1294 | |
|
1295 | 1295 | When IPython is started normally, both parameters are None: a new module |
|
1296 | 1296 | is created automatically, and its __dict__ used as the namespace. |
|
1297 | 1297 | |
|
1298 | 1298 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1299 | 1299 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1300 | 1300 | becomes the global namespace. If both are provided (as they may be |
|
1301 | 1301 | when embedding), user_ns is the local namespace, and user_module |
|
1302 | 1302 | provides the global namespace. |
|
1303 | 1303 | |
|
1304 | 1304 | Parameters |
|
1305 | 1305 | ---------- |
|
1306 | 1306 | user_module : module, optional |
|
1307 | 1307 | The current user module in which IPython is being run. If None, |
|
1308 | 1308 | a clean module will be created. |
|
1309 | 1309 | user_ns : dict, optional |
|
1310 | 1310 | A namespace in which to run interactive commands. |
|
1311 | 1311 | |
|
1312 | 1312 | Returns |
|
1313 | 1313 | ------- |
|
1314 | 1314 | A tuple of user_module and user_ns, each properly initialised. |
|
1315 | 1315 | """ |
|
1316 | 1316 | if user_module is None and user_ns is not None: |
|
1317 | 1317 | user_ns.setdefault("__name__", "__main__") |
|
1318 | 1318 | user_module = DummyMod() |
|
1319 | 1319 | user_module.__dict__ = user_ns |
|
1320 | 1320 | |
|
1321 | 1321 | if user_module is None: |
|
1322 | 1322 | user_module = types.ModuleType("__main__", |
|
1323 | 1323 | doc="Automatically created module for IPython interactive environment") |
|
1324 | 1324 | |
|
1325 | 1325 | # We must ensure that __builtin__ (without the final 's') is always |
|
1326 | 1326 | # available and pointing to the __builtin__ *module*. For more details: |
|
1327 | 1327 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1328 | 1328 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1329 | 1329 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1330 | 1330 | |
|
1331 | 1331 | if user_ns is None: |
|
1332 | 1332 | user_ns = user_module.__dict__ |
|
1333 | 1333 | |
|
1334 | 1334 | return user_module, user_ns |
|
1335 | 1335 | |
|
1336 | 1336 | def init_sys_modules(self): |
|
1337 | 1337 | # We need to insert into sys.modules something that looks like a |
|
1338 | 1338 | # module but which accesses the IPython namespace, for shelve and |
|
1339 | 1339 | # pickle to work interactively. Normally they rely on getting |
|
1340 | 1340 | # everything out of __main__, but for embedding purposes each IPython |
|
1341 | 1341 | # instance has its own private namespace, so we can't go shoving |
|
1342 | 1342 | # everything into __main__. |
|
1343 | 1343 | |
|
1344 | 1344 | # note, however, that we should only do this for non-embedded |
|
1345 | 1345 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1346 | 1346 | # namespace. Embedded instances, on the other hand, should not do |
|
1347 | 1347 | # this because they need to manage the user local/global namespaces |
|
1348 | 1348 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1349 | 1349 | # shouldn't overtake the execution environment of the script they're |
|
1350 | 1350 | # embedded in). |
|
1351 | 1351 | |
|
1352 | 1352 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1353 | 1353 | main_name = self.user_module.__name__ |
|
1354 | 1354 | sys.modules[main_name] = self.user_module |
|
1355 | 1355 | |
|
1356 | 1356 | def init_user_ns(self): |
|
1357 | 1357 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1358 | 1358 | |
|
1359 | 1359 | Certain history lists are also initialized here, as they effectively |
|
1360 | 1360 | act as user namespaces. |
|
1361 | 1361 | |
|
1362 | 1362 | Notes |
|
1363 | 1363 | ----- |
|
1364 | 1364 | All data structures here are only filled in, they are NOT reset by this |
|
1365 | 1365 | method. If they were not empty before, data will simply be added to |
|
1366 | 1366 | them. |
|
1367 | 1367 | """ |
|
1368 | 1368 | # This function works in two parts: first we put a few things in |
|
1369 | 1369 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1370 | 1370 | # initial variables aren't shown by %who. After the sync, we add the |
|
1371 | 1371 | # rest of what we *do* want the user to see with %who even on a new |
|
1372 | 1372 | # session (probably nothing, so they really only see their own stuff) |
|
1373 | 1373 | |
|
1374 | 1374 | # The user dict must *always* have a __builtin__ reference to the |
|
1375 | 1375 | # Python standard __builtin__ namespace, which must be imported. |
|
1376 | 1376 | # This is so that certain operations in prompt evaluation can be |
|
1377 | 1377 | # reliably executed with builtins. Note that we can NOT use |
|
1378 | 1378 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1379 | 1379 | # module, and can even mutate at runtime, depending on the context |
|
1380 | 1380 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1381 | 1381 | # always a module object, though it must be explicitly imported. |
|
1382 | 1382 | |
|
1383 | 1383 | # For more details: |
|
1384 | 1384 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1385 | 1385 | ns = {} |
|
1386 | 1386 | |
|
1387 | 1387 | # make global variables for user access to the histories |
|
1388 | 1388 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1389 | 1389 | ns['_oh'] = self.history_manager.output_hist |
|
1390 | 1390 | ns['_dh'] = self.history_manager.dir_hist |
|
1391 | 1391 | |
|
1392 | 1392 | # user aliases to input and output histories. These shouldn't show up |
|
1393 | 1393 | # in %who, as they can have very large reprs. |
|
1394 | 1394 | ns['In'] = self.history_manager.input_hist_parsed |
|
1395 | 1395 | ns['Out'] = self.history_manager.output_hist |
|
1396 | 1396 | |
|
1397 | 1397 | # Store myself as the public api!!! |
|
1398 | 1398 | ns['get_ipython'] = self.get_ipython |
|
1399 | 1399 | |
|
1400 | 1400 | ns['exit'] = self.exiter |
|
1401 | 1401 | ns['quit'] = self.exiter |
|
1402 | 1402 | |
|
1403 | 1403 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1404 | 1404 | # by %who |
|
1405 | 1405 | self.user_ns_hidden.update(ns) |
|
1406 | 1406 | |
|
1407 | 1407 | # Anything put into ns now would show up in %who. Think twice before |
|
1408 | 1408 | # putting anything here, as we really want %who to show the user their |
|
1409 | 1409 | # stuff, not our variables. |
|
1410 | 1410 | |
|
1411 | 1411 | # Finally, update the real user's namespace |
|
1412 | 1412 | self.user_ns.update(ns) |
|
1413 | 1413 | |
|
1414 | 1414 | @property |
|
1415 | 1415 | def all_ns_refs(self): |
|
1416 | 1416 | """Get a list of references to all the namespace dictionaries in which |
|
1417 | 1417 | IPython might store a user-created object. |
|
1418 | 1418 | |
|
1419 | 1419 | Note that this does not include the displayhook, which also caches |
|
1420 | 1420 | objects from the output.""" |
|
1421 | 1421 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1422 | 1422 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1423 | 1423 | |
|
1424 | 1424 | def reset(self, new_session=True, aggressive=False): |
|
1425 | 1425 | """Clear all internal namespaces, and attempt to release references to |
|
1426 | 1426 | user objects. |
|
1427 | 1427 | |
|
1428 | 1428 | If new_session is True, a new history session will be opened. |
|
1429 | 1429 | """ |
|
1430 | 1430 | # Clear histories |
|
1431 | 1431 | self.history_manager.reset(new_session) |
|
1432 | 1432 | # Reset counter used to index all histories |
|
1433 | 1433 | if new_session: |
|
1434 | 1434 | self.execution_count = 1 |
|
1435 | 1435 | |
|
1436 | 1436 | # Reset last execution result |
|
1437 | 1437 | self.last_execution_succeeded = True |
|
1438 | 1438 | self.last_execution_result = None |
|
1439 | 1439 | |
|
1440 | 1440 | # Flush cached output items |
|
1441 | 1441 | if self.displayhook.do_full_cache: |
|
1442 | 1442 | self.displayhook.flush() |
|
1443 | 1443 | |
|
1444 | 1444 | # The main execution namespaces must be cleared very carefully, |
|
1445 | 1445 | # skipping the deletion of the builtin-related keys, because doing so |
|
1446 | 1446 | # would cause errors in many object's __del__ methods. |
|
1447 | 1447 | if self.user_ns is not self.user_global_ns: |
|
1448 | 1448 | self.user_ns.clear() |
|
1449 | 1449 | ns = self.user_global_ns |
|
1450 | 1450 | drop_keys = set(ns.keys()) |
|
1451 | 1451 | drop_keys.discard('__builtin__') |
|
1452 | 1452 | drop_keys.discard('__builtins__') |
|
1453 | 1453 | drop_keys.discard('__name__') |
|
1454 | 1454 | for k in drop_keys: |
|
1455 | 1455 | del ns[k] |
|
1456 | 1456 | |
|
1457 | 1457 | self.user_ns_hidden.clear() |
|
1458 | 1458 | |
|
1459 | 1459 | # Restore the user namespaces to minimal usability |
|
1460 | 1460 | self.init_user_ns() |
|
1461 | 1461 | if aggressive and not hasattr(self, "_sys_modules_keys"): |
|
1462 | 1462 | print("Cannot restore sys.module, no snapshot") |
|
1463 | 1463 | elif aggressive: |
|
1464 | 1464 | print("culling sys module...") |
|
1465 | 1465 | current_keys = set(sys.modules.keys()) |
|
1466 | 1466 | for k in current_keys - self._sys_modules_keys: |
|
1467 | 1467 | if k.startswith("multiprocessing"): |
|
1468 | 1468 | continue |
|
1469 | 1469 | del sys.modules[k] |
|
1470 | 1470 | |
|
1471 | 1471 | # Restore the default and user aliases |
|
1472 | 1472 | self.alias_manager.clear_aliases() |
|
1473 | 1473 | self.alias_manager.init_aliases() |
|
1474 | 1474 | |
|
1475 | 1475 | # Now define aliases that only make sense on the terminal, because they |
|
1476 | 1476 | # need direct access to the console in a way that we can't emulate in |
|
1477 | 1477 | # GUI or web frontend |
|
1478 | 1478 | if os.name == 'posix': |
|
1479 | 1479 | for cmd in ('clear', 'more', 'less', 'man'): |
|
1480 | 1480 | if cmd not in self.magics_manager.magics['line']: |
|
1481 | 1481 | self.alias_manager.soft_define_alias(cmd, cmd) |
|
1482 | 1482 | |
|
1483 | 1483 | # Flush the private list of module references kept for script |
|
1484 | 1484 | # execution protection |
|
1485 | 1485 | self.clear_main_mod_cache() |
|
1486 | 1486 | |
|
1487 | 1487 | def del_var(self, varname, by_name=False): |
|
1488 | 1488 | """Delete a variable from the various namespaces, so that, as |
|
1489 | 1489 | far as possible, we're not keeping any hidden references to it. |
|
1490 | 1490 | |
|
1491 | 1491 | Parameters |
|
1492 | 1492 | ---------- |
|
1493 | 1493 | varname : str |
|
1494 | 1494 | The name of the variable to delete. |
|
1495 | 1495 | by_name : bool |
|
1496 | 1496 | If True, delete variables with the given name in each |
|
1497 | 1497 | namespace. If False (default), find the variable in the user |
|
1498 | 1498 | namespace, and delete references to it. |
|
1499 | 1499 | """ |
|
1500 | 1500 | if varname in ('__builtin__', '__builtins__'): |
|
1501 | 1501 | raise ValueError("Refusing to delete %s" % varname) |
|
1502 | 1502 | |
|
1503 | 1503 | ns_refs = self.all_ns_refs |
|
1504 | 1504 | |
|
1505 | 1505 | if by_name: # Delete by name |
|
1506 | 1506 | for ns in ns_refs: |
|
1507 | 1507 | try: |
|
1508 | 1508 | del ns[varname] |
|
1509 | 1509 | except KeyError: |
|
1510 | 1510 | pass |
|
1511 | 1511 | else: # Delete by object |
|
1512 | 1512 | try: |
|
1513 | 1513 | obj = self.user_ns[varname] |
|
1514 | 1514 | except KeyError as e: |
|
1515 | 1515 | raise NameError("name '%s' is not defined" % varname) from e |
|
1516 | 1516 | # Also check in output history |
|
1517 | 1517 | ns_refs.append(self.history_manager.output_hist) |
|
1518 | 1518 | for ns in ns_refs: |
|
1519 | 1519 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1520 | 1520 | for name in to_delete: |
|
1521 | 1521 | del ns[name] |
|
1522 | 1522 | |
|
1523 | 1523 | # Ensure it is removed from the last execution result |
|
1524 | 1524 | if self.last_execution_result.result is obj: |
|
1525 | 1525 | self.last_execution_result = None |
|
1526 | 1526 | |
|
1527 | 1527 | # displayhook keeps extra references, but not in a dictionary |
|
1528 | 1528 | for name in ('_', '__', '___'): |
|
1529 | 1529 | if getattr(self.displayhook, name) is obj: |
|
1530 | 1530 | setattr(self.displayhook, name, None) |
|
1531 | 1531 | |
|
1532 | 1532 | def reset_selective(self, regex=None): |
|
1533 | 1533 | """Clear selective variables from internal namespaces based on a |
|
1534 | 1534 | specified regular expression. |
|
1535 | 1535 | |
|
1536 | 1536 | Parameters |
|
1537 | 1537 | ---------- |
|
1538 | 1538 | regex : string or compiled pattern, optional |
|
1539 | 1539 | A regular expression pattern that will be used in searching |
|
1540 | 1540 | variable names in the users namespaces. |
|
1541 | 1541 | """ |
|
1542 | 1542 | if regex is not None: |
|
1543 | 1543 | try: |
|
1544 | 1544 | m = re.compile(regex) |
|
1545 | 1545 | except TypeError as e: |
|
1546 | 1546 | raise TypeError('regex must be a string or compiled pattern') from e |
|
1547 | 1547 | # Search for keys in each namespace that match the given regex |
|
1548 | 1548 | # If a match is found, delete the key/value pair. |
|
1549 | 1549 | for ns in self.all_ns_refs: |
|
1550 | 1550 | for var in ns: |
|
1551 | 1551 | if m.search(var): |
|
1552 | 1552 | del ns[var] |
|
1553 | 1553 | |
|
1554 | 1554 | def push(self, variables, interactive=True): |
|
1555 | 1555 | """Inject a group of variables into the IPython user namespace. |
|
1556 | 1556 | |
|
1557 | 1557 | Parameters |
|
1558 | 1558 | ---------- |
|
1559 | 1559 | variables : dict, str or list/tuple of str |
|
1560 | 1560 | The variables to inject into the user's namespace. If a dict, a |
|
1561 | 1561 | simple update is done. If a str, the string is assumed to have |
|
1562 | 1562 | variable names separated by spaces. A list/tuple of str can also |
|
1563 | 1563 | be used to give the variable names. If just the variable names are |
|
1564 | 1564 | give (list/tuple/str) then the variable values looked up in the |
|
1565 | 1565 | callers frame. |
|
1566 | 1566 | interactive : bool |
|
1567 | 1567 | If True (default), the variables will be listed with the ``who`` |
|
1568 | 1568 | magic. |
|
1569 | 1569 | """ |
|
1570 | 1570 | vdict = None |
|
1571 | 1571 | |
|
1572 | 1572 | # We need a dict of name/value pairs to do namespace updates. |
|
1573 | 1573 | if isinstance(variables, dict): |
|
1574 | 1574 | vdict = variables |
|
1575 | 1575 | elif isinstance(variables, (str, list, tuple)): |
|
1576 | 1576 | if isinstance(variables, str): |
|
1577 | 1577 | vlist = variables.split() |
|
1578 | 1578 | else: |
|
1579 | 1579 | vlist = variables |
|
1580 | 1580 | vdict = {} |
|
1581 | 1581 | cf = sys._getframe(1) |
|
1582 | 1582 | for name in vlist: |
|
1583 | 1583 | try: |
|
1584 | 1584 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1585 | 1585 | except: |
|
1586 | 1586 | print('Could not get variable %s from %s' % |
|
1587 | 1587 | (name,cf.f_code.co_name)) |
|
1588 | 1588 | else: |
|
1589 | 1589 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1590 | 1590 | |
|
1591 | 1591 | # Propagate variables to user namespace |
|
1592 | 1592 | self.user_ns.update(vdict) |
|
1593 | 1593 | |
|
1594 | 1594 | # And configure interactive visibility |
|
1595 | 1595 | user_ns_hidden = self.user_ns_hidden |
|
1596 | 1596 | if interactive: |
|
1597 | 1597 | for name in vdict: |
|
1598 | 1598 | user_ns_hidden.pop(name, None) |
|
1599 | 1599 | else: |
|
1600 | 1600 | user_ns_hidden.update(vdict) |
|
1601 | 1601 | |
|
1602 | 1602 | def drop_by_id(self, variables): |
|
1603 | 1603 | """Remove a dict of variables from the user namespace, if they are the |
|
1604 | 1604 | same as the values in the dictionary. |
|
1605 | 1605 | |
|
1606 | 1606 | This is intended for use by extensions: variables that they've added can |
|
1607 | 1607 | be taken back out if they are unloaded, without removing any that the |
|
1608 | 1608 | user has overwritten. |
|
1609 | 1609 | |
|
1610 | 1610 | Parameters |
|
1611 | 1611 | ---------- |
|
1612 | 1612 | variables : dict |
|
1613 | 1613 | A dictionary mapping object names (as strings) to the objects. |
|
1614 | 1614 | """ |
|
1615 | 1615 | for name, obj in variables.items(): |
|
1616 | 1616 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1617 | 1617 | del self.user_ns[name] |
|
1618 | 1618 | self.user_ns_hidden.pop(name, None) |
|
1619 | 1619 | |
|
1620 | 1620 | #------------------------------------------------------------------------- |
|
1621 | 1621 | # Things related to object introspection |
|
1622 | 1622 | #------------------------------------------------------------------------- |
|
1623 | 1623 | |
|
1624 | 1624 | def _ofind(self, oname, namespaces=None): |
|
1625 | 1625 | """Find an object in the available namespaces. |
|
1626 | 1626 | |
|
1627 | 1627 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1628 | 1628 | |
|
1629 | 1629 | Has special code to detect magic functions. |
|
1630 | 1630 | """ |
|
1631 | 1631 | oname = oname.strip() |
|
1632 | 1632 | if not oname.startswith(ESC_MAGIC) and \ |
|
1633 | 1633 | not oname.startswith(ESC_MAGIC2) and \ |
|
1634 | 1634 | not all(a.isidentifier() for a in oname.split(".")): |
|
1635 | 1635 | return {'found': False} |
|
1636 | 1636 | |
|
1637 | 1637 | if namespaces is None: |
|
1638 | 1638 | # Namespaces to search in: |
|
1639 | 1639 | # Put them in a list. The order is important so that we |
|
1640 | 1640 | # find things in the same order that Python finds them. |
|
1641 | 1641 | namespaces = [ ('Interactive', self.user_ns), |
|
1642 | 1642 | ('Interactive (global)', self.user_global_ns), |
|
1643 | 1643 | ('Python builtin', builtin_mod.__dict__), |
|
1644 | 1644 | ] |
|
1645 | 1645 | |
|
1646 | 1646 | ismagic = False |
|
1647 | 1647 | isalias = False |
|
1648 | 1648 | found = False |
|
1649 | 1649 | ospace = None |
|
1650 | 1650 | parent = None |
|
1651 | 1651 | obj = None |
|
1652 | 1652 | |
|
1653 | 1653 | |
|
1654 | 1654 | # Look for the given name by splitting it in parts. If the head is |
|
1655 | 1655 | # found, then we look for all the remaining parts as members, and only |
|
1656 | 1656 | # declare success if we can find them all. |
|
1657 | 1657 | oname_parts = oname.split('.') |
|
1658 | 1658 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1659 | 1659 | for nsname,ns in namespaces: |
|
1660 | 1660 | try: |
|
1661 | 1661 | obj = ns[oname_head] |
|
1662 | 1662 | except KeyError: |
|
1663 | 1663 | continue |
|
1664 | 1664 | else: |
|
1665 | 1665 | for idx, part in enumerate(oname_rest): |
|
1666 | 1666 | try: |
|
1667 | 1667 | parent = obj |
|
1668 | 1668 | # The last part is looked up in a special way to avoid |
|
1669 | 1669 | # descriptor invocation as it may raise or have side |
|
1670 | 1670 | # effects. |
|
1671 | 1671 | if idx == len(oname_rest) - 1: |
|
1672 | 1672 | obj = self._getattr_property(obj, part) |
|
1673 | 1673 | else: |
|
1674 | 1674 | obj = getattr(obj, part) |
|
1675 | 1675 | except: |
|
1676 | 1676 | # Blanket except b/c some badly implemented objects |
|
1677 | 1677 | # allow __getattr__ to raise exceptions other than |
|
1678 | 1678 | # AttributeError, which then crashes IPython. |
|
1679 | 1679 | break |
|
1680 | 1680 | else: |
|
1681 | 1681 | # If we finish the for loop (no break), we got all members |
|
1682 | 1682 | found = True |
|
1683 | 1683 | ospace = nsname |
|
1684 | 1684 | break # namespace loop |
|
1685 | 1685 | |
|
1686 | 1686 | # Try to see if it's magic |
|
1687 | 1687 | if not found: |
|
1688 | 1688 | obj = None |
|
1689 | 1689 | if oname.startswith(ESC_MAGIC2): |
|
1690 | 1690 | oname = oname.lstrip(ESC_MAGIC2) |
|
1691 | 1691 | obj = self.find_cell_magic(oname) |
|
1692 | 1692 | elif oname.startswith(ESC_MAGIC): |
|
1693 | 1693 | oname = oname.lstrip(ESC_MAGIC) |
|
1694 | 1694 | obj = self.find_line_magic(oname) |
|
1695 | 1695 | else: |
|
1696 | 1696 | # search without prefix, so run? will find %run? |
|
1697 | 1697 | obj = self.find_line_magic(oname) |
|
1698 | 1698 | if obj is None: |
|
1699 | 1699 | obj = self.find_cell_magic(oname) |
|
1700 | 1700 | if obj is not None: |
|
1701 | 1701 | found = True |
|
1702 | 1702 | ospace = 'IPython internal' |
|
1703 | 1703 | ismagic = True |
|
1704 | 1704 | isalias = isinstance(obj, Alias) |
|
1705 | 1705 | |
|
1706 | 1706 | # Last try: special-case some literals like '', [], {}, etc: |
|
1707 | 1707 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1708 | 1708 | obj = eval(oname_head) |
|
1709 | 1709 | found = True |
|
1710 | 1710 | ospace = 'Interactive' |
|
1711 | 1711 | |
|
1712 | 1712 | return { |
|
1713 | 1713 | 'obj':obj, |
|
1714 | 1714 | 'found':found, |
|
1715 | 1715 | 'parent':parent, |
|
1716 | 1716 | 'ismagic':ismagic, |
|
1717 | 1717 | 'isalias':isalias, |
|
1718 | 1718 | 'namespace':ospace |
|
1719 | 1719 | } |
|
1720 | 1720 | |
|
1721 | 1721 | @staticmethod |
|
1722 | 1722 | def _getattr_property(obj, attrname): |
|
1723 | 1723 | """Property-aware getattr to use in object finding. |
|
1724 | 1724 | |
|
1725 | 1725 | If attrname represents a property, return it unevaluated (in case it has |
|
1726 | 1726 | side effects or raises an error. |
|
1727 | 1727 | |
|
1728 | 1728 | """ |
|
1729 | 1729 | if not isinstance(obj, type): |
|
1730 | 1730 | try: |
|
1731 | 1731 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1732 | 1732 | # `obj`, but does so for property: |
|
1733 | 1733 | # |
|
1734 | 1734 | # property.__get__(self, None, cls) -> self |
|
1735 | 1735 | # |
|
1736 | 1736 | # The universal alternative is to traverse the mro manually |
|
1737 | 1737 | # searching for attrname in class dicts. |
|
1738 | 1738 | attr = getattr(type(obj), attrname) |
|
1739 | 1739 | except AttributeError: |
|
1740 | 1740 | pass |
|
1741 | 1741 | else: |
|
1742 | 1742 | # This relies on the fact that data descriptors (with both |
|
1743 | 1743 | # __get__ & __set__ magic methods) take precedence over |
|
1744 | 1744 | # instance-level attributes: |
|
1745 | 1745 | # |
|
1746 | 1746 | # class A(object): |
|
1747 | 1747 | # @property |
|
1748 | 1748 | # def foobar(self): return 123 |
|
1749 | 1749 | # a = A() |
|
1750 | 1750 | # a.__dict__['foobar'] = 345 |
|
1751 | 1751 | # a.foobar # == 123 |
|
1752 | 1752 | # |
|
1753 | 1753 | # So, a property may be returned right away. |
|
1754 | 1754 | if isinstance(attr, property): |
|
1755 | 1755 | return attr |
|
1756 | 1756 | |
|
1757 | 1757 | # Nothing helped, fall back. |
|
1758 | 1758 | return getattr(obj, attrname) |
|
1759 | 1759 | |
|
1760 | 1760 | def _object_find(self, oname, namespaces=None): |
|
1761 | 1761 | """Find an object and return a struct with info about it.""" |
|
1762 | 1762 | return Struct(self._ofind(oname, namespaces)) |
|
1763 | 1763 | |
|
1764 | 1764 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1765 | 1765 | """Generic interface to the inspector system. |
|
1766 | 1766 | |
|
1767 | 1767 | This function is meant to be called by pdef, pdoc & friends. |
|
1768 | 1768 | """ |
|
1769 | 1769 | info = self._object_find(oname, namespaces) |
|
1770 | 1770 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1771 | 1771 | if info.found: |
|
1772 | 1772 | pmethod = getattr(self.inspector, meth) |
|
1773 | 1773 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1774 | 1774 | # bundle. |
|
1775 | 1775 | formatter = format_screen if info.ismagic else docformat |
|
1776 | 1776 | if meth == 'pdoc': |
|
1777 | 1777 | pmethod(info.obj, oname, formatter) |
|
1778 | 1778 | elif meth == 'pinfo': |
|
1779 | 1779 | pmethod( |
|
1780 | 1780 | info.obj, |
|
1781 | 1781 | oname, |
|
1782 | 1782 | formatter, |
|
1783 | 1783 | info, |
|
1784 | 1784 | enable_html_pager=self.enable_html_pager, |
|
1785 | 1785 | **kw |
|
1786 | 1786 | ) |
|
1787 | 1787 | else: |
|
1788 | 1788 | pmethod(info.obj, oname) |
|
1789 | 1789 | else: |
|
1790 | 1790 | print('Object `%s` not found.' % oname) |
|
1791 | 1791 | return 'not found' # so callers can take other action |
|
1792 | 1792 | |
|
1793 | 1793 | def object_inspect(self, oname, detail_level=0): |
|
1794 | 1794 | """Get object info about oname""" |
|
1795 | 1795 | with self.builtin_trap: |
|
1796 | 1796 | info = self._object_find(oname) |
|
1797 | 1797 | if info.found: |
|
1798 | 1798 | return self.inspector.info(info.obj, oname, info=info, |
|
1799 | 1799 | detail_level=detail_level |
|
1800 | 1800 | ) |
|
1801 | 1801 | else: |
|
1802 | 1802 | return oinspect.object_info(name=oname, found=False) |
|
1803 | 1803 | |
|
1804 | 1804 | def object_inspect_text(self, oname, detail_level=0): |
|
1805 | 1805 | """Get object info as formatted text""" |
|
1806 | 1806 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1807 | 1807 | |
|
1808 | 1808 | def object_inspect_mime(self, oname, detail_level=0): |
|
1809 | 1809 | """Get object info as a mimebundle of formatted representations. |
|
1810 | 1810 | |
|
1811 | 1811 | A mimebundle is a dictionary, keyed by mime-type. |
|
1812 | 1812 | It must always have the key `'text/plain'`. |
|
1813 | 1813 | """ |
|
1814 | 1814 | with self.builtin_trap: |
|
1815 | 1815 | info = self._object_find(oname) |
|
1816 | 1816 | if info.found: |
|
1817 | 1817 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1818 | 1818 | detail_level=detail_level |
|
1819 | 1819 | ) |
|
1820 | 1820 | else: |
|
1821 | 1821 | raise KeyError(oname) |
|
1822 | 1822 | |
|
1823 | 1823 | #------------------------------------------------------------------------- |
|
1824 | 1824 | # Things related to history management |
|
1825 | 1825 | #------------------------------------------------------------------------- |
|
1826 | 1826 | |
|
1827 | 1827 | def init_history(self): |
|
1828 | 1828 | """Sets up the command history, and starts regular autosaves.""" |
|
1829 | 1829 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1830 | 1830 | self.configurables.append(self.history_manager) |
|
1831 | 1831 | |
|
1832 | 1832 | #------------------------------------------------------------------------- |
|
1833 | 1833 | # Things related to exception handling and tracebacks (not debugging) |
|
1834 | 1834 | #------------------------------------------------------------------------- |
|
1835 | 1835 | |
|
1836 | 1836 | debugger_cls = Pdb |
|
1837 | 1837 | |
|
1838 | 1838 | def init_traceback_handlers(self, custom_exceptions): |
|
1839 | 1839 | # Syntax error handler. |
|
1840 | 1840 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1841 | 1841 | |
|
1842 | 1842 | # The interactive one is initialized with an offset, meaning we always |
|
1843 | 1843 | # want to remove the topmost item in the traceback, which is our own |
|
1844 | 1844 | # internal code. Valid modes: ['Plain','Context','Verbose','Minimal'] |
|
1845 | 1845 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1846 | 1846 | color_scheme='NoColor', |
|
1847 | 1847 | tb_offset = 1, |
|
1848 | 1848 | check_cache=check_linecache_ipython, |
|
1849 | 1849 | debugger_cls=self.debugger_cls, parent=self) |
|
1850 | 1850 | |
|
1851 | 1851 | # The instance will store a pointer to the system-wide exception hook, |
|
1852 | 1852 | # so that runtime code (such as magics) can access it. This is because |
|
1853 | 1853 | # during the read-eval loop, it may get temporarily overwritten. |
|
1854 | 1854 | self.sys_excepthook = sys.excepthook |
|
1855 | 1855 | |
|
1856 | 1856 | # and add any custom exception handlers the user may have specified |
|
1857 | 1857 | self.set_custom_exc(*custom_exceptions) |
|
1858 | 1858 | |
|
1859 | 1859 | # Set the exception mode |
|
1860 | 1860 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1861 | 1861 | |
|
1862 | 1862 | def set_custom_exc(self, exc_tuple, handler): |
|
1863 | 1863 | """set_custom_exc(exc_tuple, handler) |
|
1864 | 1864 | |
|
1865 | 1865 | Set a custom exception handler, which will be called if any of the |
|
1866 | 1866 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1867 | 1867 | run_code() method). |
|
1868 | 1868 | |
|
1869 | 1869 | Parameters |
|
1870 | 1870 | ---------- |
|
1871 | 1871 | |
|
1872 | 1872 | exc_tuple : tuple of exception classes |
|
1873 | 1873 | A *tuple* of exception classes, for which to call the defined |
|
1874 | 1874 | handler. It is very important that you use a tuple, and NOT A |
|
1875 | 1875 | LIST here, because of the way Python's except statement works. If |
|
1876 | 1876 | you only want to trap a single exception, use a singleton tuple:: |
|
1877 | 1877 | |
|
1878 | 1878 | exc_tuple == (MyCustomException,) |
|
1879 | 1879 | |
|
1880 | 1880 | handler : callable |
|
1881 | 1881 | handler must have the following signature:: |
|
1882 | 1882 | |
|
1883 | 1883 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1884 | 1884 | ... |
|
1885 | 1885 | return structured_traceback |
|
1886 | 1886 | |
|
1887 | 1887 | Your handler must return a structured traceback (a list of strings), |
|
1888 | 1888 | or None. |
|
1889 | 1889 | |
|
1890 | 1890 | This will be made into an instance method (via types.MethodType) |
|
1891 | 1891 | of IPython itself, and it will be called if any of the exceptions |
|
1892 | 1892 | listed in the exc_tuple are caught. If the handler is None, an |
|
1893 | 1893 | internal basic one is used, which just prints basic info. |
|
1894 | 1894 | |
|
1895 | 1895 | To protect IPython from crashes, if your handler ever raises an |
|
1896 | 1896 | exception or returns an invalid result, it will be immediately |
|
1897 | 1897 | disabled. |
|
1898 | 1898 | |
|
1899 | 1899 | Notes |
|
1900 | 1900 | ----- |
|
1901 | 1901 | |
|
1902 | 1902 | WARNING: by putting in your own exception handler into IPython's main |
|
1903 | 1903 | execution loop, you run a very good chance of nasty crashes. This |
|
1904 | 1904 | facility should only be used if you really know what you are doing. |
|
1905 | 1905 | """ |
|
1906 | 1906 | |
|
1907 | 1907 | if not isinstance(exc_tuple, tuple): |
|
1908 | 1908 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1909 | 1909 | |
|
1910 | 1910 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1911 | 1911 | print('*** Simple custom exception handler ***') |
|
1912 | 1912 | print('Exception type :', etype) |
|
1913 | 1913 | print('Exception value:', value) |
|
1914 | 1914 | print('Traceback :', tb) |
|
1915 | 1915 | |
|
1916 | 1916 | def validate_stb(stb): |
|
1917 | 1917 | """validate structured traceback return type |
|
1918 | 1918 | |
|
1919 | 1919 | return type of CustomTB *should* be a list of strings, but allow |
|
1920 | 1920 | single strings or None, which are harmless. |
|
1921 | 1921 | |
|
1922 | 1922 | This function will *always* return a list of strings, |
|
1923 | 1923 | and will raise a TypeError if stb is inappropriate. |
|
1924 | 1924 | """ |
|
1925 | 1925 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1926 | 1926 | if stb is None: |
|
1927 | 1927 | return [] |
|
1928 | 1928 | elif isinstance(stb, str): |
|
1929 | 1929 | return [stb] |
|
1930 | 1930 | elif not isinstance(stb, list): |
|
1931 | 1931 | raise TypeError(msg) |
|
1932 | 1932 | # it's a list |
|
1933 | 1933 | for line in stb: |
|
1934 | 1934 | # check every element |
|
1935 | 1935 | if not isinstance(line, str): |
|
1936 | 1936 | raise TypeError(msg) |
|
1937 | 1937 | return stb |
|
1938 | 1938 | |
|
1939 | 1939 | if handler is None: |
|
1940 | 1940 | wrapped = dummy_handler |
|
1941 | 1941 | else: |
|
1942 | 1942 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1943 | 1943 | """wrap CustomTB handler, to protect IPython from user code |
|
1944 | 1944 | |
|
1945 | 1945 | This makes it harder (but not impossible) for custom exception |
|
1946 | 1946 | handlers to crash IPython. |
|
1947 | 1947 | """ |
|
1948 | 1948 | try: |
|
1949 | 1949 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1950 | 1950 | return validate_stb(stb) |
|
1951 | 1951 | except: |
|
1952 | 1952 | # clear custom handler immediately |
|
1953 | 1953 | self.set_custom_exc((), None) |
|
1954 | 1954 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1955 | 1955 | # show the exception in handler first |
|
1956 | 1956 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1957 | 1957 | print(self.InteractiveTB.stb2text(stb)) |
|
1958 | 1958 | print("The original exception:") |
|
1959 | 1959 | stb = self.InteractiveTB.structured_traceback( |
|
1960 | 1960 | (etype,value,tb), tb_offset=tb_offset |
|
1961 | 1961 | ) |
|
1962 | 1962 | return stb |
|
1963 | 1963 | |
|
1964 | 1964 | self.CustomTB = types.MethodType(wrapped,self) |
|
1965 | 1965 | self.custom_exceptions = exc_tuple |
|
1966 | 1966 | |
|
1967 | 1967 | def excepthook(self, etype, value, tb): |
|
1968 | 1968 | """One more defense for GUI apps that call sys.excepthook. |
|
1969 | 1969 | |
|
1970 | 1970 | GUI frameworks like wxPython trap exceptions and call |
|
1971 | 1971 | sys.excepthook themselves. I guess this is a feature that |
|
1972 | 1972 | enables them to keep running after exceptions that would |
|
1973 | 1973 | otherwise kill their mainloop. This is a bother for IPython |
|
1974 | 1974 | which expects to catch all of the program exceptions with a try: |
|
1975 | 1975 | except: statement. |
|
1976 | 1976 | |
|
1977 | 1977 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1978 | 1978 | any app directly invokes sys.excepthook, it will look to the user like |
|
1979 | 1979 | IPython crashed. In order to work around this, we can disable the |
|
1980 | 1980 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1981 | 1981 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1982 | 1982 | call sys.excepthook will generate a regular-looking exception from |
|
1983 | 1983 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1984 | 1984 | crashes. |
|
1985 | 1985 | |
|
1986 | 1986 | This hook should be used sparingly, only in places which are not likely |
|
1987 | 1987 | to be true IPython errors. |
|
1988 | 1988 | """ |
|
1989 | 1989 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1990 | 1990 | |
|
1991 | 1991 | def _get_exc_info(self, exc_tuple=None): |
|
1992 | 1992 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1993 | 1993 | |
|
1994 | 1994 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1995 | 1995 | from whichever source. |
|
1996 | 1996 | |
|
1997 | 1997 | raises ValueError if none of these contain any information |
|
1998 | 1998 | """ |
|
1999 | 1999 | if exc_tuple is None: |
|
2000 | 2000 | etype, value, tb = sys.exc_info() |
|
2001 | 2001 | else: |
|
2002 | 2002 | etype, value, tb = exc_tuple |
|
2003 | 2003 | |
|
2004 | 2004 | if etype is None: |
|
2005 | 2005 | if hasattr(sys, 'last_type'): |
|
2006 | 2006 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
2007 | 2007 | sys.last_traceback |
|
2008 | 2008 | |
|
2009 | 2009 | if etype is None: |
|
2010 | 2010 | raise ValueError("No exception to find") |
|
2011 | 2011 | |
|
2012 | 2012 | # Now store the exception info in sys.last_type etc. |
|
2013 | 2013 | # WARNING: these variables are somewhat deprecated and not |
|
2014 | 2014 | # necessarily safe to use in a threaded environment, but tools |
|
2015 | 2015 | # like pdb depend on their existence, so let's set them. If we |
|
2016 | 2016 | # find problems in the field, we'll need to revisit their use. |
|
2017 | 2017 | sys.last_type = etype |
|
2018 | 2018 | sys.last_value = value |
|
2019 | 2019 | sys.last_traceback = tb |
|
2020 | 2020 | |
|
2021 | 2021 | return etype, value, tb |
|
2022 | 2022 | |
|
2023 | 2023 | def show_usage_error(self, exc): |
|
2024 | 2024 | """Show a short message for UsageErrors |
|
2025 | 2025 | |
|
2026 | 2026 | These are special exceptions that shouldn't show a traceback. |
|
2027 | 2027 | """ |
|
2028 | 2028 | print("UsageError: %s" % exc, file=sys.stderr) |
|
2029 | 2029 | |
|
2030 | 2030 | def get_exception_only(self, exc_tuple=None): |
|
2031 | 2031 | """ |
|
2032 | 2032 | Return as a string (ending with a newline) the exception that |
|
2033 | 2033 | just occurred, without any traceback. |
|
2034 | 2034 | """ |
|
2035 | 2035 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2036 | 2036 | msg = traceback.format_exception_only(etype, value) |
|
2037 | 2037 | return ''.join(msg) |
|
2038 | 2038 | |
|
2039 | 2039 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
2040 | 2040 | exception_only=False, running_compiled_code=False): |
|
2041 | 2041 | """Display the exception that just occurred. |
|
2042 | 2042 | |
|
2043 | 2043 | If nothing is known about the exception, this is the method which |
|
2044 | 2044 | should be used throughout the code for presenting user tracebacks, |
|
2045 | 2045 | rather than directly invoking the InteractiveTB object. |
|
2046 | 2046 | |
|
2047 | 2047 | A specific showsyntaxerror() also exists, but this method can take |
|
2048 | 2048 | care of calling it if needed, so unless you are explicitly catching a |
|
2049 | 2049 | SyntaxError exception, don't try to analyze the stack manually and |
|
2050 | 2050 | simply call this method.""" |
|
2051 | 2051 | |
|
2052 | 2052 | try: |
|
2053 | 2053 | try: |
|
2054 | 2054 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2055 | 2055 | except ValueError: |
|
2056 | 2056 | print('No traceback available to show.', file=sys.stderr) |
|
2057 | 2057 | return |
|
2058 | 2058 | |
|
2059 | 2059 | if issubclass(etype, SyntaxError): |
|
2060 | 2060 | # Though this won't be called by syntax errors in the input |
|
2061 | 2061 | # line, there may be SyntaxError cases with imported code. |
|
2062 | 2062 | self.showsyntaxerror(filename, running_compiled_code) |
|
2063 | 2063 | elif etype is UsageError: |
|
2064 | 2064 | self.show_usage_error(value) |
|
2065 | 2065 | else: |
|
2066 | 2066 | if exception_only: |
|
2067 | 2067 | stb = ['An exception has occurred, use %tb to see ' |
|
2068 | 2068 | 'the full traceback.\n'] |
|
2069 | 2069 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
2070 | 2070 | value)) |
|
2071 | 2071 | else: |
|
2072 | 2072 | try: |
|
2073 | 2073 | # Exception classes can customise their traceback - we |
|
2074 | 2074 | # use this in IPython.parallel for exceptions occurring |
|
2075 | 2075 | # in the engines. This should return a list of strings. |
|
2076 | 2076 | stb = value._render_traceback_() |
|
2077 | 2077 | except Exception: |
|
2078 | 2078 | stb = self.InteractiveTB.structured_traceback(etype, |
|
2079 | 2079 | value, tb, tb_offset=tb_offset) |
|
2080 | 2080 | |
|
2081 | 2081 | self._showtraceback(etype, value, stb) |
|
2082 | 2082 | if self.call_pdb: |
|
2083 | 2083 | # drop into debugger |
|
2084 | 2084 | self.debugger(force=True) |
|
2085 | 2085 | return |
|
2086 | 2086 | |
|
2087 | 2087 | # Actually show the traceback |
|
2088 | 2088 | self._showtraceback(etype, value, stb) |
|
2089 | 2089 | |
|
2090 | 2090 | except KeyboardInterrupt: |
|
2091 | 2091 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2092 | 2092 | |
|
2093 | 2093 | def _showtraceback(self, etype, evalue, stb: str): |
|
2094 | 2094 | """Actually show a traceback. |
|
2095 | 2095 | |
|
2096 | 2096 | Subclasses may override this method to put the traceback on a different |
|
2097 | 2097 | place, like a side channel. |
|
2098 | 2098 | """ |
|
2099 | 2099 | val = self.InteractiveTB.stb2text(stb) |
|
2100 | 2100 | try: |
|
2101 | 2101 | print(val) |
|
2102 | 2102 | except UnicodeEncodeError: |
|
2103 | 2103 | print(val.encode("utf-8", "backslashreplace").decode()) |
|
2104 | 2104 | |
|
2105 | 2105 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
2106 | 2106 | """Display the syntax error that just occurred. |
|
2107 | 2107 | |
|
2108 | 2108 | This doesn't display a stack trace because there isn't one. |
|
2109 | 2109 | |
|
2110 | 2110 | If a filename is given, it is stuffed in the exception instead |
|
2111 | 2111 | of what was there before (because Python's parser always uses |
|
2112 | 2112 | "<string>" when reading from a string). |
|
2113 | 2113 | |
|
2114 | 2114 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
2115 | 2115 | longer stack trace will be displayed. |
|
2116 | 2116 | """ |
|
2117 | 2117 | etype, value, last_traceback = self._get_exc_info() |
|
2118 | 2118 | |
|
2119 | 2119 | if filename and issubclass(etype, SyntaxError): |
|
2120 | 2120 | try: |
|
2121 | 2121 | value.filename = filename |
|
2122 | 2122 | except: |
|
2123 | 2123 | # Not the format we expect; leave it alone |
|
2124 | 2124 | pass |
|
2125 | 2125 | |
|
2126 | 2126 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
2127 | 2127 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
2128 | 2128 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
2129 | 2129 | self._showtraceback(etype, value, stb) |
|
2130 | 2130 | |
|
2131 | 2131 | # This is overridden in TerminalInteractiveShell to show a message about |
|
2132 | 2132 | # the %paste magic. |
|
2133 | 2133 | def showindentationerror(self): |
|
2134 | 2134 | """Called by _run_cell when there's an IndentationError in code entered |
|
2135 | 2135 | at the prompt. |
|
2136 | 2136 | |
|
2137 | 2137 | This is overridden in TerminalInteractiveShell to show a message about |
|
2138 | 2138 | the %paste magic.""" |
|
2139 | 2139 | self.showsyntaxerror() |
|
2140 | 2140 | |
|
2141 | 2141 | #------------------------------------------------------------------------- |
|
2142 | 2142 | # Things related to readline |
|
2143 | 2143 | #------------------------------------------------------------------------- |
|
2144 | 2144 | |
|
2145 | 2145 | def init_readline(self): |
|
2146 | 2146 | """DEPRECATED |
|
2147 | 2147 | |
|
2148 | 2148 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
2149 | 2149 | # Set a number of methods that depend on readline to be no-op |
|
2150 | 2150 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
2151 | 2151 | DeprecationWarning, stacklevel=2) |
|
2152 | 2152 | self.set_custom_completer = no_op |
|
2153 | 2153 | |
|
2154 | 2154 | @skip_doctest |
|
2155 | 2155 | def set_next_input(self, s, replace=False): |
|
2156 | 2156 | """ Sets the 'default' input string for the next command line. |
|
2157 | 2157 | |
|
2158 | 2158 | Example:: |
|
2159 | 2159 | |
|
2160 | 2160 | In [1]: _ip.set_next_input("Hello Word") |
|
2161 | 2161 | In [2]: Hello Word_ # cursor is here |
|
2162 | 2162 | """ |
|
2163 | 2163 | self.rl_next_input = s |
|
2164 | 2164 | |
|
2165 | 2165 | def _indent_current_str(self): |
|
2166 | 2166 | """return the current level of indentation as a string""" |
|
2167 | 2167 | return self.input_splitter.get_indent_spaces() * ' ' |
|
2168 | 2168 | |
|
2169 | 2169 | #------------------------------------------------------------------------- |
|
2170 | 2170 | # Things related to text completion |
|
2171 | 2171 | #------------------------------------------------------------------------- |
|
2172 | 2172 | |
|
2173 | 2173 | def init_completer(self): |
|
2174 | 2174 | """Initialize the completion machinery. |
|
2175 | 2175 | |
|
2176 | 2176 | This creates completion machinery that can be used by client code, |
|
2177 | 2177 | either interactively in-process (typically triggered by the readline |
|
2178 | 2178 | library), programmatically (such as in test suites) or out-of-process |
|
2179 | 2179 | (typically over the network by remote frontends). |
|
2180 | 2180 | """ |
|
2181 | 2181 | from IPython.core.completer import IPCompleter |
|
2182 | 2182 | from IPython.core.completerlib import (module_completer, |
|
2183 | 2183 | magic_run_completer, cd_completer, reset_completer) |
|
2184 | 2184 | |
|
2185 | 2185 | self.Completer = IPCompleter(shell=self, |
|
2186 | 2186 | namespace=self.user_ns, |
|
2187 | 2187 | global_namespace=self.user_global_ns, |
|
2188 | 2188 | parent=self, |
|
2189 | 2189 | ) |
|
2190 | 2190 | self.configurables.append(self.Completer) |
|
2191 | 2191 | |
|
2192 | 2192 | # Add custom completers to the basic ones built into IPCompleter |
|
2193 | 2193 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2194 | 2194 | self.strdispatchers['complete_command'] = sdisp |
|
2195 | 2195 | self.Completer.custom_completers = sdisp |
|
2196 | 2196 | |
|
2197 | 2197 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2198 | 2198 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2199 | 2199 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
2200 | 2200 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2201 | 2201 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2202 | 2202 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2203 | 2203 | |
|
2204 | 2204 | @skip_doctest |
|
2205 | 2205 | def complete(self, text, line=None, cursor_pos=None): |
|
2206 | 2206 | """Return the completed text and a list of completions. |
|
2207 | 2207 | |
|
2208 | 2208 | Parameters |
|
2209 | 2209 | ---------- |
|
2210 | 2210 | |
|
2211 | 2211 | text : string |
|
2212 | 2212 | A string of text to be completed on. It can be given as empty and |
|
2213 | 2213 | instead a line/position pair are given. In this case, the |
|
2214 | 2214 | completer itself will split the line like readline does. |
|
2215 | 2215 | |
|
2216 | 2216 | line : string, optional |
|
2217 | 2217 | The complete line that text is part of. |
|
2218 | 2218 | |
|
2219 | 2219 | cursor_pos : int, optional |
|
2220 | 2220 | The position of the cursor on the input line. |
|
2221 | 2221 | |
|
2222 | 2222 | Returns |
|
2223 | 2223 | ------- |
|
2224 | 2224 | text : string |
|
2225 | 2225 | The actual text that was completed. |
|
2226 | 2226 | |
|
2227 | 2227 | matches : list |
|
2228 | 2228 | A sorted list with all possible completions. |
|
2229 | 2229 | |
|
2230 | 2230 | |
|
2231 | 2231 | Notes |
|
2232 | 2232 | ----- |
|
2233 | 2233 | The optional arguments allow the completion to take more context into |
|
2234 | 2234 | account, and are part of the low-level completion API. |
|
2235 | 2235 | |
|
2236 | 2236 | This is a wrapper around the completion mechanism, similar to what |
|
2237 | 2237 | readline does at the command line when the TAB key is hit. By |
|
2238 | 2238 | exposing it as a method, it can be used by other non-readline |
|
2239 | 2239 | environments (such as GUIs) for text completion. |
|
2240 | 2240 | |
|
2241 | 2241 | Examples |
|
2242 | 2242 | -------- |
|
2243 | 2243 | |
|
2244 | 2244 | In [1]: x = 'hello' |
|
2245 | 2245 | |
|
2246 | 2246 | In [2]: _ip.complete('x.l') |
|
2247 | 2247 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2248 | 2248 | """ |
|
2249 | 2249 | |
|
2250 | 2250 | # Inject names into __builtin__ so we can complete on the added names. |
|
2251 | 2251 | with self.builtin_trap: |
|
2252 | 2252 | return self.Completer.complete(text, line, cursor_pos) |
|
2253 | 2253 | |
|
2254 | 2254 | def set_custom_completer(self, completer, pos=0) -> None: |
|
2255 | 2255 | """Adds a new custom completer function. |
|
2256 | 2256 | |
|
2257 | 2257 | The position argument (defaults to 0) is the index in the completers |
|
2258 | 2258 | list where you want the completer to be inserted. |
|
2259 | 2259 | |
|
2260 | 2260 | `completer` should have the following signature:: |
|
2261 | 2261 | |
|
2262 | 2262 | def completion(self: Completer, text: string) -> List[str]: |
|
2263 | 2263 | raise NotImplementedError |
|
2264 | 2264 | |
|
2265 | 2265 | It will be bound to the current Completer instance and pass some text |
|
2266 | 2266 | and return a list with current completions to suggest to the user. |
|
2267 | 2267 | """ |
|
2268 | 2268 | |
|
2269 | 2269 | newcomp = types.MethodType(completer, self.Completer) |
|
2270 | 2270 | self.Completer.custom_matchers.insert(pos,newcomp) |
|
2271 | 2271 | |
|
2272 | 2272 | def set_completer_frame(self, frame=None): |
|
2273 | 2273 | """Set the frame of the completer.""" |
|
2274 | 2274 | if frame: |
|
2275 | 2275 | self.Completer.namespace = frame.f_locals |
|
2276 | 2276 | self.Completer.global_namespace = frame.f_globals |
|
2277 | 2277 | else: |
|
2278 | 2278 | self.Completer.namespace = self.user_ns |
|
2279 | 2279 | self.Completer.global_namespace = self.user_global_ns |
|
2280 | 2280 | |
|
2281 | 2281 | #------------------------------------------------------------------------- |
|
2282 | 2282 | # Things related to magics |
|
2283 | 2283 | #------------------------------------------------------------------------- |
|
2284 | 2284 | |
|
2285 | 2285 | def init_magics(self): |
|
2286 | 2286 | from IPython.core import magics as m |
|
2287 | 2287 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2288 | 2288 | parent=self, |
|
2289 | 2289 | user_magics=m.UserMagics(self)) |
|
2290 | 2290 | self.configurables.append(self.magics_manager) |
|
2291 | 2291 | |
|
2292 | 2292 | # Expose as public API from the magics manager |
|
2293 | 2293 | self.register_magics = self.magics_manager.register |
|
2294 | 2294 | |
|
2295 | 2295 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2296 | 2296 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2297 | 2297 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2298 | 2298 | m.NamespaceMagics, m.OSMagics, m.PackagingMagics, |
|
2299 | 2299 | m.PylabMagics, m.ScriptMagics, |
|
2300 | 2300 | ) |
|
2301 | 2301 | self.register_magics(m.AsyncMagics) |
|
2302 | 2302 | |
|
2303 | 2303 | # Register Magic Aliases |
|
2304 | 2304 | mman = self.magics_manager |
|
2305 | 2305 | # FIXME: magic aliases should be defined by the Magics classes |
|
2306 | 2306 | # or in MagicsManager, not here |
|
2307 | 2307 | mman.register_alias('ed', 'edit') |
|
2308 | 2308 | mman.register_alias('hist', 'history') |
|
2309 | 2309 | mman.register_alias('rep', 'recall') |
|
2310 | 2310 | mman.register_alias('SVG', 'svg', 'cell') |
|
2311 | 2311 | mman.register_alias('HTML', 'html', 'cell') |
|
2312 | 2312 | mman.register_alias('file', 'writefile', 'cell') |
|
2313 | 2313 | |
|
2314 | 2314 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2315 | 2315 | # should be split into a prompt manager and displayhook. We probably |
|
2316 | 2316 | # even need a centralize colors management object. |
|
2317 | 2317 | self.run_line_magic('colors', self.colors) |
|
2318 | 2318 | |
|
2319 | 2319 | # Defined here so that it's included in the documentation |
|
2320 | 2320 | @functools.wraps(magic.MagicsManager.register_function) |
|
2321 | 2321 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2322 | 2322 | self.magics_manager.register_function( |
|
2323 | 2323 | func, magic_kind=magic_kind, magic_name=magic_name |
|
2324 | 2324 | ) |
|
2325 | 2325 | |
|
2326 | 2326 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2327 | 2327 | """Execute the given line magic. |
|
2328 | 2328 | |
|
2329 | 2329 | Parameters |
|
2330 | 2330 | ---------- |
|
2331 | 2331 | magic_name : str |
|
2332 | 2332 | Name of the desired magic function, without '%' prefix. |
|
2333 | 2333 | line : str |
|
2334 | 2334 | The rest of the input line as a single string. |
|
2335 | 2335 | _stack_depth : int |
|
2336 | 2336 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2337 | 2337 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2338 | 2338 | """ |
|
2339 | 2339 | fn = self.find_line_magic(magic_name) |
|
2340 | 2340 | if fn is None: |
|
2341 | 2341 | cm = self.find_cell_magic(magic_name) |
|
2342 | 2342 | etpl = "Line magic function `%%%s` not found%s." |
|
2343 | 2343 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2344 | 2344 | 'did you mean that instead?)' % magic_name ) |
|
2345 | 2345 | raise UsageError(etpl % (magic_name, extra)) |
|
2346 | 2346 | else: |
|
2347 | 2347 | # Note: this is the distance in the stack to the user's frame. |
|
2348 | 2348 | # This will need to be updated if the internal calling logic gets |
|
2349 | 2349 | # refactored, or else we'll be expanding the wrong variables. |
|
2350 | 2350 | |
|
2351 | 2351 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2352 | 2352 | stack_depth = _stack_depth |
|
2353 | 2353 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2354 | 2354 | # magic has opted out of var_expand |
|
2355 | 2355 | magic_arg_s = line |
|
2356 | 2356 | else: |
|
2357 | 2357 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2358 | 2358 | # Put magic args in a list so we can call with f(*a) syntax |
|
2359 | 2359 | args = [magic_arg_s] |
|
2360 | 2360 | kwargs = {} |
|
2361 | 2361 | # Grab local namespace if we need it: |
|
2362 | 2362 | if getattr(fn, "needs_local_scope", False): |
|
2363 | 2363 | kwargs['local_ns'] = self.get_local_scope(stack_depth) |
|
2364 | 2364 | with self.builtin_trap: |
|
2365 | 2365 | result = fn(*args, **kwargs) |
|
2366 | 2366 | return result |
|
2367 | 2367 | |
|
2368 | 2368 | def get_local_scope(self, stack_depth): |
|
2369 | 2369 | """Get local scope at given stack depth. |
|
2370 | 2370 | |
|
2371 | 2371 | Parameters |
|
2372 | 2372 | ---------- |
|
2373 | 2373 | stack_depth : int |
|
2374 | 2374 | Depth relative to calling frame |
|
2375 | 2375 | """ |
|
2376 | 2376 | return sys._getframe(stack_depth + 1).f_locals |
|
2377 | 2377 | |
|
2378 | 2378 | def run_cell_magic(self, magic_name, line, cell): |
|
2379 | 2379 | """Execute the given cell magic. |
|
2380 | 2380 | |
|
2381 | 2381 | Parameters |
|
2382 | 2382 | ---------- |
|
2383 | 2383 | magic_name : str |
|
2384 | 2384 | Name of the desired magic function, without '%' prefix. |
|
2385 | 2385 | line : str |
|
2386 | 2386 | The rest of the first input line as a single string. |
|
2387 | 2387 | cell : str |
|
2388 | 2388 | The body of the cell as a (possibly multiline) string. |
|
2389 | 2389 | """ |
|
2390 | 2390 | fn = self.find_cell_magic(magic_name) |
|
2391 | 2391 | if fn is None: |
|
2392 | 2392 | lm = self.find_line_magic(magic_name) |
|
2393 | 2393 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2394 | 2394 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2395 | 2395 | 'did you mean that instead?)'.format(magic_name)) |
|
2396 | 2396 | raise UsageError(etpl.format(magic_name, extra)) |
|
2397 | 2397 | elif cell == '': |
|
2398 | 2398 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2399 | 2399 | if self.find_line_magic(magic_name) is not None: |
|
2400 | 2400 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2401 | 2401 | raise UsageError(message) |
|
2402 | 2402 | else: |
|
2403 | 2403 | # Note: this is the distance in the stack to the user's frame. |
|
2404 | 2404 | # This will need to be updated if the internal calling logic gets |
|
2405 | 2405 | # refactored, or else we'll be expanding the wrong variables. |
|
2406 | 2406 | stack_depth = 2 |
|
2407 | 2407 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2408 | 2408 | # magic has opted out of var_expand |
|
2409 | 2409 | magic_arg_s = line |
|
2410 | 2410 | else: |
|
2411 | 2411 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2412 | 2412 | kwargs = {} |
|
2413 | 2413 | if getattr(fn, "needs_local_scope", False): |
|
2414 | 2414 | kwargs['local_ns'] = self.user_ns |
|
2415 | 2415 | |
|
2416 | 2416 | with self.builtin_trap: |
|
2417 | 2417 | args = (magic_arg_s, cell) |
|
2418 | 2418 | result = fn(*args, **kwargs) |
|
2419 | 2419 | return result |
|
2420 | 2420 | |
|
2421 | 2421 | def find_line_magic(self, magic_name): |
|
2422 | 2422 | """Find and return a line magic by name. |
|
2423 | 2423 | |
|
2424 | 2424 | Returns None if the magic isn't found.""" |
|
2425 | 2425 | return self.magics_manager.magics['line'].get(magic_name) |
|
2426 | 2426 | |
|
2427 | 2427 | def find_cell_magic(self, magic_name): |
|
2428 | 2428 | """Find and return a cell magic by name. |
|
2429 | 2429 | |
|
2430 | 2430 | Returns None if the magic isn't found.""" |
|
2431 | 2431 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2432 | 2432 | |
|
2433 | 2433 | def find_magic(self, magic_name, magic_kind='line'): |
|
2434 | 2434 | """Find and return a magic of the given type by name. |
|
2435 | 2435 | |
|
2436 | 2436 | Returns None if the magic isn't found.""" |
|
2437 | 2437 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2438 | 2438 | |
|
2439 | 2439 | def magic(self, arg_s): |
|
2440 | 2440 | """DEPRECATED. Use run_line_magic() instead. |
|
2441 | 2441 | |
|
2442 | 2442 | Call a magic function by name. |
|
2443 | 2443 | |
|
2444 | 2444 | Input: a string containing the name of the magic function to call and |
|
2445 | 2445 | any additional arguments to be passed to the magic. |
|
2446 | 2446 | |
|
2447 | 2447 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2448 | 2448 | prompt: |
|
2449 | 2449 | |
|
2450 | 2450 | In[1]: %name -opt foo bar |
|
2451 | 2451 | |
|
2452 | 2452 | To call a magic without arguments, simply use magic('name'). |
|
2453 | 2453 | |
|
2454 | 2454 | This provides a proper Python function to call IPython's magics in any |
|
2455 | 2455 | valid Python code you can type at the interpreter, including loops and |
|
2456 | 2456 | compound statements. |
|
2457 | 2457 | """ |
|
2458 | 2458 | # TODO: should we issue a loud deprecation warning here? |
|
2459 | 2459 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2460 | 2460 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2461 | 2461 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2462 | 2462 | |
|
2463 | 2463 | #------------------------------------------------------------------------- |
|
2464 | 2464 | # Things related to macros |
|
2465 | 2465 | #------------------------------------------------------------------------- |
|
2466 | 2466 | |
|
2467 | 2467 | def define_macro(self, name, themacro): |
|
2468 | 2468 | """Define a new macro |
|
2469 | 2469 | |
|
2470 | 2470 | Parameters |
|
2471 | 2471 | ---------- |
|
2472 | 2472 | name : str |
|
2473 | 2473 | The name of the macro. |
|
2474 | 2474 | themacro : str or Macro |
|
2475 | 2475 | The action to do upon invoking the macro. If a string, a new |
|
2476 | 2476 | Macro object is created by passing the string to it. |
|
2477 | 2477 | """ |
|
2478 | 2478 | |
|
2479 | 2479 | from IPython.core import macro |
|
2480 | 2480 | |
|
2481 | 2481 | if isinstance(themacro, str): |
|
2482 | 2482 | themacro = macro.Macro(themacro) |
|
2483 | 2483 | if not isinstance(themacro, macro.Macro): |
|
2484 | 2484 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2485 | 2485 | self.user_ns[name] = themacro |
|
2486 | 2486 | |
|
2487 | 2487 | #------------------------------------------------------------------------- |
|
2488 | 2488 | # Things related to the running of system commands |
|
2489 | 2489 | #------------------------------------------------------------------------- |
|
2490 | 2490 | |
|
2491 | 2491 | def system_piped(self, cmd): |
|
2492 | 2492 | """Call the given cmd in a subprocess, piping stdout/err |
|
2493 | 2493 | |
|
2494 | 2494 | Parameters |
|
2495 | 2495 | ---------- |
|
2496 | 2496 | cmd : str |
|
2497 | 2497 | Command to execute (can not end in '&', as background processes are |
|
2498 | 2498 | not supported. Should not be a command that expects input |
|
2499 | 2499 | other than simple text. |
|
2500 | 2500 | """ |
|
2501 | 2501 | if cmd.rstrip().endswith('&'): |
|
2502 | 2502 | # this is *far* from a rigorous test |
|
2503 | 2503 | # We do not support backgrounding processes because we either use |
|
2504 | 2504 | # pexpect or pipes to read from. Users can always just call |
|
2505 | 2505 | # os.system() or use ip.system=ip.system_raw |
|
2506 | 2506 | # if they really want a background process. |
|
2507 | 2507 | raise OSError("Background processes not supported.") |
|
2508 | 2508 | |
|
2509 | 2509 | # we explicitly do NOT return the subprocess status code, because |
|
2510 | 2510 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2511 | 2511 | # Instead, we store the exit_code in user_ns. |
|
2512 | 2512 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2513 | 2513 | |
|
2514 | 2514 | def system_raw(self, cmd): |
|
2515 | 2515 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2516 | 2516 | subprocess.call using the system shell on other platforms. |
|
2517 | 2517 | |
|
2518 | 2518 | Parameters |
|
2519 | 2519 | ---------- |
|
2520 | 2520 | cmd : str |
|
2521 | 2521 | Command to execute. |
|
2522 | 2522 | """ |
|
2523 | 2523 | cmd = self.var_expand(cmd, depth=1) |
|
2524 | 2524 | # warn if there is an IPython magic alternative. |
|
2525 | 2525 | main_cmd = cmd.split()[0] |
|
2526 | 2526 | has_magic_alternatives = ("pip", "conda", "cd", "ls") |
|
2527 | 2527 | |
|
2528 | 2528 | # had to check if the command was an alias expanded because of `ls` |
|
2529 | 2529 | is_alias_expanded = self.alias_manager.is_alias(main_cmd) and ( |
|
2530 | 2530 | self.alias_manager.retrieve_alias(main_cmd).strip() == cmd.strip() |
|
2531 | 2531 | ) |
|
2532 | 2532 | |
|
2533 | 2533 | if main_cmd in has_magic_alternatives and not is_alias_expanded: |
|
2534 | 2534 | warnings.warn( |
|
2535 | 2535 | ( |
|
2536 | 2536 | "You executed the system command !{0} which may not work " |
|
2537 | 2537 | "as expected. Try the IPython magic %{0} instead." |
|
2538 | 2538 | ).format(main_cmd) |
|
2539 | 2539 | ) |
|
2540 | 2540 | |
|
2541 | 2541 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2542 | 2542 | if sys.platform == 'win32': |
|
2543 | 2543 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2544 | 2544 | with AvoidUNCPath() as path: |
|
2545 | 2545 | if path is not None: |
|
2546 | 2546 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2547 | 2547 | try: |
|
2548 | 2548 | ec = os.system(cmd) |
|
2549 | 2549 | except KeyboardInterrupt: |
|
2550 | 2550 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2551 | 2551 | ec = -2 |
|
2552 | 2552 | else: |
|
2553 | 2553 | # For posix the result of the subprocess.call() below is an exit |
|
2554 | 2554 | # code, which by convention is zero for success, positive for |
|
2555 | 2555 | # program failure. Exit codes above 128 are reserved for signals, |
|
2556 | 2556 | # and the formula for converting a signal to an exit code is usually |
|
2557 | 2557 | # signal_number+128. To more easily differentiate between exit |
|
2558 | 2558 | # codes and signals, ipython uses negative numbers. For instance |
|
2559 | 2559 | # since control-c is signal 2 but exit code 130, ipython's |
|
2560 | 2560 | # _exit_code variable will read -2. Note that some shells like |
|
2561 | 2561 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2562 | 2562 | executable = os.environ.get('SHELL', None) |
|
2563 | 2563 | try: |
|
2564 | 2564 | # Use env shell instead of default /bin/sh |
|
2565 | 2565 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2566 | 2566 | except KeyboardInterrupt: |
|
2567 | 2567 | # intercept control-C; a long traceback is not useful here |
|
2568 | 2568 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2569 | 2569 | ec = 130 |
|
2570 | 2570 | if ec > 128: |
|
2571 | 2571 | ec = -(ec - 128) |
|
2572 | 2572 | |
|
2573 | 2573 | # We explicitly do NOT return the subprocess status code, because |
|
2574 | 2574 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2575 | 2575 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2576 | 2576 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2577 | 2577 | # but raising SystemExit(_exit_code) will give status 254! |
|
2578 | 2578 | self.user_ns['_exit_code'] = ec |
|
2579 | 2579 | |
|
2580 | 2580 | # use piped system by default, because it is better behaved |
|
2581 | 2581 | system = system_piped |
|
2582 | 2582 | |
|
2583 | 2583 | def getoutput(self, cmd, split=True, depth=0): |
|
2584 | 2584 | """Get output (possibly including stderr) from a subprocess. |
|
2585 | 2585 | |
|
2586 | 2586 | Parameters |
|
2587 | 2587 | ---------- |
|
2588 | 2588 | cmd : str |
|
2589 | 2589 | Command to execute (can not end in '&', as background processes are |
|
2590 | 2590 | not supported. |
|
2591 | 2591 | split : bool, optional |
|
2592 | 2592 | If True, split the output into an IPython SList. Otherwise, an |
|
2593 | 2593 | IPython LSString is returned. These are objects similar to normal |
|
2594 | 2594 | lists and strings, with a few convenience attributes for easier |
|
2595 | 2595 | manipulation of line-based output. You can use '?' on them for |
|
2596 | 2596 | details. |
|
2597 | 2597 | depth : int, optional |
|
2598 | 2598 | How many frames above the caller are the local variables which should |
|
2599 | 2599 | be expanded in the command string? The default (0) assumes that the |
|
2600 | 2600 | expansion variables are in the stack frame calling this function. |
|
2601 | 2601 | """ |
|
2602 | 2602 | if cmd.rstrip().endswith('&'): |
|
2603 | 2603 | # this is *far* from a rigorous test |
|
2604 | 2604 | raise OSError("Background processes not supported.") |
|
2605 | 2605 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2606 | 2606 | if split: |
|
2607 | 2607 | out = SList(out.splitlines()) |
|
2608 | 2608 | else: |
|
2609 | 2609 | out = LSString(out) |
|
2610 | 2610 | return out |
|
2611 | 2611 | |
|
2612 | 2612 | #------------------------------------------------------------------------- |
|
2613 | 2613 | # Things related to aliases |
|
2614 | 2614 | #------------------------------------------------------------------------- |
|
2615 | 2615 | |
|
2616 | 2616 | def init_alias(self): |
|
2617 | 2617 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2618 | 2618 | self.configurables.append(self.alias_manager) |
|
2619 | 2619 | |
|
2620 | 2620 | #------------------------------------------------------------------------- |
|
2621 | 2621 | # Things related to extensions |
|
2622 | 2622 | #------------------------------------------------------------------------- |
|
2623 | 2623 | |
|
2624 | 2624 | def init_extension_manager(self): |
|
2625 | 2625 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2626 | 2626 | self.configurables.append(self.extension_manager) |
|
2627 | 2627 | |
|
2628 | 2628 | #------------------------------------------------------------------------- |
|
2629 | 2629 | # Things related to payloads |
|
2630 | 2630 | #------------------------------------------------------------------------- |
|
2631 | 2631 | |
|
2632 | 2632 | def init_payload(self): |
|
2633 | 2633 | self.payload_manager = PayloadManager(parent=self) |
|
2634 | 2634 | self.configurables.append(self.payload_manager) |
|
2635 | 2635 | |
|
2636 | 2636 | #------------------------------------------------------------------------- |
|
2637 | 2637 | # Things related to the prefilter |
|
2638 | 2638 | #------------------------------------------------------------------------- |
|
2639 | 2639 | |
|
2640 | 2640 | def init_prefilter(self): |
|
2641 | 2641 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2642 | 2642 | self.configurables.append(self.prefilter_manager) |
|
2643 | 2643 | # Ultimately this will be refactored in the new interpreter code, but |
|
2644 | 2644 | # for now, we should expose the main prefilter method (there's legacy |
|
2645 | 2645 | # code out there that may rely on this). |
|
2646 | 2646 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2647 | 2647 | |
|
2648 | 2648 | def auto_rewrite_input(self, cmd): |
|
2649 | 2649 | """Print to the screen the rewritten form of the user's command. |
|
2650 | 2650 | |
|
2651 | 2651 | This shows visual feedback by rewriting input lines that cause |
|
2652 | 2652 | automatic calling to kick in, like:: |
|
2653 | 2653 | |
|
2654 | 2654 | /f x |
|
2655 | 2655 | |
|
2656 | 2656 | into:: |
|
2657 | 2657 | |
|
2658 | 2658 | ------> f(x) |
|
2659 | 2659 | |
|
2660 | 2660 | after the user's input prompt. This helps the user understand that the |
|
2661 | 2661 | input line was transformed automatically by IPython. |
|
2662 | 2662 | """ |
|
2663 | 2663 | if not self.show_rewritten_input: |
|
2664 | 2664 | return |
|
2665 | 2665 | |
|
2666 | 2666 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2667 | 2667 | print("------> " + cmd) |
|
2668 | 2668 | |
|
2669 | 2669 | #------------------------------------------------------------------------- |
|
2670 | 2670 | # Things related to extracting values/expressions from kernel and user_ns |
|
2671 | 2671 | #------------------------------------------------------------------------- |
|
2672 | 2672 | |
|
2673 | 2673 | def _user_obj_error(self): |
|
2674 | 2674 | """return simple exception dict |
|
2675 | 2675 | |
|
2676 | 2676 | for use in user_expressions |
|
2677 | 2677 | """ |
|
2678 | 2678 | |
|
2679 | 2679 | etype, evalue, tb = self._get_exc_info() |
|
2680 | 2680 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2681 | 2681 | |
|
2682 | 2682 | exc_info = { |
|
2683 | 2683 | "status": "error", |
|
2684 | 2684 | "traceback": stb, |
|
2685 | 2685 | "ename": etype.__name__, |
|
2686 | 2686 | "evalue": py3compat.safe_unicode(evalue), |
|
2687 | 2687 | } |
|
2688 | 2688 | |
|
2689 | 2689 | return exc_info |
|
2690 | 2690 | |
|
2691 | 2691 | def _format_user_obj(self, obj): |
|
2692 | 2692 | """format a user object to display dict |
|
2693 | 2693 | |
|
2694 | 2694 | for use in user_expressions |
|
2695 | 2695 | """ |
|
2696 | 2696 | |
|
2697 | 2697 | data, md = self.display_formatter.format(obj) |
|
2698 | 2698 | value = { |
|
2699 | 2699 | 'status' : 'ok', |
|
2700 | 2700 | 'data' : data, |
|
2701 | 2701 | 'metadata' : md, |
|
2702 | 2702 | } |
|
2703 | 2703 | return value |
|
2704 | 2704 | |
|
2705 | 2705 | def user_expressions(self, expressions): |
|
2706 | 2706 | """Evaluate a dict of expressions in the user's namespace. |
|
2707 | 2707 | |
|
2708 | 2708 | Parameters |
|
2709 | 2709 | ---------- |
|
2710 | 2710 | expressions : dict |
|
2711 | 2711 | A dict with string keys and string values. The expression values |
|
2712 | 2712 | should be valid Python expressions, each of which will be evaluated |
|
2713 | 2713 | in the user namespace. |
|
2714 | 2714 | |
|
2715 | 2715 | Returns |
|
2716 | 2716 | ------- |
|
2717 | 2717 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2718 | 2718 | display_data of each value. |
|
2719 | 2719 | """ |
|
2720 | 2720 | out = {} |
|
2721 | 2721 | user_ns = self.user_ns |
|
2722 | 2722 | global_ns = self.user_global_ns |
|
2723 | 2723 | |
|
2724 | 2724 | for key, expr in expressions.items(): |
|
2725 | 2725 | try: |
|
2726 | 2726 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2727 | 2727 | except: |
|
2728 | 2728 | value = self._user_obj_error() |
|
2729 | 2729 | out[key] = value |
|
2730 | 2730 | return out |
|
2731 | 2731 | |
|
2732 | 2732 | #------------------------------------------------------------------------- |
|
2733 | 2733 | # Things related to the running of code |
|
2734 | 2734 | #------------------------------------------------------------------------- |
|
2735 | 2735 | |
|
2736 | 2736 | def ex(self, cmd): |
|
2737 | 2737 | """Execute a normal python statement in user namespace.""" |
|
2738 | 2738 | with self.builtin_trap: |
|
2739 | 2739 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2740 | 2740 | |
|
2741 | 2741 | def ev(self, expr): |
|
2742 | 2742 | """Evaluate python expression expr in user namespace. |
|
2743 | 2743 | |
|
2744 | 2744 | Returns the result of evaluation |
|
2745 | 2745 | """ |
|
2746 | 2746 | with self.builtin_trap: |
|
2747 | 2747 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2748 | 2748 | |
|
2749 | 2749 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2750 | 2750 | """A safe version of the builtin execfile(). |
|
2751 | 2751 | |
|
2752 | 2752 | This version will never throw an exception, but instead print |
|
2753 | 2753 | helpful error messages to the screen. This only works on pure |
|
2754 | 2754 | Python files with the .py extension. |
|
2755 | 2755 | |
|
2756 | 2756 | Parameters |
|
2757 | 2757 | ---------- |
|
2758 | 2758 | fname : string |
|
2759 | 2759 | The name of the file to be executed. |
|
2760 | 2760 | where : tuple |
|
2761 | 2761 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2762 | 2762 | If only one is given, it is passed as both. |
|
2763 | 2763 | exit_ignore : bool (False) |
|
2764 | 2764 | If True, then silence SystemExit for non-zero status (it is always |
|
2765 | 2765 | silenced for zero status, as it is so common). |
|
2766 | 2766 | raise_exceptions : bool (False) |
|
2767 | 2767 | If True raise exceptions everywhere. Meant for testing. |
|
2768 | 2768 | shell_futures : bool (False) |
|
2769 | 2769 | If True, the code will share future statements with the interactive |
|
2770 | 2770 | shell. It will both be affected by previous __future__ imports, and |
|
2771 | 2771 | any __future__ imports in the code will affect the shell. If False, |
|
2772 | 2772 | __future__ imports are not shared in either direction. |
|
2773 | 2773 | |
|
2774 | 2774 | """ |
|
2775 | 2775 | fname = Path(fname).expanduser().resolve() |
|
2776 | 2776 | |
|
2777 | 2777 | # Make sure we can open the file |
|
2778 | 2778 | try: |
|
2779 | 2779 | with fname.open(): |
|
2780 | 2780 | pass |
|
2781 | 2781 | except: |
|
2782 | 2782 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2783 | 2783 | return |
|
2784 | 2784 | |
|
2785 | 2785 | # Find things also in current directory. This is needed to mimic the |
|
2786 | 2786 | # behavior of running a script from the system command line, where |
|
2787 | 2787 | # Python inserts the script's directory into sys.path |
|
2788 | 2788 | dname = str(fname.parent) |
|
2789 | 2789 | |
|
2790 | 2790 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2791 | 2791 | try: |
|
2792 | 2792 | glob, loc = (where + (None, ))[:2] |
|
2793 | 2793 | py3compat.execfile( |
|
2794 | 2794 | fname, glob, loc, |
|
2795 | 2795 | self.compile if shell_futures else None) |
|
2796 | 2796 | except SystemExit as status: |
|
2797 | 2797 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2798 | 2798 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2799 | 2799 | # these are considered normal by the OS: |
|
2800 | 2800 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2801 | 2801 | # 0 |
|
2802 | 2802 | # > python -c'import sys;sys.exit()'; echo $? |
|
2803 | 2803 | # 0 |
|
2804 | 2804 | # For other exit status, we show the exception unless |
|
2805 | 2805 | # explicitly silenced, but only in short form. |
|
2806 | 2806 | if status.code: |
|
2807 | 2807 | if raise_exceptions: |
|
2808 | 2808 | raise |
|
2809 | 2809 | if not exit_ignore: |
|
2810 | 2810 | self.showtraceback(exception_only=True) |
|
2811 | 2811 | except: |
|
2812 | 2812 | if raise_exceptions: |
|
2813 | 2813 | raise |
|
2814 | 2814 | # tb offset is 2 because we wrap execfile |
|
2815 | 2815 | self.showtraceback(tb_offset=2) |
|
2816 | 2816 | |
|
2817 | 2817 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2818 | 2818 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2819 | 2819 | |
|
2820 | 2820 | Parameters |
|
2821 | 2821 | ---------- |
|
2822 | 2822 | fname : str |
|
2823 | 2823 | The name of the file to execute. The filename must have a |
|
2824 | 2824 | .ipy or .ipynb extension. |
|
2825 | 2825 | shell_futures : bool (False) |
|
2826 | 2826 | If True, the code will share future statements with the interactive |
|
2827 | 2827 | shell. It will both be affected by previous __future__ imports, and |
|
2828 | 2828 | any __future__ imports in the code will affect the shell. If False, |
|
2829 | 2829 | __future__ imports are not shared in either direction. |
|
2830 | 2830 | raise_exceptions : bool (False) |
|
2831 | 2831 | If True raise exceptions everywhere. Meant for testing. |
|
2832 | 2832 | """ |
|
2833 | 2833 | fname = Path(fname).expanduser().resolve() |
|
2834 | 2834 | |
|
2835 | 2835 | # Make sure we can open the file |
|
2836 | 2836 | try: |
|
2837 | 2837 | with fname.open(): |
|
2838 | 2838 | pass |
|
2839 | 2839 | except: |
|
2840 | 2840 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2841 | 2841 | return |
|
2842 | 2842 | |
|
2843 | 2843 | # Find things also in current directory. This is needed to mimic the |
|
2844 | 2844 | # behavior of running a script from the system command line, where |
|
2845 | 2845 | # Python inserts the script's directory into sys.path |
|
2846 | 2846 | dname = str(fname.parent) |
|
2847 | 2847 | |
|
2848 | 2848 | def get_cells(): |
|
2849 | 2849 | """generator for sequence of code blocks to run""" |
|
2850 | 2850 | if fname.suffix == ".ipynb": |
|
2851 | 2851 | from nbformat import read |
|
2852 | 2852 | nb = read(fname, as_version=4) |
|
2853 | 2853 | if not nb.cells: |
|
2854 | 2854 | return |
|
2855 | 2855 | for cell in nb.cells: |
|
2856 | 2856 | if cell.cell_type == 'code': |
|
2857 | 2857 | yield cell.source |
|
2858 | 2858 | else: |
|
2859 | 2859 | yield fname.read_text() |
|
2860 | 2860 | |
|
2861 | 2861 | with prepended_to_syspath(dname): |
|
2862 | 2862 | try: |
|
2863 | 2863 | for cell in get_cells(): |
|
2864 | 2864 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2865 | 2865 | if raise_exceptions: |
|
2866 | 2866 | result.raise_error() |
|
2867 | 2867 | elif not result.success: |
|
2868 | 2868 | break |
|
2869 | 2869 | except: |
|
2870 | 2870 | if raise_exceptions: |
|
2871 | 2871 | raise |
|
2872 | 2872 | self.showtraceback() |
|
2873 | 2873 | warn('Unknown failure executing file: <%s>' % fname) |
|
2874 | 2874 | |
|
2875 | 2875 | def safe_run_module(self, mod_name, where): |
|
2876 | 2876 | """A safe version of runpy.run_module(). |
|
2877 | 2877 | |
|
2878 | 2878 | This version will never throw an exception, but instead print |
|
2879 | 2879 | helpful error messages to the screen. |
|
2880 | 2880 | |
|
2881 | 2881 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2882 | 2882 | |
|
2883 | 2883 | Parameters |
|
2884 | 2884 | ---------- |
|
2885 | 2885 | mod_name : string |
|
2886 | 2886 | The name of the module to be executed. |
|
2887 | 2887 | where : dict |
|
2888 | 2888 | The globals namespace. |
|
2889 | 2889 | """ |
|
2890 | 2890 | try: |
|
2891 | 2891 | try: |
|
2892 | 2892 | where.update( |
|
2893 | 2893 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2894 | 2894 | alter_sys=True) |
|
2895 | 2895 | ) |
|
2896 | 2896 | except SystemExit as status: |
|
2897 | 2897 | if status.code: |
|
2898 | 2898 | raise |
|
2899 | 2899 | except: |
|
2900 | 2900 | self.showtraceback() |
|
2901 | 2901 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2902 | 2902 | |
|
2903 | 2903 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2904 | 2904 | """Run a complete IPython cell. |
|
2905 | 2905 | |
|
2906 | 2906 | Parameters |
|
2907 | 2907 | ---------- |
|
2908 | 2908 | raw_cell : str |
|
2909 | 2909 | The code (including IPython code such as %magic functions) to run. |
|
2910 | 2910 | store_history : bool |
|
2911 | 2911 | If True, the raw and translated cell will be stored in IPython's |
|
2912 | 2912 | history. For user code calling back into IPython's machinery, this |
|
2913 | 2913 | should be set to False. |
|
2914 | 2914 | silent : bool |
|
2915 | 2915 | If True, avoid side-effects, such as implicit displayhooks and |
|
2916 | 2916 | and logging. silent=True forces store_history=False. |
|
2917 | 2917 | shell_futures : bool |
|
2918 | 2918 | If True, the code will share future statements with the interactive |
|
2919 | 2919 | shell. It will both be affected by previous __future__ imports, and |
|
2920 | 2920 | any __future__ imports in the code will affect the shell. If False, |
|
2921 | 2921 | __future__ imports are not shared in either direction. |
|
2922 | 2922 | |
|
2923 | 2923 | Returns |
|
2924 | 2924 | ------- |
|
2925 | 2925 | result : :class:`ExecutionResult` |
|
2926 | 2926 | """ |
|
2927 | 2927 | result = None |
|
2928 | 2928 | try: |
|
2929 | 2929 | result = self._run_cell( |
|
2930 | 2930 | raw_cell, store_history, silent, shell_futures) |
|
2931 | 2931 | finally: |
|
2932 | 2932 | self.events.trigger('post_execute') |
|
2933 | 2933 | if not silent: |
|
2934 | 2934 | self.events.trigger('post_run_cell', result) |
|
2935 | 2935 | return result |
|
2936 | 2936 | |
|
2937 | 2937 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool) -> ExecutionResult: |
|
2938 | 2938 | """Internal method to run a complete IPython cell.""" |
|
2939 | 2939 | |
|
2940 | 2940 | # we need to avoid calling self.transform_cell multiple time on the same thing |
|
2941 | 2941 | # so we need to store some results: |
|
2942 | 2942 | preprocessing_exc_tuple = None |
|
2943 | 2943 | try: |
|
2944 | 2944 | transformed_cell = self.transform_cell(raw_cell) |
|
2945 | 2945 | except Exception: |
|
2946 | 2946 | transformed_cell = raw_cell |
|
2947 | 2947 | preprocessing_exc_tuple = sys.exc_info() |
|
2948 | 2948 | |
|
2949 | 2949 | assert transformed_cell is not None |
|
2950 | 2950 | coro = self.run_cell_async( |
|
2951 | 2951 | raw_cell, |
|
2952 | 2952 | store_history=store_history, |
|
2953 | 2953 | silent=silent, |
|
2954 | 2954 | shell_futures=shell_futures, |
|
2955 | 2955 | transformed_cell=transformed_cell, |
|
2956 | 2956 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2957 | 2957 | ) |
|
2958 | 2958 | |
|
2959 | 2959 | # run_cell_async is async, but may not actually need an eventloop. |
|
2960 | 2960 | # when this is the case, we want to run it using the pseudo_sync_runner |
|
2961 | 2961 | # so that code can invoke eventloops (for example via the %run , and |
|
2962 | 2962 | # `%paste` magic. |
|
2963 | 2963 | if self.trio_runner: |
|
2964 | 2964 | runner = self.trio_runner |
|
2965 | 2965 | elif self.should_run_async( |
|
2966 | 2966 | raw_cell, |
|
2967 | 2967 | transformed_cell=transformed_cell, |
|
2968 | 2968 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2969 | 2969 | ): |
|
2970 | 2970 | runner = self.loop_runner |
|
2971 | 2971 | else: |
|
2972 | 2972 | runner = _pseudo_sync_runner |
|
2973 | 2973 | |
|
2974 | 2974 | try: |
|
2975 | 2975 | return runner(coro) |
|
2976 | 2976 | except BaseException as e: |
|
2977 | 2977 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) |
|
2978 | 2978 | result = ExecutionResult(info) |
|
2979 | 2979 | result.error_in_exec = e |
|
2980 | 2980 | self.showtraceback(running_compiled_code=True) |
|
2981 | 2981 | return result |
|
2982 | 2982 | |
|
2983 | 2983 | def should_run_async( |
|
2984 | 2984 | self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None |
|
2985 | 2985 | ) -> bool: |
|
2986 | 2986 | """Return whether a cell should be run asynchronously via a coroutine runner |
|
2987 | 2987 | |
|
2988 | 2988 | Parameters |
|
2989 | 2989 | ---------- |
|
2990 | 2990 | raw_cell: str |
|
2991 | 2991 | The code to be executed |
|
2992 | 2992 | |
|
2993 | 2993 | Returns |
|
2994 | 2994 | ------- |
|
2995 | 2995 | result: bool |
|
2996 | 2996 | Whether the code needs to be run with a coroutine runner or not |
|
2997 | 2997 | |
|
2998 | 2998 | .. versionadded: 7.0 |
|
2999 | 2999 | """ |
|
3000 | 3000 | if not self.autoawait: |
|
3001 | 3001 | return False |
|
3002 | 3002 | if preprocessing_exc_tuple is not None: |
|
3003 | 3003 | return False |
|
3004 | 3004 | assert preprocessing_exc_tuple is None |
|
3005 | 3005 | if transformed_cell is None: |
|
3006 | 3006 | warnings.warn( |
|
3007 | 3007 | "`should_run_async` will not call `transform_cell`" |
|
3008 | 3008 | " automatically in the future. Please pass the result to" |
|
3009 | 3009 | " `transformed_cell` argument and any exception that happen" |
|
3010 | 3010 | " during the" |
|
3011 | 3011 | "transform in `preprocessing_exc_tuple` in" |
|
3012 | 3012 | " IPython 7.17 and above.", |
|
3013 | 3013 | DeprecationWarning, |
|
3014 | 3014 | stacklevel=2, |
|
3015 | 3015 | ) |
|
3016 | 3016 | try: |
|
3017 | 3017 | cell = self.transform_cell(raw_cell) |
|
3018 | 3018 | except Exception: |
|
3019 | 3019 | # any exception during transform will be raised |
|
3020 | 3020 | # prior to execution |
|
3021 | 3021 | return False |
|
3022 | 3022 | else: |
|
3023 | 3023 | cell = transformed_cell |
|
3024 | 3024 | return _should_be_async(cell) |
|
3025 | 3025 | |
|
3026 | 3026 | async def run_cell_async( |
|
3027 | 3027 | self, |
|
3028 | 3028 | raw_cell: str, |
|
3029 | 3029 | store_history=False, |
|
3030 | 3030 | silent=False, |
|
3031 | 3031 | shell_futures=True, |
|
3032 | 3032 | *, |
|
3033 | 3033 | transformed_cell: Optional[str] = None, |
|
3034 | 3034 | preprocessing_exc_tuple: Optional[Any] = None |
|
3035 | 3035 | ) -> ExecutionResult: |
|
3036 | 3036 | """Run a complete IPython cell asynchronously. |
|
3037 | 3037 | |
|
3038 | 3038 | Parameters |
|
3039 | 3039 | ---------- |
|
3040 | 3040 | raw_cell : str |
|
3041 | 3041 | The code (including IPython code such as %magic functions) to run. |
|
3042 | 3042 | store_history : bool |
|
3043 | 3043 | If True, the raw and translated cell will be stored in IPython's |
|
3044 | 3044 | history. For user code calling back into IPython's machinery, this |
|
3045 | 3045 | should be set to False. |
|
3046 | 3046 | silent : bool |
|
3047 | 3047 | If True, avoid side-effects, such as implicit displayhooks and |
|
3048 | 3048 | and logging. silent=True forces store_history=False. |
|
3049 | 3049 | shell_futures : bool |
|
3050 | 3050 | If True, the code will share future statements with the interactive |
|
3051 | 3051 | shell. It will both be affected by previous __future__ imports, and |
|
3052 | 3052 | any __future__ imports in the code will affect the shell. If False, |
|
3053 | 3053 | __future__ imports are not shared in either direction. |
|
3054 | 3054 | transformed_cell: str |
|
3055 | 3055 | cell that was passed through transformers |
|
3056 | 3056 | preprocessing_exc_tuple: |
|
3057 | 3057 | trace if the transformation failed. |
|
3058 | 3058 | |
|
3059 | 3059 | Returns |
|
3060 | 3060 | ------- |
|
3061 | 3061 | result : :class:`ExecutionResult` |
|
3062 | 3062 | |
|
3063 | 3063 | .. versionadded: 7.0 |
|
3064 | 3064 | """ |
|
3065 | 3065 | info = ExecutionInfo( |
|
3066 | 3066 | raw_cell, store_history, silent, shell_futures) |
|
3067 | 3067 | result = ExecutionResult(info) |
|
3068 | 3068 | |
|
3069 | 3069 | if (not raw_cell) or raw_cell.isspace(): |
|
3070 | 3070 | self.last_execution_succeeded = True |
|
3071 | 3071 | self.last_execution_result = result |
|
3072 | 3072 | return result |
|
3073 | 3073 | |
|
3074 | 3074 | if silent: |
|
3075 | 3075 | store_history = False |
|
3076 | 3076 | |
|
3077 | 3077 | if store_history: |
|
3078 | 3078 | result.execution_count = self.execution_count |
|
3079 | 3079 | |
|
3080 | 3080 | def error_before_exec(value): |
|
3081 | 3081 | if store_history: |
|
3082 | 3082 | self.execution_count += 1 |
|
3083 | 3083 | result.error_before_exec = value |
|
3084 | 3084 | self.last_execution_succeeded = False |
|
3085 | 3085 | self.last_execution_result = result |
|
3086 | 3086 | return result |
|
3087 | 3087 | |
|
3088 | 3088 | self.events.trigger('pre_execute') |
|
3089 | 3089 | if not silent: |
|
3090 | 3090 | self.events.trigger('pre_run_cell', info) |
|
3091 | 3091 | |
|
3092 | 3092 | if transformed_cell is None: |
|
3093 | 3093 | warnings.warn( |
|
3094 | 3094 | "`run_cell_async` will not call `transform_cell`" |
|
3095 | 3095 | " automatically in the future. Please pass the result to" |
|
3096 | 3096 | " `transformed_cell` argument and any exception that happen" |
|
3097 | 3097 | " during the" |
|
3098 | 3098 | "transform in `preprocessing_exc_tuple` in" |
|
3099 | 3099 | " IPython 7.17 and above.", |
|
3100 | 3100 | DeprecationWarning, |
|
3101 | 3101 | stacklevel=2, |
|
3102 | 3102 | ) |
|
3103 | 3103 | # If any of our input transformation (input_transformer_manager or |
|
3104 | 3104 | # prefilter_manager) raises an exception, we store it in this variable |
|
3105 | 3105 | # so that we can display the error after logging the input and storing |
|
3106 | 3106 | # it in the history. |
|
3107 | 3107 | try: |
|
3108 | 3108 | cell = self.transform_cell(raw_cell) |
|
3109 | 3109 | except Exception: |
|
3110 | 3110 | preprocessing_exc_tuple = sys.exc_info() |
|
3111 | 3111 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
3112 | 3112 | else: |
|
3113 | 3113 | preprocessing_exc_tuple = None |
|
3114 | 3114 | else: |
|
3115 | 3115 | if preprocessing_exc_tuple is None: |
|
3116 | 3116 | cell = transformed_cell |
|
3117 | 3117 | else: |
|
3118 | 3118 | cell = raw_cell |
|
3119 | 3119 | |
|
3120 | 3120 | # Store raw and processed history |
|
3121 | 3121 | if store_history: |
|
3122 | 3122 | self.history_manager.store_inputs(self.execution_count, |
|
3123 | 3123 | cell, raw_cell) |
|
3124 | 3124 | if not silent: |
|
3125 | 3125 | self.logger.log(cell, raw_cell) |
|
3126 | 3126 | |
|
3127 | 3127 | # Display the exception if input processing failed. |
|
3128 | 3128 | if preprocessing_exc_tuple is not None: |
|
3129 | 3129 | self.showtraceback(preprocessing_exc_tuple) |
|
3130 | 3130 | if store_history: |
|
3131 | 3131 | self.execution_count += 1 |
|
3132 | 3132 | return error_before_exec(preprocessing_exc_tuple[1]) |
|
3133 | 3133 | |
|
3134 | 3134 | # Our own compiler remembers the __future__ environment. If we want to |
|
3135 | 3135 | # run code with a separate __future__ environment, use the default |
|
3136 | 3136 | # compiler |
|
3137 | 3137 | compiler = self.compile if shell_futures else self.compiler_class() |
|
3138 | 3138 | |
|
3139 | 3139 | _run_async = False |
|
3140 | 3140 | |
|
3141 | 3141 | with self.builtin_trap: |
|
3142 | 3142 | cell_name = compiler.cache(cell, self.execution_count, raw_code=raw_cell) |
|
3143 | 3143 | |
|
3144 | 3144 | with self.display_trap: |
|
3145 | 3145 | # Compile to bytecode |
|
3146 | 3146 | try: |
|
3147 | 3147 | if sys.version_info < (3,8) and self.autoawait: |
|
3148 | 3148 | if _should_be_async(cell): |
|
3149 | 3149 | # the code AST below will not be user code: we wrap it |
|
3150 | 3150 | # in an `async def`. This will likely make some AST |
|
3151 | 3151 | # transformer below miss some transform opportunity and |
|
3152 | 3152 | # introduce a small coupling to run_code (in which we |
|
3153 | 3153 | # bake some assumptions of what _ast_asyncify returns. |
|
3154 | 3154 | # they are ways around (like grafting part of the ast |
|
3155 | 3155 | # later: |
|
3156 | 3156 | # - Here, return code_ast.body[0].body[1:-1], as well |
|
3157 | 3157 | # as last expression in return statement which is |
|
3158 | 3158 | # the user code part. |
|
3159 | 3159 | # - Let it go through the AST transformers, and graft |
|
3160 | 3160 | # - it back after the AST transform |
|
3161 | 3161 | # But that seem unreasonable, at least while we |
|
3162 | 3162 | # do not need it. |
|
3163 | 3163 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') |
|
3164 | 3164 | _run_async = True |
|
3165 | 3165 | else: |
|
3166 | 3166 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3167 | 3167 | else: |
|
3168 | 3168 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3169 | 3169 | except self.custom_exceptions as e: |
|
3170 | 3170 | etype, value, tb = sys.exc_info() |
|
3171 | 3171 | self.CustomTB(etype, value, tb) |
|
3172 | 3172 | return error_before_exec(e) |
|
3173 | 3173 | except IndentationError as e: |
|
3174 | 3174 | self.showindentationerror() |
|
3175 | 3175 | return error_before_exec(e) |
|
3176 | 3176 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
3177 | 3177 | MemoryError) as e: |
|
3178 | 3178 | self.showsyntaxerror() |
|
3179 | 3179 | return error_before_exec(e) |
|
3180 | 3180 | |
|
3181 | 3181 | # Apply AST transformations |
|
3182 | 3182 | try: |
|
3183 | 3183 | code_ast = self.transform_ast(code_ast) |
|
3184 | 3184 | except InputRejected as e: |
|
3185 | 3185 | self.showtraceback() |
|
3186 | 3186 | return error_before_exec(e) |
|
3187 | 3187 | |
|
3188 | 3188 | # Give the displayhook a reference to our ExecutionResult so it |
|
3189 | 3189 | # can fill in the output value. |
|
3190 | 3190 | self.displayhook.exec_result = result |
|
3191 | 3191 | |
|
3192 | 3192 | # Execute the user code |
|
3193 | 3193 | interactivity = "none" if silent else self.ast_node_interactivity |
|
3194 | 3194 | if _run_async: |
|
3195 | 3195 | interactivity = 'async' |
|
3196 | 3196 | |
|
3197 | 3197 | has_raised = await self.run_ast_nodes(code_ast.body, cell_name, |
|
3198 | 3198 | interactivity=interactivity, compiler=compiler, result=result) |
|
3199 | 3199 | |
|
3200 | 3200 | self.last_execution_succeeded = not has_raised |
|
3201 | 3201 | self.last_execution_result = result |
|
3202 | 3202 | |
|
3203 | 3203 | # Reset this so later displayed values do not modify the |
|
3204 | 3204 | # ExecutionResult |
|
3205 | 3205 | self.displayhook.exec_result = None |
|
3206 | 3206 | |
|
3207 | 3207 | if store_history: |
|
3208 | 3208 | # Write output to the database. Does nothing unless |
|
3209 | 3209 | # history output logging is enabled. |
|
3210 | 3210 | self.history_manager.store_output(self.execution_count) |
|
3211 | 3211 | # Each cell is a *single* input, regardless of how many lines it has |
|
3212 | 3212 | self.execution_count += 1 |
|
3213 | 3213 | |
|
3214 | 3214 | return result |
|
3215 | 3215 | |
|
3216 | 3216 | def transform_cell(self, raw_cell): |
|
3217 | 3217 | """Transform an input cell before parsing it. |
|
3218 | 3218 | |
|
3219 | 3219 | Static transformations, implemented in IPython.core.inputtransformer2, |
|
3220 | 3220 | deal with things like ``%magic`` and ``!system`` commands. |
|
3221 | 3221 | These run on all input. |
|
3222 | 3222 | Dynamic transformations, for things like unescaped magics and the exit |
|
3223 | 3223 | autocall, depend on the state of the interpreter. |
|
3224 | 3224 | These only apply to single line inputs. |
|
3225 | 3225 | |
|
3226 | 3226 | These string-based transformations are followed by AST transformations; |
|
3227 | 3227 | see :meth:`transform_ast`. |
|
3228 | 3228 | """ |
|
3229 | 3229 | # Static input transformations |
|
3230 | 3230 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
3231 | 3231 | |
|
3232 | 3232 | if len(cell.splitlines()) == 1: |
|
3233 | 3233 | # Dynamic transformations - only applied for single line commands |
|
3234 | 3234 | with self.builtin_trap: |
|
3235 | 3235 | # use prefilter_lines to handle trailing newlines |
|
3236 | 3236 | # restore trailing newline for ast.parse |
|
3237 | 3237 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
3238 | 3238 | |
|
3239 | 3239 | lines = cell.splitlines(keepends=True) |
|
3240 | 3240 | for transform in self.input_transformers_post: |
|
3241 | 3241 | lines = transform(lines) |
|
3242 | 3242 | cell = ''.join(lines) |
|
3243 | 3243 | |
|
3244 | 3244 | return cell |
|
3245 | 3245 | |
|
3246 | 3246 | def transform_ast(self, node): |
|
3247 | 3247 | """Apply the AST transformations from self.ast_transformers |
|
3248 | 3248 | |
|
3249 | 3249 | Parameters |
|
3250 | 3250 | ---------- |
|
3251 | 3251 | node : ast.Node |
|
3252 | 3252 | The root node to be transformed. Typically called with the ast.Module |
|
3253 | 3253 | produced by parsing user input. |
|
3254 | 3254 | |
|
3255 | 3255 | Returns |
|
3256 | 3256 | ------- |
|
3257 | 3257 | An ast.Node corresponding to the node it was called with. Note that it |
|
3258 | 3258 | may also modify the passed object, so don't rely on references to the |
|
3259 | 3259 | original AST. |
|
3260 | 3260 | """ |
|
3261 | 3261 | for transformer in self.ast_transformers: |
|
3262 | 3262 | try: |
|
3263 | 3263 | node = transformer.visit(node) |
|
3264 | 3264 | except InputRejected: |
|
3265 | 3265 | # User-supplied AST transformers can reject an input by raising |
|
3266 | 3266 | # an InputRejected. Short-circuit in this case so that we |
|
3267 | 3267 | # don't unregister the transform. |
|
3268 | 3268 | raise |
|
3269 | 3269 | except Exception: |
|
3270 | 3270 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
3271 | 3271 | self.ast_transformers.remove(transformer) |
|
3272 | 3272 | |
|
3273 | 3273 | if self.ast_transformers: |
|
3274 | 3274 | ast.fix_missing_locations(node) |
|
3275 | 3275 | return node |
|
3276 | 3276 | |
|
3277 | 3277 | async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
3278 | 3278 | compiler=compile, result=None): |
|
3279 | 3279 | """Run a sequence of AST nodes. The execution mode depends on the |
|
3280 | 3280 | interactivity parameter. |
|
3281 | 3281 | |
|
3282 | 3282 | Parameters |
|
3283 | 3283 | ---------- |
|
3284 | 3284 | nodelist : list |
|
3285 | 3285 | A sequence of AST nodes to run. |
|
3286 | 3286 | cell_name : str |
|
3287 | 3287 | Will be passed to the compiler as the filename of the cell. Typically |
|
3288 | 3288 | the value returned by ip.compile.cache(cell). |
|
3289 | 3289 | interactivity : str |
|
3290 | 3290 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
3291 | 3291 | specifying which nodes should be run interactively (displaying output |
|
3292 | 3292 | from expressions). 'last_expr' will run the last node interactively |
|
3293 | 3293 | only if it is an expression (i.e. expressions in loops or other blocks |
|
3294 | 3294 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
3295 | 3295 | or the last assignment. Other values for this parameter will raise a |
|
3296 | 3296 | ValueError. |
|
3297 | 3297 | |
|
3298 | 3298 | Experimental value: 'async' Will try to run top level interactive |
|
3299 | 3299 | async/await code in default runner, this will not respect the |
|
3300 | 3300 | interactivity setting and will only run the last node if it is an |
|
3301 | 3301 | expression. |
|
3302 | 3302 | |
|
3303 | 3303 | compiler : callable |
|
3304 | 3304 | A function with the same interface as the built-in compile(), to turn |
|
3305 | 3305 | the AST nodes into code objects. Default is the built-in compile(). |
|
3306 | 3306 | result : ExecutionResult, optional |
|
3307 | 3307 | An object to store exceptions that occur during execution. |
|
3308 | 3308 | |
|
3309 | 3309 | Returns |
|
3310 | 3310 | ------- |
|
3311 | 3311 | True if an exception occurred while running code, False if it finished |
|
3312 | 3312 | running. |
|
3313 | 3313 | """ |
|
3314 | 3314 | if not nodelist: |
|
3315 | 3315 | return |
|
3316 | 3316 | |
|
3317 | 3317 | if interactivity == 'last_expr_or_assign': |
|
3318 | 3318 | if isinstance(nodelist[-1], _assign_nodes): |
|
3319 | 3319 | asg = nodelist[-1] |
|
3320 | 3320 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
3321 | 3321 | target = asg.targets[0] |
|
3322 | 3322 | elif isinstance(asg, _single_targets_nodes): |
|
3323 | 3323 | target = asg.target |
|
3324 | 3324 | else: |
|
3325 | 3325 | target = None |
|
3326 | 3326 | if isinstance(target, ast.Name): |
|
3327 | 3327 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
3328 | 3328 | ast.fix_missing_locations(nnode) |
|
3329 | 3329 | nodelist.append(nnode) |
|
3330 | 3330 | interactivity = 'last_expr' |
|
3331 | 3331 | |
|
3332 | 3332 | _async = False |
|
3333 | 3333 | if interactivity == 'last_expr': |
|
3334 | 3334 | if isinstance(nodelist[-1], ast.Expr): |
|
3335 | 3335 | interactivity = "last" |
|
3336 | 3336 | else: |
|
3337 | 3337 | interactivity = "none" |
|
3338 | 3338 | |
|
3339 | 3339 | if interactivity == 'none': |
|
3340 | 3340 | to_run_exec, to_run_interactive = nodelist, [] |
|
3341 | 3341 | elif interactivity == 'last': |
|
3342 | 3342 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
3343 | 3343 | elif interactivity == 'all': |
|
3344 | 3344 | to_run_exec, to_run_interactive = [], nodelist |
|
3345 | 3345 | elif interactivity == 'async': |
|
3346 | 3346 | to_run_exec, to_run_interactive = [], nodelist |
|
3347 | 3347 | _async = True |
|
3348 | 3348 | else: |
|
3349 | 3349 | raise ValueError("Interactivity was %r" % interactivity) |
|
3350 | 3350 | |
|
3351 | 3351 | try: |
|
3352 | 3352 | if _async and sys.version_info > (3,8): |
|
3353 | 3353 | raise ValueError("This branch should never happen on Python 3.8 and above, " |
|
3354 | 3354 | "please try to upgrade IPython and open a bug report with your case.") |
|
3355 | 3355 | if _async: |
|
3356 | 3356 | # If interactivity is async the semantics of run_code are |
|
3357 | 3357 | # completely different Skip usual machinery. |
|
3358 | 3358 | mod = Module(nodelist, []) |
|
3359 | 3359 | async_wrapper_code = compiler(mod, cell_name, 'exec') |
|
3360 | 3360 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) |
|
3361 | 3361 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ |
|
3362 | 3362 | if (await self.run_code(async_code, result, async_=True)): |
|
3363 | 3363 | return True |
|
3364 | 3364 | else: |
|
3365 | 3365 | if sys.version_info > (3, 8): |
|
3366 | 3366 | def compare(code): |
|
3367 | 3367 | is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE) |
|
3368 | 3368 | return is_async |
|
3369 | 3369 | else: |
|
3370 | 3370 | def compare(code): |
|
3371 | 3371 | return _async |
|
3372 | 3372 | |
|
3373 | 3373 | # refactor that to just change the mod constructor. |
|
3374 | 3374 | to_run = [] |
|
3375 | 3375 | for node in to_run_exec: |
|
3376 | 3376 | to_run.append((node, 'exec')) |
|
3377 | 3377 | |
|
3378 | 3378 | for node in to_run_interactive: |
|
3379 | 3379 | to_run.append((node, 'single')) |
|
3380 | 3380 | |
|
3381 | 3381 | for node,mode in to_run: |
|
3382 | 3382 | if mode == 'exec': |
|
3383 | 3383 | mod = Module([node], []) |
|
3384 | 3384 | elif mode == 'single': |
|
3385 | 3385 | mod = ast.Interactive([node]) |
|
3386 | 3386 | with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0): |
|
3387 | 3387 | code = compiler(mod, cell_name, mode) |
|
3388 | 3388 | asy = compare(code) |
|
3389 | 3389 | if (await self.run_code(code, result, async_=asy)): |
|
3390 | 3390 | return True |
|
3391 | 3391 | |
|
3392 | 3392 | # Flush softspace |
|
3393 | 3393 | if softspace(sys.stdout, 0): |
|
3394 | 3394 | print() |
|
3395 | 3395 | |
|
3396 | 3396 | except: |
|
3397 | 3397 | # It's possible to have exceptions raised here, typically by |
|
3398 | 3398 | # compilation of odd code (such as a naked 'return' outside a |
|
3399 | 3399 | # function) that did parse but isn't valid. Typically the exception |
|
3400 | 3400 | # is a SyntaxError, but it's safest just to catch anything and show |
|
3401 | 3401 | # the user a traceback. |
|
3402 | 3402 | |
|
3403 | 3403 | # We do only one try/except outside the loop to minimize the impact |
|
3404 | 3404 | # on runtime, and also because if any node in the node list is |
|
3405 | 3405 | # broken, we should stop execution completely. |
|
3406 | 3406 | if result: |
|
3407 | 3407 | result.error_before_exec = sys.exc_info()[1] |
|
3408 | 3408 | self.showtraceback() |
|
3409 | 3409 | return True |
|
3410 | 3410 | |
|
3411 | 3411 | return False |
|
3412 | 3412 | |
|
3413 | 3413 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): |
|
3414 | 3414 | """ |
|
3415 | 3415 | Evaluate an asynchronous code object using a code runner |
|
3416 | 3416 | |
|
3417 | 3417 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. |
|
3418 | 3418 | |
|
3419 | 3419 | Returns coroutine object, which can be executed via async loop runner |
|
3420 | 3420 | |
|
3421 | 3421 | WARNING: The semantics of `async_exec` are quite different from `exec`, |
|
3422 | 3422 | in particular you can only pass a single namespace. It also return a |
|
3423 | 3423 | handle to the value of the last things returned by code_object. |
|
3424 | 3424 | """ |
|
3425 | 3425 | |
|
3426 | 3426 | return eval(code_obj, user_ns) |
|
3427 | 3427 | |
|
3428 | 3428 | async def run_code(self, code_obj, result=None, *, async_=False): |
|
3429 | 3429 | """Execute a code object. |
|
3430 | 3430 | |
|
3431 | 3431 | When an exception occurs, self.showtraceback() is called to display a |
|
3432 | 3432 | traceback. |
|
3433 | 3433 | |
|
3434 | 3434 | Parameters |
|
3435 | 3435 | ---------- |
|
3436 | 3436 | code_obj : code object |
|
3437 | 3437 | A compiled code object, to be executed |
|
3438 | 3438 | result : ExecutionResult, optional |
|
3439 | 3439 | An object to store exceptions that occur during execution. |
|
3440 | 3440 | async_ : Bool (Experimental) |
|
3441 | 3441 | Attempt to run top-level asynchronous code in a default loop. |
|
3442 | 3442 | |
|
3443 | 3443 | Returns |
|
3444 | 3444 | ------- |
|
3445 | 3445 | False : successful execution. |
|
3446 | 3446 | True : an error occurred. |
|
3447 | 3447 | """ |
|
3448 | 3448 | # special value to say that anything above is IPython and should be |
|
3449 | 3449 | # hidden. |
|
3450 | 3450 | __tracebackhide__ = "__ipython_bottom__" |
|
3451 | 3451 | # Set our own excepthook in case the user code tries to call it |
|
3452 | 3452 | # directly, so that the IPython crash handler doesn't get triggered |
|
3453 | 3453 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
3454 | 3454 | |
|
3455 | 3455 | # we save the original sys.excepthook in the instance, in case config |
|
3456 | 3456 | # code (such as magics) needs access to it. |
|
3457 | 3457 | self.sys_excepthook = old_excepthook |
|
3458 | 3458 | outflag = True # happens in more places, so it's easier as default |
|
3459 | 3459 | try: |
|
3460 | 3460 | try: |
|
3461 | 3461 | self.hooks.pre_run_code_hook() |
|
3462 | 3462 | if async_ and sys.version_info < (3,8): |
|
3463 | 3463 | last_expr = (await self._async_exec(code_obj, self.user_ns)) |
|
3464 | 3464 | code = compile('last_expr', 'fake', "single") |
|
3465 | 3465 | exec(code, {'last_expr': last_expr}) |
|
3466 | 3466 | elif async_ : |
|
3467 | 3467 | await eval(code_obj, self.user_global_ns, self.user_ns) |
|
3468 | 3468 | else: |
|
3469 | 3469 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
3470 | 3470 | finally: |
|
3471 | 3471 | # Reset our crash handler in place |
|
3472 | 3472 | sys.excepthook = old_excepthook |
|
3473 | 3473 | except SystemExit as e: |
|
3474 | 3474 | if result is not None: |
|
3475 | 3475 | result.error_in_exec = e |
|
3476 | 3476 | self.showtraceback(exception_only=True) |
|
3477 | 3477 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
3478 | 3478 | except self.custom_exceptions: |
|
3479 | 3479 | etype, value, tb = sys.exc_info() |
|
3480 | 3480 | if result is not None: |
|
3481 | 3481 | result.error_in_exec = value |
|
3482 | 3482 | self.CustomTB(etype, value, tb) |
|
3483 | 3483 | except: |
|
3484 | 3484 | if result is not None: |
|
3485 | 3485 | result.error_in_exec = sys.exc_info()[1] |
|
3486 | 3486 | self.showtraceback(running_compiled_code=True) |
|
3487 | 3487 | else: |
|
3488 | 3488 | outflag = False |
|
3489 | 3489 | return outflag |
|
3490 | 3490 | |
|
3491 | 3491 | # For backwards compatibility |
|
3492 | 3492 | runcode = run_code |
|
3493 | 3493 | |
|
3494 | 3494 | def check_complete(self, code: str) -> Tuple[str, str]: |
|
3495 | 3495 | """Return whether a block of code is ready to execute, or should be continued |
|
3496 | 3496 | |
|
3497 | 3497 | Parameters |
|
3498 | 3498 | ---------- |
|
3499 | 3499 | source : string |
|
3500 | 3500 | Python input code, which can be multiline. |
|
3501 | 3501 | |
|
3502 | 3502 | Returns |
|
3503 | 3503 | ------- |
|
3504 | 3504 | status : str |
|
3505 | 3505 | One of 'complete', 'incomplete', or 'invalid' if source is not a |
|
3506 | 3506 | prefix of valid code. |
|
3507 | 3507 | indent : str |
|
3508 | 3508 | When status is 'incomplete', this is some whitespace to insert on |
|
3509 | 3509 | the next line of the prompt. |
|
3510 | 3510 | """ |
|
3511 | 3511 | status, nspaces = self.input_transformer_manager.check_complete(code) |
|
3512 | 3512 | return status, ' ' * (nspaces or 0) |
|
3513 | 3513 | |
|
3514 | 3514 | #------------------------------------------------------------------------- |
|
3515 | 3515 | # Things related to GUI support and pylab |
|
3516 | 3516 | #------------------------------------------------------------------------- |
|
3517 | 3517 | |
|
3518 | 3518 | active_eventloop = None |
|
3519 | 3519 | |
|
3520 | 3520 | def enable_gui(self, gui=None): |
|
3521 | 3521 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
3522 | 3522 | |
|
3523 | 3523 | def enable_matplotlib(self, gui=None): |
|
3524 | 3524 | """Enable interactive matplotlib and inline figure support. |
|
3525 | 3525 | |
|
3526 | 3526 | This takes the following steps: |
|
3527 | 3527 | |
|
3528 | 3528 | 1. select the appropriate eventloop and matplotlib backend |
|
3529 | 3529 | 2. set up matplotlib for interactive use with that backend |
|
3530 | 3530 | 3. configure formatters for inline figure display |
|
3531 | 3531 | 4. enable the selected gui eventloop |
|
3532 | 3532 | |
|
3533 | 3533 | Parameters |
|
3534 | 3534 | ---------- |
|
3535 | 3535 | gui : optional, string |
|
3536 | 3536 | If given, dictates the choice of matplotlib GUI backend to use |
|
3537 | 3537 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3538 | 3538 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3539 | 3539 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3540 | 3540 | user's matplotlibrc configuration file). Note that not all backends |
|
3541 | 3541 | make sense in all contexts, for example a terminal ipython can't |
|
3542 | 3542 | display figures inline. |
|
3543 | 3543 | """ |
|
3544 | 3544 | from IPython.core import pylabtools as pt |
|
3545 | 3545 | from matplotlib_inline.backend_inline import configure_inline_support |
|
3546 | 3546 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3547 | 3547 | |
|
3548 | 3548 | if gui != 'inline': |
|
3549 | 3549 | # If we have our first gui selection, store it |
|
3550 | 3550 | if self.pylab_gui_select is None: |
|
3551 | 3551 | self.pylab_gui_select = gui |
|
3552 | 3552 | # Otherwise if they are different |
|
3553 | 3553 | elif gui != self.pylab_gui_select: |
|
3554 | 3554 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3555 | 3555 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3556 | 3556 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3557 | 3557 | |
|
3558 | 3558 | pt.activate_matplotlib(backend) |
|
3559 | 3559 | configure_inline_support(self, backend) |
|
3560 | 3560 | |
|
3561 | 3561 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3562 | 3562 | # plot updates into account |
|
3563 | 3563 | self.enable_gui(gui) |
|
3564 | 3564 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3565 | 3565 | pt.mpl_runner(self.safe_execfile) |
|
3566 | 3566 | |
|
3567 | 3567 | return gui, backend |
|
3568 | 3568 | |
|
3569 | 3569 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3570 | 3570 | """Activate pylab support at runtime. |
|
3571 | 3571 | |
|
3572 | 3572 | This turns on support for matplotlib, preloads into the interactive |
|
3573 | 3573 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3574 | 3574 | interact with the GUI event loop. The GUI backend to be used can be |
|
3575 | 3575 | optionally selected with the optional ``gui`` argument. |
|
3576 | 3576 | |
|
3577 | 3577 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3578 | 3578 | |
|
3579 | 3579 | Parameters |
|
3580 | 3580 | ---------- |
|
3581 | 3581 | gui : optional, string |
|
3582 | 3582 | If given, dictates the choice of matplotlib GUI backend to use |
|
3583 | 3583 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3584 | 3584 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3585 | 3585 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3586 | 3586 | user's matplotlibrc configuration file). Note that not all backends |
|
3587 | 3587 | make sense in all contexts, for example a terminal ipython can't |
|
3588 | 3588 | display figures inline. |
|
3589 | 3589 | import_all : optional, bool, default: True |
|
3590 | 3590 | Whether to do `from numpy import *` and `from pylab import *` |
|
3591 | 3591 | in addition to module imports. |
|
3592 | 3592 | welcome_message : deprecated |
|
3593 | 3593 | This argument is ignored, no welcome message will be displayed. |
|
3594 | 3594 | """ |
|
3595 | 3595 | from IPython.core.pylabtools import import_pylab |
|
3596 | 3596 | |
|
3597 | 3597 | gui, backend = self.enable_matplotlib(gui) |
|
3598 | 3598 | |
|
3599 | 3599 | # We want to prevent the loading of pylab to pollute the user's |
|
3600 | 3600 | # namespace as shown by the %who* magics, so we execute the activation |
|
3601 | 3601 | # code in an empty namespace, and we update *both* user_ns and |
|
3602 | 3602 | # user_ns_hidden with this information. |
|
3603 | 3603 | ns = {} |
|
3604 | 3604 | import_pylab(ns, import_all) |
|
3605 | 3605 | # warn about clobbered names |
|
3606 | 3606 | ignored = {"__builtins__"} |
|
3607 | 3607 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3608 | 3608 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3609 | 3609 | self.user_ns.update(ns) |
|
3610 | 3610 | self.user_ns_hidden.update(ns) |
|
3611 | 3611 | return gui, backend, clobbered |
|
3612 | 3612 | |
|
3613 | 3613 | #------------------------------------------------------------------------- |
|
3614 | 3614 | # Utilities |
|
3615 | 3615 | #------------------------------------------------------------------------- |
|
3616 | 3616 | |
|
3617 | 3617 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3618 | 3618 | """Expand python variables in a string. |
|
3619 | 3619 | |
|
3620 | 3620 | The depth argument indicates how many frames above the caller should |
|
3621 | 3621 | be walked to look for the local namespace where to expand variables. |
|
3622 | 3622 | |
|
3623 | 3623 | The global namespace for expansion is always the user's interactive |
|
3624 | 3624 | namespace. |
|
3625 | 3625 | """ |
|
3626 | 3626 | ns = self.user_ns.copy() |
|
3627 | 3627 | try: |
|
3628 | 3628 | frame = sys._getframe(depth+1) |
|
3629 | 3629 | except ValueError: |
|
3630 | 3630 | # This is thrown if there aren't that many frames on the stack, |
|
3631 | 3631 | # e.g. if a script called run_line_magic() directly. |
|
3632 | 3632 | pass |
|
3633 | 3633 | else: |
|
3634 | 3634 | ns.update(frame.f_locals) |
|
3635 | 3635 | |
|
3636 | 3636 | try: |
|
3637 | 3637 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3638 | 3638 | # name, and expanding **ns for .format() would make it collide with |
|
3639 | 3639 | # the 'self' argument of the method. |
|
3640 | 3640 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3641 | 3641 | except Exception: |
|
3642 | 3642 | # if formatter couldn't format, just let it go untransformed |
|
3643 | 3643 | pass |
|
3644 | 3644 | return cmd |
|
3645 | 3645 | |
|
3646 | 3646 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3647 | 3647 | """Make a new tempfile and return its filename. |
|
3648 | 3648 | |
|
3649 | 3649 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3650 | 3650 | but it registers the created filename internally so ipython cleans it up |
|
3651 | 3651 | at exit time. |
|
3652 | 3652 | |
|
3653 | 3653 | Optional inputs: |
|
3654 | 3654 | |
|
3655 | 3655 | - data(None): if data is given, it gets written out to the temp file |
|
3656 | 3656 | immediately, and the file is closed again.""" |
|
3657 | 3657 | |
|
3658 | 3658 | dir_path = Path(tempfile.mkdtemp(prefix=prefix)) |
|
3659 | 3659 | self.tempdirs.append(dir_path) |
|
3660 | 3660 | |
|
3661 | 3661 | handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path)) |
|
3662 | 3662 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3663 | 3663 | |
|
3664 | 3664 | file_path = Path(filename) |
|
3665 | 3665 | self.tempfiles.append(file_path) |
|
3666 | 3666 | |
|
3667 | 3667 | if data: |
|
3668 | 3668 | file_path.write_text(data) |
|
3669 | 3669 | return filename |
|
3670 | 3670 | |
|
3671 | 3671 | @undoc |
|
3672 | 3672 | def write(self,data): |
|
3673 | 3673 | """DEPRECATED: Write a string to the default output""" |
|
3674 | 3674 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3675 | 3675 | DeprecationWarning, stacklevel=2) |
|
3676 | 3676 | sys.stdout.write(data) |
|
3677 | 3677 | |
|
3678 | 3678 | @undoc |
|
3679 | 3679 | def write_err(self,data): |
|
3680 | 3680 | """DEPRECATED: Write a string to the default error output""" |
|
3681 | 3681 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3682 | 3682 | DeprecationWarning, stacklevel=2) |
|
3683 | 3683 | sys.stderr.write(data) |
|
3684 | 3684 | |
|
3685 | 3685 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3686 | 3686 | if self.quiet: |
|
3687 | 3687 | return True |
|
3688 | 3688 | return ask_yes_no(prompt,default,interrupt) |
|
3689 | 3689 | |
|
3690 | 3690 | def show_usage(self): |
|
3691 | 3691 | """Show a usage message""" |
|
3692 | 3692 | page.page(IPython.core.usage.interactive_usage) |
|
3693 | 3693 | |
|
3694 | 3694 | def extract_input_lines(self, range_str, raw=False): |
|
3695 | 3695 | """Return as a string a set of input history slices. |
|
3696 | 3696 | |
|
3697 | 3697 | Parameters |
|
3698 | 3698 | ---------- |
|
3699 |
range_str : str |
|
|
3699 | range_str : str | |
|
3700 | 3700 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3701 | 3701 | since this function is for use by magic functions which get their |
|
3702 | 3702 | arguments as strings. The number before the / is the session |
|
3703 | 3703 | number: ~n goes n back from the current session. |
|
3704 | 3704 | |
|
3705 | If empty string is given, returns history of current session | |
|
3706 | without the last input. | |
|
3707 | ||
|
3705 | 3708 | raw : bool, optional |
|
3706 | 3709 | By default, the processed input is used. If this is true, the raw |
|
3707 | 3710 | input history is used instead. |
|
3708 | 3711 | |
|
3709 | 3712 | Notes |
|
3710 | 3713 | ----- |
|
3711 | 3714 | |
|
3712 | 3715 | Slices can be described with two notations: |
|
3713 | 3716 | |
|
3714 | 3717 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3715 | 3718 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3716 | 3719 | """ |
|
3717 | 3720 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3718 |
|
|
|
3721 | text = "\n".join(x for _, _, x in lines) | |
|
3722 | ||
|
3723 | # Skip the last line, as it's probably the magic that called this | |
|
3724 | if not range_str: | |
|
3725 | if "\n" not in text: | |
|
3726 | text = "" | |
|
3727 | else: | |
|
3728 | text = text[: text.rfind("\n")] | |
|
3729 | ||
|
3730 | return text | |
|
3719 | 3731 | |
|
3720 | 3732 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3721 | 3733 | """Get a code string from history, file, url, or a string or macro. |
|
3722 | 3734 | |
|
3723 | 3735 | This is mainly used by magic functions. |
|
3724 | 3736 | |
|
3725 | 3737 | Parameters |
|
3726 | 3738 | ---------- |
|
3727 | ||
|
3728 | 3739 | target : str |
|
3729 | ||
|
3730 | 3740 | A string specifying code to retrieve. This will be tried respectively |
|
3731 | 3741 | as: ranges of input history (see %history for syntax), url, |
|
3732 | 3742 | corresponding .py file, filename, or an expression evaluating to a |
|
3733 | 3743 | string or Macro in the user namespace. |
|
3734 | 3744 | |
|
3745 | If empty string is given, returns complete history of current | |
|
3746 | session, without the last line. | |
|
3747 | ||
|
3735 | 3748 | raw : bool |
|
3736 | 3749 | If true (default), retrieve raw history. Has no effect on the other |
|
3737 | 3750 | retrieval mechanisms. |
|
3738 | 3751 | |
|
3739 | 3752 | py_only : bool (default False) |
|
3740 | 3753 | Only try to fetch python code, do not try alternative methods to decode file |
|
3741 | 3754 | if unicode fails. |
|
3742 | 3755 | |
|
3743 | 3756 | Returns |
|
3744 | 3757 | ------- |
|
3745 | 3758 | A string of code. |
|
3746 | 3759 | |
|
3747 | 3760 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3748 | 3761 | to an object of another type. In each case, .args[0] is a printable |
|
3749 | 3762 | message. |
|
3750 | 3763 | """ |
|
3751 | 3764 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3752 | 3765 | if code: |
|
3753 | 3766 | return code |
|
3754 | 3767 | try: |
|
3755 | 3768 | if target.startswith(('http://', 'https://')): |
|
3756 | 3769 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3757 | 3770 | except UnicodeDecodeError as e: |
|
3758 | 3771 | if not py_only : |
|
3759 | 3772 | # Deferred import |
|
3760 | 3773 | from urllib.request import urlopen |
|
3761 | 3774 | response = urlopen(target) |
|
3762 | 3775 | return response.read().decode('latin1') |
|
3763 | 3776 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3764 | 3777 | |
|
3765 | 3778 | potential_target = [target] |
|
3766 | 3779 | try : |
|
3767 | 3780 | potential_target.insert(0,get_py_filename(target)) |
|
3768 | 3781 | except IOError: |
|
3769 | 3782 | pass |
|
3770 | 3783 | |
|
3771 | 3784 | for tgt in potential_target : |
|
3772 | 3785 | if os.path.isfile(tgt): # Read file |
|
3773 | 3786 | try : |
|
3774 | 3787 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3775 | 3788 | except UnicodeDecodeError as e: |
|
3776 | 3789 | if not py_only : |
|
3777 | 3790 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3778 | 3791 | return f.read() |
|
3779 | 3792 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3780 | 3793 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3781 | 3794 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3782 | 3795 | |
|
3783 | 3796 | if search_ns: |
|
3784 | 3797 | # Inspect namespace to load object source |
|
3785 | 3798 | object_info = self.object_inspect(target, detail_level=1) |
|
3786 | 3799 | if object_info['found'] and object_info['source']: |
|
3787 | 3800 | return object_info['source'] |
|
3788 | 3801 | |
|
3789 | 3802 | try: # User namespace |
|
3790 | 3803 | codeobj = eval(target, self.user_ns) |
|
3791 | 3804 | except Exception as e: |
|
3792 | 3805 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3793 | 3806 | "nor in the user namespace.") % target) from e |
|
3794 | 3807 | |
|
3795 | 3808 | if isinstance(codeobj, str): |
|
3796 | 3809 | return codeobj |
|
3797 | 3810 | elif isinstance(codeobj, Macro): |
|
3798 | 3811 | return codeobj.value |
|
3799 | 3812 | |
|
3800 | 3813 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3801 | 3814 | codeobj) |
|
3802 | 3815 | |
|
3803 | 3816 | def _atexit_once(self): |
|
3804 | 3817 | """ |
|
3805 | 3818 | At exist operation that need to be called at most once. |
|
3806 | 3819 | Second call to this function per instance will do nothing. |
|
3807 | 3820 | """ |
|
3808 | 3821 | |
|
3809 | 3822 | if not getattr(self, "_atexit_once_called", False): |
|
3810 | 3823 | self._atexit_once_called = True |
|
3811 | 3824 | # Clear all user namespaces to release all references cleanly. |
|
3812 | 3825 | self.reset(new_session=False) |
|
3813 | 3826 | # Close the history session (this stores the end time and line count) |
|
3814 | 3827 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3815 | 3828 | # history db |
|
3816 | 3829 | self.history_manager.end_session() |
|
3817 | 3830 | self.history_manager = None |
|
3818 | 3831 | |
|
3819 | 3832 | #------------------------------------------------------------------------- |
|
3820 | 3833 | # Things related to IPython exiting |
|
3821 | 3834 | #------------------------------------------------------------------------- |
|
3822 | 3835 | def atexit_operations(self): |
|
3823 | 3836 | """This will be executed at the time of exit. |
|
3824 | 3837 | |
|
3825 | 3838 | Cleanup operations and saving of persistent data that is done |
|
3826 | 3839 | unconditionally by IPython should be performed here. |
|
3827 | 3840 | |
|
3828 | 3841 | For things that may depend on startup flags or platform specifics (such |
|
3829 | 3842 | as having readline or not), register a separate atexit function in the |
|
3830 | 3843 | code that has the appropriate information, rather than trying to |
|
3831 | 3844 | clutter |
|
3832 | 3845 | """ |
|
3833 | 3846 | self._atexit_once() |
|
3834 | 3847 | |
|
3835 | 3848 | # Cleanup all tempfiles and folders left around |
|
3836 | 3849 | for tfile in self.tempfiles: |
|
3837 | 3850 | try: |
|
3838 | 3851 | tfile.unlink() |
|
3839 | 3852 | self.tempfiles.remove(tfile) |
|
3840 | 3853 | except FileNotFoundError: |
|
3841 | 3854 | pass |
|
3842 | 3855 | del self.tempfiles |
|
3843 | 3856 | for tdir in self.tempdirs: |
|
3844 | 3857 | try: |
|
3845 | 3858 | tdir.rmdir() |
|
3846 | 3859 | self.tempdirs.remove(tdir) |
|
3847 | 3860 | except FileNotFoundError: |
|
3848 | 3861 | pass |
|
3849 | 3862 | del self.tempdirs |
|
3850 | 3863 | |
|
3851 | 3864 | |
|
3852 | 3865 | # Run user hooks |
|
3853 | 3866 | self.hooks.shutdown_hook() |
|
3854 | 3867 | |
|
3855 | 3868 | def cleanup(self): |
|
3856 | 3869 | self.restore_sys_module_state() |
|
3857 | 3870 | |
|
3858 | 3871 | |
|
3859 | 3872 | # Overridden in terminal subclass to change prompts |
|
3860 | 3873 | def switch_doctest_mode(self, mode): |
|
3861 | 3874 | pass |
|
3862 | 3875 | |
|
3863 | 3876 | |
|
3864 | 3877 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3865 | 3878 | """An abstract base class for InteractiveShell.""" |
|
3866 | 3879 | |
|
3867 | 3880 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,750 +1,754 b'' | |||
|
1 | 1 | """Implementation of code management magic functions. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2012 The IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | # Stdlib |
|
16 | 16 | import inspect |
|
17 | 17 | import io |
|
18 | 18 | import os |
|
19 | 19 | import re |
|
20 | 20 | import sys |
|
21 | 21 | import ast |
|
22 | 22 | from itertools import chain |
|
23 | 23 | from urllib.request import Request, urlopen |
|
24 | 24 | from urllib.parse import urlencode |
|
25 | 25 | from pathlib import Path |
|
26 | 26 | |
|
27 | 27 | # Our own packages |
|
28 | 28 | from IPython.core.error import TryNext, StdinNotImplementedError, UsageError |
|
29 | 29 | from IPython.core.macro import Macro |
|
30 | 30 | from IPython.core.magic import Magics, magics_class, line_magic |
|
31 | 31 | from IPython.core.oinspect import find_file, find_source_lines |
|
32 | 32 | from IPython.core.release import version |
|
33 | 33 | from IPython.testing.skipdoctest import skip_doctest |
|
34 | 34 | from IPython.utils.contexts import preserve_keys |
|
35 | 35 | from IPython.utils.path import get_py_filename |
|
36 | 36 | from warnings import warn |
|
37 | 37 | from logging import error |
|
38 | 38 | from IPython.utils.text import get_text_list |
|
39 | 39 | |
|
40 | 40 | #----------------------------------------------------------------------------- |
|
41 | 41 | # Magic implementation classes |
|
42 | 42 | #----------------------------------------------------------------------------- |
|
43 | 43 | |
|
44 | 44 | # Used for exception handling in magic_edit |
|
45 | 45 | class MacroToEdit(ValueError): pass |
|
46 | 46 | |
|
47 | 47 | ipython_input_pat = re.compile(r"<ipython\-input\-(\d+)-[a-z\d]+>$") |
|
48 | 48 | |
|
49 | 49 | # To match, e.g. 8-10 1:5 :10 3- |
|
50 | 50 | range_re = re.compile(r""" |
|
51 | 51 | (?P<start>\d+)? |
|
52 | 52 | ((?P<sep>[\-:]) |
|
53 | 53 | (?P<end>\d+)?)? |
|
54 | 54 | $""", re.VERBOSE) |
|
55 | 55 | |
|
56 | 56 | |
|
57 | 57 | def extract_code_ranges(ranges_str): |
|
58 | 58 | """Turn a string of range for %%load into 2-tuples of (start, stop) |
|
59 | 59 | ready to use as a slice of the content split by lines. |
|
60 | 60 | |
|
61 | 61 | Examples |
|
62 | 62 | -------- |
|
63 | 63 | list(extract_input_ranges("5-10 2")) |
|
64 | 64 | [(4, 10), (1, 2)] |
|
65 | 65 | """ |
|
66 | 66 | for range_str in ranges_str.split(): |
|
67 | 67 | rmatch = range_re.match(range_str) |
|
68 | 68 | if not rmatch: |
|
69 | 69 | continue |
|
70 | 70 | sep = rmatch.group("sep") |
|
71 | 71 | start = rmatch.group("start") |
|
72 | 72 | end = rmatch.group("end") |
|
73 | 73 | |
|
74 | 74 | if sep == '-': |
|
75 | 75 | start = int(start) - 1 if start else None |
|
76 | 76 | end = int(end) if end else None |
|
77 | 77 | elif sep == ':': |
|
78 | 78 | start = int(start) - 1 if start else None |
|
79 | 79 | end = int(end) - 1 if end else None |
|
80 | 80 | else: |
|
81 | 81 | end = int(start) |
|
82 | 82 | start = int(start) - 1 |
|
83 | 83 | yield (start, end) |
|
84 | 84 | |
|
85 | 85 | |
|
86 | 86 | def extract_symbols(code, symbols): |
|
87 | 87 | """ |
|
88 | 88 | Return a tuple (blocks, not_found) |
|
89 | 89 | where ``blocks`` is a list of code fragments |
|
90 | 90 | for each symbol parsed from code, and ``not_found`` are |
|
91 | 91 | symbols not found in the code. |
|
92 | 92 | |
|
93 | 93 | For example:: |
|
94 | 94 | |
|
95 | 95 | In [1]: code = '''a = 10 |
|
96 | 96 | ...: def b(): return 42 |
|
97 | 97 | ...: class A: pass''' |
|
98 | 98 | |
|
99 | 99 | In [2]: extract_symbols(code, 'A,b,z') |
|
100 | 100 | Out[2]: (['class A: pass\\n', 'def b(): return 42\\n'], ['z']) |
|
101 | 101 | """ |
|
102 | 102 | symbols = symbols.split(',') |
|
103 | 103 | |
|
104 | 104 | # this will raise SyntaxError if code isn't valid Python |
|
105 | 105 | py_code = ast.parse(code) |
|
106 | 106 | |
|
107 | 107 | marks = [(getattr(s, 'name', None), s.lineno) for s in py_code.body] |
|
108 | 108 | code = code.split('\n') |
|
109 | 109 | |
|
110 | 110 | symbols_lines = {} |
|
111 | 111 | |
|
112 | 112 | # we already know the start_lineno of each symbol (marks). |
|
113 | 113 | # To find each end_lineno, we traverse in reverse order until each |
|
114 | 114 | # non-blank line |
|
115 | 115 | end = len(code) |
|
116 | 116 | for name, start in reversed(marks): |
|
117 | 117 | while not code[end - 1].strip(): |
|
118 | 118 | end -= 1 |
|
119 | 119 | if name: |
|
120 | 120 | symbols_lines[name] = (start - 1, end) |
|
121 | 121 | end = start - 1 |
|
122 | 122 | |
|
123 | 123 | # Now symbols_lines is a map |
|
124 | 124 | # {'symbol_name': (start_lineno, end_lineno), ...} |
|
125 | 125 | |
|
126 | 126 | # fill a list with chunks of codes for each requested symbol |
|
127 | 127 | blocks = [] |
|
128 | 128 | not_found = [] |
|
129 | 129 | for symbol in symbols: |
|
130 | 130 | if symbol in symbols_lines: |
|
131 | 131 | start, end = symbols_lines[symbol] |
|
132 | 132 | blocks.append('\n'.join(code[start:end]) + '\n') |
|
133 | 133 | else: |
|
134 | 134 | not_found.append(symbol) |
|
135 | 135 | |
|
136 | 136 | return blocks, not_found |
|
137 | 137 | |
|
138 | 138 | def strip_initial_indent(lines): |
|
139 | 139 | """For %load, strip indent from lines until finding an unindented line. |
|
140 | 140 | |
|
141 | 141 | https://github.com/ipython/ipython/issues/9775 |
|
142 | 142 | """ |
|
143 | 143 | indent_re = re.compile(r'\s+') |
|
144 | 144 | |
|
145 | 145 | it = iter(lines) |
|
146 | 146 | first_line = next(it) |
|
147 | 147 | indent_match = indent_re.match(first_line) |
|
148 | 148 | |
|
149 | 149 | if indent_match: |
|
150 | 150 | # First line was indented |
|
151 | 151 | indent = indent_match.group() |
|
152 | 152 | yield first_line[len(indent):] |
|
153 | 153 | |
|
154 | 154 | for line in it: |
|
155 | 155 | if line.startswith(indent): |
|
156 | 156 | yield line[len(indent):] |
|
157 | 157 | else: |
|
158 | 158 | # Less indented than the first line - stop dedenting |
|
159 | 159 | yield line |
|
160 | 160 | break |
|
161 | 161 | else: |
|
162 | 162 | yield first_line |
|
163 | 163 | |
|
164 | 164 | # Pass the remaining lines through without dedenting |
|
165 | 165 | for line in it: |
|
166 | 166 | yield line |
|
167 | 167 | |
|
168 | 168 | |
|
169 | 169 | class InteractivelyDefined(Exception): |
|
170 | 170 | """Exception for interactively defined variable in magic_edit""" |
|
171 | 171 | def __init__(self, index): |
|
172 | 172 | self.index = index |
|
173 | 173 | |
|
174 | 174 | |
|
175 | 175 | @magics_class |
|
176 | 176 | class CodeMagics(Magics): |
|
177 | 177 | """Magics related to code management (loading, saving, editing, ...).""" |
|
178 | 178 | |
|
179 | 179 | def __init__(self, *args, **kwargs): |
|
180 | 180 | self._knowntemps = set() |
|
181 | 181 | super(CodeMagics, self).__init__(*args, **kwargs) |
|
182 | 182 | |
|
183 | 183 | @line_magic |
|
184 | 184 | def save(self, parameter_s=''): |
|
185 | 185 | """Save a set of lines or a macro to a given filename. |
|
186 | 186 | |
|
187 | 187 | Usage:\\ |
|
188 | 188 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
189 | 189 | |
|
190 | 190 | Options: |
|
191 | 191 | |
|
192 | 192 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
193 | 193 | so that magics are loaded in their transformed version to valid |
|
194 | 194 | Python. If this option is given, the raw input as typed as the |
|
195 | 195 | command line is used instead. |
|
196 | 196 | |
|
197 | 197 | -f: force overwrite. If file exists, %save will prompt for overwrite |
|
198 | 198 | unless -f is given. |
|
199 | 199 | |
|
200 | 200 | -a: append to the file instead of overwriting it. |
|
201 | 201 | |
|
202 | 202 | This function uses the same syntax as %history for input ranges, |
|
203 | 203 | then saves the lines to the filename you specify. |
|
204 | 204 | |
|
205 | If no ranges are specified, saves history of the current session up to | |
|
206 | this point. | |
|
207 | ||
|
205 | 208 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
206 | 209 | it asks for confirmation before overwriting existing files. |
|
207 | 210 | |
|
208 | 211 | If `-r` option is used, the default extension is `.ipy`. |
|
209 | 212 | """ |
|
210 | 213 | |
|
211 | 214 | opts,args = self.parse_options(parameter_s,'fra',mode='list') |
|
212 | 215 | if not args: |
|
213 | 216 | raise UsageError('Missing filename.') |
|
214 | 217 | raw = 'r' in opts |
|
215 | 218 | force = 'f' in opts |
|
216 | 219 | append = 'a' in opts |
|
217 | 220 | mode = 'a' if append else 'w' |
|
218 | 221 | ext = '.ipy' if raw else '.py' |
|
219 | 222 | fname, codefrom = args[0], " ".join(args[1:]) |
|
220 | 223 | if not fname.endswith(('.py','.ipy')): |
|
221 | 224 | fname += ext |
|
222 | 225 | file_exists = os.path.isfile(fname) |
|
223 | 226 | if file_exists and not force and not append: |
|
224 | 227 | try: |
|
225 | 228 | overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n') |
|
226 | 229 | except StdinNotImplementedError: |
|
227 | 230 | print("File `%s` exists. Use `%%save -f %s` to force overwrite" % (fname, parameter_s)) |
|
228 | 231 | return |
|
229 | 232 | if not overwrite : |
|
230 | 233 | print('Operation cancelled.') |
|
231 | 234 | return |
|
232 | 235 | try: |
|
233 | 236 | cmds = self.shell.find_user_code(codefrom,raw) |
|
234 | 237 | except (TypeError, ValueError) as e: |
|
235 | 238 | print(e.args[0]) |
|
236 | 239 | return |
|
237 | 240 | with io.open(fname, mode, encoding="utf-8") as f: |
|
238 | 241 | if not file_exists or not append: |
|
239 | 242 | f.write("# coding: utf-8\n") |
|
240 | 243 | f.write(cmds) |
|
241 | 244 | # make sure we end on a newline |
|
242 | 245 | if not cmds.endswith('\n'): |
|
243 | 246 | f.write('\n') |
|
244 | 247 | print('The following commands were written to file `%s`:' % fname) |
|
245 | 248 | print(cmds) |
|
246 | 249 | |
|
247 | 250 | @line_magic |
|
248 | 251 | def pastebin(self, parameter_s=''): |
|
249 | 252 | """Upload code to dpaste.com, returning the URL. |
|
250 | 253 | |
|
251 | 254 | Usage:\\ |
|
252 | 255 | %pastebin [-d "Custom description"][-e 24] 1-7 |
|
253 | 256 | |
|
254 | 257 | The argument can be an input history range, a filename, or the name of a |
|
255 | 258 | string or macro. |
|
256 | 259 | |
|
260 | If no arguments are given, uploads the history of this session up to | |
|
261 | this point. | |
|
262 | ||
|
257 | 263 | Options: |
|
258 | 264 | |
|
259 | 265 | -d: Pass a custom description. The default will say |
|
260 | 266 | "Pasted from IPython". |
|
261 | 267 | -e: Pass number of days for the link to be expired. |
|
262 | 268 | The default will be 7 days. |
|
263 | 269 | """ |
|
264 | 270 | opts, args = self.parse_options(parameter_s, "d:e:") |
|
265 | 271 | |
|
266 | 272 | try: |
|
267 | 273 | code = self.shell.find_user_code(args) |
|
268 | 274 | except (ValueError, TypeError) as e: |
|
269 | 275 | print(e.args[0]) |
|
270 | 276 | return |
|
271 | 277 | |
|
272 | 278 | expiry_days = 7 |
|
273 | 279 | try: |
|
274 | 280 | expiry_days = int(opts.get("e", 7)) |
|
275 | 281 | except ValueError as e: |
|
276 | 282 | print(e.args[0].capitalize()) |
|
277 | 283 | return |
|
278 | 284 | if expiry_days < 1 or expiry_days > 365: |
|
279 | 285 | print("Expiry days should be in range of 1 to 365") |
|
280 | 286 | return |
|
281 | 287 | |
|
282 | 288 | post_data = urlencode( |
|
283 | 289 | { |
|
284 | 290 | "title": opts.get("d", "Pasted from IPython"), |
|
285 | 291 | "syntax": "python", |
|
286 | 292 | "content": code, |
|
287 | 293 | "expiry_days": expiry_days, |
|
288 | 294 | } |
|
289 | 295 | ).encode("utf-8") |
|
290 | 296 | |
|
291 | 297 | request = Request( |
|
292 | 298 | "https://dpaste.com/api/v2/", |
|
293 | 299 | headers={"User-Agent": "IPython v{}".format(version)}, |
|
294 | 300 | ) |
|
295 | 301 | response = urlopen(request, post_data) |
|
296 | 302 | return response.headers.get('Location') |
|
297 | 303 | |
|
298 | 304 | @line_magic |
|
299 | 305 | def loadpy(self, arg_s): |
|
300 | 306 | """Alias of `%load` |
|
301 | 307 | |
|
302 | 308 | `%loadpy` has gained some flexibility and dropped the requirement of a `.py` |
|
303 | 309 | extension. So it has been renamed simply into %load. You can look at |
|
304 | 310 | `%load`'s docstring for more info. |
|
305 | 311 | """ |
|
306 | 312 | self.load(arg_s) |
|
307 | 313 | |
|
308 | 314 | @line_magic |
|
309 | 315 | def load(self, arg_s): |
|
310 | 316 | """Load code into the current frontend. |
|
311 | 317 | |
|
312 | 318 | Usage:\\ |
|
313 | 319 | %load [options] source |
|
314 | 320 | |
|
315 | 321 | where source can be a filename, URL, input history range, macro, or |
|
316 | 322 | element in the user namespace |
|
317 | 323 | |
|
324 | If no arguments are given, loads the history of this session up to this | |
|
325 | point. | |
|
326 | ||
|
318 | 327 | Options: |
|
319 | 328 | |
|
320 | 329 | -r <lines>: Specify lines or ranges of lines to load from the source. |
|
321 | 330 | Ranges could be specified as x-y (x..y) or in python-style x:y |
|
322 | 331 | (x..(y-1)). Both limits x and y can be left blank (meaning the |
|
323 | 332 | beginning and end of the file, respectively). |
|
324 | 333 | |
|
325 | 334 | -s <symbols>: Specify function or classes to load from python source. |
|
326 | 335 | |
|
327 | 336 | -y : Don't ask confirmation for loading source above 200 000 characters. |
|
328 | 337 | |
|
329 | 338 | -n : Include the user's namespace when searching for source code. |
|
330 | 339 | |
|
331 | 340 | This magic command can either take a local filename, a URL, an history |
|
332 | 341 | range (see %history) or a macro as argument, it will prompt for |
|
333 | 342 | confirmation before loading source with more than 200 000 characters, unless |
|
334 | 343 | -y flag is passed or if the frontend does not support raw_input:: |
|
335 | 344 | |
|
345 | %load | |
|
336 | 346 | %load myscript.py |
|
337 | 347 | %load 7-27 |
|
338 | 348 | %load myMacro |
|
339 | 349 | %load http://www.example.com/myscript.py |
|
340 | 350 | %load -r 5-10 myscript.py |
|
341 | 351 | %load -r 10-20,30,40: foo.py |
|
342 | 352 | %load -s MyClass,wonder_function myscript.py |
|
343 | 353 | %load -n MyClass |
|
344 | 354 | %load -n my_module.wonder_function |
|
345 | 355 | """ |
|
346 | 356 | opts,args = self.parse_options(arg_s,'yns:r:') |
|
347 | ||
|
348 | if not args: | |
|
349 | raise UsageError('Missing filename, URL, input history range, ' | |
|
350 | 'macro, or element in the user namespace.') | |
|
351 | ||
|
352 | 357 | search_ns = 'n' in opts |
|
353 | ||
|
354 | 358 | contents = self.shell.find_user_code(args, search_ns=search_ns) |
|
355 | 359 | |
|
356 | 360 | if 's' in opts: |
|
357 | 361 | try: |
|
358 | 362 | blocks, not_found = extract_symbols(contents, opts['s']) |
|
359 | 363 | except SyntaxError: |
|
360 | 364 | # non python code |
|
361 | 365 | error("Unable to parse the input as valid Python code") |
|
362 | 366 | return |
|
363 | 367 | |
|
364 | 368 | if len(not_found) == 1: |
|
365 | 369 | warn('The symbol `%s` was not found' % not_found[0]) |
|
366 | 370 | elif len(not_found) > 1: |
|
367 | 371 | warn('The symbols %s were not found' % get_text_list(not_found, |
|
368 | 372 | wrap_item_with='`') |
|
369 | 373 | ) |
|
370 | 374 | |
|
371 | 375 | contents = '\n'.join(blocks) |
|
372 | 376 | |
|
373 | 377 | if 'r' in opts: |
|
374 | 378 | ranges = opts['r'].replace(',', ' ') |
|
375 | 379 | lines = contents.split('\n') |
|
376 | 380 | slices = extract_code_ranges(ranges) |
|
377 | 381 | contents = [lines[slice(*slc)] for slc in slices] |
|
378 | 382 | contents = '\n'.join(strip_initial_indent(chain.from_iterable(contents))) |
|
379 | 383 | |
|
380 | 384 | l = len(contents) |
|
381 | 385 | |
|
382 | 386 | # 200 000 is ~ 2500 full 80 character lines |
|
383 | 387 | # so in average, more than 5000 lines |
|
384 | 388 | if l > 200000 and 'y' not in opts: |
|
385 | 389 | try: |
|
386 | 390 | ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\ |
|
387 | 391 | " (%d characters). Continue (y/[N]) ?" % l), default='n' ) |
|
388 | 392 | except StdinNotImplementedError: |
|
389 | 393 | #assume yes if raw input not implemented |
|
390 | 394 | ans = True |
|
391 | 395 | |
|
392 | 396 | if ans is False : |
|
393 | 397 | print('Operation cancelled.') |
|
394 | 398 | return |
|
395 | 399 | |
|
396 | 400 | contents = "# %load {}\n".format(arg_s) + contents |
|
397 | 401 | |
|
398 | 402 | self.shell.set_next_input(contents, replace=True) |
|
399 | 403 | |
|
400 | 404 | @staticmethod |
|
401 | 405 | def _find_edit_target(shell, args, opts, last_call): |
|
402 | 406 | """Utility method used by magic_edit to find what to edit.""" |
|
403 | 407 | |
|
404 | 408 | def make_filename(arg): |
|
405 | 409 | "Make a filename from the given args" |
|
406 | 410 | try: |
|
407 | 411 | filename = get_py_filename(arg) |
|
408 | 412 | except IOError: |
|
409 | 413 | # If it ends with .py but doesn't already exist, assume we want |
|
410 | 414 | # a new file. |
|
411 | 415 | if arg.endswith('.py'): |
|
412 | 416 | filename = arg |
|
413 | 417 | else: |
|
414 | 418 | filename = None |
|
415 | 419 | return filename |
|
416 | 420 | |
|
417 | 421 | # Set a few locals from the options for convenience: |
|
418 | 422 | opts_prev = 'p' in opts |
|
419 | 423 | opts_raw = 'r' in opts |
|
420 | 424 | |
|
421 | 425 | # custom exceptions |
|
422 | 426 | class DataIsObject(Exception): pass |
|
423 | 427 | |
|
424 | 428 | # Default line number value |
|
425 | 429 | lineno = opts.get('n',None) |
|
426 | 430 | |
|
427 | 431 | if opts_prev: |
|
428 | 432 | args = '_%s' % last_call[0] |
|
429 | 433 | if args not in shell.user_ns: |
|
430 | 434 | args = last_call[1] |
|
431 | 435 | |
|
432 | 436 | # by default this is done with temp files, except when the given |
|
433 | 437 | # arg is a filename |
|
434 | 438 | use_temp = True |
|
435 | 439 | |
|
436 | 440 | data = '' |
|
437 | 441 | |
|
438 | 442 | # First, see if the arguments should be a filename. |
|
439 | 443 | filename = make_filename(args) |
|
440 | 444 | if filename: |
|
441 | 445 | use_temp = False |
|
442 | 446 | elif args: |
|
443 | 447 | # Mode where user specifies ranges of lines, like in %macro. |
|
444 | 448 | data = shell.extract_input_lines(args, opts_raw) |
|
445 | 449 | if not data: |
|
446 | 450 | try: |
|
447 | 451 | # Load the parameter given as a variable. If not a string, |
|
448 | 452 | # process it as an object instead (below) |
|
449 | 453 | |
|
450 | 454 | #print '*** args',args,'type',type(args) # dbg |
|
451 | 455 | data = eval(args, shell.user_ns) |
|
452 | 456 | if not isinstance(data, str): |
|
453 | 457 | raise DataIsObject |
|
454 | 458 | |
|
455 | 459 | except (NameError,SyntaxError): |
|
456 | 460 | # given argument is not a variable, try as a filename |
|
457 | 461 | filename = make_filename(args) |
|
458 | 462 | if filename is None: |
|
459 | 463 | warn("Argument given (%s) can't be found as a variable " |
|
460 | 464 | "or as a filename." % args) |
|
461 | 465 | return (None, None, None) |
|
462 | 466 | use_temp = False |
|
463 | 467 | |
|
464 | 468 | except DataIsObject as e: |
|
465 | 469 | # macros have a special edit function |
|
466 | 470 | if isinstance(data, Macro): |
|
467 | 471 | raise MacroToEdit(data) from e |
|
468 | 472 | |
|
469 | 473 | # For objects, try to edit the file where they are defined |
|
470 | 474 | filename = find_file(data) |
|
471 | 475 | if filename: |
|
472 | 476 | if 'fakemodule' in filename.lower() and \ |
|
473 | 477 | inspect.isclass(data): |
|
474 | 478 | # class created by %edit? Try to find source |
|
475 | 479 | # by looking for method definitions instead, the |
|
476 | 480 | # __module__ in those classes is FakeModule. |
|
477 | 481 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
478 | 482 | for attr in attrs: |
|
479 | 483 | if not inspect.ismethod(attr): |
|
480 | 484 | continue |
|
481 | 485 | filename = find_file(attr) |
|
482 | 486 | if filename and \ |
|
483 | 487 | 'fakemodule' not in filename.lower(): |
|
484 | 488 | # change the attribute to be the edit |
|
485 | 489 | # target instead |
|
486 | 490 | data = attr |
|
487 | 491 | break |
|
488 | 492 | |
|
489 | 493 | m = ipython_input_pat.match(os.path.basename(filename)) |
|
490 | 494 | if m: |
|
491 | 495 | raise InteractivelyDefined(int(m.groups()[0])) from e |
|
492 | 496 | |
|
493 | 497 | datafile = 1 |
|
494 | 498 | if filename is None: |
|
495 | 499 | filename = make_filename(args) |
|
496 | 500 | datafile = 1 |
|
497 | 501 | if filename is not None: |
|
498 | 502 | # only warn about this if we get a real name |
|
499 | 503 | warn('Could not find file where `%s` is defined.\n' |
|
500 | 504 | 'Opening a file named `%s`' % (args, filename)) |
|
501 | 505 | # Now, make sure we can actually read the source (if it was |
|
502 | 506 | # in a temp file it's gone by now). |
|
503 | 507 | if datafile: |
|
504 | 508 | if lineno is None: |
|
505 | 509 | lineno = find_source_lines(data) |
|
506 | 510 | if lineno is None: |
|
507 | 511 | filename = make_filename(args) |
|
508 | 512 | if filename is None: |
|
509 | 513 | warn('The file where `%s` was defined ' |
|
510 | 514 | 'cannot be read or found.' % data) |
|
511 | 515 | return (None, None, None) |
|
512 | 516 | use_temp = False |
|
513 | 517 | |
|
514 | 518 | if use_temp: |
|
515 | 519 | filename = shell.mktempfile(data) |
|
516 | 520 | print('IPython will make a temporary file named:',filename) |
|
517 | 521 | |
|
518 | 522 | # use last_call to remember the state of the previous call, but don't |
|
519 | 523 | # let it be clobbered by successive '-p' calls. |
|
520 | 524 | try: |
|
521 | 525 | last_call[0] = shell.displayhook.prompt_count |
|
522 | 526 | if not opts_prev: |
|
523 | 527 | last_call[1] = args |
|
524 | 528 | except: |
|
525 | 529 | pass |
|
526 | 530 | |
|
527 | 531 | |
|
528 | 532 | return filename, lineno, use_temp |
|
529 | 533 | |
|
530 | 534 | def _edit_macro(self,mname,macro): |
|
531 | 535 | """open an editor with the macro data in a file""" |
|
532 | 536 | filename = self.shell.mktempfile(macro.value) |
|
533 | 537 | self.shell.hooks.editor(filename) |
|
534 | 538 | |
|
535 | 539 | # and make a new macro object, to replace the old one |
|
536 | 540 | mvalue = Path(filename).read_text() |
|
537 | 541 | self.shell.user_ns[mname] = Macro(mvalue) |
|
538 | 542 | |
|
539 | 543 | @skip_doctest |
|
540 | 544 | @line_magic |
|
541 | 545 | def edit(self, parameter_s='',last_call=['','']): |
|
542 | 546 | """Bring up an editor and execute the resulting code. |
|
543 | 547 | |
|
544 | 548 | Usage: |
|
545 | 549 | %edit [options] [args] |
|
546 | 550 | |
|
547 | 551 | %edit runs IPython's editor hook. The default version of this hook is |
|
548 | 552 | set to call the editor specified by your $EDITOR environment variable. |
|
549 | 553 | If this isn't found, it will default to vi under Linux/Unix and to |
|
550 | 554 | notepad under Windows. See the end of this docstring for how to change |
|
551 | 555 | the editor hook. |
|
552 | 556 | |
|
553 | 557 | You can also set the value of this editor via the |
|
554 | 558 | ``TerminalInteractiveShell.editor`` option in your configuration file. |
|
555 | 559 | This is useful if you wish to use a different editor from your typical |
|
556 | 560 | default with IPython (and for Windows users who typically don't set |
|
557 | 561 | environment variables). |
|
558 | 562 | |
|
559 | 563 | This command allows you to conveniently edit multi-line code right in |
|
560 | 564 | your IPython session. |
|
561 | 565 | |
|
562 | 566 | If called without arguments, %edit opens up an empty editor with a |
|
563 | 567 | temporary file and will execute the contents of this file when you |
|
564 | 568 | close it (don't forget to save it!). |
|
565 | 569 | |
|
566 | 570 | |
|
567 | 571 | Options: |
|
568 | 572 | |
|
569 | 573 | -n <number>: open the editor at a specified line number. By default, |
|
570 | 574 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
571 | 575 | you can configure this by providing your own modified hook if your |
|
572 | 576 | favorite editor supports line-number specifications with a different |
|
573 | 577 | syntax. |
|
574 | 578 | |
|
575 | 579 | -p: this will call the editor with the same data as the previous time |
|
576 | 580 | it was used, regardless of how long ago (in your current session) it |
|
577 | 581 | was. |
|
578 | 582 | |
|
579 | 583 | -r: use 'raw' input. This option only applies to input taken from the |
|
580 | 584 | user's history. By default, the 'processed' history is used, so that |
|
581 | 585 | magics are loaded in their transformed version to valid Python. If |
|
582 | 586 | this option is given, the raw input as typed as the command line is |
|
583 | 587 | used instead. When you exit the editor, it will be executed by |
|
584 | 588 | IPython's own processor. |
|
585 | 589 | |
|
586 | 590 | -x: do not execute the edited code immediately upon exit. This is |
|
587 | 591 | mainly useful if you are editing programs which need to be called with |
|
588 | 592 | command line arguments, which you can then do using %run. |
|
589 | 593 | |
|
590 | 594 | |
|
591 | 595 | Arguments: |
|
592 | 596 | |
|
593 | 597 | If arguments are given, the following possibilities exist: |
|
594 | 598 | |
|
595 | 599 | - If the argument is a filename, IPython will load that into the |
|
596 | 600 | editor. It will execute its contents with execfile() when you exit, |
|
597 | 601 | loading any code in the file into your interactive namespace. |
|
598 | 602 | |
|
599 | 603 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". |
|
600 | 604 | The syntax is the same as in the %history magic. |
|
601 | 605 | |
|
602 | 606 | - If the argument is a string variable, its contents are loaded |
|
603 | 607 | into the editor. You can thus edit any string which contains |
|
604 | 608 | python code (including the result of previous edits). |
|
605 | 609 | |
|
606 | 610 | - If the argument is the name of an object (other than a string), |
|
607 | 611 | IPython will try to locate the file where it was defined and open the |
|
608 | 612 | editor at the point where it is defined. You can use `%edit function` |
|
609 | 613 | to load an editor exactly at the point where 'function' is defined, |
|
610 | 614 | edit it and have the file be executed automatically. |
|
611 | 615 | |
|
612 | 616 | - If the object is a macro (see %macro for details), this opens up your |
|
613 | 617 | specified editor with a temporary file containing the macro's data. |
|
614 | 618 | Upon exit, the macro is reloaded with the contents of the file. |
|
615 | 619 | |
|
616 | 620 | Note: opening at an exact line is only supported under Unix, and some |
|
617 | 621 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
618 | 622 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
619 | 623 | (X)Emacs, vi, jed, pico and joe all do. |
|
620 | 624 | |
|
621 | 625 | After executing your code, %edit will return as output the code you |
|
622 | 626 | typed in the editor (except when it was an existing file). This way |
|
623 | 627 | you can reload the code in further invocations of %edit as a variable, |
|
624 | 628 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
625 | 629 | the output. |
|
626 | 630 | |
|
627 | 631 | Note that %edit is also available through the alias %ed. |
|
628 | 632 | |
|
629 | 633 | This is an example of creating a simple function inside the editor and |
|
630 | 634 | then modifying it. First, start up the editor:: |
|
631 | 635 | |
|
632 | 636 | In [1]: edit |
|
633 | 637 | Editing... done. Executing edited code... |
|
634 | 638 | Out[1]: 'def foo():\\n print "foo() was defined in an editing |
|
635 | 639 | session"\\n' |
|
636 | 640 | |
|
637 | 641 | We can then call the function foo():: |
|
638 | 642 | |
|
639 | 643 | In [2]: foo() |
|
640 | 644 | foo() was defined in an editing session |
|
641 | 645 | |
|
642 | 646 | Now we edit foo. IPython automatically loads the editor with the |
|
643 | 647 | (temporary) file where foo() was previously defined:: |
|
644 | 648 | |
|
645 | 649 | In [3]: edit foo |
|
646 | 650 | Editing... done. Executing edited code... |
|
647 | 651 | |
|
648 | 652 | And if we call foo() again we get the modified version:: |
|
649 | 653 | |
|
650 | 654 | In [4]: foo() |
|
651 | 655 | foo() has now been changed! |
|
652 | 656 | |
|
653 | 657 | Here is an example of how to edit a code snippet successive |
|
654 | 658 | times. First we call the editor:: |
|
655 | 659 | |
|
656 | 660 | In [5]: edit |
|
657 | 661 | Editing... done. Executing edited code... |
|
658 | 662 | hello |
|
659 | 663 | Out[5]: "print 'hello'\\n" |
|
660 | 664 | |
|
661 | 665 | Now we call it again with the previous output (stored in _):: |
|
662 | 666 | |
|
663 | 667 | In [6]: edit _ |
|
664 | 668 | Editing... done. Executing edited code... |
|
665 | 669 | hello world |
|
666 | 670 | Out[6]: "print 'hello world'\\n" |
|
667 | 671 | |
|
668 | 672 | Now we call it with the output #8 (stored in _8, also as Out[8]):: |
|
669 | 673 | |
|
670 | 674 | In [7]: edit _8 |
|
671 | 675 | Editing... done. Executing edited code... |
|
672 | 676 | hello again |
|
673 | 677 | Out[7]: "print 'hello again'\\n" |
|
674 | 678 | |
|
675 | 679 | |
|
676 | 680 | Changing the default editor hook: |
|
677 | 681 | |
|
678 | 682 | If you wish to write your own editor hook, you can put it in a |
|
679 | 683 | configuration file which you load at startup time. The default hook |
|
680 | 684 | is defined in the IPython.core.hooks module, and you can use that as a |
|
681 | 685 | starting example for further modifications. That file also has |
|
682 | 686 | general instructions on how to set a new hook for use once you've |
|
683 | 687 | defined it.""" |
|
684 | 688 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
685 | 689 | |
|
686 | 690 | try: |
|
687 | 691 | filename, lineno, is_temp = self._find_edit_target(self.shell, |
|
688 | 692 | args, opts, last_call) |
|
689 | 693 | except MacroToEdit as e: |
|
690 | 694 | self._edit_macro(args, e.args[0]) |
|
691 | 695 | return |
|
692 | 696 | except InteractivelyDefined as e: |
|
693 | 697 | print("Editing In[%i]" % e.index) |
|
694 | 698 | args = str(e.index) |
|
695 | 699 | filename, lineno, is_temp = self._find_edit_target(self.shell, |
|
696 | 700 | args, opts, last_call) |
|
697 | 701 | if filename is None: |
|
698 | 702 | # nothing was found, warnings have already been issued, |
|
699 | 703 | # just give up. |
|
700 | 704 | return |
|
701 | 705 | |
|
702 | 706 | if is_temp: |
|
703 | 707 | self._knowntemps.add(filename) |
|
704 | 708 | elif (filename in self._knowntemps): |
|
705 | 709 | is_temp = True |
|
706 | 710 | |
|
707 | 711 | |
|
708 | 712 | # do actual editing here |
|
709 | 713 | print('Editing...', end=' ') |
|
710 | 714 | sys.stdout.flush() |
|
711 | 715 | filepath = Path(filename) |
|
712 | 716 | try: |
|
713 | 717 | # Quote filenames that may have spaces in them when opening |
|
714 | 718 | # the editor |
|
715 | 719 | quoted = filename = str(filepath.absolute()) |
|
716 | 720 | if " " in quoted: |
|
717 | 721 | quoted = "'%s'" % quoted |
|
718 | 722 | self.shell.hooks.editor(quoted, lineno) |
|
719 | 723 | except TryNext: |
|
720 | 724 | warn('Could not open editor') |
|
721 | 725 | return |
|
722 | 726 | |
|
723 | 727 | # XXX TODO: should this be generalized for all string vars? |
|
724 | 728 | # For now, this is special-cased to blocks created by cpaste |
|
725 | 729 | if args.strip() == "pasted_block": |
|
726 | 730 | self.shell.user_ns["pasted_block"] = filepath.read_text() |
|
727 | 731 | |
|
728 | 732 | if 'x' in opts: # -x prevents actual execution |
|
729 | 733 | print() |
|
730 | 734 | else: |
|
731 | 735 | print('done. Executing edited code...') |
|
732 | 736 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
733 | 737 | if not is_temp: |
|
734 | 738 | self.shell.user_ns['__file__'] = filename |
|
735 | 739 | if 'r' in opts: # Untranslated IPython code |
|
736 | 740 | source = filepath.read_text() |
|
737 | 741 | self.shell.run_cell(source, store_history=False) |
|
738 | 742 | else: |
|
739 | 743 | self.shell.safe_execfile(filename, self.shell.user_ns, |
|
740 | 744 | self.shell.user_ns) |
|
741 | 745 | |
|
742 | 746 | if is_temp: |
|
743 | 747 | try: |
|
744 | 748 | return filepath.read_text() |
|
745 | 749 | except IOError as msg: |
|
746 | 750 | if Path(msg.filename) == filepath: |
|
747 | 751 | warn('File not found. Did you forget to save?') |
|
748 | 752 | return |
|
749 | 753 | else: |
|
750 | 754 | self.shell.showtraceback() |
@@ -1,335 +1,333 b'' | |||
|
1 | 1 | """Implementation of magic functions related to History. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2012, IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | # Stdlib |
|
16 | 16 | import os |
|
17 | 17 | import sys |
|
18 | 18 | from io import open as io_open |
|
19 | 19 | import fnmatch |
|
20 | 20 | |
|
21 | 21 | # Our own packages |
|
22 | 22 | from IPython.core.error import StdinNotImplementedError |
|
23 | 23 | from IPython.core.magic import Magics, magics_class, line_magic |
|
24 | 24 | from IPython.core.magic_arguments import (argument, magic_arguments, |
|
25 | 25 | parse_argstring) |
|
26 | 26 | from IPython.testing.skipdoctest import skip_doctest |
|
27 | 27 | from IPython.utils import io |
|
28 | 28 | |
|
29 | 29 | #----------------------------------------------------------------------------- |
|
30 | 30 | # Magics class implementation |
|
31 | 31 | #----------------------------------------------------------------------------- |
|
32 | 32 | |
|
33 | 33 | |
|
34 | 34 | _unspecified = object() |
|
35 | 35 | |
|
36 | 36 | |
|
37 | 37 | @magics_class |
|
38 | 38 | class HistoryMagics(Magics): |
|
39 | 39 | |
|
40 | 40 | @magic_arguments() |
|
41 | 41 | @argument( |
|
42 | 42 | '-n', dest='print_nums', action='store_true', default=False, |
|
43 | 43 | help=""" |
|
44 | 44 | print line numbers for each input. |
|
45 | 45 | This feature is only available if numbered prompts are in use. |
|
46 | 46 | """) |
|
47 | 47 | @argument( |
|
48 | 48 | '-o', dest='get_output', action='store_true', default=False, |
|
49 | 49 | help="also print outputs for each input.") |
|
50 | 50 | @argument( |
|
51 | 51 | '-p', dest='pyprompts', action='store_true', default=False, |
|
52 | 52 | help=""" |
|
53 | 53 | print classic '>>>' python prompts before each input. |
|
54 | 54 | This is useful for making documentation, and in conjunction |
|
55 | 55 | with -o, for producing doctest-ready output. |
|
56 | 56 | """) |
|
57 | 57 | @argument( |
|
58 | 58 | '-t', dest='raw', action='store_false', default=True, |
|
59 | 59 | help=""" |
|
60 | 60 | print the 'translated' history, as IPython understands it. |
|
61 | 61 | IPython filters your input and converts it all into valid Python |
|
62 | 62 | source before executing it (things like magics or aliases are turned |
|
63 | 63 | into function calls, for example). With this option, you'll see the |
|
64 | 64 | native history instead of the user-entered version: '%%cd /' will be |
|
65 | 65 | seen as 'get_ipython().run_line_magic("cd", "/")' instead of '%%cd /'. |
|
66 | 66 | """) |
|
67 | 67 | @argument( |
|
68 | 68 | '-f', dest='filename', |
|
69 | 69 | help=""" |
|
70 | 70 | FILENAME: instead of printing the output to the screen, redirect |
|
71 | 71 | it to the given file. The file is always overwritten, though *when |
|
72 | 72 | it can*, IPython asks for confirmation first. In particular, running |
|
73 | 73 | the command 'history -f FILENAME' from the IPython Notebook |
|
74 | 74 | interface will replace FILENAME even if it already exists *without* |
|
75 | 75 | confirmation. |
|
76 | 76 | """) |
|
77 | 77 | @argument( |
|
78 | 78 | '-g', dest='pattern', nargs='*', default=None, |
|
79 | 79 | help=""" |
|
80 | 80 | treat the arg as a glob pattern to search for in (full) history. |
|
81 | 81 | This includes the saved history (almost all commands ever written). |
|
82 | 82 | The pattern may contain '?' to match one unknown character and '*' |
|
83 | 83 | to match any number of unknown characters. Use '%%hist -g' to show |
|
84 | 84 | full saved history (may be very long). |
|
85 | 85 | """) |
|
86 | 86 | @argument( |
|
87 | 87 | '-l', dest='limit', type=int, nargs='?', default=_unspecified, |
|
88 | 88 | help=""" |
|
89 | 89 | get the last n lines from all sessions. Specify n as a single |
|
90 | 90 | arg, or the default is the last 10 lines. |
|
91 | 91 | """) |
|
92 | 92 | @argument( |
|
93 | 93 | '-u', dest='unique', action='store_true', |
|
94 | 94 | help=""" |
|
95 | 95 | when searching history using `-g`, show only unique history. |
|
96 | 96 | """) |
|
97 | 97 | @argument('range', nargs='*') |
|
98 | 98 | @skip_doctest |
|
99 | 99 | @line_magic |
|
100 | 100 | def history(self, parameter_s = ''): |
|
101 | 101 | """Print input history (_i<n> variables), with most recent last. |
|
102 | 102 | |
|
103 | 103 | By default, input history is printed without line numbers so it can be |
|
104 | 104 | directly pasted into an editor. Use -n to show them. |
|
105 | 105 | |
|
106 | 106 | By default, all input history from the current session is displayed. |
|
107 | 107 | Ranges of history can be indicated using the syntax: |
|
108 | 108 | |
|
109 | 109 | ``4`` |
|
110 | 110 | Line 4, current session |
|
111 | 111 | ``4-6`` |
|
112 | 112 | Lines 4-6, current session |
|
113 | 113 | ``243/1-5`` |
|
114 | 114 | Lines 1-5, session 243 |
|
115 | 115 | ``~2/7`` |
|
116 | 116 | Line 7, session 2 before current |
|
117 | 117 | ``~8/1-~6/5`` |
|
118 | 118 | From the first line of 8 sessions ago, to the fifth line of 6 |
|
119 | 119 | sessions ago. |
|
120 | 120 | |
|
121 | 121 | Multiple ranges can be entered, separated by spaces |
|
122 | 122 | |
|
123 | 123 | The same syntax is used by %macro, %save, %edit, %rerun |
|
124 | 124 | |
|
125 | 125 | Examples |
|
126 | 126 | -------- |
|
127 | 127 | :: |
|
128 | 128 | |
|
129 | 129 | In [6]: %history -n 4-6 |
|
130 | 130 | 4:a = 12 |
|
131 | 131 | 5:print a**2 |
|
132 | 132 | 6:%history -n 4-6 |
|
133 | 133 | |
|
134 | 134 | """ |
|
135 | 135 | |
|
136 | 136 | args = parse_argstring(self.history, parameter_s) |
|
137 | 137 | |
|
138 | 138 | # For brevity |
|
139 | 139 | history_manager = self.shell.history_manager |
|
140 | 140 | |
|
141 | 141 | def _format_lineno(session, line): |
|
142 | 142 | """Helper function to format line numbers properly.""" |
|
143 | 143 | if session in (0, history_manager.session_number): |
|
144 | 144 | return str(line) |
|
145 | 145 | return "%s/%s" % (session, line) |
|
146 | 146 | |
|
147 | 147 | # Check if output to specific file was requested. |
|
148 | 148 | outfname = args.filename |
|
149 | 149 | if not outfname: |
|
150 | 150 | outfile = sys.stdout # default |
|
151 | 151 | # We don't want to close stdout at the end! |
|
152 | 152 | close_at_end = False |
|
153 | 153 | else: |
|
154 | 154 | if os.path.exists(outfname): |
|
155 | 155 | try: |
|
156 | 156 | ans = io.ask_yes_no("File %r exists. Overwrite?" % outfname) |
|
157 | 157 | except StdinNotImplementedError: |
|
158 | 158 | ans = True |
|
159 | 159 | if not ans: |
|
160 | 160 | print('Aborting.') |
|
161 | 161 | return |
|
162 | 162 | print("Overwriting file.") |
|
163 | 163 | outfile = io_open(outfname, 'w', encoding='utf-8') |
|
164 | 164 | close_at_end = True |
|
165 | 165 | |
|
166 | 166 | print_nums = args.print_nums |
|
167 | 167 | get_output = args.get_output |
|
168 | 168 | pyprompts = args.pyprompts |
|
169 | 169 | raw = args.raw |
|
170 | 170 | |
|
171 | 171 | pattern = None |
|
172 | 172 | limit = None if args.limit is _unspecified else args.limit |
|
173 | 173 | |
|
174 | 174 | range_pattern = False |
|
175 | 175 | if args.pattern is not None and not args.range: |
|
176 | 176 | if args.pattern: |
|
177 | 177 | pattern = "*" + " ".join(args.pattern) + "*" |
|
178 | 178 | else: |
|
179 | 179 | pattern = "*" |
|
180 | 180 | hist = history_manager.search(pattern, raw=raw, output=get_output, |
|
181 | 181 | n=limit, unique=args.unique) |
|
182 | 182 | print_nums = True |
|
183 | 183 | elif args.limit is not _unspecified: |
|
184 | 184 | n = 10 if limit is None else limit |
|
185 | 185 | hist = history_manager.get_tail(n, raw=raw, output=get_output) |
|
186 | 186 | else: |
|
187 | if args.range: # Get history by ranges | |
|
188 | if args.pattern: | |
|
189 | range_pattern = "*" + " ".join(args.pattern) + "*" | |
|
190 | print_nums = True | |
|
191 | hist = history_manager.get_range_by_str(" ".join(args.range), | |
|
192 | raw, get_output) | |
|
193 | else: # Just get history for the current session | |
|
194 | hist = history_manager.get_range(raw=raw, output=get_output) | |
|
187 | if args.pattern: | |
|
188 | range_pattern = "*" + " ".join(args.pattern) + "*" | |
|
189 | print_nums = True | |
|
190 | hist = history_manager.get_range_by_str( | |
|
191 | " ".join(args.range), raw, get_output | |
|
192 | ) | |
|
195 | 193 | |
|
196 | 194 | # We could be displaying the entire history, so let's not try to pull |
|
197 | 195 | # it into a list in memory. Anything that needs more space will just |
|
198 | 196 | # misalign. |
|
199 | 197 | width = 4 |
|
200 | 198 | |
|
201 | 199 | for session, lineno, inline in hist: |
|
202 | 200 | # Print user history with tabs expanded to 4 spaces. The GUI |
|
203 | 201 | # clients use hard tabs for easier usability in auto-indented code, |
|
204 | 202 | # but we want to produce PEP-8 compliant history for safe pasting |
|
205 | 203 | # into an editor. |
|
206 | 204 | if get_output: |
|
207 | 205 | inline, output = inline |
|
208 | 206 | if range_pattern: |
|
209 | 207 | if not fnmatch.fnmatch(inline, range_pattern): |
|
210 | 208 | continue |
|
211 | 209 | inline = inline.expandtabs(4).rstrip() |
|
212 | 210 | |
|
213 | 211 | multiline = "\n" in inline |
|
214 | 212 | line_sep = '\n' if multiline else ' ' |
|
215 | 213 | if print_nums: |
|
216 | 214 | print(u'%s:%s' % (_format_lineno(session, lineno).rjust(width), |
|
217 | 215 | line_sep), file=outfile, end=u'') |
|
218 | 216 | if pyprompts: |
|
219 | 217 | print(u">>> ", end=u"", file=outfile) |
|
220 | 218 | if multiline: |
|
221 | 219 | inline = "\n... ".join(inline.splitlines()) + "\n..." |
|
222 | 220 | print(inline, file=outfile) |
|
223 | 221 | if get_output and output: |
|
224 | 222 | print(output, file=outfile) |
|
225 | 223 | |
|
226 | 224 | if close_at_end: |
|
227 | 225 | outfile.close() |
|
228 | 226 | |
|
229 | 227 | @line_magic |
|
230 | 228 | def recall(self, arg): |
|
231 | 229 | r"""Repeat a command, or get command to input line for editing. |
|
232 | 230 | |
|
233 | 231 | %recall and %rep are equivalent. |
|
234 | 232 | |
|
235 | 233 | - %recall (no arguments): |
|
236 | 234 | |
|
237 | 235 | Place a string version of last computation result (stored in the |
|
238 | 236 | special '_' variable) to the next input prompt. Allows you to create |
|
239 | 237 | elaborate command lines without using copy-paste:: |
|
240 | 238 | |
|
241 | 239 | In[1]: l = ["hei", "vaan"] |
|
242 | 240 | In[2]: "".join(l) |
|
243 | 241 | Out[2]: heivaan |
|
244 | 242 | In[3]: %recall |
|
245 | 243 | In[4]: heivaan_ <== cursor blinking |
|
246 | 244 | |
|
247 | 245 | %recall 45 |
|
248 | 246 | |
|
249 | 247 | Place history line 45 on the next input prompt. Use %hist to find |
|
250 | 248 | out the number. |
|
251 | 249 | |
|
252 | 250 | %recall 1-4 |
|
253 | 251 | |
|
254 | 252 | Combine the specified lines into one cell, and place it on the next |
|
255 | 253 | input prompt. See %history for the slice syntax. |
|
256 | 254 | |
|
257 | 255 | %recall foo+bar |
|
258 | 256 | |
|
259 | 257 | If foo+bar can be evaluated in the user namespace, the result is |
|
260 | 258 | placed at the next input prompt. Otherwise, the history is searched |
|
261 | 259 | for lines which contain that substring, and the most recent one is |
|
262 | 260 | placed at the next input prompt. |
|
263 | 261 | """ |
|
264 | 262 | if not arg: # Last output |
|
265 | 263 | self.shell.set_next_input(str(self.shell.user_ns["_"])) |
|
266 | 264 | return |
|
267 | 265 | # Get history range |
|
268 | 266 | histlines = self.shell.history_manager.get_range_by_str(arg) |
|
269 | 267 | cmd = "\n".join(x[2] for x in histlines) |
|
270 | 268 | if cmd: |
|
271 | 269 | self.shell.set_next_input(cmd.rstrip()) |
|
272 | 270 | return |
|
273 | 271 | |
|
274 | 272 | try: # Variable in user namespace |
|
275 | 273 | cmd = str(eval(arg, self.shell.user_ns)) |
|
276 | 274 | except Exception: # Search for term in history |
|
277 | 275 | histlines = self.shell.history_manager.search("*"+arg+"*") |
|
278 | 276 | for h in reversed([x[2] for x in histlines]): |
|
279 | 277 | if 'recall' in h or 'rep' in h: |
|
280 | 278 | continue |
|
281 | 279 | self.shell.set_next_input(h.rstrip()) |
|
282 | 280 | return |
|
283 | 281 | else: |
|
284 | 282 | self.shell.set_next_input(cmd.rstrip()) |
|
285 | 283 | return |
|
286 | 284 | print("Couldn't evaluate or find in history:", arg) |
|
287 | 285 | |
|
288 | 286 | @line_magic |
|
289 | 287 | def rerun(self, parameter_s=''): |
|
290 | 288 | """Re-run previous input |
|
291 | 289 | |
|
292 | 290 | By default, you can specify ranges of input history to be repeated |
|
293 | 291 | (as with %history). With no arguments, it will repeat the last line. |
|
294 | 292 | |
|
295 | 293 | Options: |
|
296 | 294 | |
|
297 | 295 | -l <n> : Repeat the last n lines of input, not including the |
|
298 | 296 | current command. |
|
299 | 297 | |
|
300 | 298 | -g foo : Repeat the most recent line which contains foo |
|
301 | 299 | """ |
|
302 | 300 | opts, args = self.parse_options(parameter_s, 'l:g:', mode='string') |
|
303 | 301 | if "l" in opts: # Last n lines |
|
304 | 302 | n = int(opts['l']) |
|
305 | 303 | |
|
306 | 304 | if n == 0: |
|
307 | 305 | print("Requested 0 last lines - nothing to run") |
|
308 | 306 | return |
|
309 | 307 | elif n < 0: |
|
310 | 308 | print("Number of lines to rerun cannot be negative") |
|
311 | 309 | return |
|
312 | 310 | |
|
313 | 311 | hist = self.shell.history_manager.get_tail(n) |
|
314 | 312 | elif "g" in opts: # Search |
|
315 | 313 | p = "*"+opts['g']+"*" |
|
316 | 314 | hist = list(self.shell.history_manager.search(p)) |
|
317 | 315 | for l in reversed(hist): |
|
318 | 316 | if "rerun" not in l[2]: |
|
319 | 317 | hist = [l] # The last match which isn't a %rerun |
|
320 | 318 | break |
|
321 | 319 | else: |
|
322 | 320 | hist = [] # No matches except %rerun |
|
323 | 321 | elif args: # Specify history ranges |
|
324 | 322 | hist = self.shell.history_manager.get_range_by_str(args) |
|
325 | 323 | else: # Last line |
|
326 | 324 | hist = self.shell.history_manager.get_tail(1) |
|
327 | 325 | hist = [x[2] for x in hist] |
|
328 | 326 | if not hist: |
|
329 | 327 | print("No lines in history match specification") |
|
330 | 328 | return |
|
331 | 329 | histlines = "\n".join(hist) |
|
332 | 330 | print("=== Executing: ===") |
|
333 | 331 | print(histlines) |
|
334 | 332 | print("=== Output: ===") |
|
335 | 333 | self.shell.run_cell("\n".join(hist), store_history=False) |
@@ -1,860 +1,859 b'' | |||
|
1 | 1 | """Implementation of magic functions for interaction with the OS. |
|
2 | 2 | |
|
3 | 3 | Note: this module is named 'osm' instead of 'os' to avoid a collision with the |
|
4 | 4 | builtin. |
|
5 | 5 | """ |
|
6 | 6 | # Copyright (c) IPython Development Team. |
|
7 | 7 | # Distributed under the terms of the Modified BSD License. |
|
8 | 8 | |
|
9 | 9 | import io |
|
10 | 10 | import os |
|
11 | 11 | import re |
|
12 | 12 | import sys |
|
13 | 13 | from pprint import pformat |
|
14 | 14 | |
|
15 | 15 | from IPython.core import magic_arguments |
|
16 | 16 | from IPython.core import oinspect |
|
17 | 17 | from IPython.core import page |
|
18 | 18 | from IPython.core.alias import AliasError, Alias |
|
19 | 19 | from IPython.core.error import UsageError |
|
20 | 20 | from IPython.core.magic import ( |
|
21 | 21 | Magics, compress_dhist, magics_class, line_magic, cell_magic, line_cell_magic |
|
22 | 22 | ) |
|
23 | 23 | from IPython.testing.skipdoctest import skip_doctest |
|
24 | 24 | from IPython.utils.openpy import source_to_unicode |
|
25 | 25 | from IPython.utils.process import abbrev_cwd |
|
26 | 26 | from IPython.utils.terminal import set_term_title |
|
27 | 27 | from traitlets import Bool |
|
28 | 28 | from warnings import warn |
|
29 | 29 | |
|
30 | 30 | |
|
31 | 31 | @magics_class |
|
32 | 32 | class OSMagics(Magics): |
|
33 | 33 | """Magics to interact with the underlying OS (shell-type functionality). |
|
34 | 34 | """ |
|
35 | 35 | |
|
36 | 36 | cd_force_quiet = Bool(False, |
|
37 | 37 | help="Force %cd magic to be quiet even if -q is not passed." |
|
38 | 38 | ).tag(config=True) |
|
39 | 39 | |
|
40 | 40 | def __init__(self, shell=None, **kwargs): |
|
41 | 41 | |
|
42 | 42 | # Now define isexec in a cross platform manner. |
|
43 | 43 | self.is_posix = False |
|
44 | 44 | self.execre = None |
|
45 | 45 | if os.name == 'posix': |
|
46 | 46 | self.is_posix = True |
|
47 | 47 | else: |
|
48 | 48 | try: |
|
49 | 49 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
50 | 50 | except KeyError: |
|
51 | 51 | winext = 'exe|com|bat|py' |
|
52 | 52 | try: |
|
53 | 53 | self.execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
54 | 54 | except re.error: |
|
55 | 55 | warn("Seems like your pathext environmental " |
|
56 | 56 | "variable is malformed. Please check it to " |
|
57 | 57 | "enable a proper handle of file extensions " |
|
58 | 58 | "managed for your system") |
|
59 | 59 | winext = 'exe|com|bat|py' |
|
60 | 60 | self.execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
61 | 61 | |
|
62 | 62 | # call up the chain |
|
63 | 63 | super().__init__(shell=shell, **kwargs) |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | @skip_doctest |
|
67 | 67 | def _isexec_POSIX(self, file): |
|
68 | 68 | """ |
|
69 | 69 | Test for executable on a POSIX system |
|
70 | 70 | """ |
|
71 | 71 | if os.access(file.path, os.X_OK): |
|
72 | 72 | # will fail on maxOS if access is not X_OK |
|
73 | 73 | return file.is_file() |
|
74 | 74 | return False |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | |
|
78 | 78 | @skip_doctest |
|
79 | 79 | def _isexec_WIN(self, file): |
|
80 | 80 | """ |
|
81 | 81 | Test for executable file on non POSIX system |
|
82 | 82 | """ |
|
83 | 83 | return file.is_file() and self.execre.match(file.name) is not None |
|
84 | 84 | |
|
85 | 85 | @skip_doctest |
|
86 | 86 | def isexec(self, file): |
|
87 | 87 | """ |
|
88 | 88 | Test for executable file on non POSIX system |
|
89 | 89 | """ |
|
90 | 90 | if self.is_posix: |
|
91 | 91 | return self._isexec_POSIX(file) |
|
92 | 92 | else: |
|
93 | 93 | return self._isexec_WIN(file) |
|
94 | 94 | |
|
95 | 95 | |
|
96 | 96 | @skip_doctest |
|
97 | 97 | @line_magic |
|
98 | 98 | def alias(self, parameter_s=''): |
|
99 | 99 | """Define an alias for a system command. |
|
100 | 100 | |
|
101 | 101 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
102 | 102 | |
|
103 | 103 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
104 | 104 | params' (from your underlying operating system). |
|
105 | 105 | |
|
106 | 106 | Aliases have lower precedence than magic functions and Python normal |
|
107 | 107 | variables, so if 'foo' is both a Python variable and an alias, the |
|
108 | 108 | alias can not be executed until 'del foo' removes the Python variable. |
|
109 | 109 | |
|
110 | 110 | You can use the %l specifier in an alias definition to represent the |
|
111 | 111 | whole line when the alias is called. For example:: |
|
112 | 112 | |
|
113 | 113 | In [2]: alias bracket echo "Input in brackets: <%l>" |
|
114 | 114 | In [3]: bracket hello world |
|
115 | 115 | Input in brackets: <hello world> |
|
116 | 116 | |
|
117 | 117 | You can also define aliases with parameters using %s specifiers (one |
|
118 | 118 | per parameter):: |
|
119 | 119 | |
|
120 | 120 | In [1]: alias parts echo first %s second %s |
|
121 | 121 | In [2]: %parts A B |
|
122 | 122 | first A second B |
|
123 | 123 | In [3]: %parts A |
|
124 | 124 | Incorrect number of arguments: 2 expected. |
|
125 | 125 | parts is an alias to: 'echo first %s second %s' |
|
126 | 126 | |
|
127 | 127 | Note that %l and %s are mutually exclusive. You can only use one or |
|
128 | 128 | the other in your aliases. |
|
129 | 129 | |
|
130 | 130 | Aliases expand Python variables just like system calls using ! or !! |
|
131 | 131 | do: all expressions prefixed with '$' get expanded. For details of |
|
132 | 132 | the semantic rules, see PEP-215: |
|
133 | 133 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
134 | 134 | IPython for variable expansion. If you want to access a true shell |
|
135 | 135 | variable, an extra $ is necessary to prevent its expansion by |
|
136 | 136 | IPython:: |
|
137 | 137 | |
|
138 | 138 | In [6]: alias show echo |
|
139 | 139 | In [7]: PATH='A Python string' |
|
140 | 140 | In [8]: show $PATH |
|
141 | 141 | A Python string |
|
142 | 142 | In [9]: show $$PATH |
|
143 | 143 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
144 | 144 | |
|
145 | 145 | You can use the alias facility to access all of $PATH. See the %rehashx |
|
146 | 146 | function, which automatically creates aliases for the contents of your |
|
147 | 147 | $PATH. |
|
148 | 148 | |
|
149 | 149 | If called with no parameters, %alias prints the current alias table |
|
150 | 150 | for your system. For posix systems, the default aliases are 'cat', |
|
151 | 151 | 'cp', 'mv', 'rm', 'rmdir', and 'mkdir', and other platform-specific |
|
152 | 152 | aliases are added. For windows-based systems, the default aliases are |
|
153 | 153 | 'copy', 'ddir', 'echo', 'ls', 'ldir', 'mkdir', 'ren', and 'rmdir'. |
|
154 | 154 | |
|
155 | 155 | You can see the definition of alias by adding a question mark in the |
|
156 | 156 | end:: |
|
157 | 157 | |
|
158 | 158 | In [1]: cat? |
|
159 | 159 | Repr: <alias cat for 'cat'>""" |
|
160 | 160 | |
|
161 | 161 | par = parameter_s.strip() |
|
162 | 162 | if not par: |
|
163 | 163 | aliases = sorted(self.shell.alias_manager.aliases) |
|
164 | 164 | # stored = self.shell.db.get('stored_aliases', {} ) |
|
165 | 165 | # for k, v in stored: |
|
166 | 166 | # atab.append(k, v[0]) |
|
167 | 167 | |
|
168 | 168 | print("Total number of aliases:", len(aliases)) |
|
169 | 169 | sys.stdout.flush() |
|
170 | 170 | return aliases |
|
171 | 171 | |
|
172 | 172 | # Now try to define a new one |
|
173 | 173 | try: |
|
174 | 174 | alias,cmd = par.split(None, 1) |
|
175 | 175 | except TypeError: |
|
176 | 176 | print(oinspect.getdoc(self.alias)) |
|
177 | 177 | return |
|
178 | 178 | |
|
179 | 179 | try: |
|
180 | 180 | self.shell.alias_manager.define_alias(alias, cmd) |
|
181 | 181 | except AliasError as e: |
|
182 | 182 | print(e) |
|
183 | 183 | # end magic_alias |
|
184 | 184 | |
|
185 | 185 | @line_magic |
|
186 | 186 | def unalias(self, parameter_s=''): |
|
187 | 187 | """Remove an alias""" |
|
188 | 188 | |
|
189 | 189 | aname = parameter_s.strip() |
|
190 | 190 | try: |
|
191 | 191 | self.shell.alias_manager.undefine_alias(aname) |
|
192 | 192 | except ValueError as e: |
|
193 | 193 | print(e) |
|
194 | 194 | return |
|
195 | 195 | |
|
196 | 196 | stored = self.shell.db.get('stored_aliases', {} ) |
|
197 | 197 | if aname in stored: |
|
198 | 198 | print("Removing %stored alias",aname) |
|
199 | 199 | del stored[aname] |
|
200 | 200 | self.shell.db['stored_aliases'] = stored |
|
201 | 201 | |
|
202 | 202 | @line_magic |
|
203 | 203 | def rehashx(self, parameter_s=''): |
|
204 | 204 | """Update the alias table with all executable files in $PATH. |
|
205 | 205 | |
|
206 | 206 | rehashx explicitly checks that every entry in $PATH is a file |
|
207 | 207 | with execute access (os.X_OK). |
|
208 | 208 | |
|
209 | 209 | Under Windows, it checks executability as a match against a |
|
210 | 210 | '|'-separated string of extensions, stored in the IPython config |
|
211 | 211 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
212 | 212 | |
|
213 | 213 | This function also resets the root module cache of module completer, |
|
214 | 214 | used on slow filesystems. |
|
215 | 215 | """ |
|
216 | 216 | from IPython.core.alias import InvalidAliasError |
|
217 | 217 | |
|
218 | 218 | # for the benefit of module completer in ipy_completers.py |
|
219 | 219 | del self.shell.db['rootmodules_cache'] |
|
220 | 220 | |
|
221 | 221 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
222 | 222 | os.environ.get('PATH','').split(os.pathsep)] |
|
223 | 223 | |
|
224 | 224 | syscmdlist = [] |
|
225 | 225 | savedir = os.getcwd() |
|
226 | 226 | |
|
227 | 227 | # Now walk the paths looking for executables to alias. |
|
228 | 228 | try: |
|
229 | 229 | # write the whole loop for posix/Windows so we don't have an if in |
|
230 | 230 | # the innermost part |
|
231 | 231 | if self.is_posix: |
|
232 | 232 | for pdir in path: |
|
233 | 233 | try: |
|
234 | 234 | os.chdir(pdir) |
|
235 | 235 | except OSError: |
|
236 | 236 | continue |
|
237 | 237 | |
|
238 | 238 | # for python 3.6+ rewrite to: with os.scandir(pdir) as dirlist: |
|
239 | 239 | dirlist = os.scandir(path=pdir) |
|
240 | 240 | for ff in dirlist: |
|
241 | 241 | if self.isexec(ff): |
|
242 | 242 | fname = ff.name |
|
243 | 243 | try: |
|
244 | 244 | # Removes dots from the name since ipython |
|
245 | 245 | # will assume names with dots to be python. |
|
246 | 246 | if not self.shell.alias_manager.is_alias(fname): |
|
247 | 247 | self.shell.alias_manager.define_alias( |
|
248 | 248 | fname.replace('.',''), fname) |
|
249 | 249 | except InvalidAliasError: |
|
250 | 250 | pass |
|
251 | 251 | else: |
|
252 | 252 | syscmdlist.append(fname) |
|
253 | 253 | else: |
|
254 | 254 | no_alias = Alias.blacklist |
|
255 | 255 | for pdir in path: |
|
256 | 256 | try: |
|
257 | 257 | os.chdir(pdir) |
|
258 | 258 | except OSError: |
|
259 | 259 | continue |
|
260 | 260 | |
|
261 | 261 | # for python 3.6+ rewrite to: with os.scandir(pdir) as dirlist: |
|
262 | 262 | dirlist = os.scandir(pdir) |
|
263 | 263 | for ff in dirlist: |
|
264 | 264 | fname = ff.name |
|
265 | 265 | base, ext = os.path.splitext(fname) |
|
266 | 266 | if self.isexec(ff) and base.lower() not in no_alias: |
|
267 | 267 | if ext.lower() == '.exe': |
|
268 | 268 | fname = base |
|
269 | 269 | try: |
|
270 | 270 | # Removes dots from the name since ipython |
|
271 | 271 | # will assume names with dots to be python. |
|
272 | 272 | self.shell.alias_manager.define_alias( |
|
273 | 273 | base.lower().replace('.',''), fname) |
|
274 | 274 | except InvalidAliasError: |
|
275 | 275 | pass |
|
276 | 276 | syscmdlist.append(fname) |
|
277 | 277 | |
|
278 | 278 | self.shell.db['syscmdlist'] = syscmdlist |
|
279 | 279 | finally: |
|
280 | 280 | os.chdir(savedir) |
|
281 | 281 | |
|
282 | 282 | @skip_doctest |
|
283 | 283 | @line_magic |
|
284 | 284 | def pwd(self, parameter_s=''): |
|
285 | 285 | """Return the current working directory path. |
|
286 | 286 | |
|
287 | 287 | Examples |
|
288 | 288 | -------- |
|
289 | 289 | :: |
|
290 | 290 | |
|
291 | 291 | In [9]: pwd |
|
292 | 292 | Out[9]: '/home/tsuser/sprint/ipython' |
|
293 | 293 | """ |
|
294 | 294 | try: |
|
295 | 295 | return os.getcwd() |
|
296 | 296 | except FileNotFoundError as e: |
|
297 | 297 | raise UsageError("CWD no longer exists - please use %cd to change directory.") from e |
|
298 | 298 | |
|
299 | 299 | @skip_doctest |
|
300 | 300 | @line_magic |
|
301 | 301 | def cd(self, parameter_s=''): |
|
302 | 302 | """Change the current working directory. |
|
303 | 303 | |
|
304 | 304 | This command automatically maintains an internal list of directories |
|
305 | 305 | you visit during your IPython session, in the variable ``_dh``. The |
|
306 | 306 | command :magic:`%dhist` shows this history nicely formatted. You can |
|
307 | 307 | also do ``cd -<tab>`` to see directory history conveniently. |
|
308 | 308 | Usage: |
|
309 | 309 | |
|
310 | 310 | - ``cd 'dir'``: changes to directory 'dir'. |
|
311 | 311 | - ``cd -``: changes to the last visited directory. |
|
312 | 312 | - ``cd -<n>``: changes to the n-th directory in the directory history. |
|
313 | 313 | - ``cd --foo``: change to directory that matches 'foo' in history |
|
314 | 314 | - ``cd -b <bookmark_name>``: jump to a bookmark set by %bookmark |
|
315 | 315 | - Hitting a tab key after ``cd -b`` allows you to tab-complete |
|
316 | 316 | bookmark names. |
|
317 | 317 | |
|
318 | 318 | .. note:: |
|
319 | 319 | ``cd <bookmark_name>`` is enough if there is no directory |
|
320 | 320 | ``<bookmark_name>``, but a bookmark with the name exists. |
|
321 | 321 | |
|
322 | 322 | |
|
323 | 323 | Options: |
|
324 | 324 | |
|
325 | 325 | -q Be quiet. Do not print the working directory after the |
|
326 | 326 | cd command is executed. By default IPython's cd |
|
327 | 327 | command does print this directory, since the default |
|
328 | 328 | prompts do not display path information. |
|
329 | 329 | |
|
330 | 330 | .. note:: |
|
331 | 331 | Note that ``!cd`` doesn't work for this purpose because the shell |
|
332 | 332 | where ``!command`` runs is immediately discarded after executing |
|
333 | 333 | 'command'. |
|
334 | 334 | |
|
335 | 335 | |
|
336 | 336 | Examples |
|
337 | 337 | -------- |
|
338 | 338 | :: |
|
339 | 339 | |
|
340 | 340 | In [10]: cd parent/child |
|
341 | 341 | /home/tsuser/parent/child |
|
342 | 342 | """ |
|
343 | 343 | |
|
344 | 344 | try: |
|
345 | 345 | oldcwd = os.getcwd() |
|
346 | 346 | except FileNotFoundError: |
|
347 | 347 | # Happens if the CWD has been deleted. |
|
348 | 348 | oldcwd = None |
|
349 | 349 | |
|
350 | 350 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
351 | 351 | # jump in directory history by number |
|
352 | 352 | if numcd: |
|
353 | 353 | nn = int(numcd.group(2)) |
|
354 | 354 | try: |
|
355 | 355 | ps = self.shell.user_ns['_dh'][nn] |
|
356 | 356 | except IndexError: |
|
357 | 357 | print('The requested directory does not exist in history.') |
|
358 | 358 | return |
|
359 | 359 | else: |
|
360 | 360 | opts = {} |
|
361 | 361 | elif parameter_s.startswith('--'): |
|
362 | 362 | ps = None |
|
363 | 363 | fallback = None |
|
364 | 364 | pat = parameter_s[2:] |
|
365 | 365 | dh = self.shell.user_ns['_dh'] |
|
366 | 366 | # first search only by basename (last component) |
|
367 | 367 | for ent in reversed(dh): |
|
368 | 368 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
369 | 369 | ps = ent |
|
370 | 370 | break |
|
371 | 371 | |
|
372 | 372 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
373 | 373 | fallback = ent |
|
374 | 374 | |
|
375 | 375 | # if we have no last part match, pick the first full path match |
|
376 | 376 | if ps is None: |
|
377 | 377 | ps = fallback |
|
378 | 378 | |
|
379 | 379 | if ps is None: |
|
380 | 380 | print("No matching entry in directory history") |
|
381 | 381 | return |
|
382 | 382 | else: |
|
383 | 383 | opts = {} |
|
384 | 384 | |
|
385 | 385 | |
|
386 | 386 | else: |
|
387 | 387 | opts, ps = self.parse_options(parameter_s, 'qb', mode='string') |
|
388 | 388 | # jump to previous |
|
389 | 389 | if ps == '-': |
|
390 | 390 | try: |
|
391 | 391 | ps = self.shell.user_ns['_dh'][-2] |
|
392 | 392 | except IndexError as e: |
|
393 | 393 | raise UsageError('%cd -: No previous directory to change to.') from e |
|
394 | 394 | # jump to bookmark if needed |
|
395 | 395 | else: |
|
396 | 396 | if not os.path.isdir(ps) or 'b' in opts: |
|
397 | 397 | bkms = self.shell.db.get('bookmarks', {}) |
|
398 | 398 | |
|
399 | 399 | if ps in bkms: |
|
400 | 400 | target = bkms[ps] |
|
401 | 401 | print('(bookmark:%s) -> %s' % (ps, target)) |
|
402 | 402 | ps = target |
|
403 | 403 | else: |
|
404 | 404 | if 'b' in opts: |
|
405 | 405 | raise UsageError("Bookmark '%s' not found. " |
|
406 | 406 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
407 | 407 | |
|
408 | 408 | # at this point ps should point to the target dir |
|
409 | 409 | if ps: |
|
410 | 410 | try: |
|
411 | 411 | os.chdir(os.path.expanduser(ps)) |
|
412 | 412 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
413 | 413 | set_term_title(self.shell.term_title_format.format(cwd=abbrev_cwd())) |
|
414 | 414 | except OSError: |
|
415 | 415 | print(sys.exc_info()[1]) |
|
416 | 416 | else: |
|
417 | 417 | cwd = os.getcwd() |
|
418 | 418 | dhist = self.shell.user_ns['_dh'] |
|
419 | 419 | if oldcwd != cwd: |
|
420 | 420 | dhist.append(cwd) |
|
421 | 421 | self.shell.db['dhist'] = compress_dhist(dhist)[-100:] |
|
422 | 422 | |
|
423 | 423 | else: |
|
424 | 424 | os.chdir(self.shell.home_dir) |
|
425 | 425 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
426 | 426 | set_term_title(self.shell.term_title_format.format(cwd="~")) |
|
427 | 427 | cwd = os.getcwd() |
|
428 | 428 | dhist = self.shell.user_ns['_dh'] |
|
429 | 429 | |
|
430 | 430 | if oldcwd != cwd: |
|
431 | 431 | dhist.append(cwd) |
|
432 | 432 | self.shell.db['dhist'] = compress_dhist(dhist)[-100:] |
|
433 | 433 | if not 'q' in opts and not self.cd_force_quiet and self.shell.user_ns['_dh']: |
|
434 | 434 | print(self.shell.user_ns['_dh'][-1]) |
|
435 | 435 | |
|
436 | 436 | @line_magic |
|
437 | 437 | def env(self, parameter_s=''): |
|
438 | 438 | """Get, set, or list environment variables. |
|
439 | 439 | |
|
440 | 440 | Usage:\\ |
|
441 | 441 | |
|
442 | 442 | :``%env``: lists all environment variables/values |
|
443 | 443 | :``%env var``: get value for var |
|
444 | 444 | :``%env var val``: set value for var |
|
445 | 445 | :``%env var=val``: set value for var |
|
446 | 446 | :``%env var=$val``: set value for var, using python expansion if possible |
|
447 | 447 | """ |
|
448 | 448 | if parameter_s.strip(): |
|
449 | 449 | split = '=' if '=' in parameter_s else ' ' |
|
450 | 450 | bits = parameter_s.split(split) |
|
451 | 451 | if len(bits) == 1: |
|
452 | 452 | key = parameter_s.strip() |
|
453 | 453 | if key in os.environ: |
|
454 | 454 | return os.environ[key] |
|
455 | 455 | else: |
|
456 | 456 | err = "Environment does not have key: {0}".format(key) |
|
457 | 457 | raise UsageError(err) |
|
458 | 458 | if len(bits) > 1: |
|
459 | 459 | return self.set_env(parameter_s) |
|
460 | 460 | env = dict(os.environ) |
|
461 | 461 | # hide likely secrets when printing the whole environment |
|
462 | 462 | for key in list(env): |
|
463 | 463 | if any(s in key.lower() for s in ('key', 'token', 'secret')): |
|
464 | 464 | env[key] = '<hidden>' |
|
465 | 465 | |
|
466 | 466 | return env |
|
467 | 467 | |
|
468 | 468 | @line_magic |
|
469 | 469 | def set_env(self, parameter_s): |
|
470 | 470 | """Set environment variables. Assumptions are that either "val" is a |
|
471 | 471 | name in the user namespace, or val is something that evaluates to a |
|
472 | 472 | string. |
|
473 | 473 | |
|
474 | 474 | Usage:\\ |
|
475 | 475 | %set_env var val: set value for var |
|
476 | 476 | %set_env var=val: set value for var |
|
477 | 477 | %set_env var=$val: set value for var, using python expansion if possible |
|
478 | 478 | """ |
|
479 | 479 | split = '=' if '=' in parameter_s else ' ' |
|
480 | 480 | bits = parameter_s.split(split, 1) |
|
481 | 481 | if not parameter_s.strip() or len(bits)<2: |
|
482 | 482 | raise UsageError("usage is 'set_env var=val'") |
|
483 | 483 | var = bits[0].strip() |
|
484 | 484 | val = bits[1].strip() |
|
485 | 485 | if re.match(r'.*\s.*', var): |
|
486 | 486 | # an environment variable with whitespace is almost certainly |
|
487 | 487 | # not what the user intended. what's more likely is the wrong |
|
488 | 488 | # split was chosen, ie for "set_env cmd_args A=B", we chose |
|
489 | 489 | # '=' for the split and should have chosen ' '. to get around |
|
490 | 490 | # this, users should just assign directly to os.environ or use |
|
491 | 491 | # standard magic {var} expansion. |
|
492 | 492 | err = "refusing to set env var with whitespace: '{0}'" |
|
493 | 493 | err = err.format(val) |
|
494 | 494 | raise UsageError(err) |
|
495 | 495 | os.environ[var] = val |
|
496 | 496 | print('env: {0}={1}'.format(var,val)) |
|
497 | 497 | |
|
498 | 498 | @line_magic |
|
499 | 499 | def pushd(self, parameter_s=''): |
|
500 | 500 | """Place the current dir on stack and change directory. |
|
501 | 501 | |
|
502 | 502 | Usage:\\ |
|
503 | 503 | %pushd ['dirname'] |
|
504 | 504 | """ |
|
505 | 505 | |
|
506 | 506 | dir_s = self.shell.dir_stack |
|
507 | 507 | tgt = os.path.expanduser(parameter_s) |
|
508 | 508 | cwd = os.getcwd().replace(self.shell.home_dir,'~') |
|
509 | 509 | if tgt: |
|
510 | 510 | self.cd(parameter_s) |
|
511 | 511 | dir_s.insert(0,cwd) |
|
512 | 512 | return self.shell.run_line_magic('dirs', '') |
|
513 | 513 | |
|
514 | 514 | @line_magic |
|
515 | 515 | def popd(self, parameter_s=''): |
|
516 | 516 | """Change to directory popped off the top of the stack. |
|
517 | 517 | """ |
|
518 | 518 | if not self.shell.dir_stack: |
|
519 | 519 | raise UsageError("%popd on empty stack") |
|
520 | 520 | top = self.shell.dir_stack.pop(0) |
|
521 | 521 | self.cd(top) |
|
522 | 522 | print("popd ->",top) |
|
523 | 523 | |
|
524 | 524 | @line_magic |
|
525 | 525 | def dirs(self, parameter_s=''): |
|
526 | 526 | """Return the current directory stack.""" |
|
527 | 527 | |
|
528 | 528 | return self.shell.dir_stack |
|
529 | 529 | |
|
530 | 530 | @line_magic |
|
531 | 531 | def dhist(self, parameter_s=''): |
|
532 | 532 | """Print your history of visited directories. |
|
533 | 533 | |
|
534 | 534 | %dhist -> print full history\\ |
|
535 | 535 | %dhist n -> print last n entries only\\ |
|
536 | 536 | %dhist n1 n2 -> print entries between n1 and n2 (n2 not included)\\ |
|
537 | 537 | |
|
538 | 538 | This history is automatically maintained by the %cd command, and |
|
539 | 539 | always available as the global list variable _dh. You can use %cd -<n> |
|
540 | 540 | to go to directory number <n>. |
|
541 | 541 | |
|
542 | 542 | Note that most of time, you should view directory history by entering |
|
543 | 543 | cd -<TAB>. |
|
544 | 544 | |
|
545 | 545 | """ |
|
546 | 546 | |
|
547 | 547 | dh = self.shell.user_ns['_dh'] |
|
548 | 548 | if parameter_s: |
|
549 | 549 | try: |
|
550 | 550 | args = map(int,parameter_s.split()) |
|
551 | 551 | except: |
|
552 | 552 | self.arg_err(self.dhist) |
|
553 | 553 | return |
|
554 | 554 | if len(args) == 1: |
|
555 | 555 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
556 | 556 | elif len(args) == 2: |
|
557 | 557 | ini,fin = args |
|
558 | 558 | fin = min(fin, len(dh)) |
|
559 | 559 | else: |
|
560 | 560 | self.arg_err(self.dhist) |
|
561 | 561 | return |
|
562 | 562 | else: |
|
563 | 563 | ini,fin = 0,len(dh) |
|
564 | 564 | print('Directory history (kept in _dh)') |
|
565 | 565 | for i in range(ini, fin): |
|
566 | 566 | print("%d: %s" % (i, dh[i])) |
|
567 | 567 | |
|
568 | 568 | @skip_doctest |
|
569 | 569 | @line_magic |
|
570 | 570 | def sc(self, parameter_s=''): |
|
571 | 571 | """Shell capture - run shell command and capture output (DEPRECATED use !). |
|
572 | 572 | |
|
573 | 573 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
574 | 574 | |
|
575 | 575 | You should use the form 'var = !command' instead. Example: |
|
576 | 576 | |
|
577 | 577 | "%sc -l myfiles = ls ~" should now be written as |
|
578 | 578 | |
|
579 | 579 | "myfiles = !ls ~" |
|
580 | 580 | |
|
581 | 581 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
582 | 582 | below. |
|
583 | 583 | |
|
584 | 584 | -- |
|
585 | 585 | %sc [options] varname=command |
|
586 | 586 | |
|
587 | 587 | IPython will run the given command using commands.getoutput(), and |
|
588 | 588 | will then update the user's interactive namespace with a variable |
|
589 | 589 | called varname, containing the value of the call. Your command can |
|
590 | 590 | contain shell wildcards, pipes, etc. |
|
591 | 591 | |
|
592 | 592 | The '=' sign in the syntax is mandatory, and the variable name you |
|
593 | 593 | supply must follow Python's standard conventions for valid names. |
|
594 | 594 | |
|
595 | 595 | (A special format without variable name exists for internal use) |
|
596 | 596 | |
|
597 | 597 | Options: |
|
598 | 598 | |
|
599 | 599 | -l: list output. Split the output on newlines into a list before |
|
600 | 600 | assigning it to the given variable. By default the output is stored |
|
601 | 601 | as a single string. |
|
602 | 602 | |
|
603 | 603 | -v: verbose. Print the contents of the variable. |
|
604 | 604 | |
|
605 | 605 | In most cases you should not need to split as a list, because the |
|
606 | 606 | returned value is a special type of string which can automatically |
|
607 | 607 | provide its contents either as a list (split on newlines) or as a |
|
608 | 608 | space-separated string. These are convenient, respectively, either |
|
609 | 609 | for sequential processing or to be passed to a shell command. |
|
610 | 610 | |
|
611 | 611 | For example:: |
|
612 | 612 | |
|
613 | 613 | # Capture into variable a |
|
614 | 614 | In [1]: sc a=ls *py |
|
615 | 615 | |
|
616 | 616 | # a is a string with embedded newlines |
|
617 | 617 | In [2]: a |
|
618 | 618 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
619 | 619 | |
|
620 | 620 | # which can be seen as a list: |
|
621 | 621 | In [3]: a.l |
|
622 | 622 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
623 | 623 | |
|
624 | 624 | # or as a whitespace-separated string: |
|
625 | 625 | In [4]: a.s |
|
626 | 626 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
627 | 627 | |
|
628 | 628 | # a.s is useful to pass as a single command line: |
|
629 | 629 | In [5]: !wc -l $a.s |
|
630 | 630 | 146 setup.py |
|
631 | 631 | 130 win32_manual_post_install.py |
|
632 | 632 | 276 total |
|
633 | 633 | |
|
634 | 634 | # while the list form is useful to loop over: |
|
635 | 635 | In [6]: for f in a.l: |
|
636 | 636 | ...: !wc -l $f |
|
637 | 637 | ...: |
|
638 | 638 | 146 setup.py |
|
639 | 639 | 130 win32_manual_post_install.py |
|
640 | 640 | |
|
641 | 641 | Similarly, the lists returned by the -l option are also special, in |
|
642 | 642 | the sense that you can equally invoke the .s attribute on them to |
|
643 | 643 | automatically get a whitespace-separated string from their contents:: |
|
644 | 644 | |
|
645 | 645 | In [7]: sc -l b=ls *py |
|
646 | 646 | |
|
647 | 647 | In [8]: b |
|
648 | 648 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
649 | 649 | |
|
650 | 650 | In [9]: b.s |
|
651 | 651 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
652 | 652 | |
|
653 | 653 | In summary, both the lists and strings used for output capture have |
|
654 | 654 | the following special attributes:: |
|
655 | 655 | |
|
656 | 656 | .l (or .list) : value as list. |
|
657 | 657 | .n (or .nlstr): value as newline-separated string. |
|
658 | 658 | .s (or .spstr): value as space-separated string. |
|
659 | 659 | """ |
|
660 | 660 | |
|
661 | 661 | opts,args = self.parse_options(parameter_s, 'lv') |
|
662 | 662 | # Try to get a variable name and command to run |
|
663 | 663 | try: |
|
664 | 664 | # the variable name must be obtained from the parse_options |
|
665 | 665 | # output, which uses shlex.split to strip options out. |
|
666 | 666 | var,_ = args.split('=', 1) |
|
667 | 667 | var = var.strip() |
|
668 | 668 | # But the command has to be extracted from the original input |
|
669 | 669 | # parameter_s, not on what parse_options returns, to avoid the |
|
670 | 670 | # quote stripping which shlex.split performs on it. |
|
671 | 671 | _,cmd = parameter_s.split('=', 1) |
|
672 | 672 | except ValueError: |
|
673 | 673 | var,cmd = '','' |
|
674 | 674 | # If all looks ok, proceed |
|
675 | 675 | split = 'l' in opts |
|
676 | 676 | out = self.shell.getoutput(cmd, split=split) |
|
677 | 677 | if 'v' in opts: |
|
678 | 678 | print('%s ==\n%s' % (var, pformat(out))) |
|
679 | 679 | if var: |
|
680 | 680 | self.shell.user_ns.update({var:out}) |
|
681 | 681 | else: |
|
682 | 682 | return out |
|
683 | 683 | |
|
684 | 684 | @line_cell_magic |
|
685 | 685 | def sx(self, line='', cell=None): |
|
686 | 686 | """Shell execute - run shell command and capture output (!! is short-hand). |
|
687 | 687 | |
|
688 | 688 | %sx command |
|
689 | 689 | |
|
690 | 690 | IPython will run the given command using commands.getoutput(), and |
|
691 | 691 | return the result formatted as a list (split on '\\n'). Since the |
|
692 | 692 | output is _returned_, it will be stored in ipython's regular output |
|
693 | 693 | cache Out[N] and in the '_N' automatic variables. |
|
694 | 694 | |
|
695 | 695 | Notes: |
|
696 | 696 | |
|
697 | 697 | 1) If an input line begins with '!!', then %sx is automatically |
|
698 | 698 | invoked. That is, while:: |
|
699 | 699 | |
|
700 | 700 | !ls |
|
701 | 701 | |
|
702 | 702 | causes ipython to simply issue system('ls'), typing:: |
|
703 | 703 | |
|
704 | 704 | !!ls |
|
705 | 705 | |
|
706 | 706 | is a shorthand equivalent to:: |
|
707 | 707 | |
|
708 | 708 | %sx ls |
|
709 | 709 | |
|
710 | 710 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
711 | 711 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
712 | 712 | to process line-oriented shell output via further python commands. |
|
713 | 713 | %sc is meant to provide much finer control, but requires more |
|
714 | 714 | typing. |
|
715 | 715 | |
|
716 | 716 | 3) Just like %sc -l, this is a list with special attributes: |
|
717 | 717 | :: |
|
718 | 718 | |
|
719 | 719 | .l (or .list) : value as list. |
|
720 | 720 | .n (or .nlstr): value as newline-separated string. |
|
721 | 721 | .s (or .spstr): value as whitespace-separated string. |
|
722 | 722 | |
|
723 | 723 | This is very useful when trying to use such lists as arguments to |
|
724 | 724 | system commands.""" |
|
725 | 725 | |
|
726 | 726 | if cell is None: |
|
727 | 727 | # line magic |
|
728 | 728 | return self.shell.getoutput(line) |
|
729 | 729 | else: |
|
730 | 730 | opts,args = self.parse_options(line, '', 'out=') |
|
731 | 731 | output = self.shell.getoutput(cell) |
|
732 | 732 | out_name = opts.get('out', opts.get('o')) |
|
733 | 733 | if out_name: |
|
734 | 734 | self.shell.user_ns[out_name] = output |
|
735 | 735 | else: |
|
736 | 736 | return output |
|
737 | 737 | |
|
738 | 738 | system = line_cell_magic('system')(sx) |
|
739 | 739 | bang = cell_magic('!')(sx) |
|
740 | 740 | |
|
741 | 741 | @line_magic |
|
742 | 742 | def bookmark(self, parameter_s=''): |
|
743 | 743 | """Manage IPython's bookmark system. |
|
744 | 744 | |
|
745 | 745 | %bookmark <name> - set bookmark to current dir |
|
746 | 746 | %bookmark <name> <dir> - set bookmark to <dir> |
|
747 | 747 | %bookmark -l - list all bookmarks |
|
748 | 748 | %bookmark -d <name> - remove bookmark |
|
749 | 749 | %bookmark -r - remove all bookmarks |
|
750 | 750 | |
|
751 | 751 | You can later on access a bookmarked folder with:: |
|
752 | 752 | |
|
753 | 753 | %cd -b <name> |
|
754 | 754 | |
|
755 | 755 | or simply '%cd <name>' if there is no directory called <name> AND |
|
756 | 756 | there is such a bookmark defined. |
|
757 | 757 | |
|
758 | 758 | Your bookmarks persist through IPython sessions, but they are |
|
759 | 759 | associated with each profile.""" |
|
760 | 760 | |
|
761 | 761 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
762 | 762 | if len(args) > 2: |
|
763 | 763 | raise UsageError("%bookmark: too many arguments") |
|
764 | 764 | |
|
765 | 765 | bkms = self.shell.db.get('bookmarks',{}) |
|
766 | 766 | |
|
767 | 767 | if 'd' in opts: |
|
768 | 768 | try: |
|
769 | 769 | todel = args[0] |
|
770 | 770 | except IndexError as e: |
|
771 | 771 | raise UsageError( |
|
772 | 772 | "%bookmark -d: must provide a bookmark to delete") from e |
|
773 | 773 | else: |
|
774 | 774 | try: |
|
775 | 775 | del bkms[todel] |
|
776 | 776 | except KeyError as e: |
|
777 | 777 | raise UsageError( |
|
778 | 778 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) from e |
|
779 | 779 | |
|
780 | 780 | elif 'r' in opts: |
|
781 | 781 | bkms = {} |
|
782 | 782 | elif 'l' in opts: |
|
783 | 783 | bks = sorted(bkms) |
|
784 | 784 | if bks: |
|
785 | 785 | size = max(map(len, bks)) |
|
786 | 786 | else: |
|
787 | 787 | size = 0 |
|
788 | 788 | fmt = '%-'+str(size)+'s -> %s' |
|
789 | 789 | print('Current bookmarks:') |
|
790 | 790 | for bk in bks: |
|
791 | 791 | print(fmt % (bk, bkms[bk])) |
|
792 | 792 | else: |
|
793 | 793 | if not args: |
|
794 | 794 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
795 | 795 | elif len(args)==1: |
|
796 | 796 | bkms[args[0]] = os.getcwd() |
|
797 | 797 | elif len(args)==2: |
|
798 | 798 | bkms[args[0]] = args[1] |
|
799 | 799 | self.shell.db['bookmarks'] = bkms |
|
800 | 800 | |
|
801 | 801 | @line_magic |
|
802 | 802 | def pycat(self, parameter_s=''): |
|
803 | 803 | """Show a syntax-highlighted file through a pager. |
|
804 | 804 | |
|
805 | 805 | This magic is similar to the cat utility, but it will assume the file |
|
806 | 806 | to be Python source and will show it with syntax highlighting. |
|
807 | 807 | |
|
808 | 808 | This magic command can either take a local filename, an url, |
|
809 |
an history range (see %history) or a macro as argument |
|
|
809 | an history range (see %history) or a macro as argument. | |
|
810 | ||
|
811 | If no parameter is given, prints out history of current session up to | |
|
812 | this point. :: | |
|
810 | 813 | |
|
811 | 814 | %pycat myscript.py |
|
812 | 815 | %pycat 7-27 |
|
813 | 816 | %pycat myMacro |
|
814 | 817 | %pycat http://www.example.com/myscript.py |
|
815 | 818 | """ |
|
816 | if not parameter_s: | |
|
817 | raise UsageError('Missing filename, URL, input history range, ' | |
|
818 | 'or macro.') | |
|
819 | ||
|
820 | try : | |
|
819 | try: | |
|
821 | 820 | cont = self.shell.find_user_code(parameter_s, skip_encoding_cookie=False) |
|
822 | 821 | except (ValueError, IOError): |
|
823 | 822 | print("Error: no such file, variable, URL, history range or macro") |
|
824 | 823 | return |
|
825 | 824 | |
|
826 | 825 | page.page(self.shell.pycolorize(source_to_unicode(cont))) |
|
827 | 826 | |
|
828 | 827 | @magic_arguments.magic_arguments() |
|
829 | 828 | @magic_arguments.argument( |
|
830 | 829 | '-a', '--append', action='store_true', default=False, |
|
831 | 830 | help='Append contents of the cell to an existing file. ' |
|
832 | 831 | 'The file will be created if it does not exist.' |
|
833 | 832 | ) |
|
834 | 833 | @magic_arguments.argument( |
|
835 | 834 | 'filename', type=str, |
|
836 | 835 | help='file to write' |
|
837 | 836 | ) |
|
838 | 837 | @cell_magic |
|
839 | 838 | def writefile(self, line, cell): |
|
840 | 839 | """Write the contents of the cell to a file. |
|
841 | 840 | |
|
842 | 841 | The file will be overwritten unless the -a (--append) flag is specified. |
|
843 | 842 | """ |
|
844 | 843 | args = magic_arguments.parse_argstring(self.writefile, line) |
|
845 | 844 | if re.match(r'^(\'.*\')|(".*")$', args.filename): |
|
846 | 845 | filename = os.path.expanduser(args.filename[1:-1]) |
|
847 | 846 | else: |
|
848 | 847 | filename = os.path.expanduser(args.filename) |
|
849 | 848 | |
|
850 | 849 | if os.path.exists(filename): |
|
851 | 850 | if args.append: |
|
852 | 851 | print("Appending to %s" % filename) |
|
853 | 852 | else: |
|
854 | 853 | print("Overwriting %s" % filename) |
|
855 | 854 | else: |
|
856 | 855 | print("Writing %s" % filename) |
|
857 | 856 | |
|
858 | 857 | mode = 'a' if args.append else 'w' |
|
859 | 858 | with io.open(filename, mode, encoding='utf-8') as f: |
|
860 | 859 | f.write(cell) |
@@ -1,215 +1,223 b'' | |||
|
1 | 1 | # coding: utf-8 |
|
2 | 2 | """Tests for the IPython tab-completion machinery. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Module imports |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | |
|
8 | 8 | # stdlib |
|
9 | 9 | import io |
|
10 | 10 | from pathlib import Path |
|
11 | 11 | import sys |
|
12 | 12 | import tempfile |
|
13 | 13 | from datetime import datetime |
|
14 | 14 | import sqlite3 |
|
15 | 15 | |
|
16 | 16 | # third party |
|
17 | 17 | import nose.tools as nt |
|
18 | 18 | |
|
19 | 19 | # our own packages |
|
20 | 20 | from traitlets.config.loader import Config |
|
21 | 21 | from IPython.utils.tempdir import TemporaryDirectory |
|
22 | 22 | from IPython.core.history import HistoryManager, extract_hist_ranges |
|
23 | 23 | from IPython.testing.decorators import skipif |
|
24 | 24 | |
|
25 | 25 | def test_proper_default_encoding(): |
|
26 | 26 | nt.assert_equal(sys.getdefaultencoding(), "utf-8") |
|
27 | 27 | |
|
28 | 28 | @skipif(sqlite3.sqlite_version_info > (3,24,0)) |
|
29 | 29 | def test_history(): |
|
30 | 30 | ip = get_ipython() |
|
31 | 31 | with TemporaryDirectory() as tmpdir: |
|
32 | 32 | tmp_path = Path(tmpdir) |
|
33 | 33 | hist_manager_ori = ip.history_manager |
|
34 | 34 | hist_file = tmp_path / "history.sqlite" |
|
35 | 35 | try: |
|
36 | 36 | ip.history_manager = HistoryManager(shell=ip, hist_file=hist_file) |
|
37 | 37 | hist = [u'a=1', u'def f():\n test = 1\n return test', u"b='β¬ΓΒΎΓ·Γ'"] |
|
38 | 38 | for i, h in enumerate(hist, start=1): |
|
39 | 39 | ip.history_manager.store_inputs(i, h) |
|
40 | 40 | |
|
41 | 41 | ip.history_manager.db_log_output = True |
|
42 | 42 | # Doesn't match the input, but we'll just check it's stored. |
|
43 | 43 | ip.history_manager.output_hist_reprs[3] = "spam" |
|
44 | 44 | ip.history_manager.store_output(3) |
|
45 | 45 | |
|
46 | 46 | nt.assert_equal(ip.history_manager.input_hist_raw, [''] + hist) |
|
47 | 47 | |
|
48 | 48 | # Detailed tests for _get_range_session |
|
49 | 49 | grs = ip.history_manager._get_range_session |
|
50 | 50 | nt.assert_equal(list(grs(start=2,stop=-1)), list(zip([0], [2], hist[1:-1]))) |
|
51 | 51 | nt.assert_equal(list(grs(start=-2)), list(zip([0,0], [2,3], hist[-2:]))) |
|
52 | 52 | nt.assert_equal(list(grs(output=True)), list(zip([0,0,0], [1,2,3], zip(hist, [None,None,'spam'])))) |
|
53 | 53 | |
|
54 | 54 | # Check whether specifying a range beyond the end of the current |
|
55 | 55 | # session results in an error (gh-804) |
|
56 | 56 | ip.magic('%hist 2-500') |
|
57 | 57 | |
|
58 | 58 | # Check that we can write non-ascii characters to a file |
|
59 | 59 | ip.magic("%%hist -f %s" % (tmp_path / "test1")) |
|
60 | 60 | ip.magic("%%hist -pf %s" % (tmp_path / "test2")) |
|
61 | 61 | ip.magic("%%hist -nf %s" % (tmp_path / "test3")) |
|
62 | 62 | ip.magic("%%save %s 1-10" % (tmp_path / "test4")) |
|
63 | 63 | |
|
64 | 64 | # New session |
|
65 | 65 | ip.history_manager.reset() |
|
66 | 66 | newcmds = [u"z=5", |
|
67 | 67 | u"class X(object):\n pass", |
|
68 | 68 | u"k='p'", |
|
69 | 69 | u"z=5"] |
|
70 | 70 | for i, cmd in enumerate(newcmds, start=1): |
|
71 | 71 | ip.history_manager.store_inputs(i, cmd) |
|
72 | 72 | gothist = ip.history_manager.get_range(start=1, stop=4) |
|
73 | 73 | nt.assert_equal(list(gothist), list(zip([0,0,0],[1,2,3], newcmds))) |
|
74 | 74 | # Previous session: |
|
75 | 75 | gothist = ip.history_manager.get_range(-1, 1, 4) |
|
76 | 76 | nt.assert_equal(list(gothist), list(zip([1,1,1],[1,2,3], hist))) |
|
77 | 77 | |
|
78 | 78 | newhist = [(2, i, c) for (i, c) in enumerate(newcmds, 1)] |
|
79 | 79 | |
|
80 | 80 | # Check get_hist_tail |
|
81 | 81 | gothist = ip.history_manager.get_tail(5, output=True, |
|
82 | 82 | include_latest=True) |
|
83 | 83 | expected = [(1, 3, (hist[-1], "spam"))] \ |
|
84 | 84 | + [(s, n, (c, None)) for (s, n, c) in newhist] |
|
85 | 85 | nt.assert_equal(list(gothist), expected) |
|
86 | 86 | |
|
87 | 87 | gothist = ip.history_manager.get_tail(2) |
|
88 | 88 | expected = newhist[-3:-1] |
|
89 | 89 | nt.assert_equal(list(gothist), expected) |
|
90 | 90 | |
|
91 | 91 | # Check get_hist_search |
|
92 | 92 | |
|
93 | 93 | gothist = ip.history_manager.search("*test*") |
|
94 | 94 | nt.assert_equal(list(gothist), [(1,2,hist[1])] ) |
|
95 | 95 | |
|
96 | 96 | gothist = ip.history_manager.search("*=*") |
|
97 | 97 | nt.assert_equal(list(gothist), |
|
98 | 98 | [(1, 1, hist[0]), |
|
99 | 99 | (1, 2, hist[1]), |
|
100 | 100 | (1, 3, hist[2]), |
|
101 | 101 | newhist[0], |
|
102 | 102 | newhist[2], |
|
103 | 103 | newhist[3]]) |
|
104 | 104 | |
|
105 | 105 | gothist = ip.history_manager.search("*=*", n=4) |
|
106 | 106 | nt.assert_equal(list(gothist), |
|
107 | 107 | [(1, 3, hist[2]), |
|
108 | 108 | newhist[0], |
|
109 | 109 | newhist[2], |
|
110 | 110 | newhist[3]]) |
|
111 | 111 | |
|
112 | 112 | gothist = ip.history_manager.search("*=*", unique=True) |
|
113 | 113 | nt.assert_equal(list(gothist), |
|
114 | 114 | [(1, 1, hist[0]), |
|
115 | 115 | (1, 2, hist[1]), |
|
116 | 116 | (1, 3, hist[2]), |
|
117 | 117 | newhist[2], |
|
118 | 118 | newhist[3]]) |
|
119 | 119 | |
|
120 | 120 | gothist = ip.history_manager.search("*=*", unique=True, n=3) |
|
121 | 121 | nt.assert_equal(list(gothist), |
|
122 | 122 | [(1, 3, hist[2]), |
|
123 | 123 | newhist[2], |
|
124 | 124 | newhist[3]]) |
|
125 | 125 | |
|
126 | 126 | gothist = ip.history_manager.search("b*", output=True) |
|
127 | 127 | nt.assert_equal(list(gothist), [(1,3,(hist[2],"spam"))] ) |
|
128 | 128 | |
|
129 | 129 | # Cross testing: check that magic %save can get previous session. |
|
130 | 130 | testfilename = (tmp_path / "test.py").resolve() |
|
131 | 131 | ip.magic("save " + str(testfilename) + " ~1/1-3") |
|
132 | 132 | with io.open(testfilename, encoding='utf-8') as testfile: |
|
133 | 133 | nt.assert_equal(testfile.read(), |
|
134 | 134 | u"# coding: utf-8\n" + u"\n".join(hist)+u"\n") |
|
135 | 135 | |
|
136 | 136 | # Duplicate line numbers - check that it doesn't crash, and |
|
137 | 137 | # gets a new session |
|
138 | 138 | ip.history_manager.store_inputs(1, "rogue") |
|
139 | 139 | ip.history_manager.writeout_cache() |
|
140 | 140 | nt.assert_equal(ip.history_manager.session_number, 3) |
|
141 | 141 | finally: |
|
142 | 142 | # Ensure saving thread is shut down before we try to clean up the files |
|
143 | 143 | ip.history_manager.save_thread.stop() |
|
144 | 144 | # Forcibly close database rather than relying on garbage collection |
|
145 | 145 | ip.history_manager.db.close() |
|
146 | 146 | # Restore history manager |
|
147 | 147 | ip.history_manager = hist_manager_ori |
|
148 | 148 | |
|
149 | 149 | |
|
150 | 150 | def test_extract_hist_ranges(): |
|
151 | 151 | instr = "1 2/3 ~4/5-6 ~4/7-~4/9 ~9/2-~7/5 ~10/" |
|
152 | 152 | expected = [(0, 1, 2), # 0 == current session |
|
153 | 153 | (2, 3, 4), |
|
154 | 154 | (-4, 5, 7), |
|
155 | 155 | (-4, 7, 10), |
|
156 | 156 | (-9, 2, None), # None == to end |
|
157 | 157 | (-8, 1, None), |
|
158 | 158 | (-7, 1, 6), |
|
159 | 159 | (-10, 1, None)] |
|
160 | 160 | actual = list(extract_hist_ranges(instr)) |
|
161 | 161 | nt.assert_equal(actual, expected) |
|
162 | 162 | |
|
163 | ||
|
164 | def test_extract_hist_ranges_empty_str(): | |
|
165 | instr = "" | |
|
166 | expected = [(0, 1, None)] # 0 == current session, None == to end | |
|
167 | actual = list(extract_hist_ranges(instr)) | |
|
168 | nt.assert_equal(actual, expected) | |
|
169 | ||
|
170 | ||
|
163 | 171 | def test_magic_rerun(): |
|
164 | 172 | """Simple test for %rerun (no args -> rerun last line)""" |
|
165 | 173 | ip = get_ipython() |
|
166 | 174 | ip.run_cell("a = 10", store_history=True) |
|
167 | 175 | ip.run_cell("a += 1", store_history=True) |
|
168 | 176 | nt.assert_equal(ip.user_ns["a"], 11) |
|
169 | 177 | ip.run_cell("%rerun", store_history=True) |
|
170 | 178 | nt.assert_equal(ip.user_ns["a"], 12) |
|
171 | 179 | |
|
172 | 180 | def test_timestamp_type(): |
|
173 | 181 | ip = get_ipython() |
|
174 | 182 | info = ip.history_manager.get_session_info() |
|
175 | 183 | nt.assert_true(isinstance(info[1], datetime)) |
|
176 | 184 | |
|
177 | 185 | def test_hist_file_config(): |
|
178 | 186 | cfg = Config() |
|
179 | 187 | tfile = tempfile.NamedTemporaryFile(delete=False) |
|
180 | 188 | cfg.HistoryManager.hist_file = Path(tfile.name) |
|
181 | 189 | try: |
|
182 | 190 | hm = HistoryManager(shell=get_ipython(), config=cfg) |
|
183 | 191 | nt.assert_equal(hm.hist_file, cfg.HistoryManager.hist_file) |
|
184 | 192 | finally: |
|
185 | 193 | try: |
|
186 | 194 | Path(tfile.name).unlink() |
|
187 | 195 | except OSError: |
|
188 | 196 | # same catch as in testing.tools.TempFileMixin |
|
189 | 197 | # On Windows, even though we close the file, we still can't |
|
190 | 198 | # delete it. I have no clue why |
|
191 | 199 | pass |
|
192 | 200 | |
|
193 | 201 | def test_histmanager_disabled(): |
|
194 | 202 | """Ensure that disabling the history manager doesn't create a database.""" |
|
195 | 203 | cfg = Config() |
|
196 | 204 | cfg.HistoryAccessor.enabled = False |
|
197 | 205 | |
|
198 | 206 | ip = get_ipython() |
|
199 | 207 | with TemporaryDirectory() as tmpdir: |
|
200 | 208 | hist_manager_ori = ip.history_manager |
|
201 | 209 | hist_file = Path(tmpdir) / "history.sqlite" |
|
202 | 210 | cfg.HistoryManager.hist_file = hist_file |
|
203 | 211 | try: |
|
204 | 212 | ip.history_manager = HistoryManager(shell=ip, config=cfg) |
|
205 | 213 | hist = [u'a=1', u'def f():\n test = 1\n return test', u"b='β¬ΓΒΎΓ·Γ'"] |
|
206 | 214 | for i, h in enumerate(hist, start=1): |
|
207 | 215 | ip.history_manager.store_inputs(i, h) |
|
208 | 216 | nt.assert_equal(ip.history_manager.input_hist_raw, [''] + hist) |
|
209 | 217 | ip.history_manager.reset() |
|
210 | 218 | ip.history_manager.end_session() |
|
211 | 219 | finally: |
|
212 | 220 | ip.history_manager = hist_manager_ori |
|
213 | 221 | |
|
214 | 222 | # hist_file should not be created |
|
215 | 223 | nt.assert_false(hist_file.exists()) |
@@ -1,1279 +1,1302 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Tests for various magic functions. |
|
3 | 3 | |
|
4 | 4 | Needs to be run by nose (to make ipython session available). |
|
5 | 5 | """ |
|
6 | 6 | |
|
7 | 7 | import io |
|
8 | 8 | import os |
|
9 | 9 | import re |
|
10 | 10 | import sys |
|
11 | 11 | import warnings |
|
12 | 12 | from textwrap import dedent |
|
13 | 13 | from unittest import TestCase |
|
14 | 14 | from unittest import mock |
|
15 | 15 | from importlib import invalidate_caches |
|
16 | 16 | from io import StringIO |
|
17 | 17 | from pathlib import Path |
|
18 | 18 | |
|
19 | 19 | import nose.tools as nt |
|
20 | 20 | |
|
21 | 21 | import shlex |
|
22 | 22 | |
|
23 | 23 | from IPython import get_ipython |
|
24 | 24 | from IPython.core import magic |
|
25 | 25 | from IPython.core.error import UsageError |
|
26 | 26 | from IPython.core.magic import (Magics, magics_class, line_magic, |
|
27 | 27 | cell_magic, |
|
28 | 28 | register_line_magic, register_cell_magic) |
|
29 | 29 | from IPython.core.magics import execution, script, code, logging, osm |
|
30 | 30 | from IPython.testing import decorators as dec |
|
31 | 31 | from IPython.testing import tools as tt |
|
32 | 32 | from IPython.utils.io import capture_output |
|
33 | 33 | from IPython.utils.tempdir import (TemporaryDirectory, |
|
34 | 34 | TemporaryWorkingDirectory) |
|
35 | 35 | from IPython.utils.process import find_cmd |
|
36 | 36 | from .test_debugger import PdbTestInput |
|
37 | 37 | |
|
38 | 38 | import pytest |
|
39 | 39 | |
|
40 | 40 | |
|
41 | 41 | @magic.magics_class |
|
42 | 42 | class DummyMagics(magic.Magics): pass |
|
43 | 43 | |
|
44 | 44 | def test_extract_code_ranges(): |
|
45 | 45 | instr = "1 3 5-6 7-9 10:15 17: :10 10- -13 :" |
|
46 | 46 | expected = [(0, 1), |
|
47 | 47 | (2, 3), |
|
48 | 48 | (4, 6), |
|
49 | 49 | (6, 9), |
|
50 | 50 | (9, 14), |
|
51 | 51 | (16, None), |
|
52 | 52 | (None, 9), |
|
53 | 53 | (9, None), |
|
54 | 54 | (None, 13), |
|
55 | 55 | (None, None)] |
|
56 | 56 | actual = list(code.extract_code_ranges(instr)) |
|
57 | 57 | nt.assert_equal(actual, expected) |
|
58 | 58 | |
|
59 | 59 | def test_extract_symbols(): |
|
60 | 60 | source = """import foo\na = 10\ndef b():\n return 42\n\n\nclass A: pass\n\n\n""" |
|
61 | 61 | symbols_args = ["a", "b", "A", "A,b", "A,a", "z"] |
|
62 | 62 | expected = [([], ['a']), |
|
63 | 63 | (["def b():\n return 42\n"], []), |
|
64 | 64 | (["class A: pass\n"], []), |
|
65 | 65 | (["class A: pass\n", "def b():\n return 42\n"], []), |
|
66 | 66 | (["class A: pass\n"], ['a']), |
|
67 | 67 | ([], ['z'])] |
|
68 | 68 | for symbols, exp in zip(symbols_args, expected): |
|
69 | 69 | nt.assert_equal(code.extract_symbols(source, symbols), exp) |
|
70 | 70 | |
|
71 | 71 | |
|
72 | 72 | def test_extract_symbols_raises_exception_with_non_python_code(): |
|
73 | 73 | source = ("=begin A Ruby program :)=end\n" |
|
74 | 74 | "def hello\n" |
|
75 | 75 | "puts 'Hello world'\n" |
|
76 | 76 | "end") |
|
77 | 77 | with nt.assert_raises(SyntaxError): |
|
78 | 78 | code.extract_symbols(source, "hello") |
|
79 | 79 | |
|
80 | 80 | |
|
81 | 81 | def test_magic_not_found(): |
|
82 | 82 | # magic not found raises UsageError |
|
83 | 83 | with nt.assert_raises(UsageError): |
|
84 | 84 | _ip.magic('doesntexist') |
|
85 | 85 | |
|
86 | 86 | # ensure result isn't success when a magic isn't found |
|
87 | 87 | result = _ip.run_cell('%doesntexist') |
|
88 | 88 | assert isinstance(result.error_in_exec, UsageError) |
|
89 | 89 | |
|
90 | 90 | |
|
91 | 91 | def test_cell_magic_not_found(): |
|
92 | 92 | # magic not found raises UsageError |
|
93 | 93 | with nt.assert_raises(UsageError): |
|
94 | 94 | _ip.run_cell_magic('doesntexist', 'line', 'cell') |
|
95 | 95 | |
|
96 | 96 | # ensure result isn't success when a magic isn't found |
|
97 | 97 | result = _ip.run_cell('%%doesntexist') |
|
98 | 98 | assert isinstance(result.error_in_exec, UsageError) |
|
99 | 99 | |
|
100 | 100 | |
|
101 | 101 | def test_magic_error_status(): |
|
102 | 102 | def fail(shell): |
|
103 | 103 | 1/0 |
|
104 | 104 | _ip.register_magic_function(fail) |
|
105 | 105 | result = _ip.run_cell('%fail') |
|
106 | 106 | assert isinstance(result.error_in_exec, ZeroDivisionError) |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | def test_config(): |
|
110 | 110 | """ test that config magic does not raise |
|
111 | 111 | can happen if Configurable init is moved too early into |
|
112 | 112 | Magics.__init__ as then a Config object will be registered as a |
|
113 | 113 | magic. |
|
114 | 114 | """ |
|
115 | 115 | ## should not raise. |
|
116 | 116 | _ip.magic('config') |
|
117 | 117 | |
|
118 | 118 | def test_config_available_configs(): |
|
119 | 119 | """ test that config magic prints available configs in unique and |
|
120 | 120 | sorted order. """ |
|
121 | 121 | with capture_output() as captured: |
|
122 | 122 | _ip.magic('config') |
|
123 | 123 | |
|
124 | 124 | stdout = captured.stdout |
|
125 | 125 | config_classes = stdout.strip().split('\n')[1:] |
|
126 | 126 | nt.assert_list_equal(config_classes, sorted(set(config_classes))) |
|
127 | 127 | |
|
128 | 128 | def test_config_print_class(): |
|
129 | 129 | """ test that config with a classname prints the class's options. """ |
|
130 | 130 | with capture_output() as captured: |
|
131 | 131 | _ip.magic('config TerminalInteractiveShell') |
|
132 | 132 | |
|
133 | 133 | stdout = captured.stdout |
|
134 | 134 | if not re.match("TerminalInteractiveShell.* options", stdout.splitlines()[0]): |
|
135 | 135 | print(stdout) |
|
136 | 136 | raise AssertionError("1st line of stdout not like " |
|
137 | 137 | "'TerminalInteractiveShell.* options'") |
|
138 | 138 | |
|
139 | 139 | def test_rehashx(): |
|
140 | 140 | # clear up everything |
|
141 | 141 | _ip.alias_manager.clear_aliases() |
|
142 | 142 | del _ip.db['syscmdlist'] |
|
143 | 143 | |
|
144 | 144 | _ip.magic('rehashx') |
|
145 | 145 | # Practically ALL ipython development systems will have more than 10 aliases |
|
146 | 146 | |
|
147 | 147 | nt.assert_true(len(_ip.alias_manager.aliases) > 10) |
|
148 | 148 | for name, cmd in _ip.alias_manager.aliases: |
|
149 | 149 | # we must strip dots from alias names |
|
150 | 150 | nt.assert_not_in('.', name) |
|
151 | 151 | |
|
152 | 152 | # rehashx must fill up syscmdlist |
|
153 | 153 | scoms = _ip.db['syscmdlist'] |
|
154 | 154 | nt.assert_true(len(scoms) > 10) |
|
155 | 155 | |
|
156 | 156 | |
|
157 | 157 | |
|
158 | 158 | def test_magic_parse_options(): |
|
159 | 159 | """Test that we don't mangle paths when parsing magic options.""" |
|
160 | 160 | ip = get_ipython() |
|
161 | 161 | path = 'c:\\x' |
|
162 | 162 | m = DummyMagics(ip) |
|
163 | 163 | opts = m.parse_options('-f %s' % path,'f:')[0] |
|
164 | 164 | # argv splitting is os-dependent |
|
165 | 165 | if os.name == 'posix': |
|
166 | 166 | expected = 'c:x' |
|
167 | 167 | else: |
|
168 | 168 | expected = path |
|
169 | 169 | nt.assert_equal(opts['f'], expected) |
|
170 | 170 | |
|
171 | 171 | def test_magic_parse_long_options(): |
|
172 | 172 | """Magic.parse_options can handle --foo=bar long options""" |
|
173 | 173 | ip = get_ipython() |
|
174 | 174 | m = DummyMagics(ip) |
|
175 | 175 | opts, _ = m.parse_options('--foo --bar=bubble', 'a', 'foo', 'bar=') |
|
176 | 176 | nt.assert_in('foo', opts) |
|
177 | 177 | nt.assert_in('bar', opts) |
|
178 | 178 | nt.assert_equal(opts['bar'], "bubble") |
|
179 | 179 | |
|
180 | 180 | |
|
181 | 181 | def doctest_hist_f(): |
|
182 | 182 | """Test %hist -f with temporary filename. |
|
183 | 183 | |
|
184 | 184 | In [9]: import tempfile |
|
185 | 185 | |
|
186 | 186 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
187 | 187 | |
|
188 | 188 | In [11]: %hist -nl -f $tfile 3 |
|
189 | 189 | |
|
190 | 190 | In [13]: import os; os.unlink(tfile) |
|
191 | 191 | """ |
|
192 | 192 | |
|
193 | 193 | |
|
194 | 194 | def doctest_hist_op(): |
|
195 | 195 | """Test %hist -op |
|
196 | 196 | |
|
197 | 197 | In [1]: class b(float): |
|
198 | 198 | ...: pass |
|
199 | 199 | ...: |
|
200 | 200 | |
|
201 | 201 | In [2]: class s(object): |
|
202 | 202 | ...: def __str__(self): |
|
203 | 203 | ...: return 's' |
|
204 | 204 | ...: |
|
205 | 205 | |
|
206 | 206 | In [3]: |
|
207 | 207 | |
|
208 | 208 | In [4]: class r(b): |
|
209 | 209 | ...: def __repr__(self): |
|
210 | 210 | ...: return 'r' |
|
211 | 211 | ...: |
|
212 | 212 | |
|
213 | 213 | In [5]: class sr(s,r): pass |
|
214 | 214 | ...: |
|
215 | 215 | |
|
216 | 216 | In [6]: |
|
217 | 217 | |
|
218 | 218 | In [7]: bb=b() |
|
219 | 219 | |
|
220 | 220 | In [8]: ss=s() |
|
221 | 221 | |
|
222 | 222 | In [9]: rr=r() |
|
223 | 223 | |
|
224 | 224 | In [10]: ssrr=sr() |
|
225 | 225 | |
|
226 | 226 | In [11]: 4.5 |
|
227 | 227 | Out[11]: 4.5 |
|
228 | 228 | |
|
229 | 229 | In [12]: str(ss) |
|
230 | 230 | Out[12]: 's' |
|
231 | 231 | |
|
232 | 232 | In [13]: |
|
233 | 233 | |
|
234 | 234 | In [14]: %hist -op |
|
235 | 235 | >>> class b: |
|
236 | 236 | ... pass |
|
237 | 237 | ... |
|
238 | 238 | >>> class s(b): |
|
239 | 239 | ... def __str__(self): |
|
240 | 240 | ... return 's' |
|
241 | 241 | ... |
|
242 | 242 | >>> |
|
243 | 243 | >>> class r(b): |
|
244 | 244 | ... def __repr__(self): |
|
245 | 245 | ... return 'r' |
|
246 | 246 | ... |
|
247 | 247 | >>> class sr(s,r): pass |
|
248 | 248 | >>> |
|
249 | 249 | >>> bb=b() |
|
250 | 250 | >>> ss=s() |
|
251 | 251 | >>> rr=r() |
|
252 | 252 | >>> ssrr=sr() |
|
253 | 253 | >>> 4.5 |
|
254 | 254 | 4.5 |
|
255 | 255 | >>> str(ss) |
|
256 | 256 | 's' |
|
257 | 257 | >>> |
|
258 | 258 | """ |
|
259 | 259 | |
|
260 | 260 | def test_hist_pof(): |
|
261 | 261 | ip = get_ipython() |
|
262 | 262 | ip.run_cell(u"1+2", store_history=True) |
|
263 | 263 | #raise Exception(ip.history_manager.session_number) |
|
264 | 264 | #raise Exception(list(ip.history_manager._get_range_session())) |
|
265 | 265 | with TemporaryDirectory() as td: |
|
266 | 266 | tf = os.path.join(td, 'hist.py') |
|
267 | 267 | ip.run_line_magic('history', '-pof %s' % tf) |
|
268 | 268 | assert os.path.isfile(tf) |
|
269 | 269 | |
|
270 | 270 | |
|
271 | 271 | def test_macro(): |
|
272 | 272 | ip = get_ipython() |
|
273 | 273 | ip.history_manager.reset() # Clear any existing history. |
|
274 | 274 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] |
|
275 | 275 | for i, cmd in enumerate(cmds, start=1): |
|
276 | 276 | ip.history_manager.store_inputs(i, cmd) |
|
277 | 277 | ip.magic("macro test 1-3") |
|
278 | 278 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") |
|
279 | 279 | |
|
280 | 280 | # List macros |
|
281 | 281 | nt.assert_in("test", ip.magic("macro")) |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | def test_macro_run(): |
|
285 | 285 | """Test that we can run a multi-line macro successfully.""" |
|
286 | 286 | ip = get_ipython() |
|
287 | 287 | ip.history_manager.reset() |
|
288 | 288 | cmds = ["a=10", "a+=1", "print(a)", "%macro test 2-3"] |
|
289 | 289 | for cmd in cmds: |
|
290 | 290 | ip.run_cell(cmd, store_history=True) |
|
291 | 291 | nt.assert_equal(ip.user_ns["test"].value, "a+=1\nprint(a)\n") |
|
292 | 292 | with tt.AssertPrints("12"): |
|
293 | 293 | ip.run_cell("test") |
|
294 | 294 | with tt.AssertPrints("13"): |
|
295 | 295 | ip.run_cell("test") |
|
296 | 296 | |
|
297 | 297 | |
|
298 | 298 | def test_magic_magic(): |
|
299 | 299 | """Test %magic""" |
|
300 | 300 | ip = get_ipython() |
|
301 | 301 | with capture_output() as captured: |
|
302 | 302 | ip.magic("magic") |
|
303 | 303 | |
|
304 | 304 | stdout = captured.stdout |
|
305 | 305 | nt.assert_in('%magic', stdout) |
|
306 | 306 | nt.assert_in('IPython', stdout) |
|
307 | 307 | nt.assert_in('Available', stdout) |
|
308 | 308 | |
|
309 | 309 | |
|
310 | 310 | @dec.skipif_not_numpy |
|
311 | 311 | def test_numpy_reset_array_undec(): |
|
312 | 312 | "Test '%reset array' functionality" |
|
313 | 313 | _ip.ex('import numpy as np') |
|
314 | 314 | _ip.ex('a = np.empty(2)') |
|
315 | 315 | nt.assert_in('a', _ip.user_ns) |
|
316 | 316 | _ip.magic('reset -f array') |
|
317 | 317 | nt.assert_not_in('a', _ip.user_ns) |
|
318 | 318 | |
|
319 | 319 | def test_reset_out(): |
|
320 | 320 | "Test '%reset out' magic" |
|
321 | 321 | _ip.run_cell("parrot = 'dead'", store_history=True) |
|
322 | 322 | # test '%reset -f out', make an Out prompt |
|
323 | 323 | _ip.run_cell("parrot", store_history=True) |
|
324 | 324 | nt.assert_true('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
325 | 325 | _ip.magic('reset -f out') |
|
326 | 326 | nt.assert_false('dead' in [_ip.user_ns[x] for x in ('_','__','___')]) |
|
327 | 327 | nt.assert_equal(len(_ip.user_ns['Out']), 0) |
|
328 | 328 | |
|
329 | 329 | def test_reset_in(): |
|
330 | 330 | "Test '%reset in' magic" |
|
331 | 331 | # test '%reset -f in' |
|
332 | 332 | _ip.run_cell("parrot", store_history=True) |
|
333 | 333 | nt.assert_true('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
334 | 334 | _ip.magic('%reset -f in') |
|
335 | 335 | nt.assert_false('parrot' in [_ip.user_ns[x] for x in ('_i','_ii','_iii')]) |
|
336 | 336 | nt.assert_equal(len(set(_ip.user_ns['In'])), 1) |
|
337 | 337 | |
|
338 | 338 | def test_reset_dhist(): |
|
339 | 339 | "Test '%reset dhist' magic" |
|
340 | 340 | _ip.run_cell("tmp = [d for d in _dh]") # copy before clearing |
|
341 | 341 | _ip.magic('cd ' + os.path.dirname(nt.__file__)) |
|
342 | 342 | _ip.magic('cd -') |
|
343 | 343 | nt.assert_true(len(_ip.user_ns['_dh']) > 0) |
|
344 | 344 | _ip.magic('reset -f dhist') |
|
345 | 345 | nt.assert_equal(len(_ip.user_ns['_dh']), 0) |
|
346 | 346 | _ip.run_cell("_dh = [d for d in tmp]") #restore |
|
347 | 347 | |
|
348 | 348 | def test_reset_in_length(): |
|
349 | 349 | "Test that '%reset in' preserves In[] length" |
|
350 | 350 | _ip.run_cell("print 'foo'") |
|
351 | 351 | _ip.run_cell("reset -f in") |
|
352 | 352 | nt.assert_equal(len(_ip.user_ns['In']), _ip.displayhook.prompt_count+1) |
|
353 | 353 | |
|
354 | 354 | class TestResetErrors(TestCase): |
|
355 | 355 | |
|
356 | 356 | def test_reset_redefine(self): |
|
357 | 357 | |
|
358 | 358 | @magics_class |
|
359 | 359 | class KernelMagics(Magics): |
|
360 | 360 | @line_magic |
|
361 | 361 | def less(self, shell): pass |
|
362 | 362 | |
|
363 | 363 | _ip.register_magics(KernelMagics) |
|
364 | 364 | |
|
365 | 365 | with self.assertLogs() as cm: |
|
366 | 366 | # hack, we want to just capture logs, but assertLogs fails if not |
|
367 | 367 | # logs get produce. |
|
368 | 368 | # so log one things we ignore. |
|
369 | 369 | import logging as log_mod |
|
370 | 370 | log = log_mod.getLogger() |
|
371 | 371 | log.info('Nothing') |
|
372 | 372 | # end hack. |
|
373 | 373 | _ip.run_cell("reset -f") |
|
374 | 374 | |
|
375 | 375 | assert len(cm.output) == 1 |
|
376 | 376 | for out in cm.output: |
|
377 | 377 | assert "Invalid alias" not in out |
|
378 | 378 | |
|
379 | 379 | def test_tb_syntaxerror(): |
|
380 | 380 | """test %tb after a SyntaxError""" |
|
381 | 381 | ip = get_ipython() |
|
382 | 382 | ip.run_cell("for") |
|
383 | 383 | |
|
384 | 384 | # trap and validate stdout |
|
385 | 385 | save_stdout = sys.stdout |
|
386 | 386 | try: |
|
387 | 387 | sys.stdout = StringIO() |
|
388 | 388 | ip.run_cell("%tb") |
|
389 | 389 | out = sys.stdout.getvalue() |
|
390 | 390 | finally: |
|
391 | 391 | sys.stdout = save_stdout |
|
392 | 392 | # trim output, and only check the last line |
|
393 | 393 | last_line = out.rstrip().splitlines()[-1].strip() |
|
394 | 394 | nt.assert_equal(last_line, "SyntaxError: invalid syntax") |
|
395 | 395 | |
|
396 | 396 | |
|
397 | 397 | def test_time(): |
|
398 | 398 | ip = get_ipython() |
|
399 | 399 | |
|
400 | 400 | with tt.AssertPrints("Wall time: "): |
|
401 | 401 | ip.run_cell("%time None") |
|
402 | 402 | |
|
403 | 403 | ip.run_cell("def f(kmjy):\n" |
|
404 | 404 | " %time print (2*kmjy)") |
|
405 | 405 | |
|
406 | 406 | with tt.AssertPrints("Wall time: "): |
|
407 | 407 | with tt.AssertPrints("hihi", suppress=False): |
|
408 | 408 | ip.run_cell("f('hi')") |
|
409 | 409 | |
|
410 | 410 | def test_time_last_not_expression(): |
|
411 | 411 | ip.run_cell("%%time\n" |
|
412 | 412 | "var_1 = 1\n" |
|
413 | 413 | "var_2 = 2\n") |
|
414 | 414 | assert ip.user_ns['var_1'] == 1 |
|
415 | 415 | del ip.user_ns['var_1'] |
|
416 | 416 | assert ip.user_ns['var_2'] == 2 |
|
417 | 417 | del ip.user_ns['var_2'] |
|
418 | 418 | |
|
419 | 419 | |
|
420 | 420 | @dec.skip_win32 |
|
421 | 421 | def test_time2(): |
|
422 | 422 | ip = get_ipython() |
|
423 | 423 | |
|
424 | 424 | with tt.AssertPrints("CPU times: user "): |
|
425 | 425 | ip.run_cell("%time None") |
|
426 | 426 | |
|
427 | 427 | def test_time3(): |
|
428 | 428 | """Erroneous magic function calls, issue gh-3334""" |
|
429 | 429 | ip = get_ipython() |
|
430 | 430 | ip.user_ns.pop('run', None) |
|
431 | 431 | |
|
432 | 432 | with tt.AssertNotPrints("not found", channel='stderr'): |
|
433 | 433 | ip.run_cell("%%time\n" |
|
434 | 434 | "run = 0\n" |
|
435 | 435 | "run += 1") |
|
436 | 436 | |
|
437 | 437 | def test_multiline_time(): |
|
438 | 438 | """Make sure last statement from time return a value.""" |
|
439 | 439 | ip = get_ipython() |
|
440 | 440 | ip.user_ns.pop('run', None) |
|
441 | 441 | |
|
442 | 442 | ip.run_cell(dedent("""\ |
|
443 | 443 | %%time |
|
444 | 444 | a = "ho" |
|
445 | 445 | b = "hey" |
|
446 | 446 | a+b |
|
447 | 447 | """)) |
|
448 | 448 | nt.assert_equal(ip.user_ns_hidden['_'], 'hohey') |
|
449 | 449 | |
|
450 | 450 | def test_time_local_ns(): |
|
451 | 451 | """ |
|
452 | 452 | Test that local_ns is actually global_ns when running a cell magic |
|
453 | 453 | """ |
|
454 | 454 | ip = get_ipython() |
|
455 | 455 | ip.run_cell("%%time\n" |
|
456 | 456 | "myvar = 1") |
|
457 | 457 | nt.assert_equal(ip.user_ns['myvar'], 1) |
|
458 | 458 | del ip.user_ns['myvar'] |
|
459 | 459 | |
|
460 | 460 | def test_doctest_mode(): |
|
461 | 461 | "Toggle doctest_mode twice, it should be a no-op and run without error" |
|
462 | 462 | _ip.magic('doctest_mode') |
|
463 | 463 | _ip.magic('doctest_mode') |
|
464 | 464 | |
|
465 | 465 | |
|
466 | 466 | def test_parse_options(): |
|
467 | 467 | """Tests for basic options parsing in magics.""" |
|
468 | 468 | # These are only the most minimal of tests, more should be added later. At |
|
469 | 469 | # the very least we check that basic text/unicode calls work OK. |
|
470 | 470 | m = DummyMagics(_ip) |
|
471 | 471 | nt.assert_equal(m.parse_options('foo', '')[1], 'foo') |
|
472 | 472 | nt.assert_equal(m.parse_options(u'foo', '')[1], u'foo') |
|
473 | 473 | |
|
474 | 474 | |
|
475 | 475 | def test_parse_options_preserve_non_option_string(): |
|
476 | 476 | """Test to assert preservation of non-option part of magic-block, while parsing magic options.""" |
|
477 | 477 | m = DummyMagics(_ip) |
|
478 | 478 | opts, stmt = m.parse_options( |
|
479 | 479 | " -n1 -r 13 _ = 314 + foo", "n:r:", preserve_non_opts=True |
|
480 | 480 | ) |
|
481 | 481 | nt.assert_equal(opts, {"n": "1", "r": "13"}) |
|
482 | 482 | nt.assert_equal(stmt, "_ = 314 + foo") |
|
483 | 483 | |
|
484 | 484 | |
|
485 | 485 | def test_run_magic_preserve_code_block(): |
|
486 | 486 | """Test to assert preservation of non-option part of magic-block, while running magic.""" |
|
487 | 487 | _ip.user_ns["spaces"] = [] |
|
488 | 488 | _ip.magic("timeit -n1 -r1 spaces.append([s.count(' ') for s in ['document']])") |
|
489 | 489 | assert _ip.user_ns["spaces"] == [[0]] |
|
490 | 490 | |
|
491 | 491 | |
|
492 | 492 | def test_dirops(): |
|
493 | 493 | """Test various directory handling operations.""" |
|
494 | 494 | # curpath = lambda :os.path.splitdrive(os.getcwd())[1].replace('\\','/') |
|
495 | 495 | curpath = os.getcwd |
|
496 | 496 | startdir = os.getcwd() |
|
497 | 497 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
498 | 498 | try: |
|
499 | 499 | _ip.magic('cd "%s"' % ipdir) |
|
500 | 500 | nt.assert_equal(curpath(), ipdir) |
|
501 | 501 | _ip.magic('cd -') |
|
502 | 502 | nt.assert_equal(curpath(), startdir) |
|
503 | 503 | _ip.magic('pushd "%s"' % ipdir) |
|
504 | 504 | nt.assert_equal(curpath(), ipdir) |
|
505 | 505 | _ip.magic('popd') |
|
506 | 506 | nt.assert_equal(curpath(), startdir) |
|
507 | 507 | finally: |
|
508 | 508 | os.chdir(startdir) |
|
509 | 509 | |
|
510 | 510 | |
|
511 | 511 | def test_cd_force_quiet(): |
|
512 | 512 | """Test OSMagics.cd_force_quiet option""" |
|
513 | 513 | _ip.config.OSMagics.cd_force_quiet = True |
|
514 | 514 | osmagics = osm.OSMagics(shell=_ip) |
|
515 | 515 | |
|
516 | 516 | startdir = os.getcwd() |
|
517 | 517 | ipdir = os.path.realpath(_ip.ipython_dir) |
|
518 | 518 | |
|
519 | 519 | try: |
|
520 | 520 | with tt.AssertNotPrints(ipdir): |
|
521 | 521 | osmagics.cd('"%s"' % ipdir) |
|
522 | 522 | with tt.AssertNotPrints(startdir): |
|
523 | 523 | osmagics.cd('-') |
|
524 | 524 | finally: |
|
525 | 525 | os.chdir(startdir) |
|
526 | 526 | |
|
527 | 527 | |
|
528 | 528 | def test_xmode(): |
|
529 | 529 | # Calling xmode three times should be a no-op |
|
530 | 530 | xmode = _ip.InteractiveTB.mode |
|
531 | 531 | for i in range(4): |
|
532 | 532 | _ip.magic("xmode") |
|
533 | 533 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) |
|
534 | 534 | |
|
535 | 535 | def test_reset_hard(): |
|
536 | 536 | monitor = [] |
|
537 | 537 | class A(object): |
|
538 | 538 | def __del__(self): |
|
539 | 539 | monitor.append(1) |
|
540 | 540 | def __repr__(self): |
|
541 | 541 | return "<A instance>" |
|
542 | 542 | |
|
543 | 543 | _ip.user_ns["a"] = A() |
|
544 | 544 | _ip.run_cell("a") |
|
545 | 545 | |
|
546 | 546 | nt.assert_equal(monitor, []) |
|
547 | 547 | _ip.magic("reset -f") |
|
548 | 548 | nt.assert_equal(monitor, [1]) |
|
549 | 549 | |
|
550 | 550 | class TestXdel(tt.TempFileMixin): |
|
551 | 551 | def test_xdel(self): |
|
552 | 552 | """Test that references from %run are cleared by xdel.""" |
|
553 | 553 | src = ("class A(object):\n" |
|
554 | 554 | " monitor = []\n" |
|
555 | 555 | " def __del__(self):\n" |
|
556 | 556 | " self.monitor.append(1)\n" |
|
557 | 557 | "a = A()\n") |
|
558 | 558 | self.mktmp(src) |
|
559 | 559 | # %run creates some hidden references... |
|
560 | 560 | _ip.magic("run %s" % self.fname) |
|
561 | 561 | # ... as does the displayhook. |
|
562 | 562 | _ip.run_cell("a") |
|
563 | 563 | |
|
564 | 564 | monitor = _ip.user_ns["A"].monitor |
|
565 | 565 | nt.assert_equal(monitor, []) |
|
566 | 566 | |
|
567 | 567 | _ip.magic("xdel a") |
|
568 | 568 | |
|
569 | 569 | # Check that a's __del__ method has been called. |
|
570 | 570 | nt.assert_equal(monitor, [1]) |
|
571 | 571 | |
|
572 | 572 | def doctest_who(): |
|
573 | 573 | """doctest for %who |
|
574 | 574 | |
|
575 | 575 | In [1]: %reset -f |
|
576 | 576 | |
|
577 | 577 | In [2]: alpha = 123 |
|
578 | 578 | |
|
579 | 579 | In [3]: beta = 'beta' |
|
580 | 580 | |
|
581 | 581 | In [4]: %who int |
|
582 | 582 | alpha |
|
583 | 583 | |
|
584 | 584 | In [5]: %who str |
|
585 | 585 | beta |
|
586 | 586 | |
|
587 | 587 | In [6]: %whos |
|
588 | 588 | Variable Type Data/Info |
|
589 | 589 | ---------------------------- |
|
590 | 590 | alpha int 123 |
|
591 | 591 | beta str beta |
|
592 | 592 | |
|
593 | 593 | In [7]: %who_ls |
|
594 | 594 | Out[7]: ['alpha', 'beta'] |
|
595 | 595 | """ |
|
596 | 596 | |
|
597 | 597 | def test_whos(): |
|
598 | 598 | """Check that whos is protected against objects where repr() fails.""" |
|
599 | 599 | class A(object): |
|
600 | 600 | def __repr__(self): |
|
601 | 601 | raise Exception() |
|
602 | 602 | _ip.user_ns['a'] = A() |
|
603 | 603 | _ip.magic("whos") |
|
604 | 604 | |
|
605 | 605 | def doctest_precision(): |
|
606 | 606 | """doctest for %precision |
|
607 | 607 | |
|
608 | 608 | In [1]: f = get_ipython().display_formatter.formatters['text/plain'] |
|
609 | 609 | |
|
610 | 610 | In [2]: %precision 5 |
|
611 | 611 | Out[2]: '%.5f' |
|
612 | 612 | |
|
613 | 613 | In [3]: f.float_format |
|
614 | 614 | Out[3]: '%.5f' |
|
615 | 615 | |
|
616 | 616 | In [4]: %precision %e |
|
617 | 617 | Out[4]: '%e' |
|
618 | 618 | |
|
619 | 619 | In [5]: f(3.1415927) |
|
620 | 620 | Out[5]: '3.141593e+00' |
|
621 | 621 | """ |
|
622 | 622 | |
|
623 | 623 | def test_debug_magic(): |
|
624 | 624 | """Test debugging a small code with %debug |
|
625 | 625 | |
|
626 | 626 | In [1]: with PdbTestInput(['c']): |
|
627 | 627 | ...: %debug print("a b") #doctest: +ELLIPSIS |
|
628 | 628 | ...: |
|
629 | 629 | ... |
|
630 | 630 | ipdb> c |
|
631 | 631 | a b |
|
632 | 632 | In [2]: |
|
633 | 633 | """ |
|
634 | 634 | |
|
635 | 635 | def test_psearch(): |
|
636 | 636 | with tt.AssertPrints("dict.fromkeys"): |
|
637 | 637 | _ip.run_cell("dict.fr*?") |
|
638 | 638 | with tt.AssertPrints("Ο.is_integer"): |
|
639 | 639 | _ip.run_cell("Ο = 3.14;\nΟ.is_integ*?") |
|
640 | 640 | |
|
641 | 641 | def test_timeit_shlex(): |
|
642 | 642 | """test shlex issues with timeit (#1109)""" |
|
643 | 643 | _ip.ex("def f(*a,**kw): pass") |
|
644 | 644 | _ip.magic('timeit -n1 "this is a bug".count(" ")') |
|
645 | 645 | _ip.magic('timeit -r1 -n1 f(" ", 1)') |
|
646 | 646 | _ip.magic('timeit -r1 -n1 f(" ", 1, " ", 2, " ")') |
|
647 | 647 | _ip.magic('timeit -r1 -n1 ("a " + "b")') |
|
648 | 648 | _ip.magic('timeit -r1 -n1 f("a " + "b")') |
|
649 | 649 | _ip.magic('timeit -r1 -n1 f("a " + "b ")') |
|
650 | 650 | |
|
651 | 651 | |
|
652 | 652 | def test_timeit_special_syntax(): |
|
653 | 653 | "Test %%timeit with IPython special syntax" |
|
654 | 654 | @register_line_magic |
|
655 | 655 | def lmagic(line): |
|
656 | 656 | ip = get_ipython() |
|
657 | 657 | ip.user_ns['lmagic_out'] = line |
|
658 | 658 | |
|
659 | 659 | # line mode test |
|
660 | 660 | _ip.run_line_magic('timeit', '-n1 -r1 %lmagic my line') |
|
661 | 661 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
662 | 662 | # cell mode test |
|
663 | 663 | _ip.run_cell_magic('timeit', '-n1 -r1', '%lmagic my line2') |
|
664 | 664 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
665 | 665 | |
|
666 | 666 | def test_timeit_return(): |
|
667 | 667 | """ |
|
668 | 668 | test whether timeit -o return object |
|
669 | 669 | """ |
|
670 | 670 | |
|
671 | 671 | res = _ip.run_line_magic('timeit','-n10 -r10 -o 1') |
|
672 | 672 | assert(res is not None) |
|
673 | 673 | |
|
674 | 674 | def test_timeit_quiet(): |
|
675 | 675 | """ |
|
676 | 676 | test quiet option of timeit magic |
|
677 | 677 | """ |
|
678 | 678 | with tt.AssertNotPrints("loops"): |
|
679 | 679 | _ip.run_cell("%timeit -n1 -r1 -q 1") |
|
680 | 680 | |
|
681 | 681 | def test_timeit_return_quiet(): |
|
682 | 682 | with tt.AssertNotPrints("loops"): |
|
683 | 683 | res = _ip.run_line_magic('timeit', '-n1 -r1 -q -o 1') |
|
684 | 684 | assert (res is not None) |
|
685 | 685 | |
|
686 | 686 | def test_timeit_invalid_return(): |
|
687 | 687 | with nt.assert_raises_regex(SyntaxError, "outside function"): |
|
688 | 688 | _ip.run_line_magic('timeit', 'return') |
|
689 | 689 | |
|
690 | 690 | @dec.skipif(execution.profile is None) |
|
691 | 691 | def test_prun_special_syntax(): |
|
692 | 692 | "Test %%prun with IPython special syntax" |
|
693 | 693 | @register_line_magic |
|
694 | 694 | def lmagic(line): |
|
695 | 695 | ip = get_ipython() |
|
696 | 696 | ip.user_ns['lmagic_out'] = line |
|
697 | 697 | |
|
698 | 698 | # line mode test |
|
699 | 699 | _ip.run_line_magic('prun', '-q %lmagic my line') |
|
700 | 700 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line') |
|
701 | 701 | # cell mode test |
|
702 | 702 | _ip.run_cell_magic('prun', '-q', '%lmagic my line2') |
|
703 | 703 | nt.assert_equal(_ip.user_ns['lmagic_out'], 'my line2') |
|
704 | 704 | |
|
705 | 705 | @dec.skipif(execution.profile is None) |
|
706 | 706 | def test_prun_quotes(): |
|
707 | 707 | "Test that prun does not clobber string escapes (GH #1302)" |
|
708 | 708 | _ip.magic(r"prun -q x = '\t'") |
|
709 | 709 | nt.assert_equal(_ip.user_ns['x'], '\t') |
|
710 | 710 | |
|
711 | 711 | def test_extension(): |
|
712 | 712 | # Debugging information for failures of this test |
|
713 | 713 | print('sys.path:') |
|
714 | 714 | for p in sys.path: |
|
715 | 715 | print(' ', p) |
|
716 | 716 | print('CWD', os.getcwd()) |
|
717 | 717 | |
|
718 | 718 | nt.assert_raises(ImportError, _ip.magic, "load_ext daft_extension") |
|
719 | 719 | daft_path = os.path.join(os.path.dirname(__file__), "daft_extension") |
|
720 | 720 | sys.path.insert(0, daft_path) |
|
721 | 721 | try: |
|
722 | 722 | _ip.user_ns.pop('arq', None) |
|
723 | 723 | invalidate_caches() # Clear import caches |
|
724 | 724 | _ip.magic("load_ext daft_extension") |
|
725 | 725 | nt.assert_equal(_ip.user_ns['arq'], 185) |
|
726 | 726 | _ip.magic("unload_ext daft_extension") |
|
727 | 727 | assert 'arq' not in _ip.user_ns |
|
728 | 728 | finally: |
|
729 | 729 | sys.path.remove(daft_path) |
|
730 | 730 | |
|
731 | 731 | |
|
732 | 732 | def test_notebook_export_json(): |
|
733 | 733 | _ip = get_ipython() |
|
734 | 734 | _ip.history_manager.reset() # Clear any existing history. |
|
735 | 735 | cmds = [u"a=1", u"def b():\n return a**2", u"print('noΓ«l, Γ©tΓ©', b())"] |
|
736 | 736 | for i, cmd in enumerate(cmds, start=1): |
|
737 | 737 | _ip.history_manager.store_inputs(i, cmd) |
|
738 | 738 | with TemporaryDirectory() as td: |
|
739 | 739 | outfile = os.path.join(td, "nb.ipynb") |
|
740 | 740 | _ip.magic("notebook -e %s" % outfile) |
|
741 | 741 | |
|
742 | 742 | |
|
743 | 743 | class TestEnv(TestCase): |
|
744 | 744 | |
|
745 | 745 | def test_env(self): |
|
746 | 746 | env = _ip.magic("env") |
|
747 | 747 | self.assertTrue(isinstance(env, dict)) |
|
748 | 748 | |
|
749 | 749 | def test_env_secret(self): |
|
750 | 750 | env = _ip.magic("env") |
|
751 | 751 | hidden = "<hidden>" |
|
752 | 752 | with mock.patch.dict( |
|
753 | 753 | os.environ, |
|
754 | 754 | { |
|
755 | 755 | "API_KEY": "abc123", |
|
756 | 756 | "SECRET_THING": "ssshhh", |
|
757 | 757 | "JUPYTER_TOKEN": "", |
|
758 | 758 | "VAR": "abc" |
|
759 | 759 | } |
|
760 | 760 | ): |
|
761 | 761 | env = _ip.magic("env") |
|
762 | 762 | assert env["API_KEY"] == hidden |
|
763 | 763 | assert env["SECRET_THING"] == hidden |
|
764 | 764 | assert env["JUPYTER_TOKEN"] == hidden |
|
765 | 765 | assert env["VAR"] == "abc" |
|
766 | 766 | |
|
767 | 767 | def test_env_get_set_simple(self): |
|
768 | 768 | env = _ip.magic("env var val1") |
|
769 | 769 | self.assertEqual(env, None) |
|
770 | 770 | self.assertEqual(os.environ['var'], 'val1') |
|
771 | 771 | self.assertEqual(_ip.magic("env var"), 'val1') |
|
772 | 772 | env = _ip.magic("env var=val2") |
|
773 | 773 | self.assertEqual(env, None) |
|
774 | 774 | self.assertEqual(os.environ['var'], 'val2') |
|
775 | 775 | |
|
776 | 776 | def test_env_get_set_complex(self): |
|
777 | 777 | env = _ip.magic("env var 'val1 '' 'val2") |
|
778 | 778 | self.assertEqual(env, None) |
|
779 | 779 | self.assertEqual(os.environ['var'], "'val1 '' 'val2") |
|
780 | 780 | self.assertEqual(_ip.magic("env var"), "'val1 '' 'val2") |
|
781 | 781 | env = _ip.magic('env var=val2 val3="val4') |
|
782 | 782 | self.assertEqual(env, None) |
|
783 | 783 | self.assertEqual(os.environ['var'], 'val2 val3="val4') |
|
784 | 784 | |
|
785 | 785 | def test_env_set_bad_input(self): |
|
786 | 786 | self.assertRaises(UsageError, lambda: _ip.magic("set_env var")) |
|
787 | 787 | |
|
788 | 788 | def test_env_set_whitespace(self): |
|
789 | 789 | self.assertRaises(UsageError, lambda: _ip.magic("env var A=B")) |
|
790 | 790 | |
|
791 | 791 | |
|
792 | 792 | class CellMagicTestCase(TestCase): |
|
793 | 793 | |
|
794 | 794 | def check_ident(self, magic): |
|
795 | 795 | # Manually called, we get the result |
|
796 | 796 | out = _ip.run_cell_magic(magic, 'a', 'b') |
|
797 | 797 | nt.assert_equal(out, ('a','b')) |
|
798 | 798 | # Via run_cell, it goes into the user's namespace via displayhook |
|
799 | 799 | _ip.run_cell('%%' + magic +' c\nd\n') |
|
800 | 800 | nt.assert_equal(_ip.user_ns['_'], ('c','d\n')) |
|
801 | 801 | |
|
802 | 802 | def test_cell_magic_func_deco(self): |
|
803 | 803 | "Cell magic using simple decorator" |
|
804 | 804 | @register_cell_magic |
|
805 | 805 | def cellm(line, cell): |
|
806 | 806 | return line, cell |
|
807 | 807 | |
|
808 | 808 | self.check_ident('cellm') |
|
809 | 809 | |
|
810 | 810 | def test_cell_magic_reg(self): |
|
811 | 811 | "Cell magic manually registered" |
|
812 | 812 | def cellm(line, cell): |
|
813 | 813 | return line, cell |
|
814 | 814 | |
|
815 | 815 | _ip.register_magic_function(cellm, 'cell', 'cellm2') |
|
816 | 816 | self.check_ident('cellm2') |
|
817 | 817 | |
|
818 | 818 | def test_cell_magic_class(self): |
|
819 | 819 | "Cell magics declared via a class" |
|
820 | 820 | @magics_class |
|
821 | 821 | class MyMagics(Magics): |
|
822 | 822 | |
|
823 | 823 | @cell_magic |
|
824 | 824 | def cellm3(self, line, cell): |
|
825 | 825 | return line, cell |
|
826 | 826 | |
|
827 | 827 | _ip.register_magics(MyMagics) |
|
828 | 828 | self.check_ident('cellm3') |
|
829 | 829 | |
|
830 | 830 | def test_cell_magic_class2(self): |
|
831 | 831 | "Cell magics declared via a class, #2" |
|
832 | 832 | @magics_class |
|
833 | 833 | class MyMagics2(Magics): |
|
834 | 834 | |
|
835 | 835 | @cell_magic('cellm4') |
|
836 | 836 | def cellm33(self, line, cell): |
|
837 | 837 | return line, cell |
|
838 | 838 | |
|
839 | 839 | _ip.register_magics(MyMagics2) |
|
840 | 840 | self.check_ident('cellm4') |
|
841 | 841 | # Check that nothing is registered as 'cellm33' |
|
842 | 842 | c33 = _ip.find_cell_magic('cellm33') |
|
843 | 843 | nt.assert_equal(c33, None) |
|
844 | 844 | |
|
845 | 845 | def test_file(): |
|
846 | 846 | """Basic %%writefile""" |
|
847 | 847 | ip = get_ipython() |
|
848 | 848 | with TemporaryDirectory() as td: |
|
849 | 849 | fname = os.path.join(td, 'file1') |
|
850 | 850 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
851 | 851 | 'line1', |
|
852 | 852 | 'line2', |
|
853 | 853 | ])) |
|
854 | 854 | s = Path(fname).read_text() |
|
855 | 855 | nt.assert_in('line1\n', s) |
|
856 | 856 | nt.assert_in('line2', s) |
|
857 | 857 | |
|
858 | 858 | @dec.skip_win32 |
|
859 | 859 | def test_file_single_quote(): |
|
860 | 860 | """Basic %%writefile with embedded single quotes""" |
|
861 | 861 | ip = get_ipython() |
|
862 | 862 | with TemporaryDirectory() as td: |
|
863 | 863 | fname = os.path.join(td, '\'file1\'') |
|
864 | 864 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
865 | 865 | 'line1', |
|
866 | 866 | 'line2', |
|
867 | 867 | ])) |
|
868 | 868 | s = Path(fname).read_text() |
|
869 | 869 | nt.assert_in('line1\n', s) |
|
870 | 870 | nt.assert_in('line2', s) |
|
871 | 871 | |
|
872 | 872 | @dec.skip_win32 |
|
873 | 873 | def test_file_double_quote(): |
|
874 | 874 | """Basic %%writefile with embedded double quotes""" |
|
875 | 875 | ip = get_ipython() |
|
876 | 876 | with TemporaryDirectory() as td: |
|
877 | 877 | fname = os.path.join(td, '"file1"') |
|
878 | 878 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
879 | 879 | 'line1', |
|
880 | 880 | 'line2', |
|
881 | 881 | ])) |
|
882 | 882 | s = Path(fname).read_text() |
|
883 | 883 | nt.assert_in('line1\n', s) |
|
884 | 884 | nt.assert_in('line2', s) |
|
885 | 885 | |
|
886 | 886 | def test_file_var_expand(): |
|
887 | 887 | """%%writefile $filename""" |
|
888 | 888 | ip = get_ipython() |
|
889 | 889 | with TemporaryDirectory() as td: |
|
890 | 890 | fname = os.path.join(td, 'file1') |
|
891 | 891 | ip.user_ns['filename'] = fname |
|
892 | 892 | ip.run_cell_magic("writefile", '$filename', u'\n'.join([ |
|
893 | 893 | 'line1', |
|
894 | 894 | 'line2', |
|
895 | 895 | ])) |
|
896 | 896 | s = Path(fname).read_text() |
|
897 | 897 | nt.assert_in('line1\n', s) |
|
898 | 898 | nt.assert_in('line2', s) |
|
899 | 899 | |
|
900 | 900 | def test_file_unicode(): |
|
901 | 901 | """%%writefile with unicode cell""" |
|
902 | 902 | ip = get_ipython() |
|
903 | 903 | with TemporaryDirectory() as td: |
|
904 | 904 | fname = os.path.join(td, 'file1') |
|
905 | 905 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
906 | 906 | u'linΓ©1', |
|
907 | 907 | u'linΓ©2', |
|
908 | 908 | ])) |
|
909 | 909 | with io.open(fname, encoding='utf-8') as f: |
|
910 | 910 | s = f.read() |
|
911 | 911 | nt.assert_in(u'linΓ©1\n', s) |
|
912 | 912 | nt.assert_in(u'linΓ©2', s) |
|
913 | 913 | |
|
914 | 914 | def test_file_amend(): |
|
915 | 915 | """%%writefile -a amends files""" |
|
916 | 916 | ip = get_ipython() |
|
917 | 917 | with TemporaryDirectory() as td: |
|
918 | 918 | fname = os.path.join(td, 'file2') |
|
919 | 919 | ip.run_cell_magic("writefile", fname, u'\n'.join([ |
|
920 | 920 | 'line1', |
|
921 | 921 | 'line2', |
|
922 | 922 | ])) |
|
923 | 923 | ip.run_cell_magic("writefile", "-a %s" % fname, u'\n'.join([ |
|
924 | 924 | 'line3', |
|
925 | 925 | 'line4', |
|
926 | 926 | ])) |
|
927 | 927 | s = Path(fname).read_text() |
|
928 | 928 | nt.assert_in('line1\n', s) |
|
929 | 929 | nt.assert_in('line3\n', s) |
|
930 | 930 | |
|
931 | 931 | def test_file_spaces(): |
|
932 | 932 | """%%file with spaces in filename""" |
|
933 | 933 | ip = get_ipython() |
|
934 | 934 | with TemporaryWorkingDirectory() as td: |
|
935 | 935 | fname = "file name" |
|
936 | 936 | ip.run_cell_magic("file", '"%s"'%fname, u'\n'.join([ |
|
937 | 937 | 'line1', |
|
938 | 938 | 'line2', |
|
939 | 939 | ])) |
|
940 | 940 | s = Path(fname).read_text() |
|
941 | 941 | nt.assert_in('line1\n', s) |
|
942 | 942 | nt.assert_in('line2', s) |
|
943 | 943 | |
|
944 | 944 | def test_script_config(): |
|
945 | 945 | ip = get_ipython() |
|
946 | 946 | ip.config.ScriptMagics.script_magics = ['whoda'] |
|
947 | 947 | sm = script.ScriptMagics(shell=ip) |
|
948 | 948 | nt.assert_in('whoda', sm.magics['cell']) |
|
949 | 949 | |
|
950 | 950 | @dec.skip_win32 |
|
951 | 951 | def test_script_out(): |
|
952 | 952 | ip = get_ipython() |
|
953 | 953 | ip.run_cell_magic("script", "--out output sh", "echo 'hi'") |
|
954 | 954 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
955 | 955 | |
|
956 | 956 | @dec.skip_win32 |
|
957 | 957 | def test_script_err(): |
|
958 | 958 | ip = get_ipython() |
|
959 | 959 | ip.run_cell_magic("script", "--err error sh", "echo 'hello' >&2") |
|
960 | 960 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
961 | 961 | |
|
962 | 962 | @dec.skip_win32 |
|
963 | 963 | def test_script_out_err(): |
|
964 | 964 | ip = get_ipython() |
|
965 | 965 | ip.run_cell_magic("script", "--out output --err error sh", "echo 'hi'\necho 'hello' >&2") |
|
966 | 966 | nt.assert_equal(ip.user_ns['output'], 'hi\n') |
|
967 | 967 | nt.assert_equal(ip.user_ns['error'], 'hello\n') |
|
968 | 968 | |
|
969 | 969 | @dec.skip_win32 |
|
970 | 970 | async def test_script_bg_out(): |
|
971 | 971 | ip = get_ipython() |
|
972 | 972 | ip.run_cell_magic("script", "--bg --out output sh", "echo 'hi'") |
|
973 | 973 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") |
|
974 | 974 | ip.user_ns['output'].close() |
|
975 | 975 | |
|
976 | 976 | @dec.skip_win32 |
|
977 | 977 | async def test_script_bg_err(): |
|
978 | 978 | ip = get_ipython() |
|
979 | 979 | ip.run_cell_magic("script", "--bg --err error sh", "echo 'hello' >&2") |
|
980 | 980 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") |
|
981 | 981 | ip.user_ns["error"].close() |
|
982 | 982 | |
|
983 | 983 | |
|
984 | 984 | @dec.skip_win32 |
|
985 | 985 | async def test_script_bg_out_err(): |
|
986 | 986 | ip = get_ipython() |
|
987 | 987 | ip.run_cell_magic( |
|
988 | 988 | "script", "--bg --out output --err error sh", "echo 'hi'\necho 'hello' >&2" |
|
989 | 989 | ) |
|
990 | 990 | nt.assert_equal((await ip.user_ns["output"].read()), b"hi\n") |
|
991 | 991 | nt.assert_equal((await ip.user_ns["error"].read()), b"hello\n") |
|
992 | 992 | ip.user_ns["output"].close() |
|
993 | 993 | ip.user_ns["error"].close() |
|
994 | 994 | |
|
995 | 995 | |
|
996 | 996 | def test_script_defaults(): |
|
997 | 997 | ip = get_ipython() |
|
998 | 998 | for cmd in ['sh', 'bash', 'perl', 'ruby']: |
|
999 | 999 | try: |
|
1000 | 1000 | find_cmd(cmd) |
|
1001 | 1001 | except Exception: |
|
1002 | 1002 | pass |
|
1003 | 1003 | else: |
|
1004 | 1004 | nt.assert_in(cmd, ip.magics_manager.magics['cell']) |
|
1005 | 1005 | |
|
1006 | 1006 | |
|
1007 | 1007 | @magics_class |
|
1008 | 1008 | class FooFoo(Magics): |
|
1009 | 1009 | """class with both %foo and %%foo magics""" |
|
1010 | 1010 | @line_magic('foo') |
|
1011 | 1011 | def line_foo(self, line): |
|
1012 | 1012 | "I am line foo" |
|
1013 | 1013 | pass |
|
1014 | 1014 | |
|
1015 | 1015 | @cell_magic("foo") |
|
1016 | 1016 | def cell_foo(self, line, cell): |
|
1017 | 1017 | "I am cell foo, not line foo" |
|
1018 | 1018 | pass |
|
1019 | 1019 | |
|
1020 | 1020 | def test_line_cell_info(): |
|
1021 | 1021 | """%%foo and %foo magics are distinguishable to inspect""" |
|
1022 | 1022 | ip = get_ipython() |
|
1023 | 1023 | ip.magics_manager.register(FooFoo) |
|
1024 | 1024 | oinfo = ip.object_inspect('foo') |
|
1025 | 1025 | nt.assert_true(oinfo['found']) |
|
1026 | 1026 | nt.assert_true(oinfo['ismagic']) |
|
1027 | 1027 | |
|
1028 | 1028 | oinfo = ip.object_inspect('%%foo') |
|
1029 | 1029 | nt.assert_true(oinfo['found']) |
|
1030 | 1030 | nt.assert_true(oinfo['ismagic']) |
|
1031 | 1031 | nt.assert_equal(oinfo['docstring'], FooFoo.cell_foo.__doc__) |
|
1032 | 1032 | |
|
1033 | 1033 | oinfo = ip.object_inspect('%foo') |
|
1034 | 1034 | nt.assert_true(oinfo['found']) |
|
1035 | 1035 | nt.assert_true(oinfo['ismagic']) |
|
1036 | 1036 | nt.assert_equal(oinfo['docstring'], FooFoo.line_foo.__doc__) |
|
1037 | 1037 | |
|
1038 | 1038 | def test_multiple_magics(): |
|
1039 | 1039 | ip = get_ipython() |
|
1040 | 1040 | foo1 = FooFoo(ip) |
|
1041 | 1041 | foo2 = FooFoo(ip) |
|
1042 | 1042 | mm = ip.magics_manager |
|
1043 | 1043 | mm.register(foo1) |
|
1044 | 1044 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo1) |
|
1045 | 1045 | mm.register(foo2) |
|
1046 | 1046 | nt.assert_true(mm.magics['line']['foo'].__self__ is foo2) |
|
1047 | 1047 | |
|
1048 | 1048 | def test_alias_magic(): |
|
1049 | 1049 | """Test %alias_magic.""" |
|
1050 | 1050 | ip = get_ipython() |
|
1051 | 1051 | mm = ip.magics_manager |
|
1052 | 1052 | |
|
1053 | 1053 | # Basic operation: both cell and line magics are created, if possible. |
|
1054 | 1054 | ip.run_line_magic('alias_magic', 'timeit_alias timeit') |
|
1055 | 1055 | nt.assert_in('timeit_alias', mm.magics['line']) |
|
1056 | 1056 | nt.assert_in('timeit_alias', mm.magics['cell']) |
|
1057 | 1057 | |
|
1058 | 1058 | # --cell is specified, line magic not created. |
|
1059 | 1059 | ip.run_line_magic('alias_magic', '--cell timeit_cell_alias timeit') |
|
1060 | 1060 | nt.assert_not_in('timeit_cell_alias', mm.magics['line']) |
|
1061 | 1061 | nt.assert_in('timeit_cell_alias', mm.magics['cell']) |
|
1062 | 1062 | |
|
1063 | 1063 | # Test that line alias is created successfully. |
|
1064 | 1064 | ip.run_line_magic('alias_magic', '--line env_alias env') |
|
1065 | 1065 | nt.assert_equal(ip.run_line_magic('env', ''), |
|
1066 | 1066 | ip.run_line_magic('env_alias', '')) |
|
1067 | 1067 | |
|
1068 | 1068 | # Test that line alias with parameters passed in is created successfully. |
|
1069 | 1069 | ip.run_line_magic('alias_magic', '--line history_alias history --params ' + shlex.quote('3')) |
|
1070 | 1070 | nt.assert_in('history_alias', mm.magics['line']) |
|
1071 | 1071 | |
|
1072 | 1072 | |
|
1073 | 1073 | def test_save(): |
|
1074 | 1074 | """Test %save.""" |
|
1075 | 1075 | ip = get_ipython() |
|
1076 | 1076 | ip.history_manager.reset() # Clear any existing history. |
|
1077 | 1077 | cmds = [u"a=1", u"def b():\n return a**2", u"print(a, b())"] |
|
1078 | 1078 | for i, cmd in enumerate(cmds, start=1): |
|
1079 | 1079 | ip.history_manager.store_inputs(i, cmd) |
|
1080 | 1080 | with TemporaryDirectory() as tmpdir: |
|
1081 | 1081 | file = os.path.join(tmpdir, "testsave.py") |
|
1082 | 1082 | ip.run_line_magic("save", "%s 1-10" % file) |
|
1083 | 1083 | content = Path(file).read_text() |
|
1084 | 1084 | nt.assert_equal(content.count(cmds[0]), 1) |
|
1085 | 1085 | nt.assert_in("coding: utf-8", content) |
|
1086 | 1086 | ip.run_line_magic("save", "-a %s 1-10" % file) |
|
1087 | 1087 | content = Path(file).read_text() |
|
1088 | 1088 | nt.assert_equal(content.count(cmds[0]), 2) |
|
1089 | 1089 | nt.assert_in("coding: utf-8", content) |
|
1090 | 1090 | |
|
1091 | 1091 | |
|
1092 | def test_save_with_no_args(): | |
|
1093 | ip = get_ipython() | |
|
1094 | ip.history_manager.reset() # Clear any existing history. | |
|
1095 | cmds = [u"a=1", u"def b():\n return a**2", u"print(a, b())", "%save"] | |
|
1096 | for i, cmd in enumerate(cmds, start=1): | |
|
1097 | ip.history_manager.store_inputs(i, cmd) | |
|
1098 | ||
|
1099 | with TemporaryDirectory() as tmpdir: | |
|
1100 | path = os.path.join(tmpdir, "testsave.py") | |
|
1101 | ip.run_line_magic("save", path) | |
|
1102 | content = Path(path).read_text() | |
|
1103 | expected_content = dedent( | |
|
1104 | """\ | |
|
1105 | # coding: utf-8 | |
|
1106 | a=1 | |
|
1107 | def b(): | |
|
1108 | return a**2 | |
|
1109 | print(a, b()) | |
|
1110 | """ | |
|
1111 | ) | |
|
1112 | nt.assert_equal(content, expected_content) | |
|
1113 | ||
|
1114 | ||
|
1092 | 1115 | def test_store(): |
|
1093 | 1116 | """Test %store.""" |
|
1094 | 1117 | ip = get_ipython() |
|
1095 | 1118 | ip.run_line_magic('load_ext', 'storemagic') |
|
1096 | 1119 | |
|
1097 | 1120 | # make sure the storage is empty |
|
1098 | 1121 | ip.run_line_magic('store', '-z') |
|
1099 | 1122 | ip.user_ns['var'] = 42 |
|
1100 | 1123 | ip.run_line_magic('store', 'var') |
|
1101 | 1124 | ip.user_ns['var'] = 39 |
|
1102 | 1125 | ip.run_line_magic('store', '-r') |
|
1103 | 1126 | nt.assert_equal(ip.user_ns['var'], 42) |
|
1104 | 1127 | |
|
1105 | 1128 | ip.run_line_magic('store', '-d var') |
|
1106 | 1129 | ip.user_ns['var'] = 39 |
|
1107 | 1130 | ip.run_line_magic('store' , '-r') |
|
1108 | 1131 | nt.assert_equal(ip.user_ns['var'], 39) |
|
1109 | 1132 | |
|
1110 | 1133 | |
|
1111 | 1134 | def _run_edit_test(arg_s, exp_filename=None, |
|
1112 | 1135 | exp_lineno=-1, |
|
1113 | 1136 | exp_contents=None, |
|
1114 | 1137 | exp_is_temp=None): |
|
1115 | 1138 | ip = get_ipython() |
|
1116 | 1139 | M = code.CodeMagics(ip) |
|
1117 | 1140 | last_call = ['',''] |
|
1118 | 1141 | opts,args = M.parse_options(arg_s,'prxn:') |
|
1119 | 1142 | filename, lineno, is_temp = M._find_edit_target(ip, args, opts, last_call) |
|
1120 | 1143 | |
|
1121 | 1144 | if exp_filename is not None: |
|
1122 | 1145 | nt.assert_equal(exp_filename, filename) |
|
1123 | 1146 | if exp_contents is not None: |
|
1124 | 1147 | with io.open(filename, 'r', encoding='utf-8') as f: |
|
1125 | 1148 | contents = f.read() |
|
1126 | 1149 | nt.assert_equal(exp_contents, contents) |
|
1127 | 1150 | if exp_lineno != -1: |
|
1128 | 1151 | nt.assert_equal(exp_lineno, lineno) |
|
1129 | 1152 | if exp_is_temp is not None: |
|
1130 | 1153 | nt.assert_equal(exp_is_temp, is_temp) |
|
1131 | 1154 | |
|
1132 | 1155 | |
|
1133 | 1156 | def test_edit_interactive(): |
|
1134 | 1157 | """%edit on interactively defined objects""" |
|
1135 | 1158 | ip = get_ipython() |
|
1136 | 1159 | n = ip.execution_count |
|
1137 | 1160 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1138 | 1161 | |
|
1139 | 1162 | try: |
|
1140 | 1163 | _run_edit_test("foo") |
|
1141 | 1164 | except code.InteractivelyDefined as e: |
|
1142 | 1165 | nt.assert_equal(e.index, n) |
|
1143 | 1166 | else: |
|
1144 | 1167 | raise AssertionError("Should have raised InteractivelyDefined") |
|
1145 | 1168 | |
|
1146 | 1169 | |
|
1147 | 1170 | def test_edit_cell(): |
|
1148 | 1171 | """%edit [cell id]""" |
|
1149 | 1172 | ip = get_ipython() |
|
1150 | 1173 | |
|
1151 | 1174 | ip.run_cell(u"def foo(): return 1", store_history=True) |
|
1152 | 1175 | |
|
1153 | 1176 | # test |
|
1154 | 1177 | _run_edit_test("1", exp_contents=ip.user_ns['In'][1], exp_is_temp=True) |
|
1155 | 1178 | |
|
1156 | 1179 | def test_edit_fname(): |
|
1157 | 1180 | """%edit file""" |
|
1158 | 1181 | # test |
|
1159 | 1182 | _run_edit_test("test file.py", exp_filename="test file.py") |
|
1160 | 1183 | |
|
1161 | 1184 | def test_bookmark(): |
|
1162 | 1185 | ip = get_ipython() |
|
1163 | 1186 | ip.run_line_magic('bookmark', 'bmname') |
|
1164 | 1187 | with tt.AssertPrints('bmname'): |
|
1165 | 1188 | ip.run_line_magic('bookmark', '-l') |
|
1166 | 1189 | ip.run_line_magic('bookmark', '-d bmname') |
|
1167 | 1190 | |
|
1168 | 1191 | def test_ls_magic(): |
|
1169 | 1192 | ip = get_ipython() |
|
1170 | 1193 | json_formatter = ip.display_formatter.formatters['application/json'] |
|
1171 | 1194 | json_formatter.enabled = True |
|
1172 | 1195 | lsmagic = ip.magic('lsmagic') |
|
1173 | 1196 | with warnings.catch_warnings(record=True) as w: |
|
1174 | 1197 | j = json_formatter(lsmagic) |
|
1175 | 1198 | nt.assert_equal(sorted(j), ['cell', 'line']) |
|
1176 | 1199 | nt.assert_equal(w, []) # no warnings |
|
1177 | 1200 | |
|
1178 | 1201 | def test_strip_initial_indent(): |
|
1179 | 1202 | def sii(s): |
|
1180 | 1203 | lines = s.splitlines() |
|
1181 | 1204 | return '\n'.join(code.strip_initial_indent(lines)) |
|
1182 | 1205 | |
|
1183 | 1206 | nt.assert_equal(sii(" a = 1\nb = 2"), "a = 1\nb = 2") |
|
1184 | 1207 | nt.assert_equal(sii(" a\n b\nc"), "a\n b\nc") |
|
1185 | 1208 | nt.assert_equal(sii("a\n b"), "a\n b") |
|
1186 | 1209 | |
|
1187 | 1210 | def test_logging_magic_quiet_from_arg(): |
|
1188 | 1211 | _ip.config.LoggingMagics.quiet = False |
|
1189 | 1212 | lm = logging.LoggingMagics(shell=_ip) |
|
1190 | 1213 | with TemporaryDirectory() as td: |
|
1191 | 1214 | try: |
|
1192 | 1215 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1193 | 1216 | lm.logstart('-q {}'.format( |
|
1194 | 1217 | os.path.join(td, "quiet_from_arg.log"))) |
|
1195 | 1218 | finally: |
|
1196 | 1219 | _ip.logger.logstop() |
|
1197 | 1220 | |
|
1198 | 1221 | def test_logging_magic_quiet_from_config(): |
|
1199 | 1222 | _ip.config.LoggingMagics.quiet = True |
|
1200 | 1223 | lm = logging.LoggingMagics(shell=_ip) |
|
1201 | 1224 | with TemporaryDirectory() as td: |
|
1202 | 1225 | try: |
|
1203 | 1226 | with tt.AssertNotPrints(re.compile("Activating.*")): |
|
1204 | 1227 | lm.logstart(os.path.join(td, "quiet_from_config.log")) |
|
1205 | 1228 | finally: |
|
1206 | 1229 | _ip.logger.logstop() |
|
1207 | 1230 | |
|
1208 | 1231 | |
|
1209 | 1232 | def test_logging_magic_not_quiet(): |
|
1210 | 1233 | _ip.config.LoggingMagics.quiet = False |
|
1211 | 1234 | lm = logging.LoggingMagics(shell=_ip) |
|
1212 | 1235 | with TemporaryDirectory() as td: |
|
1213 | 1236 | try: |
|
1214 | 1237 | with tt.AssertPrints(re.compile("Activating.*")): |
|
1215 | 1238 | lm.logstart(os.path.join(td, "not_quiet.log")) |
|
1216 | 1239 | finally: |
|
1217 | 1240 | _ip.logger.logstop() |
|
1218 | 1241 | |
|
1219 | 1242 | |
|
1220 | 1243 | def test_time_no_var_expand(): |
|
1221 | 1244 | _ip.user_ns['a'] = 5 |
|
1222 | 1245 | _ip.user_ns['b'] = [] |
|
1223 | 1246 | _ip.magic('time b.append("{a}")') |
|
1224 | 1247 | assert _ip.user_ns['b'] == ['{a}'] |
|
1225 | 1248 | |
|
1226 | 1249 | |
|
1227 | 1250 | # this is slow, put at the end for local testing. |
|
1228 | 1251 | def test_timeit_arguments(): |
|
1229 | 1252 | "Test valid timeit arguments, should not cause SyntaxError (GH #1269)" |
|
1230 | 1253 | if sys.version_info < (3,7): |
|
1231 | 1254 | _ip.magic("timeit -n1 -r1 ('#')") |
|
1232 | 1255 | else: |
|
1233 | 1256 | # 3.7 optimize no-op statement like above out, and complain there is |
|
1234 | 1257 | # nothing in the for loop. |
|
1235 | 1258 | _ip.magic("timeit -n1 -r1 a=('#')") |
|
1236 | 1259 | |
|
1237 | 1260 | |
|
1238 | 1261 | TEST_MODULE = """ |
|
1239 | 1262 | print('Loaded my_tmp') |
|
1240 | 1263 | if __name__ == "__main__": |
|
1241 | 1264 | print('I just ran a script') |
|
1242 | 1265 | """ |
|
1243 | 1266 | |
|
1244 | 1267 | |
|
1245 | 1268 | def test_run_module_from_import_hook(): |
|
1246 | 1269 | "Test that a module can be loaded via an import hook" |
|
1247 | 1270 | with TemporaryDirectory() as tmpdir: |
|
1248 | 1271 | fullpath = os.path.join(tmpdir, 'my_tmp.py') |
|
1249 | 1272 | Path(fullpath).write_text(TEST_MODULE) |
|
1250 | 1273 | |
|
1251 | 1274 | class MyTempImporter(object): |
|
1252 | 1275 | def __init__(self): |
|
1253 | 1276 | pass |
|
1254 | 1277 | |
|
1255 | 1278 | def find_module(self, fullname, path=None): |
|
1256 | 1279 | if 'my_tmp' in fullname: |
|
1257 | 1280 | return self |
|
1258 | 1281 | return None |
|
1259 | 1282 | |
|
1260 | 1283 | def load_module(self, name): |
|
1261 | 1284 | import imp |
|
1262 | 1285 | return imp.load_source('my_tmp', fullpath) |
|
1263 | 1286 | |
|
1264 | 1287 | def get_code(self, fullname): |
|
1265 | 1288 | return compile(Path(fullpath).read_text(), "foo", "exec") |
|
1266 | 1289 | |
|
1267 | 1290 | def is_package(self, __): |
|
1268 | 1291 | return False |
|
1269 | 1292 | |
|
1270 | 1293 | sys.meta_path.insert(0, MyTempImporter()) |
|
1271 | 1294 | |
|
1272 | 1295 | with capture_output() as captured: |
|
1273 | 1296 | _ip.magic("run -m my_tmp") |
|
1274 | 1297 | _ip.run_cell("import my_tmp") |
|
1275 | 1298 | |
|
1276 | 1299 | output = "Loaded my_tmp\nI just ran a script\nLoaded my_tmp\n" |
|
1277 | 1300 | nt.assert_equal(output, captured.stdout) |
|
1278 | 1301 | |
|
1279 | 1302 | sys.meta_path.pop(0) |
General Comments 0
You need to be logged in to leave comments.
Login now