|
@@
-1,2558
+1,2561
b''
|
|
1
|
# -*- coding: utf-8 -*-
|
|
1
|
# -*- coding: utf-8 -*-
|
|
2
|
"""
|
|
2
|
"""
|
|
3
|
Main IPython Component
|
|
3
|
Main IPython Component
|
|
4
|
"""
|
|
4
|
"""
|
|
5
|
|
|
5
|
|
|
6
|
#-----------------------------------------------------------------------------
|
|
6
|
#-----------------------------------------------------------------------------
|
|
7
|
# Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
|
|
7
|
# Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
|
|
8
|
# Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
|
|
8
|
# Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
|
|
9
|
# Copyright (C) 2008-2009 The IPython Development Team
|
|
9
|
# Copyright (C) 2008-2009 The IPython Development Team
|
|
10
|
#
|
|
10
|
#
|
|
11
|
# Distributed under the terms of the BSD License. The full license is in
|
|
11
|
# Distributed under the terms of the BSD License. The full license is in
|
|
12
|
# the file COPYING, distributed as part of this software.
|
|
12
|
# the file COPYING, distributed as part of this software.
|
|
13
|
#-----------------------------------------------------------------------------
|
|
13
|
#-----------------------------------------------------------------------------
|
|
14
|
|
|
14
|
|
|
15
|
#-----------------------------------------------------------------------------
|
|
15
|
#-----------------------------------------------------------------------------
|
|
16
|
# Imports
|
|
16
|
# Imports
|
|
17
|
#-----------------------------------------------------------------------------
|
|
17
|
#-----------------------------------------------------------------------------
|
|
18
|
|
|
18
|
|
|
19
|
from __future__ import with_statement
|
|
19
|
from __future__ import with_statement
|
|
20
|
from __future__ import absolute_import
|
|
20
|
from __future__ import absolute_import
|
|
21
|
|
|
21
|
|
|
22
|
import __builtin__
|
|
22
|
import __builtin__
|
|
23
|
import bdb
|
|
23
|
import bdb
|
|
24
|
import codeop
|
|
24
|
import codeop
|
|
25
|
import exceptions
|
|
25
|
import exceptions
|
|
26
|
import new
|
|
26
|
import new
|
|
27
|
import os
|
|
27
|
import os
|
|
28
|
import re
|
|
28
|
import re
|
|
29
|
import string
|
|
29
|
import string
|
|
30
|
import sys
|
|
30
|
import sys
|
|
31
|
import tempfile
|
|
31
|
import tempfile
|
|
32
|
from contextlib import nested
|
|
32
|
from contextlib import nested
|
|
33
|
|
|
33
|
|
|
34
|
from IPython.core import debugger, oinspect
|
|
34
|
from IPython.core import debugger, oinspect
|
|
35
|
from IPython.core import history as ipcorehist
|
|
35
|
from IPython.core import history as ipcorehist
|
|
36
|
from IPython.core import prefilter
|
|
36
|
from IPython.core import prefilter
|
|
37
|
from IPython.core import shadowns
|
|
37
|
from IPython.core import shadowns
|
|
38
|
from IPython.core import ultratb
|
|
38
|
from IPython.core import ultratb
|
|
39
|
from IPython.core.alias import AliasManager
|
|
39
|
from IPython.core.alias import AliasManager
|
|
40
|
from IPython.core.builtin_trap import BuiltinTrap
|
|
40
|
from IPython.core.builtin_trap import BuiltinTrap
|
|
41
|
from IPython.core.component import Component
|
|
41
|
from IPython.core.component import Component
|
|
42
|
from IPython.core.display_trap import DisplayTrap
|
|
42
|
from IPython.core.display_trap import DisplayTrap
|
|
43
|
from IPython.core.error import TryNext, UsageError
|
|
43
|
from IPython.core.error import TryNext, UsageError
|
|
44
|
from IPython.core.fakemodule import FakeModule, init_fakemod_dict
|
|
44
|
from IPython.core.fakemodule import FakeModule, init_fakemod_dict
|
|
45
|
from IPython.core.logger import Logger
|
|
45
|
from IPython.core.logger import Logger
|
|
46
|
from IPython.core.magic import Magic
|
|
46
|
from IPython.core.magic import Magic
|
|
47
|
from IPython.core.prefilter import PrefilterManager
|
|
47
|
from IPython.core.prefilter import PrefilterManager
|
|
48
|
from IPython.core.prompts import CachedOutput
|
|
48
|
from IPython.core.prompts import CachedOutput
|
|
49
|
from IPython.core.usage import interactive_usage, default_banner
|
|
49
|
from IPython.core.usage import interactive_usage, default_banner
|
|
50
|
import IPython.core.hooks
|
|
50
|
import IPython.core.hooks
|
|
51
|
from IPython.external.Itpl import ItplNS
|
|
51
|
from IPython.external.Itpl import ItplNS
|
|
52
|
from IPython.lib.inputhook import enable_gui
|
|
52
|
from IPython.lib.inputhook import enable_gui
|
|
53
|
from IPython.lib.backgroundjobs import BackgroundJobManager
|
|
53
|
from IPython.lib.backgroundjobs import BackgroundJobManager
|
|
54
|
from IPython.lib.pylabtools import pylab_activate
|
|
54
|
from IPython.lib.pylabtools import pylab_activate
|
|
55
|
from IPython.utils import PyColorize
|
|
55
|
from IPython.utils import PyColorize
|
|
56
|
from IPython.utils import pickleshare
|
|
56
|
from IPython.utils import pickleshare
|
|
57
|
from IPython.utils.doctestreload import doctest_reload
|
|
57
|
from IPython.utils.doctestreload import doctest_reload
|
|
58
|
from IPython.utils.ipstruct import Struct
|
|
58
|
from IPython.utils.ipstruct import Struct
|
|
59
|
from IPython.utils.io import Term, ask_yes_no
|
|
59
|
from IPython.utils.io import Term, ask_yes_no
|
|
60
|
from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
|
|
60
|
from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
|
|
61
|
from IPython.utils.process import (
|
|
61
|
from IPython.utils.process import (
|
|
62
|
abbrev_cwd,
|
|
62
|
abbrev_cwd,
|
|
63
|
getoutput,
|
|
63
|
getoutput,
|
|
64
|
getoutputerror
|
|
64
|
getoutputerror
|
|
65
|
)
|
|
65
|
)
|
|
66
|
# import IPython.utils.rlineimpl as readline
|
|
66
|
# import IPython.utils.rlineimpl as readline
|
|
67
|
from IPython.utils.strdispatch import StrDispatch
|
|
67
|
from IPython.utils.strdispatch import StrDispatch
|
|
68
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
68
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
69
|
from IPython.utils.terminal import toggle_set_term_title, set_term_title
|
|
69
|
from IPython.utils.terminal import toggle_set_term_title, set_term_title
|
|
70
|
from IPython.utils.warn import warn, error, fatal
|
|
70
|
from IPython.utils.warn import warn, error, fatal
|
|
71
|
from IPython.utils.traitlets import (
|
|
71
|
from IPython.utils.traitlets import (
|
|
72
|
Int, Str, CBool, CaselessStrEnum, Enum, List, Unicode
|
|
72
|
Int, Str, CBool, CaselessStrEnum, Enum, List, Unicode
|
|
73
|
)
|
|
73
|
)
|
|
74
|
|
|
74
|
|
|
75
|
# from IPython.utils import growl
|
|
75
|
# from IPython.utils import growl
|
|
76
|
# growl.start("IPython")
|
|
76
|
# growl.start("IPython")
|
|
77
|
|
|
77
|
|
|
78
|
#-----------------------------------------------------------------------------
|
|
78
|
#-----------------------------------------------------------------------------
|
|
79
|
# Globals
|
|
79
|
# Globals
|
|
80
|
#-----------------------------------------------------------------------------
|
|
80
|
#-----------------------------------------------------------------------------
|
|
81
|
|
|
81
|
|
|
82
|
# store the builtin raw_input globally, and use this always, in case user code
|
|
82
|
# store the builtin raw_input globally, and use this always, in case user code
|
|
83
|
# overwrites it (like wx.py.PyShell does)
|
|
83
|
# overwrites it (like wx.py.PyShell does)
|
|
84
|
raw_input_original = raw_input
|
|
84
|
raw_input_original = raw_input
|
|
85
|
|
|
85
|
|
|
86
|
# compiled regexps for autoindent management
|
|
86
|
# compiled regexps for autoindent management
|
|
87
|
dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
|
|
87
|
dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
|
|
88
|
|
|
88
|
|
|
89
|
#-----------------------------------------------------------------------------
|
|
89
|
#-----------------------------------------------------------------------------
|
|
90
|
# Utilities
|
|
90
|
# Utilities
|
|
91
|
#-----------------------------------------------------------------------------
|
|
91
|
#-----------------------------------------------------------------------------
|
|
92
|
|
|
92
|
|
|
93
|
ini_spaces_re = re.compile(r'^(\s+)')
|
|
93
|
ini_spaces_re = re.compile(r'^(\s+)')
|
|
94
|
|
|
94
|
|
|
95
|
|
|
95
|
|
|
96
|
def num_ini_spaces(strng):
|
|
96
|
def num_ini_spaces(strng):
|
|
97
|
"""Return the number of initial spaces in a string"""
|
|
97
|
"""Return the number of initial spaces in a string"""
|
|
98
|
|
|
98
|
|
|
99
|
ini_spaces = ini_spaces_re.match(strng)
|
|
99
|
ini_spaces = ini_spaces_re.match(strng)
|
|
100
|
if ini_spaces:
|
|
100
|
if ini_spaces:
|
|
101
|
return ini_spaces.end()
|
|
101
|
return ini_spaces.end()
|
|
102
|
else:
|
|
102
|
else:
|
|
103
|
return 0
|
|
103
|
return 0
|
|
104
|
|
|
104
|
|
|
105
|
|
|
105
|
|
|
106
|
def softspace(file, newvalue):
|
|
106
|
def softspace(file, newvalue):
|
|
107
|
"""Copied from code.py, to remove the dependency"""
|
|
107
|
"""Copied from code.py, to remove the dependency"""
|
|
108
|
|
|
108
|
|
|
109
|
oldvalue = 0
|
|
109
|
oldvalue = 0
|
|
110
|
try:
|
|
110
|
try:
|
|
111
|
oldvalue = file.softspace
|
|
111
|
oldvalue = file.softspace
|
|
112
|
except AttributeError:
|
|
112
|
except AttributeError:
|
|
113
|
pass
|
|
113
|
pass
|
|
114
|
try:
|
|
114
|
try:
|
|
115
|
file.softspace = newvalue
|
|
115
|
file.softspace = newvalue
|
|
116
|
except (AttributeError, TypeError):
|
|
116
|
except (AttributeError, TypeError):
|
|
117
|
# "attribute-less object" or "read-only attributes"
|
|
117
|
# "attribute-less object" or "read-only attributes"
|
|
118
|
pass
|
|
118
|
pass
|
|
119
|
return oldvalue
|
|
119
|
return oldvalue
|
|
120
|
|
|
120
|
|
|
121
|
|
|
121
|
|
|
122
|
def no_op(*a, **kw): pass
|
|
122
|
def no_op(*a, **kw): pass
|
|
123
|
|
|
123
|
|
|
124
|
class SpaceInInput(exceptions.Exception): pass
|
|
124
|
class SpaceInInput(exceptions.Exception): pass
|
|
125
|
|
|
125
|
|
|
126
|
class Bunch: pass
|
|
126
|
class Bunch: pass
|
|
127
|
|
|
127
|
|
|
128
|
class InputList(list):
|
|
128
|
class InputList(list):
|
|
129
|
"""Class to store user input.
|
|
129
|
"""Class to store user input.
|
|
130
|
|
|
130
|
|
|
131
|
It's basically a list, but slices return a string instead of a list, thus
|
|
131
|
It's basically a list, but slices return a string instead of a list, thus
|
|
132
|
allowing things like (assuming 'In' is an instance):
|
|
132
|
allowing things like (assuming 'In' is an instance):
|
|
133
|
|
|
133
|
|
|
134
|
exec In[4:7]
|
|
134
|
exec In[4:7]
|
|
135
|
|
|
135
|
|
|
136
|
or
|
|
136
|
or
|
|
137
|
|
|
137
|
|
|
138
|
exec In[5:9] + In[14] + In[21:25]"""
|
|
138
|
exec In[5:9] + In[14] + In[21:25]"""
|
|
139
|
|
|
139
|
|
|
140
|
def __getslice__(self,i,j):
|
|
140
|
def __getslice__(self,i,j):
|
|
141
|
return ''.join(list.__getslice__(self,i,j))
|
|
141
|
return ''.join(list.__getslice__(self,i,j))
|
|
142
|
|
|
142
|
|
|
143
|
|
|
143
|
|
|
144
|
class SyntaxTB(ultratb.ListTB):
|
|
144
|
class SyntaxTB(ultratb.ListTB):
|
|
145
|
"""Extension which holds some state: the last exception value"""
|
|
145
|
"""Extension which holds some state: the last exception value"""
|
|
146
|
|
|
146
|
|
|
147
|
def __init__(self,color_scheme = 'NoColor'):
|
|
147
|
def __init__(self,color_scheme = 'NoColor'):
|
|
148
|
ultratb.ListTB.__init__(self,color_scheme)
|
|
148
|
ultratb.ListTB.__init__(self,color_scheme)
|
|
149
|
self.last_syntax_error = None
|
|
149
|
self.last_syntax_error = None
|
|
150
|
|
|
150
|
|
|
151
|
def __call__(self, etype, value, elist):
|
|
151
|
def __call__(self, etype, value, elist):
|
|
152
|
self.last_syntax_error = value
|
|
152
|
self.last_syntax_error = value
|
|
153
|
ultratb.ListTB.__call__(self,etype,value,elist)
|
|
153
|
ultratb.ListTB.__call__(self,etype,value,elist)
|
|
154
|
|
|
154
|
|
|
155
|
def clear_err_state(self):
|
|
155
|
def clear_err_state(self):
|
|
156
|
"""Return the current error state and clear it"""
|
|
156
|
"""Return the current error state and clear it"""
|
|
157
|
e = self.last_syntax_error
|
|
157
|
e = self.last_syntax_error
|
|
158
|
self.last_syntax_error = None
|
|
158
|
self.last_syntax_error = None
|
|
159
|
return e
|
|
159
|
return e
|
|
160
|
|
|
160
|
|
|
161
|
|
|
161
|
|
|
162
|
def get_default_editor():
|
|
162
|
def get_default_editor():
|
|
163
|
try:
|
|
163
|
try:
|
|
164
|
ed = os.environ['EDITOR']
|
|
164
|
ed = os.environ['EDITOR']
|
|
165
|
except KeyError:
|
|
165
|
except KeyError:
|
|
166
|
if os.name == 'posix':
|
|
166
|
if os.name == 'posix':
|
|
167
|
ed = 'vi' # the only one guaranteed to be there!
|
|
167
|
ed = 'vi' # the only one guaranteed to be there!
|
|
168
|
else:
|
|
168
|
else:
|
|
169
|
ed = 'notepad' # same in Windows!
|
|
169
|
ed = 'notepad' # same in Windows!
|
|
170
|
return ed
|
|
170
|
return ed
|
|
171
|
|
|
171
|
|
|
172
|
|
|
172
|
|
|
173
|
def get_default_colors():
|
|
173
|
def get_default_colors():
|
|
174
|
if sys.platform=='darwin':
|
|
174
|
if sys.platform=='darwin':
|
|
175
|
return "LightBG"
|
|
175
|
return "LightBG"
|
|
176
|
elif os.name=='nt':
|
|
176
|
elif os.name=='nt':
|
|
177
|
return 'Linux'
|
|
177
|
return 'Linux'
|
|
178
|
else:
|
|
178
|
else:
|
|
179
|
return 'Linux'
|
|
179
|
return 'Linux'
|
|
180
|
|
|
180
|
|
|
181
|
|
|
181
|
|
|
182
|
class SeparateStr(Str):
|
|
182
|
class SeparateStr(Str):
|
|
183
|
"""A Str subclass to validate separate_in, separate_out, etc.
|
|
183
|
"""A Str subclass to validate separate_in, separate_out, etc.
|
|
184
|
|
|
184
|
|
|
185
|
This is a Str based traitlet that converts '0'->'' and '\\n'->'\n'.
|
|
185
|
This is a Str based traitlet that converts '0'->'' and '\\n'->'\n'.
|
|
186
|
"""
|
|
186
|
"""
|
|
187
|
|
|
187
|
|
|
188
|
def validate(self, obj, value):
|
|
188
|
def validate(self, obj, value):
|
|
189
|
if value == '0': value = ''
|
|
189
|
if value == '0': value = ''
|
|
190
|
value = value.replace('\\n','\n')
|
|
190
|
value = value.replace('\\n','\n')
|
|
191
|
return super(SeparateStr, self).validate(obj, value)
|
|
191
|
return super(SeparateStr, self).validate(obj, value)
|
|
192
|
|
|
192
|
|
|
193
|
|
|
193
|
|
|
194
|
#-----------------------------------------------------------------------------
|
|
194
|
#-----------------------------------------------------------------------------
|
|
195
|
# Main IPython class
|
|
195
|
# Main IPython class
|
|
196
|
#-----------------------------------------------------------------------------
|
|
196
|
#-----------------------------------------------------------------------------
|
|
197
|
|
|
197
|
|
|
198
|
|
|
198
|
|
|
199
|
class InteractiveShell(Component, Magic):
|
|
199
|
class InteractiveShell(Component, Magic):
|
|
200
|
"""An enhanced, interactive shell for Python."""
|
|
200
|
"""An enhanced, interactive shell for Python."""
|
|
201
|
|
|
201
|
|
|
202
|
autocall = Enum((0,1,2), default_value=1, config=True)
|
|
202
|
autocall = Enum((0,1,2), default_value=1, config=True)
|
|
203
|
autoedit_syntax = CBool(False, config=True)
|
|
203
|
autoedit_syntax = CBool(False, config=True)
|
|
204
|
autoindent = CBool(True, config=True)
|
|
204
|
autoindent = CBool(True, config=True)
|
|
205
|
automagic = CBool(True, config=True)
|
|
205
|
automagic = CBool(True, config=True)
|
|
206
|
banner = Str('')
|
|
206
|
banner = Str('')
|
|
207
|
banner1 = Str(default_banner, config=True)
|
|
207
|
banner1 = Str(default_banner, config=True)
|
|
208
|
banner2 = Str('', config=True)
|
|
208
|
banner2 = Str('', config=True)
|
|
209
|
cache_size = Int(1000, config=True)
|
|
209
|
cache_size = Int(1000, config=True)
|
|
210
|
color_info = CBool(True, config=True)
|
|
210
|
color_info = CBool(True, config=True)
|
|
211
|
colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
|
|
211
|
colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
|
|
212
|
default_value=get_default_colors(), config=True)
|
|
212
|
default_value=get_default_colors(), config=True)
|
|
213
|
confirm_exit = CBool(True, config=True)
|
|
213
|
confirm_exit = CBool(True, config=True)
|
|
214
|
debug = CBool(False, config=True)
|
|
214
|
debug = CBool(False, config=True)
|
|
215
|
deep_reload = CBool(False, config=True)
|
|
215
|
deep_reload = CBool(False, config=True)
|
|
216
|
# This display_banner only controls whether or not self.show_banner()
|
|
216
|
# This display_banner only controls whether or not self.show_banner()
|
|
217
|
# is called when mainloop/interact are called. The default is False
|
|
217
|
# is called when mainloop/interact are called. The default is False
|
|
218
|
# because for the terminal based application, the banner behavior
|
|
218
|
# because for the terminal based application, the banner behavior
|
|
219
|
# is controlled by Global.display_banner, which IPythonApp looks at
|
|
219
|
# is controlled by Global.display_banner, which IPythonApp looks at
|
|
220
|
# to determine if *it* should call show_banner() by hand or not.
|
|
220
|
# to determine if *it* should call show_banner() by hand or not.
|
|
221
|
display_banner = CBool(False) # This isn't configurable!
|
|
221
|
display_banner = CBool(False) # This isn't configurable!
|
|
222
|
embedded = CBool(False)
|
|
222
|
embedded = CBool(False)
|
|
223
|
embedded_active = CBool(False)
|
|
223
|
embedded_active = CBool(False)
|
|
224
|
editor = Str(get_default_editor(), config=True)
|
|
224
|
editor = Str(get_default_editor(), config=True)
|
|
225
|
filename = Str("<ipython console>")
|
|
225
|
filename = Str("<ipython console>")
|
|
226
|
ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
|
|
226
|
ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
|
|
227
|
logstart = CBool(False, config=True)
|
|
227
|
logstart = CBool(False, config=True)
|
|
228
|
logfile = Str('', config=True)
|
|
228
|
logfile = Str('', config=True)
|
|
229
|
logappend = Str('', config=True)
|
|
229
|
logappend = Str('', config=True)
|
|
230
|
object_info_string_level = Enum((0,1,2), default_value=0,
|
|
230
|
object_info_string_level = Enum((0,1,2), default_value=0,
|
|
231
|
config=True)
|
|
231
|
config=True)
|
|
232
|
pager = Str('less', config=True)
|
|
232
|
pager = Str('less', config=True)
|
|
233
|
pdb = CBool(False, config=True)
|
|
233
|
pdb = CBool(False, config=True)
|
|
234
|
pprint = CBool(True, config=True)
|
|
234
|
pprint = CBool(True, config=True)
|
|
235
|
profile = Str('', config=True)
|
|
235
|
profile = Str('', config=True)
|
|
236
|
prompt_in1 = Str('In [\\#]: ', config=True)
|
|
236
|
prompt_in1 = Str('In [\\#]: ', config=True)
|
|
237
|
prompt_in2 = Str(' .\\D.: ', config=True)
|
|
237
|
prompt_in2 = Str(' .\\D.: ', config=True)
|
|
238
|
prompt_out = Str('Out[\\#]: ', config=True)
|
|
238
|
prompt_out = Str('Out[\\#]: ', config=True)
|
|
239
|
prompts_pad_left = CBool(True, config=True)
|
|
239
|
prompts_pad_left = CBool(True, config=True)
|
|
240
|
quiet = CBool(False, config=True)
|
|
240
|
quiet = CBool(False, config=True)
|
|
241
|
|
|
241
|
|
|
242
|
readline_use = CBool(True, config=True)
|
|
242
|
readline_use = CBool(True, config=True)
|
|
243
|
readline_merge_completions = CBool(True, config=True)
|
|
243
|
readline_merge_completions = CBool(True, config=True)
|
|
244
|
readline_omit__names = Enum((0,1,2), default_value=0, config=True)
|
|
244
|
readline_omit__names = Enum((0,1,2), default_value=0, config=True)
|
|
245
|
readline_remove_delims = Str('-/~', config=True)
|
|
245
|
readline_remove_delims = Str('-/~', config=True)
|
|
246
|
readline_parse_and_bind = List([
|
|
246
|
readline_parse_and_bind = List([
|
|
247
|
'tab: complete',
|
|
247
|
'tab: complete',
|
|
248
|
'"\C-l": possible-completions',
|
|
248
|
'"\C-l": possible-completions',
|
|
249
|
'set show-all-if-ambiguous on',
|
|
249
|
'set show-all-if-ambiguous on',
|
|
250
|
'"\C-o": tab-insert',
|
|
250
|
'"\C-o": tab-insert',
|
|
251
|
'"\M-i": " "',
|
|
251
|
'"\M-i": " "',
|
|
252
|
'"\M-o": "\d\d\d\d"',
|
|
252
|
'"\M-o": "\d\d\d\d"',
|
|
253
|
'"\M-I": "\d\d\d\d"',
|
|
253
|
'"\M-I": "\d\d\d\d"',
|
|
254
|
'"\C-r": reverse-search-history',
|
|
254
|
'"\C-r": reverse-search-history',
|
|
255
|
'"\C-s": forward-search-history',
|
|
255
|
'"\C-s": forward-search-history',
|
|
256
|
'"\C-p": history-search-backward',
|
|
256
|
'"\C-p": history-search-backward',
|
|
257
|
'"\C-n": history-search-forward',
|
|
257
|
'"\C-n": history-search-forward',
|
|
258
|
'"\e[A": history-search-backward',
|
|
258
|
'"\e[A": history-search-backward',
|
|
259
|
'"\e[B": history-search-forward',
|
|
259
|
'"\e[B": history-search-forward',
|
|
260
|
'"\C-k": kill-line',
|
|
260
|
'"\C-k": kill-line',
|
|
261
|
'"\C-u": unix-line-discard',
|
|
261
|
'"\C-u": unix-line-discard',
|
|
262
|
], allow_none=False, config=True)
|
|
262
|
], allow_none=False, config=True)
|
|
263
|
|
|
263
|
|
|
264
|
screen_length = Int(0, config=True)
|
|
264
|
screen_length = Int(0, config=True)
|
|
265
|
|
|
265
|
|
|
266
|
# Use custom TraitletTypes that convert '0'->'' and '\\n'->'\n'
|
|
266
|
# Use custom TraitletTypes that convert '0'->'' and '\\n'->'\n'
|
|
267
|
separate_in = SeparateStr('\n', config=True)
|
|
267
|
separate_in = SeparateStr('\n', config=True)
|
|
268
|
separate_out = SeparateStr('', config=True)
|
|
268
|
separate_out = SeparateStr('', config=True)
|
|
269
|
separate_out2 = SeparateStr('', config=True)
|
|
269
|
separate_out2 = SeparateStr('', config=True)
|
|
270
|
|
|
270
|
|
|
271
|
system_header = Str('IPython system call: ', config=True)
|
|
271
|
system_header = Str('IPython system call: ', config=True)
|
|
272
|
system_verbose = CBool(False, config=True)
|
|
272
|
system_verbose = CBool(False, config=True)
|
|
273
|
term_title = CBool(False, config=True)
|
|
273
|
term_title = CBool(False, config=True)
|
|
274
|
wildcards_case_sensitive = CBool(True, config=True)
|
|
274
|
wildcards_case_sensitive = CBool(True, config=True)
|
|
275
|
xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
|
|
275
|
xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
|
|
276
|
default_value='Context', config=True)
|
|
276
|
default_value='Context', config=True)
|
|
277
|
|
|
277
|
|
|
278
|
autoexec = List(allow_none=False)
|
|
278
|
autoexec = List(allow_none=False)
|
|
279
|
|
|
279
|
|
|
280
|
# class attribute to indicate whether the class supports threads or not.
|
|
280
|
# class attribute to indicate whether the class supports threads or not.
|
|
281
|
# Subclasses with thread support should override this as needed.
|
|
281
|
# Subclasses with thread support should override this as needed.
|
|
282
|
isthreaded = False
|
|
282
|
isthreaded = False
|
|
283
|
|
|
283
|
|
|
284
|
def __init__(self, parent=None, config=None, ipython_dir=None, usage=None,
|
|
284
|
def __init__(self, parent=None, config=None, ipython_dir=None, usage=None,
|
|
285
|
user_ns=None, user_global_ns=None,
|
|
285
|
user_ns=None, user_global_ns=None,
|
|
286
|
banner1=None, banner2=None, display_banner=None,
|
|
286
|
banner1=None, banner2=None, display_banner=None,
|
|
287
|
custom_exceptions=((),None)):
|
|
287
|
custom_exceptions=((),None)):
|
|
288
|
|
|
288
|
|
|
289
|
# This is where traitlets with a config_key argument are updated
|
|
289
|
# This is where traitlets with a config_key argument are updated
|
|
290
|
# from the values on config.
|
|
290
|
# from the values on config.
|
|
291
|
super(InteractiveShell, self).__init__(parent, config=config)
|
|
291
|
super(InteractiveShell, self).__init__(parent, config=config)
|
|
292
|
|
|
292
|
|
|
293
|
# These are relatively independent and stateless
|
|
293
|
# These are relatively independent and stateless
|
|
294
|
self.init_ipython_dir(ipython_dir)
|
|
294
|
self.init_ipython_dir(ipython_dir)
|
|
295
|
self.init_instance_attrs()
|
|
295
|
self.init_instance_attrs()
|
|
296
|
self.init_term_title()
|
|
296
|
self.init_term_title()
|
|
297
|
self.init_usage(usage)
|
|
297
|
self.init_usage(usage)
|
|
298
|
self.init_banner(banner1, banner2, display_banner)
|
|
298
|
self.init_banner(banner1, banner2, display_banner)
|
|
299
|
|
|
299
|
|
|
300
|
# Create namespaces (user_ns, user_global_ns, etc.)
|
|
300
|
# Create namespaces (user_ns, user_global_ns, etc.)
|
|
301
|
self.init_create_namespaces(user_ns, user_global_ns)
|
|
301
|
self.init_create_namespaces(user_ns, user_global_ns)
|
|
302
|
# This has to be done after init_create_namespaces because it uses
|
|
302
|
# This has to be done after init_create_namespaces because it uses
|
|
303
|
# something in self.user_ns, but before init_sys_modules, which
|
|
303
|
# something in self.user_ns, but before init_sys_modules, which
|
|
304
|
# is the first thing to modify sys.
|
|
304
|
# is the first thing to modify sys.
|
|
305
|
self.save_sys_module_state()
|
|
305
|
self.save_sys_module_state()
|
|
306
|
self.init_sys_modules()
|
|
306
|
self.init_sys_modules()
|
|
307
|
|
|
307
|
|
|
308
|
self.init_history()
|
|
308
|
self.init_history()
|
|
309
|
self.init_encoding()
|
|
309
|
self.init_encoding()
|
|
310
|
self.init_prefilter()
|
|
310
|
self.init_prefilter()
|
|
311
|
|
|
311
|
|
|
312
|
Magic.__init__(self, self)
|
|
312
|
Magic.__init__(self, self)
|
|
313
|
|
|
313
|
|
|
314
|
self.init_syntax_highlighting()
|
|
314
|
self.init_syntax_highlighting()
|
|
315
|
self.init_hooks()
|
|
315
|
self.init_hooks()
|
|
316
|
self.init_pushd_popd_magic()
|
|
316
|
self.init_pushd_popd_magic()
|
|
317
|
self.init_traceback_handlers(custom_exceptions)
|
|
317
|
self.init_traceback_handlers(custom_exceptions)
|
|
318
|
self.init_user_ns()
|
|
318
|
self.init_user_ns()
|
|
319
|
self.init_logger()
|
|
319
|
self.init_logger()
|
|
320
|
self.init_alias()
|
|
320
|
self.init_alias()
|
|
321
|
self.init_builtins()
|
|
321
|
self.init_builtins()
|
|
322
|
|
|
322
|
|
|
323
|
# pre_config_initialization
|
|
323
|
# pre_config_initialization
|
|
324
|
self.init_shadow_hist()
|
|
324
|
self.init_shadow_hist()
|
|
325
|
|
|
325
|
|
|
326
|
# The next section should contain averything that was in ipmaker.
|
|
326
|
# The next section should contain averything that was in ipmaker.
|
|
327
|
self.init_logstart()
|
|
327
|
self.init_logstart()
|
|
328
|
|
|
328
|
|
|
329
|
# The following was in post_config_initialization
|
|
329
|
# The following was in post_config_initialization
|
|
330
|
self.init_inspector()
|
|
330
|
self.init_inspector()
|
|
331
|
self.init_readline()
|
|
331
|
self.init_readline()
|
|
332
|
self.init_prompts()
|
|
332
|
self.init_prompts()
|
|
333
|
self.init_displayhook()
|
|
333
|
self.init_displayhook()
|
|
334
|
self.init_reload_doctest()
|
|
334
|
self.init_reload_doctest()
|
|
335
|
self.init_magics()
|
|
335
|
self.init_magics()
|
|
336
|
self.init_pdb()
|
|
336
|
self.init_pdb()
|
|
337
|
self.hooks.late_startup_hook()
|
|
337
|
self.hooks.late_startup_hook()
|
|
338
|
|
|
338
|
|
|
339
|
def get_ipython(self):
|
|
339
|
def get_ipython(self):
|
|
340
|
"""Return the currently running IPython instance."""
|
|
340
|
"""Return the currently running IPython instance."""
|
|
341
|
return self
|
|
341
|
return self
|
|
342
|
|
|
342
|
|
|
343
|
#-------------------------------------------------------------------------
|
|
343
|
#-------------------------------------------------------------------------
|
|
344
|
# Traitlet changed handlers
|
|
344
|
# Traitlet changed handlers
|
|
345
|
#-------------------------------------------------------------------------
|
|
345
|
#-------------------------------------------------------------------------
|
|
346
|
|
|
346
|
|
|
347
|
def _banner1_changed(self):
|
|
347
|
def _banner1_changed(self):
|
|
348
|
self.compute_banner()
|
|
348
|
self.compute_banner()
|
|
349
|
|
|
349
|
|
|
350
|
def _banner2_changed(self):
|
|
350
|
def _banner2_changed(self):
|
|
351
|
self.compute_banner()
|
|
351
|
self.compute_banner()
|
|
352
|
|
|
352
|
|
|
353
|
def _ipython_dir_changed(self, name, new):
|
|
353
|
def _ipython_dir_changed(self, name, new):
|
|
354
|
if not os.path.isdir(new):
|
|
354
|
if not os.path.isdir(new):
|
|
355
|
os.makedirs(new, mode = 0777)
|
|
355
|
os.makedirs(new, mode = 0777)
|
|
356
|
if not os.path.isdir(self.ipython_extension_dir):
|
|
356
|
if not os.path.isdir(self.ipython_extension_dir):
|
|
357
|
os.makedirs(self.ipython_extension_dir, mode = 0777)
|
|
357
|
os.makedirs(self.ipython_extension_dir, mode = 0777)
|
|
358
|
|
|
358
|
|
|
359
|
@property
|
|
359
|
@property
|
|
360
|
def ipython_extension_dir(self):
|
|
360
|
def ipython_extension_dir(self):
|
|
361
|
return os.path.join(self.ipython_dir, 'extensions')
|
|
361
|
return os.path.join(self.ipython_dir, 'extensions')
|
|
362
|
|
|
362
|
|
|
363
|
@property
|
|
363
|
@property
|
|
364
|
def usable_screen_length(self):
|
|
364
|
def usable_screen_length(self):
|
|
365
|
if self.screen_length == 0:
|
|
365
|
if self.screen_length == 0:
|
|
366
|
return 0
|
|
366
|
return 0
|
|
367
|
else:
|
|
367
|
else:
|
|
368
|
num_lines_bot = self.separate_in.count('\n')+1
|
|
368
|
num_lines_bot = self.separate_in.count('\n')+1
|
|
369
|
return self.screen_length - num_lines_bot
|
|
369
|
return self.screen_length - num_lines_bot
|
|
370
|
|
|
370
|
|
|
371
|
def _term_title_changed(self, name, new_value):
|
|
371
|
def _term_title_changed(self, name, new_value):
|
|
372
|
self.init_term_title()
|
|
372
|
self.init_term_title()
|
|
373
|
|
|
373
|
|
|
374
|
def set_autoindent(self,value=None):
|
|
374
|
def set_autoindent(self,value=None):
|
|
375
|
"""Set the autoindent flag, checking for readline support.
|
|
375
|
"""Set the autoindent flag, checking for readline support.
|
|
376
|
|
|
376
|
|
|
377
|
If called with no arguments, it acts as a toggle."""
|
|
377
|
If called with no arguments, it acts as a toggle."""
|
|
378
|
|
|
378
|
|
|
379
|
if not self.has_readline:
|
|
379
|
if not self.has_readline:
|
|
380
|
if os.name == 'posix':
|
|
380
|
if os.name == 'posix':
|
|
381
|
warn("The auto-indent feature requires the readline library")
|
|
381
|
warn("The auto-indent feature requires the readline library")
|
|
382
|
self.autoindent = 0
|
|
382
|
self.autoindent = 0
|
|
383
|
return
|
|
383
|
return
|
|
384
|
if value is None:
|
|
384
|
if value is None:
|
|
385
|
self.autoindent = not self.autoindent
|
|
385
|
self.autoindent = not self.autoindent
|
|
386
|
else:
|
|
386
|
else:
|
|
387
|
self.autoindent = value
|
|
387
|
self.autoindent = value
|
|
388
|
|
|
388
|
|
|
389
|
#-------------------------------------------------------------------------
|
|
389
|
#-------------------------------------------------------------------------
|
|
390
|
# init_* methods called by __init__
|
|
390
|
# init_* methods called by __init__
|
|
391
|
#-------------------------------------------------------------------------
|
|
391
|
#-------------------------------------------------------------------------
|
|
392
|
|
|
392
|
|
|
393
|
def init_ipython_dir(self, ipython_dir):
|
|
393
|
def init_ipython_dir(self, ipython_dir):
|
|
394
|
if ipython_dir is not None:
|
|
394
|
if ipython_dir is not None:
|
|
395
|
self.ipython_dir = ipython_dir
|
|
395
|
self.ipython_dir = ipython_dir
|
|
396
|
self.config.Global.ipython_dir = self.ipython_dir
|
|
396
|
self.config.Global.ipython_dir = self.ipython_dir
|
|
397
|
return
|
|
397
|
return
|
|
398
|
|
|
398
|
|
|
399
|
if hasattr(self.config.Global, 'ipython_dir'):
|
|
399
|
if hasattr(self.config.Global, 'ipython_dir'):
|
|
400
|
self.ipython_dir = self.config.Global.ipython_dir
|
|
400
|
self.ipython_dir = self.config.Global.ipython_dir
|
|
401
|
else:
|
|
401
|
else:
|
|
402
|
self.ipython_dir = get_ipython_dir()
|
|
402
|
self.ipython_dir = get_ipython_dir()
|
|
403
|
|
|
403
|
|
|
404
|
# All children can just read this
|
|
404
|
# All children can just read this
|
|
405
|
self.config.Global.ipython_dir = self.ipython_dir
|
|
405
|
self.config.Global.ipython_dir = self.ipython_dir
|
|
406
|
|
|
406
|
|
|
407
|
def init_instance_attrs(self):
|
|
407
|
def init_instance_attrs(self):
|
|
408
|
self.jobs = BackgroundJobManager()
|
|
408
|
self.jobs = BackgroundJobManager()
|
|
409
|
self.more = False
|
|
409
|
self.more = False
|
|
410
|
|
|
410
|
|
|
411
|
# command compiler
|
|
411
|
# command compiler
|
|
412
|
self.compile = codeop.CommandCompiler()
|
|
412
|
self.compile = codeop.CommandCompiler()
|
|
413
|
|
|
413
|
|
|
414
|
# User input buffer
|
|
414
|
# User input buffer
|
|
415
|
self.buffer = []
|
|
415
|
self.buffer = []
|
|
416
|
|
|
416
|
|
|
417
|
# Make an empty namespace, which extension writers can rely on both
|
|
417
|
# Make an empty namespace, which extension writers can rely on both
|
|
418
|
# existing and NEVER being used by ipython itself. This gives them a
|
|
418
|
# existing and NEVER being used by ipython itself. This gives them a
|
|
419
|
# convenient location for storing additional information and state
|
|
419
|
# convenient location for storing additional information and state
|
|
420
|
# their extensions may require, without fear of collisions with other
|
|
420
|
# their extensions may require, without fear of collisions with other
|
|
421
|
# ipython names that may develop later.
|
|
421
|
# ipython names that may develop later.
|
|
422
|
self.meta = Struct()
|
|
422
|
self.meta = Struct()
|
|
423
|
|
|
423
|
|
|
424
|
# Object variable to store code object waiting execution. This is
|
|
424
|
# Object variable to store code object waiting execution. This is
|
|
425
|
# used mainly by the multithreaded shells, but it can come in handy in
|
|
425
|
# used mainly by the multithreaded shells, but it can come in handy in
|
|
426
|
# other situations. No need to use a Queue here, since it's a single
|
|
426
|
# other situations. No need to use a Queue here, since it's a single
|
|
427
|
# item which gets cleared once run.
|
|
427
|
# item which gets cleared once run.
|
|
428
|
self.code_to_run = None
|
|
428
|
self.code_to_run = None
|
|
429
|
|
|
429
|
|
|
430
|
# Flag to mark unconditional exit
|
|
430
|
# Flag to mark unconditional exit
|
|
431
|
self.exit_now = False
|
|
431
|
self.exit_now = False
|
|
432
|
|
|
432
|
|
|
433
|
# Temporary files used for various purposes. Deleted at exit.
|
|
433
|
# Temporary files used for various purposes. Deleted at exit.
|
|
434
|
self.tempfiles = []
|
|
434
|
self.tempfiles = []
|
|
435
|
|
|
435
|
|
|
436
|
# Keep track of readline usage (later set by init_readline)
|
|
436
|
# Keep track of readline usage (later set by init_readline)
|
|
437
|
self.has_readline = False
|
|
437
|
self.has_readline = False
|
|
438
|
|
|
438
|
|
|
439
|
# keep track of where we started running (mainly for crash post-mortem)
|
|
439
|
# keep track of where we started running (mainly for crash post-mortem)
|
|
440
|
# This is not being used anywhere currently.
|
|
440
|
# This is not being used anywhere currently.
|
|
441
|
self.starting_dir = os.getcwd()
|
|
441
|
self.starting_dir = os.getcwd()
|
|
442
|
|
|
442
|
|
|
443
|
# Indentation management
|
|
443
|
# Indentation management
|
|
444
|
self.indent_current_nsp = 0
|
|
444
|
self.indent_current_nsp = 0
|
|
445
|
|
|
445
|
|
|
446
|
def init_term_title(self):
|
|
446
|
def init_term_title(self):
|
|
447
|
# Enable or disable the terminal title.
|
|
447
|
# Enable or disable the terminal title.
|
|
448
|
if self.term_title:
|
|
448
|
if self.term_title:
|
|
449
|
toggle_set_term_title(True)
|
|
449
|
toggle_set_term_title(True)
|
|
450
|
set_term_title('IPython: ' + abbrev_cwd())
|
|
450
|
set_term_title('IPython: ' + abbrev_cwd())
|
|
451
|
else:
|
|
451
|
else:
|
|
452
|
toggle_set_term_title(False)
|
|
452
|
toggle_set_term_title(False)
|
|
453
|
|
|
453
|
|
|
454
|
def init_usage(self, usage=None):
|
|
454
|
def init_usage(self, usage=None):
|
|
455
|
if usage is None:
|
|
455
|
if usage is None:
|
|
456
|
self.usage = interactive_usage
|
|
456
|
self.usage = interactive_usage
|
|
457
|
else:
|
|
457
|
else:
|
|
458
|
self.usage = usage
|
|
458
|
self.usage = usage
|
|
459
|
|
|
459
|
|
|
460
|
def init_encoding(self):
|
|
460
|
def init_encoding(self):
|
|
461
|
# Get system encoding at startup time. Certain terminals (like Emacs
|
|
461
|
# Get system encoding at startup time. Certain terminals (like Emacs
|
|
462
|
# under Win32 have it set to None, and we need to have a known valid
|
|
462
|
# under Win32 have it set to None, and we need to have a known valid
|
|
463
|
# encoding to use in the raw_input() method
|
|
463
|
# encoding to use in the raw_input() method
|
|
464
|
try:
|
|
464
|
try:
|
|
465
|
self.stdin_encoding = sys.stdin.encoding or 'ascii'
|
|
465
|
self.stdin_encoding = sys.stdin.encoding or 'ascii'
|
|
466
|
except AttributeError:
|
|
466
|
except AttributeError:
|
|
467
|
self.stdin_encoding = 'ascii'
|
|
467
|
self.stdin_encoding = 'ascii'
|
|
468
|
|
|
468
|
|
|
469
|
def init_syntax_highlighting(self):
|
|
469
|
def init_syntax_highlighting(self):
|
|
470
|
# Python source parser/formatter for syntax highlighting
|
|
470
|
# Python source parser/formatter for syntax highlighting
|
|
471
|
pyformat = PyColorize.Parser().format
|
|
471
|
pyformat = PyColorize.Parser().format
|
|
472
|
self.pycolorize = lambda src: pyformat(src,'str',self.colors)
|
|
472
|
self.pycolorize = lambda src: pyformat(src,'str',self.colors)
|
|
473
|
|
|
473
|
|
|
474
|
def init_pushd_popd_magic(self):
|
|
474
|
def init_pushd_popd_magic(self):
|
|
475
|
# for pushd/popd management
|
|
475
|
# for pushd/popd management
|
|
476
|
try:
|
|
476
|
try:
|
|
477
|
self.home_dir = get_home_dir()
|
|
477
|
self.home_dir = get_home_dir()
|
|
478
|
except HomeDirError, msg:
|
|
478
|
except HomeDirError, msg:
|
|
479
|
fatal(msg)
|
|
479
|
fatal(msg)
|
|
480
|
|
|
480
|
|
|
481
|
self.dir_stack = []
|
|
481
|
self.dir_stack = []
|
|
482
|
|
|
482
|
|
|
483
|
def init_logger(self):
|
|
483
|
def init_logger(self):
|
|
484
|
self.logger = Logger(self, logfname='ipython_log.py', logmode='rotate')
|
|
484
|
self.logger = Logger(self, logfname='ipython_log.py', logmode='rotate')
|
|
485
|
# local shortcut, this is used a LOT
|
|
485
|
# local shortcut, this is used a LOT
|
|
486
|
self.log = self.logger.log
|
|
486
|
self.log = self.logger.log
|
|
487
|
|
|
487
|
|
|
488
|
def init_logstart(self):
|
|
488
|
def init_logstart(self):
|
|
489
|
if self.logappend:
|
|
489
|
if self.logappend:
|
|
490
|
self.magic_logstart(self.logappend + ' append')
|
|
490
|
self.magic_logstart(self.logappend + ' append')
|
|
491
|
elif self.logfile:
|
|
491
|
elif self.logfile:
|
|
492
|
self.magic_logstart(self.logfile)
|
|
492
|
self.magic_logstart(self.logfile)
|
|
493
|
elif self.logstart:
|
|
493
|
elif self.logstart:
|
|
494
|
self.magic_logstart()
|
|
494
|
self.magic_logstart()
|
|
495
|
|
|
495
|
|
|
496
|
def init_builtins(self):
|
|
496
|
def init_builtins(self):
|
|
497
|
self.builtin_trap = BuiltinTrap(self)
|
|
497
|
self.builtin_trap = BuiltinTrap(self)
|
|
498
|
|
|
498
|
|
|
499
|
def init_inspector(self):
|
|
499
|
def init_inspector(self):
|
|
500
|
# Object inspector
|
|
500
|
# Object inspector
|
|
501
|
self.inspector = oinspect.Inspector(oinspect.InspectColors,
|
|
501
|
self.inspector = oinspect.Inspector(oinspect.InspectColors,
|
|
502
|
PyColorize.ANSICodeColors,
|
|
502
|
PyColorize.ANSICodeColors,
|
|
503
|
'NoColor',
|
|
503
|
'NoColor',
|
|
504
|
self.object_info_string_level)
|
|
504
|
self.object_info_string_level)
|
|
505
|
|
|
505
|
|
|
506
|
def init_prompts(self):
|
|
506
|
def init_prompts(self):
|
|
507
|
# Initialize cache, set in/out prompts and printing system
|
|
507
|
# Initialize cache, set in/out prompts and printing system
|
|
508
|
self.outputcache = CachedOutput(self,
|
|
508
|
self.outputcache = CachedOutput(self,
|
|
509
|
self.cache_size,
|
|
509
|
self.cache_size,
|
|
510
|
self.pprint,
|
|
510
|
self.pprint,
|
|
511
|
input_sep = self.separate_in,
|
|
511
|
input_sep = self.separate_in,
|
|
512
|
output_sep = self.separate_out,
|
|
512
|
output_sep = self.separate_out,
|
|
513
|
output_sep2 = self.separate_out2,
|
|
513
|
output_sep2 = self.separate_out2,
|
|
514
|
ps1 = self.prompt_in1,
|
|
514
|
ps1 = self.prompt_in1,
|
|
515
|
ps2 = self.prompt_in2,
|
|
515
|
ps2 = self.prompt_in2,
|
|
516
|
ps_out = self.prompt_out,
|
|
516
|
ps_out = self.prompt_out,
|
|
517
|
pad_left = self.prompts_pad_left)
|
|
517
|
pad_left = self.prompts_pad_left)
|
|
518
|
|
|
518
|
|
|
519
|
# user may have over-ridden the default print hook:
|
|
519
|
# user may have over-ridden the default print hook:
|
|
520
|
try:
|
|
520
|
try:
|
|
521
|
self.outputcache.__class__.display = self.hooks.display
|
|
521
|
self.outputcache.__class__.display = self.hooks.display
|
|
522
|
except AttributeError:
|
|
522
|
except AttributeError:
|
|
523
|
pass
|
|
523
|
pass
|
|
524
|
|
|
524
|
|
|
525
|
def init_displayhook(self):
|
|
525
|
def init_displayhook(self):
|
|
526
|
self.display_trap = DisplayTrap(self, self.outputcache)
|
|
526
|
self.display_trap = DisplayTrap(self, self.outputcache)
|
|
527
|
|
|
527
|
|
|
528
|
def init_reload_doctest(self):
|
|
528
|
def init_reload_doctest(self):
|
|
529
|
# Do a proper resetting of doctest, including the necessary displayhook
|
|
529
|
# Do a proper resetting of doctest, including the necessary displayhook
|
|
530
|
# monkeypatching
|
|
530
|
# monkeypatching
|
|
531
|
try:
|
|
531
|
try:
|
|
532
|
doctest_reload()
|
|
532
|
doctest_reload()
|
|
533
|
except ImportError:
|
|
533
|
except ImportError:
|
|
534
|
warn("doctest module does not exist.")
|
|
534
|
warn("doctest module does not exist.")
|
|
535
|
|
|
535
|
|
|
536
|
#-------------------------------------------------------------------------
|
|
536
|
#-------------------------------------------------------------------------
|
|
537
|
# Things related to the banner
|
|
537
|
# Things related to the banner
|
|
538
|
#-------------------------------------------------------------------------
|
|
538
|
#-------------------------------------------------------------------------
|
|
539
|
|
|
539
|
|
|
540
|
def init_banner(self, banner1, banner2, display_banner):
|
|
540
|
def init_banner(self, banner1, banner2, display_banner):
|
|
541
|
if banner1 is not None:
|
|
541
|
if banner1 is not None:
|
|
542
|
self.banner1 = banner1
|
|
542
|
self.banner1 = banner1
|
|
543
|
if banner2 is not None:
|
|
543
|
if banner2 is not None:
|
|
544
|
self.banner2 = banner2
|
|
544
|
self.banner2 = banner2
|
|
545
|
if display_banner is not None:
|
|
545
|
if display_banner is not None:
|
|
546
|
self.display_banner = display_banner
|
|
546
|
self.display_banner = display_banner
|
|
547
|
self.compute_banner()
|
|
547
|
self.compute_banner()
|
|
548
|
|
|
548
|
|
|
549
|
def show_banner(self, banner=None):
|
|
549
|
def show_banner(self, banner=None):
|
|
550
|
if banner is None:
|
|
550
|
if banner is None:
|
|
551
|
banner = self.banner
|
|
551
|
banner = self.banner
|
|
552
|
self.write(banner)
|
|
552
|
self.write(banner)
|
|
553
|
|
|
553
|
|
|
554
|
def compute_banner(self):
|
|
554
|
def compute_banner(self):
|
|
555
|
self.banner = self.banner1 + '\n'
|
|
555
|
self.banner = self.banner1 + '\n'
|
|
556
|
if self.profile:
|
|
556
|
if self.profile:
|
|
557
|
self.banner += '\nIPython profile: %s\n' % self.profile
|
|
557
|
self.banner += '\nIPython profile: %s\n' % self.profile
|
|
558
|
if self.banner2:
|
|
558
|
if self.banner2:
|
|
559
|
self.banner += '\n' + self.banner2 + '\n'
|
|
559
|
self.banner += '\n' + self.banner2 + '\n'
|
|
560
|
|
|
560
|
|
|
561
|
#-------------------------------------------------------------------------
|
|
561
|
#-------------------------------------------------------------------------
|
|
562
|
# Things related to injections into the sys module
|
|
562
|
# Things related to injections into the sys module
|
|
563
|
#-------------------------------------------------------------------------
|
|
563
|
#-------------------------------------------------------------------------
|
|
564
|
|
|
564
|
|
|
565
|
def save_sys_module_state(self):
|
|
565
|
def save_sys_module_state(self):
|
|
566
|
"""Save the state of hooks in the sys module.
|
|
566
|
"""Save the state of hooks in the sys module.
|
|
567
|
|
|
567
|
|
|
568
|
This has to be called after self.user_ns is created.
|
|
568
|
This has to be called after self.user_ns is created.
|
|
569
|
"""
|
|
569
|
"""
|
|
570
|
self._orig_sys_module_state = {}
|
|
570
|
self._orig_sys_module_state = {}
|
|
571
|
self._orig_sys_module_state['stdin'] = sys.stdin
|
|
571
|
self._orig_sys_module_state['stdin'] = sys.stdin
|
|
572
|
self._orig_sys_module_state['stdout'] = sys.stdout
|
|
572
|
self._orig_sys_module_state['stdout'] = sys.stdout
|
|
573
|
self._orig_sys_module_state['stderr'] = sys.stderr
|
|
573
|
self._orig_sys_module_state['stderr'] = sys.stderr
|
|
574
|
self._orig_sys_module_state['excepthook'] = sys.excepthook
|
|
574
|
self._orig_sys_module_state['excepthook'] = sys.excepthook
|
|
575
|
try:
|
|
575
|
try:
|
|
576
|
self._orig_sys_modules_main_name = self.user_ns['__name__']
|
|
576
|
self._orig_sys_modules_main_name = self.user_ns['__name__']
|
|
577
|
except KeyError:
|
|
577
|
except KeyError:
|
|
578
|
pass
|
|
578
|
pass
|
|
579
|
|
|
579
|
|
|
580
|
def restore_sys_module_state(self):
|
|
580
|
def restore_sys_module_state(self):
|
|
581
|
"""Restore the state of the sys module."""
|
|
581
|
"""Restore the state of the sys module."""
|
|
582
|
try:
|
|
582
|
try:
|
|
583
|
for k, v in self._orig_sys_module_state.items():
|
|
583
|
for k, v in self._orig_sys_module_state.items():
|
|
584
|
setattr(sys, k, v)
|
|
584
|
setattr(sys, k, v)
|
|
585
|
except AttributeError:
|
|
585
|
except AttributeError:
|
|
586
|
pass
|
|
586
|
pass
|
|
587
|
try:
|
|
587
|
try:
|
|
588
|
delattr(sys, 'ipcompleter')
|
|
588
|
delattr(sys, 'ipcompleter')
|
|
589
|
except AttributeError:
|
|
589
|
except AttributeError:
|
|
590
|
pass
|
|
590
|
pass
|
|
591
|
# Reset what what done in self.init_sys_modules
|
|
591
|
# Reset what what done in self.init_sys_modules
|
|
592
|
try:
|
|
592
|
try:
|
|
593
|
sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
|
|
593
|
sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
|
|
594
|
except (AttributeError, KeyError):
|
|
594
|
except (AttributeError, KeyError):
|
|
595
|
pass
|
|
595
|
pass
|
|
596
|
|
|
596
|
|
|
597
|
#-------------------------------------------------------------------------
|
|
597
|
#-------------------------------------------------------------------------
|
|
598
|
# Things related to hooks
|
|
598
|
# Things related to hooks
|
|
599
|
#-------------------------------------------------------------------------
|
|
599
|
#-------------------------------------------------------------------------
|
|
600
|
|
|
600
|
|
|
601
|
def init_hooks(self):
|
|
601
|
def init_hooks(self):
|
|
602
|
# hooks holds pointers used for user-side customizations
|
|
602
|
# hooks holds pointers used for user-side customizations
|
|
603
|
self.hooks = Struct()
|
|
603
|
self.hooks = Struct()
|
|
604
|
|
|
604
|
|
|
605
|
self.strdispatchers = {}
|
|
605
|
self.strdispatchers = {}
|
|
606
|
|
|
606
|
|
|
607
|
# Set all default hooks, defined in the IPython.hooks module.
|
|
607
|
# Set all default hooks, defined in the IPython.hooks module.
|
|
608
|
hooks = IPython.core.hooks
|
|
608
|
hooks = IPython.core.hooks
|
|
609
|
for hook_name in hooks.__all__:
|
|
609
|
for hook_name in hooks.__all__:
|
|
610
|
# default hooks have priority 100, i.e. low; user hooks should have
|
|
610
|
# default hooks have priority 100, i.e. low; user hooks should have
|
|
611
|
# 0-100 priority
|
|
611
|
# 0-100 priority
|
|
612
|
self.set_hook(hook_name,getattr(hooks,hook_name), 100)
|
|
612
|
self.set_hook(hook_name,getattr(hooks,hook_name), 100)
|
|
613
|
|
|
613
|
|
|
614
|
def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
|
|
614
|
def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
|
|
615
|
"""set_hook(name,hook) -> sets an internal IPython hook.
|
|
615
|
"""set_hook(name,hook) -> sets an internal IPython hook.
|
|
616
|
|
|
616
|
|
|
617
|
IPython exposes some of its internal API as user-modifiable hooks. By
|
|
617
|
IPython exposes some of its internal API as user-modifiable hooks. By
|
|
618
|
adding your function to one of these hooks, you can modify IPython's
|
|
618
|
adding your function to one of these hooks, you can modify IPython's
|
|
619
|
behavior to call at runtime your own routines."""
|
|
619
|
behavior to call at runtime your own routines."""
|
|
620
|
|
|
620
|
|
|
621
|
# At some point in the future, this should validate the hook before it
|
|
621
|
# At some point in the future, this should validate the hook before it
|
|
622
|
# accepts it. Probably at least check that the hook takes the number
|
|
622
|
# accepts it. Probably at least check that the hook takes the number
|
|
623
|
# of args it's supposed to.
|
|
623
|
# of args it's supposed to.
|
|
624
|
|
|
624
|
|
|
625
|
f = new.instancemethod(hook,self,self.__class__)
|
|
625
|
f = new.instancemethod(hook,self,self.__class__)
|
|
626
|
|
|
626
|
|
|
627
|
# check if the hook is for strdispatcher first
|
|
627
|
# check if the hook is for strdispatcher first
|
|
628
|
if str_key is not None:
|
|
628
|
if str_key is not None:
|
|
629
|
sdp = self.strdispatchers.get(name, StrDispatch())
|
|
629
|
sdp = self.strdispatchers.get(name, StrDispatch())
|
|
630
|
sdp.add_s(str_key, f, priority )
|
|
630
|
sdp.add_s(str_key, f, priority )
|
|
631
|
self.strdispatchers[name] = sdp
|
|
631
|
self.strdispatchers[name] = sdp
|
|
632
|
return
|
|
632
|
return
|
|
633
|
if re_key is not None:
|
|
633
|
if re_key is not None:
|
|
634
|
sdp = self.strdispatchers.get(name, StrDispatch())
|
|
634
|
sdp = self.strdispatchers.get(name, StrDispatch())
|
|
635
|
sdp.add_re(re.compile(re_key), f, priority )
|
|
635
|
sdp.add_re(re.compile(re_key), f, priority )
|
|
636
|
self.strdispatchers[name] = sdp
|
|
636
|
self.strdispatchers[name] = sdp
|
|
637
|
return
|
|
637
|
return
|
|
638
|
|
|
638
|
|
|
639
|
dp = getattr(self.hooks, name, None)
|
|
639
|
dp = getattr(self.hooks, name, None)
|
|
640
|
if name not in IPython.core.hooks.__all__:
|
|
640
|
if name not in IPython.core.hooks.__all__:
|
|
641
|
print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ )
|
|
641
|
print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ )
|
|
642
|
if not dp:
|
|
642
|
if not dp:
|
|
643
|
dp = IPython.core.hooks.CommandChainDispatcher()
|
|
643
|
dp = IPython.core.hooks.CommandChainDispatcher()
|
|
644
|
|
|
644
|
|
|
645
|
try:
|
|
645
|
try:
|
|
646
|
dp.add(f,priority)
|
|
646
|
dp.add(f,priority)
|
|
647
|
except AttributeError:
|
|
647
|
except AttributeError:
|
|
648
|
# it was not commandchain, plain old func - replace
|
|
648
|
# it was not commandchain, plain old func - replace
|
|
649
|
dp = f
|
|
649
|
dp = f
|
|
650
|
|
|
650
|
|
|
651
|
setattr(self.hooks,name, dp)
|
|
651
|
setattr(self.hooks,name, dp)
|
|
652
|
|
|
652
|
|
|
653
|
#-------------------------------------------------------------------------
|
|
653
|
#-------------------------------------------------------------------------
|
|
654
|
# Things related to the "main" module
|
|
654
|
# Things related to the "main" module
|
|
655
|
#-------------------------------------------------------------------------
|
|
655
|
#-------------------------------------------------------------------------
|
|
656
|
|
|
656
|
|
|
657
|
def new_main_mod(self,ns=None):
|
|
657
|
def new_main_mod(self,ns=None):
|
|
658
|
"""Return a new 'main' module object for user code execution.
|
|
658
|
"""Return a new 'main' module object for user code execution.
|
|
659
|
"""
|
|
659
|
"""
|
|
660
|
main_mod = self._user_main_module
|
|
660
|
main_mod = self._user_main_module
|
|
661
|
init_fakemod_dict(main_mod,ns)
|
|
661
|
init_fakemod_dict(main_mod,ns)
|
|
662
|
return main_mod
|
|
662
|
return main_mod
|
|
663
|
|
|
663
|
|
|
664
|
def cache_main_mod(self,ns,fname):
|
|
664
|
def cache_main_mod(self,ns,fname):
|
|
665
|
"""Cache a main module's namespace.
|
|
665
|
"""Cache a main module's namespace.
|
|
666
|
|
|
666
|
|
|
667
|
When scripts are executed via %run, we must keep a reference to the
|
|
667
|
When scripts are executed via %run, we must keep a reference to the
|
|
668
|
namespace of their __main__ module (a FakeModule instance) around so
|
|
668
|
namespace of their __main__ module (a FakeModule instance) around so
|
|
669
|
that Python doesn't clear it, rendering objects defined therein
|
|
669
|
that Python doesn't clear it, rendering objects defined therein
|
|
670
|
useless.
|
|
670
|
useless.
|
|
671
|
|
|
671
|
|
|
672
|
This method keeps said reference in a private dict, keyed by the
|
|
672
|
This method keeps said reference in a private dict, keyed by the
|
|
673
|
absolute path of the module object (which corresponds to the script
|
|
673
|
absolute path of the module object (which corresponds to the script
|
|
674
|
path). This way, for multiple executions of the same script we only
|
|
674
|
path). This way, for multiple executions of the same script we only
|
|
675
|
keep one copy of the namespace (the last one), thus preventing memory
|
|
675
|
keep one copy of the namespace (the last one), thus preventing memory
|
|
676
|
leaks from old references while allowing the objects from the last
|
|
676
|
leaks from old references while allowing the objects from the last
|
|
677
|
execution to be accessible.
|
|
677
|
execution to be accessible.
|
|
678
|
|
|
678
|
|
|
679
|
Note: we can not allow the actual FakeModule instances to be deleted,
|
|
679
|
Note: we can not allow the actual FakeModule instances to be deleted,
|
|
680
|
because of how Python tears down modules (it hard-sets all their
|
|
680
|
because of how Python tears down modules (it hard-sets all their
|
|
681
|
references to None without regard for reference counts). This method
|
|
681
|
references to None without regard for reference counts). This method
|
|
682
|
must therefore make a *copy* of the given namespace, to allow the
|
|
682
|
must therefore make a *copy* of the given namespace, to allow the
|
|
683
|
original module's __dict__ to be cleared and reused.
|
|
683
|
original module's __dict__ to be cleared and reused.
|
|
684
|
|
|
684
|
|
|
685
|
|
|
685
|
|
|
686
|
Parameters
|
|
686
|
Parameters
|
|
687
|
----------
|
|
687
|
----------
|
|
688
|
ns : a namespace (a dict, typically)
|
|
688
|
ns : a namespace (a dict, typically)
|
|
689
|
|
|
689
|
|
|
690
|
fname : str
|
|
690
|
fname : str
|
|
691
|
Filename associated with the namespace.
|
|
691
|
Filename associated with the namespace.
|
|
692
|
|
|
692
|
|
|
693
|
Examples
|
|
693
|
Examples
|
|
694
|
--------
|
|
694
|
--------
|
|
695
|
|
|
695
|
|
|
696
|
In [10]: import IPython
|
|
696
|
In [10]: import IPython
|
|
697
|
|
|
697
|
|
|
698
|
In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
|
|
698
|
In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
|
|
699
|
|
|
699
|
|
|
700
|
In [12]: IPython.__file__ in _ip._main_ns_cache
|
|
700
|
In [12]: IPython.__file__ in _ip._main_ns_cache
|
|
701
|
Out[12]: True
|
|
701
|
Out[12]: True
|
|
702
|
"""
|
|
702
|
"""
|
|
703
|
self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
|
|
703
|
self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
|
|
704
|
|
|
704
|
|
|
705
|
def clear_main_mod_cache(self):
|
|
705
|
def clear_main_mod_cache(self):
|
|
706
|
"""Clear the cache of main modules.
|
|
706
|
"""Clear the cache of main modules.
|
|
707
|
|
|
707
|
|
|
708
|
Mainly for use by utilities like %reset.
|
|
708
|
Mainly for use by utilities like %reset.
|
|
709
|
|
|
709
|
|
|
710
|
Examples
|
|
710
|
Examples
|
|
711
|
--------
|
|
711
|
--------
|
|
712
|
|
|
712
|
|
|
713
|
In [15]: import IPython
|
|
713
|
In [15]: import IPython
|
|
714
|
|
|
714
|
|
|
715
|
In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
|
|
715
|
In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
|
|
716
|
|
|
716
|
|
|
717
|
In [17]: len(_ip._main_ns_cache) > 0
|
|
717
|
In [17]: len(_ip._main_ns_cache) > 0
|
|
718
|
Out[17]: True
|
|
718
|
Out[17]: True
|
|
719
|
|
|
719
|
|
|
720
|
In [18]: _ip.clear_main_mod_cache()
|
|
720
|
In [18]: _ip.clear_main_mod_cache()
|
|
721
|
|
|
721
|
|
|
722
|
In [19]: len(_ip._main_ns_cache) == 0
|
|
722
|
In [19]: len(_ip._main_ns_cache) == 0
|
|
723
|
Out[19]: True
|
|
723
|
Out[19]: True
|
|
724
|
"""
|
|
724
|
"""
|
|
725
|
self._main_ns_cache.clear()
|
|
725
|
self._main_ns_cache.clear()
|
|
726
|
|
|
726
|
|
|
727
|
#-------------------------------------------------------------------------
|
|
727
|
#-------------------------------------------------------------------------
|
|
728
|
# Things related to debugging
|
|
728
|
# Things related to debugging
|
|
729
|
#-------------------------------------------------------------------------
|
|
729
|
#-------------------------------------------------------------------------
|
|
730
|
|
|
730
|
|
|
731
|
def init_pdb(self):
|
|
731
|
def init_pdb(self):
|
|
732
|
# Set calling of pdb on exceptions
|
|
732
|
# Set calling of pdb on exceptions
|
|
733
|
# self.call_pdb is a property
|
|
733
|
# self.call_pdb is a property
|
|
734
|
self.call_pdb = self.pdb
|
|
734
|
self.call_pdb = self.pdb
|
|
735
|
|
|
735
|
|
|
736
|
def _get_call_pdb(self):
|
|
736
|
def _get_call_pdb(self):
|
|
737
|
return self._call_pdb
|
|
737
|
return self._call_pdb
|
|
738
|
|
|
738
|
|
|
739
|
def _set_call_pdb(self,val):
|
|
739
|
def _set_call_pdb(self,val):
|
|
740
|
|
|
740
|
|
|
741
|
if val not in (0,1,False,True):
|
|
741
|
if val not in (0,1,False,True):
|
|
742
|
raise ValueError,'new call_pdb value must be boolean'
|
|
742
|
raise ValueError,'new call_pdb value must be boolean'
|
|
743
|
|
|
743
|
|
|
744
|
# store value in instance
|
|
744
|
# store value in instance
|
|
745
|
self._call_pdb = val
|
|
745
|
self._call_pdb = val
|
|
746
|
|
|
746
|
|
|
747
|
# notify the actual exception handlers
|
|
747
|
# notify the actual exception handlers
|
|
748
|
self.InteractiveTB.call_pdb = val
|
|
748
|
self.InteractiveTB.call_pdb = val
|
|
749
|
if self.isthreaded:
|
|
749
|
if self.isthreaded:
|
|
750
|
try:
|
|
750
|
try:
|
|
751
|
self.sys_excepthook.call_pdb = val
|
|
751
|
self.sys_excepthook.call_pdb = val
|
|
752
|
except:
|
|
752
|
except:
|
|
753
|
warn('Failed to activate pdb for threaded exception handler')
|
|
753
|
warn('Failed to activate pdb for threaded exception handler')
|
|
754
|
|
|
754
|
|
|
755
|
call_pdb = property(_get_call_pdb,_set_call_pdb,None,
|
|
755
|
call_pdb = property(_get_call_pdb,_set_call_pdb,None,
|
|
756
|
'Control auto-activation of pdb at exceptions')
|
|
756
|
'Control auto-activation of pdb at exceptions')
|
|
757
|
|
|
757
|
|
|
758
|
def debugger(self,force=False):
|
|
758
|
def debugger(self,force=False):
|
|
759
|
"""Call the pydb/pdb debugger.
|
|
759
|
"""Call the pydb/pdb debugger.
|
|
760
|
|
|
760
|
|
|
761
|
Keywords:
|
|
761
|
Keywords:
|
|
762
|
|
|
762
|
|
|
763
|
- force(False): by default, this routine checks the instance call_pdb
|
|
763
|
- force(False): by default, this routine checks the instance call_pdb
|
|
764
|
flag and does not actually invoke the debugger if the flag is false.
|
|
764
|
flag and does not actually invoke the debugger if the flag is false.
|
|
765
|
The 'force' option forces the debugger to activate even if the flag
|
|
765
|
The 'force' option forces the debugger to activate even if the flag
|
|
766
|
is false.
|
|
766
|
is false.
|
|
767
|
"""
|
|
767
|
"""
|
|
768
|
|
|
768
|
|
|
769
|
if not (force or self.call_pdb):
|
|
769
|
if not (force or self.call_pdb):
|
|
770
|
return
|
|
770
|
return
|
|
771
|
|
|
771
|
|
|
772
|
if not hasattr(sys,'last_traceback'):
|
|
772
|
if not hasattr(sys,'last_traceback'):
|
|
773
|
error('No traceback has been produced, nothing to debug.')
|
|
773
|
error('No traceback has been produced, nothing to debug.')
|
|
774
|
return
|
|
774
|
return
|
|
775
|
|
|
775
|
|
|
776
|
# use pydb if available
|
|
776
|
# use pydb if available
|
|
777
|
if debugger.has_pydb:
|
|
777
|
if debugger.has_pydb:
|
|
778
|
from pydb import pm
|
|
778
|
from pydb import pm
|
|
779
|
else:
|
|
779
|
else:
|
|
780
|
# fallback to our internal debugger
|
|
780
|
# fallback to our internal debugger
|
|
781
|
pm = lambda : self.InteractiveTB.debugger(force=True)
|
|
781
|
pm = lambda : self.InteractiveTB.debugger(force=True)
|
|
782
|
self.history_saving_wrapper(pm)()
|
|
782
|
self.history_saving_wrapper(pm)()
|
|
783
|
|
|
783
|
|
|
784
|
#-------------------------------------------------------------------------
|
|
784
|
#-------------------------------------------------------------------------
|
|
785
|
# Things related to IPython's various namespaces
|
|
785
|
# Things related to IPython's various namespaces
|
|
786
|
#-------------------------------------------------------------------------
|
|
786
|
#-------------------------------------------------------------------------
|
|
787
|
|
|
787
|
|
|
788
|
def init_create_namespaces(self, user_ns=None, user_global_ns=None):
|
|
788
|
def init_create_namespaces(self, user_ns=None, user_global_ns=None):
|
|
789
|
# Create the namespace where the user will operate. user_ns is
|
|
789
|
# Create the namespace where the user will operate. user_ns is
|
|
790
|
# normally the only one used, and it is passed to the exec calls as
|
|
790
|
# normally the only one used, and it is passed to the exec calls as
|
|
791
|
# the locals argument. But we do carry a user_global_ns namespace
|
|
791
|
# the locals argument. But we do carry a user_global_ns namespace
|
|
792
|
# given as the exec 'globals' argument, This is useful in embedding
|
|
792
|
# given as the exec 'globals' argument, This is useful in embedding
|
|
793
|
# situations where the ipython shell opens in a context where the
|
|
793
|
# situations where the ipython shell opens in a context where the
|
|
794
|
# distinction between locals and globals is meaningful. For
|
|
794
|
# distinction between locals and globals is meaningful. For
|
|
795
|
# non-embedded contexts, it is just the same object as the user_ns dict.
|
|
795
|
# non-embedded contexts, it is just the same object as the user_ns dict.
|
|
796
|
|
|
796
|
|
|
797
|
# FIXME. For some strange reason, __builtins__ is showing up at user
|
|
797
|
# FIXME. For some strange reason, __builtins__ is showing up at user
|
|
798
|
# level as a dict instead of a module. This is a manual fix, but I
|
|
798
|
# level as a dict instead of a module. This is a manual fix, but I
|
|
799
|
# should really track down where the problem is coming from. Alex
|
|
799
|
# should really track down where the problem is coming from. Alex
|
|
800
|
# Schmolck reported this problem first.
|
|
800
|
# Schmolck reported this problem first.
|
|
801
|
|
|
801
|
|
|
802
|
# A useful post by Alex Martelli on this topic:
|
|
802
|
# A useful post by Alex Martelli on this topic:
|
|
803
|
# Re: inconsistent value from __builtins__
|
|
803
|
# Re: inconsistent value from __builtins__
|
|
804
|
# Von: Alex Martelli <aleaxit@yahoo.com>
|
|
804
|
# Von: Alex Martelli <aleaxit@yahoo.com>
|
|
805
|
# Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
|
|
805
|
# Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
|
|
806
|
# Gruppen: comp.lang.python
|
|
806
|
# Gruppen: comp.lang.python
|
|
807
|
|
|
807
|
|
|
808
|
# Michael Hohn <hohn@hooknose.lbl.gov> wrote:
|
|
808
|
# Michael Hohn <hohn@hooknose.lbl.gov> wrote:
|
|
809
|
# > >>> print type(builtin_check.get_global_binding('__builtins__'))
|
|
809
|
# > >>> print type(builtin_check.get_global_binding('__builtins__'))
|
|
810
|
# > <type 'dict'>
|
|
810
|
# > <type 'dict'>
|
|
811
|
# > >>> print type(__builtins__)
|
|
811
|
# > >>> print type(__builtins__)
|
|
812
|
# > <type 'module'>
|
|
812
|
# > <type 'module'>
|
|
813
|
# > Is this difference in return value intentional?
|
|
813
|
# > Is this difference in return value intentional?
|
|
814
|
|
|
814
|
|
|
815
|
# Well, it's documented that '__builtins__' can be either a dictionary
|
|
815
|
# Well, it's documented that '__builtins__' can be either a dictionary
|
|
816
|
# or a module, and it's been that way for a long time. Whether it's
|
|
816
|
# or a module, and it's been that way for a long time. Whether it's
|
|
817
|
# intentional (or sensible), I don't know. In any case, the idea is
|
|
817
|
# intentional (or sensible), I don't know. In any case, the idea is
|
|
818
|
# that if you need to access the built-in namespace directly, you
|
|
818
|
# that if you need to access the built-in namespace directly, you
|
|
819
|
# should start with "import __builtin__" (note, no 's') which will
|
|
819
|
# should start with "import __builtin__" (note, no 's') which will
|
|
820
|
# definitely give you a module. Yeah, it's somewhat confusing:-(.
|
|
820
|
# definitely give you a module. Yeah, it's somewhat confusing:-(.
|
|
821
|
|
|
821
|
|
|
822
|
# These routines return properly built dicts as needed by the rest of
|
|
822
|
# These routines return properly built dicts as needed by the rest of
|
|
823
|
# the code, and can also be used by extension writers to generate
|
|
823
|
# the code, and can also be used by extension writers to generate
|
|
824
|
# properly initialized namespaces.
|
|
824
|
# properly initialized namespaces.
|
|
825
|
user_ns, user_global_ns = self.make_user_namespaces(user_ns, user_global_ns)
|
|
825
|
user_ns, user_global_ns = self.make_user_namespaces(user_ns, user_global_ns)
|
|
826
|
|
|
826
|
|
|
827
|
# Assign namespaces
|
|
827
|
# Assign namespaces
|
|
828
|
# This is the namespace where all normal user variables live
|
|
828
|
# This is the namespace where all normal user variables live
|
|
829
|
self.user_ns = user_ns
|
|
829
|
self.user_ns = user_ns
|
|
830
|
self.user_global_ns = user_global_ns
|
|
830
|
self.user_global_ns = user_global_ns
|
|
831
|
|
|
831
|
|
|
832
|
# An auxiliary namespace that checks what parts of the user_ns were
|
|
832
|
# An auxiliary namespace that checks what parts of the user_ns were
|
|
833
|
# loaded at startup, so we can list later only variables defined in
|
|
833
|
# loaded at startup, so we can list later only variables defined in
|
|
834
|
# actual interactive use. Since it is always a subset of user_ns, it
|
|
834
|
# actual interactive use. Since it is always a subset of user_ns, it
|
|
835
|
# doesn't need to be separately tracked in the ns_table.
|
|
835
|
# doesn't need to be separately tracked in the ns_table.
|
|
836
|
self.user_config_ns = {}
|
|
836
|
self.user_ns_hidden = {}
|
|
837
|
|
|
837
|
|
|
838
|
# A namespace to keep track of internal data structures to prevent
|
|
838
|
# A namespace to keep track of internal data structures to prevent
|
|
839
|
# them from cluttering user-visible stuff. Will be updated later
|
|
839
|
# them from cluttering user-visible stuff. Will be updated later
|
|
840
|
self.internal_ns = {}
|
|
840
|
self.internal_ns = {}
|
|
841
|
|
|
841
|
|
|
842
|
# Now that FakeModule produces a real module, we've run into a nasty
|
|
842
|
# Now that FakeModule produces a real module, we've run into a nasty
|
|
843
|
# problem: after script execution (via %run), the module where the user
|
|
843
|
# problem: after script execution (via %run), the module where the user
|
|
844
|
# code ran is deleted. Now that this object is a true module (needed
|
|
844
|
# code ran is deleted. Now that this object is a true module (needed
|
|
845
|
# so docetst and other tools work correctly), the Python module
|
|
845
|
# so docetst and other tools work correctly), the Python module
|
|
846
|
# teardown mechanism runs over it, and sets to None every variable
|
|
846
|
# teardown mechanism runs over it, and sets to None every variable
|
|
847
|
# present in that module. Top-level references to objects from the
|
|
847
|
# present in that module. Top-level references to objects from the
|
|
848
|
# script survive, because the user_ns is updated with them. However,
|
|
848
|
# script survive, because the user_ns is updated with them. However,
|
|
849
|
# calling functions defined in the script that use other things from
|
|
849
|
# calling functions defined in the script that use other things from
|
|
850
|
# the script will fail, because the function's closure had references
|
|
850
|
# the script will fail, because the function's closure had references
|
|
851
|
# to the original objects, which are now all None. So we must protect
|
|
851
|
# to the original objects, which are now all None. So we must protect
|
|
852
|
# these modules from deletion by keeping a cache.
|
|
852
|
# these modules from deletion by keeping a cache.
|
|
853
|
#
|
|
853
|
#
|
|
854
|
# To avoid keeping stale modules around (we only need the one from the
|
|
854
|
# To avoid keeping stale modules around (we only need the one from the
|
|
855
|
# last run), we use a dict keyed with the full path to the script, so
|
|
855
|
# last run), we use a dict keyed with the full path to the script, so
|
|
856
|
# only the last version of the module is held in the cache. Note,
|
|
856
|
# only the last version of the module is held in the cache. Note,
|
|
857
|
# however, that we must cache the module *namespace contents* (their
|
|
857
|
# however, that we must cache the module *namespace contents* (their
|
|
858
|
# __dict__). Because if we try to cache the actual modules, old ones
|
|
858
|
# __dict__). Because if we try to cache the actual modules, old ones
|
|
859
|
# (uncached) could be destroyed while still holding references (such as
|
|
859
|
# (uncached) could be destroyed while still holding references (such as
|
|
860
|
# those held by GUI objects that tend to be long-lived)>
|
|
860
|
# those held by GUI objects that tend to be long-lived)>
|
|
861
|
#
|
|
861
|
#
|
|
862
|
# The %reset command will flush this cache. See the cache_main_mod()
|
|
862
|
# The %reset command will flush this cache. See the cache_main_mod()
|
|
863
|
# and clear_main_mod_cache() methods for details on use.
|
|
863
|
# and clear_main_mod_cache() methods for details on use.
|
|
864
|
|
|
864
|
|
|
865
|
# This is the cache used for 'main' namespaces
|
|
865
|
# This is the cache used for 'main' namespaces
|
|
866
|
self._main_ns_cache = {}
|
|
866
|
self._main_ns_cache = {}
|
|
867
|
# And this is the single instance of FakeModule whose __dict__ we keep
|
|
867
|
# And this is the single instance of FakeModule whose __dict__ we keep
|
|
868
|
# copying and clearing for reuse on each %run
|
|
868
|
# copying and clearing for reuse on each %run
|
|
869
|
self._user_main_module = FakeModule()
|
|
869
|
self._user_main_module = FakeModule()
|
|
870
|
|
|
870
|
|
|
871
|
# A table holding all the namespaces IPython deals with, so that
|
|
871
|
# A table holding all the namespaces IPython deals with, so that
|
|
872
|
# introspection facilities can search easily.
|
|
872
|
# introspection facilities can search easily.
|
|
873
|
self.ns_table = {'user':user_ns,
|
|
873
|
self.ns_table = {'user':user_ns,
|
|
874
|
'user_global':user_global_ns,
|
|
874
|
'user_global':user_global_ns,
|
|
875
|
'internal':self.internal_ns,
|
|
875
|
'internal':self.internal_ns,
|
|
876
|
'builtin':__builtin__.__dict__
|
|
876
|
'builtin':__builtin__.__dict__
|
|
877
|
}
|
|
877
|
}
|
|
878
|
|
|
878
|
|
|
879
|
# Similarly, track all namespaces where references can be held and that
|
|
879
|
# Similarly, track all namespaces where references can be held and that
|
|
880
|
# we can safely clear (so it can NOT include builtin). This one can be
|
|
880
|
# we can safely clear (so it can NOT include builtin). This one can be
|
|
881
|
# a simple list.
|
|
881
|
# a simple list.
|
|
882
|
self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns,
|
|
882
|
self.ns_refs_table = [ user_ns, user_global_ns, self.user_ns_hidden,
|
|
883
|
self.internal_ns, self._main_ns_cache ]
|
|
883
|
self.internal_ns, self._main_ns_cache ]
|
|
884
|
|
|
884
|
|
|
885
|
def make_user_namespaces(self, user_ns=None, user_global_ns=None):
|
|
885
|
def make_user_namespaces(self, user_ns=None, user_global_ns=None):
|
|
886
|
"""Return a valid local and global user interactive namespaces.
|
|
886
|
"""Return a valid local and global user interactive namespaces.
|
|
887
|
|
|
887
|
|
|
888
|
This builds a dict with the minimal information needed to operate as a
|
|
888
|
This builds a dict with the minimal information needed to operate as a
|
|
889
|
valid IPython user namespace, which you can pass to the various
|
|
889
|
valid IPython user namespace, which you can pass to the various
|
|
890
|
embedding classes in ipython. The default implementation returns the
|
|
890
|
embedding classes in ipython. The default implementation returns the
|
|
891
|
same dict for both the locals and the globals to allow functions to
|
|
891
|
same dict for both the locals and the globals to allow functions to
|
|
892
|
refer to variables in the namespace. Customized implementations can
|
|
892
|
refer to variables in the namespace. Customized implementations can
|
|
893
|
return different dicts. The locals dictionary can actually be anything
|
|
893
|
return different dicts. The locals dictionary can actually be anything
|
|
894
|
following the basic mapping protocol of a dict, but the globals dict
|
|
894
|
following the basic mapping protocol of a dict, but the globals dict
|
|
895
|
must be a true dict, not even a subclass. It is recommended that any
|
|
895
|
must be a true dict, not even a subclass. It is recommended that any
|
|
896
|
custom object for the locals namespace synchronize with the globals
|
|
896
|
custom object for the locals namespace synchronize with the globals
|
|
897
|
dict somehow.
|
|
897
|
dict somehow.
|
|
898
|
|
|
898
|
|
|
899
|
Raises TypeError if the provided globals namespace is not a true dict.
|
|
899
|
Raises TypeError if the provided globals namespace is not a true dict.
|
|
900
|
|
|
900
|
|
|
901
|
Parameters
|
|
901
|
Parameters
|
|
902
|
----------
|
|
902
|
----------
|
|
903
|
user_ns : dict-like, optional
|
|
903
|
user_ns : dict-like, optional
|
|
904
|
The current user namespace. The items in this namespace should
|
|
904
|
The current user namespace. The items in this namespace should
|
|
905
|
be included in the output. If None, an appropriate blank
|
|
905
|
be included in the output. If None, an appropriate blank
|
|
906
|
namespace should be created.
|
|
906
|
namespace should be created.
|
|
907
|
user_global_ns : dict, optional
|
|
907
|
user_global_ns : dict, optional
|
|
908
|
The current user global namespace. The items in this namespace
|
|
908
|
The current user global namespace. The items in this namespace
|
|
909
|
should be included in the output. If None, an appropriate
|
|
909
|
should be included in the output. If None, an appropriate
|
|
910
|
blank namespace should be created.
|
|
910
|
blank namespace should be created.
|
|
911
|
|
|
911
|
|
|
912
|
Returns
|
|
912
|
Returns
|
|
913
|
-------
|
|
913
|
-------
|
|
914
|
A pair of dictionary-like object to be used as the local namespace
|
|
914
|
A pair of dictionary-like object to be used as the local namespace
|
|
915
|
of the interpreter and a dict to be used as the global namespace.
|
|
915
|
of the interpreter and a dict to be used as the global namespace.
|
|
916
|
"""
|
|
916
|
"""
|
|
917
|
|
|
917
|
|
|
918
|
|
|
918
|
|
|
919
|
# We must ensure that __builtin__ (without the final 's') is always
|
|
919
|
# We must ensure that __builtin__ (without the final 's') is always
|
|
920
|
# available and pointing to the __builtin__ *module*. For more details:
|
|
920
|
# available and pointing to the __builtin__ *module*. For more details:
|
|
921
|
# http://mail.python.org/pipermail/python-dev/2001-April/014068.html
|
|
921
|
# http://mail.python.org/pipermail/python-dev/2001-April/014068.html
|
|
922
|
|
|
922
|
|
|
923
|
if user_ns is None:
|
|
923
|
if user_ns is None:
|
|
924
|
# Set __name__ to __main__ to better match the behavior of the
|
|
924
|
# Set __name__ to __main__ to better match the behavior of the
|
|
925
|
# normal interpreter.
|
|
925
|
# normal interpreter.
|
|
926
|
user_ns = {'__name__' :'__main__',
|
|
926
|
user_ns = {'__name__' :'__main__',
|
|
927
|
'__builtin__' : __builtin__,
|
|
927
|
'__builtin__' : __builtin__,
|
|
928
|
'__builtins__' : __builtin__,
|
|
928
|
'__builtins__' : __builtin__,
|
|
929
|
}
|
|
929
|
}
|
|
930
|
else:
|
|
930
|
else:
|
|
931
|
user_ns.setdefault('__name__','__main__')
|
|
931
|
user_ns.setdefault('__name__','__main__')
|
|
932
|
user_ns.setdefault('__builtin__',__builtin__)
|
|
932
|
user_ns.setdefault('__builtin__',__builtin__)
|
|
933
|
user_ns.setdefault('__builtins__',__builtin__)
|
|
933
|
user_ns.setdefault('__builtins__',__builtin__)
|
|
934
|
|
|
934
|
|
|
935
|
if user_global_ns is None:
|
|
935
|
if user_global_ns is None:
|
|
936
|
user_global_ns = user_ns
|
|
936
|
user_global_ns = user_ns
|
|
937
|
if type(user_global_ns) is not dict:
|
|
937
|
if type(user_global_ns) is not dict:
|
|
938
|
raise TypeError("user_global_ns must be a true dict; got %r"
|
|
938
|
raise TypeError("user_global_ns must be a true dict; got %r"
|
|
939
|
% type(user_global_ns))
|
|
939
|
% type(user_global_ns))
|
|
940
|
|
|
940
|
|
|
941
|
return user_ns, user_global_ns
|
|
941
|
return user_ns, user_global_ns
|
|
942
|
|
|
942
|
|
|
943
|
def init_sys_modules(self):
|
|
943
|
def init_sys_modules(self):
|
|
944
|
# We need to insert into sys.modules something that looks like a
|
|
944
|
# We need to insert into sys.modules something that looks like a
|
|
945
|
# module but which accesses the IPython namespace, for shelve and
|
|
945
|
# module but which accesses the IPython namespace, for shelve and
|
|
946
|
# pickle to work interactively. Normally they rely on getting
|
|
946
|
# pickle to work interactively. Normally they rely on getting
|
|
947
|
# everything out of __main__, but for embedding purposes each IPython
|
|
947
|
# everything out of __main__, but for embedding purposes each IPython
|
|
948
|
# instance has its own private namespace, so we can't go shoving
|
|
948
|
# instance has its own private namespace, so we can't go shoving
|
|
949
|
# everything into __main__.
|
|
949
|
# everything into __main__.
|
|
950
|
|
|
950
|
|
|
951
|
# note, however, that we should only do this for non-embedded
|
|
951
|
# note, however, that we should only do this for non-embedded
|
|
952
|
# ipythons, which really mimic the __main__.__dict__ with their own
|
|
952
|
# ipythons, which really mimic the __main__.__dict__ with their own
|
|
953
|
# namespace. Embedded instances, on the other hand, should not do
|
|
953
|
# namespace. Embedded instances, on the other hand, should not do
|
|
954
|
# this because they need to manage the user local/global namespaces
|
|
954
|
# this because they need to manage the user local/global namespaces
|
|
955
|
# only, but they live within a 'normal' __main__ (meaning, they
|
|
955
|
# only, but they live within a 'normal' __main__ (meaning, they
|
|
956
|
# shouldn't overtake the execution environment of the script they're
|
|
956
|
# shouldn't overtake the execution environment of the script they're
|
|
957
|
# embedded in).
|
|
957
|
# embedded in).
|
|
958
|
|
|
958
|
|
|
959
|
# This is overridden in the InteractiveShellEmbed subclass to a no-op.
|
|
959
|
# This is overridden in the InteractiveShellEmbed subclass to a no-op.
|
|
960
|
|
|
960
|
|
|
961
|
try:
|
|
961
|
try:
|
|
962
|
main_name = self.user_ns['__name__']
|
|
962
|
main_name = self.user_ns['__name__']
|
|
963
|
except KeyError:
|
|
963
|
except KeyError:
|
|
964
|
raise KeyError('user_ns dictionary MUST have a "__name__" key')
|
|
964
|
raise KeyError('user_ns dictionary MUST have a "__name__" key')
|
|
965
|
else:
|
|
965
|
else:
|
|
966
|
sys.modules[main_name] = FakeModule(self.user_ns)
|
|
966
|
sys.modules[main_name] = FakeModule(self.user_ns)
|
|
967
|
|
|
967
|
|
|
968
|
def init_user_ns(self):
|
|
968
|
def init_user_ns(self):
|
|
969
|
"""Initialize all user-visible namespaces to their minimum defaults.
|
|
969
|
"""Initialize all user-visible namespaces to their minimum defaults.
|
|
970
|
|
|
970
|
|
|
971
|
Certain history lists are also initialized here, as they effectively
|
|
971
|
Certain history lists are also initialized here, as they effectively
|
|
972
|
act as user namespaces.
|
|
972
|
act as user namespaces.
|
|
973
|
|
|
973
|
|
|
974
|
Notes
|
|
974
|
Notes
|
|
975
|
-----
|
|
975
|
-----
|
|
976
|
All data structures here are only filled in, they are NOT reset by this
|
|
976
|
All data structures here are only filled in, they are NOT reset by this
|
|
977
|
method. If they were not empty before, data will simply be added to
|
|
977
|
method. If they were not empty before, data will simply be added to
|
|
978
|
therm.
|
|
978
|
therm.
|
|
979
|
"""
|
|
979
|
"""
|
|
980
|
# This function works in two parts: first we put a few things in
|
|
980
|
# This function works in two parts: first we put a few things in
|
|
981
|
# user_ns, and we sync that contents into user_config_ns so that these
|
|
981
|
# user_ns, and we sync that contents into user_ns_hidden so that these
|
|
982
|
# initial variables aren't shown by %who. After the sync, we add the
|
|
982
|
# initial variables aren't shown by %who. After the sync, we add the
|
|
983
|
# rest of what we *do* want the user to see with %who even on a new
|
|
983
|
# rest of what we *do* want the user to see with %who even on a new
|
|
984
|
# session (probably nothing, so theye really only see their own stuff)
|
|
984
|
# session (probably nothing, so theye really only see their own stuff)
|
|
985
|
|
|
985
|
|
|
986
|
# The user dict must *always* have a __builtin__ reference to the
|
|
986
|
# The user dict must *always* have a __builtin__ reference to the
|
|
987
|
# Python standard __builtin__ namespace, which must be imported.
|
|
987
|
# Python standard __builtin__ namespace, which must be imported.
|
|
988
|
# This is so that certain operations in prompt evaluation can be
|
|
988
|
# This is so that certain operations in prompt evaluation can be
|
|
989
|
# reliably executed with builtins. Note that we can NOT use
|
|
989
|
# reliably executed with builtins. Note that we can NOT use
|
|
990
|
# __builtins__ (note the 's'), because that can either be a dict or a
|
|
990
|
# __builtins__ (note the 's'), because that can either be a dict or a
|
|
991
|
# module, and can even mutate at runtime, depending on the context
|
|
991
|
# module, and can even mutate at runtime, depending on the context
|
|
992
|
# (Python makes no guarantees on it). In contrast, __builtin__ is
|
|
992
|
# (Python makes no guarantees on it). In contrast, __builtin__ is
|
|
993
|
# always a module object, though it must be explicitly imported.
|
|
993
|
# always a module object, though it must be explicitly imported.
|
|
994
|
|
|
994
|
|
|
995
|
# For more details:
|
|
995
|
# For more details:
|
|
996
|
# http://mail.python.org/pipermail/python-dev/2001-April/014068.html
|
|
996
|
# http://mail.python.org/pipermail/python-dev/2001-April/014068.html
|
|
997
|
ns = dict(__builtin__ = __builtin__)
|
|
997
|
ns = dict(__builtin__ = __builtin__)
|
|
998
|
|
|
998
|
|
|
999
|
# Put 'help' in the user namespace
|
|
999
|
# Put 'help' in the user namespace
|
|
1000
|
try:
|
|
1000
|
try:
|
|
1001
|
from site import _Helper
|
|
1001
|
from site import _Helper
|
|
1002
|
ns['help'] = _Helper()
|
|
1002
|
ns['help'] = _Helper()
|
|
1003
|
except ImportError:
|
|
1003
|
except ImportError:
|
|
1004
|
warn('help() not available - check site.py')
|
|
1004
|
warn('help() not available - check site.py')
|
|
1005
|
|
|
1005
|
|
|
1006
|
# make global variables for user access to the histories
|
|
1006
|
# make global variables for user access to the histories
|
|
1007
|
ns['_ih'] = self.input_hist
|
|
1007
|
ns['_ih'] = self.input_hist
|
|
1008
|
ns['_oh'] = self.output_hist
|
|
1008
|
ns['_oh'] = self.output_hist
|
|
1009
|
ns['_dh'] = self.dir_hist
|
|
1009
|
ns['_dh'] = self.dir_hist
|
|
1010
|
|
|
1010
|
|
|
1011
|
ns['_sh'] = shadowns
|
|
1011
|
ns['_sh'] = shadowns
|
|
1012
|
|
|
1012
|
|
|
1013
|
# user aliases to input and output histories. These shouldn't show up
|
|
1013
|
# user aliases to input and output histories. These shouldn't show up
|
|
1014
|
# in %who, as they can have very large reprs.
|
|
1014
|
# in %who, as they can have very large reprs.
|
|
1015
|
ns['In'] = self.input_hist
|
|
1015
|
ns['In'] = self.input_hist
|
|
1016
|
ns['Out'] = self.output_hist
|
|
1016
|
ns['Out'] = self.output_hist
|
|
1017
|
|
|
1017
|
|
|
1018
|
# Store myself as the public api!!!
|
|
1018
|
# Store myself as the public api!!!
|
|
1019
|
ns['get_ipython'] = self.get_ipython
|
|
1019
|
ns['get_ipython'] = self.get_ipython
|
|
1020
|
|
|
1020
|
|
|
1021
|
# Sync what we've added so far to user_config_ns so these aren't seen
|
|
1021
|
# Sync what we've added so far to user_ns_hidden so these aren't seen
|
|
1022
|
# by %who
|
|
1022
|
# by %who
|
|
1023
|
self.user_config_ns.update(ns)
|
|
1023
|
self.user_ns_hidden.update(ns)
|
|
1024
|
|
|
1024
|
|
|
1025
|
# Anything put into ns now would show up in %who. Think twice before
|
|
1025
|
# Anything put into ns now would show up in %who. Think twice before
|
|
1026
|
# putting anything here, as we really want %who to show the user their
|
|
1026
|
# putting anything here, as we really want %who to show the user their
|
|
1027
|
# stuff, not our variables.
|
|
1027
|
# stuff, not our variables.
|
|
1028
|
|
|
1028
|
|
|
1029
|
# Finally, update the real user's namespace
|
|
1029
|
# Finally, update the real user's namespace
|
|
1030
|
self.user_ns.update(ns)
|
|
1030
|
self.user_ns.update(ns)
|
|
1031
|
|
|
1031
|
|
|
1032
|
|
|
1032
|
|
|
1033
|
def reset(self):
|
|
1033
|
def reset(self):
|
|
1034
|
"""Clear all internal namespaces.
|
|
1034
|
"""Clear all internal namespaces.
|
|
1035
|
|
|
1035
|
|
|
1036
|
Note that this is much more aggressive than %reset, since it clears
|
|
1036
|
Note that this is much more aggressive than %reset, since it clears
|
|
1037
|
fully all namespaces, as well as all input/output lists.
|
|
1037
|
fully all namespaces, as well as all input/output lists.
|
|
1038
|
"""
|
|
1038
|
"""
|
|
1039
|
for ns in self.ns_refs_table:
|
|
1039
|
for ns in self.ns_refs_table:
|
|
1040
|
ns.clear()
|
|
1040
|
ns.clear()
|
|
1041
|
|
|
1041
|
|
|
1042
|
self.alias_manager.clear_aliases()
|
|
1042
|
self.alias_manager.clear_aliases()
|
|
1043
|
|
|
1043
|
|
|
1044
|
# Clear input and output histories
|
|
1044
|
# Clear input and output histories
|
|
1045
|
self.input_hist[:] = []
|
|
1045
|
self.input_hist[:] = []
|
|
1046
|
self.input_hist_raw[:] = []
|
|
1046
|
self.input_hist_raw[:] = []
|
|
1047
|
self.output_hist.clear()
|
|
1047
|
self.output_hist.clear()
|
|
1048
|
|
|
1048
|
|
|
1049
|
# Restore the user namespaces to minimal usability
|
|
1049
|
# Restore the user namespaces to minimal usability
|
|
1050
|
self.init_user_ns()
|
|
1050
|
self.init_user_ns()
|
|
1051
|
|
|
1051
|
|
|
1052
|
# Restore the default and user aliases
|
|
1052
|
# Restore the default and user aliases
|
|
1053
|
self.alias_manager.init_aliases()
|
|
1053
|
self.alias_manager.init_aliases()
|
|
1054
|
|
|
1054
|
|
|
1055
|
def push(self, variables, interactive=True):
|
|
1055
|
def push(self, variables, interactive=True):
|
|
1056
|
"""Inject a group of variables into the IPython user namespace.
|
|
1056
|
"""Inject a group of variables into the IPython user namespace.
|
|
1057
|
|
|
1057
|
|
|
1058
|
Parameters
|
|
1058
|
Parameters
|
|
1059
|
----------
|
|
1059
|
----------
|
|
1060
|
variables : dict, str or list/tuple of str
|
|
1060
|
variables : dict, str or list/tuple of str
|
|
1061
|
The variables to inject into the user's namespace. If a dict,
|
|
1061
|
The variables to inject into the user's namespace. If a dict,
|
|
1062
|
a simple update is done. If a str, the string is assumed to
|
|
1062
|
a simple update is done. If a str, the string is assumed to
|
|
1063
|
have variable names separated by spaces. A list/tuple of str
|
|
1063
|
have variable names separated by spaces. A list/tuple of str
|
|
1064
|
can also be used to give the variable names. If just the variable
|
|
1064
|
can also be used to give the variable names. If just the variable
|
|
1065
|
names are give (list/tuple/str) then the variable values looked
|
|
1065
|
names are give (list/tuple/str) then the variable values looked
|
|
1066
|
up in the callers frame.
|
|
1066
|
up in the callers frame.
|
|
1067
|
interactive : bool
|
|
1067
|
interactive : bool
|
|
1068
|
If True (default), the variables will be listed with the ``who``
|
|
1068
|
If True (default), the variables will be listed with the ``who``
|
|
1069
|
magic.
|
|
1069
|
magic.
|
|
1070
|
"""
|
|
1070
|
"""
|
|
1071
|
vdict = None
|
|
1071
|
vdict = None
|
|
1072
|
|
|
1072
|
|
|
1073
|
# We need a dict of name/value pairs to do namespace updates.
|
|
1073
|
# We need a dict of name/value pairs to do namespace updates.
|
|
1074
|
if isinstance(variables, dict):
|
|
1074
|
if isinstance(variables, dict):
|
|
1075
|
vdict = variables
|
|
1075
|
vdict = variables
|
|
1076
|
elif isinstance(variables, (basestring, list, tuple)):
|
|
1076
|
elif isinstance(variables, (basestring, list, tuple)):
|
|
1077
|
if isinstance(variables, basestring):
|
|
1077
|
if isinstance(variables, basestring):
|
|
1078
|
vlist = variables.split()
|
|
1078
|
vlist = variables.split()
|
|
1079
|
else:
|
|
1079
|
else:
|
|
1080
|
vlist = variables
|
|
1080
|
vlist = variables
|
|
1081
|
vdict = {}
|
|
1081
|
vdict = {}
|
|
1082
|
cf = sys._getframe(1)
|
|
1082
|
cf = sys._getframe(1)
|
|
1083
|
for name in vlist:
|
|
1083
|
for name in vlist:
|
|
1084
|
try:
|
|
1084
|
try:
|
|
1085
|
vdict[name] = eval(name, cf.f_globals, cf.f_locals)
|
|
1085
|
vdict[name] = eval(name, cf.f_globals, cf.f_locals)
|
|
1086
|
except:
|
|
1086
|
except:
|
|
1087
|
print ('Could not get variable %s from %s' %
|
|
1087
|
print ('Could not get variable %s from %s' %
|
|
1088
|
(name,cf.f_code.co_name))
|
|
1088
|
(name,cf.f_code.co_name))
|
|
1089
|
else:
|
|
1089
|
else:
|
|
1090
|
raise ValueError('variables must be a dict/str/list/tuple')
|
|
1090
|
raise ValueError('variables must be a dict/str/list/tuple')
|
|
1091
|
|
|
1091
|
|
|
1092
|
# Propagate variables to user namespace
|
|
1092
|
# Propagate variables to user namespace
|
|
1093
|
self.user_ns.update(vdict)
|
|
1093
|
self.user_ns.update(vdict)
|
|
1094
|
|
|
1094
|
|
|
1095
|
# And configure interactive visibility
|
|
1095
|
# And configure interactive visibility
|
|
1096
|
config_ns = self.user_config_ns
|
|
1096
|
config_ns = self.user_ns_hidden
|
|
1097
|
if interactive:
|
|
1097
|
if interactive:
|
|
1098
|
for name, val in vdict.iteritems():
|
|
1098
|
for name, val in vdict.iteritems():
|
|
1099
|
config_ns.pop(name, None)
|
|
1099
|
config_ns.pop(name, None)
|
|
1100
|
else:
|
|
1100
|
else:
|
|
1101
|
for name,val in vdict.iteritems():
|
|
1101
|
for name,val in vdict.iteritems():
|
|
1102
|
config_ns[name] = val
|
|
1102
|
config_ns[name] = val
|
|
1103
|
|
|
1103
|
|
|
1104
|
#-------------------------------------------------------------------------
|
|
1104
|
#-------------------------------------------------------------------------
|
|
1105
|
# Things related to history management
|
|
1105
|
# Things related to history management
|
|
1106
|
#-------------------------------------------------------------------------
|
|
1106
|
#-------------------------------------------------------------------------
|
|
1107
|
|
|
1107
|
|
|
1108
|
def init_history(self):
|
|
1108
|
def init_history(self):
|
|
1109
|
# List of input with multi-line handling.
|
|
1109
|
# List of input with multi-line handling.
|
|
1110
|
self.input_hist = InputList()
|
|
1110
|
self.input_hist = InputList()
|
|
1111
|
# This one will hold the 'raw' input history, without any
|
|
1111
|
# This one will hold the 'raw' input history, without any
|
|
1112
|
# pre-processing. This will allow users to retrieve the input just as
|
|
1112
|
# pre-processing. This will allow users to retrieve the input just as
|
|
1113
|
# it was exactly typed in by the user, with %hist -r.
|
|
1113
|
# it was exactly typed in by the user, with %hist -r.
|
|
1114
|
self.input_hist_raw = InputList()
|
|
1114
|
self.input_hist_raw = InputList()
|
|
1115
|
|
|
1115
|
|
|
1116
|
# list of visited directories
|
|
1116
|
# list of visited directories
|
|
1117
|
try:
|
|
1117
|
try:
|
|
1118
|
self.dir_hist = [os.getcwd()]
|
|
1118
|
self.dir_hist = [os.getcwd()]
|
|
1119
|
except OSError:
|
|
1119
|
except OSError:
|
|
1120
|
self.dir_hist = []
|
|
1120
|
self.dir_hist = []
|
|
1121
|
|
|
1121
|
|
|
1122
|
# dict of output history
|
|
1122
|
# dict of output history
|
|
1123
|
self.output_hist = {}
|
|
1123
|
self.output_hist = {}
|
|
1124
|
|
|
1124
|
|
|
1125
|
# Now the history file
|
|
1125
|
# Now the history file
|
|
1126
|
if self.profile:
|
|
1126
|
if self.profile:
|
|
1127
|
histfname = 'history-%s' % self.profile
|
|
1127
|
histfname = 'history-%s' % self.profile
|
|
1128
|
else:
|
|
1128
|
else:
|
|
1129
|
histfname = 'history'
|
|
1129
|
histfname = 'history'
|
|
1130
|
self.histfile = os.path.join(self.ipython_dir, histfname)
|
|
1130
|
self.histfile = os.path.join(self.ipython_dir, histfname)
|
|
1131
|
|
|
1131
|
|
|
1132
|
# Fill the history zero entry, user counter starts at 1
|
|
1132
|
# Fill the history zero entry, user counter starts at 1
|
|
1133
|
self.input_hist.append('\n')
|
|
1133
|
self.input_hist.append('\n')
|
|
1134
|
self.input_hist_raw.append('\n')
|
|
1134
|
self.input_hist_raw.append('\n')
|
|
1135
|
|
|
1135
|
|
|
1136
|
def init_shadow_hist(self):
|
|
1136
|
def init_shadow_hist(self):
|
|
1137
|
try:
|
|
1137
|
try:
|
|
1138
|
self.db = pickleshare.PickleShareDB(self.ipython_dir + "/db")
|
|
1138
|
self.db = pickleshare.PickleShareDB(self.ipython_dir + "/db")
|
|
1139
|
except exceptions.UnicodeDecodeError:
|
|
1139
|
except exceptions.UnicodeDecodeError:
|
|
1140
|
print "Your ipython_dir can't be decoded to unicode!"
|
|
1140
|
print "Your ipython_dir can't be decoded to unicode!"
|
|
1141
|
print "Please set HOME environment variable to something that"
|
|
1141
|
print "Please set HOME environment variable to something that"
|
|
1142
|
print r"only has ASCII characters, e.g. c:\home"
|
|
1142
|
print r"only has ASCII characters, e.g. c:\home"
|
|
1143
|
print "Now it is", self.ipython_dir
|
|
1143
|
print "Now it is", self.ipython_dir
|
|
1144
|
sys.exit()
|
|
1144
|
sys.exit()
|
|
1145
|
self.shadowhist = ipcorehist.ShadowHist(self.db)
|
|
1145
|
self.shadowhist = ipcorehist.ShadowHist(self.db)
|
|
1146
|
|
|
1146
|
|
|
1147
|
def savehist(self):
|
|
1147
|
def savehist(self):
|
|
1148
|
"""Save input history to a file (via readline library)."""
|
|
1148
|
"""Save input history to a file (via readline library)."""
|
|
1149
|
|
|
1149
|
|
|
1150
|
try:
|
|
1150
|
try:
|
|
1151
|
self.readline.write_history_file(self.histfile)
|
|
1151
|
self.readline.write_history_file(self.histfile)
|
|
1152
|
except:
|
|
1152
|
except:
|
|
1153
|
print 'Unable to save IPython command history to file: ' + \
|
|
1153
|
print 'Unable to save IPython command history to file: ' + \
|
|
1154
|
`self.histfile`
|
|
1154
|
`self.histfile`
|
|
1155
|
|
|
1155
|
|
|
1156
|
def reloadhist(self):
|
|
1156
|
def reloadhist(self):
|
|
1157
|
"""Reload the input history from disk file."""
|
|
1157
|
"""Reload the input history from disk file."""
|
|
1158
|
|
|
1158
|
|
|
1159
|
try:
|
|
1159
|
try:
|
|
1160
|
self.readline.clear_history()
|
|
1160
|
self.readline.clear_history()
|
|
1161
|
self.readline.read_history_file(self.shell.histfile)
|
|
1161
|
self.readline.read_history_file(self.shell.histfile)
|
|
1162
|
except AttributeError:
|
|
1162
|
except AttributeError:
|
|
1163
|
pass
|
|
1163
|
pass
|
|
1164
|
|
|
1164
|
|
|
1165
|
def history_saving_wrapper(self, func):
|
|
1165
|
def history_saving_wrapper(self, func):
|
|
1166
|
""" Wrap func for readline history saving
|
|
1166
|
""" Wrap func for readline history saving
|
|
1167
|
|
|
1167
|
|
|
1168
|
Convert func into callable that saves & restores
|
|
1168
|
Convert func into callable that saves & restores
|
|
1169
|
history around the call """
|
|
1169
|
history around the call """
|
|
1170
|
|
|
1170
|
|
|
1171
|
if self.has_readline:
|
|
1171
|
if self.has_readline:
|
|
1172
|
from IPython.utils import rlineimpl as readline
|
|
1172
|
from IPython.utils import rlineimpl as readline
|
|
1173
|
else:
|
|
1173
|
else:
|
|
1174
|
return func
|
|
1174
|
return func
|
|
1175
|
|
|
1175
|
|
|
1176
|
def wrapper():
|
|
1176
|
def wrapper():
|
|
1177
|
self.savehist()
|
|
1177
|
self.savehist()
|
|
1178
|
try:
|
|
1178
|
try:
|
|
1179
|
func()
|
|
1179
|
func()
|
|
1180
|
finally:
|
|
1180
|
finally:
|
|
1181
|
readline.read_history_file(self.histfile)
|
|
1181
|
readline.read_history_file(self.histfile)
|
|
1182
|
return wrapper
|
|
1182
|
return wrapper
|
|
1183
|
|
|
1183
|
|
|
1184
|
#-------------------------------------------------------------------------
|
|
1184
|
#-------------------------------------------------------------------------
|
|
1185
|
# Things related to exception handling and tracebacks (not debugging)
|
|
1185
|
# Things related to exception handling and tracebacks (not debugging)
|
|
1186
|
#-------------------------------------------------------------------------
|
|
1186
|
#-------------------------------------------------------------------------
|
|
1187
|
|
|
1187
|
|
|
1188
|
def init_traceback_handlers(self, custom_exceptions):
|
|
1188
|
def init_traceback_handlers(self, custom_exceptions):
|
|
1189
|
# Syntax error handler.
|
|
1189
|
# Syntax error handler.
|
|
1190
|
self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
|
|
1190
|
self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
|
|
1191
|
|
|
1191
|
|
|
1192
|
# The interactive one is initialized with an offset, meaning we always
|
|
1192
|
# The interactive one is initialized with an offset, meaning we always
|
|
1193
|
# want to remove the topmost item in the traceback, which is our own
|
|
1193
|
# want to remove the topmost item in the traceback, which is our own
|
|
1194
|
# internal code. Valid modes: ['Plain','Context','Verbose']
|
|
1194
|
# internal code. Valid modes: ['Plain','Context','Verbose']
|
|
1195
|
self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
|
|
1195
|
self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
|
|
1196
|
color_scheme='NoColor',
|
|
1196
|
color_scheme='NoColor',
|
|
1197
|
tb_offset = 1)
|
|
1197
|
tb_offset = 1)
|
|
1198
|
|
|
1198
|
|
|
1199
|
# The instance will store a pointer to the system-wide exception hook,
|
|
1199
|
# The instance will store a pointer to the system-wide exception hook,
|
|
1200
|
# so that runtime code (such as magics) can access it. This is because
|
|
1200
|
# so that runtime code (such as magics) can access it. This is because
|
|
1201
|
# during the read-eval loop, it may get temporarily overwritten.
|
|
1201
|
# during the read-eval loop, it may get temporarily overwritten.
|
|
1202
|
self.sys_excepthook = sys.excepthook
|
|
1202
|
self.sys_excepthook = sys.excepthook
|
|
1203
|
|
|
1203
|
|
|
1204
|
# and add any custom exception handlers the user may have specified
|
|
1204
|
# and add any custom exception handlers the user may have specified
|
|
1205
|
self.set_custom_exc(*custom_exceptions)
|
|
1205
|
self.set_custom_exc(*custom_exceptions)
|
|
1206
|
|
|
1206
|
|
|
1207
|
# Set the exception mode
|
|
1207
|
# Set the exception mode
|
|
1208
|
self.InteractiveTB.set_mode(mode=self.xmode)
|
|
1208
|
self.InteractiveTB.set_mode(mode=self.xmode)
|
|
1209
|
|
|
1209
|
|
|
1210
|
def set_custom_exc(self,exc_tuple,handler):
|
|
1210
|
def set_custom_exc(self,exc_tuple,handler):
|
|
1211
|
"""set_custom_exc(exc_tuple,handler)
|
|
1211
|
"""set_custom_exc(exc_tuple,handler)
|
|
1212
|
|
|
1212
|
|
|
1213
|
Set a custom exception handler, which will be called if any of the
|
|
1213
|
Set a custom exception handler, which will be called if any of the
|
|
1214
|
exceptions in exc_tuple occur in the mainloop (specifically, in the
|
|
1214
|
exceptions in exc_tuple occur in the mainloop (specifically, in the
|
|
1215
|
runcode() method.
|
|
1215
|
runcode() method.
|
|
1216
|
|
|
1216
|
|
|
1217
|
Inputs:
|
|
1217
|
Inputs:
|
|
1218
|
|
|
1218
|
|
|
1219
|
- exc_tuple: a *tuple* of valid exceptions to call the defined
|
|
1219
|
- exc_tuple: a *tuple* of valid exceptions to call the defined
|
|
1220
|
handler for. It is very important that you use a tuple, and NOT A
|
|
1220
|
handler for. It is very important that you use a tuple, and NOT A
|
|
1221
|
LIST here, because of the way Python's except statement works. If
|
|
1221
|
LIST here, because of the way Python's except statement works. If
|
|
1222
|
you only want to trap a single exception, use a singleton tuple:
|
|
1222
|
you only want to trap a single exception, use a singleton tuple:
|
|
1223
|
|
|
1223
|
|
|
1224
|
exc_tuple == (MyCustomException,)
|
|
1224
|
exc_tuple == (MyCustomException,)
|
|
1225
|
|
|
1225
|
|
|
1226
|
- handler: this must be defined as a function with the following
|
|
1226
|
- handler: this must be defined as a function with the following
|
|
1227
|
basic interface: def my_handler(self,etype,value,tb).
|
|
1227
|
basic interface: def my_handler(self,etype,value,tb).
|
|
1228
|
|
|
1228
|
|
|
1229
|
This will be made into an instance method (via new.instancemethod)
|
|
1229
|
This will be made into an instance method (via new.instancemethod)
|
|
1230
|
of IPython itself, and it will be called if any of the exceptions
|
|
1230
|
of IPython itself, and it will be called if any of the exceptions
|
|
1231
|
listed in the exc_tuple are caught. If the handler is None, an
|
|
1231
|
listed in the exc_tuple are caught. If the handler is None, an
|
|
1232
|
internal basic one is used, which just prints basic info.
|
|
1232
|
internal basic one is used, which just prints basic info.
|
|
1233
|
|
|
1233
|
|
|
1234
|
WARNING: by putting in your own exception handler into IPython's main
|
|
1234
|
WARNING: by putting in your own exception handler into IPython's main
|
|
1235
|
execution loop, you run a very good chance of nasty crashes. This
|
|
1235
|
execution loop, you run a very good chance of nasty crashes. This
|
|
1236
|
facility should only be used if you really know what you are doing."""
|
|
1236
|
facility should only be used if you really know what you are doing."""
|
|
1237
|
|
|
1237
|
|
|
1238
|
assert type(exc_tuple)==type(()) , \
|
|
1238
|
assert type(exc_tuple)==type(()) , \
|
|
1239
|
"The custom exceptions must be given AS A TUPLE."
|
|
1239
|
"The custom exceptions must be given AS A TUPLE."
|
|
1240
|
|
|
1240
|
|
|
1241
|
def dummy_handler(self,etype,value,tb):
|
|
1241
|
def dummy_handler(self,etype,value,tb):
|
|
1242
|
print '*** Simple custom exception handler ***'
|
|
1242
|
print '*** Simple custom exception handler ***'
|
|
1243
|
print 'Exception type :',etype
|
|
1243
|
print 'Exception type :',etype
|
|
1244
|
print 'Exception value:',value
|
|
1244
|
print 'Exception value:',value
|
|
1245
|
print 'Traceback :',tb
|
|
1245
|
print 'Traceback :',tb
|
|
1246
|
print 'Source code :','\n'.join(self.buffer)
|
|
1246
|
print 'Source code :','\n'.join(self.buffer)
|
|
1247
|
|
|
1247
|
|
|
1248
|
if handler is None: handler = dummy_handler
|
|
1248
|
if handler is None: handler = dummy_handler
|
|
1249
|
|
|
1249
|
|
|
1250
|
self.CustomTB = new.instancemethod(handler,self,self.__class__)
|
|
1250
|
self.CustomTB = new.instancemethod(handler,self,self.__class__)
|
|
1251
|
self.custom_exceptions = exc_tuple
|
|
1251
|
self.custom_exceptions = exc_tuple
|
|
1252
|
|
|
1252
|
|
|
1253
|
def excepthook(self, etype, value, tb):
|
|
1253
|
def excepthook(self, etype, value, tb):
|
|
1254
|
"""One more defense for GUI apps that call sys.excepthook.
|
|
1254
|
"""One more defense for GUI apps that call sys.excepthook.
|
|
1255
|
|
|
1255
|
|
|
1256
|
GUI frameworks like wxPython trap exceptions and call
|
|
1256
|
GUI frameworks like wxPython trap exceptions and call
|
|
1257
|
sys.excepthook themselves. I guess this is a feature that
|
|
1257
|
sys.excepthook themselves. I guess this is a feature that
|
|
1258
|
enables them to keep running after exceptions that would
|
|
1258
|
enables them to keep running after exceptions that would
|
|
1259
|
otherwise kill their mainloop. This is a bother for IPython
|
|
1259
|
otherwise kill their mainloop. This is a bother for IPython
|
|
1260
|
which excepts to catch all of the program exceptions with a try:
|
|
1260
|
which excepts to catch all of the program exceptions with a try:
|
|
1261
|
except: statement.
|
|
1261
|
except: statement.
|
|
1262
|
|
|
1262
|
|
|
1263
|
Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
|
|
1263
|
Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
|
|
1264
|
any app directly invokes sys.excepthook, it will look to the user like
|
|
1264
|
any app directly invokes sys.excepthook, it will look to the user like
|
|
1265
|
IPython crashed. In order to work around this, we can disable the
|
|
1265
|
IPython crashed. In order to work around this, we can disable the
|
|
1266
|
CrashHandler and replace it with this excepthook instead, which prints a
|
|
1266
|
CrashHandler and replace it with this excepthook instead, which prints a
|
|
1267
|
regular traceback using our InteractiveTB. In this fashion, apps which
|
|
1267
|
regular traceback using our InteractiveTB. In this fashion, apps which
|
|
1268
|
call sys.excepthook will generate a regular-looking exception from
|
|
1268
|
call sys.excepthook will generate a regular-looking exception from
|
|
1269
|
IPython, and the CrashHandler will only be triggered by real IPython
|
|
1269
|
IPython, and the CrashHandler will only be triggered by real IPython
|
|
1270
|
crashes.
|
|
1270
|
crashes.
|
|
1271
|
|
|
1271
|
|
|
1272
|
This hook should be used sparingly, only in places which are not likely
|
|
1272
|
This hook should be used sparingly, only in places which are not likely
|
|
1273
|
to be true IPython errors.
|
|
1273
|
to be true IPython errors.
|
|
1274
|
"""
|
|
1274
|
"""
|
|
1275
|
self.showtraceback((etype,value,tb),tb_offset=0)
|
|
1275
|
self.showtraceback((etype,value,tb),tb_offset=0)
|
|
1276
|
|
|
1276
|
|
|
1277
|
def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
|
|
1277
|
def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
|
|
1278
|
exception_only=False):
|
|
1278
|
exception_only=False):
|
|
1279
|
"""Display the exception that just occurred.
|
|
1279
|
"""Display the exception that just occurred.
|
|
1280
|
|
|
1280
|
|
|
1281
|
If nothing is known about the exception, this is the method which
|
|
1281
|
If nothing is known about the exception, this is the method which
|
|
1282
|
should be used throughout the code for presenting user tracebacks,
|
|
1282
|
should be used throughout the code for presenting user tracebacks,
|
|
1283
|
rather than directly invoking the InteractiveTB object.
|
|
1283
|
rather than directly invoking the InteractiveTB object.
|
|
1284
|
|
|
1284
|
|
|
1285
|
A specific showsyntaxerror() also exists, but this method can take
|
|
1285
|
A specific showsyntaxerror() also exists, but this method can take
|
|
1286
|
care of calling it if needed, so unless you are explicitly catching a
|
|
1286
|
care of calling it if needed, so unless you are explicitly catching a
|
|
1287
|
SyntaxError exception, don't try to analyze the stack manually and
|
|
1287
|
SyntaxError exception, don't try to analyze the stack manually and
|
|
1288
|
simply call this method."""
|
|
1288
|
simply call this method."""
|
|
1289
|
|
|
1289
|
|
|
1290
|
try:
|
|
1290
|
try:
|
|
1291
|
if exc_tuple is None:
|
|
1291
|
if exc_tuple is None:
|
|
1292
|
etype, value, tb = sys.exc_info()
|
|
1292
|
etype, value, tb = sys.exc_info()
|
|
1293
|
else:
|
|
1293
|
else:
|
|
1294
|
etype, value, tb = exc_tuple
|
|
1294
|
etype, value, tb = exc_tuple
|
|
1295
|
|
|
1295
|
|
|
1296
|
if etype is None:
|
|
1296
|
if etype is None:
|
|
1297
|
if hasattr(sys, 'last_type'):
|
|
1297
|
if hasattr(sys, 'last_type'):
|
|
1298
|
etype, value, tb = sys.last_type, sys.last_value, \
|
|
1298
|
etype, value, tb = sys.last_type, sys.last_value, \
|
|
1299
|
sys.last_traceback
|
|
1299
|
sys.last_traceback
|
|
1300
|
else:
|
|
1300
|
else:
|
|
1301
|
self.write('No traceback available to show.\n')
|
|
1301
|
self.write('No traceback available to show.\n')
|
|
1302
|
return
|
|
1302
|
return
|
|
1303
|
|
|
1303
|
|
|
1304
|
if etype is SyntaxError:
|
|
1304
|
if etype is SyntaxError:
|
|
1305
|
# Though this won't be called by syntax errors in the input
|
|
1305
|
# Though this won't be called by syntax errors in the input
|
|
1306
|
# line, there may be SyntaxError cases whith imported code.
|
|
1306
|
# line, there may be SyntaxError cases whith imported code.
|
|
1307
|
self.showsyntaxerror(filename)
|
|
1307
|
self.showsyntaxerror(filename)
|
|
1308
|
elif etype is UsageError:
|
|
1308
|
elif etype is UsageError:
|
|
1309
|
print "UsageError:", value
|
|
1309
|
print "UsageError:", value
|
|
1310
|
else:
|
|
1310
|
else:
|
|
1311
|
# WARNING: these variables are somewhat deprecated and not
|
|
1311
|
# WARNING: these variables are somewhat deprecated and not
|
|
1312
|
# necessarily safe to use in a threaded environment, but tools
|
|
1312
|
# necessarily safe to use in a threaded environment, but tools
|
|
1313
|
# like pdb depend on their existence, so let's set them. If we
|
|
1313
|
# like pdb depend on their existence, so let's set them. If we
|
|
1314
|
# find problems in the field, we'll need to revisit their use.
|
|
1314
|
# find problems in the field, we'll need to revisit their use.
|
|
1315
|
sys.last_type = etype
|
|
1315
|
sys.last_type = etype
|
|
1316
|
sys.last_value = value
|
|
1316
|
sys.last_value = value
|
|
1317
|
sys.last_traceback = tb
|
|
1317
|
sys.last_traceback = tb
|
|
1318
|
|
|
1318
|
|
|
1319
|
if etype in self.custom_exceptions:
|
|
1319
|
if etype in self.custom_exceptions:
|
|
1320
|
self.CustomTB(etype,value,tb)
|
|
1320
|
self.CustomTB(etype,value,tb)
|
|
1321
|
else:
|
|
1321
|
else:
|
|
1322
|
if exception_only:
|
|
1322
|
if exception_only:
|
|
1323
|
m = ('An exception has occurred, use %tb to see the '
|
|
1323
|
m = ('An exception has occurred, use %tb to see the '
|
|
1324
|
'full traceback.')
|
|
1324
|
'full traceback.')
|
|
1325
|
print m
|
|
1325
|
print m
|
|
1326
|
self.InteractiveTB.show_exception_only(etype, value)
|
|
1326
|
self.InteractiveTB.show_exception_only(etype, value)
|
|
1327
|
else:
|
|
1327
|
else:
|
|
1328
|
self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
|
|
1328
|
self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
|
|
1329
|
if self.InteractiveTB.call_pdb:
|
|
1329
|
if self.InteractiveTB.call_pdb:
|
|
1330
|
# pdb mucks up readline, fix it back
|
|
1330
|
# pdb mucks up readline, fix it back
|
|
1331
|
self.set_completer()
|
|
1331
|
self.set_completer()
|
|
1332
|
|
|
1332
|
|
|
1333
|
except KeyboardInterrupt:
|
|
1333
|
except KeyboardInterrupt:
|
|
1334
|
self.write("\nKeyboardInterrupt\n")
|
|
1334
|
self.write("\nKeyboardInterrupt\n")
|
|
1335
|
|
|
1335
|
|
|
1336
|
|
|
1336
|
|
|
1337
|
def showsyntaxerror(self, filename=None):
|
|
1337
|
def showsyntaxerror(self, filename=None):
|
|
1338
|
"""Display the syntax error that just occurred.
|
|
1338
|
"""Display the syntax error that just occurred.
|
|
1339
|
|
|
1339
|
|
|
1340
|
This doesn't display a stack trace because there isn't one.
|
|
1340
|
This doesn't display a stack trace because there isn't one.
|
|
1341
|
|
|
1341
|
|
|
1342
|
If a filename is given, it is stuffed in the exception instead
|
|
1342
|
If a filename is given, it is stuffed in the exception instead
|
|
1343
|
of what was there before (because Python's parser always uses
|
|
1343
|
of what was there before (because Python's parser always uses
|
|
1344
|
"<string>" when reading from a string).
|
|
1344
|
"<string>" when reading from a string).
|
|
1345
|
"""
|
|
1345
|
"""
|
|
1346
|
etype, value, last_traceback = sys.exc_info()
|
|
1346
|
etype, value, last_traceback = sys.exc_info()
|
|
1347
|
|
|
1347
|
|
|
1348
|
# See note about these variables in showtraceback() above
|
|
1348
|
# See note about these variables in showtraceback() above
|
|
1349
|
sys.last_type = etype
|
|
1349
|
sys.last_type = etype
|
|
1350
|
sys.last_value = value
|
|
1350
|
sys.last_value = value
|
|
1351
|
sys.last_traceback = last_traceback
|
|
1351
|
sys.last_traceback = last_traceback
|
|
1352
|
|
|
1352
|
|
|
1353
|
if filename and etype is SyntaxError:
|
|
1353
|
if filename and etype is SyntaxError:
|
|
1354
|
# Work hard to stuff the correct filename in the exception
|
|
1354
|
# Work hard to stuff the correct filename in the exception
|
|
1355
|
try:
|
|
1355
|
try:
|
|
1356
|
msg, (dummy_filename, lineno, offset, line) = value
|
|
1356
|
msg, (dummy_filename, lineno, offset, line) = value
|
|
1357
|
except:
|
|
1357
|
except:
|
|
1358
|
# Not the format we expect; leave it alone
|
|
1358
|
# Not the format we expect; leave it alone
|
|
1359
|
pass
|
|
1359
|
pass
|
|
1360
|
else:
|
|
1360
|
else:
|
|
1361
|
# Stuff in the right filename
|
|
1361
|
# Stuff in the right filename
|
|
1362
|
try:
|
|
1362
|
try:
|
|
1363
|
# Assume SyntaxError is a class exception
|
|
1363
|
# Assume SyntaxError is a class exception
|
|
1364
|
value = SyntaxError(msg, (filename, lineno, offset, line))
|
|
1364
|
value = SyntaxError(msg, (filename, lineno, offset, line))
|
|
1365
|
except:
|
|
1365
|
except:
|
|
1366
|
# If that failed, assume SyntaxError is a string
|
|
1366
|
# If that failed, assume SyntaxError is a string
|
|
1367
|
value = msg, (filename, lineno, offset, line)
|
|
1367
|
value = msg, (filename, lineno, offset, line)
|
|
1368
|
self.SyntaxTB(etype,value,[])
|
|
1368
|
self.SyntaxTB(etype,value,[])
|
|
1369
|
|
|
1369
|
|
|
1370
|
def edit_syntax_error(self):
|
|
1370
|
def edit_syntax_error(self):
|
|
1371
|
"""The bottom half of the syntax error handler called in the main loop.
|
|
1371
|
"""The bottom half of the syntax error handler called in the main loop.
|
|
1372
|
|
|
1372
|
|
|
1373
|
Loop until syntax error is fixed or user cancels.
|
|
1373
|
Loop until syntax error is fixed or user cancels.
|
|
1374
|
"""
|
|
1374
|
"""
|
|
1375
|
|
|
1375
|
|
|
1376
|
while self.SyntaxTB.last_syntax_error:
|
|
1376
|
while self.SyntaxTB.last_syntax_error:
|
|
1377
|
# copy and clear last_syntax_error
|
|
1377
|
# copy and clear last_syntax_error
|
|
1378
|
err = self.SyntaxTB.clear_err_state()
|
|
1378
|
err = self.SyntaxTB.clear_err_state()
|
|
1379
|
if not self._should_recompile(err):
|
|
1379
|
if not self._should_recompile(err):
|
|
1380
|
return
|
|
1380
|
return
|
|
1381
|
try:
|
|
1381
|
try:
|
|
1382
|
# may set last_syntax_error again if a SyntaxError is raised
|
|
1382
|
# may set last_syntax_error again if a SyntaxError is raised
|
|
1383
|
self.safe_execfile(err.filename,self.user_ns)
|
|
1383
|
self.safe_execfile(err.filename,self.user_ns)
|
|
1384
|
except:
|
|
1384
|
except:
|
|
1385
|
self.showtraceback()
|
|
1385
|
self.showtraceback()
|
|
1386
|
else:
|
|
1386
|
else:
|
|
1387
|
try:
|
|
1387
|
try:
|
|
1388
|
f = file(err.filename)
|
|
1388
|
f = file(err.filename)
|
|
1389
|
try:
|
|
1389
|
try:
|
|
1390
|
# This should be inside a display_trap block and I
|
|
1390
|
# This should be inside a display_trap block and I
|
|
1391
|
# think it is.
|
|
1391
|
# think it is.
|
|
1392
|
sys.displayhook(f.read())
|
|
1392
|
sys.displayhook(f.read())
|
|
1393
|
finally:
|
|
1393
|
finally:
|
|
1394
|
f.close()
|
|
1394
|
f.close()
|
|
1395
|
except:
|
|
1395
|
except:
|
|
1396
|
self.showtraceback()
|
|
1396
|
self.showtraceback()
|
|
1397
|
|
|
1397
|
|
|
1398
|
def _should_recompile(self,e):
|
|
1398
|
def _should_recompile(self,e):
|
|
1399
|
"""Utility routine for edit_syntax_error"""
|
|
1399
|
"""Utility routine for edit_syntax_error"""
|
|
1400
|
|
|
1400
|
|
|
1401
|
if e.filename in ('<ipython console>','<input>','<string>',
|
|
1401
|
if e.filename in ('<ipython console>','<input>','<string>',
|
|
1402
|
'<console>','<BackgroundJob compilation>',
|
|
1402
|
'<console>','<BackgroundJob compilation>',
|
|
1403
|
None):
|
|
1403
|
None):
|
|
1404
|
|
|
1404
|
|
|
1405
|
return False
|
|
1405
|
return False
|
|
1406
|
try:
|
|
1406
|
try:
|
|
1407
|
if (self.autoedit_syntax and
|
|
1407
|
if (self.autoedit_syntax and
|
|
1408
|
not self.ask_yes_no('Return to editor to correct syntax error? '
|
|
1408
|
not self.ask_yes_no('Return to editor to correct syntax error? '
|
|
1409
|
'[Y/n] ','y')):
|
|
1409
|
'[Y/n] ','y')):
|
|
1410
|
return False
|
|
1410
|
return False
|
|
1411
|
except EOFError:
|
|
1411
|
except EOFError:
|
|
1412
|
return False
|
|
1412
|
return False
|
|
1413
|
|
|
1413
|
|
|
1414
|
def int0(x):
|
|
1414
|
def int0(x):
|
|
1415
|
try:
|
|
1415
|
try:
|
|
1416
|
return int(x)
|
|
1416
|
return int(x)
|
|
1417
|
except TypeError:
|
|
1417
|
except TypeError:
|
|
1418
|
return 0
|
|
1418
|
return 0
|
|
1419
|
# always pass integer line and offset values to editor hook
|
|
1419
|
# always pass integer line and offset values to editor hook
|
|
1420
|
try:
|
|
1420
|
try:
|
|
1421
|
self.hooks.fix_error_editor(e.filename,
|
|
1421
|
self.hooks.fix_error_editor(e.filename,
|
|
1422
|
int0(e.lineno),int0(e.offset),e.msg)
|
|
1422
|
int0(e.lineno),int0(e.offset),e.msg)
|
|
1423
|
except TryNext:
|
|
1423
|
except TryNext:
|
|
1424
|
warn('Could not open editor')
|
|
1424
|
warn('Could not open editor')
|
|
1425
|
return False
|
|
1425
|
return False
|
|
1426
|
return True
|
|
1426
|
return True
|
|
1427
|
|
|
1427
|
|
|
1428
|
#-------------------------------------------------------------------------
|
|
1428
|
#-------------------------------------------------------------------------
|
|
1429
|
# Things related to tab completion
|
|
1429
|
# Things related to tab completion
|
|
1430
|
#-------------------------------------------------------------------------
|
|
1430
|
#-------------------------------------------------------------------------
|
|
1431
|
|
|
1431
|
|
|
1432
|
def complete(self, text):
|
|
1432
|
def complete(self, text):
|
|
1433
|
"""Return a sorted list of all possible completions on text.
|
|
1433
|
"""Return a sorted list of all possible completions on text.
|
|
1434
|
|
|
1434
|
|
|
1435
|
Inputs:
|
|
1435
|
Inputs:
|
|
1436
|
|
|
1436
|
|
|
1437
|
- text: a string of text to be completed on.
|
|
1437
|
- text: a string of text to be completed on.
|
|
1438
|
|
|
1438
|
|
|
1439
|
This is a wrapper around the completion mechanism, similar to what
|
|
1439
|
This is a wrapper around the completion mechanism, similar to what
|
|
1440
|
readline does at the command line when the TAB key is hit. By
|
|
1440
|
readline does at the command line when the TAB key is hit. By
|
|
1441
|
exposing it as a method, it can be used by other non-readline
|
|
1441
|
exposing it as a method, it can be used by other non-readline
|
|
1442
|
environments (such as GUIs) for text completion.
|
|
1442
|
environments (such as GUIs) for text completion.
|
|
1443
|
|
|
1443
|
|
|
1444
|
Simple usage example:
|
|
1444
|
Simple usage example:
|
|
1445
|
|
|
1445
|
|
|
1446
|
In [7]: x = 'hello'
|
|
1446
|
In [7]: x = 'hello'
|
|
1447
|
|
|
1447
|
|
|
1448
|
In [8]: x
|
|
1448
|
In [8]: x
|
|
1449
|
Out[8]: 'hello'
|
|
1449
|
Out[8]: 'hello'
|
|
1450
|
|
|
1450
|
|
|
1451
|
In [9]: print x
|
|
1451
|
In [9]: print x
|
|
1452
|
hello
|
|
1452
|
hello
|
|
1453
|
|
|
1453
|
|
|
1454
|
In [10]: _ip.complete('x.l')
|
|
1454
|
In [10]: _ip.complete('x.l')
|
|
1455
|
Out[10]: ['x.ljust', 'x.lower', 'x.lstrip']
|
|
1455
|
Out[10]: ['x.ljust', 'x.lower', 'x.lstrip']
|
|
1456
|
"""
|
|
1456
|
"""
|
|
1457
|
|
|
1457
|
|
|
1458
|
# Inject names into __builtin__ so we can complete on the added names.
|
|
1458
|
# Inject names into __builtin__ so we can complete on the added names.
|
|
1459
|
with self.builtin_trap:
|
|
1459
|
with self.builtin_trap:
|
|
1460
|
complete = self.Completer.complete
|
|
1460
|
complete = self.Completer.complete
|
|
1461
|
state = 0
|
|
1461
|
state = 0
|
|
1462
|
# use a dict so we get unique keys, since ipyhton's multiple
|
|
1462
|
# use a dict so we get unique keys, since ipyhton's multiple
|
|
1463
|
# completers can return duplicates. When we make 2.4 a requirement,
|
|
1463
|
# completers can return duplicates. When we make 2.4 a requirement,
|
|
1464
|
# start using sets instead, which are faster.
|
|
1464
|
# start using sets instead, which are faster.
|
|
1465
|
comps = {}
|
|
1465
|
comps = {}
|
|
1466
|
while True:
|
|
1466
|
while True:
|
|
1467
|
newcomp = complete(text,state,line_buffer=text)
|
|
1467
|
newcomp = complete(text,state,line_buffer=text)
|
|
1468
|
if newcomp is None:
|
|
1468
|
if newcomp is None:
|
|
1469
|
break
|
|
1469
|
break
|
|
1470
|
comps[newcomp] = 1
|
|
1470
|
comps[newcomp] = 1
|
|
1471
|
state += 1
|
|
1471
|
state += 1
|
|
1472
|
outcomps = comps.keys()
|
|
1472
|
outcomps = comps.keys()
|
|
1473
|
outcomps.sort()
|
|
1473
|
outcomps.sort()
|
|
1474
|
#print "T:",text,"OC:",outcomps # dbg
|
|
1474
|
#print "T:",text,"OC:",outcomps # dbg
|
|
1475
|
#print "vars:",self.user_ns.keys()
|
|
1475
|
#print "vars:",self.user_ns.keys()
|
|
1476
|
return outcomps
|
|
1476
|
return outcomps
|
|
1477
|
|
|
1477
|
|
|
1478
|
def set_custom_completer(self,completer,pos=0):
|
|
1478
|
def set_custom_completer(self,completer,pos=0):
|
|
1479
|
"""Adds a new custom completer function.
|
|
1479
|
"""Adds a new custom completer function.
|
|
1480
|
|
|
1480
|
|
|
1481
|
The position argument (defaults to 0) is the index in the completers
|
|
1481
|
The position argument (defaults to 0) is the index in the completers
|
|
1482
|
list where you want the completer to be inserted."""
|
|
1482
|
list where you want the completer to be inserted."""
|
|
1483
|
|
|
1483
|
|
|
1484
|
newcomp = new.instancemethod(completer,self.Completer,
|
|
1484
|
newcomp = new.instancemethod(completer,self.Completer,
|
|
1485
|
self.Completer.__class__)
|
|
1485
|
self.Completer.__class__)
|
|
1486
|
self.Completer.matchers.insert(pos,newcomp)
|
|
1486
|
self.Completer.matchers.insert(pos,newcomp)
|
|
1487
|
|
|
1487
|
|
|
1488
|
def set_completer(self):
|
|
1488
|
def set_completer(self):
|
|
1489
|
"""Reset readline's completer to be our own."""
|
|
1489
|
"""Reset readline's completer to be our own."""
|
|
1490
|
self.readline.set_completer(self.Completer.complete)
|
|
1490
|
self.readline.set_completer(self.Completer.complete)
|
|
1491
|
|
|
1491
|
|
|
1492
|
def set_completer_frame(self, frame=None):
|
|
1492
|
def set_completer_frame(self, frame=None):
|
|
1493
|
"""Set the frame of the completer."""
|
|
1493
|
"""Set the frame of the completer."""
|
|
1494
|
if frame:
|
|
1494
|
if frame:
|
|
1495
|
self.Completer.namespace = frame.f_locals
|
|
1495
|
self.Completer.namespace = frame.f_locals
|
|
1496
|
self.Completer.global_namespace = frame.f_globals
|
|
1496
|
self.Completer.global_namespace = frame.f_globals
|
|
1497
|
else:
|
|
1497
|
else:
|
|
1498
|
self.Completer.namespace = self.user_ns
|
|
1498
|
self.Completer.namespace = self.user_ns
|
|
1499
|
self.Completer.global_namespace = self.user_global_ns
|
|
1499
|
self.Completer.global_namespace = self.user_global_ns
|
|
1500
|
|
|
1500
|
|
|
1501
|
#-------------------------------------------------------------------------
|
|
1501
|
#-------------------------------------------------------------------------
|
|
1502
|
# Things related to readline
|
|
1502
|
# Things related to readline
|
|
1503
|
#-------------------------------------------------------------------------
|
|
1503
|
#-------------------------------------------------------------------------
|
|
1504
|
|
|
1504
|
|
|
1505
|
def init_readline(self):
|
|
1505
|
def init_readline(self):
|
|
1506
|
"""Command history completion/saving/reloading."""
|
|
1506
|
"""Command history completion/saving/reloading."""
|
|
1507
|
|
|
1507
|
|
|
1508
|
if self.readline_use:
|
|
1508
|
if self.readline_use:
|
|
1509
|
import IPython.utils.rlineimpl as readline
|
|
1509
|
import IPython.utils.rlineimpl as readline
|
|
1510
|
|
|
1510
|
|
|
1511
|
self.rl_next_input = None
|
|
1511
|
self.rl_next_input = None
|
|
1512
|
self.rl_do_indent = False
|
|
1512
|
self.rl_do_indent = False
|
|
1513
|
|
|
1513
|
|
|
1514
|
if not self.readline_use or not readline.have_readline:
|
|
1514
|
if not self.readline_use or not readline.have_readline:
|
|
1515
|
self.has_readline = False
|
|
1515
|
self.has_readline = False
|
|
1516
|
self.readline = None
|
|
1516
|
self.readline = None
|
|
1517
|
# Set a number of methods that depend on readline to be no-op
|
|
1517
|
# Set a number of methods that depend on readline to be no-op
|
|
1518
|
self.savehist = no_op
|
|
1518
|
self.savehist = no_op
|
|
1519
|
self.reloadhist = no_op
|
|
1519
|
self.reloadhist = no_op
|
|
1520
|
self.set_completer = no_op
|
|
1520
|
self.set_completer = no_op
|
|
1521
|
self.set_custom_completer = no_op
|
|
1521
|
self.set_custom_completer = no_op
|
|
1522
|
self.set_completer_frame = no_op
|
|
1522
|
self.set_completer_frame = no_op
|
|
1523
|
warn('Readline services not available or not loaded.')
|
|
1523
|
warn('Readline services not available or not loaded.')
|
|
1524
|
else:
|
|
1524
|
else:
|
|
1525
|
self.has_readline = True
|
|
1525
|
self.has_readline = True
|
|
1526
|
self.readline = readline
|
|
1526
|
self.readline = readline
|
|
1527
|
sys.modules['readline'] = readline
|
|
1527
|
sys.modules['readline'] = readline
|
|
1528
|
import atexit
|
|
1528
|
import atexit
|
|
1529
|
from IPython.core.completer import IPCompleter
|
|
1529
|
from IPython.core.completer import IPCompleter
|
|
1530
|
self.Completer = IPCompleter(self,
|
|
1530
|
self.Completer = IPCompleter(self,
|
|
1531
|
self.user_ns,
|
|
1531
|
self.user_ns,
|
|
1532
|
self.user_global_ns,
|
|
1532
|
self.user_global_ns,
|
|
1533
|
self.readline_omit__names,
|
|
1533
|
self.readline_omit__names,
|
|
1534
|
self.alias_manager.alias_table)
|
|
1534
|
self.alias_manager.alias_table)
|
|
1535
|
sdisp = self.strdispatchers.get('complete_command', StrDispatch())
|
|
1535
|
sdisp = self.strdispatchers.get('complete_command', StrDispatch())
|
|
1536
|
self.strdispatchers['complete_command'] = sdisp
|
|
1536
|
self.strdispatchers['complete_command'] = sdisp
|
|
1537
|
self.Completer.custom_completers = sdisp
|
|
1537
|
self.Completer.custom_completers = sdisp
|
|
1538
|
# Platform-specific configuration
|
|
1538
|
# Platform-specific configuration
|
|
1539
|
if os.name == 'nt':
|
|
1539
|
if os.name == 'nt':
|
|
1540
|
self.readline_startup_hook = readline.set_pre_input_hook
|
|
1540
|
self.readline_startup_hook = readline.set_pre_input_hook
|
|
1541
|
else:
|
|
1541
|
else:
|
|
1542
|
self.readline_startup_hook = readline.set_startup_hook
|
|
1542
|
self.readline_startup_hook = readline.set_startup_hook
|
|
1543
|
|
|
1543
|
|
|
1544
|
# Load user's initrc file (readline config)
|
|
1544
|
# Load user's initrc file (readline config)
|
|
1545
|
# Or if libedit is used, load editrc.
|
|
1545
|
# Or if libedit is used, load editrc.
|
|
1546
|
inputrc_name = os.environ.get('INPUTRC')
|
|
1546
|
inputrc_name = os.environ.get('INPUTRC')
|
|
1547
|
if inputrc_name is None:
|
|
1547
|
if inputrc_name is None:
|
|
1548
|
home_dir = get_home_dir()
|
|
1548
|
home_dir = get_home_dir()
|
|
1549
|
if home_dir is not None:
|
|
1549
|
if home_dir is not None:
|
|
1550
|
inputrc_name = '.inputrc'
|
|
1550
|
inputrc_name = '.inputrc'
|
|
1551
|
if readline.uses_libedit:
|
|
1551
|
if readline.uses_libedit:
|
|
1552
|
inputrc_name = '.editrc'
|
|
1552
|
inputrc_name = '.editrc'
|
|
1553
|
inputrc_name = os.path.join(home_dir, inputrc_name)
|
|
1553
|
inputrc_name = os.path.join(home_dir, inputrc_name)
|
|
1554
|
if os.path.isfile(inputrc_name):
|
|
1554
|
if os.path.isfile(inputrc_name):
|
|
1555
|
try:
|
|
1555
|
try:
|
|
1556
|
readline.read_init_file(inputrc_name)
|
|
1556
|
readline.read_init_file(inputrc_name)
|
|
1557
|
except:
|
|
1557
|
except:
|
|
1558
|
warn('Problems reading readline initialization file <%s>'
|
|
1558
|
warn('Problems reading readline initialization file <%s>'
|
|
1559
|
% inputrc_name)
|
|
1559
|
% inputrc_name)
|
|
1560
|
|
|
1560
|
|
|
1561
|
# save this in sys so embedded copies can restore it properly
|
|
1561
|
# save this in sys so embedded copies can restore it properly
|
|
1562
|
sys.ipcompleter = self.Completer.complete
|
|
1562
|
sys.ipcompleter = self.Completer.complete
|
|
1563
|
self.set_completer()
|
|
1563
|
self.set_completer()
|
|
1564
|
|
|
1564
|
|
|
1565
|
# Configure readline according to user's prefs
|
|
1565
|
# Configure readline according to user's prefs
|
|
1566
|
# This is only done if GNU readline is being used. If libedit
|
|
1566
|
# This is only done if GNU readline is being used. If libedit
|
|
1567
|
# is being used (as on Leopard) the readline config is
|
|
1567
|
# is being used (as on Leopard) the readline config is
|
|
1568
|
# not run as the syntax for libedit is different.
|
|
1568
|
# not run as the syntax for libedit is different.
|
|
1569
|
if not readline.uses_libedit:
|
|
1569
|
if not readline.uses_libedit:
|
|
1570
|
for rlcommand in self.readline_parse_and_bind:
|
|
1570
|
for rlcommand in self.readline_parse_and_bind:
|
|
1571
|
#print "loading rl:",rlcommand # dbg
|
|
1571
|
#print "loading rl:",rlcommand # dbg
|
|
1572
|
readline.parse_and_bind(rlcommand)
|
|
1572
|
readline.parse_and_bind(rlcommand)
|
|
1573
|
|
|
1573
|
|
|
1574
|
# Remove some chars from the delimiters list. If we encounter
|
|
1574
|
# Remove some chars from the delimiters list. If we encounter
|
|
1575
|
# unicode chars, discard them.
|
|
1575
|
# unicode chars, discard them.
|
|
1576
|
delims = readline.get_completer_delims().encode("ascii", "ignore")
|
|
1576
|
delims = readline.get_completer_delims().encode("ascii", "ignore")
|
|
1577
|
delims = delims.translate(string._idmap,
|
|
1577
|
delims = delims.translate(string._idmap,
|
|
1578
|
self.readline_remove_delims)
|
|
1578
|
self.readline_remove_delims)
|
|
1579
|
readline.set_completer_delims(delims)
|
|
1579
|
readline.set_completer_delims(delims)
|
|
1580
|
# otherwise we end up with a monster history after a while:
|
|
1580
|
# otherwise we end up with a monster history after a while:
|
|
1581
|
readline.set_history_length(1000)
|
|
1581
|
readline.set_history_length(1000)
|
|
1582
|
try:
|
|
1582
|
try:
|
|
1583
|
#print '*** Reading readline history' # dbg
|
|
1583
|
#print '*** Reading readline history' # dbg
|
|
1584
|
readline.read_history_file(self.histfile)
|
|
1584
|
readline.read_history_file(self.histfile)
|
|
1585
|
except IOError:
|
|
1585
|
except IOError:
|
|
1586
|
pass # It doesn't exist yet.
|
|
1586
|
pass # It doesn't exist yet.
|
|
1587
|
|
|
1587
|
|
|
1588
|
atexit.register(self.atexit_operations)
|
|
1588
|
atexit.register(self.atexit_operations)
|
|
1589
|
del atexit
|
|
1589
|
del atexit
|
|
1590
|
|
|
1590
|
|
|
1591
|
# Configure auto-indent for all platforms
|
|
1591
|
# Configure auto-indent for all platforms
|
|
1592
|
self.set_autoindent(self.autoindent)
|
|
1592
|
self.set_autoindent(self.autoindent)
|
|
1593
|
|
|
1593
|
|
|
1594
|
def set_next_input(self, s):
|
|
1594
|
def set_next_input(self, s):
|
|
1595
|
""" Sets the 'default' input string for the next command line.
|
|
1595
|
""" Sets the 'default' input string for the next command line.
|
|
1596
|
|
|
1596
|
|
|
1597
|
Requires readline.
|
|
1597
|
Requires readline.
|
|
1598
|
|
|
1598
|
|
|
1599
|
Example:
|
|
1599
|
Example:
|
|
1600
|
|
|
1600
|
|
|
1601
|
[D:\ipython]|1> _ip.set_next_input("Hello Word")
|
|
1601
|
[D:\ipython]|1> _ip.set_next_input("Hello Word")
|
|
1602
|
[D:\ipython]|2> Hello Word_ # cursor is here
|
|
1602
|
[D:\ipython]|2> Hello Word_ # cursor is here
|
|
1603
|
"""
|
|
1603
|
"""
|
|
1604
|
|
|
1604
|
|
|
1605
|
self.rl_next_input = s
|
|
1605
|
self.rl_next_input = s
|
|
1606
|
|
|
1606
|
|
|
1607
|
def pre_readline(self):
|
|
1607
|
def pre_readline(self):
|
|
1608
|
"""readline hook to be used at the start of each line.
|
|
1608
|
"""readline hook to be used at the start of each line.
|
|
1609
|
|
|
1609
|
|
|
1610
|
Currently it handles auto-indent only."""
|
|
1610
|
Currently it handles auto-indent only."""
|
|
1611
|
|
|
1611
|
|
|
1612
|
#debugx('self.indent_current_nsp','pre_readline:')
|
|
1612
|
#debugx('self.indent_current_nsp','pre_readline:')
|
|
1613
|
|
|
1613
|
|
|
1614
|
if self.rl_do_indent:
|
|
1614
|
if self.rl_do_indent:
|
|
1615
|
self.readline.insert_text(self._indent_current_str())
|
|
1615
|
self.readline.insert_text(self._indent_current_str())
|
|
1616
|
if self.rl_next_input is not None:
|
|
1616
|
if self.rl_next_input is not None:
|
|
1617
|
self.readline.insert_text(self.rl_next_input)
|
|
1617
|
self.readline.insert_text(self.rl_next_input)
|
|
1618
|
self.rl_next_input = None
|
|
1618
|
self.rl_next_input = None
|
|
1619
|
|
|
1619
|
|
|
1620
|
def _indent_current_str(self):
|
|
1620
|
def _indent_current_str(self):
|
|
1621
|
"""return the current level of indentation as a string"""
|
|
1621
|
"""return the current level of indentation as a string"""
|
|
1622
|
return self.indent_current_nsp * ' '
|
|
1622
|
return self.indent_current_nsp * ' '
|
|
1623
|
|
|
1623
|
|
|
1624
|
#-------------------------------------------------------------------------
|
|
1624
|
#-------------------------------------------------------------------------
|
|
1625
|
# Things related to magics
|
|
1625
|
# Things related to magics
|
|
1626
|
#-------------------------------------------------------------------------
|
|
1626
|
#-------------------------------------------------------------------------
|
|
1627
|
|
|
1627
|
|
|
1628
|
def init_magics(self):
|
|
1628
|
def init_magics(self):
|
|
1629
|
# Set user colors (don't do it in the constructor above so that it
|
|
1629
|
# Set user colors (don't do it in the constructor above so that it
|
|
1630
|
# doesn't crash if colors option is invalid)
|
|
1630
|
# doesn't crash if colors option is invalid)
|
|
1631
|
self.magic_colors(self.colors)
|
|
1631
|
self.magic_colors(self.colors)
|
|
1632
|
# History was moved to a separate module
|
|
1632
|
# History was moved to a separate module
|
|
1633
|
from . import history
|
|
1633
|
from . import history
|
|
1634
|
history.init_ipython(self)
|
|
1634
|
history.init_ipython(self)
|
|
1635
|
|
|
1635
|
|
|
1636
|
def magic(self,arg_s):
|
|
1636
|
def magic(self,arg_s):
|
|
1637
|
"""Call a magic function by name.
|
|
1637
|
"""Call a magic function by name.
|
|
1638
|
|
|
1638
|
|
|
1639
|
Input: a string containing the name of the magic function to call and any
|
|
1639
|
Input: a string containing the name of the magic function to call and any
|
|
1640
|
additional arguments to be passed to the magic.
|
|
1640
|
additional arguments to be passed to the magic.
|
|
1641
|
|
|
1641
|
|
|
1642
|
magic('name -opt foo bar') is equivalent to typing at the ipython
|
|
1642
|
magic('name -opt foo bar') is equivalent to typing at the ipython
|
|
1643
|
prompt:
|
|
1643
|
prompt:
|
|
1644
|
|
|
1644
|
|
|
1645
|
In[1]: %name -opt foo bar
|
|
1645
|
In[1]: %name -opt foo bar
|
|
1646
|
|
|
1646
|
|
|
1647
|
To call a magic without arguments, simply use magic('name').
|
|
1647
|
To call a magic without arguments, simply use magic('name').
|
|
1648
|
|
|
1648
|
|
|
1649
|
This provides a proper Python function to call IPython's magics in any
|
|
1649
|
This provides a proper Python function to call IPython's magics in any
|
|
1650
|
valid Python code you can type at the interpreter, including loops and
|
|
1650
|
valid Python code you can type at the interpreter, including loops and
|
|
1651
|
compound statements.
|
|
1651
|
compound statements.
|
|
1652
|
"""
|
|
1652
|
"""
|
|
1653
|
args = arg_s.split(' ',1)
|
|
1653
|
args = arg_s.split(' ',1)
|
|
1654
|
magic_name = args[0]
|
|
1654
|
magic_name = args[0]
|
|
1655
|
magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
|
|
1655
|
magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
|
|
1656
|
|
|
1656
|
|
|
1657
|
try:
|
|
1657
|
try:
|
|
1658
|
magic_args = args[1]
|
|
1658
|
magic_args = args[1]
|
|
1659
|
except IndexError:
|
|
1659
|
except IndexError:
|
|
1660
|
magic_args = ''
|
|
1660
|
magic_args = ''
|
|
1661
|
fn = getattr(self,'magic_'+magic_name,None)
|
|
1661
|
fn = getattr(self,'magic_'+magic_name,None)
|
|
1662
|
if fn is None:
|
|
1662
|
if fn is None:
|
|
1663
|
error("Magic function `%s` not found." % magic_name)
|
|
1663
|
error("Magic function `%s` not found." % magic_name)
|
|
1664
|
else:
|
|
1664
|
else:
|
|
1665
|
magic_args = self.var_expand(magic_args,1)
|
|
1665
|
magic_args = self.var_expand(magic_args,1)
|
|
1666
|
with nested(self.builtin_trap,):
|
|
1666
|
with nested(self.builtin_trap,):
|
|
1667
|
result = fn(magic_args)
|
|
1667
|
result = fn(magic_args)
|
|
1668
|
return result
|
|
1668
|
return result
|
|
1669
|
|
|
1669
|
|
|
1670
|
def define_magic(self, magicname, func):
|
|
1670
|
def define_magic(self, magicname, func):
|
|
1671
|
"""Expose own function as magic function for ipython
|
|
1671
|
"""Expose own function as magic function for ipython
|
|
1672
|
|
|
1672
|
|
|
1673
|
def foo_impl(self,parameter_s=''):
|
|
1673
|
def foo_impl(self,parameter_s=''):
|
|
1674
|
'My very own magic!. (Use docstrings, IPython reads them).'
|
|
1674
|
'My very own magic!. (Use docstrings, IPython reads them).'
|
|
1675
|
print 'Magic function. Passed parameter is between < >:'
|
|
1675
|
print 'Magic function. Passed parameter is between < >:'
|
|
1676
|
print '<%s>' % parameter_s
|
|
1676
|
print '<%s>' % parameter_s
|
|
1677
|
print 'The self object is:',self
|
|
1677
|
print 'The self object is:',self
|
|
1678
|
|
|
1678
|
|
|
1679
|
self.define_magic('foo',foo_impl)
|
|
1679
|
self.define_magic('foo',foo_impl)
|
|
1680
|
"""
|
|
1680
|
"""
|
|
1681
|
|
|
1681
|
|
|
1682
|
import new
|
|
1682
|
import new
|
|
1683
|
im = new.instancemethod(func,self, self.__class__)
|
|
1683
|
im = new.instancemethod(func,self, self.__class__)
|
|
1684
|
old = getattr(self, "magic_" + magicname, None)
|
|
1684
|
old = getattr(self, "magic_" + magicname, None)
|
|
1685
|
setattr(self, "magic_" + magicname, im)
|
|
1685
|
setattr(self, "magic_" + magicname, im)
|
|
1686
|
return old
|
|
1686
|
return old
|
|
1687
|
|
|
1687
|
|
|
1688
|
#-------------------------------------------------------------------------
|
|
1688
|
#-------------------------------------------------------------------------
|
|
1689
|
# Things related to macros
|
|
1689
|
# Things related to macros
|
|
1690
|
#-------------------------------------------------------------------------
|
|
1690
|
#-------------------------------------------------------------------------
|
|
1691
|
|
|
1691
|
|
|
1692
|
def define_macro(self, name, themacro):
|
|
1692
|
def define_macro(self, name, themacro):
|
|
1693
|
"""Define a new macro
|
|
1693
|
"""Define a new macro
|
|
1694
|
|
|
1694
|
|
|
1695
|
Parameters
|
|
1695
|
Parameters
|
|
1696
|
----------
|
|
1696
|
----------
|
|
1697
|
name : str
|
|
1697
|
name : str
|
|
1698
|
The name of the macro.
|
|
1698
|
The name of the macro.
|
|
1699
|
themacro : str or Macro
|
|
1699
|
themacro : str or Macro
|
|
1700
|
The action to do upon invoking the macro. If a string, a new
|
|
1700
|
The action to do upon invoking the macro. If a string, a new
|
|
1701
|
Macro object is created by passing the string to it.
|
|
1701
|
Macro object is created by passing the string to it.
|
|
1702
|
"""
|
|
1702
|
"""
|
|
1703
|
|
|
1703
|
|
|
1704
|
from IPython.core import macro
|
|
1704
|
from IPython.core import macro
|
|
1705
|
|
|
1705
|
|
|
1706
|
if isinstance(themacro, basestring):
|
|
1706
|
if isinstance(themacro, basestring):
|
|
1707
|
themacro = macro.Macro(themacro)
|
|
1707
|
themacro = macro.Macro(themacro)
|
|
1708
|
if not isinstance(themacro, macro.Macro):
|
|
1708
|
if not isinstance(themacro, macro.Macro):
|
|
1709
|
raise ValueError('A macro must be a string or a Macro instance.')
|
|
1709
|
raise ValueError('A macro must be a string or a Macro instance.')
|
|
1710
|
self.user_ns[name] = themacro
|
|
1710
|
self.user_ns[name] = themacro
|
|
1711
|
|
|
1711
|
|
|
1712
|
#-------------------------------------------------------------------------
|
|
1712
|
#-------------------------------------------------------------------------
|
|
1713
|
# Things related to the running of system commands
|
|
1713
|
# Things related to the running of system commands
|
|
1714
|
#-------------------------------------------------------------------------
|
|
1714
|
#-------------------------------------------------------------------------
|
|
1715
|
|
|
1715
|
|
|
1716
|
def system(self, cmd):
|
|
1716
|
def system(self, cmd):
|
|
1717
|
"""Make a system call, using IPython."""
|
|
1717
|
"""Make a system call, using IPython."""
|
|
1718
|
return self.hooks.shell_hook(self.var_expand(cmd, depth=2))
|
|
1718
|
return self.hooks.shell_hook(self.var_expand(cmd, depth=2))
|
|
1719
|
|
|
1719
|
|
|
1720
|
#-------------------------------------------------------------------------
|
|
1720
|
#-------------------------------------------------------------------------
|
|
1721
|
# Things related to aliases
|
|
1721
|
# Things related to aliases
|
|
1722
|
#-------------------------------------------------------------------------
|
|
1722
|
#-------------------------------------------------------------------------
|
|
1723
|
|
|
1723
|
|
|
1724
|
def init_alias(self):
|
|
1724
|
def init_alias(self):
|
|
1725
|
self.alias_manager = AliasManager(self, config=self.config)
|
|
1725
|
self.alias_manager = AliasManager(self, config=self.config)
|
|
1726
|
self.ns_table['alias'] = self.alias_manager.alias_table,
|
|
1726
|
self.ns_table['alias'] = self.alias_manager.alias_table,
|
|
1727
|
|
|
1727
|
|
|
1728
|
#-------------------------------------------------------------------------
|
|
1728
|
#-------------------------------------------------------------------------
|
|
1729
|
# Things related to the running of code
|
|
1729
|
# Things related to the running of code
|
|
1730
|
#-------------------------------------------------------------------------
|
|
1730
|
#-------------------------------------------------------------------------
|
|
1731
|
|
|
1731
|
|
|
1732
|
def ex(self, cmd):
|
|
1732
|
def ex(self, cmd):
|
|
1733
|
"""Execute a normal python statement in user namespace."""
|
|
1733
|
"""Execute a normal python statement in user namespace."""
|
|
1734
|
with nested(self.builtin_trap,):
|
|
1734
|
with nested(self.builtin_trap,):
|
|
1735
|
exec cmd in self.user_global_ns, self.user_ns
|
|
1735
|
exec cmd in self.user_global_ns, self.user_ns
|
|
1736
|
|
|
1736
|
|
|
1737
|
def ev(self, expr):
|
|
1737
|
def ev(self, expr):
|
|
1738
|
"""Evaluate python expression expr in user namespace.
|
|
1738
|
"""Evaluate python expression expr in user namespace.
|
|
1739
|
|
|
1739
|
|
|
1740
|
Returns the result of evaluation
|
|
1740
|
Returns the result of evaluation
|
|
1741
|
"""
|
|
1741
|
"""
|
|
1742
|
with nested(self.builtin_trap,):
|
|
1742
|
with nested(self.builtin_trap,):
|
|
1743
|
return eval(expr, self.user_global_ns, self.user_ns)
|
|
1743
|
return eval(expr, self.user_global_ns, self.user_ns)
|
|
1744
|
|
|
1744
|
|
|
1745
|
def mainloop(self, display_banner=None):
|
|
1745
|
def mainloop(self, display_banner=None):
|
|
1746
|
"""Start the mainloop.
|
|
1746
|
"""Start the mainloop.
|
|
1747
|
|
|
1747
|
|
|
1748
|
If an optional banner argument is given, it will override the
|
|
1748
|
If an optional banner argument is given, it will override the
|
|
1749
|
internally created default banner.
|
|
1749
|
internally created default banner.
|
|
1750
|
"""
|
|
1750
|
"""
|
|
1751
|
|
|
1751
|
|
|
1752
|
with nested(self.builtin_trap, self.display_trap):
|
|
1752
|
with nested(self.builtin_trap, self.display_trap):
|
|
1753
|
|
|
1753
|
|
|
1754
|
# if you run stuff with -c <cmd>, raw hist is not updated
|
|
1754
|
# if you run stuff with -c <cmd>, raw hist is not updated
|
|
1755
|
# ensure that it's in sync
|
|
1755
|
# ensure that it's in sync
|
|
1756
|
if len(self.input_hist) != len (self.input_hist_raw):
|
|
1756
|
if len(self.input_hist) != len (self.input_hist_raw):
|
|
1757
|
self.input_hist_raw = InputList(self.input_hist)
|
|
1757
|
self.input_hist_raw = InputList(self.input_hist)
|
|
1758
|
|
|
1758
|
|
|
1759
|
while 1:
|
|
1759
|
while 1:
|
|
1760
|
try:
|
|
1760
|
try:
|
|
1761
|
self.interact(display_banner=display_banner)
|
|
1761
|
self.interact(display_banner=display_banner)
|
|
1762
|
#self.interact_with_readline()
|
|
1762
|
#self.interact_with_readline()
|
|
1763
|
# XXX for testing of a readline-decoupled repl loop, call
|
|
1763
|
# XXX for testing of a readline-decoupled repl loop, call
|
|
1764
|
# interact_with_readline above
|
|
1764
|
# interact_with_readline above
|
|
1765
|
break
|
|
1765
|
break
|
|
1766
|
except KeyboardInterrupt:
|
|
1766
|
except KeyboardInterrupt:
|
|
1767
|
# this should not be necessary, but KeyboardInterrupt
|
|
1767
|
# this should not be necessary, but KeyboardInterrupt
|
|
1768
|
# handling seems rather unpredictable...
|
|
1768
|
# handling seems rather unpredictable...
|
|
1769
|
self.write("\nKeyboardInterrupt in interact()\n")
|
|
1769
|
self.write("\nKeyboardInterrupt in interact()\n")
|
|
1770
|
|
|
1770
|
|
|
1771
|
def interact_prompt(self):
|
|
1771
|
def interact_prompt(self):
|
|
1772
|
""" Print the prompt (in read-eval-print loop)
|
|
1772
|
""" Print the prompt (in read-eval-print loop)
|
|
1773
|
|
|
1773
|
|
|
1774
|
Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
|
|
1774
|
Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
|
|
1775
|
used in standard IPython flow.
|
|
1775
|
used in standard IPython flow.
|
|
1776
|
"""
|
|
1776
|
"""
|
|
1777
|
if self.more:
|
|
1777
|
if self.more:
|
|
1778
|
try:
|
|
1778
|
try:
|
|
1779
|
prompt = self.hooks.generate_prompt(True)
|
|
1779
|
prompt = self.hooks.generate_prompt(True)
|
|
1780
|
except:
|
|
1780
|
except:
|
|
1781
|
self.showtraceback()
|
|
1781
|
self.showtraceback()
|
|
1782
|
if self.autoindent:
|
|
1782
|
if self.autoindent:
|
|
1783
|
self.rl_do_indent = True
|
|
1783
|
self.rl_do_indent = True
|
|
1784
|
|
|
1784
|
|
|
1785
|
else:
|
|
1785
|
else:
|
|
1786
|
try:
|
|
1786
|
try:
|
|
1787
|
prompt = self.hooks.generate_prompt(False)
|
|
1787
|
prompt = self.hooks.generate_prompt(False)
|
|
1788
|
except:
|
|
1788
|
except:
|
|
1789
|
self.showtraceback()
|
|
1789
|
self.showtraceback()
|
|
1790
|
self.write(prompt)
|
|
1790
|
self.write(prompt)
|
|
1791
|
|
|
1791
|
|
|
1792
|
def interact_handle_input(self,line):
|
|
1792
|
def interact_handle_input(self,line):
|
|
1793
|
""" Handle the input line (in read-eval-print loop)
|
|
1793
|
""" Handle the input line (in read-eval-print loop)
|
|
1794
|
|
|
1794
|
|
|
1795
|
Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
|
|
1795
|
Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
|
|
1796
|
used in standard IPython flow.
|
|
1796
|
used in standard IPython flow.
|
|
1797
|
"""
|
|
1797
|
"""
|
|
1798
|
if line.lstrip() == line:
|
|
1798
|
if line.lstrip() == line:
|
|
1799
|
self.shadowhist.add(line.strip())
|
|
1799
|
self.shadowhist.add(line.strip())
|
|
1800
|
lineout = self.prefilter_manager.prefilter_lines(line,self.more)
|
|
1800
|
lineout = self.prefilter_manager.prefilter_lines(line,self.more)
|
|
1801
|
|
|
1801
|
|
|
1802
|
if line.strip():
|
|
1802
|
if line.strip():
|
|
1803
|
if self.more:
|
|
1803
|
if self.more:
|
|
1804
|
self.input_hist_raw[-1] += '%s\n' % line
|
|
1804
|
self.input_hist_raw[-1] += '%s\n' % line
|
|
1805
|
else:
|
|
1805
|
else:
|
|
1806
|
self.input_hist_raw.append('%s\n' % line)
|
|
1806
|
self.input_hist_raw.append('%s\n' % line)
|
|
1807
|
|
|
1807
|
|
|
1808
|
|
|
1808
|
|
|
1809
|
self.more = self.push_line(lineout)
|
|
1809
|
self.more = self.push_line(lineout)
|
|
1810
|
if (self.SyntaxTB.last_syntax_error and
|
|
1810
|
if (self.SyntaxTB.last_syntax_error and
|
|
1811
|
self.autoedit_syntax):
|
|
1811
|
self.autoedit_syntax):
|
|
1812
|
self.edit_syntax_error()
|
|
1812
|
self.edit_syntax_error()
|
|
1813
|
|
|
1813
|
|
|
1814
|
def interact_with_readline(self):
|
|
1814
|
def interact_with_readline(self):
|
|
1815
|
""" Demo of using interact_handle_input, interact_prompt
|
|
1815
|
""" Demo of using interact_handle_input, interact_prompt
|
|
1816
|
|
|
1816
|
|
|
1817
|
This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
|
|
1817
|
This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
|
|
1818
|
it should work like this.
|
|
1818
|
it should work like this.
|
|
1819
|
"""
|
|
1819
|
"""
|
|
1820
|
self.readline_startup_hook(self.pre_readline)
|
|
1820
|
self.readline_startup_hook(self.pre_readline)
|
|
1821
|
while not self.exit_now:
|
|
1821
|
while not self.exit_now:
|
|
1822
|
self.interact_prompt()
|
|
1822
|
self.interact_prompt()
|
|
1823
|
if self.more:
|
|
1823
|
if self.more:
|
|
1824
|
self.rl_do_indent = True
|
|
1824
|
self.rl_do_indent = True
|
|
1825
|
else:
|
|
1825
|
else:
|
|
1826
|
self.rl_do_indent = False
|
|
1826
|
self.rl_do_indent = False
|
|
1827
|
line = raw_input_original().decode(self.stdin_encoding)
|
|
1827
|
line = raw_input_original().decode(self.stdin_encoding)
|
|
1828
|
self.interact_handle_input(line)
|
|
1828
|
self.interact_handle_input(line)
|
|
1829
|
|
|
1829
|
|
|
1830
|
def interact(self, display_banner=None):
|
|
1830
|
def interact(self, display_banner=None):
|
|
1831
|
"""Closely emulate the interactive Python console."""
|
|
1831
|
"""Closely emulate the interactive Python console."""
|
|
1832
|
|
|
1832
|
|
|
1833
|
# batch run -> do not interact
|
|
1833
|
# batch run -> do not interact
|
|
1834
|
if self.exit_now:
|
|
1834
|
if self.exit_now:
|
|
1835
|
return
|
|
1835
|
return
|
|
1836
|
|
|
1836
|
|
|
1837
|
if display_banner is None:
|
|
1837
|
if display_banner is None:
|
|
1838
|
display_banner = self.display_banner
|
|
1838
|
display_banner = self.display_banner
|
|
1839
|
if display_banner:
|
|
1839
|
if display_banner:
|
|
1840
|
self.show_banner()
|
|
1840
|
self.show_banner()
|
|
1841
|
|
|
1841
|
|
|
1842
|
more = 0
|
|
1842
|
more = 0
|
|
1843
|
|
|
1843
|
|
|
1844
|
# Mark activity in the builtins
|
|
1844
|
# Mark activity in the builtins
|
|
1845
|
__builtin__.__dict__['__IPYTHON__active'] += 1
|
|
1845
|
__builtin__.__dict__['__IPYTHON__active'] += 1
|
|
1846
|
|
|
1846
|
|
|
1847
|
if self.has_readline:
|
|
1847
|
if self.has_readline:
|
|
1848
|
self.readline_startup_hook(self.pre_readline)
|
|
1848
|
self.readline_startup_hook(self.pre_readline)
|
|
1849
|
# exit_now is set by a call to %Exit or %Quit, through the
|
|
1849
|
# exit_now is set by a call to %Exit or %Quit, through the
|
|
1850
|
# ask_exit callback.
|
|
1850
|
# ask_exit callback.
|
|
1851
|
|
|
1851
|
|
|
1852
|
while not self.exit_now:
|
|
1852
|
while not self.exit_now:
|
|
1853
|
self.hooks.pre_prompt_hook()
|
|
1853
|
self.hooks.pre_prompt_hook()
|
|
1854
|
if more:
|
|
1854
|
if more:
|
|
1855
|
try:
|
|
1855
|
try:
|
|
1856
|
prompt = self.hooks.generate_prompt(True)
|
|
1856
|
prompt = self.hooks.generate_prompt(True)
|
|
1857
|
except:
|
|
1857
|
except:
|
|
1858
|
self.showtraceback()
|
|
1858
|
self.showtraceback()
|
|
1859
|
if self.autoindent:
|
|
1859
|
if self.autoindent:
|
|
1860
|
self.rl_do_indent = True
|
|
1860
|
self.rl_do_indent = True
|
|
1861
|
|
|
1861
|
|
|
1862
|
else:
|
|
1862
|
else:
|
|
1863
|
try:
|
|
1863
|
try:
|
|
1864
|
prompt = self.hooks.generate_prompt(False)
|
|
1864
|
prompt = self.hooks.generate_prompt(False)
|
|
1865
|
except:
|
|
1865
|
except:
|
|
1866
|
self.showtraceback()
|
|
1866
|
self.showtraceback()
|
|
1867
|
try:
|
|
1867
|
try:
|
|
1868
|
line = self.raw_input(prompt, more)
|
|
1868
|
line = self.raw_input(prompt, more)
|
|
1869
|
if self.exit_now:
|
|
1869
|
if self.exit_now:
|
|
1870
|
# quick exit on sys.std[in|out] close
|
|
1870
|
# quick exit on sys.std[in|out] close
|
|
1871
|
break
|
|
1871
|
break
|
|
1872
|
if self.autoindent:
|
|
1872
|
if self.autoindent:
|
|
1873
|
self.rl_do_indent = False
|
|
1873
|
self.rl_do_indent = False
|
|
1874
|
|
|
1874
|
|
|
1875
|
except KeyboardInterrupt:
|
|
1875
|
except KeyboardInterrupt:
|
|
1876
|
#double-guard against keyboardinterrupts during kbdint handling
|
|
1876
|
#double-guard against keyboardinterrupts during kbdint handling
|
|
1877
|
try:
|
|
1877
|
try:
|
|
1878
|
self.write('\nKeyboardInterrupt\n')
|
|
1878
|
self.write('\nKeyboardInterrupt\n')
|
|
1879
|
self.resetbuffer()
|
|
1879
|
self.resetbuffer()
|
|
1880
|
# keep cache in sync with the prompt counter:
|
|
1880
|
# keep cache in sync with the prompt counter:
|
|
1881
|
self.outputcache.prompt_count -= 1
|
|
1881
|
self.outputcache.prompt_count -= 1
|
|
1882
|
|
|
1882
|
|
|
1883
|
if self.autoindent:
|
|
1883
|
if self.autoindent:
|
|
1884
|
self.indent_current_nsp = 0
|
|
1884
|
self.indent_current_nsp = 0
|
|
1885
|
more = 0
|
|
1885
|
more = 0
|
|
1886
|
except KeyboardInterrupt:
|
|
1886
|
except KeyboardInterrupt:
|
|
1887
|
pass
|
|
1887
|
pass
|
|
1888
|
except EOFError:
|
|
1888
|
except EOFError:
|
|
1889
|
if self.autoindent:
|
|
1889
|
if self.autoindent:
|
|
1890
|
self.rl_do_indent = False
|
|
1890
|
self.rl_do_indent = False
|
|
1891
|
if self.has_readline:
|
|
1891
|
if self.has_readline:
|
|
1892
|
self.readline_startup_hook(None)
|
|
1892
|
self.readline_startup_hook(None)
|
|
1893
|
self.write('\n')
|
|
1893
|
self.write('\n')
|
|
1894
|
self.exit()
|
|
1894
|
self.exit()
|
|
1895
|
except bdb.BdbQuit:
|
|
1895
|
except bdb.BdbQuit:
|
|
1896
|
warn('The Python debugger has exited with a BdbQuit exception.\n'
|
|
1896
|
warn('The Python debugger has exited with a BdbQuit exception.\n'
|
|
1897
|
'Because of how pdb handles the stack, it is impossible\n'
|
|
1897
|
'Because of how pdb handles the stack, it is impossible\n'
|
|
1898
|
'for IPython to properly format this particular exception.\n'
|
|
1898
|
'for IPython to properly format this particular exception.\n'
|
|
1899
|
'IPython will resume normal operation.')
|
|
1899
|
'IPython will resume normal operation.')
|
|
1900
|
except:
|
|
1900
|
except:
|
|
1901
|
# exceptions here are VERY RARE, but they can be triggered
|
|
1901
|
# exceptions here are VERY RARE, but they can be triggered
|
|
1902
|
# asynchronously by signal handlers, for example.
|
|
1902
|
# asynchronously by signal handlers, for example.
|
|
1903
|
self.showtraceback()
|
|
1903
|
self.showtraceback()
|
|
1904
|
else:
|
|
1904
|
else:
|
|
1905
|
more = self.push_line(line)
|
|
1905
|
more = self.push_line(line)
|
|
1906
|
if (self.SyntaxTB.last_syntax_error and
|
|
1906
|
if (self.SyntaxTB.last_syntax_error and
|
|
1907
|
self.autoedit_syntax):
|
|
1907
|
self.autoedit_syntax):
|
|
1908
|
self.edit_syntax_error()
|
|
1908
|
self.edit_syntax_error()
|
|
1909
|
|
|
1909
|
|
|
1910
|
# We are off again...
|
|
1910
|
# We are off again...
|
|
1911
|
__builtin__.__dict__['__IPYTHON__active'] -= 1
|
|
1911
|
__builtin__.__dict__['__IPYTHON__active'] -= 1
|
|
1912
|
|
|
1912
|
|
|
1913
|
# Turn off the exit flag, so the mainloop can be restarted if desired
|
|
1913
|
# Turn off the exit flag, so the mainloop can be restarted if desired
|
|
1914
|
self.exit_now = False
|
|
1914
|
self.exit_now = False
|
|
1915
|
|
|
1915
|
|
|
1916
|
def safe_execfile(self, fname, *where, **kw):
|
|
1916
|
def safe_execfile(self, fname, *where, **kw):
|
|
1917
|
"""A safe version of the builtin execfile().
|
|
1917
|
"""A safe version of the builtin execfile().
|
|
1918
|
|
|
1918
|
|
|
1919
|
This version will never throw an exception, but instead print
|
|
1919
|
This version will never throw an exception, but instead print
|
|
1920
|
helpful error messages to the screen. This only works on pure
|
|
1920
|
helpful error messages to the screen. This only works on pure
|
|
1921
|
Python files with the .py extension.
|
|
1921
|
Python files with the .py extension.
|
|
1922
|
|
|
1922
|
|
|
1923
|
Parameters
|
|
1923
|
Parameters
|
|
1924
|
----------
|
|
1924
|
----------
|
|
1925
|
fname : string
|
|
1925
|
fname : string
|
|
1926
|
The name of the file to be executed.
|
|
1926
|
The name of the file to be executed.
|
|
1927
|
where : tuple
|
|
1927
|
where : tuple
|
|
1928
|
One or two namespaces, passed to execfile() as (globals,locals).
|
|
1928
|
One or two namespaces, passed to execfile() as (globals,locals).
|
|
1929
|
If only one is given, it is passed as both.
|
|
1929
|
If only one is given, it is passed as both.
|
|
1930
|
exit_ignore : bool (False)
|
|
1930
|
exit_ignore : bool (False)
|
|
1931
|
If True, then silence SystemExit for non-zero status (it is always
|
|
1931
|
If True, then silence SystemExit for non-zero status (it is always
|
|
1932
|
silenced for zero status, as it is so common).
|
|
1932
|
silenced for zero status, as it is so common).
|
|
1933
|
"""
|
|
1933
|
"""
|
|
1934
|
kw.setdefault('exit_ignore', False)
|
|
1934
|
kw.setdefault('exit_ignore', False)
|
|
1935
|
|
|
1935
|
|
|
1936
|
fname = os.path.abspath(os.path.expanduser(fname))
|
|
1936
|
fname = os.path.abspath(os.path.expanduser(fname))
|
|
1937
|
|
|
1937
|
|
|
1938
|
# Make sure we have a .py file
|
|
1938
|
# Make sure we have a .py file
|
|
1939
|
if not fname.endswith('.py'):
|
|
1939
|
if not fname.endswith('.py'):
|
|
1940
|
warn('File must end with .py to be run using execfile: <%s>' % fname)
|
|
1940
|
warn('File must end with .py to be run using execfile: <%s>' % fname)
|
|
1941
|
|
|
1941
|
|
|
1942
|
# Make sure we can open the file
|
|
1942
|
# Make sure we can open the file
|
|
1943
|
try:
|
|
1943
|
try:
|
|
1944
|
with open(fname) as thefile:
|
|
1944
|
with open(fname) as thefile:
|
|
1945
|
pass
|
|
1945
|
pass
|
|
1946
|
except:
|
|
1946
|
except:
|
|
1947
|
warn('Could not open file <%s> for safe execution.' % fname)
|
|
1947
|
warn('Could not open file <%s> for safe execution.' % fname)
|
|
1948
|
return
|
|
1948
|
return
|
|
1949
|
|
|
1949
|
|
|
1950
|
# Find things also in current directory. This is needed to mimic the
|
|
1950
|
# Find things also in current directory. This is needed to mimic the
|
|
1951
|
# behavior of running a script from the system command line, where
|
|
1951
|
# behavior of running a script from the system command line, where
|
|
1952
|
# Python inserts the script's directory into sys.path
|
|
1952
|
# Python inserts the script's directory into sys.path
|
|
1953
|
dname = os.path.dirname(fname)
|
|
1953
|
dname = os.path.dirname(fname)
|
|
1954
|
|
|
1954
|
|
|
1955
|
with prepended_to_syspath(dname):
|
|
1955
|
with prepended_to_syspath(dname):
|
|
1956
|
try:
|
|
1956
|
try:
|
|
1957
|
execfile(fname,*where)
|
|
1957
|
execfile(fname,*where)
|
|
1958
|
except SystemExit, status:
|
|
1958
|
except SystemExit, status:
|
|
1959
|
# If the call was made with 0 or None exit status (sys.exit(0)
|
|
1959
|
# If the call was made with 0 or None exit status (sys.exit(0)
|
|
1960
|
# or sys.exit() ), don't bother showing a traceback, as both of
|
|
1960
|
# or sys.exit() ), don't bother showing a traceback, as both of
|
|
1961
|
# these are considered normal by the OS:
|
|
1961
|
# these are considered normal by the OS:
|
|
1962
|
# > python -c'import sys;sys.exit(0)'; echo $?
|
|
1962
|
# > python -c'import sys;sys.exit(0)'; echo $?
|
|
1963
|
# 0
|
|
1963
|
# 0
|
|
1964
|
# > python -c'import sys;sys.exit()'; echo $?
|
|
1964
|
# > python -c'import sys;sys.exit()'; echo $?
|
|
1965
|
# 0
|
|
1965
|
# 0
|
|
1966
|
# For other exit status, we show the exception unless
|
|
1966
|
# For other exit status, we show the exception unless
|
|
1967
|
# explicitly silenced, but only in short form.
|
|
1967
|
# explicitly silenced, but only in short form.
|
|
1968
|
if status.code not in (0, None) and not kw['exit_ignore']:
|
|
1968
|
if status.code not in (0, None) and not kw['exit_ignore']:
|
|
1969
|
self.showtraceback(exception_only=True)
|
|
1969
|
self.showtraceback(exception_only=True)
|
|
1970
|
except:
|
|
1970
|
except:
|
|
1971
|
self.showtraceback()
|
|
1971
|
self.showtraceback()
|
|
1972
|
|
|
1972
|
|
|
1973
|
def safe_execfile_ipy(self, fname):
|
|
1973
|
def safe_execfile_ipy(self, fname):
|
|
1974
|
"""Like safe_execfile, but for .ipy files with IPython syntax.
|
|
1974
|
"""Like safe_execfile, but for .ipy files with IPython syntax.
|
|
1975
|
|
|
1975
|
|
|
1976
|
Parameters
|
|
1976
|
Parameters
|
|
1977
|
----------
|
|
1977
|
----------
|
|
1978
|
fname : str
|
|
1978
|
fname : str
|
|
1979
|
The name of the file to execute. The filename must have a
|
|
1979
|
The name of the file to execute. The filename must have a
|
|
1980
|
.ipy extension.
|
|
1980
|
.ipy extension.
|
|
1981
|
"""
|
|
1981
|
"""
|
|
1982
|
fname = os.path.abspath(os.path.expanduser(fname))
|
|
1982
|
fname = os.path.abspath(os.path.expanduser(fname))
|
|
1983
|
|
|
1983
|
|
|
1984
|
# Make sure we have a .py file
|
|
1984
|
# Make sure we have a .py file
|
|
1985
|
if not fname.endswith('.ipy'):
|
|
1985
|
if not fname.endswith('.ipy'):
|
|
1986
|
warn('File must end with .py to be run using execfile: <%s>' % fname)
|
|
1986
|
warn('File must end with .py to be run using execfile: <%s>' % fname)
|
|
1987
|
|
|
1987
|
|
|
1988
|
# Make sure we can open the file
|
|
1988
|
# Make sure we can open the file
|
|
1989
|
try:
|
|
1989
|
try:
|
|
1990
|
with open(fname) as thefile:
|
|
1990
|
with open(fname) as thefile:
|
|
1991
|
pass
|
|
1991
|
pass
|
|
1992
|
except:
|
|
1992
|
except:
|
|
1993
|
warn('Could not open file <%s> for safe execution.' % fname)
|
|
1993
|
warn('Could not open file <%s> for safe execution.' % fname)
|
|
1994
|
return
|
|
1994
|
return
|
|
1995
|
|
|
1995
|
|
|
1996
|
# Find things also in current directory. This is needed to mimic the
|
|
1996
|
# Find things also in current directory. This is needed to mimic the
|
|
1997
|
# behavior of running a script from the system command line, where
|
|
1997
|
# behavior of running a script from the system command line, where
|
|
1998
|
# Python inserts the script's directory into sys.path
|
|
1998
|
# Python inserts the script's directory into sys.path
|
|
1999
|
dname = os.path.dirname(fname)
|
|
1999
|
dname = os.path.dirname(fname)
|
|
2000
|
|
|
2000
|
|
|
2001
|
with prepended_to_syspath(dname):
|
|
2001
|
with prepended_to_syspath(dname):
|
|
2002
|
try:
|
|
2002
|
try:
|
|
2003
|
with open(fname) as thefile:
|
|
2003
|
with open(fname) as thefile:
|
|
2004
|
script = thefile.read()
|
|
2004
|
script = thefile.read()
|
|
2005
|
# self.runlines currently captures all exceptions
|
|
2005
|
# self.runlines currently captures all exceptions
|
|
2006
|
# raise in user code. It would be nice if there were
|
|
2006
|
# raise in user code. It would be nice if there were
|
|
2007
|
# versions of runlines, execfile that did raise, so
|
|
2007
|
# versions of runlines, execfile that did raise, so
|
|
2008
|
# we could catch the errors.
|
|
2008
|
# we could catch the errors.
|
|
2009
|
self.runlines(script, clean=True)
|
|
2009
|
self.runlines(script, clean=True)
|
|
2010
|
except:
|
|
2010
|
except:
|
|
2011
|
self.showtraceback()
|
|
2011
|
self.showtraceback()
|
|
2012
|
warn('Unknown failure executing file: <%s>' % fname)
|
|
2012
|
warn('Unknown failure executing file: <%s>' % fname)
|
|
2013
|
|
|
2013
|
|
|
2014
|
def _is_secondary_block_start(self, s):
|
|
2014
|
def _is_secondary_block_start(self, s):
|
|
2015
|
if not s.endswith(':'):
|
|
2015
|
if not s.endswith(':'):
|
|
2016
|
return False
|
|
2016
|
return False
|
|
2017
|
if (s.startswith('elif') or
|
|
2017
|
if (s.startswith('elif') or
|
|
2018
|
s.startswith('else') or
|
|
2018
|
s.startswith('else') or
|
|
2019
|
s.startswith('except') or
|
|
2019
|
s.startswith('except') or
|
|
2020
|
s.startswith('finally')):
|
|
2020
|
s.startswith('finally')):
|
|
2021
|
return True
|
|
2021
|
return True
|
|
2022
|
|
|
2022
|
|
|
2023
|
def cleanup_ipy_script(self, script):
|
|
2023
|
def cleanup_ipy_script(self, script):
|
|
2024
|
"""Make a script safe for self.runlines()
|
|
2024
|
"""Make a script safe for self.runlines()
|
|
2025
|
|
|
2025
|
|
|
2026
|
Currently, IPython is lines based, with blocks being detected by
|
|
2026
|
Currently, IPython is lines based, with blocks being detected by
|
|
2027
|
empty lines. This is a problem for block based scripts that may
|
|
2027
|
empty lines. This is a problem for block based scripts that may
|
|
2028
|
not have empty lines after blocks. This script adds those empty
|
|
2028
|
not have empty lines after blocks. This script adds those empty
|
|
2029
|
lines to make scripts safe for running in the current line based
|
|
2029
|
lines to make scripts safe for running in the current line based
|
|
2030
|
IPython.
|
|
2030
|
IPython.
|
|
2031
|
"""
|
|
2031
|
"""
|
|
2032
|
res = []
|
|
2032
|
res = []
|
|
2033
|
lines = script.splitlines()
|
|
2033
|
lines = script.splitlines()
|
|
2034
|
level = 0
|
|
2034
|
level = 0
|
|
2035
|
|
|
2035
|
|
|
2036
|
for l in lines:
|
|
2036
|
for l in lines:
|
|
2037
|
lstripped = l.lstrip()
|
|
2037
|
lstripped = l.lstrip()
|
|
2038
|
stripped = l.strip()
|
|
2038
|
stripped = l.strip()
|
|
2039
|
if not stripped:
|
|
2039
|
if not stripped:
|
|
2040
|
continue
|
|
2040
|
continue
|
|
2041
|
newlevel = len(l) - len(lstripped)
|
|
2041
|
newlevel = len(l) - len(lstripped)
|
|
2042
|
if level > 0 and newlevel == 0 and \
|
|
2042
|
if level > 0 and newlevel == 0 and \
|
|
2043
|
not self._is_secondary_block_start(stripped):
|
|
2043
|
not self._is_secondary_block_start(stripped):
|
|
2044
|
# add empty line
|
|
2044
|
# add empty line
|
|
2045
|
res.append('')
|
|
2045
|
res.append('')
|
|
2046
|
res.append(l)
|
|
2046
|
res.append(l)
|
|
2047
|
level = newlevel
|
|
2047
|
level = newlevel
|
|
2048
|
|
|
2048
|
|
|
2049
|
return '\n'.join(res) + '\n'
|
|
2049
|
return '\n'.join(res) + '\n'
|
|
2050
|
|
|
2050
|
|
|
2051
|
def runlines(self, lines, clean=False):
|
|
2051
|
def runlines(self, lines, clean=False):
|
|
2052
|
"""Run a string of one or more lines of source.
|
|
2052
|
"""Run a string of one or more lines of source.
|
|
2053
|
|
|
2053
|
|
|
2054
|
This method is capable of running a string containing multiple source
|
|
2054
|
This method is capable of running a string containing multiple source
|
|
2055
|
lines, as if they had been entered at the IPython prompt. Since it
|
|
2055
|
lines, as if they had been entered at the IPython prompt. Since it
|
|
2056
|
exposes IPython's processing machinery, the given strings can contain
|
|
2056
|
exposes IPython's processing machinery, the given strings can contain
|
|
2057
|
magic calls (%magic), special shell access (!cmd), etc.
|
|
2057
|
magic calls (%magic), special shell access (!cmd), etc.
|
|
2058
|
"""
|
|
2058
|
"""
|
|
2059
|
|
|
2059
|
|
|
2060
|
if isinstance(lines, (list, tuple)):
|
|
2060
|
if isinstance(lines, (list, tuple)):
|
|
2061
|
lines = '\n'.join(lines)
|
|
2061
|
lines = '\n'.join(lines)
|
|
2062
|
|
|
2062
|
|
|
2063
|
if clean:
|
|
2063
|
if clean:
|
|
2064
|
lines = self.cleanup_ipy_script(lines)
|
|
2064
|
lines = self.cleanup_ipy_script(lines)
|
|
2065
|
|
|
2065
|
|
|
2066
|
# We must start with a clean buffer, in case this is run from an
|
|
2066
|
# We must start with a clean buffer, in case this is run from an
|
|
2067
|
# interactive IPython session (via a magic, for example).
|
|
2067
|
# interactive IPython session (via a magic, for example).
|
|
2068
|
self.resetbuffer()
|
|
2068
|
self.resetbuffer()
|
|
2069
|
lines = lines.splitlines()
|
|
2069
|
lines = lines.splitlines()
|
|
2070
|
more = 0
|
|
2070
|
more = 0
|
|
2071
|
|
|
2071
|
|
|
2072
|
with nested(self.builtin_trap, self.display_trap):
|
|
2072
|
with nested(self.builtin_trap, self.display_trap):
|
|
2073
|
for line in lines:
|
|
2073
|
for line in lines:
|
|
2074
|
# skip blank lines so we don't mess up the prompt counter, but do
|
|
2074
|
# skip blank lines so we don't mess up the prompt counter, but do
|
|
2075
|
# NOT skip even a blank line if we are in a code block (more is
|
|
2075
|
# NOT skip even a blank line if we are in a code block (more is
|
|
2076
|
# true)
|
|
2076
|
# true)
|
|
2077
|
|
|
2077
|
|
|
2078
|
if line or more:
|
|
2078
|
if line or more:
|
|
2079
|
# push to raw history, so hist line numbers stay in sync
|
|
2079
|
# push to raw history, so hist line numbers stay in sync
|
|
2080
|
self.input_hist_raw.append("# " + line + "\n")
|
|
2080
|
self.input_hist_raw.append("# " + line + "\n")
|
|
2081
|
prefiltered = self.prefilter_manager.prefilter_lines(line,more)
|
|
2081
|
prefiltered = self.prefilter_manager.prefilter_lines(line,more)
|
|
2082
|
more = self.push_line(prefiltered)
|
|
2082
|
more = self.push_line(prefiltered)
|
|
2083
|
# IPython's runsource returns None if there was an error
|
|
2083
|
# IPython's runsource returns None if there was an error
|
|
2084
|
# compiling the code. This allows us to stop processing right
|
|
2084
|
# compiling the code. This allows us to stop processing right
|
|
2085
|
# away, so the user gets the error message at the right place.
|
|
2085
|
# away, so the user gets the error message at the right place.
|
|
2086
|
if more is None:
|
|
2086
|
if more is None:
|
|
2087
|
break
|
|
2087
|
break
|
|
2088
|
else:
|
|
2088
|
else:
|
|
2089
|
self.input_hist_raw.append("\n")
|
|
2089
|
self.input_hist_raw.append("\n")
|
|
2090
|
# final newline in case the input didn't have it, so that the code
|
|
2090
|
# final newline in case the input didn't have it, so that the code
|
|
2091
|
# actually does get executed
|
|
2091
|
# actually does get executed
|
|
2092
|
if more:
|
|
2092
|
if more:
|
|
2093
|
self.push_line('\n')
|
|
2093
|
self.push_line('\n')
|
|
2094
|
|
|
2094
|
|
|
2095
|
def runsource(self, source, filename='<input>', symbol='single'):
|
|
2095
|
def runsource(self, source, filename='<input>', symbol='single'):
|
|
2096
|
"""Compile and run some source in the interpreter.
|
|
2096
|
"""Compile and run some source in the interpreter.
|
|
2097
|
|
|
2097
|
|
|
2098
|
Arguments are as for compile_command().
|
|
2098
|
Arguments are as for compile_command().
|
|
2099
|
|
|
2099
|
|
|
2100
|
One several things can happen:
|
|
2100
|
One several things can happen:
|
|
2101
|
|
|
2101
|
|
|
2102
|
1) The input is incorrect; compile_command() raised an
|
|
2102
|
1) The input is incorrect; compile_command() raised an
|
|
2103
|
exception (SyntaxError or OverflowError). A syntax traceback
|
|
2103
|
exception (SyntaxError or OverflowError). A syntax traceback
|
|
2104
|
will be printed by calling the showsyntaxerror() method.
|
|
2104
|
will be printed by calling the showsyntaxerror() method.
|
|
2105
|
|
|
2105
|
|
|
2106
|
2) The input is incomplete, and more input is required;
|
|
2106
|
2) The input is incomplete, and more input is required;
|
|
2107
|
compile_command() returned None. Nothing happens.
|
|
2107
|
compile_command() returned None. Nothing happens.
|
|
2108
|
|
|
2108
|
|
|
2109
|
3) The input is complete; compile_command() returned a code
|
|
2109
|
3) The input is complete; compile_command() returned a code
|
|
2110
|
object. The code is executed by calling self.runcode() (which
|
|
2110
|
object. The code is executed by calling self.runcode() (which
|
|
2111
|
also handles run-time exceptions, except for SystemExit).
|
|
2111
|
also handles run-time exceptions, except for SystemExit).
|
|
2112
|
|
|
2112
|
|
|
2113
|
The return value is:
|
|
2113
|
The return value is:
|
|
2114
|
|
|
2114
|
|
|
2115
|
- True in case 2
|
|
2115
|
- True in case 2
|
|
2116
|
|
|
2116
|
|
|
2117
|
- False in the other cases, unless an exception is raised, where
|
|
2117
|
- False in the other cases, unless an exception is raised, where
|
|
2118
|
None is returned instead. This can be used by external callers to
|
|
2118
|
None is returned instead. This can be used by external callers to
|
|
2119
|
know whether to continue feeding input or not.
|
|
2119
|
know whether to continue feeding input or not.
|
|
2120
|
|
|
2120
|
|
|
2121
|
The return value can be used to decide whether to use sys.ps1 or
|
|
2121
|
The return value can be used to decide whether to use sys.ps1 or
|
|
2122
|
sys.ps2 to prompt the next line."""
|
|
2122
|
sys.ps2 to prompt the next line."""
|
|
2123
|
|
|
2123
|
|
|
2124
|
# if the source code has leading blanks, add 'if 1:\n' to it
|
|
2124
|
# if the source code has leading blanks, add 'if 1:\n' to it
|
|
2125
|
# this allows execution of indented pasted code. It is tempting
|
|
2125
|
# this allows execution of indented pasted code. It is tempting
|
|
2126
|
# to add '\n' at the end of source to run commands like ' a=1'
|
|
2126
|
# to add '\n' at the end of source to run commands like ' a=1'
|
|
2127
|
# directly, but this fails for more complicated scenarios
|
|
2127
|
# directly, but this fails for more complicated scenarios
|
|
2128
|
source=source.encode(self.stdin_encoding)
|
|
2128
|
source=source.encode(self.stdin_encoding)
|
|
2129
|
if source[:1] in [' ', '\t']:
|
|
2129
|
if source[:1] in [' ', '\t']:
|
|
2130
|
source = 'if 1:\n%s' % source
|
|
2130
|
source = 'if 1:\n%s' % source
|
|
2131
|
|
|
2131
|
|
|
2132
|
try:
|
|
2132
|
try:
|
|
2133
|
code = self.compile(source,filename,symbol)
|
|
2133
|
code = self.compile(source,filename,symbol)
|
|
2134
|
except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
|
|
2134
|
except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
|
|
2135
|
# Case 1
|
|
2135
|
# Case 1
|
|
2136
|
self.showsyntaxerror(filename)
|
|
2136
|
self.showsyntaxerror(filename)
|
|
2137
|
return None
|
|
2137
|
return None
|
|
2138
|
|
|
2138
|
|
|
2139
|
if code is None:
|
|
2139
|
if code is None:
|
|
2140
|
# Case 2
|
|
2140
|
# Case 2
|
|
2141
|
return True
|
|
2141
|
return True
|
|
2142
|
|
|
2142
|
|
|
2143
|
# Case 3
|
|
2143
|
# Case 3
|
|
2144
|
# We store the code object so that threaded shells and
|
|
2144
|
# We store the code object so that threaded shells and
|
|
2145
|
# custom exception handlers can access all this info if needed.
|
|
2145
|
# custom exception handlers can access all this info if needed.
|
|
2146
|
# The source corresponding to this can be obtained from the
|
|
2146
|
# The source corresponding to this can be obtained from the
|
|
2147
|
# buffer attribute as '\n'.join(self.buffer).
|
|
2147
|
# buffer attribute as '\n'.join(self.buffer).
|
|
2148
|
self.code_to_run = code
|
|
2148
|
self.code_to_run = code
|
|
2149
|
# now actually execute the code object
|
|
2149
|
# now actually execute the code object
|
|
2150
|
if self.runcode(code) == 0:
|
|
2150
|
if self.runcode(code) == 0:
|
|
2151
|
return False
|
|
2151
|
return False
|
|
2152
|
else:
|
|
2152
|
else:
|
|
2153
|
return None
|
|
2153
|
return None
|
|
2154
|
|
|
2154
|
|
|
2155
|
def runcode(self,code_obj):
|
|
2155
|
def runcode(self,code_obj):
|
|
2156
|
"""Execute a code object.
|
|
2156
|
"""Execute a code object.
|
|
2157
|
|
|
2157
|
|
|
2158
|
When an exception occurs, self.showtraceback() is called to display a
|
|
2158
|
When an exception occurs, self.showtraceback() is called to display a
|
|
2159
|
traceback.
|
|
2159
|
traceback.
|
|
2160
|
|
|
2160
|
|
|
2161
|
Return value: a flag indicating whether the code to be run completed
|
|
2161
|
Return value: a flag indicating whether the code to be run completed
|
|
2162
|
successfully:
|
|
2162
|
successfully:
|
|
2163
|
|
|
2163
|
|
|
2164
|
- 0: successful execution.
|
|
2164
|
- 0: successful execution.
|
|
2165
|
- 1: an error occurred.
|
|
2165
|
- 1: an error occurred.
|
|
2166
|
"""
|
|
2166
|
"""
|
|
2167
|
|
|
2167
|
|
|
2168
|
# Set our own excepthook in case the user code tries to call it
|
|
2168
|
# Set our own excepthook in case the user code tries to call it
|
|
2169
|
# directly, so that the IPython crash handler doesn't get triggered
|
|
2169
|
# directly, so that the IPython crash handler doesn't get triggered
|
|
2170
|
old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
|
|
2170
|
old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
|
|
2171
|
|
|
2171
|
|
|
2172
|
# we save the original sys.excepthook in the instance, in case config
|
|
2172
|
# we save the original sys.excepthook in the instance, in case config
|
|
2173
|
# code (such as magics) needs access to it.
|
|
2173
|
# code (such as magics) needs access to it.
|
|
2174
|
self.sys_excepthook = old_excepthook
|
|
2174
|
self.sys_excepthook = old_excepthook
|
|
2175
|
outflag = 1 # happens in more places, so it's easier as default
|
|
2175
|
outflag = 1 # happens in more places, so it's easier as default
|
|
2176
|
try:
|
|
2176
|
try:
|
|
2177
|
try:
|
|
2177
|
try:
|
|
2178
|
self.hooks.pre_runcode_hook()
|
|
2178
|
self.hooks.pre_runcode_hook()
|
|
2179
|
exec code_obj in self.user_global_ns, self.user_ns
|
|
2179
|
exec code_obj in self.user_global_ns, self.user_ns
|
|
2180
|
finally:
|
|
2180
|
finally:
|
|
2181
|
# Reset our crash handler in place
|
|
2181
|
# Reset our crash handler in place
|
|
2182
|
sys.excepthook = old_excepthook
|
|
2182
|
sys.excepthook = old_excepthook
|
|
2183
|
except SystemExit:
|
|
2183
|
except SystemExit:
|
|
2184
|
self.resetbuffer()
|
|
2184
|
self.resetbuffer()
|
|
2185
|
self.showtraceback(exception_only=True)
|
|
2185
|
self.showtraceback(exception_only=True)
|
|
2186
|
warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1)
|
|
2186
|
warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1)
|
|
2187
|
except self.custom_exceptions:
|
|
2187
|
except self.custom_exceptions:
|
|
2188
|
etype,value,tb = sys.exc_info()
|
|
2188
|
etype,value,tb = sys.exc_info()
|
|
2189
|
self.CustomTB(etype,value,tb)
|
|
2189
|
self.CustomTB(etype,value,tb)
|
|
2190
|
except:
|
|
2190
|
except:
|
|
2191
|
self.showtraceback()
|
|
2191
|
self.showtraceback()
|
|
2192
|
else:
|
|
2192
|
else:
|
|
2193
|
outflag = 0
|
|
2193
|
outflag = 0
|
|
2194
|
if softspace(sys.stdout, 0):
|
|
2194
|
if softspace(sys.stdout, 0):
|
|
2195
|
print
|
|
2195
|
print
|
|
2196
|
# Flush out code object which has been run (and source)
|
|
2196
|
# Flush out code object which has been run (and source)
|
|
2197
|
self.code_to_run = None
|
|
2197
|
self.code_to_run = None
|
|
2198
|
return outflag
|
|
2198
|
return outflag
|
|
2199
|
|
|
2199
|
|
|
2200
|
def push_line(self, line):
|
|
2200
|
def push_line(self, line):
|
|
2201
|
"""Push a line to the interpreter.
|
|
2201
|
"""Push a line to the interpreter.
|
|
2202
|
|
|
2202
|
|
|
2203
|
The line should not have a trailing newline; it may have
|
|
2203
|
The line should not have a trailing newline; it may have
|
|
2204
|
internal newlines. The line is appended to a buffer and the
|
|
2204
|
internal newlines. The line is appended to a buffer and the
|
|
2205
|
interpreter's runsource() method is called with the
|
|
2205
|
interpreter's runsource() method is called with the
|
|
2206
|
concatenated contents of the buffer as source. If this
|
|
2206
|
concatenated contents of the buffer as source. If this
|
|
2207
|
indicates that the command was executed or invalid, the buffer
|
|
2207
|
indicates that the command was executed or invalid, the buffer
|
|
2208
|
is reset; otherwise, the command is incomplete, and the buffer
|
|
2208
|
is reset; otherwise, the command is incomplete, and the buffer
|
|
2209
|
is left as it was after the line was appended. The return
|
|
2209
|
is left as it was after the line was appended. The return
|
|
2210
|
value is 1 if more input is required, 0 if the line was dealt
|
|
2210
|
value is 1 if more input is required, 0 if the line was dealt
|
|
2211
|
with in some way (this is the same as runsource()).
|
|
2211
|
with in some way (this is the same as runsource()).
|
|
2212
|
"""
|
|
2212
|
"""
|
|
2213
|
|
|
2213
|
|
|
2214
|
# autoindent management should be done here, and not in the
|
|
2214
|
# autoindent management should be done here, and not in the
|
|
2215
|
# interactive loop, since that one is only seen by keyboard input. We
|
|
2215
|
# interactive loop, since that one is only seen by keyboard input. We
|
|
2216
|
# need this done correctly even for code run via runlines (which uses
|
|
2216
|
# need this done correctly even for code run via runlines (which uses
|
|
2217
|
# push).
|
|
2217
|
# push).
|
|
2218
|
|
|
2218
|
|
|
2219
|
#print 'push line: <%s>' % line # dbg
|
|
2219
|
#print 'push line: <%s>' % line # dbg
|
|
2220
|
for subline in line.splitlines():
|
|
2220
|
for subline in line.splitlines():
|
|
2221
|
self._autoindent_update(subline)
|
|
2221
|
self._autoindent_update(subline)
|
|
2222
|
self.buffer.append(line)
|
|
2222
|
self.buffer.append(line)
|
|
2223
|
more = self.runsource('\n'.join(self.buffer), self.filename)
|
|
2223
|
more = self.runsource('\n'.join(self.buffer), self.filename)
|
|
2224
|
if not more:
|
|
2224
|
if not more:
|
|
2225
|
self.resetbuffer()
|
|
2225
|
self.resetbuffer()
|
|
2226
|
return more
|
|
2226
|
return more
|
|
2227
|
|
|
2227
|
|
|
2228
|
def _autoindent_update(self,line):
|
|
2228
|
def _autoindent_update(self,line):
|
|
2229
|
"""Keep track of the indent level."""
|
|
2229
|
"""Keep track of the indent level."""
|
|
2230
|
|
|
2230
|
|
|
2231
|
#debugx('line')
|
|
2231
|
#debugx('line')
|
|
2232
|
#debugx('self.indent_current_nsp')
|
|
2232
|
#debugx('self.indent_current_nsp')
|
|
2233
|
if self.autoindent:
|
|
2233
|
if self.autoindent:
|
|
2234
|
if line:
|
|
2234
|
if line:
|
|
2235
|
inisp = num_ini_spaces(line)
|
|
2235
|
inisp = num_ini_spaces(line)
|
|
2236
|
if inisp < self.indent_current_nsp:
|
|
2236
|
if inisp < self.indent_current_nsp:
|
|
2237
|
self.indent_current_nsp = inisp
|
|
2237
|
self.indent_current_nsp = inisp
|
|
2238
|
|
|
2238
|
|
|
2239
|
if line[-1] == ':':
|
|
2239
|
if line[-1] == ':':
|
|
2240
|
self.indent_current_nsp += 4
|
|
2240
|
self.indent_current_nsp += 4
|
|
2241
|
elif dedent_re.match(line):
|
|
2241
|
elif dedent_re.match(line):
|
|
2242
|
self.indent_current_nsp -= 4
|
|
2242
|
self.indent_current_nsp -= 4
|
|
2243
|
else:
|
|
2243
|
else:
|
|
2244
|
self.indent_current_nsp = 0
|
|
2244
|
self.indent_current_nsp = 0
|
|
2245
|
|
|
2245
|
|
|
2246
|
def resetbuffer(self):
|
|
2246
|
def resetbuffer(self):
|
|
2247
|
"""Reset the input buffer."""
|
|
2247
|
"""Reset the input buffer."""
|
|
2248
|
self.buffer[:] = []
|
|
2248
|
self.buffer[:] = []
|
|
2249
|
|
|
2249
|
|
|
2250
|
def raw_input(self,prompt='',continue_prompt=False):
|
|
2250
|
def raw_input(self,prompt='',continue_prompt=False):
|
|
2251
|
"""Write a prompt and read a line.
|
|
2251
|
"""Write a prompt and read a line.
|
|
2252
|
|
|
2252
|
|
|
2253
|
The returned line does not include the trailing newline.
|
|
2253
|
The returned line does not include the trailing newline.
|
|
2254
|
When the user enters the EOF key sequence, EOFError is raised.
|
|
2254
|
When the user enters the EOF key sequence, EOFError is raised.
|
|
2255
|
|
|
2255
|
|
|
2256
|
Optional inputs:
|
|
2256
|
Optional inputs:
|
|
2257
|
|
|
2257
|
|
|
2258
|
- prompt(''): a string to be printed to prompt the user.
|
|
2258
|
- prompt(''): a string to be printed to prompt the user.
|
|
2259
|
|
|
2259
|
|
|
2260
|
- continue_prompt(False): whether this line is the first one or a
|
|
2260
|
- continue_prompt(False): whether this line is the first one or a
|
|
2261
|
continuation in a sequence of inputs.
|
|
2261
|
continuation in a sequence of inputs.
|
|
2262
|
"""
|
|
2262
|
"""
|
|
2263
|
# growl.notify("raw_input: ", "prompt = %r\ncontinue_prompt = %s" % (prompt, continue_prompt))
|
|
2263
|
# growl.notify("raw_input: ", "prompt = %r\ncontinue_prompt = %s" % (prompt, continue_prompt))
|
|
2264
|
|
|
2264
|
|
|
2265
|
# Code run by the user may have modified the readline completer state.
|
|
2265
|
# Code run by the user may have modified the readline completer state.
|
|
2266
|
# We must ensure that our completer is back in place.
|
|
2266
|
# We must ensure that our completer is back in place.
|
|
2267
|
|
|
2267
|
|
|
2268
|
if self.has_readline:
|
|
2268
|
if self.has_readline:
|
|
2269
|
self.set_completer()
|
|
2269
|
self.set_completer()
|
|
2270
|
|
|
2270
|
|
|
2271
|
try:
|
|
2271
|
try:
|
|
2272
|
line = raw_input_original(prompt).decode(self.stdin_encoding)
|
|
2272
|
line = raw_input_original(prompt).decode(self.stdin_encoding)
|
|
2273
|
except ValueError:
|
|
2273
|
except ValueError:
|
|
2274
|
warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
|
|
2274
|
warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
|
|
2275
|
" or sys.stdout.close()!\nExiting IPython!")
|
|
2275
|
" or sys.stdout.close()!\nExiting IPython!")
|
|
2276
|
self.ask_exit()
|
|
2276
|
self.ask_exit()
|
|
2277
|
return ""
|
|
2277
|
return ""
|
|
2278
|
|
|
2278
|
|
|
2279
|
# Try to be reasonably smart about not re-indenting pasted input more
|
|
2279
|
# Try to be reasonably smart about not re-indenting pasted input more
|
|
2280
|
# than necessary. We do this by trimming out the auto-indent initial
|
|
2280
|
# than necessary. We do this by trimming out the auto-indent initial
|
|
2281
|
# spaces, if the user's actual input started itself with whitespace.
|
|
2281
|
# spaces, if the user's actual input started itself with whitespace.
|
|
2282
|
#debugx('self.buffer[-1]')
|
|
2282
|
#debugx('self.buffer[-1]')
|
|
2283
|
|
|
2283
|
|
|
2284
|
if self.autoindent:
|
|
2284
|
if self.autoindent:
|
|
2285
|
if num_ini_spaces(line) > self.indent_current_nsp:
|
|
2285
|
if num_ini_spaces(line) > self.indent_current_nsp:
|
|
2286
|
line = line[self.indent_current_nsp:]
|
|
2286
|
line = line[self.indent_current_nsp:]
|
|
2287
|
self.indent_current_nsp = 0
|
|
2287
|
self.indent_current_nsp = 0
|
|
2288
|
|
|
2288
|
|
|
2289
|
# store the unfiltered input before the user has any chance to modify
|
|
2289
|
# store the unfiltered input before the user has any chance to modify
|
|
2290
|
# it.
|
|
2290
|
# it.
|
|
2291
|
if line.strip():
|
|
2291
|
if line.strip():
|
|
2292
|
if continue_prompt:
|
|
2292
|
if continue_prompt:
|
|
2293
|
self.input_hist_raw[-1] += '%s\n' % line
|
|
2293
|
self.input_hist_raw[-1] += '%s\n' % line
|
|
2294
|
if self.has_readline and self.readline_use:
|
|
2294
|
if self.has_readline and self.readline_use:
|
|
2295
|
try:
|
|
2295
|
try:
|
|
2296
|
histlen = self.readline.get_current_history_length()
|
|
2296
|
histlen = self.readline.get_current_history_length()
|
|
2297
|
if histlen > 1:
|
|
2297
|
if histlen > 1:
|
|
2298
|
newhist = self.input_hist_raw[-1].rstrip()
|
|
2298
|
newhist = self.input_hist_raw[-1].rstrip()
|
|
2299
|
self.readline.remove_history_item(histlen-1)
|
|
2299
|
self.readline.remove_history_item(histlen-1)
|
|
2300
|
self.readline.replace_history_item(histlen-2,
|
|
2300
|
self.readline.replace_history_item(histlen-2,
|
|
2301
|
newhist.encode(self.stdin_encoding))
|
|
2301
|
newhist.encode(self.stdin_encoding))
|
|
2302
|
except AttributeError:
|
|
2302
|
except AttributeError:
|
|
2303
|
pass # re{move,place}_history_item are new in 2.4.
|
|
2303
|
pass # re{move,place}_history_item are new in 2.4.
|
|
2304
|
else:
|
|
2304
|
else:
|
|
2305
|
self.input_hist_raw.append('%s\n' % line)
|
|
2305
|
self.input_hist_raw.append('%s\n' % line)
|
|
2306
|
# only entries starting at first column go to shadow history
|
|
2306
|
# only entries starting at first column go to shadow history
|
|
2307
|
if line.lstrip() == line:
|
|
2307
|
if line.lstrip() == line:
|
|
2308
|
self.shadowhist.add(line.strip())
|
|
2308
|
self.shadowhist.add(line.strip())
|
|
2309
|
elif not continue_prompt:
|
|
2309
|
elif not continue_prompt:
|
|
2310
|
self.input_hist_raw.append('\n')
|
|
2310
|
self.input_hist_raw.append('\n')
|
|
2311
|
try:
|
|
2311
|
try:
|
|
2312
|
lineout = self.prefilter_manager.prefilter_lines(line,continue_prompt)
|
|
2312
|
lineout = self.prefilter_manager.prefilter_lines(line,continue_prompt)
|
|
2313
|
except:
|
|
2313
|
except:
|
|
2314
|
# blanket except, in case a user-defined prefilter crashes, so it
|
|
2314
|
# blanket except, in case a user-defined prefilter crashes, so it
|
|
2315
|
# can't take all of ipython with it.
|
|
2315
|
# can't take all of ipython with it.
|
|
2316
|
self.showtraceback()
|
|
2316
|
self.showtraceback()
|
|
2317
|
return ''
|
|
2317
|
return ''
|
|
2318
|
else:
|
|
2318
|
else:
|
|
2319
|
return lineout
|
|
2319
|
return lineout
|
|
2320
|
|
|
2320
|
|
|
2321
|
#-------------------------------------------------------------------------
|
|
2321
|
#-------------------------------------------------------------------------
|
|
2322
|
# Working with components
|
|
2322
|
# Working with components
|
|
2323
|
#-------------------------------------------------------------------------
|
|
2323
|
#-------------------------------------------------------------------------
|
|
2324
|
|
|
2324
|
|
|
2325
|
def get_component(self, name=None, klass=None):
|
|
2325
|
def get_component(self, name=None, klass=None):
|
|
2326
|
"""Fetch a component by name and klass in my tree."""
|
|
2326
|
"""Fetch a component by name and klass in my tree."""
|
|
2327
|
c = Component.get_instances(root=self, name=name, klass=klass)
|
|
2327
|
c = Component.get_instances(root=self, name=name, klass=klass)
|
|
2328
|
if len(c) == 0:
|
|
2328
|
if len(c) == 0:
|
|
2329
|
return None
|
|
2329
|
return None
|
|
2330
|
if len(c) == 1:
|
|
2330
|
if len(c) == 1:
|
|
2331
|
return c[0]
|
|
2331
|
return c[0]
|
|
2332
|
else:
|
|
2332
|
else:
|
|
2333
|
return c
|
|
2333
|
return c
|
|
2334
|
|
|
2334
|
|
|
2335
|
#-------------------------------------------------------------------------
|
|
2335
|
#-------------------------------------------------------------------------
|
|
2336
|
# IPython extensions
|
|
2336
|
# IPython extensions
|
|
2337
|
#-------------------------------------------------------------------------
|
|
2337
|
#-------------------------------------------------------------------------
|
|
2338
|
|
|
2338
|
|
|
2339
|
def load_extension(self, module_str):
|
|
2339
|
def load_extension(self, module_str):
|
|
2340
|
"""Load an IPython extension by its module name.
|
|
2340
|
"""Load an IPython extension by its module name.
|
|
2341
|
|
|
2341
|
|
|
2342
|
An IPython extension is an importable Python module that has
|
|
2342
|
An IPython extension is an importable Python module that has
|
|
2343
|
a function with the signature::
|
|
2343
|
a function with the signature::
|
|
2344
|
|
|
2344
|
|
|
2345
|
def load_ipython_extension(ipython):
|
|
2345
|
def load_ipython_extension(ipython):
|
|
2346
|
# Do things with ipython
|
|
2346
|
# Do things with ipython
|
|
2347
|
|
|
2347
|
|
|
2348
|
This function is called after your extension is imported and the
|
|
2348
|
This function is called after your extension is imported and the
|
|
2349
|
currently active :class:`InteractiveShell` instance is passed as
|
|
2349
|
currently active :class:`InteractiveShell` instance is passed as
|
|
2350
|
the only argument. You can do anything you want with IPython at
|
|
2350
|
the only argument. You can do anything you want with IPython at
|
|
2351
|
that point, including defining new magic and aliases, adding new
|
|
2351
|
that point, including defining new magic and aliases, adding new
|
|
2352
|
components, etc.
|
|
2352
|
components, etc.
|
|
2353
|
|
|
2353
|
|
|
2354
|
The :func:`load_ipython_extension` will be called again is you
|
|
2354
|
The :func:`load_ipython_extension` will be called again is you
|
|
2355
|
load or reload the extension again. It is up to the extension
|
|
2355
|
load or reload the extension again. It is up to the extension
|
|
2356
|
author to add code to manage that.
|
|
2356
|
author to add code to manage that.
|
|
2357
|
|
|
2357
|
|
|
2358
|
You can put your extension modules anywhere you want, as long as
|
|
2358
|
You can put your extension modules anywhere you want, as long as
|
|
2359
|
they can be imported by Python's standard import mechanism. However,
|
|
2359
|
they can be imported by Python's standard import mechanism. However,
|
|
2360
|
to make it easy to write extensions, you can also put your extensions
|
|
2360
|
to make it easy to write extensions, you can also put your extensions
|
|
2361
|
in ``os.path.join(self.ipython_dir, 'extensions')``. This directory
|
|
2361
|
in ``os.path.join(self.ipython_dir, 'extensions')``. This directory
|
|
2362
|
is added to ``sys.path`` automatically.
|
|
2362
|
is added to ``sys.path`` automatically.
|
|
|
|
|
2363
|
|
|
|
|
|
2364
|
If :func:`load_ipython_extension` returns anything, this function
|
|
|
|
|
2365
|
will return that object.
|
|
2363
|
"""
|
|
2366
|
"""
|
|
2364
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
2367
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
2365
|
|
|
2368
|
|
|
2366
|
if module_str not in sys.modules:
|
|
2369
|
if module_str not in sys.modules:
|
|
2367
|
with prepended_to_syspath(self.ipython_extension_dir):
|
|
2370
|
with prepended_to_syspath(self.ipython_extension_dir):
|
|
2368
|
__import__(module_str)
|
|
2371
|
__import__(module_str)
|
|
2369
|
mod = sys.modules[module_str]
|
|
2372
|
mod = sys.modules[module_str]
|
|
2370
|
return self._call_load_ipython_extension(mod)
|
|
2373
|
return self._call_load_ipython_extension(mod)
|
|
2371
|
|
|
2374
|
|
|
2372
|
def unload_extension(self, module_str):
|
|
2375
|
def unload_extension(self, module_str):
|
|
2373
|
"""Unload an IPython extension by its module name.
|
|
2376
|
"""Unload an IPython extension by its module name.
|
|
2374
|
|
|
2377
|
|
|
2375
|
This function looks up the extension's name in ``sys.modules`` and
|
|
2378
|
This function looks up the extension's name in ``sys.modules`` and
|
|
2376
|
simply calls ``mod.unload_ipython_extension(self)``.
|
|
2379
|
simply calls ``mod.unload_ipython_extension(self)``.
|
|
2377
|
"""
|
|
2380
|
"""
|
|
2378
|
if module_str in sys.modules:
|
|
2381
|
if module_str in sys.modules:
|
|
2379
|
mod = sys.modules[module_str]
|
|
2382
|
mod = sys.modules[module_str]
|
|
2380
|
self._call_unload_ipython_extension(mod)
|
|
2383
|
self._call_unload_ipython_extension(mod)
|
|
2381
|
|
|
2384
|
|
|
2382
|
def reload_extension(self, module_str):
|
|
2385
|
def reload_extension(self, module_str):
|
|
2383
|
"""Reload an IPython extension by calling reload.
|
|
2386
|
"""Reload an IPython extension by calling reload.
|
|
2384
|
|
|
2387
|
|
|
2385
|
If the module has not been loaded before,
|
|
2388
|
If the module has not been loaded before,
|
|
2386
|
:meth:`InteractiveShell.load_extension` is called. Otherwise
|
|
2389
|
:meth:`InteractiveShell.load_extension` is called. Otherwise
|
|
2387
|
:func:`reload` is called and then the :func:`load_ipython_extension`
|
|
2390
|
:func:`reload` is called and then the :func:`load_ipython_extension`
|
|
2388
|
function of the module, if it exists is called.
|
|
2391
|
function of the module, if it exists is called.
|
|
2389
|
"""
|
|
2392
|
"""
|
|
2390
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
2393
|
from IPython.utils.syspathcontext import prepended_to_syspath
|
|
2391
|
|
|
2394
|
|
|
2392
|
with prepended_to_syspath(self.ipython_extension_dir):
|
|
2395
|
with prepended_to_syspath(self.ipython_extension_dir):
|
|
2393
|
if module_str in sys.modules:
|
|
2396
|
if module_str in sys.modules:
|
|
2394
|
mod = sys.modules[module_str]
|
|
2397
|
mod = sys.modules[module_str]
|
|
2395
|
reload(mod)
|
|
2398
|
reload(mod)
|
|
2396
|
self._call_load_ipython_extension(mod)
|
|
2399
|
self._call_load_ipython_extension(mod)
|
|
2397
|
else:
|
|
2400
|
else:
|
|
2398
|
self.load_extension(module_str)
|
|
2401
|
self.load_extension(module_str)
|
|
2399
|
|
|
2402
|
|
|
2400
|
def _call_load_ipython_extension(self, mod):
|
|
2403
|
def _call_load_ipython_extension(self, mod):
|
|
2401
|
if hasattr(mod, 'load_ipython_extension'):
|
|
2404
|
if hasattr(mod, 'load_ipython_extension'):
|
|
2402
|
return mod.load_ipython_extension(self)
|
|
2405
|
return mod.load_ipython_extension(self)
|
|
2403
|
|
|
2406
|
|
|
2404
|
def _call_unload_ipython_extension(self, mod):
|
|
2407
|
def _call_unload_ipython_extension(self, mod):
|
|
2405
|
if hasattr(mod, 'unload_ipython_extension'):
|
|
2408
|
if hasattr(mod, 'unload_ipython_extension'):
|
|
2406
|
return mod.unload_ipython_extension(self)
|
|
2409
|
return mod.unload_ipython_extension(self)
|
|
2407
|
|
|
2410
|
|
|
2408
|
#-------------------------------------------------------------------------
|
|
2411
|
#-------------------------------------------------------------------------
|
|
2409
|
# Things related to the prefilter
|
|
2412
|
# Things related to the prefilter
|
|
2410
|
#-------------------------------------------------------------------------
|
|
2413
|
#-------------------------------------------------------------------------
|
|
2411
|
|
|
2414
|
|
|
2412
|
def init_prefilter(self):
|
|
2415
|
def init_prefilter(self):
|
|
2413
|
self.prefilter_manager = PrefilterManager(self, config=self.config)
|
|
2416
|
self.prefilter_manager = PrefilterManager(self, config=self.config)
|
|
2414
|
# Ultimately this will be refactored in the new interpreter code, but
|
|
2417
|
# Ultimately this will be refactored in the new interpreter code, but
|
|
2415
|
# for now, we should expose the main prefilter method (there's legacy
|
|
2418
|
# for now, we should expose the main prefilter method (there's legacy
|
|
2416
|
# code out there that may rely on this).
|
|
2419
|
# code out there that may rely on this).
|
|
2417
|
self.prefilter = self.prefilter_manager.prefilter_lines
|
|
2420
|
self.prefilter = self.prefilter_manager.prefilter_lines
|
|
2418
|
|
|
2421
|
|
|
2419
|
#-------------------------------------------------------------------------
|
|
2422
|
#-------------------------------------------------------------------------
|
|
2420
|
# Utilities
|
|
2423
|
# Utilities
|
|
2421
|
#-------------------------------------------------------------------------
|
|
2424
|
#-------------------------------------------------------------------------
|
|
2422
|
|
|
2425
|
|
|
2423
|
def getoutput(self, cmd):
|
|
2426
|
def getoutput(self, cmd):
|
|
2424
|
return getoutput(self.var_expand(cmd,depth=2),
|
|
2427
|
return getoutput(self.var_expand(cmd,depth=2),
|
|
2425
|
header=self.system_header,
|
|
2428
|
header=self.system_header,
|
|
2426
|
verbose=self.system_verbose)
|
|
2429
|
verbose=self.system_verbose)
|
|
2427
|
|
|
2430
|
|
|
2428
|
def getoutputerror(self, cmd):
|
|
2431
|
def getoutputerror(self, cmd):
|
|
2429
|
return getoutputerror(self.var_expand(cmd,depth=2),
|
|
2432
|
return getoutputerror(self.var_expand(cmd,depth=2),
|
|
2430
|
header=self.system_header,
|
|
2433
|
header=self.system_header,
|
|
2431
|
verbose=self.system_verbose)
|
|
2434
|
verbose=self.system_verbose)
|
|
2432
|
|
|
2435
|
|
|
2433
|
def var_expand(self,cmd,depth=0):
|
|
2436
|
def var_expand(self,cmd,depth=0):
|
|
2434
|
"""Expand python variables in a string.
|
|
2437
|
"""Expand python variables in a string.
|
|
2435
|
|
|
2438
|
|
|
2436
|
The depth argument indicates how many frames above the caller should
|
|
2439
|
The depth argument indicates how many frames above the caller should
|
|
2437
|
be walked to look for the local namespace where to expand variables.
|
|
2440
|
be walked to look for the local namespace where to expand variables.
|
|
2438
|
|
|
2441
|
|
|
2439
|
The global namespace for expansion is always the user's interactive
|
|
2442
|
The global namespace for expansion is always the user's interactive
|
|
2440
|
namespace.
|
|
2443
|
namespace.
|
|
2441
|
"""
|
|
2444
|
"""
|
|
2442
|
|
|
2445
|
|
|
2443
|
return str(ItplNS(cmd,
|
|
2446
|
return str(ItplNS(cmd,
|
|
2444
|
self.user_ns, # globals
|
|
2447
|
self.user_ns, # globals
|
|
2445
|
# Skip our own frame in searching for locals:
|
|
2448
|
# Skip our own frame in searching for locals:
|
|
2446
|
sys._getframe(depth+1).f_locals # locals
|
|
2449
|
sys._getframe(depth+1).f_locals # locals
|
|
2447
|
))
|
|
2450
|
))
|
|
2448
|
|
|
2451
|
|
|
2449
|
def mktempfile(self,data=None):
|
|
2452
|
def mktempfile(self,data=None):
|
|
2450
|
"""Make a new tempfile and return its filename.
|
|
2453
|
"""Make a new tempfile and return its filename.
|
|
2451
|
|
|
2454
|
|
|
2452
|
This makes a call to tempfile.mktemp, but it registers the created
|
|
2455
|
This makes a call to tempfile.mktemp, but it registers the created
|
|
2453
|
filename internally so ipython cleans it up at exit time.
|
|
2456
|
filename internally so ipython cleans it up at exit time.
|
|
2454
|
|
|
2457
|
|
|
2455
|
Optional inputs:
|
|
2458
|
Optional inputs:
|
|
2456
|
|
|
2459
|
|
|
2457
|
- data(None): if data is given, it gets written out to the temp file
|
|
2460
|
- data(None): if data is given, it gets written out to the temp file
|
|
2458
|
immediately, and the file is closed again."""
|
|
2461
|
immediately, and the file is closed again."""
|
|
2459
|
|
|
2462
|
|
|
2460
|
filename = tempfile.mktemp('.py','ipython_edit_')
|
|
2463
|
filename = tempfile.mktemp('.py','ipython_edit_')
|
|
2461
|
self.tempfiles.append(filename)
|
|
2464
|
self.tempfiles.append(filename)
|
|
2462
|
|
|
2465
|
|
|
2463
|
if data:
|
|
2466
|
if data:
|
|
2464
|
tmp_file = open(filename,'w')
|
|
2467
|
tmp_file = open(filename,'w')
|
|
2465
|
tmp_file.write(data)
|
|
2468
|
tmp_file.write(data)
|
|
2466
|
tmp_file.close()
|
|
2469
|
tmp_file.close()
|
|
2467
|
return filename
|
|
2470
|
return filename
|
|
2468
|
|
|
2471
|
|
|
2469
|
def write(self,data):
|
|
2472
|
def write(self,data):
|
|
2470
|
"""Write a string to the default output"""
|
|
2473
|
"""Write a string to the default output"""
|
|
2471
|
Term.cout.write(data)
|
|
2474
|
Term.cout.write(data)
|
|
2472
|
|
|
2475
|
|
|
2473
|
def write_err(self,data):
|
|
2476
|
def write_err(self,data):
|
|
2474
|
"""Write a string to the default error output"""
|
|
2477
|
"""Write a string to the default error output"""
|
|
2475
|
Term.cerr.write(data)
|
|
2478
|
Term.cerr.write(data)
|
|
2476
|
|
|
2479
|
|
|
2477
|
def ask_yes_no(self,prompt,default=True):
|
|
2480
|
def ask_yes_no(self,prompt,default=True):
|
|
2478
|
if self.quiet:
|
|
2481
|
if self.quiet:
|
|
2479
|
return True
|
|
2482
|
return True
|
|
2480
|
return ask_yes_no(prompt,default)
|
|
2483
|
return ask_yes_no(prompt,default)
|
|
2481
|
|
|
2484
|
|
|
2482
|
#-------------------------------------------------------------------------
|
|
2485
|
#-------------------------------------------------------------------------
|
|
2483
|
# Things related to GUI support and pylab
|
|
2486
|
# Things related to GUI support and pylab
|
|
2484
|
#-------------------------------------------------------------------------
|
|
2487
|
#-------------------------------------------------------------------------
|
|
2485
|
|
|
2488
|
|
|
2486
|
def enable_pylab(self, gui=None):
|
|
2489
|
def enable_pylab(self, gui=None):
|
|
2487
|
"""Activate pylab support at runtime.
|
|
2490
|
"""Activate pylab support at runtime.
|
|
2488
|
|
|
2491
|
|
|
2489
|
This turns on support for matplotlib, preloads into the interactive
|
|
2492
|
This turns on support for matplotlib, preloads into the interactive
|
|
2490
|
namespace all of numpy and pylab, and configures IPython to correcdtly
|
|
2493
|
namespace all of numpy and pylab, and configures IPython to correcdtly
|
|
2491
|
interact with the GUI event loop. The GUI backend to be used can be
|
|
2494
|
interact with the GUI event loop. The GUI backend to be used can be
|
|
2492
|
optionally selected with the optional :param:`gui` argument.
|
|
2495
|
optionally selected with the optional :param:`gui` argument.
|
|
2493
|
|
|
2496
|
|
|
2494
|
Parameters
|
|
2497
|
Parameters
|
|
2495
|
----------
|
|
2498
|
----------
|
|
2496
|
gui : optional, string
|
|
2499
|
gui : optional, string
|
|
2497
|
|
|
2500
|
|
|
2498
|
If given, dictates the choice of matplotlib GUI backend to use
|
|
2501
|
If given, dictates the choice of matplotlib GUI backend to use
|
|
2499
|
(should be one of IPython's supported backends, 'tk', 'qt', 'wx' or
|
|
2502
|
(should be one of IPython's supported backends, 'tk', 'qt', 'wx' or
|
|
2500
|
'gtk'), otherwise we use the default chosen by matplotlib (as
|
|
2503
|
'gtk'), otherwise we use the default chosen by matplotlib (as
|
|
2501
|
dictated by the matplotlib build-time options plus the user's
|
|
2504
|
dictated by the matplotlib build-time options plus the user's
|
|
2502
|
matplotlibrc configuration file).
|
|
2505
|
matplotlibrc configuration file).
|
|
2503
|
"""
|
|
2506
|
"""
|
|
2504
|
# We want to prevent the loading of pylab to pollute the user's
|
|
2507
|
# We want to prevent the loading of pylab to pollute the user's
|
|
2505
|
# namespace as shown by the %who* magics, so we execute the activation
|
|
2508
|
# namespace as shown by the %who* magics, so we execute the activation
|
|
2506
|
# code in an empty namespace, and we update *both* user_ns and
|
|
2509
|
# code in an empty namespace, and we update *both* user_ns and
|
|
2507
|
# user_config_ns with this information.
|
|
2510
|
# user_ns_hidden with this information.
|
|
2508
|
ns = {}
|
|
2511
|
ns = {}
|
|
2509
|
gui = pylab_activate(ns, gui)
|
|
2512
|
gui = pylab_activate(ns, gui)
|
|
2510
|
self.user_ns.update(ns)
|
|
2513
|
self.user_ns.update(ns)
|
|
2511
|
self.user_config_ns.update(ns)
|
|
2514
|
self.user_ns_hidden.update(ns)
|
|
2512
|
# Now we must activate the gui pylab wants to use, and fix %run to take
|
|
2515
|
# Now we must activate the gui pylab wants to use, and fix %run to take
|
|
2513
|
# plot updates into account
|
|
2516
|
# plot updates into account
|
|
2514
|
enable_gui(gui)
|
|
2517
|
enable_gui(gui)
|
|
2515
|
self.magic_run = self._pylab_magic_run
|
|
2518
|
self.magic_run = self._pylab_magic_run
|
|
2516
|
|
|
2519
|
|
|
2517
|
#-------------------------------------------------------------------------
|
|
2520
|
#-------------------------------------------------------------------------
|
|
2518
|
# Things related to IPython exiting
|
|
2521
|
# Things related to IPython exiting
|
|
2519
|
#-------------------------------------------------------------------------
|
|
2522
|
#-------------------------------------------------------------------------
|
|
2520
|
|
|
2523
|
|
|
2521
|
def ask_exit(self):
|
|
2524
|
def ask_exit(self):
|
|
2522
|
""" Ask the shell to exit. Can be overiden and used as a callback. """
|
|
2525
|
""" Ask the shell to exit. Can be overiden and used as a callback. """
|
|
2523
|
self.exit_now = True
|
|
2526
|
self.exit_now = True
|
|
2524
|
|
|
2527
|
|
|
2525
|
def exit(self):
|
|
2528
|
def exit(self):
|
|
2526
|
"""Handle interactive exit.
|
|
2529
|
"""Handle interactive exit.
|
|
2527
|
|
|
2530
|
|
|
2528
|
This method calls the ask_exit callback."""
|
|
2531
|
This method calls the ask_exit callback."""
|
|
2529
|
if self.confirm_exit:
|
|
2532
|
if self.confirm_exit:
|
|
2530
|
if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
|
|
2533
|
if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
|
|
2531
|
self.ask_exit()
|
|
2534
|
self.ask_exit()
|
|
2532
|
else:
|
|
2535
|
else:
|
|
2533
|
self.ask_exit()
|
|
2536
|
self.ask_exit()
|
|
2534
|
|
|
2537
|
|
|
2535
|
def atexit_operations(self):
|
|
2538
|
def atexit_operations(self):
|
|
2536
|
"""This will be executed at the time of exit.
|
|
2539
|
"""This will be executed at the time of exit.
|
|
2537
|
|
|
2540
|
|
|
2538
|
Saving of persistent data should be performed here.
|
|
2541
|
Saving of persistent data should be performed here.
|
|
2539
|
"""
|
|
2542
|
"""
|
|
2540
|
self.savehist()
|
|
2543
|
self.savehist()
|
|
2541
|
|
|
2544
|
|
|
2542
|
# Cleanup all tempfiles left around
|
|
2545
|
# Cleanup all tempfiles left around
|
|
2543
|
for tfile in self.tempfiles:
|
|
2546
|
for tfile in self.tempfiles:
|
|
2544
|
try:
|
|
2547
|
try:
|
|
2545
|
os.unlink(tfile)
|
|
2548
|
os.unlink(tfile)
|
|
2546
|
except OSError:
|
|
2549
|
except OSError:
|
|
2547
|
pass
|
|
2550
|
pass
|
|
2548
|
|
|
2551
|
|
|
2549
|
# Clear all user namespaces to release all references cleanly.
|
|
2552
|
# Clear all user namespaces to release all references cleanly.
|
|
2550
|
self.reset()
|
|
2553
|
self.reset()
|
|
2551
|
|
|
2554
|
|
|
2552
|
# Run user hooks
|
|
2555
|
# Run user hooks
|
|
2553
|
self.hooks.shutdown_hook()
|
|
2556
|
self.hooks.shutdown_hook()
|
|
2554
|
|
|
2557
|
|
|
2555
|
def cleanup(self):
|
|
2558
|
def cleanup(self):
|
|
2556
|
self.restore_sys_module_state()
|
|
2559
|
self.restore_sys_module_state()
|
|
2557
|
|
|
2560
|
|
|
2558
|
|
|
2561
|
|