Show More
@@ -0,0 +1,37 b'' | |||||
|
1 | """Tests for the key interactiveshell module. | |||
|
2 | ||||
|
3 | Historically the main classes in interactiveshell have been under-tested. This | |||
|
4 | module should grow as many single-method tests as possible to trap many of the | |||
|
5 | recurring bugs we seem to encounter with high-level interaction. | |||
|
6 | ||||
|
7 | Authors | |||
|
8 | ------- | |||
|
9 | * Fernando Perez | |||
|
10 | """ | |||
|
11 | #----------------------------------------------------------------------------- | |||
|
12 | # Copyright (C) 2011 The IPython Development Team | |||
|
13 | # | |||
|
14 | # Distributed under the terms of the BSD License. The full license is in | |||
|
15 | # the file COPYING, distributed as part of this software. | |||
|
16 | #----------------------------------------------------------------------------- | |||
|
17 | ||||
|
18 | #----------------------------------------------------------------------------- | |||
|
19 | # Imports | |||
|
20 | #----------------------------------------------------------------------------- | |||
|
21 | # stdlib | |||
|
22 | import unittest | |||
|
23 | ||||
|
24 | #----------------------------------------------------------------------------- | |||
|
25 | # Tests | |||
|
26 | #----------------------------------------------------------------------------- | |||
|
27 | ||||
|
28 | class InteractiveShellTestCase(unittest.TestCase): | |||
|
29 | def test_naked_string_cells(self): | |||
|
30 | """Test that cells with only naked strings are fully executed""" | |||
|
31 | ip = get_ipython() | |||
|
32 | # First, single-line inputs | |||
|
33 | ip.run_cell('"a"\n') | |||
|
34 | self.assertEquals(ip.user_ns['_'], 'a') | |||
|
35 | # And also multi-line cells | |||
|
36 | ip.run_cell('"""a\nb"""\n') | |||
|
37 | self.assertEquals(ip.user_ns['_'], 'a\nb') |
@@ -1,321 +1,324 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Displayhook for IPython. |
|
2 | """Displayhook for IPython. | |
3 |
|
3 | |||
4 | This defines a callable class that IPython uses for `sys.displayhook`. |
|
4 | This defines a callable class that IPython uses for `sys.displayhook`. | |
5 |
|
5 | |||
6 | Authors: |
|
6 | Authors: | |
7 |
|
7 | |||
8 | * Fernando Perez |
|
8 | * Fernando Perez | |
9 | * Brian Granger |
|
9 | * Brian Granger | |
10 | * Robert Kern |
|
10 | * Robert Kern | |
11 | """ |
|
11 | """ | |
12 |
|
12 | |||
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Copyright (C) 2008-2010 The IPython Development Team |
|
14 | # Copyright (C) 2008-2010 The IPython Development Team | |
15 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> |
|
15 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> | |
16 | # |
|
16 | # | |
17 | # Distributed under the terms of the BSD License. The full license is in |
|
17 | # Distributed under the terms of the BSD License. The full license is in | |
18 | # the file COPYING, distributed as part of this software. |
|
18 | # the file COPYING, distributed as part of this software. | |
19 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
20 |
|
20 | |||
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 | # Imports |
|
22 | # Imports | |
23 | #----------------------------------------------------------------------------- |
|
23 | #----------------------------------------------------------------------------- | |
24 |
|
24 | |||
25 | import __builtin__ |
|
25 | import __builtin__ | |
26 |
|
26 | |||
27 | from IPython.config.configurable import Configurable |
|
27 | from IPython.config.configurable import Configurable | |
28 | from IPython.core import prompts |
|
28 | from IPython.core import prompts | |
29 | import IPython.utils.generics |
|
29 | import IPython.utils.generics | |
30 | import IPython.utils.io |
|
30 | import IPython.utils.io | |
31 | from IPython.utils.traitlets import Instance, List |
|
31 | from IPython.utils.traitlets import Instance, List | |
32 | from IPython.utils.warn import warn |
|
32 | from IPython.utils.warn import warn | |
33 |
|
33 | |||
34 | #----------------------------------------------------------------------------- |
|
34 | #----------------------------------------------------------------------------- | |
35 | # Main displayhook class |
|
35 | # Main displayhook class | |
36 | #----------------------------------------------------------------------------- |
|
36 | #----------------------------------------------------------------------------- | |
37 |
|
37 | |||
38 | # TODO: The DisplayHook class should be split into two classes, one that |
|
38 | # TODO: The DisplayHook class should be split into two classes, one that | |
39 | # manages the prompts and their synchronization and another that just does the |
|
39 | # manages the prompts and their synchronization and another that just does the | |
40 | # displayhook logic and calls into the prompt manager. |
|
40 | # displayhook logic and calls into the prompt manager. | |
41 |
|
41 | |||
42 | # TODO: Move the various attributes (cache_size, colors, input_sep, |
|
42 | # TODO: Move the various attributes (cache_size, colors, input_sep, | |
43 | # output_sep, output_sep2, ps1, ps2, ps_out, pad_left). Some of these are also |
|
43 | # output_sep, output_sep2, ps1, ps2, ps_out, pad_left). Some of these are also | |
44 | # attributes of InteractiveShell. They should be on ONE object only and the |
|
44 | # attributes of InteractiveShell. They should be on ONE object only and the | |
45 | # other objects should ask that one object for their values. |
|
45 | # other objects should ask that one object for their values. | |
46 |
|
46 | |||
47 | class DisplayHook(Configurable): |
|
47 | class DisplayHook(Configurable): | |
48 | """The custom IPython displayhook to replace sys.displayhook. |
|
48 | """The custom IPython displayhook to replace sys.displayhook. | |
49 |
|
49 | |||
50 | This class does many things, but the basic idea is that it is a callable |
|
50 | This class does many things, but the basic idea is that it is a callable | |
51 | that gets called anytime user code returns a value. |
|
51 | that gets called anytime user code returns a value. | |
52 |
|
52 | |||
53 | Currently this class does more than just the displayhook logic and that |
|
53 | Currently this class does more than just the displayhook logic and that | |
54 | extra logic should eventually be moved out of here. |
|
54 | extra logic should eventually be moved out of here. | |
55 | """ |
|
55 | """ | |
56 |
|
56 | |||
57 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
57 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | |
58 |
|
58 | |||
59 | def __init__(self, shell=None, cache_size=1000, |
|
59 | def __init__(self, shell=None, cache_size=1000, | |
60 | colors='NoColor', input_sep='\n', |
|
60 | colors='NoColor', input_sep='\n', | |
61 | output_sep='\n', output_sep2='', |
|
61 | output_sep='\n', output_sep2='', | |
62 | ps1 = None, ps2 = None, ps_out = None, pad_left=True, |
|
62 | ps1 = None, ps2 = None, ps_out = None, pad_left=True, | |
63 | config=None): |
|
63 | config=None): | |
64 | super(DisplayHook, self).__init__(shell=shell, config=config) |
|
64 | super(DisplayHook, self).__init__(shell=shell, config=config) | |
65 |
|
65 | |||
66 | cache_size_min = 3 |
|
66 | cache_size_min = 3 | |
67 | if cache_size <= 0: |
|
67 | if cache_size <= 0: | |
68 | self.do_full_cache = 0 |
|
68 | self.do_full_cache = 0 | |
69 | cache_size = 0 |
|
69 | cache_size = 0 | |
70 | elif cache_size < cache_size_min: |
|
70 | elif cache_size < cache_size_min: | |
71 | self.do_full_cache = 0 |
|
71 | self.do_full_cache = 0 | |
72 | cache_size = 0 |
|
72 | cache_size = 0 | |
73 | warn('caching was disabled (min value for cache size is %s).' % |
|
73 | warn('caching was disabled (min value for cache size is %s).' % | |
74 | cache_size_min,level=3) |
|
74 | cache_size_min,level=3) | |
75 | else: |
|
75 | else: | |
76 | self.do_full_cache = 1 |
|
76 | self.do_full_cache = 1 | |
77 |
|
77 | |||
78 | self.cache_size = cache_size |
|
78 | self.cache_size = cache_size | |
79 | self.input_sep = input_sep |
|
79 | self.input_sep = input_sep | |
80 |
|
80 | |||
81 | # we need a reference to the user-level namespace |
|
81 | # we need a reference to the user-level namespace | |
82 | self.shell = shell |
|
82 | self.shell = shell | |
83 |
|
83 | |||
84 | # Set input prompt strings and colors |
|
84 | # Set input prompt strings and colors | |
85 | if cache_size == 0: |
|
85 | if cache_size == 0: | |
86 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ |
|
86 | if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \ | |
87 | or ps1.find(r'\N') > -1: |
|
87 | or ps1.find(r'\N') > -1: | |
88 | ps1 = '>>> ' |
|
88 | ps1 = '>>> ' | |
89 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ |
|
89 | if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \ | |
90 | or ps2.find(r'\N') > -1: |
|
90 | or ps2.find(r'\N') > -1: | |
91 | ps2 = '... ' |
|
91 | ps2 = '... ' | |
92 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') |
|
92 | self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ') | |
93 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') |
|
93 | self.ps2_str = self._set_prompt_str(ps2,' .\\D.: ','... ') | |
94 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') |
|
94 | self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','') | |
95 |
|
95 | |||
96 | self.color_table = prompts.PromptColors |
|
96 | self.color_table = prompts.PromptColors | |
97 | self.prompt1 = prompts.Prompt1(self,sep=input_sep,prompt=self.ps1_str, |
|
97 | self.prompt1 = prompts.Prompt1(self,sep=input_sep,prompt=self.ps1_str, | |
98 | pad_left=pad_left) |
|
98 | pad_left=pad_left) | |
99 | self.prompt2 = prompts.Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) |
|
99 | self.prompt2 = prompts.Prompt2(self,prompt=self.ps2_str,pad_left=pad_left) | |
100 | self.prompt_out = prompts.PromptOut(self,sep='',prompt=self.ps_out_str, |
|
100 | self.prompt_out = prompts.PromptOut(self,sep='',prompt=self.ps_out_str, | |
101 | pad_left=pad_left) |
|
101 | pad_left=pad_left) | |
102 | self.set_colors(colors) |
|
102 | self.set_colors(colors) | |
103 |
|
103 | |||
104 | # Store the last prompt string each time, we need it for aligning |
|
104 | # Store the last prompt string each time, we need it for aligning | |
105 | # continuation and auto-rewrite prompts |
|
105 | # continuation and auto-rewrite prompts | |
106 | self.last_prompt = '' |
|
106 | self.last_prompt = '' | |
107 | self.output_sep = output_sep |
|
107 | self.output_sep = output_sep | |
108 | self.output_sep2 = output_sep2 |
|
108 | self.output_sep2 = output_sep2 | |
109 | self._,self.__,self.___ = '','','' |
|
109 | self._,self.__,self.___ = '','','' | |
110 |
|
110 | |||
111 | # these are deliberately global: |
|
111 | # these are deliberately global: | |
112 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} |
|
112 | to_user_ns = {'_':self._,'__':self.__,'___':self.___} | |
113 | self.shell.user_ns.update(to_user_ns) |
|
113 | self.shell.user_ns.update(to_user_ns) | |
114 |
|
114 | |||
115 | @property |
|
115 | @property | |
116 | def prompt_count(self): |
|
116 | def prompt_count(self): | |
117 | return self.shell.execution_count |
|
117 | return self.shell.execution_count | |
118 |
|
118 | |||
119 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): |
|
119 | def _set_prompt_str(self,p_str,cache_def,no_cache_def): | |
120 | if p_str is None: |
|
120 | if p_str is None: | |
121 | if self.do_full_cache: |
|
121 | if self.do_full_cache: | |
122 | return cache_def |
|
122 | return cache_def | |
123 | else: |
|
123 | else: | |
124 | return no_cache_def |
|
124 | return no_cache_def | |
125 | else: |
|
125 | else: | |
126 | return p_str |
|
126 | return p_str | |
127 |
|
127 | |||
128 | def set_colors(self, colors): |
|
128 | def set_colors(self, colors): | |
129 | """Set the active color scheme and configure colors for the three |
|
129 | """Set the active color scheme and configure colors for the three | |
130 | prompt subsystems.""" |
|
130 | prompt subsystems.""" | |
131 |
|
131 | |||
132 | # FIXME: This modifying of the global prompts.prompt_specials needs |
|
132 | # FIXME: This modifying of the global prompts.prompt_specials needs | |
133 | # to be fixed. We need to refactor all of the prompts stuff to use |
|
133 | # to be fixed. We need to refactor all of the prompts stuff to use | |
134 | # proper configuration and traits notifications. |
|
134 | # proper configuration and traits notifications. | |
135 | if colors.lower()=='nocolor': |
|
135 | if colors.lower()=='nocolor': | |
136 | prompts.prompt_specials = prompts.prompt_specials_nocolor |
|
136 | prompts.prompt_specials = prompts.prompt_specials_nocolor | |
137 | else: |
|
137 | else: | |
138 | prompts.prompt_specials = prompts.prompt_specials_color |
|
138 | prompts.prompt_specials = prompts.prompt_specials_color | |
139 |
|
139 | |||
140 | self.color_table.set_active_scheme(colors) |
|
140 | self.color_table.set_active_scheme(colors) | |
141 | self.prompt1.set_colors() |
|
141 | self.prompt1.set_colors() | |
142 | self.prompt2.set_colors() |
|
142 | self.prompt2.set_colors() | |
143 | self.prompt_out.set_colors() |
|
143 | self.prompt_out.set_colors() | |
144 |
|
144 | |||
145 | #------------------------------------------------------------------------- |
|
145 | #------------------------------------------------------------------------- | |
146 | # Methods used in __call__. Override these methods to modify the behavior |
|
146 | # Methods used in __call__. Override these methods to modify the behavior | |
147 | # of the displayhook. |
|
147 | # of the displayhook. | |
148 | #------------------------------------------------------------------------- |
|
148 | #------------------------------------------------------------------------- | |
149 |
|
149 | |||
150 | def check_for_underscore(self): |
|
150 | def check_for_underscore(self): | |
151 | """Check if the user has set the '_' variable by hand.""" |
|
151 | """Check if the user has set the '_' variable by hand.""" | |
152 | # If something injected a '_' variable in __builtin__, delete |
|
152 | # If something injected a '_' variable in __builtin__, delete | |
153 | # ipython's automatic one so we don't clobber that. gettext() in |
|
153 | # ipython's automatic one so we don't clobber that. gettext() in | |
154 | # particular uses _, so we need to stay away from it. |
|
154 | # particular uses _, so we need to stay away from it. | |
155 | if '_' in __builtin__.__dict__: |
|
155 | if '_' in __builtin__.__dict__: | |
156 | try: |
|
156 | try: | |
157 | del self.shell.user_ns['_'] |
|
157 | del self.shell.user_ns['_'] | |
158 | except KeyError: |
|
158 | except KeyError: | |
159 | pass |
|
159 | pass | |
160 |
|
160 | |||
161 | def quiet(self): |
|
161 | def quiet(self): | |
162 | """Should we silence the display hook because of ';'?""" |
|
162 | """Should we silence the display hook because of ';'?""" | |
163 | # do not print output if input ends in ';' |
|
163 | # do not print output if input ends in ';' | |
164 | try: |
|
164 | try: | |
165 | if self.shell.history_manager.input_hist_parsed[self.prompt_count].endswith(';\n'): |
|
165 | if self.shell.history_manager.input_hist_parsed[self.prompt_count].endswith(';\n'): | |
166 | return True |
|
166 | return True | |
167 | except IndexError: |
|
167 | except IndexError: | |
168 | # some uses of ipshellembed may fail here |
|
168 | # some uses of ipshellembed may fail here | |
169 | pass |
|
169 | pass | |
170 | return False |
|
170 | return False | |
171 |
|
171 | |||
172 | def start_displayhook(self): |
|
172 | def start_displayhook(self): | |
173 | """Start the displayhook, initializing resources.""" |
|
173 | """Start the displayhook, initializing resources.""" | |
174 | pass |
|
174 | pass | |
175 |
|
175 | |||
176 | def write_output_prompt(self): |
|
176 | def write_output_prompt(self): | |
177 | """Write the output prompt. |
|
177 | """Write the output prompt. | |
178 |
|
178 | |||
179 | The default implementation simply writes the prompt to |
|
179 | The default implementation simply writes the prompt to | |
180 | ``io.Term.cout``. |
|
180 | ``io.Term.cout``. | |
181 | """ |
|
181 | """ | |
182 | # Use write, not print which adds an extra space. |
|
182 | # Use write, not print which adds an extra space. | |
183 | IPython.utils.io.Term.cout.write(self.output_sep) |
|
183 | IPython.utils.io.Term.cout.write(self.output_sep) | |
184 | outprompt = str(self.prompt_out) |
|
184 | outprompt = str(self.prompt_out) | |
185 | if self.do_full_cache: |
|
185 | if self.do_full_cache: | |
186 | IPython.utils.io.Term.cout.write(outprompt) |
|
186 | IPython.utils.io.Term.cout.write(outprompt) | |
187 |
|
187 | |||
188 | def compute_format_data(self, result): |
|
188 | def compute_format_data(self, result): | |
189 | """Compute format data of the object to be displayed. |
|
189 | """Compute format data of the object to be displayed. | |
190 |
|
190 | |||
191 | The format data is a generalization of the :func:`repr` of an object. |
|
191 | The format data is a generalization of the :func:`repr` of an object. | |
192 | In the default implementation the format data is a :class:`dict` of |
|
192 | In the default implementation the format data is a :class:`dict` of | |
193 | key value pair where the keys are valid MIME types and the values |
|
193 | key value pair where the keys are valid MIME types and the values | |
194 | are JSON'able data structure containing the raw data for that MIME |
|
194 | are JSON'able data structure containing the raw data for that MIME | |
195 | type. It is up to frontends to determine pick a MIME to to use and |
|
195 | type. It is up to frontends to determine pick a MIME to to use and | |
196 | display that data in an appropriate manner. |
|
196 | display that data in an appropriate manner. | |
197 |
|
197 | |||
198 | This method only computes the format data for the object and should |
|
198 | This method only computes the format data for the object and should | |
199 | NOT actually print or write that to a stream. |
|
199 | NOT actually print or write that to a stream. | |
200 |
|
200 | |||
201 | Parameters |
|
201 | Parameters | |
202 | ---------- |
|
202 | ---------- | |
203 | result : object |
|
203 | result : object | |
204 | The Python object passed to the display hook, whose format will be |
|
204 | The Python object passed to the display hook, whose format will be | |
205 | computed. |
|
205 | computed. | |
206 |
|
206 | |||
207 | Returns |
|
207 | Returns | |
208 | ------- |
|
208 | ------- | |
209 | format_data : dict |
|
209 | format_data : dict | |
210 | A :class:`dict` whose keys are valid MIME types and values are |
|
210 | A :class:`dict` whose keys are valid MIME types and values are | |
211 | JSON'able raw data for that MIME type. It is recommended that |
|
211 | JSON'able raw data for that MIME type. It is recommended that | |
212 | all return values of this should always include the "text/plain" |
|
212 | all return values of this should always include the "text/plain" | |
213 | MIME type representation of the object. |
|
213 | MIME type representation of the object. | |
214 | """ |
|
214 | """ | |
215 | return self.shell.display_formatter.format(result) |
|
215 | return self.shell.display_formatter.format(result) | |
216 |
|
216 | |||
217 | def write_format_data(self, format_dict): |
|
217 | def write_format_data(self, format_dict): | |
218 | """Write the format data dict to the frontend. |
|
218 | """Write the format data dict to the frontend. | |
219 |
|
219 | |||
220 | This default version of this method simply writes the plain text |
|
220 | This default version of this method simply writes the plain text | |
221 | representation of the object to ``io.Term.cout``. Subclasses should |
|
221 | representation of the object to ``io.Term.cout``. Subclasses should | |
222 | override this method to send the entire `format_dict` to the |
|
222 | override this method to send the entire `format_dict` to the | |
223 | frontends. |
|
223 | frontends. | |
224 |
|
224 | |||
225 | Parameters |
|
225 | Parameters | |
226 | ---------- |
|
226 | ---------- | |
227 | format_dict : dict |
|
227 | format_dict : dict | |
228 | The format dict for the object passed to `sys.displayhook`. |
|
228 | The format dict for the object passed to `sys.displayhook`. | |
229 | """ |
|
229 | """ | |
230 | # We want to print because we want to always make sure we have a |
|
230 | # We want to print because we want to always make sure we have a | |
231 | # newline, even if all the prompt separators are ''. This is the |
|
231 | # newline, even if all the prompt separators are ''. This is the | |
232 | # standard IPython behavior. |
|
232 | # standard IPython behavior. | |
233 | result_repr = format_dict['text/plain'] |
|
233 | result_repr = format_dict['text/plain'] | |
234 | if '\n' in result_repr: |
|
234 | if '\n' in result_repr: | |
235 | # So that multi-line strings line up with the left column of |
|
235 | # So that multi-line strings line up with the left column of | |
236 | # the screen, instead of having the output prompt mess up |
|
236 | # the screen, instead of having the output prompt mess up | |
237 | # their first line. |
|
237 | # their first line. | |
238 | # We use the ps_out_str template instead of the expanded prompt |
|
238 | # We use the ps_out_str template instead of the expanded prompt | |
239 | # because the expansion may add ANSI escapes that will interfere |
|
239 | # because the expansion may add ANSI escapes that will interfere | |
240 | # with our ability to determine whether or not we should add |
|
240 | # with our ability to determine whether or not we should add | |
241 | # a newline. |
|
241 | # a newline. | |
242 | if self.ps_out_str and not self.ps_out_str.endswith('\n'): |
|
242 | if self.ps_out_str and not self.ps_out_str.endswith('\n'): | |
243 | # But avoid extraneous empty lines. |
|
243 | # But avoid extraneous empty lines. | |
244 | result_repr = '\n' + result_repr |
|
244 | result_repr = '\n' + result_repr | |
245 |
|
245 | |||
246 | print >>IPython.utils.io.Term.cout, result_repr |
|
246 | print >>IPython.utils.io.Term.cout, result_repr | |
247 |
|
247 | |||
248 | def update_user_ns(self, result): |
|
248 | def update_user_ns(self, result): | |
249 | """Update user_ns with various things like _, __, _1, etc.""" |
|
249 | """Update user_ns with various things like _, __, _1, etc.""" | |
250 |
|
250 | |||
251 | # Avoid recursive reference when displaying _oh/Out |
|
251 | # Avoid recursive reference when displaying _oh/Out | |
252 | if result is not self.shell.user_ns['_oh']: |
|
252 | if result is not self.shell.user_ns['_oh']: | |
253 | if len(self.shell.user_ns['_oh']) >= self.cache_size and self.do_full_cache: |
|
253 | if len(self.shell.user_ns['_oh']) >= self.cache_size and self.do_full_cache: | |
254 | warn('Output cache limit (currently '+ |
|
254 | warn('Output cache limit (currently '+ | |
255 | `self.cache_size`+' entries) hit.\n' |
|
255 | `self.cache_size`+' entries) hit.\n' | |
256 | 'Flushing cache and resetting history counter...\n' |
|
256 | 'Flushing cache and resetting history counter...\n' | |
257 | 'The only history variables available will be _,__,___ and _1\n' |
|
257 | 'The only history variables available will be _,__,___ and _1\n' | |
258 | 'with the current result.') |
|
258 | 'with the current result.') | |
259 |
|
259 | |||
260 | self.flush() |
|
260 | self.flush() | |
261 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise |
|
261 | # Don't overwrite '_' and friends if '_' is in __builtin__ (otherwise | |
262 | # we cause buggy behavior for things like gettext). |
|
262 | # we cause buggy behavior for things like gettext). | |
|
263 | ||||
263 | if '_' not in __builtin__.__dict__: |
|
264 | if '_' not in __builtin__.__dict__: | |
264 | self.___ = self.__ |
|
265 | self.___ = self.__ | |
265 | self.__ = self._ |
|
266 | self.__ = self._ | |
266 | self._ = result |
|
267 | self._ = result | |
267 |
self.shell.user_ns.update({'_':self._, |
|
268 | self.shell.user_ns.update({'_':self._, | |
|
269 | '__':self.__, | |||
|
270 | '___':self.___}) | |||
268 |
|
271 | |||
269 | # hackish access to top-level namespace to create _1,_2... dynamically |
|
272 | # hackish access to top-level namespace to create _1,_2... dynamically | |
270 | to_main = {} |
|
273 | to_main = {} | |
271 | if self.do_full_cache: |
|
274 | if self.do_full_cache: | |
272 | new_result = '_'+`self.prompt_count` |
|
275 | new_result = '_'+`self.prompt_count` | |
273 | to_main[new_result] = result |
|
276 | to_main[new_result] = result | |
274 | self.shell.user_ns.update(to_main) |
|
277 | self.shell.user_ns.update(to_main) | |
275 | self.shell.user_ns['_oh'][self.prompt_count] = result |
|
278 | self.shell.user_ns['_oh'][self.prompt_count] = result | |
276 |
|
279 | |||
277 | def log_output(self, result): |
|
280 | def log_output(self, result): | |
278 | """Log the output.""" |
|
281 | """Log the output.""" | |
279 | if self.shell.logger.log_output: |
|
282 | if self.shell.logger.log_output: | |
280 | self.shell.logger.log_write(repr(result), 'output') |
|
283 | self.shell.logger.log_write(repr(result), 'output') | |
281 |
|
284 | |||
282 | def finish_displayhook(self): |
|
285 | def finish_displayhook(self): | |
283 | """Finish up all displayhook activities.""" |
|
286 | """Finish up all displayhook activities.""" | |
284 | IPython.utils.io.Term.cout.write(self.output_sep2) |
|
287 | IPython.utils.io.Term.cout.write(self.output_sep2) | |
285 | IPython.utils.io.Term.cout.flush() |
|
288 | IPython.utils.io.Term.cout.flush() | |
286 |
|
289 | |||
287 | def __call__(self, result=None): |
|
290 | def __call__(self, result=None): | |
288 | """Printing with history cache management. |
|
291 | """Printing with history cache management. | |
289 |
|
292 | |||
290 | This is invoked everytime the interpreter needs to print, and is |
|
293 | This is invoked everytime the interpreter needs to print, and is | |
291 | activated by setting the variable sys.displayhook to it. |
|
294 | activated by setting the variable sys.displayhook to it. | |
292 | """ |
|
295 | """ | |
293 | self.check_for_underscore() |
|
296 | self.check_for_underscore() | |
294 | if result is not None and not self.quiet(): |
|
297 | if result is not None and not self.quiet(): | |
295 | self.start_displayhook() |
|
298 | self.start_displayhook() | |
296 | self.write_output_prompt() |
|
299 | self.write_output_prompt() | |
297 | format_dict = self.compute_format_data(result) |
|
300 | format_dict = self.compute_format_data(result) | |
298 | self.write_format_data(format_dict) |
|
301 | self.write_format_data(format_dict) | |
299 | self.update_user_ns(result) |
|
302 | self.update_user_ns(result) | |
300 | self.log_output(result) |
|
303 | self.log_output(result) | |
301 | self.finish_displayhook() |
|
304 | self.finish_displayhook() | |
302 |
|
305 | |||
303 | def flush(self): |
|
306 | def flush(self): | |
304 | if not self.do_full_cache: |
|
307 | if not self.do_full_cache: | |
305 | raise ValueError,"You shouldn't have reached the cache flush "\ |
|
308 | raise ValueError,"You shouldn't have reached the cache flush "\ | |
306 | "if full caching is not enabled!" |
|
309 | "if full caching is not enabled!" | |
307 | # delete auto-generated vars from global namespace |
|
310 | # delete auto-generated vars from global namespace | |
308 |
|
311 | |||
309 | for n in range(1,self.prompt_count + 1): |
|
312 | for n in range(1,self.prompt_count + 1): | |
310 | key = '_'+`n` |
|
313 | key = '_'+`n` | |
311 | try: |
|
314 | try: | |
312 | del self.shell.user_ns[key] |
|
315 | del self.shell.user_ns[key] | |
313 | except: pass |
|
316 | except: pass | |
314 | self.shell.user_ns['_oh'].clear() |
|
317 | self.shell.user_ns['_oh'].clear() | |
315 |
|
318 | |||
316 | if '_' not in __builtin__.__dict__: |
|
319 | if '_' not in __builtin__.__dict__: | |
317 | self.shell.user_ns.update({'_':None,'__':None, '___':None}) |
|
320 | self.shell.user_ns.update({'_':None,'__':None, '___':None}) | |
318 | import gc |
|
321 | import gc | |
319 | # TODO: Is this really needed? |
|
322 | # TODO: Is this really needed? | |
320 | gc.collect() |
|
323 | gc.collect() | |
321 |
|
324 |
@@ -1,2555 +1,2558 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Main IPython class.""" |
|
2 | """Main IPython class.""" | |
3 |
|
3 | |||
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 |
# Copyright (C) 2008-201 |
|
7 | # Copyright (C) 2008-2011 The IPython Development Team | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 |
|
12 | |||
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 | # Imports |
|
14 | # Imports | |
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 |
|
16 | |||
17 | from __future__ import with_statement |
|
17 | from __future__ import with_statement | |
18 | from __future__ import absolute_import |
|
18 | from __future__ import absolute_import | |
19 |
|
19 | |||
20 | import __builtin__ |
|
20 | import __builtin__ | |
21 | import __future__ |
|
21 | import __future__ | |
22 | import abc |
|
22 | import abc | |
23 | import atexit |
|
23 | import atexit | |
24 | import codeop |
|
24 | import codeop | |
25 | import os |
|
25 | import os | |
26 | import re |
|
26 | import re | |
27 | import sys |
|
27 | import sys | |
28 | import tempfile |
|
28 | import tempfile | |
29 | import types |
|
29 | import types | |
30 | from contextlib import nested |
|
30 | from contextlib import nested | |
31 |
|
31 | |||
32 | from IPython.config.configurable import Configurable |
|
32 | from IPython.config.configurable import Configurable | |
33 | from IPython.core import debugger, oinspect |
|
33 | from IPython.core import debugger, oinspect | |
34 | from IPython.core import history as ipcorehist |
|
34 | from IPython.core import history as ipcorehist | |
35 | from IPython.core import page |
|
35 | from IPython.core import page | |
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.compilerop import CachingCompiler |
|
41 | from IPython.core.compilerop import CachingCompiler | |
42 | from IPython.core.display_trap import DisplayTrap |
|
42 | from IPython.core.display_trap import DisplayTrap | |
43 | from IPython.core.displayhook import DisplayHook |
|
43 | from IPython.core.displayhook import DisplayHook | |
44 | from IPython.core.displaypub import DisplayPublisher |
|
44 | from IPython.core.displaypub import DisplayPublisher | |
45 | from IPython.core.error import TryNext, UsageError |
|
45 | from IPython.core.error import TryNext, UsageError | |
46 | from IPython.core.extensions import ExtensionManager |
|
46 | from IPython.core.extensions import ExtensionManager | |
47 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
47 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
48 | from IPython.core.formatters import DisplayFormatter |
|
48 | from IPython.core.formatters import DisplayFormatter | |
49 | from IPython.core.history import HistoryManager |
|
49 | from IPython.core.history import HistoryManager | |
50 | from IPython.core.inputsplitter import IPythonInputSplitter |
|
50 | from IPython.core.inputsplitter import IPythonInputSplitter | |
51 | from IPython.core.logger import Logger |
|
51 | from IPython.core.logger import Logger | |
52 | from IPython.core.magic import Magic |
|
52 | from IPython.core.magic import Magic | |
53 | from IPython.core.payload import PayloadManager |
|
53 | from IPython.core.payload import PayloadManager | |
54 | from IPython.core.plugin import PluginManager |
|
54 | from IPython.core.plugin import PluginManager | |
55 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC |
|
55 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC | |
56 | from IPython.external.Itpl import ItplNS |
|
56 | from IPython.external.Itpl import ItplNS | |
57 | from IPython.utils import PyColorize |
|
57 | from IPython.utils import PyColorize | |
58 | from IPython.utils import io |
|
58 | from IPython.utils import io | |
59 | from IPython.utils import pickleshare |
|
59 | from IPython.utils import pickleshare | |
60 | from IPython.utils.doctestreload import doctest_reload |
|
60 | from IPython.utils.doctestreload import doctest_reload | |
61 | from IPython.utils.io import ask_yes_no, rprint |
|
61 | from IPython.utils.io import ask_yes_no, rprint | |
62 | from IPython.utils.ipstruct import Struct |
|
62 | from IPython.utils.ipstruct import Struct | |
63 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError |
|
63 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError | |
64 | from IPython.utils.process import system, getoutput |
|
64 | from IPython.utils.process import system, getoutput | |
65 | from IPython.utils.strdispatch import StrDispatch |
|
65 | from IPython.utils.strdispatch import StrDispatch | |
66 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
66 | from IPython.utils.syspathcontext import prepended_to_syspath | |
67 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList |
|
67 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList | |
68 | from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum, |
|
68 | from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum, | |
69 | List, Unicode, Instance, Type) |
|
69 | List, Unicode, Instance, Type) | |
70 | from IPython.utils.warn import warn, error, fatal |
|
70 | from IPython.utils.warn import warn, error, fatal | |
71 | import IPython.core.hooks |
|
71 | import IPython.core.hooks | |
72 |
|
72 | |||
73 | #----------------------------------------------------------------------------- |
|
73 | #----------------------------------------------------------------------------- | |
74 | # Globals |
|
74 | # Globals | |
75 | #----------------------------------------------------------------------------- |
|
75 | #----------------------------------------------------------------------------- | |
76 |
|
76 | |||
77 | # compiled regexps for autoindent management |
|
77 | # compiled regexps for autoindent management | |
78 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
78 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
79 |
|
79 | |||
80 | #----------------------------------------------------------------------------- |
|
80 | #----------------------------------------------------------------------------- | |
81 | # Utilities |
|
81 | # Utilities | |
82 | #----------------------------------------------------------------------------- |
|
82 | #----------------------------------------------------------------------------- | |
83 |
|
83 | |||
84 | # store the builtin raw_input globally, and use this always, in case user code |
|
84 | # store the builtin raw_input globally, and use this always, in case user code | |
85 | # overwrites it (like wx.py.PyShell does) |
|
85 | # overwrites it (like wx.py.PyShell does) | |
86 | raw_input_original = raw_input |
|
86 | raw_input_original = raw_input | |
87 |
|
87 | |||
88 | def softspace(file, newvalue): |
|
88 | def softspace(file, newvalue): | |
89 | """Copied from code.py, to remove the dependency""" |
|
89 | """Copied from code.py, to remove the dependency""" | |
90 |
|
90 | |||
91 | oldvalue = 0 |
|
91 | oldvalue = 0 | |
92 | try: |
|
92 | try: | |
93 | oldvalue = file.softspace |
|
93 | oldvalue = file.softspace | |
94 | except AttributeError: |
|
94 | except AttributeError: | |
95 | pass |
|
95 | pass | |
96 | try: |
|
96 | try: | |
97 | file.softspace = newvalue |
|
97 | file.softspace = newvalue | |
98 | except (AttributeError, TypeError): |
|
98 | except (AttributeError, TypeError): | |
99 | # "attribute-less object" or "read-only attributes" |
|
99 | # "attribute-less object" or "read-only attributes" | |
100 | pass |
|
100 | pass | |
101 | return oldvalue |
|
101 | return oldvalue | |
102 |
|
102 | |||
103 |
|
103 | |||
104 | def no_op(*a, **kw): pass |
|
104 | def no_op(*a, **kw): pass | |
105 |
|
105 | |||
106 | class SpaceInInput(Exception): pass |
|
106 | class SpaceInInput(Exception): pass | |
107 |
|
107 | |||
108 | class Bunch: pass |
|
108 | class Bunch: pass | |
109 |
|
109 | |||
110 |
|
110 | |||
111 | def get_default_colors(): |
|
111 | def get_default_colors(): | |
112 | if sys.platform=='darwin': |
|
112 | if sys.platform=='darwin': | |
113 | return "LightBG" |
|
113 | return "LightBG" | |
114 | elif os.name=='nt': |
|
114 | elif os.name=='nt': | |
115 | return 'Linux' |
|
115 | return 'Linux' | |
116 | else: |
|
116 | else: | |
117 | return 'Linux' |
|
117 | return 'Linux' | |
118 |
|
118 | |||
119 |
|
119 | |||
120 | class SeparateStr(Str): |
|
120 | class SeparateStr(Str): | |
121 | """A Str subclass to validate separate_in, separate_out, etc. |
|
121 | """A Str subclass to validate separate_in, separate_out, etc. | |
122 |
|
122 | |||
123 | This is a Str based trait that converts '0'->'' and '\\n'->'\n'. |
|
123 | This is a Str based trait that converts '0'->'' and '\\n'->'\n'. | |
124 | """ |
|
124 | """ | |
125 |
|
125 | |||
126 | def validate(self, obj, value): |
|
126 | def validate(self, obj, value): | |
127 | if value == '0': value = '' |
|
127 | if value == '0': value = '' | |
128 | value = value.replace('\\n','\n') |
|
128 | value = value.replace('\\n','\n') | |
129 | return super(SeparateStr, self).validate(obj, value) |
|
129 | return super(SeparateStr, self).validate(obj, value) | |
130 |
|
130 | |||
131 | class MultipleInstanceError(Exception): |
|
131 | class MultipleInstanceError(Exception): | |
132 | pass |
|
132 | pass | |
133 |
|
133 | |||
134 |
|
134 | |||
135 | #----------------------------------------------------------------------------- |
|
135 | #----------------------------------------------------------------------------- | |
136 | # Main IPython class |
|
136 | # Main IPython class | |
137 | #----------------------------------------------------------------------------- |
|
137 | #----------------------------------------------------------------------------- | |
138 |
|
138 | |||
139 | class InteractiveShell(Configurable, Magic): |
|
139 | class InteractiveShell(Configurable, Magic): | |
140 | """An enhanced, interactive shell for Python.""" |
|
140 | """An enhanced, interactive shell for Python.""" | |
141 |
|
141 | |||
142 | _instance = None |
|
142 | _instance = None | |
143 | autocall = Enum((0,1,2), default_value=1, config=True) |
|
143 | autocall = Enum((0,1,2), default_value=1, config=True) | |
144 | # TODO: remove all autoindent logic and put into frontends. |
|
144 | # TODO: remove all autoindent logic and put into frontends. | |
145 | # We can't do this yet because even runlines uses the autoindent. |
|
145 | # We can't do this yet because even runlines uses the autoindent. | |
146 | autoindent = CBool(True, config=True) |
|
146 | autoindent = CBool(True, config=True) | |
147 | automagic = CBool(True, config=True) |
|
147 | automagic = CBool(True, config=True) | |
148 | cache_size = Int(1000, config=True) |
|
148 | cache_size = Int(1000, config=True) | |
149 | color_info = CBool(True, config=True) |
|
149 | color_info = CBool(True, config=True) | |
150 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
150 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
151 | default_value=get_default_colors(), config=True) |
|
151 | default_value=get_default_colors(), config=True) | |
152 | debug = CBool(False, config=True) |
|
152 | debug = CBool(False, config=True) | |
153 | deep_reload = CBool(False, config=True) |
|
153 | deep_reload = CBool(False, config=True) | |
154 | display_formatter = Instance(DisplayFormatter) |
|
154 | display_formatter = Instance(DisplayFormatter) | |
155 | displayhook_class = Type(DisplayHook) |
|
155 | displayhook_class = Type(DisplayHook) | |
156 | display_pub_class = Type(DisplayPublisher) |
|
156 | display_pub_class = Type(DisplayPublisher) | |
157 |
|
157 | |||
158 | exit_now = CBool(False) |
|
158 | exit_now = CBool(False) | |
159 | # Monotonically increasing execution counter |
|
159 | # Monotonically increasing execution counter | |
160 | execution_count = Int(1) |
|
160 | execution_count = Int(1) | |
161 | filename = Str("<ipython console>") |
|
161 | filename = Str("<ipython console>") | |
162 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
162 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
163 |
|
163 | |||
164 | # Input splitter, to split entire cells of input into either individual |
|
164 | # Input splitter, to split entire cells of input into either individual | |
165 | # interactive statements or whole blocks. |
|
165 | # interactive statements or whole blocks. | |
166 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
166 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
167 | (), {}) |
|
167 | (), {}) | |
168 | logstart = CBool(False, config=True) |
|
168 | logstart = CBool(False, config=True) | |
169 | logfile = Str('', config=True) |
|
169 | logfile = Str('', config=True) | |
170 | logappend = Str('', config=True) |
|
170 | logappend = Str('', config=True) | |
171 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
171 | object_info_string_level = Enum((0,1,2), default_value=0, | |
172 | config=True) |
|
172 | config=True) | |
173 | pdb = CBool(False, config=True) |
|
173 | pdb = CBool(False, config=True) | |
174 |
|
174 | |||
175 | profile = Str('', config=True) |
|
175 | profile = Str('', config=True) | |
176 | prompt_in1 = Str('In [\\#]: ', config=True) |
|
176 | prompt_in1 = Str('In [\\#]: ', config=True) | |
177 | prompt_in2 = Str(' .\\D.: ', config=True) |
|
177 | prompt_in2 = Str(' .\\D.: ', config=True) | |
178 | prompt_out = Str('Out[\\#]: ', config=True) |
|
178 | prompt_out = Str('Out[\\#]: ', config=True) | |
179 | prompts_pad_left = CBool(True, config=True) |
|
179 | prompts_pad_left = CBool(True, config=True) | |
180 | quiet = CBool(False, config=True) |
|
180 | quiet = CBool(False, config=True) | |
181 |
|
181 | |||
182 | history_length = Int(10000, config=True) |
|
182 | history_length = Int(10000, config=True) | |
183 |
|
183 | |||
184 | # The readline stuff will eventually be moved to the terminal subclass |
|
184 | # The readline stuff will eventually be moved to the terminal subclass | |
185 | # but for now, we can't do that as readline is welded in everywhere. |
|
185 | # but for now, we can't do that as readline is welded in everywhere. | |
186 | readline_use = CBool(True, config=True) |
|
186 | readline_use = CBool(True, config=True) | |
187 | readline_merge_completions = CBool(True, config=True) |
|
187 | readline_merge_completions = CBool(True, config=True) | |
188 | readline_omit__names = Enum((0,1,2), default_value=2, config=True) |
|
188 | readline_omit__names = Enum((0,1,2), default_value=2, config=True) | |
189 | readline_remove_delims = Str('-/~', config=True) |
|
189 | readline_remove_delims = Str('-/~', config=True) | |
190 | readline_parse_and_bind = List([ |
|
190 | readline_parse_and_bind = List([ | |
191 | 'tab: complete', |
|
191 | 'tab: complete', | |
192 | '"\C-l": clear-screen', |
|
192 | '"\C-l": clear-screen', | |
193 | 'set show-all-if-ambiguous on', |
|
193 | 'set show-all-if-ambiguous on', | |
194 | '"\C-o": tab-insert', |
|
194 | '"\C-o": tab-insert', | |
195 | '"\M-i": " "', |
|
195 | '"\M-i": " "', | |
196 | '"\M-o": "\d\d\d\d"', |
|
196 | '"\M-o": "\d\d\d\d"', | |
197 | '"\M-I": "\d\d\d\d"', |
|
197 | '"\M-I": "\d\d\d\d"', | |
198 | '"\C-r": reverse-search-history', |
|
198 | '"\C-r": reverse-search-history', | |
199 | '"\C-s": forward-search-history', |
|
199 | '"\C-s": forward-search-history', | |
200 | '"\C-p": history-search-backward', |
|
200 | '"\C-p": history-search-backward', | |
201 | '"\C-n": history-search-forward', |
|
201 | '"\C-n": history-search-forward', | |
202 | '"\e[A": history-search-backward', |
|
202 | '"\e[A": history-search-backward', | |
203 | '"\e[B": history-search-forward', |
|
203 | '"\e[B": history-search-forward', | |
204 | '"\C-k": kill-line', |
|
204 | '"\C-k": kill-line', | |
205 | '"\C-u": unix-line-discard', |
|
205 | '"\C-u": unix-line-discard', | |
206 | ], allow_none=False, config=True) |
|
206 | ], allow_none=False, config=True) | |
207 |
|
207 | |||
208 | # TODO: this part of prompt management should be moved to the frontends. |
|
208 | # TODO: this part of prompt management should be moved to the frontends. | |
209 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
209 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
210 | separate_in = SeparateStr('\n', config=True) |
|
210 | separate_in = SeparateStr('\n', config=True) | |
211 | separate_out = SeparateStr('', config=True) |
|
211 | separate_out = SeparateStr('', config=True) | |
212 | separate_out2 = SeparateStr('', config=True) |
|
212 | separate_out2 = SeparateStr('', config=True) | |
213 | wildcards_case_sensitive = CBool(True, config=True) |
|
213 | wildcards_case_sensitive = CBool(True, config=True) | |
214 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
214 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
215 | default_value='Context', config=True) |
|
215 | default_value='Context', config=True) | |
216 |
|
216 | |||
217 | # Subcomponents of InteractiveShell |
|
217 | # Subcomponents of InteractiveShell | |
218 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
218 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
219 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
219 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
220 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
220 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
221 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
221 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
222 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
222 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
223 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
223 | plugin_manager = Instance('IPython.core.plugin.PluginManager') | |
224 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
224 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
225 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
225 | history_manager = Instance('IPython.core.history.HistoryManager') | |
226 |
|
226 | |||
227 | # Private interface |
|
227 | # Private interface | |
228 | _post_execute = set() |
|
228 | _post_execute = set() | |
229 |
|
229 | |||
230 | def __init__(self, config=None, ipython_dir=None, |
|
230 | def __init__(self, config=None, ipython_dir=None, | |
231 | user_ns=None, user_global_ns=None, |
|
231 | user_ns=None, user_global_ns=None, | |
232 | custom_exceptions=((), None)): |
|
232 | custom_exceptions=((), None)): | |
233 |
|
233 | |||
234 | # This is where traits with a config_key argument are updated |
|
234 | # This is where traits with a config_key argument are updated | |
235 | # from the values on config. |
|
235 | # from the values on config. | |
236 | super(InteractiveShell, self).__init__(config=config) |
|
236 | super(InteractiveShell, self).__init__(config=config) | |
237 |
|
237 | |||
238 | # These are relatively independent and stateless |
|
238 | # These are relatively independent and stateless | |
239 | self.init_ipython_dir(ipython_dir) |
|
239 | self.init_ipython_dir(ipython_dir) | |
240 | self.init_instance_attrs() |
|
240 | self.init_instance_attrs() | |
241 | self.init_environment() |
|
241 | self.init_environment() | |
242 |
|
242 | |||
243 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
243 | # Create namespaces (user_ns, user_global_ns, etc.) | |
244 | self.init_create_namespaces(user_ns, user_global_ns) |
|
244 | self.init_create_namespaces(user_ns, user_global_ns) | |
245 | # This has to be done after init_create_namespaces because it uses |
|
245 | # This has to be done after init_create_namespaces because it uses | |
246 | # something in self.user_ns, but before init_sys_modules, which |
|
246 | # something in self.user_ns, but before init_sys_modules, which | |
247 | # is the first thing to modify sys. |
|
247 | # is the first thing to modify sys. | |
248 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
248 | # TODO: When we override sys.stdout and sys.stderr before this class | |
249 | # is created, we are saving the overridden ones here. Not sure if this |
|
249 | # is created, we are saving the overridden ones here. Not sure if this | |
250 | # is what we want to do. |
|
250 | # is what we want to do. | |
251 | self.save_sys_module_state() |
|
251 | self.save_sys_module_state() | |
252 | self.init_sys_modules() |
|
252 | self.init_sys_modules() | |
253 |
|
253 | |||
254 | self.init_history() |
|
254 | self.init_history() | |
255 | self.init_encoding() |
|
255 | self.init_encoding() | |
256 | self.init_prefilter() |
|
256 | self.init_prefilter() | |
257 |
|
257 | |||
258 | Magic.__init__(self, self) |
|
258 | Magic.__init__(self, self) | |
259 |
|
259 | |||
260 | self.init_syntax_highlighting() |
|
260 | self.init_syntax_highlighting() | |
261 | self.init_hooks() |
|
261 | self.init_hooks() | |
262 | self.init_pushd_popd_magic() |
|
262 | self.init_pushd_popd_magic() | |
263 | # self.init_traceback_handlers use to be here, but we moved it below |
|
263 | # self.init_traceback_handlers use to be here, but we moved it below | |
264 | # because it and init_io have to come after init_readline. |
|
264 | # because it and init_io have to come after init_readline. | |
265 | self.init_user_ns() |
|
265 | self.init_user_ns() | |
266 | self.init_logger() |
|
266 | self.init_logger() | |
267 | self.init_alias() |
|
267 | self.init_alias() | |
268 | self.init_builtins() |
|
268 | self.init_builtins() | |
269 |
|
269 | |||
270 | # pre_config_initialization |
|
270 | # pre_config_initialization | |
271 |
|
271 | |||
272 | # The next section should contain everything that was in ipmaker. |
|
272 | # The next section should contain everything that was in ipmaker. | |
273 | self.init_logstart() |
|
273 | self.init_logstart() | |
274 |
|
274 | |||
275 | # The following was in post_config_initialization |
|
275 | # The following was in post_config_initialization | |
276 | self.init_inspector() |
|
276 | self.init_inspector() | |
277 | # init_readline() must come before init_io(), because init_io uses |
|
277 | # init_readline() must come before init_io(), because init_io uses | |
278 | # readline related things. |
|
278 | # readline related things. | |
279 | self.init_readline() |
|
279 | self.init_readline() | |
280 | # init_completer must come after init_readline, because it needs to |
|
280 | # init_completer must come after init_readline, because it needs to | |
281 | # know whether readline is present or not system-wide to configure the |
|
281 | # know whether readline is present or not system-wide to configure the | |
282 | # completers, since the completion machinery can now operate |
|
282 | # completers, since the completion machinery can now operate | |
283 | # independently of readline (e.g. over the network) |
|
283 | # independently of readline (e.g. over the network) | |
284 | self.init_completer() |
|
284 | self.init_completer() | |
285 | # TODO: init_io() needs to happen before init_traceback handlers |
|
285 | # TODO: init_io() needs to happen before init_traceback handlers | |
286 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
286 | # because the traceback handlers hardcode the stdout/stderr streams. | |
287 | # This logic in in debugger.Pdb and should eventually be changed. |
|
287 | # This logic in in debugger.Pdb and should eventually be changed. | |
288 | self.init_io() |
|
288 | self.init_io() | |
289 | self.init_traceback_handlers(custom_exceptions) |
|
289 | self.init_traceback_handlers(custom_exceptions) | |
290 | self.init_prompts() |
|
290 | self.init_prompts() | |
291 | self.init_display_formatter() |
|
291 | self.init_display_formatter() | |
292 | self.init_display_pub() |
|
292 | self.init_display_pub() | |
293 | self.init_displayhook() |
|
293 | self.init_displayhook() | |
294 | self.init_reload_doctest() |
|
294 | self.init_reload_doctest() | |
295 | self.init_magics() |
|
295 | self.init_magics() | |
296 | self.init_pdb() |
|
296 | self.init_pdb() | |
297 | self.init_extension_manager() |
|
297 | self.init_extension_manager() | |
298 | self.init_plugin_manager() |
|
298 | self.init_plugin_manager() | |
299 | self.init_payload() |
|
299 | self.init_payload() | |
300 | self.hooks.late_startup_hook() |
|
300 | self.hooks.late_startup_hook() | |
301 | atexit.register(self.atexit_operations) |
|
301 | atexit.register(self.atexit_operations) | |
302 |
|
302 | |||
303 | # While we're trying to have each part of the code directly access what it |
|
303 | # While we're trying to have each part of the code directly access what it | |
304 | # needs without keeping redundant references to objects, we have too much |
|
304 | # needs without keeping redundant references to objects, we have too much | |
305 | # legacy code that expects ip.db to exist, so let's make it a property that |
|
305 | # legacy code that expects ip.db to exist, so let's make it a property that | |
306 | # retrieves the underlying object from our new history manager. |
|
306 | # retrieves the underlying object from our new history manager. | |
307 | @property |
|
307 | @property | |
308 | def db(self): |
|
308 | def db(self): | |
309 | return self.history_manager.shadow_db |
|
309 | return self.history_manager.shadow_db | |
310 |
|
310 | |||
311 | @classmethod |
|
311 | @classmethod | |
312 | def instance(cls, *args, **kwargs): |
|
312 | def instance(cls, *args, **kwargs): | |
313 | """Returns a global InteractiveShell instance.""" |
|
313 | """Returns a global InteractiveShell instance.""" | |
314 | if cls._instance is None: |
|
314 | if cls._instance is None: | |
315 | inst = cls(*args, **kwargs) |
|
315 | inst = cls(*args, **kwargs) | |
316 | # Now make sure that the instance will also be returned by |
|
316 | # Now make sure that the instance will also be returned by | |
317 | # the subclasses instance attribute. |
|
317 | # the subclasses instance attribute. | |
318 | for subclass in cls.mro(): |
|
318 | for subclass in cls.mro(): | |
319 | if issubclass(cls, subclass) and \ |
|
319 | if issubclass(cls, subclass) and \ | |
320 | issubclass(subclass, InteractiveShell): |
|
320 | issubclass(subclass, InteractiveShell): | |
321 | subclass._instance = inst |
|
321 | subclass._instance = inst | |
322 | else: |
|
322 | else: | |
323 | break |
|
323 | break | |
324 | if isinstance(cls._instance, cls): |
|
324 | if isinstance(cls._instance, cls): | |
325 | return cls._instance |
|
325 | return cls._instance | |
326 | else: |
|
326 | else: | |
327 | raise MultipleInstanceError( |
|
327 | raise MultipleInstanceError( | |
328 | 'Multiple incompatible subclass instances of ' |
|
328 | 'Multiple incompatible subclass instances of ' | |
329 | 'InteractiveShell are being created.' |
|
329 | 'InteractiveShell are being created.' | |
330 | ) |
|
330 | ) | |
331 |
|
331 | |||
332 | @classmethod |
|
332 | @classmethod | |
333 | def initialized(cls): |
|
333 | def initialized(cls): | |
334 | return hasattr(cls, "_instance") |
|
334 | return hasattr(cls, "_instance") | |
335 |
|
335 | |||
336 | def get_ipython(self): |
|
336 | def get_ipython(self): | |
337 | """Return the currently running IPython instance.""" |
|
337 | """Return the currently running IPython instance.""" | |
338 | return self |
|
338 | return self | |
339 |
|
339 | |||
340 | #------------------------------------------------------------------------- |
|
340 | #------------------------------------------------------------------------- | |
341 | # Trait changed handlers |
|
341 | # Trait changed handlers | |
342 | #------------------------------------------------------------------------- |
|
342 | #------------------------------------------------------------------------- | |
343 |
|
343 | |||
344 | def _ipython_dir_changed(self, name, new): |
|
344 | def _ipython_dir_changed(self, name, new): | |
345 | if not os.path.isdir(new): |
|
345 | if not os.path.isdir(new): | |
346 | os.makedirs(new, mode = 0777) |
|
346 | os.makedirs(new, mode = 0777) | |
347 |
|
347 | |||
348 | def set_autoindent(self,value=None): |
|
348 | def set_autoindent(self,value=None): | |
349 | """Set the autoindent flag, checking for readline support. |
|
349 | """Set the autoindent flag, checking for readline support. | |
350 |
|
350 | |||
351 | If called with no arguments, it acts as a toggle.""" |
|
351 | If called with no arguments, it acts as a toggle.""" | |
352 |
|
352 | |||
353 | if not self.has_readline: |
|
353 | if not self.has_readline: | |
354 | if os.name == 'posix': |
|
354 | if os.name == 'posix': | |
355 | warn("The auto-indent feature requires the readline library") |
|
355 | warn("The auto-indent feature requires the readline library") | |
356 | self.autoindent = 0 |
|
356 | self.autoindent = 0 | |
357 | return |
|
357 | return | |
358 | if value is None: |
|
358 | if value is None: | |
359 | self.autoindent = not self.autoindent |
|
359 | self.autoindent = not self.autoindent | |
360 | else: |
|
360 | else: | |
361 | self.autoindent = value |
|
361 | self.autoindent = value | |
362 |
|
362 | |||
363 | #------------------------------------------------------------------------- |
|
363 | #------------------------------------------------------------------------- | |
364 | # init_* methods called by __init__ |
|
364 | # init_* methods called by __init__ | |
365 | #------------------------------------------------------------------------- |
|
365 | #------------------------------------------------------------------------- | |
366 |
|
366 | |||
367 | def init_ipython_dir(self, ipython_dir): |
|
367 | def init_ipython_dir(self, ipython_dir): | |
368 | if ipython_dir is not None: |
|
368 | if ipython_dir is not None: | |
369 | self.ipython_dir = ipython_dir |
|
369 | self.ipython_dir = ipython_dir | |
370 | self.config.Global.ipython_dir = self.ipython_dir |
|
370 | self.config.Global.ipython_dir = self.ipython_dir | |
371 | return |
|
371 | return | |
372 |
|
372 | |||
373 | if hasattr(self.config.Global, 'ipython_dir'): |
|
373 | if hasattr(self.config.Global, 'ipython_dir'): | |
374 | self.ipython_dir = self.config.Global.ipython_dir |
|
374 | self.ipython_dir = self.config.Global.ipython_dir | |
375 | else: |
|
375 | else: | |
376 | self.ipython_dir = get_ipython_dir() |
|
376 | self.ipython_dir = get_ipython_dir() | |
377 |
|
377 | |||
378 | # All children can just read this |
|
378 | # All children can just read this | |
379 | self.config.Global.ipython_dir = self.ipython_dir |
|
379 | self.config.Global.ipython_dir = self.ipython_dir | |
380 |
|
380 | |||
381 | def init_instance_attrs(self): |
|
381 | def init_instance_attrs(self): | |
382 | self.more = False |
|
382 | self.more = False | |
383 |
|
383 | |||
384 | # command compiler |
|
384 | # command compiler | |
385 | self.compile = CachingCompiler() |
|
385 | self.compile = CachingCompiler() | |
386 |
|
386 | |||
387 | # User input buffers |
|
387 | # User input buffers | |
388 | # NOTE: these variables are slated for full removal, once we are 100% |
|
388 | # NOTE: these variables are slated for full removal, once we are 100% | |
389 | # sure that the new execution logic is solid. We will delte runlines, |
|
389 | # sure that the new execution logic is solid. We will delte runlines, | |
390 | # push_line and these buffers, as all input will be managed by the |
|
390 | # push_line and these buffers, as all input will be managed by the | |
391 | # frontends via an inputsplitter instance. |
|
391 | # frontends via an inputsplitter instance. | |
392 | self.buffer = [] |
|
392 | self.buffer = [] | |
393 | self.buffer_raw = [] |
|
393 | self.buffer_raw = [] | |
394 |
|
394 | |||
395 | # Make an empty namespace, which extension writers can rely on both |
|
395 | # Make an empty namespace, which extension writers can rely on both | |
396 | # existing and NEVER being used by ipython itself. This gives them a |
|
396 | # existing and NEVER being used by ipython itself. This gives them a | |
397 | # convenient location for storing additional information and state |
|
397 | # convenient location for storing additional information and state | |
398 | # their extensions may require, without fear of collisions with other |
|
398 | # their extensions may require, without fear of collisions with other | |
399 | # ipython names that may develop later. |
|
399 | # ipython names that may develop later. | |
400 | self.meta = Struct() |
|
400 | self.meta = Struct() | |
401 |
|
401 | |||
402 | # Object variable to store code object waiting execution. This is |
|
402 | # Object variable to store code object waiting execution. This is | |
403 | # used mainly by the multithreaded shells, but it can come in handy in |
|
403 | # used mainly by the multithreaded shells, but it can come in handy in | |
404 | # other situations. No need to use a Queue here, since it's a single |
|
404 | # other situations. No need to use a Queue here, since it's a single | |
405 | # item which gets cleared once run. |
|
405 | # item which gets cleared once run. | |
406 | self.code_to_run = None |
|
406 | self.code_to_run = None | |
407 |
|
407 | |||
408 | # Temporary files used for various purposes. Deleted at exit. |
|
408 | # Temporary files used for various purposes. Deleted at exit. | |
409 | self.tempfiles = [] |
|
409 | self.tempfiles = [] | |
410 |
|
410 | |||
411 | # Keep track of readline usage (later set by init_readline) |
|
411 | # Keep track of readline usage (later set by init_readline) | |
412 | self.has_readline = False |
|
412 | self.has_readline = False | |
413 |
|
413 | |||
414 | # keep track of where we started running (mainly for crash post-mortem) |
|
414 | # keep track of where we started running (mainly for crash post-mortem) | |
415 | # This is not being used anywhere currently. |
|
415 | # This is not being used anywhere currently. | |
416 | self.starting_dir = os.getcwd() |
|
416 | self.starting_dir = os.getcwd() | |
417 |
|
417 | |||
418 | # Indentation management |
|
418 | # Indentation management | |
419 | self.indent_current_nsp = 0 |
|
419 | self.indent_current_nsp = 0 | |
420 |
|
420 | |||
421 | def init_environment(self): |
|
421 | def init_environment(self): | |
422 | """Any changes we need to make to the user's environment.""" |
|
422 | """Any changes we need to make to the user's environment.""" | |
423 | pass |
|
423 | pass | |
424 |
|
424 | |||
425 | def init_encoding(self): |
|
425 | def init_encoding(self): | |
426 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
426 | # Get system encoding at startup time. Certain terminals (like Emacs | |
427 | # under Win32 have it set to None, and we need to have a known valid |
|
427 | # under Win32 have it set to None, and we need to have a known valid | |
428 | # encoding to use in the raw_input() method |
|
428 | # encoding to use in the raw_input() method | |
429 | try: |
|
429 | try: | |
430 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
430 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
431 | except AttributeError: |
|
431 | except AttributeError: | |
432 | self.stdin_encoding = 'ascii' |
|
432 | self.stdin_encoding = 'ascii' | |
433 |
|
433 | |||
434 | def init_syntax_highlighting(self): |
|
434 | def init_syntax_highlighting(self): | |
435 | # Python source parser/formatter for syntax highlighting |
|
435 | # Python source parser/formatter for syntax highlighting | |
436 | pyformat = PyColorize.Parser().format |
|
436 | pyformat = PyColorize.Parser().format | |
437 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
437 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
438 |
|
438 | |||
439 | def init_pushd_popd_magic(self): |
|
439 | def init_pushd_popd_magic(self): | |
440 | # for pushd/popd management |
|
440 | # for pushd/popd management | |
441 | try: |
|
441 | try: | |
442 | self.home_dir = get_home_dir() |
|
442 | self.home_dir = get_home_dir() | |
443 | except HomeDirError, msg: |
|
443 | except HomeDirError, msg: | |
444 | fatal(msg) |
|
444 | fatal(msg) | |
445 |
|
445 | |||
446 | self.dir_stack = [] |
|
446 | self.dir_stack = [] | |
447 |
|
447 | |||
448 | def init_logger(self): |
|
448 | def init_logger(self): | |
449 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
449 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
450 | logmode='rotate') |
|
450 | logmode='rotate') | |
451 |
|
451 | |||
452 | def init_logstart(self): |
|
452 | def init_logstart(self): | |
453 | """Initialize logging in case it was requested at the command line. |
|
453 | """Initialize logging in case it was requested at the command line. | |
454 | """ |
|
454 | """ | |
455 | if self.logappend: |
|
455 | if self.logappend: | |
456 | self.magic_logstart(self.logappend + ' append') |
|
456 | self.magic_logstart(self.logappend + ' append') | |
457 | elif self.logfile: |
|
457 | elif self.logfile: | |
458 | self.magic_logstart(self.logfile) |
|
458 | self.magic_logstart(self.logfile) | |
459 | elif self.logstart: |
|
459 | elif self.logstart: | |
460 | self.magic_logstart() |
|
460 | self.magic_logstart() | |
461 |
|
461 | |||
462 | def init_builtins(self): |
|
462 | def init_builtins(self): | |
463 | self.builtin_trap = BuiltinTrap(shell=self) |
|
463 | self.builtin_trap = BuiltinTrap(shell=self) | |
464 |
|
464 | |||
465 | def init_inspector(self): |
|
465 | def init_inspector(self): | |
466 | # Object inspector |
|
466 | # Object inspector | |
467 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
467 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
468 | PyColorize.ANSICodeColors, |
|
468 | PyColorize.ANSICodeColors, | |
469 | 'NoColor', |
|
469 | 'NoColor', | |
470 | self.object_info_string_level) |
|
470 | self.object_info_string_level) | |
471 |
|
471 | |||
472 | def init_io(self): |
|
472 | def init_io(self): | |
473 | # This will just use sys.stdout and sys.stderr. If you want to |
|
473 | # This will just use sys.stdout and sys.stderr. If you want to | |
474 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
474 | # override sys.stdout and sys.stderr themselves, you need to do that | |
475 | # *before* instantiating this class, because Term holds onto |
|
475 | # *before* instantiating this class, because Term holds onto | |
476 | # references to the underlying streams. |
|
476 | # references to the underlying streams. | |
477 | if sys.platform == 'win32' and self.has_readline: |
|
477 | if sys.platform == 'win32' and self.has_readline: | |
478 | Term = io.IOTerm(cout=self.readline._outputfile, |
|
478 | Term = io.IOTerm(cout=self.readline._outputfile, | |
479 | cerr=self.readline._outputfile) |
|
479 | cerr=self.readline._outputfile) | |
480 | else: |
|
480 | else: | |
481 | Term = io.IOTerm() |
|
481 | Term = io.IOTerm() | |
482 | io.Term = Term |
|
482 | io.Term = Term | |
483 |
|
483 | |||
484 | def init_prompts(self): |
|
484 | def init_prompts(self): | |
485 | # TODO: This is a pass for now because the prompts are managed inside |
|
485 | # TODO: This is a pass for now because the prompts are managed inside | |
486 | # the DisplayHook. Once there is a separate prompt manager, this |
|
486 | # the DisplayHook. Once there is a separate prompt manager, this | |
487 | # will initialize that object and all prompt related information. |
|
487 | # will initialize that object and all prompt related information. | |
488 | pass |
|
488 | pass | |
489 |
|
489 | |||
490 | def init_display_formatter(self): |
|
490 | def init_display_formatter(self): | |
491 | self.display_formatter = DisplayFormatter(config=self.config) |
|
491 | self.display_formatter = DisplayFormatter(config=self.config) | |
492 |
|
492 | |||
493 | def init_display_pub(self): |
|
493 | def init_display_pub(self): | |
494 | self.display_pub = self.display_pub_class(config=self.config) |
|
494 | self.display_pub = self.display_pub_class(config=self.config) | |
495 |
|
495 | |||
496 | def init_displayhook(self): |
|
496 | def init_displayhook(self): | |
497 | # Initialize displayhook, set in/out prompts and printing system |
|
497 | # Initialize displayhook, set in/out prompts and printing system | |
498 | self.displayhook = self.displayhook_class( |
|
498 | self.displayhook = self.displayhook_class( | |
499 | config=self.config, |
|
499 | config=self.config, | |
500 | shell=self, |
|
500 | shell=self, | |
501 | cache_size=self.cache_size, |
|
501 | cache_size=self.cache_size, | |
502 | input_sep = self.separate_in, |
|
502 | input_sep = self.separate_in, | |
503 | output_sep = self.separate_out, |
|
503 | output_sep = self.separate_out, | |
504 | output_sep2 = self.separate_out2, |
|
504 | output_sep2 = self.separate_out2, | |
505 | ps1 = self.prompt_in1, |
|
505 | ps1 = self.prompt_in1, | |
506 | ps2 = self.prompt_in2, |
|
506 | ps2 = self.prompt_in2, | |
507 | ps_out = self.prompt_out, |
|
507 | ps_out = self.prompt_out, | |
508 | pad_left = self.prompts_pad_left |
|
508 | pad_left = self.prompts_pad_left | |
509 | ) |
|
509 | ) | |
510 | # This is a context manager that installs/revmoes the displayhook at |
|
510 | # This is a context manager that installs/revmoes the displayhook at | |
511 | # the appropriate time. |
|
511 | # the appropriate time. | |
512 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
512 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
513 |
|
513 | |||
514 | def init_reload_doctest(self): |
|
514 | def init_reload_doctest(self): | |
515 | # Do a proper resetting of doctest, including the necessary displayhook |
|
515 | # Do a proper resetting of doctest, including the necessary displayhook | |
516 | # monkeypatching |
|
516 | # monkeypatching | |
517 | try: |
|
517 | try: | |
518 | doctest_reload() |
|
518 | doctest_reload() | |
519 | except ImportError: |
|
519 | except ImportError: | |
520 | warn("doctest module does not exist.") |
|
520 | warn("doctest module does not exist.") | |
521 |
|
521 | |||
522 | #------------------------------------------------------------------------- |
|
522 | #------------------------------------------------------------------------- | |
523 | # Things related to injections into the sys module |
|
523 | # Things related to injections into the sys module | |
524 | #------------------------------------------------------------------------- |
|
524 | #------------------------------------------------------------------------- | |
525 |
|
525 | |||
526 | def save_sys_module_state(self): |
|
526 | def save_sys_module_state(self): | |
527 | """Save the state of hooks in the sys module. |
|
527 | """Save the state of hooks in the sys module. | |
528 |
|
528 | |||
529 | This has to be called after self.user_ns is created. |
|
529 | This has to be called after self.user_ns is created. | |
530 | """ |
|
530 | """ | |
531 | self._orig_sys_module_state = {} |
|
531 | self._orig_sys_module_state = {} | |
532 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
532 | self._orig_sys_module_state['stdin'] = sys.stdin | |
533 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
533 | self._orig_sys_module_state['stdout'] = sys.stdout | |
534 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
534 | self._orig_sys_module_state['stderr'] = sys.stderr | |
535 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
535 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
536 | try: |
|
536 | try: | |
537 | self._orig_sys_modules_main_name = self.user_ns['__name__'] |
|
537 | self._orig_sys_modules_main_name = self.user_ns['__name__'] | |
538 | except KeyError: |
|
538 | except KeyError: | |
539 | pass |
|
539 | pass | |
540 |
|
540 | |||
541 | def restore_sys_module_state(self): |
|
541 | def restore_sys_module_state(self): | |
542 | """Restore the state of the sys module.""" |
|
542 | """Restore the state of the sys module.""" | |
543 | try: |
|
543 | try: | |
544 | for k, v in self._orig_sys_module_state.iteritems(): |
|
544 | for k, v in self._orig_sys_module_state.iteritems(): | |
545 | setattr(sys, k, v) |
|
545 | setattr(sys, k, v) | |
546 | except AttributeError: |
|
546 | except AttributeError: | |
547 | pass |
|
547 | pass | |
548 | # Reset what what done in self.init_sys_modules |
|
548 | # Reset what what done in self.init_sys_modules | |
549 | try: |
|
549 | try: | |
550 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name |
|
550 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name | |
551 | except (AttributeError, KeyError): |
|
551 | except (AttributeError, KeyError): | |
552 | pass |
|
552 | pass | |
553 |
|
553 | |||
554 | #------------------------------------------------------------------------- |
|
554 | #------------------------------------------------------------------------- | |
555 | # Things related to hooks |
|
555 | # Things related to hooks | |
556 | #------------------------------------------------------------------------- |
|
556 | #------------------------------------------------------------------------- | |
557 |
|
557 | |||
558 | def init_hooks(self): |
|
558 | def init_hooks(self): | |
559 | # hooks holds pointers used for user-side customizations |
|
559 | # hooks holds pointers used for user-side customizations | |
560 | self.hooks = Struct() |
|
560 | self.hooks = Struct() | |
561 |
|
561 | |||
562 | self.strdispatchers = {} |
|
562 | self.strdispatchers = {} | |
563 |
|
563 | |||
564 | # Set all default hooks, defined in the IPython.hooks module. |
|
564 | # Set all default hooks, defined in the IPython.hooks module. | |
565 | hooks = IPython.core.hooks |
|
565 | hooks = IPython.core.hooks | |
566 | for hook_name in hooks.__all__: |
|
566 | for hook_name in hooks.__all__: | |
567 | # default hooks have priority 100, i.e. low; user hooks should have |
|
567 | # default hooks have priority 100, i.e. low; user hooks should have | |
568 | # 0-100 priority |
|
568 | # 0-100 priority | |
569 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
569 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
570 |
|
570 | |||
571 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
571 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
572 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
572 | """set_hook(name,hook) -> sets an internal IPython hook. | |
573 |
|
573 | |||
574 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
574 | IPython exposes some of its internal API as user-modifiable hooks. By | |
575 | adding your function to one of these hooks, you can modify IPython's |
|
575 | adding your function to one of these hooks, you can modify IPython's | |
576 | behavior to call at runtime your own routines.""" |
|
576 | behavior to call at runtime your own routines.""" | |
577 |
|
577 | |||
578 | # At some point in the future, this should validate the hook before it |
|
578 | # At some point in the future, this should validate the hook before it | |
579 | # accepts it. Probably at least check that the hook takes the number |
|
579 | # accepts it. Probably at least check that the hook takes the number | |
580 | # of args it's supposed to. |
|
580 | # of args it's supposed to. | |
581 |
|
581 | |||
582 | f = types.MethodType(hook,self) |
|
582 | f = types.MethodType(hook,self) | |
583 |
|
583 | |||
584 | # check if the hook is for strdispatcher first |
|
584 | # check if the hook is for strdispatcher first | |
585 | if str_key is not None: |
|
585 | if str_key is not None: | |
586 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
586 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
587 | sdp.add_s(str_key, f, priority ) |
|
587 | sdp.add_s(str_key, f, priority ) | |
588 | self.strdispatchers[name] = sdp |
|
588 | self.strdispatchers[name] = sdp | |
589 | return |
|
589 | return | |
590 | if re_key is not None: |
|
590 | if re_key is not None: | |
591 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
591 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
592 | sdp.add_re(re.compile(re_key), f, priority ) |
|
592 | sdp.add_re(re.compile(re_key), f, priority ) | |
593 | self.strdispatchers[name] = sdp |
|
593 | self.strdispatchers[name] = sdp | |
594 | return |
|
594 | return | |
595 |
|
595 | |||
596 | dp = getattr(self.hooks, name, None) |
|
596 | dp = getattr(self.hooks, name, None) | |
597 | if name not in IPython.core.hooks.__all__: |
|
597 | if name not in IPython.core.hooks.__all__: | |
598 | print "Warning! Hook '%s' is not one of %s" % \ |
|
598 | print "Warning! Hook '%s' is not one of %s" % \ | |
599 | (name, IPython.core.hooks.__all__ ) |
|
599 | (name, IPython.core.hooks.__all__ ) | |
600 | if not dp: |
|
600 | if not dp: | |
601 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
601 | dp = IPython.core.hooks.CommandChainDispatcher() | |
602 |
|
602 | |||
603 | try: |
|
603 | try: | |
604 | dp.add(f,priority) |
|
604 | dp.add(f,priority) | |
605 | except AttributeError: |
|
605 | except AttributeError: | |
606 | # it was not commandchain, plain old func - replace |
|
606 | # it was not commandchain, plain old func - replace | |
607 | dp = f |
|
607 | dp = f | |
608 |
|
608 | |||
609 | setattr(self.hooks,name, dp) |
|
609 | setattr(self.hooks,name, dp) | |
610 |
|
610 | |||
611 | def register_post_execute(self, func): |
|
611 | def register_post_execute(self, func): | |
612 | """Register a function for calling after code execution. |
|
612 | """Register a function for calling after code execution. | |
613 | """ |
|
613 | """ | |
614 | if not callable(func): |
|
614 | if not callable(func): | |
615 | raise ValueError('argument %s must be callable' % func) |
|
615 | raise ValueError('argument %s must be callable' % func) | |
616 | self._post_execute.add(func) |
|
616 | self._post_execute.add(func) | |
617 |
|
617 | |||
618 | #------------------------------------------------------------------------- |
|
618 | #------------------------------------------------------------------------- | |
619 | # Things related to the "main" module |
|
619 | # Things related to the "main" module | |
620 | #------------------------------------------------------------------------- |
|
620 | #------------------------------------------------------------------------- | |
621 |
|
621 | |||
622 | def new_main_mod(self,ns=None): |
|
622 | def new_main_mod(self,ns=None): | |
623 | """Return a new 'main' module object for user code execution. |
|
623 | """Return a new 'main' module object for user code execution. | |
624 | """ |
|
624 | """ | |
625 | main_mod = self._user_main_module |
|
625 | main_mod = self._user_main_module | |
626 | init_fakemod_dict(main_mod,ns) |
|
626 | init_fakemod_dict(main_mod,ns) | |
627 | return main_mod |
|
627 | return main_mod | |
628 |
|
628 | |||
629 | def cache_main_mod(self,ns,fname): |
|
629 | def cache_main_mod(self,ns,fname): | |
630 | """Cache a main module's namespace. |
|
630 | """Cache a main module's namespace. | |
631 |
|
631 | |||
632 | When scripts are executed via %run, we must keep a reference to the |
|
632 | When scripts are executed via %run, we must keep a reference to the | |
633 | namespace of their __main__ module (a FakeModule instance) around so |
|
633 | namespace of their __main__ module (a FakeModule instance) around so | |
634 | that Python doesn't clear it, rendering objects defined therein |
|
634 | that Python doesn't clear it, rendering objects defined therein | |
635 | useless. |
|
635 | useless. | |
636 |
|
636 | |||
637 | This method keeps said reference in a private dict, keyed by the |
|
637 | This method keeps said reference in a private dict, keyed by the | |
638 | absolute path of the module object (which corresponds to the script |
|
638 | absolute path of the module object (which corresponds to the script | |
639 | path). This way, for multiple executions of the same script we only |
|
639 | path). This way, for multiple executions of the same script we only | |
640 | keep one copy of the namespace (the last one), thus preventing memory |
|
640 | keep one copy of the namespace (the last one), thus preventing memory | |
641 | leaks from old references while allowing the objects from the last |
|
641 | leaks from old references while allowing the objects from the last | |
642 | execution to be accessible. |
|
642 | execution to be accessible. | |
643 |
|
643 | |||
644 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
644 | Note: we can not allow the actual FakeModule instances to be deleted, | |
645 | because of how Python tears down modules (it hard-sets all their |
|
645 | because of how Python tears down modules (it hard-sets all their | |
646 | references to None without regard for reference counts). This method |
|
646 | references to None without regard for reference counts). This method | |
647 | must therefore make a *copy* of the given namespace, to allow the |
|
647 | must therefore make a *copy* of the given namespace, to allow the | |
648 | original module's __dict__ to be cleared and reused. |
|
648 | original module's __dict__ to be cleared and reused. | |
649 |
|
649 | |||
650 |
|
650 | |||
651 | Parameters |
|
651 | Parameters | |
652 | ---------- |
|
652 | ---------- | |
653 | ns : a namespace (a dict, typically) |
|
653 | ns : a namespace (a dict, typically) | |
654 |
|
654 | |||
655 | fname : str |
|
655 | fname : str | |
656 | Filename associated with the namespace. |
|
656 | Filename associated with the namespace. | |
657 |
|
657 | |||
658 | Examples |
|
658 | Examples | |
659 | -------- |
|
659 | -------- | |
660 |
|
660 | |||
661 | In [10]: import IPython |
|
661 | In [10]: import IPython | |
662 |
|
662 | |||
663 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
663 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
664 |
|
664 | |||
665 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
665 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
666 | Out[12]: True |
|
666 | Out[12]: True | |
667 | """ |
|
667 | """ | |
668 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
668 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
669 |
|
669 | |||
670 | def clear_main_mod_cache(self): |
|
670 | def clear_main_mod_cache(self): | |
671 | """Clear the cache of main modules. |
|
671 | """Clear the cache of main modules. | |
672 |
|
672 | |||
673 | Mainly for use by utilities like %reset. |
|
673 | Mainly for use by utilities like %reset. | |
674 |
|
674 | |||
675 | Examples |
|
675 | Examples | |
676 | -------- |
|
676 | -------- | |
677 |
|
677 | |||
678 | In [15]: import IPython |
|
678 | In [15]: import IPython | |
679 |
|
679 | |||
680 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
680 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
681 |
|
681 | |||
682 | In [17]: len(_ip._main_ns_cache) > 0 |
|
682 | In [17]: len(_ip._main_ns_cache) > 0 | |
683 | Out[17]: True |
|
683 | Out[17]: True | |
684 |
|
684 | |||
685 | In [18]: _ip.clear_main_mod_cache() |
|
685 | In [18]: _ip.clear_main_mod_cache() | |
686 |
|
686 | |||
687 | In [19]: len(_ip._main_ns_cache) == 0 |
|
687 | In [19]: len(_ip._main_ns_cache) == 0 | |
688 | Out[19]: True |
|
688 | Out[19]: True | |
689 | """ |
|
689 | """ | |
690 | self._main_ns_cache.clear() |
|
690 | self._main_ns_cache.clear() | |
691 |
|
691 | |||
692 | #------------------------------------------------------------------------- |
|
692 | #------------------------------------------------------------------------- | |
693 | # Things related to debugging |
|
693 | # Things related to debugging | |
694 | #------------------------------------------------------------------------- |
|
694 | #------------------------------------------------------------------------- | |
695 |
|
695 | |||
696 | def init_pdb(self): |
|
696 | def init_pdb(self): | |
697 | # Set calling of pdb on exceptions |
|
697 | # Set calling of pdb on exceptions | |
698 | # self.call_pdb is a property |
|
698 | # self.call_pdb is a property | |
699 | self.call_pdb = self.pdb |
|
699 | self.call_pdb = self.pdb | |
700 |
|
700 | |||
701 | def _get_call_pdb(self): |
|
701 | def _get_call_pdb(self): | |
702 | return self._call_pdb |
|
702 | return self._call_pdb | |
703 |
|
703 | |||
704 | def _set_call_pdb(self,val): |
|
704 | def _set_call_pdb(self,val): | |
705 |
|
705 | |||
706 | if val not in (0,1,False,True): |
|
706 | if val not in (0,1,False,True): | |
707 | raise ValueError,'new call_pdb value must be boolean' |
|
707 | raise ValueError,'new call_pdb value must be boolean' | |
708 |
|
708 | |||
709 | # store value in instance |
|
709 | # store value in instance | |
710 | self._call_pdb = val |
|
710 | self._call_pdb = val | |
711 |
|
711 | |||
712 | # notify the actual exception handlers |
|
712 | # notify the actual exception handlers | |
713 | self.InteractiveTB.call_pdb = val |
|
713 | self.InteractiveTB.call_pdb = val | |
714 |
|
714 | |||
715 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
715 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
716 | 'Control auto-activation of pdb at exceptions') |
|
716 | 'Control auto-activation of pdb at exceptions') | |
717 |
|
717 | |||
718 | def debugger(self,force=False): |
|
718 | def debugger(self,force=False): | |
719 | """Call the pydb/pdb debugger. |
|
719 | """Call the pydb/pdb debugger. | |
720 |
|
720 | |||
721 | Keywords: |
|
721 | Keywords: | |
722 |
|
722 | |||
723 | - force(False): by default, this routine checks the instance call_pdb |
|
723 | - force(False): by default, this routine checks the instance call_pdb | |
724 | flag and does not actually invoke the debugger if the flag is false. |
|
724 | flag and does not actually invoke the debugger if the flag is false. | |
725 | The 'force' option forces the debugger to activate even if the flag |
|
725 | The 'force' option forces the debugger to activate even if the flag | |
726 | is false. |
|
726 | is false. | |
727 | """ |
|
727 | """ | |
728 |
|
728 | |||
729 | if not (force or self.call_pdb): |
|
729 | if not (force or self.call_pdb): | |
730 | return |
|
730 | return | |
731 |
|
731 | |||
732 | if not hasattr(sys,'last_traceback'): |
|
732 | if not hasattr(sys,'last_traceback'): | |
733 | error('No traceback has been produced, nothing to debug.') |
|
733 | error('No traceback has been produced, nothing to debug.') | |
734 | return |
|
734 | return | |
735 |
|
735 | |||
736 | # use pydb if available |
|
736 | # use pydb if available | |
737 | if debugger.has_pydb: |
|
737 | if debugger.has_pydb: | |
738 | from pydb import pm |
|
738 | from pydb import pm | |
739 | else: |
|
739 | else: | |
740 | # fallback to our internal debugger |
|
740 | # fallback to our internal debugger | |
741 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
741 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
742 | self.history_saving_wrapper(pm)() |
|
742 | self.history_saving_wrapper(pm)() | |
743 |
|
743 | |||
744 | #------------------------------------------------------------------------- |
|
744 | #------------------------------------------------------------------------- | |
745 | # Things related to IPython's various namespaces |
|
745 | # Things related to IPython's various namespaces | |
746 | #------------------------------------------------------------------------- |
|
746 | #------------------------------------------------------------------------- | |
747 |
|
747 | |||
748 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): |
|
748 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): | |
749 | # Create the namespace where the user will operate. user_ns is |
|
749 | # Create the namespace where the user will operate. user_ns is | |
750 | # normally the only one used, and it is passed to the exec calls as |
|
750 | # normally the only one used, and it is passed to the exec calls as | |
751 | # the locals argument. But we do carry a user_global_ns namespace |
|
751 | # the locals argument. But we do carry a user_global_ns namespace | |
752 | # given as the exec 'globals' argument, This is useful in embedding |
|
752 | # given as the exec 'globals' argument, This is useful in embedding | |
753 | # situations where the ipython shell opens in a context where the |
|
753 | # situations where the ipython shell opens in a context where the | |
754 | # distinction between locals and globals is meaningful. For |
|
754 | # distinction between locals and globals is meaningful. For | |
755 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
755 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
756 |
|
756 | |||
757 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
757 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
758 | # level as a dict instead of a module. This is a manual fix, but I |
|
758 | # level as a dict instead of a module. This is a manual fix, but I | |
759 | # should really track down where the problem is coming from. Alex |
|
759 | # should really track down where the problem is coming from. Alex | |
760 | # Schmolck reported this problem first. |
|
760 | # Schmolck reported this problem first. | |
761 |
|
761 | |||
762 | # A useful post by Alex Martelli on this topic: |
|
762 | # A useful post by Alex Martelli on this topic: | |
763 | # Re: inconsistent value from __builtins__ |
|
763 | # Re: inconsistent value from __builtins__ | |
764 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
764 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
765 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
765 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
766 | # Gruppen: comp.lang.python |
|
766 | # Gruppen: comp.lang.python | |
767 |
|
767 | |||
768 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
768 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
769 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
769 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
770 | # > <type 'dict'> |
|
770 | # > <type 'dict'> | |
771 | # > >>> print type(__builtins__) |
|
771 | # > >>> print type(__builtins__) | |
772 | # > <type 'module'> |
|
772 | # > <type 'module'> | |
773 | # > Is this difference in return value intentional? |
|
773 | # > Is this difference in return value intentional? | |
774 |
|
774 | |||
775 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
775 | # Well, it's documented that '__builtins__' can be either a dictionary | |
776 | # or a module, and it's been that way for a long time. Whether it's |
|
776 | # or a module, and it's been that way for a long time. Whether it's | |
777 | # intentional (or sensible), I don't know. In any case, the idea is |
|
777 | # intentional (or sensible), I don't know. In any case, the idea is | |
778 | # that if you need to access the built-in namespace directly, you |
|
778 | # that if you need to access the built-in namespace directly, you | |
779 | # should start with "import __builtin__" (note, no 's') which will |
|
779 | # should start with "import __builtin__" (note, no 's') which will | |
780 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
780 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
781 |
|
781 | |||
782 | # These routines return properly built dicts as needed by the rest of |
|
782 | # These routines return properly built dicts as needed by the rest of | |
783 | # the code, and can also be used by extension writers to generate |
|
783 | # the code, and can also be used by extension writers to generate | |
784 | # properly initialized namespaces. |
|
784 | # properly initialized namespaces. | |
785 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, |
|
785 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, | |
786 | user_global_ns) |
|
786 | user_global_ns) | |
787 |
|
787 | |||
788 | # Assign namespaces |
|
788 | # Assign namespaces | |
789 | # This is the namespace where all normal user variables live |
|
789 | # This is the namespace where all normal user variables live | |
790 | self.user_ns = user_ns |
|
790 | self.user_ns = user_ns | |
791 | self.user_global_ns = user_global_ns |
|
791 | self.user_global_ns = user_global_ns | |
792 |
|
792 | |||
793 | # An auxiliary namespace that checks what parts of the user_ns were |
|
793 | # An auxiliary namespace that checks what parts of the user_ns were | |
794 | # loaded at startup, so we can list later only variables defined in |
|
794 | # loaded at startup, so we can list later only variables defined in | |
795 | # actual interactive use. Since it is always a subset of user_ns, it |
|
795 | # actual interactive use. Since it is always a subset of user_ns, it | |
796 | # doesn't need to be separately tracked in the ns_table. |
|
796 | # doesn't need to be separately tracked in the ns_table. | |
797 | self.user_ns_hidden = {} |
|
797 | self.user_ns_hidden = {} | |
798 |
|
798 | |||
799 | # A namespace to keep track of internal data structures to prevent |
|
799 | # A namespace to keep track of internal data structures to prevent | |
800 | # them from cluttering user-visible stuff. Will be updated later |
|
800 | # them from cluttering user-visible stuff. Will be updated later | |
801 | self.internal_ns = {} |
|
801 | self.internal_ns = {} | |
802 |
|
802 | |||
803 | # Now that FakeModule produces a real module, we've run into a nasty |
|
803 | # Now that FakeModule produces a real module, we've run into a nasty | |
804 | # problem: after script execution (via %run), the module where the user |
|
804 | # problem: after script execution (via %run), the module where the user | |
805 | # code ran is deleted. Now that this object is a true module (needed |
|
805 | # code ran is deleted. Now that this object is a true module (needed | |
806 | # so docetst and other tools work correctly), the Python module |
|
806 | # so docetst and other tools work correctly), the Python module | |
807 | # teardown mechanism runs over it, and sets to None every variable |
|
807 | # teardown mechanism runs over it, and sets to None every variable | |
808 | # present in that module. Top-level references to objects from the |
|
808 | # present in that module. Top-level references to objects from the | |
809 | # script survive, because the user_ns is updated with them. However, |
|
809 | # script survive, because the user_ns is updated with them. However, | |
810 | # calling functions defined in the script that use other things from |
|
810 | # calling functions defined in the script that use other things from | |
811 | # the script will fail, because the function's closure had references |
|
811 | # the script will fail, because the function's closure had references | |
812 | # to the original objects, which are now all None. So we must protect |
|
812 | # to the original objects, which are now all None. So we must protect | |
813 | # these modules from deletion by keeping a cache. |
|
813 | # these modules from deletion by keeping a cache. | |
814 | # |
|
814 | # | |
815 | # To avoid keeping stale modules around (we only need the one from the |
|
815 | # To avoid keeping stale modules around (we only need the one from the | |
816 | # last run), we use a dict keyed with the full path to the script, so |
|
816 | # last run), we use a dict keyed with the full path to the script, so | |
817 | # only the last version of the module is held in the cache. Note, |
|
817 | # only the last version of the module is held in the cache. Note, | |
818 | # however, that we must cache the module *namespace contents* (their |
|
818 | # however, that we must cache the module *namespace contents* (their | |
819 | # __dict__). Because if we try to cache the actual modules, old ones |
|
819 | # __dict__). Because if we try to cache the actual modules, old ones | |
820 | # (uncached) could be destroyed while still holding references (such as |
|
820 | # (uncached) could be destroyed while still holding references (such as | |
821 | # those held by GUI objects that tend to be long-lived)> |
|
821 | # those held by GUI objects that tend to be long-lived)> | |
822 | # |
|
822 | # | |
823 | # The %reset command will flush this cache. See the cache_main_mod() |
|
823 | # The %reset command will flush this cache. See the cache_main_mod() | |
824 | # and clear_main_mod_cache() methods for details on use. |
|
824 | # and clear_main_mod_cache() methods for details on use. | |
825 |
|
825 | |||
826 | # This is the cache used for 'main' namespaces |
|
826 | # This is the cache used for 'main' namespaces | |
827 | self._main_ns_cache = {} |
|
827 | self._main_ns_cache = {} | |
828 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
828 | # And this is the single instance of FakeModule whose __dict__ we keep | |
829 | # copying and clearing for reuse on each %run |
|
829 | # copying and clearing for reuse on each %run | |
830 | self._user_main_module = FakeModule() |
|
830 | self._user_main_module = FakeModule() | |
831 |
|
831 | |||
832 | # A table holding all the namespaces IPython deals with, so that |
|
832 | # A table holding all the namespaces IPython deals with, so that | |
833 | # introspection facilities can search easily. |
|
833 | # introspection facilities can search easily. | |
834 | self.ns_table = {'user':user_ns, |
|
834 | self.ns_table = {'user':user_ns, | |
835 | 'user_global':user_global_ns, |
|
835 | 'user_global':user_global_ns, | |
836 | 'internal':self.internal_ns, |
|
836 | 'internal':self.internal_ns, | |
837 | 'builtin':__builtin__.__dict__ |
|
837 | 'builtin':__builtin__.__dict__ | |
838 | } |
|
838 | } | |
839 |
|
839 | |||
840 | # Similarly, track all namespaces where references can be held and that |
|
840 | # Similarly, track all namespaces where references can be held and that | |
841 | # we can safely clear (so it can NOT include builtin). This one can be |
|
841 | # we can safely clear (so it can NOT include builtin). This one can be | |
842 | # a simple list. Note that the main execution namespaces, user_ns and |
|
842 | # a simple list. Note that the main execution namespaces, user_ns and | |
843 | # user_global_ns, can NOT be listed here, as clearing them blindly |
|
843 | # user_global_ns, can NOT be listed here, as clearing them blindly | |
844 | # causes errors in object __del__ methods. Instead, the reset() method |
|
844 | # causes errors in object __del__ methods. Instead, the reset() method | |
845 | # clears them manually and carefully. |
|
845 | # clears them manually and carefully. | |
846 | self.ns_refs_table = [ self.user_ns_hidden, |
|
846 | self.ns_refs_table = [ self.user_ns_hidden, | |
847 | self.internal_ns, self._main_ns_cache ] |
|
847 | self.internal_ns, self._main_ns_cache ] | |
848 |
|
848 | |||
849 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
849 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): | |
850 | """Return a valid local and global user interactive namespaces. |
|
850 | """Return a valid local and global user interactive namespaces. | |
851 |
|
851 | |||
852 | This builds a dict with the minimal information needed to operate as a |
|
852 | This builds a dict with the minimal information needed to operate as a | |
853 | valid IPython user namespace, which you can pass to the various |
|
853 | valid IPython user namespace, which you can pass to the various | |
854 | embedding classes in ipython. The default implementation returns the |
|
854 | embedding classes in ipython. The default implementation returns the | |
855 | same dict for both the locals and the globals to allow functions to |
|
855 | same dict for both the locals and the globals to allow functions to | |
856 | refer to variables in the namespace. Customized implementations can |
|
856 | refer to variables in the namespace. Customized implementations can | |
857 | return different dicts. The locals dictionary can actually be anything |
|
857 | return different dicts. The locals dictionary can actually be anything | |
858 | following the basic mapping protocol of a dict, but the globals dict |
|
858 | following the basic mapping protocol of a dict, but the globals dict | |
859 | must be a true dict, not even a subclass. It is recommended that any |
|
859 | must be a true dict, not even a subclass. It is recommended that any | |
860 | custom object for the locals namespace synchronize with the globals |
|
860 | custom object for the locals namespace synchronize with the globals | |
861 | dict somehow. |
|
861 | dict somehow. | |
862 |
|
862 | |||
863 | Raises TypeError if the provided globals namespace is not a true dict. |
|
863 | Raises TypeError if the provided globals namespace is not a true dict. | |
864 |
|
864 | |||
865 | Parameters |
|
865 | Parameters | |
866 | ---------- |
|
866 | ---------- | |
867 | user_ns : dict-like, optional |
|
867 | user_ns : dict-like, optional | |
868 | The current user namespace. The items in this namespace should |
|
868 | The current user namespace. The items in this namespace should | |
869 | be included in the output. If None, an appropriate blank |
|
869 | be included in the output. If None, an appropriate blank | |
870 | namespace should be created. |
|
870 | namespace should be created. | |
871 | user_global_ns : dict, optional |
|
871 | user_global_ns : dict, optional | |
872 | The current user global namespace. The items in this namespace |
|
872 | The current user global namespace. The items in this namespace | |
873 | should be included in the output. If None, an appropriate |
|
873 | should be included in the output. If None, an appropriate | |
874 | blank namespace should be created. |
|
874 | blank namespace should be created. | |
875 |
|
875 | |||
876 | Returns |
|
876 | Returns | |
877 | ------- |
|
877 | ------- | |
878 | A pair of dictionary-like object to be used as the local namespace |
|
878 | A pair of dictionary-like object to be used as the local namespace | |
879 | of the interpreter and a dict to be used as the global namespace. |
|
879 | of the interpreter and a dict to be used as the global namespace. | |
880 | """ |
|
880 | """ | |
881 |
|
881 | |||
882 |
|
882 | |||
883 | # We must ensure that __builtin__ (without the final 's') is always |
|
883 | # We must ensure that __builtin__ (without the final 's') is always | |
884 | # available and pointing to the __builtin__ *module*. For more details: |
|
884 | # available and pointing to the __builtin__ *module*. For more details: | |
885 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
885 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
886 |
|
886 | |||
887 | if user_ns is None: |
|
887 | if user_ns is None: | |
888 | # Set __name__ to __main__ to better match the behavior of the |
|
888 | # Set __name__ to __main__ to better match the behavior of the | |
889 | # normal interpreter. |
|
889 | # normal interpreter. | |
890 | user_ns = {'__name__' :'__main__', |
|
890 | user_ns = {'__name__' :'__main__', | |
891 | '__builtin__' : __builtin__, |
|
891 | '__builtin__' : __builtin__, | |
892 | '__builtins__' : __builtin__, |
|
892 | '__builtins__' : __builtin__, | |
893 | } |
|
893 | } | |
894 | else: |
|
894 | else: | |
895 | user_ns.setdefault('__name__','__main__') |
|
895 | user_ns.setdefault('__name__','__main__') | |
896 | user_ns.setdefault('__builtin__',__builtin__) |
|
896 | user_ns.setdefault('__builtin__',__builtin__) | |
897 | user_ns.setdefault('__builtins__',__builtin__) |
|
897 | user_ns.setdefault('__builtins__',__builtin__) | |
898 |
|
898 | |||
899 | if user_global_ns is None: |
|
899 | if user_global_ns is None: | |
900 | user_global_ns = user_ns |
|
900 | user_global_ns = user_ns | |
901 | if type(user_global_ns) is not dict: |
|
901 | if type(user_global_ns) is not dict: | |
902 | raise TypeError("user_global_ns must be a true dict; got %r" |
|
902 | raise TypeError("user_global_ns must be a true dict; got %r" | |
903 | % type(user_global_ns)) |
|
903 | % type(user_global_ns)) | |
904 |
|
904 | |||
905 | return user_ns, user_global_ns |
|
905 | return user_ns, user_global_ns | |
906 |
|
906 | |||
907 | def init_sys_modules(self): |
|
907 | def init_sys_modules(self): | |
908 | # We need to insert into sys.modules something that looks like a |
|
908 | # We need to insert into sys.modules something that looks like a | |
909 | # module but which accesses the IPython namespace, for shelve and |
|
909 | # module but which accesses the IPython namespace, for shelve and | |
910 | # pickle to work interactively. Normally they rely on getting |
|
910 | # pickle to work interactively. Normally they rely on getting | |
911 | # everything out of __main__, but for embedding purposes each IPython |
|
911 | # everything out of __main__, but for embedding purposes each IPython | |
912 | # instance has its own private namespace, so we can't go shoving |
|
912 | # instance has its own private namespace, so we can't go shoving | |
913 | # everything into __main__. |
|
913 | # everything into __main__. | |
914 |
|
914 | |||
915 | # note, however, that we should only do this for non-embedded |
|
915 | # note, however, that we should only do this for non-embedded | |
916 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
916 | # ipythons, which really mimic the __main__.__dict__ with their own | |
917 | # namespace. Embedded instances, on the other hand, should not do |
|
917 | # namespace. Embedded instances, on the other hand, should not do | |
918 | # this because they need to manage the user local/global namespaces |
|
918 | # this because they need to manage the user local/global namespaces | |
919 | # only, but they live within a 'normal' __main__ (meaning, they |
|
919 | # only, but they live within a 'normal' __main__ (meaning, they | |
920 | # shouldn't overtake the execution environment of the script they're |
|
920 | # shouldn't overtake the execution environment of the script they're | |
921 | # embedded in). |
|
921 | # embedded in). | |
922 |
|
922 | |||
923 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
923 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
924 |
|
924 | |||
925 | try: |
|
925 | try: | |
926 | main_name = self.user_ns['__name__'] |
|
926 | main_name = self.user_ns['__name__'] | |
927 | except KeyError: |
|
927 | except KeyError: | |
928 | raise KeyError('user_ns dictionary MUST have a "__name__" key') |
|
928 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
929 | else: |
|
929 | else: | |
930 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
930 | sys.modules[main_name] = FakeModule(self.user_ns) | |
931 |
|
931 | |||
932 | def init_user_ns(self): |
|
932 | def init_user_ns(self): | |
933 | """Initialize all user-visible namespaces to their minimum defaults. |
|
933 | """Initialize all user-visible namespaces to their minimum defaults. | |
934 |
|
934 | |||
935 | Certain history lists are also initialized here, as they effectively |
|
935 | Certain history lists are also initialized here, as they effectively | |
936 | act as user namespaces. |
|
936 | act as user namespaces. | |
937 |
|
937 | |||
938 | Notes |
|
938 | Notes | |
939 | ----- |
|
939 | ----- | |
940 | All data structures here are only filled in, they are NOT reset by this |
|
940 | All data structures here are only filled in, they are NOT reset by this | |
941 | method. If they were not empty before, data will simply be added to |
|
941 | method. If they were not empty before, data will simply be added to | |
942 | therm. |
|
942 | therm. | |
943 | """ |
|
943 | """ | |
944 | # This function works in two parts: first we put a few things in |
|
944 | # This function works in two parts: first we put a few things in | |
945 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
945 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
946 | # initial variables aren't shown by %who. After the sync, we add the |
|
946 | # initial variables aren't shown by %who. After the sync, we add the | |
947 | # rest of what we *do* want the user to see with %who even on a new |
|
947 | # rest of what we *do* want the user to see with %who even on a new | |
948 | # session (probably nothing, so theye really only see their own stuff) |
|
948 | # session (probably nothing, so theye really only see their own stuff) | |
949 |
|
949 | |||
950 | # The user dict must *always* have a __builtin__ reference to the |
|
950 | # The user dict must *always* have a __builtin__ reference to the | |
951 | # Python standard __builtin__ namespace, which must be imported. |
|
951 | # Python standard __builtin__ namespace, which must be imported. | |
952 | # This is so that certain operations in prompt evaluation can be |
|
952 | # This is so that certain operations in prompt evaluation can be | |
953 | # reliably executed with builtins. Note that we can NOT use |
|
953 | # reliably executed with builtins. Note that we can NOT use | |
954 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
954 | # __builtins__ (note the 's'), because that can either be a dict or a | |
955 | # module, and can even mutate at runtime, depending on the context |
|
955 | # module, and can even mutate at runtime, depending on the context | |
956 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
956 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
957 | # always a module object, though it must be explicitly imported. |
|
957 | # always a module object, though it must be explicitly imported. | |
958 |
|
958 | |||
959 | # For more details: |
|
959 | # For more details: | |
960 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
960 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
961 | ns = dict(__builtin__ = __builtin__) |
|
961 | ns = dict(__builtin__ = __builtin__) | |
962 |
|
962 | |||
963 | # Put 'help' in the user namespace |
|
963 | # Put 'help' in the user namespace | |
964 | try: |
|
964 | try: | |
965 | from site import _Helper |
|
965 | from site import _Helper | |
966 | ns['help'] = _Helper() |
|
966 | ns['help'] = _Helper() | |
967 | except ImportError: |
|
967 | except ImportError: | |
968 | warn('help() not available - check site.py') |
|
968 | warn('help() not available - check site.py') | |
969 |
|
969 | |||
970 | # make global variables for user access to the histories |
|
970 | # make global variables for user access to the histories | |
971 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
971 | ns['_ih'] = self.history_manager.input_hist_parsed | |
972 | ns['_oh'] = self.history_manager.output_hist |
|
972 | ns['_oh'] = self.history_manager.output_hist | |
973 | ns['_dh'] = self.history_manager.dir_hist |
|
973 | ns['_dh'] = self.history_manager.dir_hist | |
974 |
|
974 | |||
975 | ns['_sh'] = shadowns |
|
975 | ns['_sh'] = shadowns | |
976 |
|
976 | |||
977 | # user aliases to input and output histories. These shouldn't show up |
|
977 | # user aliases to input and output histories. These shouldn't show up | |
978 | # in %who, as they can have very large reprs. |
|
978 | # in %who, as they can have very large reprs. | |
979 | ns['In'] = self.history_manager.input_hist_parsed |
|
979 | ns['In'] = self.history_manager.input_hist_parsed | |
980 | ns['Out'] = self.history_manager.output_hist |
|
980 | ns['Out'] = self.history_manager.output_hist | |
981 |
|
981 | |||
982 | # Store myself as the public api!!! |
|
982 | # Store myself as the public api!!! | |
983 | ns['get_ipython'] = self.get_ipython |
|
983 | ns['get_ipython'] = self.get_ipython | |
984 |
|
984 | |||
985 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
985 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
986 | # by %who |
|
986 | # by %who | |
987 | self.user_ns_hidden.update(ns) |
|
987 | self.user_ns_hidden.update(ns) | |
988 |
|
988 | |||
989 | # Anything put into ns now would show up in %who. Think twice before |
|
989 | # Anything put into ns now would show up in %who. Think twice before | |
990 | # putting anything here, as we really want %who to show the user their |
|
990 | # putting anything here, as we really want %who to show the user their | |
991 | # stuff, not our variables. |
|
991 | # stuff, not our variables. | |
992 |
|
992 | |||
993 | # Finally, update the real user's namespace |
|
993 | # Finally, update the real user's namespace | |
994 | self.user_ns.update(ns) |
|
994 | self.user_ns.update(ns) | |
995 |
|
995 | |||
996 | def reset(self): |
|
996 | def reset(self): | |
997 | """Clear all internal namespaces. |
|
997 | """Clear all internal namespaces. | |
998 |
|
998 | |||
999 | Note that this is much more aggressive than %reset, since it clears |
|
999 | Note that this is much more aggressive than %reset, since it clears | |
1000 | fully all namespaces, as well as all input/output lists. |
|
1000 | fully all namespaces, as well as all input/output lists. | |
1001 | """ |
|
1001 | """ | |
1002 | # Clear histories |
|
1002 | # Clear histories | |
1003 | self.history_manager.reset() |
|
1003 | self.history_manager.reset() | |
1004 |
|
1004 | |||
1005 | # Reset counter used to index all histories |
|
1005 | # Reset counter used to index all histories | |
1006 | self.execution_count = 0 |
|
1006 | self.execution_count = 0 | |
1007 |
|
1007 | |||
1008 | # Restore the user namespaces to minimal usability |
|
1008 | # Restore the user namespaces to minimal usability | |
1009 | for ns in self.ns_refs_table: |
|
1009 | for ns in self.ns_refs_table: | |
1010 | ns.clear() |
|
1010 | ns.clear() | |
1011 |
|
1011 | |||
1012 | # The main execution namespaces must be cleared very carefully, |
|
1012 | # The main execution namespaces must be cleared very carefully, | |
1013 | # skipping the deletion of the builtin-related keys, because doing so |
|
1013 | # skipping the deletion of the builtin-related keys, because doing so | |
1014 | # would cause errors in many object's __del__ methods. |
|
1014 | # would cause errors in many object's __del__ methods. | |
1015 | for ns in [self.user_ns, self.user_global_ns]: |
|
1015 | for ns in [self.user_ns, self.user_global_ns]: | |
1016 | drop_keys = set(ns.keys()) |
|
1016 | drop_keys = set(ns.keys()) | |
1017 | drop_keys.discard('__builtin__') |
|
1017 | drop_keys.discard('__builtin__') | |
1018 | drop_keys.discard('__builtins__') |
|
1018 | drop_keys.discard('__builtins__') | |
1019 | for k in drop_keys: |
|
1019 | for k in drop_keys: | |
1020 | del ns[k] |
|
1020 | del ns[k] | |
1021 |
|
1021 | |||
1022 | # Restore the user namespaces to minimal usability |
|
1022 | # Restore the user namespaces to minimal usability | |
1023 | self.init_user_ns() |
|
1023 | self.init_user_ns() | |
1024 |
|
1024 | |||
1025 | # Restore the default and user aliases |
|
1025 | # Restore the default and user aliases | |
1026 | self.alias_manager.clear_aliases() |
|
1026 | self.alias_manager.clear_aliases() | |
1027 | self.alias_manager.init_aliases() |
|
1027 | self.alias_manager.init_aliases() | |
1028 |
|
1028 | |||
1029 | def reset_selective(self, regex=None): |
|
1029 | def reset_selective(self, regex=None): | |
1030 | """Clear selective variables from internal namespaces based on a |
|
1030 | """Clear selective variables from internal namespaces based on a | |
1031 | specified regular expression. |
|
1031 | specified regular expression. | |
1032 |
|
1032 | |||
1033 | Parameters |
|
1033 | Parameters | |
1034 | ---------- |
|
1034 | ---------- | |
1035 | regex : string or compiled pattern, optional |
|
1035 | regex : string or compiled pattern, optional | |
1036 | A regular expression pattern that will be used in searching |
|
1036 | A regular expression pattern that will be used in searching | |
1037 | variable names in the users namespaces. |
|
1037 | variable names in the users namespaces. | |
1038 | """ |
|
1038 | """ | |
1039 | if regex is not None: |
|
1039 | if regex is not None: | |
1040 | try: |
|
1040 | try: | |
1041 | m = re.compile(regex) |
|
1041 | m = re.compile(regex) | |
1042 | except TypeError: |
|
1042 | except TypeError: | |
1043 | raise TypeError('regex must be a string or compiled pattern') |
|
1043 | raise TypeError('regex must be a string or compiled pattern') | |
1044 | # Search for keys in each namespace that match the given regex |
|
1044 | # Search for keys in each namespace that match the given regex | |
1045 | # If a match is found, delete the key/value pair. |
|
1045 | # If a match is found, delete the key/value pair. | |
1046 | for ns in self.ns_refs_table: |
|
1046 | for ns in self.ns_refs_table: | |
1047 | for var in ns: |
|
1047 | for var in ns: | |
1048 | if m.search(var): |
|
1048 | if m.search(var): | |
1049 | del ns[var] |
|
1049 | del ns[var] | |
1050 |
|
1050 | |||
1051 | def push(self, variables, interactive=True): |
|
1051 | def push(self, variables, interactive=True): | |
1052 | """Inject a group of variables into the IPython user namespace. |
|
1052 | """Inject a group of variables into the IPython user namespace. | |
1053 |
|
1053 | |||
1054 | Parameters |
|
1054 | Parameters | |
1055 | ---------- |
|
1055 | ---------- | |
1056 | variables : dict, str or list/tuple of str |
|
1056 | variables : dict, str or list/tuple of str | |
1057 | The variables to inject into the user's namespace. If a dict, a |
|
1057 | The variables to inject into the user's namespace. If a dict, a | |
1058 | simple update is done. If a str, the string is assumed to have |
|
1058 | simple update is done. If a str, the string is assumed to have | |
1059 | variable names separated by spaces. A list/tuple of str can also |
|
1059 | variable names separated by spaces. A list/tuple of str can also | |
1060 | be used to give the variable names. If just the variable names are |
|
1060 | be used to give the variable names. If just the variable names are | |
1061 | give (list/tuple/str) then the variable values looked up in the |
|
1061 | give (list/tuple/str) then the variable values looked up in the | |
1062 | callers frame. |
|
1062 | callers frame. | |
1063 | interactive : bool |
|
1063 | interactive : bool | |
1064 | If True (default), the variables will be listed with the ``who`` |
|
1064 | If True (default), the variables will be listed with the ``who`` | |
1065 | magic. |
|
1065 | magic. | |
1066 | """ |
|
1066 | """ | |
1067 | vdict = None |
|
1067 | vdict = None | |
1068 |
|
1068 | |||
1069 | # We need a dict of name/value pairs to do namespace updates. |
|
1069 | # We need a dict of name/value pairs to do namespace updates. | |
1070 | if isinstance(variables, dict): |
|
1070 | if isinstance(variables, dict): | |
1071 | vdict = variables |
|
1071 | vdict = variables | |
1072 | elif isinstance(variables, (basestring, list, tuple)): |
|
1072 | elif isinstance(variables, (basestring, list, tuple)): | |
1073 | if isinstance(variables, basestring): |
|
1073 | if isinstance(variables, basestring): | |
1074 | vlist = variables.split() |
|
1074 | vlist = variables.split() | |
1075 | else: |
|
1075 | else: | |
1076 | vlist = variables |
|
1076 | vlist = variables | |
1077 | vdict = {} |
|
1077 | vdict = {} | |
1078 | cf = sys._getframe(1) |
|
1078 | cf = sys._getframe(1) | |
1079 | for name in vlist: |
|
1079 | for name in vlist: | |
1080 | try: |
|
1080 | try: | |
1081 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1081 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1082 | except: |
|
1082 | except: | |
1083 | print ('Could not get variable %s from %s' % |
|
1083 | print ('Could not get variable %s from %s' % | |
1084 | (name,cf.f_code.co_name)) |
|
1084 | (name,cf.f_code.co_name)) | |
1085 | else: |
|
1085 | else: | |
1086 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1086 | raise ValueError('variables must be a dict/str/list/tuple') | |
1087 |
|
1087 | |||
1088 | # Propagate variables to user namespace |
|
1088 | # Propagate variables to user namespace | |
1089 | self.user_ns.update(vdict) |
|
1089 | self.user_ns.update(vdict) | |
1090 |
|
1090 | |||
1091 | # And configure interactive visibility |
|
1091 | # And configure interactive visibility | |
1092 | config_ns = self.user_ns_hidden |
|
1092 | config_ns = self.user_ns_hidden | |
1093 | if interactive: |
|
1093 | if interactive: | |
1094 | for name, val in vdict.iteritems(): |
|
1094 | for name, val in vdict.iteritems(): | |
1095 | config_ns.pop(name, None) |
|
1095 | config_ns.pop(name, None) | |
1096 | else: |
|
1096 | else: | |
1097 | for name,val in vdict.iteritems(): |
|
1097 | for name,val in vdict.iteritems(): | |
1098 | config_ns[name] = val |
|
1098 | config_ns[name] = val | |
1099 |
|
1099 | |||
1100 | #------------------------------------------------------------------------- |
|
1100 | #------------------------------------------------------------------------- | |
1101 | # Things related to object introspection |
|
1101 | # Things related to object introspection | |
1102 | #------------------------------------------------------------------------- |
|
1102 | #------------------------------------------------------------------------- | |
1103 |
|
1103 | |||
1104 | def _ofind(self, oname, namespaces=None): |
|
1104 | def _ofind(self, oname, namespaces=None): | |
1105 | """Find an object in the available namespaces. |
|
1105 | """Find an object in the available namespaces. | |
1106 |
|
1106 | |||
1107 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1107 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1108 |
|
1108 | |||
1109 | Has special code to detect magic functions. |
|
1109 | Has special code to detect magic functions. | |
1110 | """ |
|
1110 | """ | |
1111 | #oname = oname.strip() |
|
1111 | #oname = oname.strip() | |
1112 | #print '1- oname: <%r>' % oname # dbg |
|
1112 | #print '1- oname: <%r>' % oname # dbg | |
1113 | try: |
|
1113 | try: | |
1114 | oname = oname.strip().encode('ascii') |
|
1114 | oname = oname.strip().encode('ascii') | |
1115 | #print '2- oname: <%r>' % oname # dbg |
|
1115 | #print '2- oname: <%r>' % oname # dbg | |
1116 | except UnicodeEncodeError: |
|
1116 | except UnicodeEncodeError: | |
1117 | print 'Python identifiers can only contain ascii characters.' |
|
1117 | print 'Python identifiers can only contain ascii characters.' | |
1118 | return dict(found=False) |
|
1118 | return dict(found=False) | |
1119 |
|
1119 | |||
1120 | alias_ns = None |
|
1120 | alias_ns = None | |
1121 | if namespaces is None: |
|
1121 | if namespaces is None: | |
1122 | # Namespaces to search in: |
|
1122 | # Namespaces to search in: | |
1123 | # Put them in a list. The order is important so that we |
|
1123 | # Put them in a list. The order is important so that we | |
1124 | # find things in the same order that Python finds them. |
|
1124 | # find things in the same order that Python finds them. | |
1125 | namespaces = [ ('Interactive', self.user_ns), |
|
1125 | namespaces = [ ('Interactive', self.user_ns), | |
1126 | ('IPython internal', self.internal_ns), |
|
1126 | ('IPython internal', self.internal_ns), | |
1127 | ('Python builtin', __builtin__.__dict__), |
|
1127 | ('Python builtin', __builtin__.__dict__), | |
1128 | ('Alias', self.alias_manager.alias_table), |
|
1128 | ('Alias', self.alias_manager.alias_table), | |
1129 | ] |
|
1129 | ] | |
1130 | alias_ns = self.alias_manager.alias_table |
|
1130 | alias_ns = self.alias_manager.alias_table | |
1131 |
|
1131 | |||
1132 | # initialize results to 'null' |
|
1132 | # initialize results to 'null' | |
1133 | found = False; obj = None; ospace = None; ds = None; |
|
1133 | found = False; obj = None; ospace = None; ds = None; | |
1134 | ismagic = False; isalias = False; parent = None |
|
1134 | ismagic = False; isalias = False; parent = None | |
1135 |
|
1135 | |||
1136 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1136 | # We need to special-case 'print', which as of python2.6 registers as a | |
1137 | # function but should only be treated as one if print_function was |
|
1137 | # function but should only be treated as one if print_function was | |
1138 | # loaded with a future import. In this case, just bail. |
|
1138 | # loaded with a future import. In this case, just bail. | |
1139 | if (oname == 'print' and not (self.compile.compiler_flags & |
|
1139 | if (oname == 'print' and not (self.compile.compiler_flags & | |
1140 | __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1140 | __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1141 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1141 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1142 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1142 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1143 |
|
1143 | |||
1144 | # Look for the given name by splitting it in parts. If the head is |
|
1144 | # Look for the given name by splitting it in parts. If the head is | |
1145 | # found, then we look for all the remaining parts as members, and only |
|
1145 | # found, then we look for all the remaining parts as members, and only | |
1146 | # declare success if we can find them all. |
|
1146 | # declare success if we can find them all. | |
1147 | oname_parts = oname.split('.') |
|
1147 | oname_parts = oname.split('.') | |
1148 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1148 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1149 | for nsname,ns in namespaces: |
|
1149 | for nsname,ns in namespaces: | |
1150 | try: |
|
1150 | try: | |
1151 | obj = ns[oname_head] |
|
1151 | obj = ns[oname_head] | |
1152 | except KeyError: |
|
1152 | except KeyError: | |
1153 | continue |
|
1153 | continue | |
1154 | else: |
|
1154 | else: | |
1155 | #print 'oname_rest:', oname_rest # dbg |
|
1155 | #print 'oname_rest:', oname_rest # dbg | |
1156 | for part in oname_rest: |
|
1156 | for part in oname_rest: | |
1157 | try: |
|
1157 | try: | |
1158 | parent = obj |
|
1158 | parent = obj | |
1159 | obj = getattr(obj,part) |
|
1159 | obj = getattr(obj,part) | |
1160 | except: |
|
1160 | except: | |
1161 | # Blanket except b/c some badly implemented objects |
|
1161 | # Blanket except b/c some badly implemented objects | |
1162 | # allow __getattr__ to raise exceptions other than |
|
1162 | # allow __getattr__ to raise exceptions other than | |
1163 | # AttributeError, which then crashes IPython. |
|
1163 | # AttributeError, which then crashes IPython. | |
1164 | break |
|
1164 | break | |
1165 | else: |
|
1165 | else: | |
1166 | # If we finish the for loop (no break), we got all members |
|
1166 | # If we finish the for loop (no break), we got all members | |
1167 | found = True |
|
1167 | found = True | |
1168 | ospace = nsname |
|
1168 | ospace = nsname | |
1169 | if ns == alias_ns: |
|
1169 | if ns == alias_ns: | |
1170 | isalias = True |
|
1170 | isalias = True | |
1171 | break # namespace loop |
|
1171 | break # namespace loop | |
1172 |
|
1172 | |||
1173 | # Try to see if it's magic |
|
1173 | # Try to see if it's magic | |
1174 | if not found: |
|
1174 | if not found: | |
1175 | if oname.startswith(ESC_MAGIC): |
|
1175 | if oname.startswith(ESC_MAGIC): | |
1176 | oname = oname[1:] |
|
1176 | oname = oname[1:] | |
1177 | obj = getattr(self,'magic_'+oname,None) |
|
1177 | obj = getattr(self,'magic_'+oname,None) | |
1178 | if obj is not None: |
|
1178 | if obj is not None: | |
1179 | found = True |
|
1179 | found = True | |
1180 | ospace = 'IPython internal' |
|
1180 | ospace = 'IPython internal' | |
1181 | ismagic = True |
|
1181 | ismagic = True | |
1182 |
|
1182 | |||
1183 | # Last try: special-case some literals like '', [], {}, etc: |
|
1183 | # Last try: special-case some literals like '', [], {}, etc: | |
1184 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1184 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1185 | obj = eval(oname_head) |
|
1185 | obj = eval(oname_head) | |
1186 | found = True |
|
1186 | found = True | |
1187 | ospace = 'Interactive' |
|
1187 | ospace = 'Interactive' | |
1188 |
|
1188 | |||
1189 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1189 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1190 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1190 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1191 |
|
1191 | |||
1192 | def _ofind_property(self, oname, info): |
|
1192 | def _ofind_property(self, oname, info): | |
1193 | """Second part of object finding, to look for property details.""" |
|
1193 | """Second part of object finding, to look for property details.""" | |
1194 | if info.found: |
|
1194 | if info.found: | |
1195 | # Get the docstring of the class property if it exists. |
|
1195 | # Get the docstring of the class property if it exists. | |
1196 | path = oname.split('.') |
|
1196 | path = oname.split('.') | |
1197 | root = '.'.join(path[:-1]) |
|
1197 | root = '.'.join(path[:-1]) | |
1198 | if info.parent is not None: |
|
1198 | if info.parent is not None: | |
1199 | try: |
|
1199 | try: | |
1200 | target = getattr(info.parent, '__class__') |
|
1200 | target = getattr(info.parent, '__class__') | |
1201 | # The object belongs to a class instance. |
|
1201 | # The object belongs to a class instance. | |
1202 | try: |
|
1202 | try: | |
1203 | target = getattr(target, path[-1]) |
|
1203 | target = getattr(target, path[-1]) | |
1204 | # The class defines the object. |
|
1204 | # The class defines the object. | |
1205 | if isinstance(target, property): |
|
1205 | if isinstance(target, property): | |
1206 | oname = root + '.__class__.' + path[-1] |
|
1206 | oname = root + '.__class__.' + path[-1] | |
1207 | info = Struct(self._ofind(oname)) |
|
1207 | info = Struct(self._ofind(oname)) | |
1208 | except AttributeError: pass |
|
1208 | except AttributeError: pass | |
1209 | except AttributeError: pass |
|
1209 | except AttributeError: pass | |
1210 |
|
1210 | |||
1211 | # We return either the new info or the unmodified input if the object |
|
1211 | # We return either the new info or the unmodified input if the object | |
1212 | # hadn't been found |
|
1212 | # hadn't been found | |
1213 | return info |
|
1213 | return info | |
1214 |
|
1214 | |||
1215 | def _object_find(self, oname, namespaces=None): |
|
1215 | def _object_find(self, oname, namespaces=None): | |
1216 | """Find an object and return a struct with info about it.""" |
|
1216 | """Find an object and return a struct with info about it.""" | |
1217 | inf = Struct(self._ofind(oname, namespaces)) |
|
1217 | inf = Struct(self._ofind(oname, namespaces)) | |
1218 | return Struct(self._ofind_property(oname, inf)) |
|
1218 | return Struct(self._ofind_property(oname, inf)) | |
1219 |
|
1219 | |||
1220 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1220 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1221 | """Generic interface to the inspector system. |
|
1221 | """Generic interface to the inspector system. | |
1222 |
|
1222 | |||
1223 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1223 | This function is meant to be called by pdef, pdoc & friends.""" | |
1224 | info = self._object_find(oname) |
|
1224 | info = self._object_find(oname) | |
1225 | if info.found: |
|
1225 | if info.found: | |
1226 | pmethod = getattr(self.inspector, meth) |
|
1226 | pmethod = getattr(self.inspector, meth) | |
1227 | formatter = format_screen if info.ismagic else None |
|
1227 | formatter = format_screen if info.ismagic else None | |
1228 | if meth == 'pdoc': |
|
1228 | if meth == 'pdoc': | |
1229 | pmethod(info.obj, oname, formatter) |
|
1229 | pmethod(info.obj, oname, formatter) | |
1230 | elif meth == 'pinfo': |
|
1230 | elif meth == 'pinfo': | |
1231 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1231 | pmethod(info.obj, oname, formatter, info, **kw) | |
1232 | else: |
|
1232 | else: | |
1233 | pmethod(info.obj, oname) |
|
1233 | pmethod(info.obj, oname) | |
1234 | else: |
|
1234 | else: | |
1235 | print 'Object `%s` not found.' % oname |
|
1235 | print 'Object `%s` not found.' % oname | |
1236 | return 'not found' # so callers can take other action |
|
1236 | return 'not found' # so callers can take other action | |
1237 |
|
1237 | |||
1238 | def object_inspect(self, oname): |
|
1238 | def object_inspect(self, oname): | |
1239 | info = self._object_find(oname) |
|
1239 | info = self._object_find(oname) | |
1240 | if info.found: |
|
1240 | if info.found: | |
1241 | return self.inspector.info(info.obj, oname, info=info) |
|
1241 | return self.inspector.info(info.obj, oname, info=info) | |
1242 | else: |
|
1242 | else: | |
1243 | return oinspect.object_info(name=oname, found=False) |
|
1243 | return oinspect.object_info(name=oname, found=False) | |
1244 |
|
1244 | |||
1245 | #------------------------------------------------------------------------- |
|
1245 | #------------------------------------------------------------------------- | |
1246 | # Things related to history management |
|
1246 | # Things related to history management | |
1247 | #------------------------------------------------------------------------- |
|
1247 | #------------------------------------------------------------------------- | |
1248 |
|
1248 | |||
1249 | def init_history(self): |
|
1249 | def init_history(self): | |
1250 | """Sets up the command history, and starts regular autosaves.""" |
|
1250 | """Sets up the command history, and starts regular autosaves.""" | |
1251 | self.history_manager = HistoryManager(shell=self) |
|
1251 | self.history_manager = HistoryManager(shell=self) | |
1252 |
|
1252 | |||
1253 | def save_history(self): |
|
1253 | def save_history(self): | |
1254 | """Save input history to a file (via readline library).""" |
|
1254 | """Save input history to a file (via readline library).""" | |
1255 | self.history_manager.save_history() |
|
1255 | self.history_manager.save_history() | |
1256 |
|
1256 | |||
1257 | def reload_history(self): |
|
1257 | def reload_history(self): | |
1258 | """Reload the input history from disk file.""" |
|
1258 | """Reload the input history from disk file.""" | |
1259 | self.history_manager.reload_history() |
|
1259 | self.history_manager.reload_history() | |
1260 |
|
1260 | |||
1261 | def history_saving_wrapper(self, func): |
|
1261 | def history_saving_wrapper(self, func): | |
1262 | """ Wrap func for readline history saving |
|
1262 | """ Wrap func for readline history saving | |
1263 |
|
1263 | |||
1264 | Convert func into callable that saves & restores |
|
1264 | Convert func into callable that saves & restores | |
1265 | history around the call """ |
|
1265 | history around the call """ | |
1266 |
|
1266 | |||
1267 | if self.has_readline: |
|
1267 | if self.has_readline: | |
1268 | from IPython.utils import rlineimpl as readline |
|
1268 | from IPython.utils import rlineimpl as readline | |
1269 | else: |
|
1269 | else: | |
1270 | return func |
|
1270 | return func | |
1271 |
|
1271 | |||
1272 | def wrapper(): |
|
1272 | def wrapper(): | |
1273 | self.save_history() |
|
1273 | self.save_history() | |
1274 | try: |
|
1274 | try: | |
1275 | func() |
|
1275 | func() | |
1276 | finally: |
|
1276 | finally: | |
1277 | self.reload_history() |
|
1277 | self.reload_history() | |
1278 | return wrapper |
|
1278 | return wrapper | |
1279 |
|
1279 | |||
1280 | def get_history(self, index=None, raw=False, output=True): |
|
1280 | def get_history(self, index=None, raw=False, output=True): | |
1281 | return self.history_manager.get_history(index, raw, output) |
|
1281 | return self.history_manager.get_history(index, raw, output) | |
1282 |
|
1282 | |||
1283 |
|
1283 | |||
1284 | #------------------------------------------------------------------------- |
|
1284 | #------------------------------------------------------------------------- | |
1285 | # Things related to exception handling and tracebacks (not debugging) |
|
1285 | # Things related to exception handling and tracebacks (not debugging) | |
1286 | #------------------------------------------------------------------------- |
|
1286 | #------------------------------------------------------------------------- | |
1287 |
|
1287 | |||
1288 | def init_traceback_handlers(self, custom_exceptions): |
|
1288 | def init_traceback_handlers(self, custom_exceptions): | |
1289 | # Syntax error handler. |
|
1289 | # Syntax error handler. | |
1290 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1290 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1291 |
|
1291 | |||
1292 | # The interactive one is initialized with an offset, meaning we always |
|
1292 | # The interactive one is initialized with an offset, meaning we always | |
1293 | # want to remove the topmost item in the traceback, which is our own |
|
1293 | # want to remove the topmost item in the traceback, which is our own | |
1294 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1294 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1295 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1295 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1296 | color_scheme='NoColor', |
|
1296 | color_scheme='NoColor', | |
1297 | tb_offset = 1, |
|
1297 | tb_offset = 1, | |
1298 | check_cache=self.compile.check_cache) |
|
1298 | check_cache=self.compile.check_cache) | |
1299 |
|
1299 | |||
1300 | # The instance will store a pointer to the system-wide exception hook, |
|
1300 | # The instance will store a pointer to the system-wide exception hook, | |
1301 | # so that runtime code (such as magics) can access it. This is because |
|
1301 | # so that runtime code (such as magics) can access it. This is because | |
1302 | # during the read-eval loop, it may get temporarily overwritten. |
|
1302 | # during the read-eval loop, it may get temporarily overwritten. | |
1303 | self.sys_excepthook = sys.excepthook |
|
1303 | self.sys_excepthook = sys.excepthook | |
1304 |
|
1304 | |||
1305 | # and add any custom exception handlers the user may have specified |
|
1305 | # and add any custom exception handlers the user may have specified | |
1306 | self.set_custom_exc(*custom_exceptions) |
|
1306 | self.set_custom_exc(*custom_exceptions) | |
1307 |
|
1307 | |||
1308 | # Set the exception mode |
|
1308 | # Set the exception mode | |
1309 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1309 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1310 |
|
1310 | |||
1311 | def set_custom_exc(self, exc_tuple, handler): |
|
1311 | def set_custom_exc(self, exc_tuple, handler): | |
1312 | """set_custom_exc(exc_tuple,handler) |
|
1312 | """set_custom_exc(exc_tuple,handler) | |
1313 |
|
1313 | |||
1314 | Set a custom exception handler, which will be called if any of the |
|
1314 | Set a custom exception handler, which will be called if any of the | |
1315 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1315 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1316 | run_code() method. |
|
1316 | run_code() method. | |
1317 |
|
1317 | |||
1318 | Inputs: |
|
1318 | Inputs: | |
1319 |
|
1319 | |||
1320 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1320 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
1321 | handler for. It is very important that you use a tuple, and NOT A |
|
1321 | handler for. It is very important that you use a tuple, and NOT A | |
1322 | LIST here, because of the way Python's except statement works. If |
|
1322 | LIST here, because of the way Python's except statement works. If | |
1323 | you only want to trap a single exception, use a singleton tuple: |
|
1323 | you only want to trap a single exception, use a singleton tuple: | |
1324 |
|
1324 | |||
1325 | exc_tuple == (MyCustomException,) |
|
1325 | exc_tuple == (MyCustomException,) | |
1326 |
|
1326 | |||
1327 | - handler: this must be defined as a function with the following |
|
1327 | - handler: this must be defined as a function with the following | |
1328 | basic interface:: |
|
1328 | basic interface:: | |
1329 |
|
1329 | |||
1330 | def my_handler(self, etype, value, tb, tb_offset=None) |
|
1330 | def my_handler(self, etype, value, tb, tb_offset=None) | |
1331 | ... |
|
1331 | ... | |
1332 | # The return value must be |
|
1332 | # The return value must be | |
1333 | return structured_traceback |
|
1333 | return structured_traceback | |
1334 |
|
1334 | |||
1335 | This will be made into an instance method (via types.MethodType) |
|
1335 | This will be made into an instance method (via types.MethodType) | |
1336 | of IPython itself, and it will be called if any of the exceptions |
|
1336 | of IPython itself, and it will be called if any of the exceptions | |
1337 | listed in the exc_tuple are caught. If the handler is None, an |
|
1337 | listed in the exc_tuple are caught. If the handler is None, an | |
1338 | internal basic one is used, which just prints basic info. |
|
1338 | internal basic one is used, which just prints basic info. | |
1339 |
|
1339 | |||
1340 | WARNING: by putting in your own exception handler into IPython's main |
|
1340 | WARNING: by putting in your own exception handler into IPython's main | |
1341 | execution loop, you run a very good chance of nasty crashes. This |
|
1341 | execution loop, you run a very good chance of nasty crashes. This | |
1342 | facility should only be used if you really know what you are doing.""" |
|
1342 | facility should only be used if you really know what you are doing.""" | |
1343 |
|
1343 | |||
1344 | assert type(exc_tuple)==type(()) , \ |
|
1344 | assert type(exc_tuple)==type(()) , \ | |
1345 | "The custom exceptions must be given AS A TUPLE." |
|
1345 | "The custom exceptions must be given AS A TUPLE." | |
1346 |
|
1346 | |||
1347 | def dummy_handler(self,etype,value,tb): |
|
1347 | def dummy_handler(self,etype,value,tb): | |
1348 | print '*** Simple custom exception handler ***' |
|
1348 | print '*** Simple custom exception handler ***' | |
1349 | print 'Exception type :',etype |
|
1349 | print 'Exception type :',etype | |
1350 | print 'Exception value:',value |
|
1350 | print 'Exception value:',value | |
1351 | print 'Traceback :',tb |
|
1351 | print 'Traceback :',tb | |
1352 | print 'Source code :','\n'.join(self.buffer) |
|
1352 | print 'Source code :','\n'.join(self.buffer) | |
1353 |
|
1353 | |||
1354 | if handler is None: handler = dummy_handler |
|
1354 | if handler is None: handler = dummy_handler | |
1355 |
|
1355 | |||
1356 | self.CustomTB = types.MethodType(handler,self) |
|
1356 | self.CustomTB = types.MethodType(handler,self) | |
1357 | self.custom_exceptions = exc_tuple |
|
1357 | self.custom_exceptions = exc_tuple | |
1358 |
|
1358 | |||
1359 | def excepthook(self, etype, value, tb): |
|
1359 | def excepthook(self, etype, value, tb): | |
1360 | """One more defense for GUI apps that call sys.excepthook. |
|
1360 | """One more defense for GUI apps that call sys.excepthook. | |
1361 |
|
1361 | |||
1362 | GUI frameworks like wxPython trap exceptions and call |
|
1362 | GUI frameworks like wxPython trap exceptions and call | |
1363 | sys.excepthook themselves. I guess this is a feature that |
|
1363 | sys.excepthook themselves. I guess this is a feature that | |
1364 | enables them to keep running after exceptions that would |
|
1364 | enables them to keep running after exceptions that would | |
1365 | otherwise kill their mainloop. This is a bother for IPython |
|
1365 | otherwise kill their mainloop. This is a bother for IPython | |
1366 | which excepts to catch all of the program exceptions with a try: |
|
1366 | which excepts to catch all of the program exceptions with a try: | |
1367 | except: statement. |
|
1367 | except: statement. | |
1368 |
|
1368 | |||
1369 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1369 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1370 | any app directly invokes sys.excepthook, it will look to the user like |
|
1370 | any app directly invokes sys.excepthook, it will look to the user like | |
1371 | IPython crashed. In order to work around this, we can disable the |
|
1371 | IPython crashed. In order to work around this, we can disable the | |
1372 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1372 | CrashHandler and replace it with this excepthook instead, which prints a | |
1373 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1373 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1374 | call sys.excepthook will generate a regular-looking exception from |
|
1374 | call sys.excepthook will generate a regular-looking exception from | |
1375 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1375 | IPython, and the CrashHandler will only be triggered by real IPython | |
1376 | crashes. |
|
1376 | crashes. | |
1377 |
|
1377 | |||
1378 | This hook should be used sparingly, only in places which are not likely |
|
1378 | This hook should be used sparingly, only in places which are not likely | |
1379 | to be true IPython errors. |
|
1379 | to be true IPython errors. | |
1380 | """ |
|
1380 | """ | |
1381 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1381 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1382 |
|
1382 | |||
1383 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1383 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
1384 | exception_only=False): |
|
1384 | exception_only=False): | |
1385 | """Display the exception that just occurred. |
|
1385 | """Display the exception that just occurred. | |
1386 |
|
1386 | |||
1387 | If nothing is known about the exception, this is the method which |
|
1387 | If nothing is known about the exception, this is the method which | |
1388 | should be used throughout the code for presenting user tracebacks, |
|
1388 | should be used throughout the code for presenting user tracebacks, | |
1389 | rather than directly invoking the InteractiveTB object. |
|
1389 | rather than directly invoking the InteractiveTB object. | |
1390 |
|
1390 | |||
1391 | A specific showsyntaxerror() also exists, but this method can take |
|
1391 | A specific showsyntaxerror() also exists, but this method can take | |
1392 | care of calling it if needed, so unless you are explicitly catching a |
|
1392 | care of calling it if needed, so unless you are explicitly catching a | |
1393 | SyntaxError exception, don't try to analyze the stack manually and |
|
1393 | SyntaxError exception, don't try to analyze the stack manually and | |
1394 | simply call this method.""" |
|
1394 | simply call this method.""" | |
1395 |
|
1395 | |||
1396 | try: |
|
1396 | try: | |
1397 | if exc_tuple is None: |
|
1397 | if exc_tuple is None: | |
1398 | etype, value, tb = sys.exc_info() |
|
1398 | etype, value, tb = sys.exc_info() | |
1399 | else: |
|
1399 | else: | |
1400 | etype, value, tb = exc_tuple |
|
1400 | etype, value, tb = exc_tuple | |
1401 |
|
1401 | |||
1402 | if etype is None: |
|
1402 | if etype is None: | |
1403 | if hasattr(sys, 'last_type'): |
|
1403 | if hasattr(sys, 'last_type'): | |
1404 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1404 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1405 | sys.last_traceback |
|
1405 | sys.last_traceback | |
1406 | else: |
|
1406 | else: | |
1407 | self.write_err('No traceback available to show.\n') |
|
1407 | self.write_err('No traceback available to show.\n') | |
1408 | return |
|
1408 | return | |
1409 |
|
1409 | |||
1410 | if etype is SyntaxError: |
|
1410 | if etype is SyntaxError: | |
1411 | # Though this won't be called by syntax errors in the input |
|
1411 | # Though this won't be called by syntax errors in the input | |
1412 | # line, there may be SyntaxError cases whith imported code. |
|
1412 | # line, there may be SyntaxError cases whith imported code. | |
1413 | self.showsyntaxerror(filename) |
|
1413 | self.showsyntaxerror(filename) | |
1414 | elif etype is UsageError: |
|
1414 | elif etype is UsageError: | |
1415 | print "UsageError:", value |
|
1415 | print "UsageError:", value | |
1416 | else: |
|
1416 | else: | |
1417 | # WARNING: these variables are somewhat deprecated and not |
|
1417 | # WARNING: these variables are somewhat deprecated and not | |
1418 | # necessarily safe to use in a threaded environment, but tools |
|
1418 | # necessarily safe to use in a threaded environment, but tools | |
1419 | # like pdb depend on their existence, so let's set them. If we |
|
1419 | # like pdb depend on their existence, so let's set them. If we | |
1420 | # find problems in the field, we'll need to revisit their use. |
|
1420 | # find problems in the field, we'll need to revisit their use. | |
1421 | sys.last_type = etype |
|
1421 | sys.last_type = etype | |
1422 | sys.last_value = value |
|
1422 | sys.last_value = value | |
1423 | sys.last_traceback = tb |
|
1423 | sys.last_traceback = tb | |
1424 |
|
1424 | |||
1425 | if etype in self.custom_exceptions: |
|
1425 | if etype in self.custom_exceptions: | |
1426 | # FIXME: Old custom traceback objects may just return a |
|
1426 | # FIXME: Old custom traceback objects may just return a | |
1427 | # string, in that case we just put it into a list |
|
1427 | # string, in that case we just put it into a list | |
1428 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1428 | stb = self.CustomTB(etype, value, tb, tb_offset) | |
1429 | if isinstance(ctb, basestring): |
|
1429 | if isinstance(ctb, basestring): | |
1430 | stb = [stb] |
|
1430 | stb = [stb] | |
1431 | else: |
|
1431 | else: | |
1432 | if exception_only: |
|
1432 | if exception_only: | |
1433 | stb = ['An exception has occurred, use %tb to see ' |
|
1433 | stb = ['An exception has occurred, use %tb to see ' | |
1434 | 'the full traceback.\n'] |
|
1434 | 'the full traceback.\n'] | |
1435 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1435 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1436 | value)) |
|
1436 | value)) | |
1437 | else: |
|
1437 | else: | |
1438 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1438 | stb = self.InteractiveTB.structured_traceback(etype, | |
1439 | value, tb, tb_offset=tb_offset) |
|
1439 | value, tb, tb_offset=tb_offset) | |
1440 | # FIXME: the pdb calling should be done by us, not by |
|
1440 | # FIXME: the pdb calling should be done by us, not by | |
1441 | # the code computing the traceback. |
|
1441 | # the code computing the traceback. | |
1442 | if self.InteractiveTB.call_pdb: |
|
1442 | if self.InteractiveTB.call_pdb: | |
1443 | # pdb mucks up readline, fix it back |
|
1443 | # pdb mucks up readline, fix it back | |
1444 | self.set_readline_completer() |
|
1444 | self.set_readline_completer() | |
1445 |
|
1445 | |||
1446 | # Actually show the traceback |
|
1446 | # Actually show the traceback | |
1447 | self._showtraceback(etype, value, stb) |
|
1447 | self._showtraceback(etype, value, stb) | |
1448 |
|
1448 | |||
1449 | except KeyboardInterrupt: |
|
1449 | except KeyboardInterrupt: | |
1450 | self.write_err("\nKeyboardInterrupt\n") |
|
1450 | self.write_err("\nKeyboardInterrupt\n") | |
1451 |
|
1451 | |||
1452 | def _showtraceback(self, etype, evalue, stb): |
|
1452 | def _showtraceback(self, etype, evalue, stb): | |
1453 | """Actually show a traceback. |
|
1453 | """Actually show a traceback. | |
1454 |
|
1454 | |||
1455 | Subclasses may override this method to put the traceback on a different |
|
1455 | Subclasses may override this method to put the traceback on a different | |
1456 | place, like a side channel. |
|
1456 | place, like a side channel. | |
1457 | """ |
|
1457 | """ | |
1458 | print >> io.Term.cout, self.InteractiveTB.stb2text(stb) |
|
1458 | print >> io.Term.cout, self.InteractiveTB.stb2text(stb) | |
1459 |
|
1459 | |||
1460 | def showsyntaxerror(self, filename=None): |
|
1460 | def showsyntaxerror(self, filename=None): | |
1461 | """Display the syntax error that just occurred. |
|
1461 | """Display the syntax error that just occurred. | |
1462 |
|
1462 | |||
1463 | This doesn't display a stack trace because there isn't one. |
|
1463 | This doesn't display a stack trace because there isn't one. | |
1464 |
|
1464 | |||
1465 | If a filename is given, it is stuffed in the exception instead |
|
1465 | If a filename is given, it is stuffed in the exception instead | |
1466 | of what was there before (because Python's parser always uses |
|
1466 | of what was there before (because Python's parser always uses | |
1467 | "<string>" when reading from a string). |
|
1467 | "<string>" when reading from a string). | |
1468 | """ |
|
1468 | """ | |
1469 | etype, value, last_traceback = sys.exc_info() |
|
1469 | etype, value, last_traceback = sys.exc_info() | |
1470 |
|
1470 | |||
1471 | # See note about these variables in showtraceback() above |
|
1471 | # See note about these variables in showtraceback() above | |
1472 | sys.last_type = etype |
|
1472 | sys.last_type = etype | |
1473 | sys.last_value = value |
|
1473 | sys.last_value = value | |
1474 | sys.last_traceback = last_traceback |
|
1474 | sys.last_traceback = last_traceback | |
1475 |
|
1475 | |||
1476 | if filename and etype is SyntaxError: |
|
1476 | if filename and etype is SyntaxError: | |
1477 | # Work hard to stuff the correct filename in the exception |
|
1477 | # Work hard to stuff the correct filename in the exception | |
1478 | try: |
|
1478 | try: | |
1479 | msg, (dummy_filename, lineno, offset, line) = value |
|
1479 | msg, (dummy_filename, lineno, offset, line) = value | |
1480 | except: |
|
1480 | except: | |
1481 | # Not the format we expect; leave it alone |
|
1481 | # Not the format we expect; leave it alone | |
1482 | pass |
|
1482 | pass | |
1483 | else: |
|
1483 | else: | |
1484 | # Stuff in the right filename |
|
1484 | # Stuff in the right filename | |
1485 | try: |
|
1485 | try: | |
1486 | # Assume SyntaxError is a class exception |
|
1486 | # Assume SyntaxError is a class exception | |
1487 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1487 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1488 | except: |
|
1488 | except: | |
1489 | # If that failed, assume SyntaxError is a string |
|
1489 | # If that failed, assume SyntaxError is a string | |
1490 | value = msg, (filename, lineno, offset, line) |
|
1490 | value = msg, (filename, lineno, offset, line) | |
1491 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1491 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1492 | self._showtraceback(etype, value, stb) |
|
1492 | self._showtraceback(etype, value, stb) | |
1493 |
|
1493 | |||
1494 | #------------------------------------------------------------------------- |
|
1494 | #------------------------------------------------------------------------- | |
1495 | # Things related to readline |
|
1495 | # Things related to readline | |
1496 | #------------------------------------------------------------------------- |
|
1496 | #------------------------------------------------------------------------- | |
1497 |
|
1497 | |||
1498 | def init_readline(self): |
|
1498 | def init_readline(self): | |
1499 | """Command history completion/saving/reloading.""" |
|
1499 | """Command history completion/saving/reloading.""" | |
1500 |
|
1500 | |||
1501 | if self.readline_use: |
|
1501 | if self.readline_use: | |
1502 | import IPython.utils.rlineimpl as readline |
|
1502 | import IPython.utils.rlineimpl as readline | |
1503 |
|
1503 | |||
1504 | self.rl_next_input = None |
|
1504 | self.rl_next_input = None | |
1505 | self.rl_do_indent = False |
|
1505 | self.rl_do_indent = False | |
1506 |
|
1506 | |||
1507 | if not self.readline_use or not readline.have_readline: |
|
1507 | if not self.readline_use or not readline.have_readline: | |
1508 | self.has_readline = False |
|
1508 | self.has_readline = False | |
1509 | self.readline = None |
|
1509 | self.readline = None | |
1510 | # Set a number of methods that depend on readline to be no-op |
|
1510 | # Set a number of methods that depend on readline to be no-op | |
1511 | self.set_readline_completer = no_op |
|
1511 | self.set_readline_completer = no_op | |
1512 | self.set_custom_completer = no_op |
|
1512 | self.set_custom_completer = no_op | |
1513 | self.set_completer_frame = no_op |
|
1513 | self.set_completer_frame = no_op | |
1514 | warn('Readline services not available or not loaded.') |
|
1514 | warn('Readline services not available or not loaded.') | |
1515 | else: |
|
1515 | else: | |
1516 | self.has_readline = True |
|
1516 | self.has_readline = True | |
1517 | self.readline = readline |
|
1517 | self.readline = readline | |
1518 | sys.modules['readline'] = readline |
|
1518 | sys.modules['readline'] = readline | |
1519 |
|
1519 | |||
1520 | # Platform-specific configuration |
|
1520 | # Platform-specific configuration | |
1521 | if os.name == 'nt': |
|
1521 | if os.name == 'nt': | |
1522 | # FIXME - check with Frederick to see if we can harmonize |
|
1522 | # FIXME - check with Frederick to see if we can harmonize | |
1523 | # naming conventions with pyreadline to avoid this |
|
1523 | # naming conventions with pyreadline to avoid this | |
1524 | # platform-dependent check |
|
1524 | # platform-dependent check | |
1525 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1525 | self.readline_startup_hook = readline.set_pre_input_hook | |
1526 | else: |
|
1526 | else: | |
1527 | self.readline_startup_hook = readline.set_startup_hook |
|
1527 | self.readline_startup_hook = readline.set_startup_hook | |
1528 |
|
1528 | |||
1529 | # Load user's initrc file (readline config) |
|
1529 | # Load user's initrc file (readline config) | |
1530 | # Or if libedit is used, load editrc. |
|
1530 | # Or if libedit is used, load editrc. | |
1531 | inputrc_name = os.environ.get('INPUTRC') |
|
1531 | inputrc_name = os.environ.get('INPUTRC') | |
1532 | if inputrc_name is None: |
|
1532 | if inputrc_name is None: | |
1533 | home_dir = get_home_dir() |
|
1533 | home_dir = get_home_dir() | |
1534 | if home_dir is not None: |
|
1534 | if home_dir is not None: | |
1535 | inputrc_name = '.inputrc' |
|
1535 | inputrc_name = '.inputrc' | |
1536 | if readline.uses_libedit: |
|
1536 | if readline.uses_libedit: | |
1537 | inputrc_name = '.editrc' |
|
1537 | inputrc_name = '.editrc' | |
1538 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1538 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1539 | if os.path.isfile(inputrc_name): |
|
1539 | if os.path.isfile(inputrc_name): | |
1540 | try: |
|
1540 | try: | |
1541 | readline.read_init_file(inputrc_name) |
|
1541 | readline.read_init_file(inputrc_name) | |
1542 | except: |
|
1542 | except: | |
1543 | warn('Problems reading readline initialization file <%s>' |
|
1543 | warn('Problems reading readline initialization file <%s>' | |
1544 | % inputrc_name) |
|
1544 | % inputrc_name) | |
1545 |
|
1545 | |||
1546 | # Configure readline according to user's prefs |
|
1546 | # Configure readline according to user's prefs | |
1547 | # This is only done if GNU readline is being used. If libedit |
|
1547 | # This is only done if GNU readline is being used. If libedit | |
1548 | # is being used (as on Leopard) the readline config is |
|
1548 | # is being used (as on Leopard) the readline config is | |
1549 | # not run as the syntax for libedit is different. |
|
1549 | # not run as the syntax for libedit is different. | |
1550 | if not readline.uses_libedit: |
|
1550 | if not readline.uses_libedit: | |
1551 | for rlcommand in self.readline_parse_and_bind: |
|
1551 | for rlcommand in self.readline_parse_and_bind: | |
1552 | #print "loading rl:",rlcommand # dbg |
|
1552 | #print "loading rl:",rlcommand # dbg | |
1553 | readline.parse_and_bind(rlcommand) |
|
1553 | readline.parse_and_bind(rlcommand) | |
1554 |
|
1554 | |||
1555 | # Remove some chars from the delimiters list. If we encounter |
|
1555 | # Remove some chars from the delimiters list. If we encounter | |
1556 | # unicode chars, discard them. |
|
1556 | # unicode chars, discard them. | |
1557 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1557 | delims = readline.get_completer_delims().encode("ascii", "ignore") | |
1558 | delims = delims.translate(None, self.readline_remove_delims) |
|
1558 | delims = delims.translate(None, self.readline_remove_delims) | |
1559 | delims = delims.replace(ESC_MAGIC, '') |
|
1559 | delims = delims.replace(ESC_MAGIC, '') | |
1560 | readline.set_completer_delims(delims) |
|
1560 | readline.set_completer_delims(delims) | |
1561 | # otherwise we end up with a monster history after a while: |
|
1561 | # otherwise we end up with a monster history after a while: | |
1562 | readline.set_history_length(self.history_length) |
|
1562 | readline.set_history_length(self.history_length) | |
1563 | try: |
|
1563 | try: | |
1564 | #print '*** Reading readline history' # dbg |
|
1564 | #print '*** Reading readline history' # dbg | |
1565 | self.reload_history() |
|
1565 | self.reload_history() | |
1566 | except IOError: |
|
1566 | except IOError: | |
1567 | pass # It doesn't exist yet. |
|
1567 | pass # It doesn't exist yet. | |
1568 |
|
1568 | |||
1569 | # Configure auto-indent for all platforms |
|
1569 | # Configure auto-indent for all platforms | |
1570 | self.set_autoindent(self.autoindent) |
|
1570 | self.set_autoindent(self.autoindent) | |
1571 |
|
1571 | |||
1572 | def set_next_input(self, s): |
|
1572 | def set_next_input(self, s): | |
1573 | """ Sets the 'default' input string for the next command line. |
|
1573 | """ Sets the 'default' input string for the next command line. | |
1574 |
|
1574 | |||
1575 | Requires readline. |
|
1575 | Requires readline. | |
1576 |
|
1576 | |||
1577 | Example: |
|
1577 | Example: | |
1578 |
|
1578 | |||
1579 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1579 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1580 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1580 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1581 | """ |
|
1581 | """ | |
1582 |
|
1582 | |||
1583 | self.rl_next_input = s |
|
1583 | self.rl_next_input = s | |
1584 |
|
1584 | |||
1585 | # Maybe move this to the terminal subclass? |
|
1585 | # Maybe move this to the terminal subclass? | |
1586 | def pre_readline(self): |
|
1586 | def pre_readline(self): | |
1587 | """readline hook to be used at the start of each line. |
|
1587 | """readline hook to be used at the start of each line. | |
1588 |
|
1588 | |||
1589 | Currently it handles auto-indent only.""" |
|
1589 | Currently it handles auto-indent only.""" | |
1590 |
|
1590 | |||
1591 | if self.rl_do_indent: |
|
1591 | if self.rl_do_indent: | |
1592 | self.readline.insert_text(self._indent_current_str()) |
|
1592 | self.readline.insert_text(self._indent_current_str()) | |
1593 | if self.rl_next_input is not None: |
|
1593 | if self.rl_next_input is not None: | |
1594 | self.readline.insert_text(self.rl_next_input) |
|
1594 | self.readline.insert_text(self.rl_next_input) | |
1595 | self.rl_next_input = None |
|
1595 | self.rl_next_input = None | |
1596 |
|
1596 | |||
1597 | def _indent_current_str(self): |
|
1597 | def _indent_current_str(self): | |
1598 | """return the current level of indentation as a string""" |
|
1598 | """return the current level of indentation as a string""" | |
1599 | return self.input_splitter.indent_spaces * ' ' |
|
1599 | return self.input_splitter.indent_spaces * ' ' | |
1600 |
|
1600 | |||
1601 | #------------------------------------------------------------------------- |
|
1601 | #------------------------------------------------------------------------- | |
1602 | # Things related to text completion |
|
1602 | # Things related to text completion | |
1603 | #------------------------------------------------------------------------- |
|
1603 | #------------------------------------------------------------------------- | |
1604 |
|
1604 | |||
1605 | def init_completer(self): |
|
1605 | def init_completer(self): | |
1606 | """Initialize the completion machinery. |
|
1606 | """Initialize the completion machinery. | |
1607 |
|
1607 | |||
1608 | This creates completion machinery that can be used by client code, |
|
1608 | This creates completion machinery that can be used by client code, | |
1609 | either interactively in-process (typically triggered by the readline |
|
1609 | either interactively in-process (typically triggered by the readline | |
1610 | library), programatically (such as in test suites) or out-of-prcess |
|
1610 | library), programatically (such as in test suites) or out-of-prcess | |
1611 | (typically over the network by remote frontends). |
|
1611 | (typically over the network by remote frontends). | |
1612 | """ |
|
1612 | """ | |
1613 | from IPython.core.completer import IPCompleter |
|
1613 | from IPython.core.completer import IPCompleter | |
1614 | from IPython.core.completerlib import (module_completer, |
|
1614 | from IPython.core.completerlib import (module_completer, | |
1615 | magic_run_completer, cd_completer) |
|
1615 | magic_run_completer, cd_completer) | |
1616 |
|
1616 | |||
1617 | self.Completer = IPCompleter(self, |
|
1617 | self.Completer = IPCompleter(self, | |
1618 | self.user_ns, |
|
1618 | self.user_ns, | |
1619 | self.user_global_ns, |
|
1619 | self.user_global_ns, | |
1620 | self.readline_omit__names, |
|
1620 | self.readline_omit__names, | |
1621 | self.alias_manager.alias_table, |
|
1621 | self.alias_manager.alias_table, | |
1622 | self.has_readline) |
|
1622 | self.has_readline) | |
1623 |
|
1623 | |||
1624 | # Add custom completers to the basic ones built into IPCompleter |
|
1624 | # Add custom completers to the basic ones built into IPCompleter | |
1625 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1625 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1626 | self.strdispatchers['complete_command'] = sdisp |
|
1626 | self.strdispatchers['complete_command'] = sdisp | |
1627 | self.Completer.custom_completers = sdisp |
|
1627 | self.Completer.custom_completers = sdisp | |
1628 |
|
1628 | |||
1629 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1629 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1630 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1630 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1631 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1631 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1632 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1632 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1633 |
|
1633 | |||
1634 | # Only configure readline if we truly are using readline. IPython can |
|
1634 | # Only configure readline if we truly are using readline. IPython can | |
1635 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1635 | # do tab-completion over the network, in GUIs, etc, where readline | |
1636 | # itself may be absent |
|
1636 | # itself may be absent | |
1637 | if self.has_readline: |
|
1637 | if self.has_readline: | |
1638 | self.set_readline_completer() |
|
1638 | self.set_readline_completer() | |
1639 |
|
1639 | |||
1640 | def complete(self, text, line=None, cursor_pos=None): |
|
1640 | def complete(self, text, line=None, cursor_pos=None): | |
1641 | """Return the completed text and a list of completions. |
|
1641 | """Return the completed text and a list of completions. | |
1642 |
|
1642 | |||
1643 | Parameters |
|
1643 | Parameters | |
1644 | ---------- |
|
1644 | ---------- | |
1645 |
|
1645 | |||
1646 | text : string |
|
1646 | text : string | |
1647 | A string of text to be completed on. It can be given as empty and |
|
1647 | A string of text to be completed on. It can be given as empty and | |
1648 | instead a line/position pair are given. In this case, the |
|
1648 | instead a line/position pair are given. In this case, the | |
1649 | completer itself will split the line like readline does. |
|
1649 | completer itself will split the line like readline does. | |
1650 |
|
1650 | |||
1651 | line : string, optional |
|
1651 | line : string, optional | |
1652 | The complete line that text is part of. |
|
1652 | The complete line that text is part of. | |
1653 |
|
1653 | |||
1654 | cursor_pos : int, optional |
|
1654 | cursor_pos : int, optional | |
1655 | The position of the cursor on the input line. |
|
1655 | The position of the cursor on the input line. | |
1656 |
|
1656 | |||
1657 | Returns |
|
1657 | Returns | |
1658 | ------- |
|
1658 | ------- | |
1659 | text : string |
|
1659 | text : string | |
1660 | The actual text that was completed. |
|
1660 | The actual text that was completed. | |
1661 |
|
1661 | |||
1662 | matches : list |
|
1662 | matches : list | |
1663 | A sorted list with all possible completions. |
|
1663 | A sorted list with all possible completions. | |
1664 |
|
1664 | |||
1665 | The optional arguments allow the completion to take more context into |
|
1665 | The optional arguments allow the completion to take more context into | |
1666 | account, and are part of the low-level completion API. |
|
1666 | account, and are part of the low-level completion API. | |
1667 |
|
1667 | |||
1668 | This is a wrapper around the completion mechanism, similar to what |
|
1668 | This is a wrapper around the completion mechanism, similar to what | |
1669 | readline does at the command line when the TAB key is hit. By |
|
1669 | readline does at the command line when the TAB key is hit. By | |
1670 | exposing it as a method, it can be used by other non-readline |
|
1670 | exposing it as a method, it can be used by other non-readline | |
1671 | environments (such as GUIs) for text completion. |
|
1671 | environments (such as GUIs) for text completion. | |
1672 |
|
1672 | |||
1673 | Simple usage example: |
|
1673 | Simple usage example: | |
1674 |
|
1674 | |||
1675 | In [1]: x = 'hello' |
|
1675 | In [1]: x = 'hello' | |
1676 |
|
1676 | |||
1677 | In [2]: _ip.complete('x.l') |
|
1677 | In [2]: _ip.complete('x.l') | |
1678 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1678 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
1679 | """ |
|
1679 | """ | |
1680 |
|
1680 | |||
1681 | # Inject names into __builtin__ so we can complete on the added names. |
|
1681 | # Inject names into __builtin__ so we can complete on the added names. | |
1682 | with self.builtin_trap: |
|
1682 | with self.builtin_trap: | |
1683 | return self.Completer.complete(text, line, cursor_pos) |
|
1683 | return self.Completer.complete(text, line, cursor_pos) | |
1684 |
|
1684 | |||
1685 | def set_custom_completer(self, completer, pos=0): |
|
1685 | def set_custom_completer(self, completer, pos=0): | |
1686 | """Adds a new custom completer function. |
|
1686 | """Adds a new custom completer function. | |
1687 |
|
1687 | |||
1688 | The position argument (defaults to 0) is the index in the completers |
|
1688 | The position argument (defaults to 0) is the index in the completers | |
1689 | list where you want the completer to be inserted.""" |
|
1689 | list where you want the completer to be inserted.""" | |
1690 |
|
1690 | |||
1691 | newcomp = types.MethodType(completer,self.Completer) |
|
1691 | newcomp = types.MethodType(completer,self.Completer) | |
1692 | self.Completer.matchers.insert(pos,newcomp) |
|
1692 | self.Completer.matchers.insert(pos,newcomp) | |
1693 |
|
1693 | |||
1694 | def set_readline_completer(self): |
|
1694 | def set_readline_completer(self): | |
1695 | """Reset readline's completer to be our own.""" |
|
1695 | """Reset readline's completer to be our own.""" | |
1696 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1696 | self.readline.set_completer(self.Completer.rlcomplete) | |
1697 |
|
1697 | |||
1698 | def set_completer_frame(self, frame=None): |
|
1698 | def set_completer_frame(self, frame=None): | |
1699 | """Set the frame of the completer.""" |
|
1699 | """Set the frame of the completer.""" | |
1700 | if frame: |
|
1700 | if frame: | |
1701 | self.Completer.namespace = frame.f_locals |
|
1701 | self.Completer.namespace = frame.f_locals | |
1702 | self.Completer.global_namespace = frame.f_globals |
|
1702 | self.Completer.global_namespace = frame.f_globals | |
1703 | else: |
|
1703 | else: | |
1704 | self.Completer.namespace = self.user_ns |
|
1704 | self.Completer.namespace = self.user_ns | |
1705 | self.Completer.global_namespace = self.user_global_ns |
|
1705 | self.Completer.global_namespace = self.user_global_ns | |
1706 |
|
1706 | |||
1707 | #------------------------------------------------------------------------- |
|
1707 | #------------------------------------------------------------------------- | |
1708 | # Things related to magics |
|
1708 | # Things related to magics | |
1709 | #------------------------------------------------------------------------- |
|
1709 | #------------------------------------------------------------------------- | |
1710 |
|
1710 | |||
1711 | def init_magics(self): |
|
1711 | def init_magics(self): | |
1712 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1712 | # FIXME: Move the color initialization to the DisplayHook, which | |
1713 | # should be split into a prompt manager and displayhook. We probably |
|
1713 | # should be split into a prompt manager and displayhook. We probably | |
1714 | # even need a centralize colors management object. |
|
1714 | # even need a centralize colors management object. | |
1715 | self.magic_colors(self.colors) |
|
1715 | self.magic_colors(self.colors) | |
1716 | # History was moved to a separate module |
|
1716 | # History was moved to a separate module | |
1717 | from . import history |
|
1717 | from . import history | |
1718 | history.init_ipython(self) |
|
1718 | history.init_ipython(self) | |
1719 |
|
1719 | |||
1720 | def magic(self,arg_s): |
|
1720 | def magic(self,arg_s): | |
1721 | """Call a magic function by name. |
|
1721 | """Call a magic function by name. | |
1722 |
|
1722 | |||
1723 | Input: a string containing the name of the magic function to call and |
|
1723 | Input: a string containing the name of the magic function to call and | |
1724 | any additional arguments to be passed to the magic. |
|
1724 | any additional arguments to be passed to the magic. | |
1725 |
|
1725 | |||
1726 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1726 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1727 | prompt: |
|
1727 | prompt: | |
1728 |
|
1728 | |||
1729 | In[1]: %name -opt foo bar |
|
1729 | In[1]: %name -opt foo bar | |
1730 |
|
1730 | |||
1731 | To call a magic without arguments, simply use magic('name'). |
|
1731 | To call a magic without arguments, simply use magic('name'). | |
1732 |
|
1732 | |||
1733 | This provides a proper Python function to call IPython's magics in any |
|
1733 | This provides a proper Python function to call IPython's magics in any | |
1734 | valid Python code you can type at the interpreter, including loops and |
|
1734 | valid Python code you can type at the interpreter, including loops and | |
1735 | compound statements. |
|
1735 | compound statements. | |
1736 | """ |
|
1736 | """ | |
1737 | args = arg_s.split(' ',1) |
|
1737 | args = arg_s.split(' ',1) | |
1738 | magic_name = args[0] |
|
1738 | magic_name = args[0] | |
1739 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1739 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1740 |
|
1740 | |||
1741 | try: |
|
1741 | try: | |
1742 | magic_args = args[1] |
|
1742 | magic_args = args[1] | |
1743 | except IndexError: |
|
1743 | except IndexError: | |
1744 | magic_args = '' |
|
1744 | magic_args = '' | |
1745 | fn = getattr(self,'magic_'+magic_name,None) |
|
1745 | fn = getattr(self,'magic_'+magic_name,None) | |
1746 | if fn is None: |
|
1746 | if fn is None: | |
1747 | error("Magic function `%s` not found." % magic_name) |
|
1747 | error("Magic function `%s` not found." % magic_name) | |
1748 | else: |
|
1748 | else: | |
1749 | magic_args = self.var_expand(magic_args,1) |
|
1749 | magic_args = self.var_expand(magic_args,1) | |
1750 | with nested(self.builtin_trap,): |
|
1750 | with nested(self.builtin_trap,): | |
1751 | result = fn(magic_args) |
|
1751 | result = fn(magic_args) | |
1752 | return result |
|
1752 | return result | |
1753 |
|
1753 | |||
1754 | def define_magic(self, magicname, func): |
|
1754 | def define_magic(self, magicname, func): | |
1755 | """Expose own function as magic function for ipython |
|
1755 | """Expose own function as magic function for ipython | |
1756 |
|
1756 | |||
1757 | def foo_impl(self,parameter_s=''): |
|
1757 | def foo_impl(self,parameter_s=''): | |
1758 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
1758 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
1759 | print 'Magic function. Passed parameter is between < >:' |
|
1759 | print 'Magic function. Passed parameter is between < >:' | |
1760 | print '<%s>' % parameter_s |
|
1760 | print '<%s>' % parameter_s | |
1761 | print 'The self object is:',self |
|
1761 | print 'The self object is:',self | |
1762 |
|
1762 | |||
1763 | self.define_magic('foo',foo_impl) |
|
1763 | self.define_magic('foo',foo_impl) | |
1764 | """ |
|
1764 | """ | |
1765 |
|
1765 | |||
1766 | import new |
|
1766 | import new | |
1767 | im = types.MethodType(func,self) |
|
1767 | im = types.MethodType(func,self) | |
1768 | old = getattr(self, "magic_" + magicname, None) |
|
1768 | old = getattr(self, "magic_" + magicname, None) | |
1769 | setattr(self, "magic_" + magicname, im) |
|
1769 | setattr(self, "magic_" + magicname, im) | |
1770 | return old |
|
1770 | return old | |
1771 |
|
1771 | |||
1772 | #------------------------------------------------------------------------- |
|
1772 | #------------------------------------------------------------------------- | |
1773 | # Things related to macros |
|
1773 | # Things related to macros | |
1774 | #------------------------------------------------------------------------- |
|
1774 | #------------------------------------------------------------------------- | |
1775 |
|
1775 | |||
1776 | def define_macro(self, name, themacro): |
|
1776 | def define_macro(self, name, themacro): | |
1777 | """Define a new macro |
|
1777 | """Define a new macro | |
1778 |
|
1778 | |||
1779 | Parameters |
|
1779 | Parameters | |
1780 | ---------- |
|
1780 | ---------- | |
1781 | name : str |
|
1781 | name : str | |
1782 | The name of the macro. |
|
1782 | The name of the macro. | |
1783 | themacro : str or Macro |
|
1783 | themacro : str or Macro | |
1784 | The action to do upon invoking the macro. If a string, a new |
|
1784 | The action to do upon invoking the macro. If a string, a new | |
1785 | Macro object is created by passing the string to it. |
|
1785 | Macro object is created by passing the string to it. | |
1786 | """ |
|
1786 | """ | |
1787 |
|
1787 | |||
1788 | from IPython.core import macro |
|
1788 | from IPython.core import macro | |
1789 |
|
1789 | |||
1790 | if isinstance(themacro, basestring): |
|
1790 | if isinstance(themacro, basestring): | |
1791 | themacro = macro.Macro(themacro) |
|
1791 | themacro = macro.Macro(themacro) | |
1792 | if not isinstance(themacro, macro.Macro): |
|
1792 | if not isinstance(themacro, macro.Macro): | |
1793 | raise ValueError('A macro must be a string or a Macro instance.') |
|
1793 | raise ValueError('A macro must be a string or a Macro instance.') | |
1794 | self.user_ns[name] = themacro |
|
1794 | self.user_ns[name] = themacro | |
1795 |
|
1795 | |||
1796 | #------------------------------------------------------------------------- |
|
1796 | #------------------------------------------------------------------------- | |
1797 | # Things related to the running of system commands |
|
1797 | # Things related to the running of system commands | |
1798 | #------------------------------------------------------------------------- |
|
1798 | #------------------------------------------------------------------------- | |
1799 |
|
1799 | |||
1800 | def system(self, cmd): |
|
1800 | def system(self, cmd): | |
1801 | """Call the given cmd in a subprocess. |
|
1801 | """Call the given cmd in a subprocess. | |
1802 |
|
1802 | |||
1803 | Parameters |
|
1803 | Parameters | |
1804 | ---------- |
|
1804 | ---------- | |
1805 | cmd : str |
|
1805 | cmd : str | |
1806 | Command to execute (can not end in '&', as bacground processes are |
|
1806 | Command to execute (can not end in '&', as bacground processes are | |
1807 | not supported. |
|
1807 | not supported. | |
1808 | """ |
|
1808 | """ | |
1809 | # We do not support backgrounding processes because we either use |
|
1809 | # We do not support backgrounding processes because we either use | |
1810 | # pexpect or pipes to read from. Users can always just call |
|
1810 | # pexpect or pipes to read from. Users can always just call | |
1811 | # os.system() if they really want a background process. |
|
1811 | # os.system() if they really want a background process. | |
1812 | if cmd.endswith('&'): |
|
1812 | if cmd.endswith('&'): | |
1813 | raise OSError("Background processes not supported.") |
|
1813 | raise OSError("Background processes not supported.") | |
1814 |
|
1814 | |||
1815 | return system(self.var_expand(cmd, depth=2)) |
|
1815 | return system(self.var_expand(cmd, depth=2)) | |
1816 |
|
1816 | |||
1817 | def getoutput(self, cmd, split=True): |
|
1817 | def getoutput(self, cmd, split=True): | |
1818 | """Get output (possibly including stderr) from a subprocess. |
|
1818 | """Get output (possibly including stderr) from a subprocess. | |
1819 |
|
1819 | |||
1820 | Parameters |
|
1820 | Parameters | |
1821 | ---------- |
|
1821 | ---------- | |
1822 | cmd : str |
|
1822 | cmd : str | |
1823 | Command to execute (can not end in '&', as background processes are |
|
1823 | Command to execute (can not end in '&', as background processes are | |
1824 | not supported. |
|
1824 | not supported. | |
1825 | split : bool, optional |
|
1825 | split : bool, optional | |
1826 |
|
1826 | |||
1827 | If True, split the output into an IPython SList. Otherwise, an |
|
1827 | If True, split the output into an IPython SList. Otherwise, an | |
1828 | IPython LSString is returned. These are objects similar to normal |
|
1828 | IPython LSString is returned. These are objects similar to normal | |
1829 | lists and strings, with a few convenience attributes for easier |
|
1829 | lists and strings, with a few convenience attributes for easier | |
1830 | manipulation of line-based output. You can use '?' on them for |
|
1830 | manipulation of line-based output. You can use '?' on them for | |
1831 | details. |
|
1831 | details. | |
1832 | """ |
|
1832 | """ | |
1833 | if cmd.endswith('&'): |
|
1833 | if cmd.endswith('&'): | |
1834 | raise OSError("Background processes not supported.") |
|
1834 | raise OSError("Background processes not supported.") | |
1835 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
1835 | out = getoutput(self.var_expand(cmd, depth=2)) | |
1836 | if split: |
|
1836 | if split: | |
1837 | out = SList(out.splitlines()) |
|
1837 | out = SList(out.splitlines()) | |
1838 | else: |
|
1838 | else: | |
1839 | out = LSString(out) |
|
1839 | out = LSString(out) | |
1840 | return out |
|
1840 | return out | |
1841 |
|
1841 | |||
1842 | #------------------------------------------------------------------------- |
|
1842 | #------------------------------------------------------------------------- | |
1843 | # Things related to aliases |
|
1843 | # Things related to aliases | |
1844 | #------------------------------------------------------------------------- |
|
1844 | #------------------------------------------------------------------------- | |
1845 |
|
1845 | |||
1846 | def init_alias(self): |
|
1846 | def init_alias(self): | |
1847 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
1847 | self.alias_manager = AliasManager(shell=self, config=self.config) | |
1848 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
1848 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
1849 |
|
1849 | |||
1850 | #------------------------------------------------------------------------- |
|
1850 | #------------------------------------------------------------------------- | |
1851 | # Things related to extensions and plugins |
|
1851 | # Things related to extensions and plugins | |
1852 | #------------------------------------------------------------------------- |
|
1852 | #------------------------------------------------------------------------- | |
1853 |
|
1853 | |||
1854 | def init_extension_manager(self): |
|
1854 | def init_extension_manager(self): | |
1855 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
1855 | self.extension_manager = ExtensionManager(shell=self, config=self.config) | |
1856 |
|
1856 | |||
1857 | def init_plugin_manager(self): |
|
1857 | def init_plugin_manager(self): | |
1858 | self.plugin_manager = PluginManager(config=self.config) |
|
1858 | self.plugin_manager = PluginManager(config=self.config) | |
1859 |
|
1859 | |||
1860 | #------------------------------------------------------------------------- |
|
1860 | #------------------------------------------------------------------------- | |
1861 | # Things related to payloads |
|
1861 | # Things related to payloads | |
1862 | #------------------------------------------------------------------------- |
|
1862 | #------------------------------------------------------------------------- | |
1863 |
|
1863 | |||
1864 | def init_payload(self): |
|
1864 | def init_payload(self): | |
1865 | self.payload_manager = PayloadManager(config=self.config) |
|
1865 | self.payload_manager = PayloadManager(config=self.config) | |
1866 |
|
1866 | |||
1867 | #------------------------------------------------------------------------- |
|
1867 | #------------------------------------------------------------------------- | |
1868 | # Things related to the prefilter |
|
1868 | # Things related to the prefilter | |
1869 | #------------------------------------------------------------------------- |
|
1869 | #------------------------------------------------------------------------- | |
1870 |
|
1870 | |||
1871 | def init_prefilter(self): |
|
1871 | def init_prefilter(self): | |
1872 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
1872 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) | |
1873 | # Ultimately this will be refactored in the new interpreter code, but |
|
1873 | # Ultimately this will be refactored in the new interpreter code, but | |
1874 | # for now, we should expose the main prefilter method (there's legacy |
|
1874 | # for now, we should expose the main prefilter method (there's legacy | |
1875 | # code out there that may rely on this). |
|
1875 | # code out there that may rely on this). | |
1876 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
1876 | self.prefilter = self.prefilter_manager.prefilter_lines | |
1877 |
|
1877 | |||
1878 | def auto_rewrite_input(self, cmd): |
|
1878 | def auto_rewrite_input(self, cmd): | |
1879 | """Print to the screen the rewritten form of the user's command. |
|
1879 | """Print to the screen the rewritten form of the user's command. | |
1880 |
|
1880 | |||
1881 | This shows visual feedback by rewriting input lines that cause |
|
1881 | This shows visual feedback by rewriting input lines that cause | |
1882 | automatic calling to kick in, like:: |
|
1882 | automatic calling to kick in, like:: | |
1883 |
|
1883 | |||
1884 | /f x |
|
1884 | /f x | |
1885 |
|
1885 | |||
1886 | into:: |
|
1886 | into:: | |
1887 |
|
1887 | |||
1888 | ------> f(x) |
|
1888 | ------> f(x) | |
1889 |
|
1889 | |||
1890 | after the user's input prompt. This helps the user understand that the |
|
1890 | after the user's input prompt. This helps the user understand that the | |
1891 | input line was transformed automatically by IPython. |
|
1891 | input line was transformed automatically by IPython. | |
1892 | """ |
|
1892 | """ | |
1893 | rw = self.displayhook.prompt1.auto_rewrite() + cmd |
|
1893 | rw = self.displayhook.prompt1.auto_rewrite() + cmd | |
1894 |
|
1894 | |||
1895 | try: |
|
1895 | try: | |
1896 | # plain ascii works better w/ pyreadline, on some machines, so |
|
1896 | # plain ascii works better w/ pyreadline, on some machines, so | |
1897 | # we use it and only print uncolored rewrite if we have unicode |
|
1897 | # we use it and only print uncolored rewrite if we have unicode | |
1898 | rw = str(rw) |
|
1898 | rw = str(rw) | |
1899 | print >> IPython.utils.io.Term.cout, rw |
|
1899 | print >> IPython.utils.io.Term.cout, rw | |
1900 | except UnicodeEncodeError: |
|
1900 | except UnicodeEncodeError: | |
1901 | print "------> " + cmd |
|
1901 | print "------> " + cmd | |
1902 |
|
1902 | |||
1903 | #------------------------------------------------------------------------- |
|
1903 | #------------------------------------------------------------------------- | |
1904 | # Things related to extracting values/expressions from kernel and user_ns |
|
1904 | # Things related to extracting values/expressions from kernel and user_ns | |
1905 | #------------------------------------------------------------------------- |
|
1905 | #------------------------------------------------------------------------- | |
1906 |
|
1906 | |||
1907 | def _simple_error(self): |
|
1907 | def _simple_error(self): | |
1908 | etype, value = sys.exc_info()[:2] |
|
1908 | etype, value = sys.exc_info()[:2] | |
1909 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
1909 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) | |
1910 |
|
1910 | |||
1911 | def user_variables(self, names): |
|
1911 | def user_variables(self, names): | |
1912 | """Get a list of variable names from the user's namespace. |
|
1912 | """Get a list of variable names from the user's namespace. | |
1913 |
|
1913 | |||
1914 | Parameters |
|
1914 | Parameters | |
1915 | ---------- |
|
1915 | ---------- | |
1916 | names : list of strings |
|
1916 | names : list of strings | |
1917 | A list of names of variables to be read from the user namespace. |
|
1917 | A list of names of variables to be read from the user namespace. | |
1918 |
|
1918 | |||
1919 | Returns |
|
1919 | Returns | |
1920 | ------- |
|
1920 | ------- | |
1921 | A dict, keyed by the input names and with the repr() of each value. |
|
1921 | A dict, keyed by the input names and with the repr() of each value. | |
1922 | """ |
|
1922 | """ | |
1923 | out = {} |
|
1923 | out = {} | |
1924 | user_ns = self.user_ns |
|
1924 | user_ns = self.user_ns | |
1925 | for varname in names: |
|
1925 | for varname in names: | |
1926 | try: |
|
1926 | try: | |
1927 | value = repr(user_ns[varname]) |
|
1927 | value = repr(user_ns[varname]) | |
1928 | except: |
|
1928 | except: | |
1929 | value = self._simple_error() |
|
1929 | value = self._simple_error() | |
1930 | out[varname] = value |
|
1930 | out[varname] = value | |
1931 | return out |
|
1931 | return out | |
1932 |
|
1932 | |||
1933 | def user_expressions(self, expressions): |
|
1933 | def user_expressions(self, expressions): | |
1934 | """Evaluate a dict of expressions in the user's namespace. |
|
1934 | """Evaluate a dict of expressions in the user's namespace. | |
1935 |
|
1935 | |||
1936 | Parameters |
|
1936 | Parameters | |
1937 | ---------- |
|
1937 | ---------- | |
1938 | expressions : dict |
|
1938 | expressions : dict | |
1939 | A dict with string keys and string values. The expression values |
|
1939 | A dict with string keys and string values. The expression values | |
1940 | should be valid Python expressions, each of which will be evaluated |
|
1940 | should be valid Python expressions, each of which will be evaluated | |
1941 | in the user namespace. |
|
1941 | in the user namespace. | |
1942 |
|
1942 | |||
1943 | Returns |
|
1943 | Returns | |
1944 | ------- |
|
1944 | ------- | |
1945 | A dict, keyed like the input expressions dict, with the repr() of each |
|
1945 | A dict, keyed like the input expressions dict, with the repr() of each | |
1946 | value. |
|
1946 | value. | |
1947 | """ |
|
1947 | """ | |
1948 | out = {} |
|
1948 | out = {} | |
1949 | user_ns = self.user_ns |
|
1949 | user_ns = self.user_ns | |
1950 | global_ns = self.user_global_ns |
|
1950 | global_ns = self.user_global_ns | |
1951 | for key, expr in expressions.iteritems(): |
|
1951 | for key, expr in expressions.iteritems(): | |
1952 | try: |
|
1952 | try: | |
1953 | value = repr(eval(expr, global_ns, user_ns)) |
|
1953 | value = repr(eval(expr, global_ns, user_ns)) | |
1954 | except: |
|
1954 | except: | |
1955 | value = self._simple_error() |
|
1955 | value = self._simple_error() | |
1956 | out[key] = value |
|
1956 | out[key] = value | |
1957 | return out |
|
1957 | return out | |
1958 |
|
1958 | |||
1959 | #------------------------------------------------------------------------- |
|
1959 | #------------------------------------------------------------------------- | |
1960 | # Things related to the running of code |
|
1960 | # Things related to the running of code | |
1961 | #------------------------------------------------------------------------- |
|
1961 | #------------------------------------------------------------------------- | |
1962 |
|
1962 | |||
1963 | def ex(self, cmd): |
|
1963 | def ex(self, cmd): | |
1964 | """Execute a normal python statement in user namespace.""" |
|
1964 | """Execute a normal python statement in user namespace.""" | |
1965 | with nested(self.builtin_trap,): |
|
1965 | with nested(self.builtin_trap,): | |
1966 | exec cmd in self.user_global_ns, self.user_ns |
|
1966 | exec cmd in self.user_global_ns, self.user_ns | |
1967 |
|
1967 | |||
1968 | def ev(self, expr): |
|
1968 | def ev(self, expr): | |
1969 | """Evaluate python expression expr in user namespace. |
|
1969 | """Evaluate python expression expr in user namespace. | |
1970 |
|
1970 | |||
1971 | Returns the result of evaluation |
|
1971 | Returns the result of evaluation | |
1972 | """ |
|
1972 | """ | |
1973 | with nested(self.builtin_trap,): |
|
1973 | with nested(self.builtin_trap,): | |
1974 | return eval(expr, self.user_global_ns, self.user_ns) |
|
1974 | return eval(expr, self.user_global_ns, self.user_ns) | |
1975 |
|
1975 | |||
1976 | def safe_execfile(self, fname, *where, **kw): |
|
1976 | def safe_execfile(self, fname, *where, **kw): | |
1977 | """A safe version of the builtin execfile(). |
|
1977 | """A safe version of the builtin execfile(). | |
1978 |
|
1978 | |||
1979 | This version will never throw an exception, but instead print |
|
1979 | This version will never throw an exception, but instead print | |
1980 | helpful error messages to the screen. This only works on pure |
|
1980 | helpful error messages to the screen. This only works on pure | |
1981 | Python files with the .py extension. |
|
1981 | Python files with the .py extension. | |
1982 |
|
1982 | |||
1983 | Parameters |
|
1983 | Parameters | |
1984 | ---------- |
|
1984 | ---------- | |
1985 | fname : string |
|
1985 | fname : string | |
1986 | The name of the file to be executed. |
|
1986 | The name of the file to be executed. | |
1987 | where : tuple |
|
1987 | where : tuple | |
1988 | One or two namespaces, passed to execfile() as (globals,locals). |
|
1988 | One or two namespaces, passed to execfile() as (globals,locals). | |
1989 | If only one is given, it is passed as both. |
|
1989 | If only one is given, it is passed as both. | |
1990 | exit_ignore : bool (False) |
|
1990 | exit_ignore : bool (False) | |
1991 | If True, then silence SystemExit for non-zero status (it is always |
|
1991 | If True, then silence SystemExit for non-zero status (it is always | |
1992 | silenced for zero status, as it is so common). |
|
1992 | silenced for zero status, as it is so common). | |
1993 | """ |
|
1993 | """ | |
1994 | kw.setdefault('exit_ignore', False) |
|
1994 | kw.setdefault('exit_ignore', False) | |
1995 |
|
1995 | |||
1996 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
1996 | fname = os.path.abspath(os.path.expanduser(fname)) | |
1997 |
|
1997 | |||
1998 | # Make sure we have a .py file |
|
1998 | # Make sure we have a .py file | |
1999 | if not fname.endswith('.py'): |
|
1999 | if not fname.endswith('.py'): | |
2000 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2000 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
2001 |
|
2001 | |||
2002 | # Make sure we can open the file |
|
2002 | # Make sure we can open the file | |
2003 | try: |
|
2003 | try: | |
2004 | with open(fname) as thefile: |
|
2004 | with open(fname) as thefile: | |
2005 | pass |
|
2005 | pass | |
2006 | except: |
|
2006 | except: | |
2007 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2007 | warn('Could not open file <%s> for safe execution.' % fname) | |
2008 | return |
|
2008 | return | |
2009 |
|
2009 | |||
2010 | # Find things also in current directory. This is needed to mimic the |
|
2010 | # Find things also in current directory. This is needed to mimic the | |
2011 | # behavior of running a script from the system command line, where |
|
2011 | # behavior of running a script from the system command line, where | |
2012 | # Python inserts the script's directory into sys.path |
|
2012 | # Python inserts the script's directory into sys.path | |
2013 | dname = os.path.dirname(fname) |
|
2013 | dname = os.path.dirname(fname) | |
2014 |
|
2014 | |||
2015 | with prepended_to_syspath(dname): |
|
2015 | with prepended_to_syspath(dname): | |
2016 | try: |
|
2016 | try: | |
2017 | execfile(fname,*where) |
|
2017 | execfile(fname,*where) | |
2018 | except SystemExit, status: |
|
2018 | except SystemExit, status: | |
2019 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2019 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2020 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2020 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2021 | # these are considered normal by the OS: |
|
2021 | # these are considered normal by the OS: | |
2022 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2022 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2023 | # 0 |
|
2023 | # 0 | |
2024 | # > python -c'import sys;sys.exit()'; echo $? |
|
2024 | # > python -c'import sys;sys.exit()'; echo $? | |
2025 | # 0 |
|
2025 | # 0 | |
2026 | # For other exit status, we show the exception unless |
|
2026 | # For other exit status, we show the exception unless | |
2027 | # explicitly silenced, but only in short form. |
|
2027 | # explicitly silenced, but only in short form. | |
2028 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2028 | if status.code not in (0, None) and not kw['exit_ignore']: | |
2029 | self.showtraceback(exception_only=True) |
|
2029 | self.showtraceback(exception_only=True) | |
2030 | except: |
|
2030 | except: | |
2031 | self.showtraceback() |
|
2031 | self.showtraceback() | |
2032 |
|
2032 | |||
2033 | def safe_execfile_ipy(self, fname): |
|
2033 | def safe_execfile_ipy(self, fname): | |
2034 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2034 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
2035 |
|
2035 | |||
2036 | Parameters |
|
2036 | Parameters | |
2037 | ---------- |
|
2037 | ---------- | |
2038 | fname : str |
|
2038 | fname : str | |
2039 | The name of the file to execute. The filename must have a |
|
2039 | The name of the file to execute. The filename must have a | |
2040 | .ipy extension. |
|
2040 | .ipy extension. | |
2041 | """ |
|
2041 | """ | |
2042 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2042 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2043 |
|
2043 | |||
2044 | # Make sure we have a .py file |
|
2044 | # Make sure we have a .py file | |
2045 | if not fname.endswith('.ipy'): |
|
2045 | if not fname.endswith('.ipy'): | |
2046 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2046 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
2047 |
|
2047 | |||
2048 | # Make sure we can open the file |
|
2048 | # Make sure we can open the file | |
2049 | try: |
|
2049 | try: | |
2050 | with open(fname) as thefile: |
|
2050 | with open(fname) as thefile: | |
2051 | pass |
|
2051 | pass | |
2052 | except: |
|
2052 | except: | |
2053 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2053 | warn('Could not open file <%s> for safe execution.' % fname) | |
2054 | return |
|
2054 | return | |
2055 |
|
2055 | |||
2056 | # Find things also in current directory. This is needed to mimic the |
|
2056 | # Find things also in current directory. This is needed to mimic the | |
2057 | # behavior of running a script from the system command line, where |
|
2057 | # behavior of running a script from the system command line, where | |
2058 | # Python inserts the script's directory into sys.path |
|
2058 | # Python inserts the script's directory into sys.path | |
2059 | dname = os.path.dirname(fname) |
|
2059 | dname = os.path.dirname(fname) | |
2060 |
|
2060 | |||
2061 | with prepended_to_syspath(dname): |
|
2061 | with prepended_to_syspath(dname): | |
2062 | try: |
|
2062 | try: | |
2063 | with open(fname) as thefile: |
|
2063 | with open(fname) as thefile: | |
2064 | # self.run_cell currently captures all exceptions |
|
2064 | # self.run_cell currently captures all exceptions | |
2065 | # raised in user code. It would be nice if there were |
|
2065 | # raised in user code. It would be nice if there were | |
2066 | # versions of runlines, execfile that did raise, so |
|
2066 | # versions of runlines, execfile that did raise, so | |
2067 | # we could catch the errors. |
|
2067 | # we could catch the errors. | |
2068 | self.run_cell(thefile.read()) |
|
2068 | self.run_cell(thefile.read()) | |
2069 | except: |
|
2069 | except: | |
2070 | self.showtraceback() |
|
2070 | self.showtraceback() | |
2071 | warn('Unknown failure executing file: <%s>' % fname) |
|
2071 | warn('Unknown failure executing file: <%s>' % fname) | |
2072 |
|
2072 | |||
2073 | def run_cell(self, cell): |
|
2073 | def run_cell(self, cell): | |
2074 | """Run the contents of an entire multiline 'cell' of code. |
|
2074 | """Run the contents of an entire multiline 'cell' of code. | |
2075 |
|
2075 | |||
2076 | The cell is split into separate blocks which can be executed |
|
2076 | The cell is split into separate blocks which can be executed | |
2077 | individually. Then, based on how many blocks there are, they are |
|
2077 | individually. Then, based on how many blocks there are, they are | |
2078 | executed as follows: |
|
2078 | executed as follows: | |
2079 |
|
2079 | |||
2080 | - A single block: 'single' mode. |
|
2080 | - A single block: 'single' mode. | |
2081 |
|
2081 | |||
2082 | If there's more than one block, it depends: |
|
2082 | If there's more than one block, it depends: | |
2083 |
|
2083 | |||
2084 | - if the last one is no more than two lines long, run all but the last |
|
2084 | - if the last one is no more than two lines long, run all but the last | |
2085 | in 'exec' mode and the very last one in 'single' mode. This makes it |
|
2085 | in 'exec' mode and the very last one in 'single' mode. This makes it | |
2086 | easy to type simple expressions at the end to see computed values. - |
|
2086 | easy to type simple expressions at the end to see computed values. - | |
2087 | otherwise (last one is also multiline), run all in 'exec' mode |
|
2087 | otherwise (last one is also multiline), run all in 'exec' mode | |
2088 |
|
2088 | |||
2089 | When code is executed in 'single' mode, :func:`sys.displayhook` fires, |
|
2089 | When code is executed in 'single' mode, :func:`sys.displayhook` fires, | |
2090 | results are displayed and output prompts are computed. In 'exec' mode, |
|
2090 | results are displayed and output prompts are computed. In 'exec' mode, | |
2091 | no results are displayed unless :func:`print` is called explicitly; |
|
2091 | no results are displayed unless :func:`print` is called explicitly; | |
2092 | this mode is more akin to running a script. |
|
2092 | this mode is more akin to running a script. | |
2093 |
|
2093 | |||
2094 | Parameters |
|
2094 | Parameters | |
2095 | ---------- |
|
2095 | ---------- | |
2096 | cell : str |
|
2096 | cell : str | |
2097 | A single or multiline string. |
|
2097 | A single or multiline string. | |
2098 | """ |
|
2098 | """ | |
2099 |
|
2099 | |||
2100 | # We need to break up the input into executable blocks that can be run |
|
2100 | # We need to break up the input into executable blocks that can be run | |
2101 | # in 'single' mode, to provide comfortable user behavior. |
|
2101 | # in 'single' mode, to provide comfortable user behavior. | |
2102 | blocks = self.input_splitter.split_blocks(cell) |
|
2102 | blocks = self.input_splitter.split_blocks(cell) | |
2103 |
|
2103 | |||
2104 | if not blocks: |
|
2104 | if not blocks: | |
2105 | return |
|
2105 | return | |
2106 |
|
2106 | |||
2107 | # Store the 'ipython' version of the cell as well, since that's what |
|
2107 | # Store the 'ipython' version of the cell as well, since that's what | |
2108 | # needs to go into the translated history and get executed (the |
|
2108 | # needs to go into the translated history and get executed (the | |
2109 | # original cell may contain non-python syntax). |
|
2109 | # original cell may contain non-python syntax). | |
2110 | ipy_cell = ''.join(blocks) |
|
2110 | ipy_cell = ''.join(blocks) | |
2111 |
|
2111 | |||
2112 | # Store raw and processed history |
|
2112 | # Store raw and processed history | |
2113 | self.history_manager.store_inputs(ipy_cell, cell) |
|
2113 | self.history_manager.store_inputs(ipy_cell, cell) | |
2114 |
|
2114 | |||
2115 | self.logger.log(ipy_cell, cell) |
|
2115 | self.logger.log(ipy_cell, cell) | |
2116 | # dbg code!!! |
|
|||
2117 | if 0: |
|
|||
2118 | def myapp(self, val): # dbg |
|
|||
2119 | import traceback as tb |
|
|||
2120 | stack = ''.join(tb.format_stack()) |
|
|||
2121 | print 'Value:', val |
|
|||
2122 | print 'Stack:\n', stack |
|
|||
2123 | list.append(self, val) |
|
|||
2124 |
|
||||
2125 | import new |
|
|||
2126 | self.history_manager.input_hist_parsed.append = types.MethodType(myapp, |
|
|||
2127 | self.history_manager.input_hist_parsed) |
|
|||
2128 | # End dbg |
|
|||
2129 |
|
2116 | |||
2130 | # All user code execution must happen with our context managers active |
|
2117 | # All user code execution must happen with our context managers active | |
2131 | with nested(self.builtin_trap, self.display_trap): |
|
2118 | with nested(self.builtin_trap, self.display_trap): | |
2132 |
|
2119 | |||
2133 | # Single-block input should behave like an interactive prompt |
|
2120 | # Single-block input should behave like an interactive prompt | |
2134 | if len(blocks) == 1: |
|
2121 | if len(blocks) == 1: | |
2135 | # since we return here, we need to update the execution count |
|
2122 | # since we return here, we need to update the execution count | |
2136 | out = self.run_one_block(blocks[0]) |
|
2123 | out = self.run_one_block(blocks[0]) | |
2137 | self.execution_count += 1 |
|
2124 | self.execution_count += 1 | |
2138 | return out |
|
2125 | return out | |
2139 |
|
2126 | |||
2140 | # In multi-block input, if the last block is a simple (one-two |
|
2127 | # In multi-block input, if the last block is a simple (one-two | |
2141 | # lines) expression, run it in single mode so it produces output. |
|
2128 | # lines) expression, run it in single mode so it produces output. | |
2142 | # Otherwise just feed the whole thing to run_code. This seems like |
|
2129 | # Otherwise just feed the whole thing to run_code. This seems like | |
2143 | # a reasonable usability design. |
|
2130 | # a reasonable usability design. | |
2144 | last = blocks[-1] |
|
2131 | last = blocks[-1] | |
2145 | last_nlines = len(last.splitlines()) |
|
2132 | last_nlines = len(last.splitlines()) | |
2146 |
|
2133 | |||
2147 | # Note: below, whenever we call run_code, we must sync history |
|
2134 | # Note: below, whenever we call run_code, we must sync history | |
2148 | # ourselves, because run_code is NOT meant to manage history at all. |
|
2135 | # ourselves, because run_code is NOT meant to manage history at all. | |
2149 | if last_nlines < 2: |
|
2136 | if last_nlines < 2: | |
2150 | # Here we consider the cell split between 'body' and 'last', |
|
2137 | # Here we consider the cell split between 'body' and 'last', | |
2151 | # store all history and execute 'body', and if successful, then |
|
2138 | # store all history and execute 'body', and if successful, then | |
2152 | # proceed to execute 'last'. |
|
2139 | # proceed to execute 'last'. | |
2153 |
|
2140 | |||
2154 | # Get the main body to run as a cell |
|
2141 | # Get the main body to run as a cell | |
2155 | ipy_body = ''.join(blocks[:-1]) |
|
2142 | ipy_body = ''.join(blocks[:-1]) | |
2156 | retcode = self.run_source(ipy_body, symbol='exec', |
|
2143 | retcode = self.run_source(ipy_body, symbol='exec', | |
2157 | post_execute=False) |
|
2144 | post_execute=False) | |
2158 | if retcode==0: |
|
2145 | if retcode==0: | |
2159 | # And the last expression via runlines so it produces output |
|
2146 | # And the last expression via runlines so it produces output | |
2160 | self.run_one_block(last) |
|
2147 | self.run_one_block(last) | |
2161 | else: |
|
2148 | else: | |
2162 | # Run the whole cell as one entity, storing both raw and |
|
2149 | # Run the whole cell as one entity, storing both raw and | |
2163 | # processed input in history |
|
2150 | # processed input in history | |
2164 | self.run_source(ipy_cell, symbol='exec') |
|
2151 | self.run_source(ipy_cell, symbol='exec') | |
2165 |
|
2152 | |||
2166 | # Each cell is a *single* input, regardless of how many lines it has |
|
2153 | # Each cell is a *single* input, regardless of how many lines it has | |
2167 | self.execution_count += 1 |
|
2154 | self.execution_count += 1 | |
2168 |
|
2155 | |||
2169 | def run_one_block(self, block): |
|
2156 | def run_one_block(self, block): | |
2170 | """Run a single interactive block. |
|
2157 | """Run a single interactive block of source code. | |
2171 |
|
2158 | |||
2172 | If the block is single-line, dynamic transformations are applied to it |
|
2159 | If the block is single-line, dynamic transformations are applied to it | |
2173 | (like automagics, autocall and alias recognition). |
|
2160 | (like automagics, autocall and alias recognition). | |
|
2161 | ||||
|
2162 | If the block is multi-line, it must consist of valid Python code only. | |||
|
2163 | ||||
|
2164 | Parameters | |||
|
2165 | ---------- | |||
|
2166 | block : string | |||
|
2167 | A (possibly multiline) string of code to be executed. | |||
|
2168 | ||||
|
2169 | Returns | |||
|
2170 | ------- | |||
|
2171 | The output of the underlying execution method used, be it | |||
|
2172 | :meth:`run_source` or :meth:`run_single_line`. | |||
2174 | """ |
|
2173 | """ | |
2175 | if len(block.splitlines()) <= 1: |
|
2174 | if len(block.splitlines()) <= 1: | |
2176 | out = self.run_single_line(block) |
|
2175 | out = self.run_single_line(block) | |
2177 | else: |
|
2176 | else: | |
2178 | out = self.run_code(block) |
|
2177 | # Call run_source, which correctly compiles the input cell. | |
|
2178 | # run_code must only be called when we know we have a code object, | |||
|
2179 | # as it does a naked exec and the compilation mode may not be what | |||
|
2180 | # we wanted. | |||
|
2181 | out = self.run_source(block) | |||
2179 | return out |
|
2182 | return out | |
2180 |
|
2183 | |||
2181 | def run_single_line(self, line): |
|
2184 | def run_single_line(self, line): | |
2182 | """Run a single-line interactive statement. |
|
2185 | """Run a single-line interactive statement. | |
2183 |
|
2186 | |||
2184 | This assumes the input has been transformed to IPython syntax by |
|
2187 | This assumes the input has been transformed to IPython syntax by | |
2185 | applying all static transformations (those with an explicit prefix like |
|
2188 | applying all static transformations (those with an explicit prefix like | |
2186 | % or !), but it will further try to apply the dynamic ones. |
|
2189 | % or !), but it will further try to apply the dynamic ones. | |
2187 |
|
2190 | |||
2188 | It does not update history. |
|
2191 | It does not update history. | |
2189 | """ |
|
2192 | """ | |
2190 | tline = self.prefilter_manager.prefilter_line(line) |
|
2193 | tline = self.prefilter_manager.prefilter_line(line) | |
2191 | return self.run_source(tline) |
|
2194 | return self.run_source(tline) | |
2192 |
|
2195 | |||
2193 | # PENDING REMOVAL: this method is slated for deletion, once our new |
|
2196 | # PENDING REMOVAL: this method is slated for deletion, once our new | |
2194 | # input logic has been 100% moved to frontends and is stable. |
|
2197 | # input logic has been 100% moved to frontends and is stable. | |
2195 | def runlines(self, lines, clean=False): |
|
2198 | def runlines(self, lines, clean=False): | |
2196 | """Run a string of one or more lines of source. |
|
2199 | """Run a string of one or more lines of source. | |
2197 |
|
2200 | |||
2198 | This method is capable of running a string containing multiple source |
|
2201 | This method is capable of running a string containing multiple source | |
2199 | lines, as if they had been entered at the IPython prompt. Since it |
|
2202 | lines, as if they had been entered at the IPython prompt. Since it | |
2200 | exposes IPython's processing machinery, the given strings can contain |
|
2203 | exposes IPython's processing machinery, the given strings can contain | |
2201 | magic calls (%magic), special shell access (!cmd), etc. |
|
2204 | magic calls (%magic), special shell access (!cmd), etc. | |
2202 | """ |
|
2205 | """ | |
2203 |
|
2206 | |||
2204 | if isinstance(lines, (list, tuple)): |
|
2207 | if isinstance(lines, (list, tuple)): | |
2205 | lines = '\n'.join(lines) |
|
2208 | lines = '\n'.join(lines) | |
2206 |
|
2209 | |||
2207 | if clean: |
|
2210 | if clean: | |
2208 | lines = self._cleanup_ipy_script(lines) |
|
2211 | lines = self._cleanup_ipy_script(lines) | |
2209 |
|
2212 | |||
2210 | # We must start with a clean buffer, in case this is run from an |
|
2213 | # We must start with a clean buffer, in case this is run from an | |
2211 | # interactive IPython session (via a magic, for example). |
|
2214 | # interactive IPython session (via a magic, for example). | |
2212 | self.reset_buffer() |
|
2215 | self.reset_buffer() | |
2213 | lines = lines.splitlines() |
|
2216 | lines = lines.splitlines() | |
2214 |
|
2217 | |||
2215 | # Since we will prefilter all lines, store the user's raw input too |
|
2218 | # Since we will prefilter all lines, store the user's raw input too | |
2216 | # before we apply any transformations |
|
2219 | # before we apply any transformations | |
2217 | self.buffer_raw[:] = [ l+'\n' for l in lines] |
|
2220 | self.buffer_raw[:] = [ l+'\n' for l in lines] | |
2218 |
|
2221 | |||
2219 | more = False |
|
2222 | more = False | |
2220 | prefilter_lines = self.prefilter_manager.prefilter_lines |
|
2223 | prefilter_lines = self.prefilter_manager.prefilter_lines | |
2221 | with nested(self.builtin_trap, self.display_trap): |
|
2224 | with nested(self.builtin_trap, self.display_trap): | |
2222 | for line in lines: |
|
2225 | for line in lines: | |
2223 | # skip blank lines so we don't mess up the prompt counter, but |
|
2226 | # skip blank lines so we don't mess up the prompt counter, but | |
2224 | # do NOT skip even a blank line if we are in a code block (more |
|
2227 | # do NOT skip even a blank line if we are in a code block (more | |
2225 | # is true) |
|
2228 | # is true) | |
2226 |
|
2229 | |||
2227 | if line or more: |
|
2230 | if line or more: | |
2228 | more = self.push_line(prefilter_lines(line, more)) |
|
2231 | more = self.push_line(prefilter_lines(line, more)) | |
2229 | # IPython's run_source returns None if there was an error |
|
2232 | # IPython's run_source returns None if there was an error | |
2230 | # compiling the code. This allows us to stop processing |
|
2233 | # compiling the code. This allows us to stop processing | |
2231 | # right away, so the user gets the error message at the |
|
2234 | # right away, so the user gets the error message at the | |
2232 | # right place. |
|
2235 | # right place. | |
2233 | if more is None: |
|
2236 | if more is None: | |
2234 | break |
|
2237 | break | |
2235 | # final newline in case the input didn't have it, so that the code |
|
2238 | # final newline in case the input didn't have it, so that the code | |
2236 | # actually does get executed |
|
2239 | # actually does get executed | |
2237 | if more: |
|
2240 | if more: | |
2238 | self.push_line('\n') |
|
2241 | self.push_line('\n') | |
2239 |
|
2242 | |||
2240 | def run_source(self, source, filename=None, |
|
2243 | def run_source(self, source, filename=None, | |
2241 | symbol='single', post_execute=True): |
|
2244 | symbol='single', post_execute=True): | |
2242 | """Compile and run some source in the interpreter. |
|
2245 | """Compile and run some source in the interpreter. | |
2243 |
|
2246 | |||
2244 | Arguments are as for compile_command(). |
|
2247 | Arguments are as for compile_command(). | |
2245 |
|
2248 | |||
2246 | One several things can happen: |
|
2249 | One several things can happen: | |
2247 |
|
2250 | |||
2248 | 1) The input is incorrect; compile_command() raised an |
|
2251 | 1) The input is incorrect; compile_command() raised an | |
2249 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2252 | exception (SyntaxError or OverflowError). A syntax traceback | |
2250 | will be printed by calling the showsyntaxerror() method. |
|
2253 | will be printed by calling the showsyntaxerror() method. | |
2251 |
|
2254 | |||
2252 | 2) The input is incomplete, and more input is required; |
|
2255 | 2) The input is incomplete, and more input is required; | |
2253 | compile_command() returned None. Nothing happens. |
|
2256 | compile_command() returned None. Nothing happens. | |
2254 |
|
2257 | |||
2255 | 3) The input is complete; compile_command() returned a code |
|
2258 | 3) The input is complete; compile_command() returned a code | |
2256 | object. The code is executed by calling self.run_code() (which |
|
2259 | object. The code is executed by calling self.run_code() (which | |
2257 | also handles run-time exceptions, except for SystemExit). |
|
2260 | also handles run-time exceptions, except for SystemExit). | |
2258 |
|
2261 | |||
2259 | The return value is: |
|
2262 | The return value is: | |
2260 |
|
2263 | |||
2261 | - True in case 2 |
|
2264 | - True in case 2 | |
2262 |
|
2265 | |||
2263 | - False in the other cases, unless an exception is raised, where |
|
2266 | - False in the other cases, unless an exception is raised, where | |
2264 | None is returned instead. This can be used by external callers to |
|
2267 | None is returned instead. This can be used by external callers to | |
2265 | know whether to continue feeding input or not. |
|
2268 | know whether to continue feeding input or not. | |
2266 |
|
2269 | |||
2267 | The return value can be used to decide whether to use sys.ps1 or |
|
2270 | The return value can be used to decide whether to use sys.ps1 or | |
2268 | sys.ps2 to prompt the next line.""" |
|
2271 | sys.ps2 to prompt the next line.""" | |
2269 |
|
2272 | |||
2270 | # We need to ensure that the source is unicode from here on. |
|
2273 | # We need to ensure that the source is unicode from here on. | |
2271 | if type(source)==str: |
|
2274 | if type(source)==str: | |
2272 | usource = source.decode(self.stdin_encoding) |
|
2275 | usource = source.decode(self.stdin_encoding) | |
2273 | else: |
|
2276 | else: | |
2274 | usource = source |
|
2277 | usource = source | |
2275 |
|
2278 | |||
2276 | if 0: # dbg |
|
2279 | if 0: # dbg | |
2277 | print 'Source:', repr(source) # dbg |
|
2280 | print 'Source:', repr(source) # dbg | |
2278 | print 'USource:', repr(usource) # dbg |
|
2281 | print 'USource:', repr(usource) # dbg | |
2279 | print 'type:', type(source) # dbg |
|
2282 | print 'type:', type(source) # dbg | |
2280 | print 'encoding', self.stdin_encoding # dbg |
|
2283 | print 'encoding', self.stdin_encoding # dbg | |
2281 |
|
2284 | |||
2282 | try: |
|
2285 | try: | |
2283 | code = self.compile(usource, symbol, self.execution_count) |
|
2286 | code = self.compile(usource, symbol, self.execution_count) | |
2284 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2287 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2285 | # Case 1 |
|
2288 | # Case 1 | |
2286 | self.showsyntaxerror(filename) |
|
2289 | self.showsyntaxerror(filename) | |
2287 | return None |
|
2290 | return None | |
2288 |
|
2291 | |||
2289 | if code is None: |
|
2292 | if code is None: | |
2290 | # Case 2 |
|
2293 | # Case 2 | |
2291 | return True |
|
2294 | return True | |
2292 |
|
2295 | |||
2293 | # Case 3 |
|
2296 | # Case 3 | |
2294 | # We store the code object so that threaded shells and |
|
2297 | # We store the code object so that threaded shells and | |
2295 | # custom exception handlers can access all this info if needed. |
|
2298 | # custom exception handlers can access all this info if needed. | |
2296 | # The source corresponding to this can be obtained from the |
|
2299 | # The source corresponding to this can be obtained from the | |
2297 | # buffer attribute as '\n'.join(self.buffer). |
|
2300 | # buffer attribute as '\n'.join(self.buffer). | |
2298 | self.code_to_run = code |
|
2301 | self.code_to_run = code | |
2299 | # now actually execute the code object |
|
2302 | # now actually execute the code object | |
2300 | if self.run_code(code, post_execute) == 0: |
|
2303 | if self.run_code(code, post_execute) == 0: | |
2301 | return False |
|
2304 | return False | |
2302 | else: |
|
2305 | else: | |
2303 | return None |
|
2306 | return None | |
2304 |
|
2307 | |||
2305 | # For backwards compatibility |
|
2308 | # For backwards compatibility | |
2306 | runsource = run_source |
|
2309 | runsource = run_source | |
2307 |
|
2310 | |||
2308 | def run_code(self, code_obj, post_execute=True): |
|
2311 | def run_code(self, code_obj, post_execute=True): | |
2309 | """Execute a code object. |
|
2312 | """Execute a code object. | |
2310 |
|
2313 | |||
2311 | When an exception occurs, self.showtraceback() is called to display a |
|
2314 | When an exception occurs, self.showtraceback() is called to display a | |
2312 | traceback. |
|
2315 | traceback. | |
2313 |
|
2316 | |||
2314 | Return value: a flag indicating whether the code to be run completed |
|
2317 | Return value: a flag indicating whether the code to be run completed | |
2315 | successfully: |
|
2318 | successfully: | |
2316 |
|
2319 | |||
2317 | - 0: successful execution. |
|
2320 | - 0: successful execution. | |
2318 | - 1: an error occurred. |
|
2321 | - 1: an error occurred. | |
2319 | """ |
|
2322 | """ | |
2320 |
|
2323 | |||
2321 | # Set our own excepthook in case the user code tries to call it |
|
2324 | # Set our own excepthook in case the user code tries to call it | |
2322 | # directly, so that the IPython crash handler doesn't get triggered |
|
2325 | # directly, so that the IPython crash handler doesn't get triggered | |
2323 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2326 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2324 |
|
2327 | |||
2325 | # we save the original sys.excepthook in the instance, in case config |
|
2328 | # we save the original sys.excepthook in the instance, in case config | |
2326 | # code (such as magics) needs access to it. |
|
2329 | # code (such as magics) needs access to it. | |
2327 | self.sys_excepthook = old_excepthook |
|
2330 | self.sys_excepthook = old_excepthook | |
2328 | outflag = 1 # happens in more places, so it's easier as default |
|
2331 | outflag = 1 # happens in more places, so it's easier as default | |
2329 | try: |
|
2332 | try: | |
2330 | try: |
|
2333 | try: | |
2331 | self.hooks.pre_run_code_hook() |
|
2334 | self.hooks.pre_run_code_hook() | |
2332 | #rprint('Running code') # dbg |
|
2335 | #rprint('Running code', repr(code_obj)) # dbg | |
2333 | exec code_obj in self.user_global_ns, self.user_ns |
|
2336 | exec code_obj in self.user_global_ns, self.user_ns | |
2334 | finally: |
|
2337 | finally: | |
2335 | # Reset our crash handler in place |
|
2338 | # Reset our crash handler in place | |
2336 | sys.excepthook = old_excepthook |
|
2339 | sys.excepthook = old_excepthook | |
2337 | except SystemExit: |
|
2340 | except SystemExit: | |
2338 | self.reset_buffer() |
|
2341 | self.reset_buffer() | |
2339 | self.showtraceback(exception_only=True) |
|
2342 | self.showtraceback(exception_only=True) | |
2340 | warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1) |
|
2343 | warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1) | |
2341 | except self.custom_exceptions: |
|
2344 | except self.custom_exceptions: | |
2342 | etype,value,tb = sys.exc_info() |
|
2345 | etype,value,tb = sys.exc_info() | |
2343 | self.CustomTB(etype,value,tb) |
|
2346 | self.CustomTB(etype,value,tb) | |
2344 | except: |
|
2347 | except: | |
2345 | self.showtraceback() |
|
2348 | self.showtraceback() | |
2346 | else: |
|
2349 | else: | |
2347 | outflag = 0 |
|
2350 | outflag = 0 | |
2348 | if softspace(sys.stdout, 0): |
|
2351 | if softspace(sys.stdout, 0): | |
2349 |
|
2352 | |||
2350 |
|
2353 | |||
2351 | # Execute any registered post-execution functions. Here, any errors |
|
2354 | # Execute any registered post-execution functions. Here, any errors | |
2352 | # are reported only minimally and just on the terminal, because the |
|
2355 | # are reported only minimally and just on the terminal, because the | |
2353 | # main exception channel may be occupied with a user traceback. |
|
2356 | # main exception channel may be occupied with a user traceback. | |
2354 | # FIXME: we need to think this mechanism a little more carefully. |
|
2357 | # FIXME: we need to think this mechanism a little more carefully. | |
2355 | if post_execute: |
|
2358 | if post_execute: | |
2356 | for func in self._post_execute: |
|
2359 | for func in self._post_execute: | |
2357 | try: |
|
2360 | try: | |
2358 | func() |
|
2361 | func() | |
2359 | except: |
|
2362 | except: | |
2360 | head = '[ ERROR ] Evaluating post_execute function: %s' % \ |
|
2363 | head = '[ ERROR ] Evaluating post_execute function: %s' % \ | |
2361 | func |
|
2364 | func | |
2362 | print >> io.Term.cout, head |
|
2365 | print >> io.Term.cout, head | |
2363 | print >> io.Term.cout, self._simple_error() |
|
2366 | print >> io.Term.cout, self._simple_error() | |
2364 | print >> io.Term.cout, 'Removing from post_execute' |
|
2367 | print >> io.Term.cout, 'Removing from post_execute' | |
2365 | self._post_execute.remove(func) |
|
2368 | self._post_execute.remove(func) | |
2366 |
|
2369 | |||
2367 | # Flush out code object which has been run (and source) |
|
2370 | # Flush out code object which has been run (and source) | |
2368 | self.code_to_run = None |
|
2371 | self.code_to_run = None | |
2369 | return outflag |
|
2372 | return outflag | |
2370 |
|
2373 | |||
2371 | # For backwards compatibility |
|
2374 | # For backwards compatibility | |
2372 | runcode = run_code |
|
2375 | runcode = run_code | |
2373 |
|
2376 | |||
2374 | # PENDING REMOVAL: this method is slated for deletion, once our new |
|
2377 | # PENDING REMOVAL: this method is slated for deletion, once our new | |
2375 | # input logic has been 100% moved to frontends and is stable. |
|
2378 | # input logic has been 100% moved to frontends and is stable. | |
2376 | def push_line(self, line): |
|
2379 | def push_line(self, line): | |
2377 | """Push a line to the interpreter. |
|
2380 | """Push a line to the interpreter. | |
2378 |
|
2381 | |||
2379 | The line should not have a trailing newline; it may have |
|
2382 | The line should not have a trailing newline; it may have | |
2380 | internal newlines. The line is appended to a buffer and the |
|
2383 | internal newlines. The line is appended to a buffer and the | |
2381 | interpreter's run_source() method is called with the |
|
2384 | interpreter's run_source() method is called with the | |
2382 | concatenated contents of the buffer as source. If this |
|
2385 | concatenated contents of the buffer as source. If this | |
2383 | indicates that the command was executed or invalid, the buffer |
|
2386 | indicates that the command was executed or invalid, the buffer | |
2384 | is reset; otherwise, the command is incomplete, and the buffer |
|
2387 | is reset; otherwise, the command is incomplete, and the buffer | |
2385 | is left as it was after the line was appended. The return |
|
2388 | is left as it was after the line was appended. The return | |
2386 | value is 1 if more input is required, 0 if the line was dealt |
|
2389 | value is 1 if more input is required, 0 if the line was dealt | |
2387 | with in some way (this is the same as run_source()). |
|
2390 | with in some way (this is the same as run_source()). | |
2388 | """ |
|
2391 | """ | |
2389 |
|
2392 | |||
2390 | # autoindent management should be done here, and not in the |
|
2393 | # autoindent management should be done here, and not in the | |
2391 | # interactive loop, since that one is only seen by keyboard input. We |
|
2394 | # interactive loop, since that one is only seen by keyboard input. We | |
2392 | # need this done correctly even for code run via runlines (which uses |
|
2395 | # need this done correctly even for code run via runlines (which uses | |
2393 | # push). |
|
2396 | # push). | |
2394 |
|
2397 | |||
2395 | #print 'push line: <%s>' % line # dbg |
|
2398 | #print 'push line: <%s>' % line # dbg | |
2396 | self.buffer.append(line) |
|
2399 | self.buffer.append(line) | |
2397 | full_source = '\n'.join(self.buffer) |
|
2400 | full_source = '\n'.join(self.buffer) | |
2398 | more = self.run_source(full_source, self.filename) |
|
2401 | more = self.run_source(full_source, self.filename) | |
2399 | if not more: |
|
2402 | if not more: | |
2400 | self.history_manager.store_inputs('\n'.join(self.buffer_raw), |
|
2403 | self.history_manager.store_inputs('\n'.join(self.buffer_raw), | |
2401 | full_source) |
|
2404 | full_source) | |
2402 | self.reset_buffer() |
|
2405 | self.reset_buffer() | |
2403 | self.execution_count += 1 |
|
2406 | self.execution_count += 1 | |
2404 | return more |
|
2407 | return more | |
2405 |
|
2408 | |||
2406 | def reset_buffer(self): |
|
2409 | def reset_buffer(self): | |
2407 | """Reset the input buffer.""" |
|
2410 | """Reset the input buffer.""" | |
2408 | self.buffer[:] = [] |
|
2411 | self.buffer[:] = [] | |
2409 | self.buffer_raw[:] = [] |
|
2412 | self.buffer_raw[:] = [] | |
2410 | self.input_splitter.reset() |
|
2413 | self.input_splitter.reset() | |
2411 |
|
2414 | |||
2412 | # For backwards compatibility |
|
2415 | # For backwards compatibility | |
2413 | resetbuffer = reset_buffer |
|
2416 | resetbuffer = reset_buffer | |
2414 |
|
2417 | |||
2415 | def _is_secondary_block_start(self, s): |
|
2418 | def _is_secondary_block_start(self, s): | |
2416 | if not s.endswith(':'): |
|
2419 | if not s.endswith(':'): | |
2417 | return False |
|
2420 | return False | |
2418 | if (s.startswith('elif') or |
|
2421 | if (s.startswith('elif') or | |
2419 | s.startswith('else') or |
|
2422 | s.startswith('else') or | |
2420 | s.startswith('except') or |
|
2423 | s.startswith('except') or | |
2421 | s.startswith('finally')): |
|
2424 | s.startswith('finally')): | |
2422 | return True |
|
2425 | return True | |
2423 |
|
2426 | |||
2424 | def _cleanup_ipy_script(self, script): |
|
2427 | def _cleanup_ipy_script(self, script): | |
2425 | """Make a script safe for self.runlines() |
|
2428 | """Make a script safe for self.runlines() | |
2426 |
|
2429 | |||
2427 | Currently, IPython is lines based, with blocks being detected by |
|
2430 | Currently, IPython is lines based, with blocks being detected by | |
2428 | empty lines. This is a problem for block based scripts that may |
|
2431 | empty lines. This is a problem for block based scripts that may | |
2429 | not have empty lines after blocks. This script adds those empty |
|
2432 | not have empty lines after blocks. This script adds those empty | |
2430 | lines to make scripts safe for running in the current line based |
|
2433 | lines to make scripts safe for running in the current line based | |
2431 | IPython. |
|
2434 | IPython. | |
2432 | """ |
|
2435 | """ | |
2433 | res = [] |
|
2436 | res = [] | |
2434 | lines = script.splitlines() |
|
2437 | lines = script.splitlines() | |
2435 | level = 0 |
|
2438 | level = 0 | |
2436 |
|
2439 | |||
2437 | for l in lines: |
|
2440 | for l in lines: | |
2438 | lstripped = l.lstrip() |
|
2441 | lstripped = l.lstrip() | |
2439 | stripped = l.strip() |
|
2442 | stripped = l.strip() | |
2440 | if not stripped: |
|
2443 | if not stripped: | |
2441 | continue |
|
2444 | continue | |
2442 | newlevel = len(l) - len(lstripped) |
|
2445 | newlevel = len(l) - len(lstripped) | |
2443 | if level > 0 and newlevel == 0 and \ |
|
2446 | if level > 0 and newlevel == 0 and \ | |
2444 | not self._is_secondary_block_start(stripped): |
|
2447 | not self._is_secondary_block_start(stripped): | |
2445 | # add empty line |
|
2448 | # add empty line | |
2446 | res.append('') |
|
2449 | res.append('') | |
2447 | res.append(l) |
|
2450 | res.append(l) | |
2448 | level = newlevel |
|
2451 | level = newlevel | |
2449 |
|
2452 | |||
2450 | return '\n'.join(res) + '\n' |
|
2453 | return '\n'.join(res) + '\n' | |
2451 |
|
2454 | |||
2452 | #------------------------------------------------------------------------- |
|
2455 | #------------------------------------------------------------------------- | |
2453 | # Things related to GUI support and pylab |
|
2456 | # Things related to GUI support and pylab | |
2454 | #------------------------------------------------------------------------- |
|
2457 | #------------------------------------------------------------------------- | |
2455 |
|
2458 | |||
2456 | def enable_pylab(self, gui=None): |
|
2459 | def enable_pylab(self, gui=None): | |
2457 | raise NotImplementedError('Implement enable_pylab in a subclass') |
|
2460 | raise NotImplementedError('Implement enable_pylab in a subclass') | |
2458 |
|
2461 | |||
2459 | #------------------------------------------------------------------------- |
|
2462 | #------------------------------------------------------------------------- | |
2460 | # Utilities |
|
2463 | # Utilities | |
2461 | #------------------------------------------------------------------------- |
|
2464 | #------------------------------------------------------------------------- | |
2462 |
|
2465 | |||
2463 | def var_expand(self,cmd,depth=0): |
|
2466 | def var_expand(self,cmd,depth=0): | |
2464 | """Expand python variables in a string. |
|
2467 | """Expand python variables in a string. | |
2465 |
|
2468 | |||
2466 | The depth argument indicates how many frames above the caller should |
|
2469 | The depth argument indicates how many frames above the caller should | |
2467 | be walked to look for the local namespace where to expand variables. |
|
2470 | be walked to look for the local namespace where to expand variables. | |
2468 |
|
2471 | |||
2469 | The global namespace for expansion is always the user's interactive |
|
2472 | The global namespace for expansion is always the user's interactive | |
2470 | namespace. |
|
2473 | namespace. | |
2471 | """ |
|
2474 | """ | |
2472 |
|
2475 | |||
2473 | return str(ItplNS(cmd, |
|
2476 | return str(ItplNS(cmd, | |
2474 | self.user_ns, # globals |
|
2477 | self.user_ns, # globals | |
2475 | # Skip our own frame in searching for locals: |
|
2478 | # Skip our own frame in searching for locals: | |
2476 | sys._getframe(depth+1).f_locals # locals |
|
2479 | sys._getframe(depth+1).f_locals # locals | |
2477 | )) |
|
2480 | )) | |
2478 |
|
2481 | |||
2479 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2482 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
2480 | """Make a new tempfile and return its filename. |
|
2483 | """Make a new tempfile and return its filename. | |
2481 |
|
2484 | |||
2482 | This makes a call to tempfile.mktemp, but it registers the created |
|
2485 | This makes a call to tempfile.mktemp, but it registers the created | |
2483 | filename internally so ipython cleans it up at exit time. |
|
2486 | filename internally so ipython cleans it up at exit time. | |
2484 |
|
2487 | |||
2485 | Optional inputs: |
|
2488 | Optional inputs: | |
2486 |
|
2489 | |||
2487 | - data(None): if data is given, it gets written out to the temp file |
|
2490 | - data(None): if data is given, it gets written out to the temp file | |
2488 | immediately, and the file is closed again.""" |
|
2491 | immediately, and the file is closed again.""" | |
2489 |
|
2492 | |||
2490 | filename = tempfile.mktemp('.py', prefix) |
|
2493 | filename = tempfile.mktemp('.py', prefix) | |
2491 | self.tempfiles.append(filename) |
|
2494 | self.tempfiles.append(filename) | |
2492 |
|
2495 | |||
2493 | if data: |
|
2496 | if data: | |
2494 | tmp_file = open(filename,'w') |
|
2497 | tmp_file = open(filename,'w') | |
2495 | tmp_file.write(data) |
|
2498 | tmp_file.write(data) | |
2496 | tmp_file.close() |
|
2499 | tmp_file.close() | |
2497 | return filename |
|
2500 | return filename | |
2498 |
|
2501 | |||
2499 | # TODO: This should be removed when Term is refactored. |
|
2502 | # TODO: This should be removed when Term is refactored. | |
2500 | def write(self,data): |
|
2503 | def write(self,data): | |
2501 | """Write a string to the default output""" |
|
2504 | """Write a string to the default output""" | |
2502 | io.Term.cout.write(data) |
|
2505 | io.Term.cout.write(data) | |
2503 |
|
2506 | |||
2504 | # TODO: This should be removed when Term is refactored. |
|
2507 | # TODO: This should be removed when Term is refactored. | |
2505 | def write_err(self,data): |
|
2508 | def write_err(self,data): | |
2506 | """Write a string to the default error output""" |
|
2509 | """Write a string to the default error output""" | |
2507 | io.Term.cerr.write(data) |
|
2510 | io.Term.cerr.write(data) | |
2508 |
|
2511 | |||
2509 | def ask_yes_no(self,prompt,default=True): |
|
2512 | def ask_yes_no(self,prompt,default=True): | |
2510 | if self.quiet: |
|
2513 | if self.quiet: | |
2511 | return True |
|
2514 | return True | |
2512 | return ask_yes_no(prompt,default) |
|
2515 | return ask_yes_no(prompt,default) | |
2513 |
|
2516 | |||
2514 | def show_usage(self): |
|
2517 | def show_usage(self): | |
2515 | """Show a usage message""" |
|
2518 | """Show a usage message""" | |
2516 | page.page(IPython.core.usage.interactive_usage) |
|
2519 | page.page(IPython.core.usage.interactive_usage) | |
2517 |
|
2520 | |||
2518 | #------------------------------------------------------------------------- |
|
2521 | #------------------------------------------------------------------------- | |
2519 | # Things related to IPython exiting |
|
2522 | # Things related to IPython exiting | |
2520 | #------------------------------------------------------------------------- |
|
2523 | #------------------------------------------------------------------------- | |
2521 | def atexit_operations(self): |
|
2524 | def atexit_operations(self): | |
2522 | """This will be executed at the time of exit. |
|
2525 | """This will be executed at the time of exit. | |
2523 |
|
2526 | |||
2524 | Cleanup operations and saving of persistent data that is done |
|
2527 | Cleanup operations and saving of persistent data that is done | |
2525 | unconditionally by IPython should be performed here. |
|
2528 | unconditionally by IPython should be performed here. | |
2526 |
|
2529 | |||
2527 | For things that may depend on startup flags or platform specifics (such |
|
2530 | For things that may depend on startup flags or platform specifics (such | |
2528 | as having readline or not), register a separate atexit function in the |
|
2531 | as having readline or not), register a separate atexit function in the | |
2529 | code that has the appropriate information, rather than trying to |
|
2532 | code that has the appropriate information, rather than trying to | |
2530 | clutter |
|
2533 | clutter | |
2531 | """ |
|
2534 | """ | |
2532 | # Cleanup all tempfiles left around |
|
2535 | # Cleanup all tempfiles left around | |
2533 | for tfile in self.tempfiles: |
|
2536 | for tfile in self.tempfiles: | |
2534 | try: |
|
2537 | try: | |
2535 | os.unlink(tfile) |
|
2538 | os.unlink(tfile) | |
2536 | except OSError: |
|
2539 | except OSError: | |
2537 | pass |
|
2540 | pass | |
2538 |
|
2541 | |||
2539 | self.save_history() |
|
2542 | self.save_history() | |
2540 |
|
2543 | |||
2541 | # Clear all user namespaces to release all references cleanly. |
|
2544 | # Clear all user namespaces to release all references cleanly. | |
2542 | self.reset() |
|
2545 | self.reset() | |
2543 |
|
2546 | |||
2544 | # Run user hooks |
|
2547 | # Run user hooks | |
2545 | self.hooks.shutdown_hook() |
|
2548 | self.hooks.shutdown_hook() | |
2546 |
|
2549 | |||
2547 | def cleanup(self): |
|
2550 | def cleanup(self): | |
2548 | self.restore_sys_module_state() |
|
2551 | self.restore_sys_module_state() | |
2549 |
|
2552 | |||
2550 |
|
2553 | |||
2551 | class InteractiveShellABC(object): |
|
2554 | class InteractiveShellABC(object): | |
2552 | """An abstract base class for InteractiveShell.""" |
|
2555 | """An abstract base class for InteractiveShell.""" | |
2553 | __metaclass__ = abc.ABCMeta |
|
2556 | __metaclass__ = abc.ABCMeta | |
2554 |
|
2557 | |||
2555 | InteractiveShellABC.register(InteractiveShell) |
|
2558 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,688 +1,693 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Tests for the inputsplitter module. |
|
2 | """Tests for the inputsplitter module. | |
|
3 | ||||
|
4 | Authors | |||
|
5 | ------- | |||
|
6 | * Fernando Perez | |||
|
7 | * Robert Kern | |||
3 | """ |
|
8 | """ | |
4 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2010 The IPython Development Team |
|
10 | # Copyright (C) 2010 The IPython Development Team | |
6 | # |
|
11 | # | |
7 | # Distributed under the terms of the BSD License. The full license is in |
|
12 | # Distributed under the terms of the BSD License. The full license is in | |
8 | # the file COPYING, distributed as part of this software. |
|
13 | # the file COPYING, distributed as part of this software. | |
9 | #----------------------------------------------------------------------------- |
|
14 | #----------------------------------------------------------------------------- | |
10 |
|
15 | |||
11 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
12 | # Imports |
|
17 | # Imports | |
13 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
14 | # stdlib |
|
19 | # stdlib | |
15 | import unittest |
|
20 | import unittest | |
16 | import sys |
|
21 | import sys | |
17 |
|
22 | |||
18 | # Third party |
|
23 | # Third party | |
19 | import nose.tools as nt |
|
24 | import nose.tools as nt | |
20 |
|
25 | |||
21 | # Our own |
|
26 | # Our own | |
22 | from IPython.core import inputsplitter as isp |
|
27 | from IPython.core import inputsplitter as isp | |
23 |
|
28 | |||
24 | #----------------------------------------------------------------------------- |
|
29 | #----------------------------------------------------------------------------- | |
25 | # Semi-complete examples (also used as tests) |
|
30 | # Semi-complete examples (also used as tests) | |
26 | #----------------------------------------------------------------------------- |
|
31 | #----------------------------------------------------------------------------- | |
27 |
|
32 | |||
28 | # Note: at the bottom, there's a slightly more complete version of this that |
|
33 | # Note: at the bottom, there's a slightly more complete version of this that | |
29 | # can be useful during development of code here. |
|
34 | # can be useful during development of code here. | |
30 |
|
35 | |||
31 | def mini_interactive_loop(input_func): |
|
36 | def mini_interactive_loop(input_func): | |
32 | """Minimal example of the logic of an interactive interpreter loop. |
|
37 | """Minimal example of the logic of an interactive interpreter loop. | |
33 |
|
38 | |||
34 | This serves as an example, and it is used by the test system with a fake |
|
39 | This serves as an example, and it is used by the test system with a fake | |
35 | raw_input that simulates interactive input.""" |
|
40 | raw_input that simulates interactive input.""" | |
36 |
|
41 | |||
37 | from IPython.core.inputsplitter import InputSplitter |
|
42 | from IPython.core.inputsplitter import InputSplitter | |
38 |
|
43 | |||
39 | isp = InputSplitter() |
|
44 | isp = InputSplitter() | |
40 | # In practice, this input loop would be wrapped in an outside loop to read |
|
45 | # In practice, this input loop would be wrapped in an outside loop to read | |
41 | # input indefinitely, until some exit/quit command was issued. Here we |
|
46 | # input indefinitely, until some exit/quit command was issued. Here we | |
42 | # only illustrate the basic inner loop. |
|
47 | # only illustrate the basic inner loop. | |
43 | while isp.push_accepts_more(): |
|
48 | while isp.push_accepts_more(): | |
44 | indent = ' '*isp.indent_spaces |
|
49 | indent = ' '*isp.indent_spaces | |
45 | prompt = '>>> ' + indent |
|
50 | prompt = '>>> ' + indent | |
46 | line = indent + input_func(prompt) |
|
51 | line = indent + input_func(prompt) | |
47 | isp.push(line) |
|
52 | isp.push(line) | |
48 |
|
53 | |||
49 | # Here we just return input so we can use it in a test suite, but a real |
|
54 | # Here we just return input so we can use it in a test suite, but a real | |
50 | # interpreter would instead send it for execution somewhere. |
|
55 | # interpreter would instead send it for execution somewhere. | |
51 | src = isp.source_reset() |
|
56 | src = isp.source_reset() | |
52 | #print 'Input source was:\n', src # dbg |
|
57 | #print 'Input source was:\n', src # dbg | |
53 | return src |
|
58 | return src | |
54 |
|
59 | |||
55 | #----------------------------------------------------------------------------- |
|
60 | #----------------------------------------------------------------------------- | |
56 | # Test utilities, just for local use |
|
61 | # Test utilities, just for local use | |
57 | #----------------------------------------------------------------------------- |
|
62 | #----------------------------------------------------------------------------- | |
58 |
|
63 | |||
59 | def assemble(block): |
|
64 | def assemble(block): | |
60 | """Assemble a block into multi-line sub-blocks.""" |
|
65 | """Assemble a block into multi-line sub-blocks.""" | |
61 | return ['\n'.join(sub_block)+'\n' for sub_block in block] |
|
66 | return ['\n'.join(sub_block)+'\n' for sub_block in block] | |
62 |
|
67 | |||
63 |
|
68 | |||
64 | def pseudo_input(lines): |
|
69 | def pseudo_input(lines): | |
65 | """Return a function that acts like raw_input but feeds the input list.""" |
|
70 | """Return a function that acts like raw_input but feeds the input list.""" | |
66 | ilines = iter(lines) |
|
71 | ilines = iter(lines) | |
67 | def raw_in(prompt): |
|
72 | def raw_in(prompt): | |
68 | try: |
|
73 | try: | |
69 | return next(ilines) |
|
74 | return next(ilines) | |
70 | except StopIteration: |
|
75 | except StopIteration: | |
71 | return '' |
|
76 | return '' | |
72 | return raw_in |
|
77 | return raw_in | |
73 |
|
78 | |||
74 | #----------------------------------------------------------------------------- |
|
79 | #----------------------------------------------------------------------------- | |
75 | # Tests |
|
80 | # Tests | |
76 | #----------------------------------------------------------------------------- |
|
81 | #----------------------------------------------------------------------------- | |
77 | def test_spaces(): |
|
82 | def test_spaces(): | |
78 | tests = [('', 0), |
|
83 | tests = [('', 0), | |
79 | (' ', 1), |
|
84 | (' ', 1), | |
80 | ('\n', 0), |
|
85 | ('\n', 0), | |
81 | (' \n', 1), |
|
86 | (' \n', 1), | |
82 | ('x', 0), |
|
87 | ('x', 0), | |
83 | (' x', 1), |
|
88 | (' x', 1), | |
84 | (' x',2), |
|
89 | (' x',2), | |
85 | (' x',4), |
|
90 | (' x',4), | |
86 | # Note: tabs are counted as a single whitespace! |
|
91 | # Note: tabs are counted as a single whitespace! | |
87 | ('\tx', 1), |
|
92 | ('\tx', 1), | |
88 | ('\t x', 2), |
|
93 | ('\t x', 2), | |
89 | ] |
|
94 | ] | |
90 |
|
95 | |||
91 | for s, nsp in tests: |
|
96 | for s, nsp in tests: | |
92 | nt.assert_equal(isp.num_ini_spaces(s), nsp) |
|
97 | nt.assert_equal(isp.num_ini_spaces(s), nsp) | |
93 |
|
98 | |||
94 |
|
99 | |||
95 | def test_remove_comments(): |
|
100 | def test_remove_comments(): | |
96 | tests = [('text', 'text'), |
|
101 | tests = [('text', 'text'), | |
97 | ('text # comment', 'text '), |
|
102 | ('text # comment', 'text '), | |
98 | ('text # comment\n', 'text \n'), |
|
103 | ('text # comment\n', 'text \n'), | |
99 | ('text # comment \n', 'text \n'), |
|
104 | ('text # comment \n', 'text \n'), | |
100 | ('line # c \nline\n','line \nline\n'), |
|
105 | ('line # c \nline\n','line \nline\n'), | |
101 | ('line # c \nline#c2 \nline\nline #c\n\n', |
|
106 | ('line # c \nline#c2 \nline\nline #c\n\n', | |
102 | 'line \nline\nline\nline \n\n'), |
|
107 | 'line \nline\nline\nline \n\n'), | |
103 | ] |
|
108 | ] | |
104 |
|
109 | |||
105 | for inp, out in tests: |
|
110 | for inp, out in tests: | |
106 | nt.assert_equal(isp.remove_comments(inp), out) |
|
111 | nt.assert_equal(isp.remove_comments(inp), out) | |
107 |
|
112 | |||
108 |
|
113 | |||
109 | def test_get_input_encoding(): |
|
114 | def test_get_input_encoding(): | |
110 | encoding = isp.get_input_encoding() |
|
115 | encoding = isp.get_input_encoding() | |
111 | nt.assert_true(isinstance(encoding, basestring)) |
|
116 | nt.assert_true(isinstance(encoding, basestring)) | |
112 | # simple-minded check that at least encoding a simple string works with the |
|
117 | # simple-minded check that at least encoding a simple string works with the | |
113 | # encoding we got. |
|
118 | # encoding we got. | |
114 | nt.assert_equal('test'.encode(encoding), 'test') |
|
119 | nt.assert_equal('test'.encode(encoding), 'test') | |
115 |
|
120 | |||
116 |
|
121 | |||
117 | class NoInputEncodingTestCase(unittest.TestCase): |
|
122 | class NoInputEncodingTestCase(unittest.TestCase): | |
118 | def setUp(self): |
|
123 | def setUp(self): | |
119 | self.old_stdin = sys.stdin |
|
124 | self.old_stdin = sys.stdin | |
120 | class X: pass |
|
125 | class X: pass | |
121 | fake_stdin = X() |
|
126 | fake_stdin = X() | |
122 | sys.stdin = fake_stdin |
|
127 | sys.stdin = fake_stdin | |
123 |
|
128 | |||
124 | def test(self): |
|
129 | def test(self): | |
125 | # Verify that if sys.stdin has no 'encoding' attribute we do the right |
|
130 | # Verify that if sys.stdin has no 'encoding' attribute we do the right | |
126 | # thing |
|
131 | # thing | |
127 | enc = isp.get_input_encoding() |
|
132 | enc = isp.get_input_encoding() | |
128 | self.assertEqual(enc, 'ascii') |
|
133 | self.assertEqual(enc, 'ascii') | |
129 |
|
134 | |||
130 | def tearDown(self): |
|
135 | def tearDown(self): | |
131 | sys.stdin = self.old_stdin |
|
136 | sys.stdin = self.old_stdin | |
132 |
|
137 | |||
133 |
|
138 | |||
134 | class InputSplitterTestCase(unittest.TestCase): |
|
139 | class InputSplitterTestCase(unittest.TestCase): | |
135 | def setUp(self): |
|
140 | def setUp(self): | |
136 | self.isp = isp.InputSplitter() |
|
141 | self.isp = isp.InputSplitter() | |
137 |
|
142 | |||
138 | def test_reset(self): |
|
143 | def test_reset(self): | |
139 | isp = self.isp |
|
144 | isp = self.isp | |
140 | isp.push('x=1') |
|
145 | isp.push('x=1') | |
141 | isp.reset() |
|
146 | isp.reset() | |
142 | self.assertEqual(isp._buffer, []) |
|
147 | self.assertEqual(isp._buffer, []) | |
143 | self.assertEqual(isp.indent_spaces, 0) |
|
148 | self.assertEqual(isp.indent_spaces, 0) | |
144 | self.assertEqual(isp.source, '') |
|
149 | self.assertEqual(isp.source, '') | |
145 | self.assertEqual(isp.code, None) |
|
150 | self.assertEqual(isp.code, None) | |
146 | self.assertEqual(isp._is_complete, False) |
|
151 | self.assertEqual(isp._is_complete, False) | |
147 |
|
152 | |||
148 | def test_source(self): |
|
153 | def test_source(self): | |
149 | self.isp._store('1') |
|
154 | self.isp._store('1') | |
150 | self.isp._store('2') |
|
155 | self.isp._store('2') | |
151 | self.assertEqual(self.isp.source, '1\n2\n') |
|
156 | self.assertEqual(self.isp.source, '1\n2\n') | |
152 | self.assertTrue(len(self.isp._buffer)>0) |
|
157 | self.assertTrue(len(self.isp._buffer)>0) | |
153 | self.assertEqual(self.isp.source_reset(), '1\n2\n') |
|
158 | self.assertEqual(self.isp.source_reset(), '1\n2\n') | |
154 | self.assertEqual(self.isp._buffer, []) |
|
159 | self.assertEqual(self.isp._buffer, []) | |
155 | self.assertEqual(self.isp.source, '') |
|
160 | self.assertEqual(self.isp.source, '') | |
156 |
|
161 | |||
157 | def test_indent(self): |
|
162 | def test_indent(self): | |
158 | isp = self.isp # shorthand |
|
163 | isp = self.isp # shorthand | |
159 | isp.push('x=1') |
|
164 | isp.push('x=1') | |
160 | self.assertEqual(isp.indent_spaces, 0) |
|
165 | self.assertEqual(isp.indent_spaces, 0) | |
161 | isp.push('if 1:\n x=1') |
|
166 | isp.push('if 1:\n x=1') | |
162 | self.assertEqual(isp.indent_spaces, 4) |
|
167 | self.assertEqual(isp.indent_spaces, 4) | |
163 | isp.push('y=2\n') |
|
168 | isp.push('y=2\n') | |
164 | self.assertEqual(isp.indent_spaces, 0) |
|
169 | self.assertEqual(isp.indent_spaces, 0) | |
165 |
|
170 | |||
166 | def test_indent2(self): |
|
171 | def test_indent2(self): | |
167 | # In cell mode, inputs must be fed in whole blocks, so skip this test |
|
172 | # In cell mode, inputs must be fed in whole blocks, so skip this test | |
168 | if self.isp.input_mode == 'cell': return |
|
173 | if self.isp.input_mode == 'cell': return | |
169 |
|
174 | |||
170 | isp = self.isp |
|
175 | isp = self.isp | |
171 | isp.push('if 1:') |
|
176 | isp.push('if 1:') | |
172 | self.assertEqual(isp.indent_spaces, 4) |
|
177 | self.assertEqual(isp.indent_spaces, 4) | |
173 | isp.push(' x=1') |
|
178 | isp.push(' x=1') | |
174 | self.assertEqual(isp.indent_spaces, 4) |
|
179 | self.assertEqual(isp.indent_spaces, 4) | |
175 | # Blank lines shouldn't change the indent level |
|
180 | # Blank lines shouldn't change the indent level | |
176 | isp.push(' '*2) |
|
181 | isp.push(' '*2) | |
177 | self.assertEqual(isp.indent_spaces, 4) |
|
182 | self.assertEqual(isp.indent_spaces, 4) | |
178 |
|
183 | |||
179 | def test_indent3(self): |
|
184 | def test_indent3(self): | |
180 | # In cell mode, inputs must be fed in whole blocks, so skip this test |
|
185 | # In cell mode, inputs must be fed in whole blocks, so skip this test | |
181 | if self.isp.input_mode == 'cell': return |
|
186 | if self.isp.input_mode == 'cell': return | |
182 |
|
187 | |||
183 | isp = self.isp |
|
188 | isp = self.isp | |
184 | # When a multiline statement contains parens or multiline strings, we |
|
189 | # When a multiline statement contains parens or multiline strings, we | |
185 | # shouldn't get confused. |
|
190 | # shouldn't get confused. | |
186 | isp.push("if 1:") |
|
191 | isp.push("if 1:") | |
187 | isp.push(" x = (1+\n 2)") |
|
192 | isp.push(" x = (1+\n 2)") | |
188 | self.assertEqual(isp.indent_spaces, 4) |
|
193 | self.assertEqual(isp.indent_spaces, 4) | |
189 |
|
194 | |||
190 | def test_dedent(self): |
|
195 | def test_dedent(self): | |
191 | isp = self.isp # shorthand |
|
196 | isp = self.isp # shorthand | |
192 | isp.push('if 1:') |
|
197 | isp.push('if 1:') | |
193 | self.assertEqual(isp.indent_spaces, 4) |
|
198 | self.assertEqual(isp.indent_spaces, 4) | |
194 | isp.push(' pass') |
|
199 | isp.push(' pass') | |
195 | self.assertEqual(isp.indent_spaces, 0) |
|
200 | self.assertEqual(isp.indent_spaces, 0) | |
196 |
|
201 | |||
197 | def test_push(self): |
|
202 | def test_push(self): | |
198 | isp = self.isp |
|
203 | isp = self.isp | |
199 | self.assertTrue(isp.push('x=1')) |
|
204 | self.assertTrue(isp.push('x=1')) | |
200 |
|
205 | |||
201 | def test_push2(self): |
|
206 | def test_push2(self): | |
202 | isp = self.isp |
|
207 | isp = self.isp | |
203 | self.assertFalse(isp.push('if 1:')) |
|
208 | self.assertFalse(isp.push('if 1:')) | |
204 | for line in [' x=1', '# a comment', ' y=2']: |
|
209 | for line in [' x=1', '# a comment', ' y=2']: | |
205 | self.assertTrue(isp.push(line)) |
|
210 | self.assertTrue(isp.push(line)) | |
206 |
|
211 | |||
207 | def test_replace_mode(self): |
|
212 | def test_replace_mode(self): | |
208 | isp = self.isp |
|
213 | isp = self.isp | |
209 | isp.input_mode = 'cell' |
|
214 | isp.input_mode = 'cell' | |
210 | isp.push('x=1') |
|
215 | isp.push('x=1') | |
211 | self.assertEqual(isp.source, 'x=1\n') |
|
216 | self.assertEqual(isp.source, 'x=1\n') | |
212 | isp.push('x=2') |
|
217 | isp.push('x=2') | |
213 | self.assertEqual(isp.source, 'x=2\n') |
|
218 | self.assertEqual(isp.source, 'x=2\n') | |
214 |
|
219 | |||
215 | def test_push_accepts_more(self): |
|
220 | def test_push_accepts_more(self): | |
216 | isp = self.isp |
|
221 | isp = self.isp | |
217 | isp.push('x=1') |
|
222 | isp.push('x=1') | |
218 | self.assertFalse(isp.push_accepts_more()) |
|
223 | self.assertFalse(isp.push_accepts_more()) | |
219 |
|
224 | |||
220 | def test_push_accepts_more2(self): |
|
225 | def test_push_accepts_more2(self): | |
221 | # In cell mode, inputs must be fed in whole blocks, so skip this test |
|
226 | # In cell mode, inputs must be fed in whole blocks, so skip this test | |
222 | if self.isp.input_mode == 'cell': return |
|
227 | if self.isp.input_mode == 'cell': return | |
223 |
|
228 | |||
224 | isp = self.isp |
|
229 | isp = self.isp | |
225 | isp.push('if 1:') |
|
230 | isp.push('if 1:') | |
226 | self.assertTrue(isp.push_accepts_more()) |
|
231 | self.assertTrue(isp.push_accepts_more()) | |
227 | isp.push(' x=1') |
|
232 | isp.push(' x=1') | |
228 | self.assertTrue(isp.push_accepts_more()) |
|
233 | self.assertTrue(isp.push_accepts_more()) | |
229 | isp.push('') |
|
234 | isp.push('') | |
230 | self.assertFalse(isp.push_accepts_more()) |
|
235 | self.assertFalse(isp.push_accepts_more()) | |
231 |
|
236 | |||
232 | def test_push_accepts_more3(self): |
|
237 | def test_push_accepts_more3(self): | |
233 | isp = self.isp |
|
238 | isp = self.isp | |
234 | isp.push("x = (2+\n3)") |
|
239 | isp.push("x = (2+\n3)") | |
235 | self.assertFalse(isp.push_accepts_more()) |
|
240 | self.assertFalse(isp.push_accepts_more()) | |
236 |
|
241 | |||
237 | def test_push_accepts_more4(self): |
|
242 | def test_push_accepts_more4(self): | |
238 | # In cell mode, inputs must be fed in whole blocks, so skip this test |
|
243 | # In cell mode, inputs must be fed in whole blocks, so skip this test | |
239 | if self.isp.input_mode == 'cell': return |
|
244 | if self.isp.input_mode == 'cell': return | |
240 |
|
245 | |||
241 | isp = self.isp |
|
246 | isp = self.isp | |
242 | # When a multiline statement contains parens or multiline strings, we |
|
247 | # When a multiline statement contains parens or multiline strings, we | |
243 | # shouldn't get confused. |
|
248 | # shouldn't get confused. | |
244 | # FIXME: we should be able to better handle de-dents in statements like |
|
249 | # FIXME: we should be able to better handle de-dents in statements like | |
245 | # multiline strings and multiline expressions (continued with \ or |
|
250 | # multiline strings and multiline expressions (continued with \ or | |
246 | # parens). Right now we aren't handling the indentation tracking quite |
|
251 | # parens). Right now we aren't handling the indentation tracking quite | |
247 | # correctly with this, though in practice it may not be too much of a |
|
252 | # correctly with this, though in practice it may not be too much of a | |
248 | # problem. We'll need to see. |
|
253 | # problem. We'll need to see. | |
249 | isp.push("if 1:") |
|
254 | isp.push("if 1:") | |
250 | isp.push(" x = (2+") |
|
255 | isp.push(" x = (2+") | |
251 | isp.push(" 3)") |
|
256 | isp.push(" 3)") | |
252 | self.assertTrue(isp.push_accepts_more()) |
|
257 | self.assertTrue(isp.push_accepts_more()) | |
253 | isp.push(" y = 3") |
|
258 | isp.push(" y = 3") | |
254 | self.assertTrue(isp.push_accepts_more()) |
|
259 | self.assertTrue(isp.push_accepts_more()) | |
255 | isp.push('') |
|
260 | isp.push('') | |
256 | self.assertFalse(isp.push_accepts_more()) |
|
261 | self.assertFalse(isp.push_accepts_more()) | |
257 |
|
262 | |||
258 | def test_continuation(self): |
|
263 | def test_continuation(self): | |
259 | isp = self.isp |
|
264 | isp = self.isp | |
260 | isp.push("import os, \\") |
|
265 | isp.push("import os, \\") | |
261 | self.assertTrue(isp.push_accepts_more()) |
|
266 | self.assertTrue(isp.push_accepts_more()) | |
262 | isp.push("sys") |
|
267 | isp.push("sys") | |
263 | self.assertFalse(isp.push_accepts_more()) |
|
268 | self.assertFalse(isp.push_accepts_more()) | |
264 |
|
269 | |||
265 | def test_syntax_error(self): |
|
270 | def test_syntax_error(self): | |
266 | isp = self.isp |
|
271 | isp = self.isp | |
267 | # Syntax errors immediately produce a 'ready' block, so the invalid |
|
272 | # Syntax errors immediately produce a 'ready' block, so the invalid | |
268 | # Python can be sent to the kernel for evaluation with possible ipython |
|
273 | # Python can be sent to the kernel for evaluation with possible ipython | |
269 | # special-syntax conversion. |
|
274 | # special-syntax conversion. | |
270 | isp.push('run foo') |
|
275 | isp.push('run foo') | |
271 | self.assertFalse(isp.push_accepts_more()) |
|
276 | self.assertFalse(isp.push_accepts_more()) | |
272 |
|
277 | |||
273 | def check_split(self, block_lines, compile=True): |
|
278 | def check_split(self, block_lines, compile=True): | |
274 | blocks = assemble(block_lines) |
|
279 | blocks = assemble(block_lines) | |
275 | lines = ''.join(blocks) |
|
280 | lines = ''.join(blocks) | |
276 | oblock = self.isp.split_blocks(lines) |
|
281 | oblock = self.isp.split_blocks(lines) | |
277 | self.assertEqual(oblock, blocks) |
|
282 | self.assertEqual(oblock, blocks) | |
278 | if compile: |
|
283 | if compile: | |
279 | for block in blocks: |
|
284 | for block in blocks: | |
280 | self.isp._compile(block) |
|
285 | self.isp._compile(block) | |
281 |
|
286 | |||
282 | def test_split(self): |
|
287 | def test_split(self): | |
283 | # All blocks of input we want to test in a list. The format for each |
|
288 | # All blocks of input we want to test in a list. The format for each | |
284 | # block is a list of lists, with each inner lists consisting of all the |
|
289 | # block is a list of lists, with each inner lists consisting of all the | |
285 | # lines (as single-lines) that should make up a sub-block. |
|
290 | # lines (as single-lines) that should make up a sub-block. | |
286 |
|
291 | |||
287 | # Note: do NOT put here sub-blocks that don't compile, as the |
|
292 | # Note: do NOT put here sub-blocks that don't compile, as the | |
288 | # check_split() routine makes a final verification pass to check that |
|
293 | # check_split() routine makes a final verification pass to check that | |
289 | # each sub_block, as returned by split_blocks(), does compile |
|
294 | # each sub_block, as returned by split_blocks(), does compile | |
290 | # correctly. |
|
295 | # correctly. | |
291 | all_blocks = [ [['x=1']], |
|
296 | all_blocks = [ [['x=1']], | |
292 |
|
297 | |||
293 | [['x=1'], |
|
298 | [['x=1'], | |
294 | ['y=2']], |
|
299 | ['y=2']], | |
295 |
|
300 | |||
296 | [['x=1', |
|
301 | [['x=1', | |
297 | '# a comment'], |
|
302 | '# a comment'], | |
298 | ['y=11']], |
|
303 | ['y=11']], | |
299 |
|
304 | |||
300 | [['if 1:', |
|
305 | [['if 1:', | |
301 | ' x=1'], |
|
306 | ' x=1'], | |
302 | ['y=3']], |
|
307 | ['y=3']], | |
303 |
|
308 | |||
304 | [['def f(x):', |
|
309 | [['def f(x):', | |
305 | ' return x'], |
|
310 | ' return x'], | |
306 | ['x=1']], |
|
311 | ['x=1']], | |
307 |
|
312 | |||
308 | [['def f(x):', |
|
313 | [['def f(x):', | |
309 | ' x+=1', |
|
314 | ' x+=1', | |
310 | ' ', |
|
315 | ' ', | |
311 | ' return x'], |
|
316 | ' return x'], | |
312 | ['x=1']], |
|
317 | ['x=1']], | |
313 |
|
318 | |||
314 | [['def f(x):', |
|
319 | [['def f(x):', | |
315 | ' if x>0:', |
|
320 | ' if x>0:', | |
316 | ' y=1', |
|
321 | ' y=1', | |
317 | ' # a comment', |
|
322 | ' # a comment', | |
318 | ' else:', |
|
323 | ' else:', | |
319 | ' y=4', |
|
324 | ' y=4', | |
320 | ' ', |
|
325 | ' ', | |
321 | ' return y'], |
|
326 | ' return y'], | |
322 | ['x=1'], |
|
327 | ['x=1'], | |
323 | ['if 1:', |
|
328 | ['if 1:', | |
324 | ' y=11'] ], |
|
329 | ' y=11'] ], | |
325 |
|
330 | |||
326 | [['for i in range(10):' |
|
331 | [['for i in range(10):' | |
327 | ' x=i**2']], |
|
332 | ' x=i**2']], | |
328 |
|
333 | |||
329 | [['for i in range(10):' |
|
334 | [['for i in range(10):' | |
330 | ' x=i**2'], |
|
335 | ' x=i**2'], | |
331 | ['z = 1']], |
|
336 | ['z = 1']], | |
332 |
|
337 | |||
333 | [['"asdf"']], |
|
338 | [['"asdf"']], | |
334 |
|
339 | |||
335 | [['"asdf"'], |
|
340 | [['"asdf"'], | |
336 | ['10'], |
|
341 | ['10'], | |
337 | ], |
|
342 | ], | |
338 |
|
343 | |||
339 | [['"""foo', |
|
344 | [['"""foo', | |
340 | 'bar"""']], |
|
345 | 'bar"""']], | |
341 | ] |
|
346 | ] | |
342 | for block_lines in all_blocks: |
|
347 | for block_lines in all_blocks: | |
343 | self.check_split(block_lines) |
|
348 | self.check_split(block_lines) | |
344 |
|
349 | |||
345 | def test_split_syntax_errors(self): |
|
350 | def test_split_syntax_errors(self): | |
346 | # Block splitting with invalid syntax |
|
351 | # Block splitting with invalid syntax | |
347 | all_blocks = [ [['a syntax error']], |
|
352 | all_blocks = [ [['a syntax error']], | |
348 |
|
353 | |||
349 | [['x=1', |
|
354 | [['x=1', | |
350 | 'another syntax error']], |
|
355 | 'another syntax error']], | |
351 |
|
356 | |||
352 | [['for i in range(10):' |
|
357 | [['for i in range(10):' | |
353 | ' yet another error']], |
|
358 | ' yet another error']], | |
354 |
|
359 | |||
355 | ] |
|
360 | ] | |
356 | for block_lines in all_blocks: |
|
361 | for block_lines in all_blocks: | |
357 | self.check_split(block_lines, compile=False) |
|
362 | self.check_split(block_lines, compile=False) | |
358 |
|
363 | |||
359 | def test_unicode(self): |
|
364 | def test_unicode(self): | |
360 | self.isp.push(u"Pérez") |
|
365 | self.isp.push(u"Pérez") | |
361 | self.isp.push(u'\xc3\xa9') |
|
366 | self.isp.push(u'\xc3\xa9') | |
362 | self.isp.push("u'\xc3\xa9'") |
|
367 | self.isp.push("u'\xc3\xa9'") | |
363 |
|
368 | |||
364 | class InteractiveLoopTestCase(unittest.TestCase): |
|
369 | class InteractiveLoopTestCase(unittest.TestCase): | |
365 | """Tests for an interactive loop like a python shell. |
|
370 | """Tests for an interactive loop like a python shell. | |
366 | """ |
|
371 | """ | |
367 | def check_ns(self, lines, ns): |
|
372 | def check_ns(self, lines, ns): | |
368 | """Validate that the given input lines produce the resulting namespace. |
|
373 | """Validate that the given input lines produce the resulting namespace. | |
369 |
|
374 | |||
370 | Note: the input lines are given exactly as they would be typed in an |
|
375 | Note: the input lines are given exactly as they would be typed in an | |
371 | auto-indenting environment, as mini_interactive_loop above already does |
|
376 | auto-indenting environment, as mini_interactive_loop above already does | |
372 | auto-indenting and prepends spaces to the input. |
|
377 | auto-indenting and prepends spaces to the input. | |
373 | """ |
|
378 | """ | |
374 | src = mini_interactive_loop(pseudo_input(lines)) |
|
379 | src = mini_interactive_loop(pseudo_input(lines)) | |
375 | test_ns = {} |
|
380 | test_ns = {} | |
376 | exec src in test_ns |
|
381 | exec src in test_ns | |
377 | # We can't check that the provided ns is identical to the test_ns, |
|
382 | # We can't check that the provided ns is identical to the test_ns, | |
378 | # because Python fills test_ns with extra keys (copyright, etc). But |
|
383 | # because Python fills test_ns with extra keys (copyright, etc). But | |
379 | # we can check that the given dict is *contained* in test_ns |
|
384 | # we can check that the given dict is *contained* in test_ns | |
380 | for k,v in ns.iteritems(): |
|
385 | for k,v in ns.iteritems(): | |
381 | self.assertEqual(test_ns[k], v) |
|
386 | self.assertEqual(test_ns[k], v) | |
382 |
|
387 | |||
383 | def test_simple(self): |
|
388 | def test_simple(self): | |
384 | self.check_ns(['x=1'], dict(x=1)) |
|
389 | self.check_ns(['x=1'], dict(x=1)) | |
385 |
|
390 | |||
386 | def test_simple2(self): |
|
391 | def test_simple2(self): | |
387 | self.check_ns(['if 1:', 'x=2'], dict(x=2)) |
|
392 | self.check_ns(['if 1:', 'x=2'], dict(x=2)) | |
388 |
|
393 | |||
389 | def test_xy(self): |
|
394 | def test_xy(self): | |
390 | self.check_ns(['x=1; y=2'], dict(x=1, y=2)) |
|
395 | self.check_ns(['x=1; y=2'], dict(x=1, y=2)) | |
391 |
|
396 | |||
392 | def test_abc(self): |
|
397 | def test_abc(self): | |
393 | self.check_ns(['if 1:','a=1','b=2','c=3'], dict(a=1, b=2, c=3)) |
|
398 | self.check_ns(['if 1:','a=1','b=2','c=3'], dict(a=1, b=2, c=3)) | |
394 |
|
399 | |||
395 | def test_multi(self): |
|
400 | def test_multi(self): | |
396 | self.check_ns(['x =(1+','1+','2)'], dict(x=4)) |
|
401 | self.check_ns(['x =(1+','1+','2)'], dict(x=4)) | |
397 |
|
402 | |||
398 |
|
403 | |||
399 | def test_LineInfo(): |
|
404 | def test_LineInfo(): | |
400 | """Simple test for LineInfo construction and str()""" |
|
405 | """Simple test for LineInfo construction and str()""" | |
401 | linfo = isp.LineInfo(' %cd /home') |
|
406 | linfo = isp.LineInfo(' %cd /home') | |
402 | nt.assert_equals(str(linfo), 'LineInfo [ |%|cd|/home]') |
|
407 | nt.assert_equals(str(linfo), 'LineInfo [ |%|cd|/home]') | |
403 |
|
408 | |||
404 |
|
409 | |||
405 | def test_split_user_input(): |
|
410 | def test_split_user_input(): | |
406 | """Unicode test - split_user_input already has good doctests""" |
|
411 | """Unicode test - split_user_input already has good doctests""" | |
407 | line = u"Pérez Fernando" |
|
412 | line = u"Pérez Fernando" | |
408 | parts = isp.split_user_input(line) |
|
413 | parts = isp.split_user_input(line) | |
409 | parts_expected = (u'', u'', u'', line) |
|
414 | parts_expected = (u'', u'', u'', line) | |
410 | nt.assert_equal(parts, parts_expected) |
|
415 | nt.assert_equal(parts, parts_expected) | |
411 |
|
416 | |||
412 |
|
417 | |||
413 | # Transformer tests |
|
418 | # Transformer tests | |
414 | def transform_checker(tests, func): |
|
419 | def transform_checker(tests, func): | |
415 | """Utility to loop over test inputs""" |
|
420 | """Utility to loop over test inputs""" | |
416 | for inp, tr in tests: |
|
421 | for inp, tr in tests: | |
417 | nt.assert_equals(func(inp), tr) |
|
422 | nt.assert_equals(func(inp), tr) | |
418 |
|
423 | |||
419 | # Data for all the syntax tests in the form of lists of pairs of |
|
424 | # Data for all the syntax tests in the form of lists of pairs of | |
420 | # raw/transformed input. We store it here as a global dict so that we can use |
|
425 | # raw/transformed input. We store it here as a global dict so that we can use | |
421 | # it both within single-function tests and also to validate the behavior of the |
|
426 | # it both within single-function tests and also to validate the behavior of the | |
422 | # larger objects |
|
427 | # larger objects | |
423 |
|
428 | |||
424 | syntax = \ |
|
429 | syntax = \ | |
425 | dict(assign_system = |
|
430 | dict(assign_system = | |
426 | [('a =! ls', 'a = get_ipython().getoutput("ls")'), |
|
431 | [('a =! ls', 'a = get_ipython().getoutput("ls")'), | |
427 | ('b = !ls', 'b = get_ipython().getoutput("ls")'), |
|
432 | ('b = !ls', 'b = get_ipython().getoutput("ls")'), | |
428 | ('x=1', 'x=1'), # normal input is unmodified |
|
433 | ('x=1', 'x=1'), # normal input is unmodified | |
429 | (' ',' '), # blank lines are kept intact |
|
434 | (' ',' '), # blank lines are kept intact | |
430 | ], |
|
435 | ], | |
431 |
|
436 | |||
432 | assign_magic = |
|
437 | assign_magic = | |
433 | [('a =% who', 'a = get_ipython().magic("who")'), |
|
438 | [('a =% who', 'a = get_ipython().magic("who")'), | |
434 | ('b = %who', 'b = get_ipython().magic("who")'), |
|
439 | ('b = %who', 'b = get_ipython().magic("who")'), | |
435 | ('x=1', 'x=1'), # normal input is unmodified |
|
440 | ('x=1', 'x=1'), # normal input is unmodified | |
436 | (' ',' '), # blank lines are kept intact |
|
441 | (' ',' '), # blank lines are kept intact | |
437 | ], |
|
442 | ], | |
438 |
|
443 | |||
439 | classic_prompt = |
|
444 | classic_prompt = | |
440 | [('>>> x=1', 'x=1'), |
|
445 | [('>>> x=1', 'x=1'), | |
441 | ('x=1', 'x=1'), # normal input is unmodified |
|
446 | ('x=1', 'x=1'), # normal input is unmodified | |
442 | (' ', ' '), # blank lines are kept intact |
|
447 | (' ', ' '), # blank lines are kept intact | |
443 | ('... ', ''), # continuation prompts |
|
448 | ('... ', ''), # continuation prompts | |
444 | ], |
|
449 | ], | |
445 |
|
450 | |||
446 | ipy_prompt = |
|
451 | ipy_prompt = | |
447 | [('In [1]: x=1', 'x=1'), |
|
452 | [('In [1]: x=1', 'x=1'), | |
448 | ('x=1', 'x=1'), # normal input is unmodified |
|
453 | ('x=1', 'x=1'), # normal input is unmodified | |
449 | (' ',' '), # blank lines are kept intact |
|
454 | (' ',' '), # blank lines are kept intact | |
450 | (' ....: ', ''), # continuation prompts |
|
455 | (' ....: ', ''), # continuation prompts | |
451 | ], |
|
456 | ], | |
452 |
|
457 | |||
453 | # Tests for the escape transformer to leave normal code alone |
|
458 | # Tests for the escape transformer to leave normal code alone | |
454 | escaped_noesc = |
|
459 | escaped_noesc = | |
455 | [ (' ', ' '), |
|
460 | [ (' ', ' '), | |
456 | ('x=1', 'x=1'), |
|
461 | ('x=1', 'x=1'), | |
457 | ], |
|
462 | ], | |
458 |
|
463 | |||
459 | # System calls |
|
464 | # System calls | |
460 | escaped_shell = |
|
465 | escaped_shell = | |
461 | [ ('!ls', 'get_ipython().system("ls")'), |
|
466 | [ ('!ls', 'get_ipython().system("ls")'), | |
462 | # Double-escape shell, this means to capture the output of the |
|
467 | # Double-escape shell, this means to capture the output of the | |
463 | # subprocess and return it |
|
468 | # subprocess and return it | |
464 | ('!!ls', 'get_ipython().getoutput("ls")'), |
|
469 | ('!!ls', 'get_ipython().getoutput("ls")'), | |
465 | ], |
|
470 | ], | |
466 |
|
471 | |||
467 | # Help/object info |
|
472 | # Help/object info | |
468 | escaped_help = |
|
473 | escaped_help = | |
469 | [ ('?', 'get_ipython().show_usage()'), |
|
474 | [ ('?', 'get_ipython().show_usage()'), | |
470 | ('?x1', 'get_ipython().magic("pinfo x1")'), |
|
475 | ('?x1', 'get_ipython().magic("pinfo x1")'), | |
471 | ('??x2', 'get_ipython().magic("pinfo2 x2")'), |
|
476 | ('??x2', 'get_ipython().magic("pinfo2 x2")'), | |
472 | ('x3?', 'get_ipython().magic("pinfo x3")'), |
|
477 | ('x3?', 'get_ipython().magic("pinfo x3")'), | |
473 | ('x4??', 'get_ipython().magic("pinfo2 x4")'), |
|
478 | ('x4??', 'get_ipython().magic("pinfo2 x4")'), | |
474 | ('%hist?', 'get_ipython().magic("pinfo %hist")'), |
|
479 | ('%hist?', 'get_ipython().magic("pinfo %hist")'), | |
475 | ('f*?', 'get_ipython().magic("psearch f*")'), |
|
480 | ('f*?', 'get_ipython().magic("psearch f*")'), | |
476 | ('ax.*aspe*?', 'get_ipython().magic("psearch ax.*aspe*")'), |
|
481 | ('ax.*aspe*?', 'get_ipython().magic("psearch ax.*aspe*")'), | |
477 | ], |
|
482 | ], | |
478 |
|
483 | |||
479 | # Explicit magic calls |
|
484 | # Explicit magic calls | |
480 | escaped_magic = |
|
485 | escaped_magic = | |
481 | [ ('%cd', 'get_ipython().magic("cd")'), |
|
486 | [ ('%cd', 'get_ipython().magic("cd")'), | |
482 | ('%cd /home', 'get_ipython().magic("cd /home")'), |
|
487 | ('%cd /home', 'get_ipython().magic("cd /home")'), | |
483 | (' %magic', ' get_ipython().magic("magic")'), |
|
488 | (' %magic', ' get_ipython().magic("magic")'), | |
484 | ], |
|
489 | ], | |
485 |
|
490 | |||
486 | # Quoting with separate arguments |
|
491 | # Quoting with separate arguments | |
487 | escaped_quote = |
|
492 | escaped_quote = | |
488 | [ (',f', 'f("")'), |
|
493 | [ (',f', 'f("")'), | |
489 | (',f x', 'f("x")'), |
|
494 | (',f x', 'f("x")'), | |
490 | (' ,f y', ' f("y")'), |
|
495 | (' ,f y', ' f("y")'), | |
491 | (',f a b', 'f("a", "b")'), |
|
496 | (',f a b', 'f("a", "b")'), | |
492 | ], |
|
497 | ], | |
493 |
|
498 | |||
494 | # Quoting with single argument |
|
499 | # Quoting with single argument | |
495 | escaped_quote2 = |
|
500 | escaped_quote2 = | |
496 | [ (';f', 'f("")'), |
|
501 | [ (';f', 'f("")'), | |
497 | (';f x', 'f("x")'), |
|
502 | (';f x', 'f("x")'), | |
498 | (' ;f y', ' f("y")'), |
|
503 | (' ;f y', ' f("y")'), | |
499 | (';f a b', 'f("a b")'), |
|
504 | (';f a b', 'f("a b")'), | |
500 | ], |
|
505 | ], | |
501 |
|
506 | |||
502 | # Simply apply parens |
|
507 | # Simply apply parens | |
503 | escaped_paren = |
|
508 | escaped_paren = | |
504 | [ ('/f', 'f()'), |
|
509 | [ ('/f', 'f()'), | |
505 | ('/f x', 'f(x)'), |
|
510 | ('/f x', 'f(x)'), | |
506 | (' /f y', ' f(y)'), |
|
511 | (' /f y', ' f(y)'), | |
507 | ('/f a b', 'f(a, b)'), |
|
512 | ('/f a b', 'f(a, b)'), | |
508 | ], |
|
513 | ], | |
509 |
|
514 | |||
510 | ) |
|
515 | ) | |
511 |
|
516 | |||
512 | # multiline syntax examples. Each of these should be a list of lists, with |
|
517 | # multiline syntax examples. Each of these should be a list of lists, with | |
513 | # each entry itself having pairs of raw/transformed input. The union (with |
|
518 | # each entry itself having pairs of raw/transformed input. The union (with | |
514 | # '\n'.join() of the transformed inputs is what the splitter should produce |
|
519 | # '\n'.join() of the transformed inputs is what the splitter should produce | |
515 | # when fed the raw lines one at a time via push. |
|
520 | # when fed the raw lines one at a time via push. | |
516 | syntax_ml = \ |
|
521 | syntax_ml = \ | |
517 | dict(classic_prompt = |
|
522 | dict(classic_prompt = | |
518 | [ [('>>> for i in range(10):','for i in range(10):'), |
|
523 | [ [('>>> for i in range(10):','for i in range(10):'), | |
519 | ('... print i',' print i'), |
|
524 | ('... print i',' print i'), | |
520 | ('... ', ''), |
|
525 | ('... ', ''), | |
521 | ], |
|
526 | ], | |
522 | ], |
|
527 | ], | |
523 |
|
528 | |||
524 | ipy_prompt = |
|
529 | ipy_prompt = | |
525 | [ [('In [24]: for i in range(10):','for i in range(10):'), |
|
530 | [ [('In [24]: for i in range(10):','for i in range(10):'), | |
526 | (' ....: print i',' print i'), |
|
531 | (' ....: print i',' print i'), | |
527 | (' ....: ', ''), |
|
532 | (' ....: ', ''), | |
528 | ], |
|
533 | ], | |
529 | ], |
|
534 | ], | |
530 | ) |
|
535 | ) | |
531 |
|
536 | |||
532 |
|
537 | |||
533 | def test_assign_system(): |
|
538 | def test_assign_system(): | |
534 | transform_checker(syntax['assign_system'], isp.transform_assign_system) |
|
539 | transform_checker(syntax['assign_system'], isp.transform_assign_system) | |
535 |
|
540 | |||
536 |
|
541 | |||
537 | def test_assign_magic(): |
|
542 | def test_assign_magic(): | |
538 | transform_checker(syntax['assign_magic'], isp.transform_assign_magic) |
|
543 | transform_checker(syntax['assign_magic'], isp.transform_assign_magic) | |
539 |
|
544 | |||
540 |
|
545 | |||
541 | def test_classic_prompt(): |
|
546 | def test_classic_prompt(): | |
542 | transform_checker(syntax['classic_prompt'], isp.transform_classic_prompt) |
|
547 | transform_checker(syntax['classic_prompt'], isp.transform_classic_prompt) | |
543 | for example in syntax_ml['classic_prompt']: |
|
548 | for example in syntax_ml['classic_prompt']: | |
544 | transform_checker(example, isp.transform_classic_prompt) |
|
549 | transform_checker(example, isp.transform_classic_prompt) | |
545 |
|
550 | |||
546 |
|
551 | |||
547 | def test_ipy_prompt(): |
|
552 | def test_ipy_prompt(): | |
548 | transform_checker(syntax['ipy_prompt'], isp.transform_ipy_prompt) |
|
553 | transform_checker(syntax['ipy_prompt'], isp.transform_ipy_prompt) | |
549 | for example in syntax_ml['ipy_prompt']: |
|
554 | for example in syntax_ml['ipy_prompt']: | |
550 | transform_checker(example, isp.transform_ipy_prompt) |
|
555 | transform_checker(example, isp.transform_ipy_prompt) | |
551 |
|
556 | |||
552 |
|
557 | |||
553 | def test_escaped_noesc(): |
|
558 | def test_escaped_noesc(): | |
554 | transform_checker(syntax['escaped_noesc'], isp.transform_escaped) |
|
559 | transform_checker(syntax['escaped_noesc'], isp.transform_escaped) | |
555 |
|
560 | |||
556 |
|
561 | |||
557 | def test_escaped_shell(): |
|
562 | def test_escaped_shell(): | |
558 | transform_checker(syntax['escaped_shell'], isp.transform_escaped) |
|
563 | transform_checker(syntax['escaped_shell'], isp.transform_escaped) | |
559 |
|
564 | |||
560 |
|
565 | |||
561 | def test_escaped_help(): |
|
566 | def test_escaped_help(): | |
562 | transform_checker(syntax['escaped_help'], isp.transform_escaped) |
|
567 | transform_checker(syntax['escaped_help'], isp.transform_escaped) | |
563 |
|
568 | |||
564 |
|
569 | |||
565 | def test_escaped_magic(): |
|
570 | def test_escaped_magic(): | |
566 | transform_checker(syntax['escaped_magic'], isp.transform_escaped) |
|
571 | transform_checker(syntax['escaped_magic'], isp.transform_escaped) | |
567 |
|
572 | |||
568 |
|
573 | |||
569 | def test_escaped_quote(): |
|
574 | def test_escaped_quote(): | |
570 | transform_checker(syntax['escaped_quote'], isp.transform_escaped) |
|
575 | transform_checker(syntax['escaped_quote'], isp.transform_escaped) | |
571 |
|
576 | |||
572 |
|
577 | |||
573 | def test_escaped_quote2(): |
|
578 | def test_escaped_quote2(): | |
574 | transform_checker(syntax['escaped_quote2'], isp.transform_escaped) |
|
579 | transform_checker(syntax['escaped_quote2'], isp.transform_escaped) | |
575 |
|
580 | |||
576 |
|
581 | |||
577 | def test_escaped_paren(): |
|
582 | def test_escaped_paren(): | |
578 | transform_checker(syntax['escaped_paren'], isp.transform_escaped) |
|
583 | transform_checker(syntax['escaped_paren'], isp.transform_escaped) | |
579 |
|
584 | |||
580 |
|
585 | |||
581 | class IPythonInputTestCase(InputSplitterTestCase): |
|
586 | class IPythonInputTestCase(InputSplitterTestCase): | |
582 | """By just creating a new class whose .isp is a different instance, we |
|
587 | """By just creating a new class whose .isp is a different instance, we | |
583 | re-run the same test battery on the new input splitter. |
|
588 | re-run the same test battery on the new input splitter. | |
584 |
|
589 | |||
585 | In addition, this runs the tests over the syntax and syntax_ml dicts that |
|
590 | In addition, this runs the tests over the syntax and syntax_ml dicts that | |
586 | were tested by individual functions, as part of the OO interface. |
|
591 | were tested by individual functions, as part of the OO interface. | |
587 |
|
592 | |||
588 | It also makes some checks on the raw buffer storage. |
|
593 | It also makes some checks on the raw buffer storage. | |
589 | """ |
|
594 | """ | |
590 |
|
595 | |||
591 | def setUp(self): |
|
596 | def setUp(self): | |
592 | self.isp = isp.IPythonInputSplitter(input_mode='line') |
|
597 | self.isp = isp.IPythonInputSplitter(input_mode='line') | |
593 |
|
598 | |||
594 | def test_syntax(self): |
|
599 | def test_syntax(self): | |
595 | """Call all single-line syntax tests from the main object""" |
|
600 | """Call all single-line syntax tests from the main object""" | |
596 | isp = self.isp |
|
601 | isp = self.isp | |
597 | for example in syntax.itervalues(): |
|
602 | for example in syntax.itervalues(): | |
598 | for raw, out_t in example: |
|
603 | for raw, out_t in example: | |
599 | if raw.startswith(' '): |
|
604 | if raw.startswith(' '): | |
600 | continue |
|
605 | continue | |
601 |
|
606 | |||
602 | isp.push(raw) |
|
607 | isp.push(raw) | |
603 | out, out_raw = isp.source_raw_reset() |
|
608 | out, out_raw = isp.source_raw_reset() | |
604 | self.assertEqual(out.rstrip(), out_t) |
|
609 | self.assertEqual(out.rstrip(), out_t) | |
605 | self.assertEqual(out_raw.rstrip(), raw.rstrip()) |
|
610 | self.assertEqual(out_raw.rstrip(), raw.rstrip()) | |
606 |
|
611 | |||
607 | def test_syntax_multiline(self): |
|
612 | def test_syntax_multiline(self): | |
608 | isp = self.isp |
|
613 | isp = self.isp | |
609 | for example in syntax_ml.itervalues(): |
|
614 | for example in syntax_ml.itervalues(): | |
610 | out_t_parts = [] |
|
615 | out_t_parts = [] | |
611 | raw_parts = [] |
|
616 | raw_parts = [] | |
612 | for line_pairs in example: |
|
617 | for line_pairs in example: | |
613 | for lraw, out_t_part in line_pairs: |
|
618 | for lraw, out_t_part in line_pairs: | |
614 | isp.push(lraw) |
|
619 | isp.push(lraw) | |
615 | out_t_parts.append(out_t_part) |
|
620 | out_t_parts.append(out_t_part) | |
616 | raw_parts.append(lraw) |
|
621 | raw_parts.append(lraw) | |
617 |
|
622 | |||
618 | out, out_raw = isp.source_raw_reset() |
|
623 | out, out_raw = isp.source_raw_reset() | |
619 | out_t = '\n'.join(out_t_parts).rstrip() |
|
624 | out_t = '\n'.join(out_t_parts).rstrip() | |
620 | raw = '\n'.join(raw_parts).rstrip() |
|
625 | raw = '\n'.join(raw_parts).rstrip() | |
621 | self.assertEqual(out.rstrip(), out_t) |
|
626 | self.assertEqual(out.rstrip(), out_t) | |
622 | self.assertEqual(out_raw.rstrip(), raw) |
|
627 | self.assertEqual(out_raw.rstrip(), raw) | |
623 |
|
628 | |||
624 |
|
629 | |||
625 | class BlockIPythonInputTestCase(IPythonInputTestCase): |
|
630 | class BlockIPythonInputTestCase(IPythonInputTestCase): | |
626 |
|
631 | |||
627 | # Deactivate tests that don't make sense for the block mode |
|
632 | # Deactivate tests that don't make sense for the block mode | |
628 | test_push3 = test_split = lambda s: None |
|
633 | test_push3 = test_split = lambda s: None | |
629 |
|
634 | |||
630 | def setUp(self): |
|
635 | def setUp(self): | |
631 | self.isp = isp.IPythonInputSplitter(input_mode='cell') |
|
636 | self.isp = isp.IPythonInputSplitter(input_mode='cell') | |
632 |
|
637 | |||
633 | def test_syntax_multiline(self): |
|
638 | def test_syntax_multiline(self): | |
634 | isp = self.isp |
|
639 | isp = self.isp | |
635 | for example in syntax_ml.itervalues(): |
|
640 | for example in syntax_ml.itervalues(): | |
636 | raw_parts = [] |
|
641 | raw_parts = [] | |
637 | out_t_parts = [] |
|
642 | out_t_parts = [] | |
638 | for line_pairs in example: |
|
643 | for line_pairs in example: | |
639 | for raw, out_t_part in line_pairs: |
|
644 | for raw, out_t_part in line_pairs: | |
640 | raw_parts.append(raw) |
|
645 | raw_parts.append(raw) | |
641 | out_t_parts.append(out_t_part) |
|
646 | out_t_parts.append(out_t_part) | |
642 |
|
647 | |||
643 | raw = '\n'.join(raw_parts) |
|
648 | raw = '\n'.join(raw_parts) | |
644 | out_t = '\n'.join(out_t_parts) |
|
649 | out_t = '\n'.join(out_t_parts) | |
645 |
|
650 | |||
646 | isp.push(raw) |
|
651 | isp.push(raw) | |
647 | out, out_raw = isp.source_raw_reset() |
|
652 | out, out_raw = isp.source_raw_reset() | |
648 | # Match ignoring trailing whitespace |
|
653 | # Match ignoring trailing whitespace | |
649 | self.assertEqual(out.rstrip(), out_t.rstrip()) |
|
654 | self.assertEqual(out.rstrip(), out_t.rstrip()) | |
650 | self.assertEqual(out_raw.rstrip(), raw.rstrip()) |
|
655 | self.assertEqual(out_raw.rstrip(), raw.rstrip()) | |
651 |
|
656 | |||
652 |
|
657 | |||
653 | #----------------------------------------------------------------------------- |
|
658 | #----------------------------------------------------------------------------- | |
654 | # Main - use as a script, mostly for developer experiments |
|
659 | # Main - use as a script, mostly for developer experiments | |
655 | #----------------------------------------------------------------------------- |
|
660 | #----------------------------------------------------------------------------- | |
656 |
|
661 | |||
657 | if __name__ == '__main__': |
|
662 | if __name__ == '__main__': | |
658 | # A simple demo for interactive experimentation. This code will not get |
|
663 | # A simple demo for interactive experimentation. This code will not get | |
659 | # picked up by any test suite. |
|
664 | # picked up by any test suite. | |
660 | from IPython.core.inputsplitter import InputSplitter, IPythonInputSplitter |
|
665 | from IPython.core.inputsplitter import InputSplitter, IPythonInputSplitter | |
661 |
|
666 | |||
662 | # configure here the syntax to use, prompt and whether to autoindent |
|
667 | # configure here the syntax to use, prompt and whether to autoindent | |
663 | #isp, start_prompt = InputSplitter(), '>>> ' |
|
668 | #isp, start_prompt = InputSplitter(), '>>> ' | |
664 | isp, start_prompt = IPythonInputSplitter(), 'In> ' |
|
669 | isp, start_prompt = IPythonInputSplitter(), 'In> ' | |
665 |
|
670 | |||
666 | autoindent = True |
|
671 | autoindent = True | |
667 | #autoindent = False |
|
672 | #autoindent = False | |
668 |
|
673 | |||
669 | try: |
|
674 | try: | |
670 | while True: |
|
675 | while True: | |
671 | prompt = start_prompt |
|
676 | prompt = start_prompt | |
672 | while isp.push_accepts_more(): |
|
677 | while isp.push_accepts_more(): | |
673 | indent = ' '*isp.indent_spaces |
|
678 | indent = ' '*isp.indent_spaces | |
674 | if autoindent: |
|
679 | if autoindent: | |
675 | line = indent + raw_input(prompt+indent) |
|
680 | line = indent + raw_input(prompt+indent) | |
676 | else: |
|
681 | else: | |
677 | line = raw_input(prompt) |
|
682 | line = raw_input(prompt) | |
678 | isp.push(line) |
|
683 | isp.push(line) | |
679 | prompt = '... ' |
|
684 | prompt = '... ' | |
680 |
|
685 | |||
681 | # Here we just return input so we can use it in a test suite, but a |
|
686 | # Here we just return input so we can use it in a test suite, but a | |
682 | # real interpreter would instead send it for execution somewhere. |
|
687 | # real interpreter would instead send it for execution somewhere. | |
683 | #src = isp.source; raise EOFError # dbg |
|
688 | #src = isp.source; raise EOFError # dbg | |
684 | src, raw = isp.source_raw_reset() |
|
689 | src, raw = isp.source_raw_reset() | |
685 | print 'Input source was:\n', src |
|
690 | print 'Input source was:\n', src | |
686 | print 'Raw source was:\n', raw |
|
691 | print 'Raw source was:\n', raw | |
687 | except EOFError: |
|
692 | except EOFError: | |
688 | print 'Bye' |
|
693 | print 'Bye' |
@@ -1,182 +1,195 b'' | |||||
1 | """Global IPython app to support test running. |
|
1 | """Global IPython app to support test running. | |
2 |
|
2 | |||
3 | We must start our own ipython object and heavily muck with it so that all the |
|
3 | We must start our own ipython object and heavily muck with it so that all the | |
4 | modifications IPython makes to system behavior don't send the doctest machinery |
|
4 | modifications IPython makes to system behavior don't send the doctest machinery | |
5 | into a fit. This code should be considered a gross hack, but it gets the job |
|
5 | into a fit. This code should be considered a gross hack, but it gets the job | |
6 | done. |
|
6 | done. | |
7 | """ |
|
7 | """ | |
8 | from __future__ import absolute_import |
|
8 | from __future__ import absolute_import | |
9 | from __future__ import print_function |
|
9 | from __future__ import print_function | |
10 |
|
10 | |||
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 | # Copyright (C) 2009-2010 The IPython Development Team |
|
12 | # Copyright (C) 2009-2010 The IPython Development Team | |
13 | # |
|
13 | # | |
14 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | # Distributed under the terms of the BSD License. The full license is in | |
15 | # the file COPYING, distributed as part of this software. |
|
15 | # the file COPYING, distributed as part of this software. | |
16 | #----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
19 | # Imports |
|
19 | # Imports | |
20 | #----------------------------------------------------------------------------- |
|
20 | #----------------------------------------------------------------------------- | |
21 |
|
21 | |||
22 | # stdlib |
|
22 | # stdlib | |
23 | import __builtin__ |
|
23 | import __builtin__ | |
24 | import os |
|
24 | import os | |
25 | import sys |
|
25 | import sys | |
26 | from types import MethodType |
|
26 | from types import MethodType | |
27 |
|
27 | |||
28 | # our own |
|
28 | # our own | |
29 | from . import tools |
|
29 | from . import tools | |
30 |
|
30 | |||
31 | from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell |
|
31 | from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell | |
32 |
|
32 | |||
33 | #----------------------------------------------------------------------------- |
|
33 | #----------------------------------------------------------------------------- | |
34 | # Functions |
|
34 | # Functions | |
35 | #----------------------------------------------------------------------------- |
|
35 | #----------------------------------------------------------------------------- | |
36 |
|
36 | |||
37 | # Hack to modify the %run command so we can sync the user's namespace with the |
|
37 | # Hack to modify the %run command so we can sync the user's namespace with the | |
38 | # test globals. Once we move over to a clean magic system, this will be done |
|
38 | # test globals. Once we move over to a clean magic system, this will be done | |
39 | # with much less ugliness. |
|
39 | # with much less ugliness. | |
40 |
|
40 | |||
41 | class py_file_finder(object): |
|
41 | class py_file_finder(object): | |
42 | def __init__(self,test_filename): |
|
42 | def __init__(self,test_filename): | |
43 | self.test_filename = test_filename |
|
43 | self.test_filename = test_filename | |
44 |
|
44 | |||
45 | def __call__(self,name): |
|
45 | def __call__(self,name): | |
46 | from IPython.utils.path import get_py_filename |
|
46 | from IPython.utils.path import get_py_filename | |
47 | try: |
|
47 | try: | |
48 | return get_py_filename(name) |
|
48 | return get_py_filename(name) | |
49 | except IOError: |
|
49 | except IOError: | |
50 | test_dir = os.path.dirname(self.test_filename) |
|
50 | test_dir = os.path.dirname(self.test_filename) | |
51 | new_path = os.path.join(test_dir,name) |
|
51 | new_path = os.path.join(test_dir,name) | |
52 | return get_py_filename(new_path) |
|
52 | return get_py_filename(new_path) | |
53 |
|
53 | |||
54 |
|
54 | |||
55 | def _run_ns_sync(self,arg_s,runner=None): |
|
55 | def _run_ns_sync(self,arg_s,runner=None): | |
56 | """Modified version of %run that syncs testing namespaces. |
|
56 | """Modified version of %run that syncs testing namespaces. | |
57 |
|
57 | |||
58 | This is strictly needed for running doctests that call %run. |
|
58 | This is strictly needed for running doctests that call %run. | |
59 | """ |
|
59 | """ | |
60 | #print('in run_ns_sync', arg_s, file=sys.stderr) # dbg |
|
60 | #print('in run_ns_sync', arg_s, file=sys.stderr) # dbg | |
61 | finder = py_file_finder(arg_s) |
|
61 | finder = py_file_finder(arg_s) | |
62 | return get_ipython().magic_run_ori(arg_s, runner, finder) |
|
62 | return get_ipython().magic_run_ori(arg_s, runner, finder) | |
63 |
|
63 | |||
64 |
|
64 | |||
65 | class ipnsdict(dict): |
|
65 | class ipnsdict(dict): | |
66 | """A special subclass of dict for use as an IPython namespace in doctests. |
|
66 | """A special subclass of dict for use as an IPython namespace in doctests. | |
67 |
|
67 | |||
68 | This subclass adds a simple checkpointing capability so that when testing |
|
68 | This subclass adds a simple checkpointing capability so that when testing | |
69 | machinery clears it (we use it as the test execution context), it doesn't |
|
69 | machinery clears it (we use it as the test execution context), it doesn't | |
70 | get completely destroyed. |
|
70 | get completely destroyed. | |
|
71 | ||||
|
72 | In addition, it can handle the presence of the '_' key in a special manner, | |||
|
73 | which is needed because of how Python's doctest machinery operates with | |||
|
74 | '_'. See constructor and :meth:`update` for details. | |||
71 | """ |
|
75 | """ | |
72 |
|
76 | |||
73 | def __init__(self,*a): |
|
77 | def __init__(self,*a): | |
74 | dict.__init__(self,*a) |
|
78 | dict.__init__(self,*a) | |
75 | self._savedict = {} |
|
79 | self._savedict = {} | |
|
80 | # If this flag is True, the .update() method will unconditionally | |||
|
81 | # remove a key named '_'. This is so that such a dict can be used as a | |||
|
82 | # namespace in doctests that call '_'. | |||
|
83 | self.protect_underscore = False | |||
76 |
|
84 | |||
77 | def clear(self): |
|
85 | def clear(self): | |
78 | dict.clear(self) |
|
86 | dict.clear(self) | |
79 | self.update(self._savedict) |
|
87 | self.update(self._savedict) | |
80 |
|
88 | |||
81 | def _checkpoint(self): |
|
89 | def _checkpoint(self): | |
82 | self._savedict.clear() |
|
90 | self._savedict.clear() | |
83 | self._savedict.update(self) |
|
91 | self._savedict.update(self) | |
84 |
|
92 | |||
85 | def update(self,other): |
|
93 | def update(self,other): | |
86 | self._checkpoint() |
|
94 | self._checkpoint() | |
87 | dict.update(self,other) |
|
95 | dict.update(self,other) | |
88 |
|
96 | |||
89 | # If '_' is in the namespace, python won't set it when executing code, |
|
97 | if self.protect_underscore: | |
90 | # and we have examples that test it. So we ensure that the namespace |
|
98 | # If '_' is in the namespace, python won't set it when executing | |
91 | # is always 'clean' of it before it's used for test code execution. |
|
99 | # code *in doctests*, and we have multiple doctests that use '_'. | |
92 | self.pop('_',None) |
|
100 | # So we ensure that the namespace is always 'clean' of it before | |
|
101 | # it's used for test code execution. | |||
|
102 | # This flag is only turned on by the doctest machinery, so that | |||
|
103 | # normal test code can assume the _ key is updated like any other | |||
|
104 | # key and can test for its presence after cell executions. | |||
|
105 | self.pop('_', None) | |||
93 |
|
106 | |||
94 | # The builtins namespace must *always* be the real __builtin__ module, |
|
107 | # The builtins namespace must *always* be the real __builtin__ module, | |
95 | # else weird stuff happens. The main ipython code does have provisions |
|
108 | # else weird stuff happens. The main ipython code does have provisions | |
96 | # to ensure this after %run, but since in this class we do some |
|
109 | # to ensure this after %run, but since in this class we do some | |
97 | # aggressive low-level cleaning of the execution namespace, we need to |
|
110 | # aggressive low-level cleaning of the execution namespace, we need to | |
98 | # correct for that ourselves, to ensure consitency with the 'real' |
|
111 | # correct for that ourselves, to ensure consitency with the 'real' | |
99 | # ipython. |
|
112 | # ipython. | |
100 | self['__builtins__'] = __builtin__ |
|
113 | self['__builtins__'] = __builtin__ | |
101 |
|
114 | |||
102 |
|
115 | |||
103 | def get_ipython(): |
|
116 | def get_ipython(): | |
104 | # This will get replaced by the real thing once we start IPython below |
|
117 | # This will get replaced by the real thing once we start IPython below | |
105 | return start_ipython() |
|
118 | return start_ipython() | |
106 |
|
119 | |||
107 |
|
120 | |||
108 | # A couple of methods to override those in the running IPython to interact |
|
121 | # A couple of methods to override those in the running IPython to interact | |
109 | # better with doctest (doctest captures on raw stdout, so we need to direct |
|
122 | # better with doctest (doctest captures on raw stdout, so we need to direct | |
110 | # various types of output there otherwise it will miss them). |
|
123 | # various types of output there otherwise it will miss them). | |
111 |
|
124 | |||
112 | def xsys(self, cmd): |
|
125 | def xsys(self, cmd): | |
113 | """Replace the default system call with a capturing one for doctest. |
|
126 | """Replace the default system call with a capturing one for doctest. | |
114 | """ |
|
127 | """ | |
115 | # We use getoutput, but we need to strip it because pexpect captures |
|
128 | # We use getoutput, but we need to strip it because pexpect captures | |
116 | # the trailing newline differently from commands.getoutput |
|
129 | # the trailing newline differently from commands.getoutput | |
117 | print(self.getoutput(cmd, split=False).rstrip(), end='', file=sys.stdout) |
|
130 | print(self.getoutput(cmd, split=False).rstrip(), end='', file=sys.stdout) | |
118 | sys.stdout.flush() |
|
131 | sys.stdout.flush() | |
119 |
|
132 | |||
120 |
|
133 | |||
121 | def _showtraceback(self, etype, evalue, stb): |
|
134 | def _showtraceback(self, etype, evalue, stb): | |
122 | """Print the traceback purely on stdout for doctest to capture it. |
|
135 | """Print the traceback purely on stdout for doctest to capture it. | |
123 | """ |
|
136 | """ | |
124 | print(self.InteractiveTB.stb2text(stb), file=sys.stdout) |
|
137 | print(self.InteractiveTB.stb2text(stb), file=sys.stdout) | |
125 |
|
138 | |||
126 |
|
139 | |||
127 | def start_ipython(): |
|
140 | def start_ipython(): | |
128 | """Start a global IPython shell, which we need for IPython-specific syntax. |
|
141 | """Start a global IPython shell, which we need for IPython-specific syntax. | |
129 | """ |
|
142 | """ | |
130 | global get_ipython |
|
143 | global get_ipython | |
131 |
|
144 | |||
132 | # This function should only ever run once! |
|
145 | # This function should only ever run once! | |
133 | if hasattr(start_ipython, 'already_called'): |
|
146 | if hasattr(start_ipython, 'already_called'): | |
134 | return |
|
147 | return | |
135 | start_ipython.already_called = True |
|
148 | start_ipython.already_called = True | |
136 |
|
149 | |||
137 | # Store certain global objects that IPython modifies |
|
150 | # Store certain global objects that IPython modifies | |
138 | _displayhook = sys.displayhook |
|
151 | _displayhook = sys.displayhook | |
139 | _excepthook = sys.excepthook |
|
152 | _excepthook = sys.excepthook | |
140 | _main = sys.modules.get('__main__') |
|
153 | _main = sys.modules.get('__main__') | |
141 |
|
154 | |||
142 | # Create custom argv and namespaces for our IPython to be test-friendly |
|
155 | # Create custom argv and namespaces for our IPython to be test-friendly | |
143 | config = tools.default_config() |
|
156 | config = tools.default_config() | |
144 |
|
157 | |||
145 | # Create and initialize our test-friendly IPython instance. |
|
158 | # Create and initialize our test-friendly IPython instance. | |
146 | shell = TerminalInteractiveShell.instance(config=config, |
|
159 | shell = TerminalInteractiveShell.instance(config=config, | |
147 | user_ns=ipnsdict(), |
|
160 | user_ns=ipnsdict(), | |
148 | user_global_ns={} |
|
161 | user_global_ns={} | |
149 | ) |
|
162 | ) | |
150 |
|
163 | |||
151 | # A few more tweaks needed for playing nicely with doctests... |
|
164 | # A few more tweaks needed for playing nicely with doctests... | |
152 |
|
165 | |||
153 | # These traps are normally only active for interactive use, set them |
|
166 | # These traps are normally only active for interactive use, set them | |
154 | # permanently since we'll be mocking interactive sessions. |
|
167 | # permanently since we'll be mocking interactive sessions. | |
155 | shell.builtin_trap.activate() |
|
168 | shell.builtin_trap.activate() | |
156 |
|
169 | |||
157 | # Modify the IPython system call with one that uses getoutput, so that we |
|
170 | # Modify the IPython system call with one that uses getoutput, so that we | |
158 | # can capture subcommands and print them to Python's stdout, otherwise the |
|
171 | # can capture subcommands and print them to Python's stdout, otherwise the | |
159 | # doctest machinery would miss them. |
|
172 | # doctest machinery would miss them. | |
160 | shell.system = MethodType(xsys, shell, TerminalInteractiveShell) |
|
173 | shell.system = MethodType(xsys, shell, TerminalInteractiveShell) | |
161 |
|
174 | |||
162 |
|
175 | |||
163 | shell._showtraceback = MethodType(_showtraceback, shell, |
|
176 | shell._showtraceback = MethodType(_showtraceback, shell, | |
164 | TerminalInteractiveShell) |
|
177 | TerminalInteractiveShell) | |
165 |
|
178 | |||
166 | # IPython is ready, now clean up some global state... |
|
179 | # IPython is ready, now clean up some global state... | |
167 |
|
180 | |||
168 | # Deactivate the various python system hooks added by ipython for |
|
181 | # Deactivate the various python system hooks added by ipython for | |
169 | # interactive convenience so we don't confuse the doctest system |
|
182 | # interactive convenience so we don't confuse the doctest system | |
170 | sys.modules['__main__'] = _main |
|
183 | sys.modules['__main__'] = _main | |
171 | sys.displayhook = _displayhook |
|
184 | sys.displayhook = _displayhook | |
172 | sys.excepthook = _excepthook |
|
185 | sys.excepthook = _excepthook | |
173 |
|
186 | |||
174 | # So that ipython magics and aliases can be doctested (they work by making |
|
187 | # So that ipython magics and aliases can be doctested (they work by making | |
175 | # a call into a global _ip object). Also make the top-level get_ipython |
|
188 | # a call into a global _ip object). Also make the top-level get_ipython | |
176 | # now return this without recursively calling here again. |
|
189 | # now return this without recursively calling here again. | |
177 | _ip = shell |
|
190 | _ip = shell | |
178 | get_ipython = _ip.get_ipython |
|
191 | get_ipython = _ip.get_ipython | |
179 | __builtin__._ip = _ip |
|
192 | __builtin__._ip = _ip | |
180 | __builtin__.get_ipython = get_ipython |
|
193 | __builtin__.get_ipython = get_ipython | |
181 |
|
194 | |||
182 | return _ip |
|
195 | return _ip |
@@ -1,188 +1,184 b'' | |||||
1 | """Experimental code for cleaner support of IPython syntax with unittest. |
|
1 | """Experimental code for cleaner support of IPython syntax with unittest. | |
2 |
|
2 | |||
3 | In IPython up until 0.10, we've used very hacked up nose machinery for running |
|
3 | In IPython up until 0.10, we've used very hacked up nose machinery for running | |
4 | tests with IPython special syntax, and this has proved to be extremely slow. |
|
4 | tests with IPython special syntax, and this has proved to be extremely slow. | |
5 | This module provides decorators to try a different approach, stemming from a |
|
5 | This module provides decorators to try a different approach, stemming from a | |
6 | conversation Brian and I (FP) had about this problem Sept/09. |
|
6 | conversation Brian and I (FP) had about this problem Sept/09. | |
7 |
|
7 | |||
8 | The goal is to be able to easily write simple functions that can be seen by |
|
8 | The goal is to be able to easily write simple functions that can be seen by | |
9 | unittest as tests, and ultimately for these to support doctests with full |
|
9 | unittest as tests, and ultimately for these to support doctests with full | |
10 | IPython syntax. Nose already offers this based on naming conventions and our |
|
10 | IPython syntax. Nose already offers this based on naming conventions and our | |
11 | hackish plugins, but we are seeking to move away from nose dependencies if |
|
11 | hackish plugins, but we are seeking to move away from nose dependencies if | |
12 | possible. |
|
12 | possible. | |
13 |
|
13 | |||
14 | This module follows a different approach, based on decorators. |
|
14 | This module follows a different approach, based on decorators. | |
15 |
|
15 | |||
16 | - A decorator called @ipdoctest can mark any function as having a docstring |
|
16 | - A decorator called @ipdoctest can mark any function as having a docstring | |
17 | that should be viewed as a doctest, but after syntax conversion. |
|
17 | that should be viewed as a doctest, but after syntax conversion. | |
18 |
|
18 | |||
19 | Authors |
|
19 | Authors | |
20 | ------- |
|
20 | ------- | |
21 |
|
21 | |||
22 | - Fernando Perez <Fernando.Perez@berkeley.edu> |
|
22 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
23 | """ |
|
23 | """ | |
24 |
|
24 | |||
25 | from __future__ import absolute_import |
|
25 | from __future__ import absolute_import | |
26 |
|
26 | |||
27 | #----------------------------------------------------------------------------- |
|
27 | #----------------------------------------------------------------------------- | |
28 | # Copyright (C) 2009 The IPython Development Team |
|
28 | # Copyright (C) 2009 The IPython Development Team | |
29 | # |
|
29 | # | |
30 | # Distributed under the terms of the BSD License. The full license is in |
|
30 | # Distributed under the terms of the BSD License. The full license is in | |
31 | # the file COPYING, distributed as part of this software. |
|
31 | # the file COPYING, distributed as part of this software. | |
32 | #----------------------------------------------------------------------------- |
|
32 | #----------------------------------------------------------------------------- | |
33 |
|
33 | |||
34 | #----------------------------------------------------------------------------- |
|
34 | #----------------------------------------------------------------------------- | |
35 | # Imports |
|
35 | # Imports | |
36 | #----------------------------------------------------------------------------- |
|
36 | #----------------------------------------------------------------------------- | |
37 |
|
37 | |||
38 | # Stdlib |
|
38 | # Stdlib | |
39 | import re |
|
39 | import re | |
40 | import sys |
|
40 | import sys | |
41 | import unittest |
|
41 | import unittest | |
42 | from doctest import DocTestFinder, DocTestRunner |
|
42 | from doctest import DocTestFinder, DocTestRunner, TestResults | |
43 | try: |
|
|||
44 | from doctest import TestResults |
|
|||
45 | except: |
|
|||
46 | from ._doctest26 import TestResults |
|
|||
47 |
|
43 | |||
48 | # We already have python3-compliant code for parametric tests |
|
44 | # We already have python3-compliant code for parametric tests | |
49 | if sys.version[0]=='2': |
|
45 | if sys.version[0]=='2': | |
50 | from ._paramtestpy2 import ParametricTestCase |
|
46 | from ._paramtestpy2 import ParametricTestCase | |
51 | else: |
|
47 | else: | |
52 | from ._paramtestpy3 import ParametricTestCase |
|
48 | from ._paramtestpy3 import ParametricTestCase | |
53 |
|
49 | |||
54 | #----------------------------------------------------------------------------- |
|
50 | #----------------------------------------------------------------------------- | |
55 | # Classes and functions |
|
51 | # Classes and functions | |
56 | #----------------------------------------------------------------------------- |
|
52 | #----------------------------------------------------------------------------- | |
57 |
|
53 | |||
58 | def count_failures(runner): |
|
54 | def count_failures(runner): | |
59 | """Count number of failures in a doctest runner. |
|
55 | """Count number of failures in a doctest runner. | |
60 |
|
56 | |||
61 | Code modeled after the summarize() method in doctest. |
|
57 | Code modeled after the summarize() method in doctest. | |
62 | """ |
|
58 | """ | |
63 | return [TestResults(f, t) for f, t in runner._name2ft.values() if f > 0 ] |
|
59 | return [TestResults(f, t) for f, t in runner._name2ft.values() if f > 0 ] | |
64 |
|
60 | |||
65 |
|
61 | |||
66 | class IPython2PythonConverter(object): |
|
62 | class IPython2PythonConverter(object): | |
67 | """Convert IPython 'syntax' to valid Python. |
|
63 | """Convert IPython 'syntax' to valid Python. | |
68 |
|
64 | |||
69 | Eventually this code may grow to be the full IPython syntax conversion |
|
65 | Eventually this code may grow to be the full IPython syntax conversion | |
70 | implementation, but for now it only does prompt convertion.""" |
|
66 | implementation, but for now it only does prompt convertion.""" | |
71 |
|
67 | |||
72 | def __init__(self): |
|
68 | def __init__(self): | |
73 | self.rps1 = re.compile(r'In\ \[\d+\]: ') |
|
69 | self.rps1 = re.compile(r'In\ \[\d+\]: ') | |
74 | self.rps2 = re.compile(r'\ \ \ \.\.\.+: ') |
|
70 | self.rps2 = re.compile(r'\ \ \ \.\.\.+: ') | |
75 | self.rout = re.compile(r'Out\[\d+\]: \s*?\n?') |
|
71 | self.rout = re.compile(r'Out\[\d+\]: \s*?\n?') | |
76 | self.pyps1 = '>>> ' |
|
72 | self.pyps1 = '>>> ' | |
77 | self.pyps2 = '... ' |
|
73 | self.pyps2 = '... ' | |
78 | self.rpyps1 = re.compile ('(\s*%s)(.*)$' % self.pyps1) |
|
74 | self.rpyps1 = re.compile ('(\s*%s)(.*)$' % self.pyps1) | |
79 | self.rpyps2 = re.compile ('(\s*%s)(.*)$' % self.pyps2) |
|
75 | self.rpyps2 = re.compile ('(\s*%s)(.*)$' % self.pyps2) | |
80 |
|
76 | |||
81 | def __call__(self, ds): |
|
77 | def __call__(self, ds): | |
82 | """Convert IPython prompts to python ones in a string.""" |
|
78 | """Convert IPython prompts to python ones in a string.""" | |
83 | from . import globalipapp |
|
79 | from . import globalipapp | |
84 |
|
80 | |||
85 | pyps1 = '>>> ' |
|
81 | pyps1 = '>>> ' | |
86 | pyps2 = '... ' |
|
82 | pyps2 = '... ' | |
87 | pyout = '' |
|
83 | pyout = '' | |
88 |
|
84 | |||
89 | dnew = ds |
|
85 | dnew = ds | |
90 | dnew = self.rps1.sub(pyps1, dnew) |
|
86 | dnew = self.rps1.sub(pyps1, dnew) | |
91 | dnew = self.rps2.sub(pyps2, dnew) |
|
87 | dnew = self.rps2.sub(pyps2, dnew) | |
92 | dnew = self.rout.sub(pyout, dnew) |
|
88 | dnew = self.rout.sub(pyout, dnew) | |
93 | ip = globalipapp.get_ipython() |
|
89 | ip = globalipapp.get_ipython() | |
94 |
|
90 | |||
95 | # Convert input IPython source into valid Python. |
|
91 | # Convert input IPython source into valid Python. | |
96 | out = [] |
|
92 | out = [] | |
97 | newline = out.append |
|
93 | newline = out.append | |
98 | for line in dnew.splitlines(): |
|
94 | for line in dnew.splitlines(): | |
99 |
|
95 | |||
100 | mps1 = self.rpyps1.match(line) |
|
96 | mps1 = self.rpyps1.match(line) | |
101 | if mps1 is not None: |
|
97 | if mps1 is not None: | |
102 | prompt, text = mps1.groups() |
|
98 | prompt, text = mps1.groups() | |
103 | newline(prompt+ip.prefilter(text, False)) |
|
99 | newline(prompt+ip.prefilter(text, False)) | |
104 | continue |
|
100 | continue | |
105 |
|
101 | |||
106 | mps2 = self.rpyps2.match(line) |
|
102 | mps2 = self.rpyps2.match(line) | |
107 | if mps2 is not None: |
|
103 | if mps2 is not None: | |
108 | prompt, text = mps2.groups() |
|
104 | prompt, text = mps2.groups() | |
109 | newline(prompt+ip.prefilter(text, True)) |
|
105 | newline(prompt+ip.prefilter(text, True)) | |
110 | continue |
|
106 | continue | |
111 |
|
107 | |||
112 | newline(line) |
|
108 | newline(line) | |
113 | newline('') # ensure a closing newline, needed by doctest |
|
109 | newline('') # ensure a closing newline, needed by doctest | |
114 | #print "PYSRC:", '\n'.join(out) # dbg |
|
110 | #print "PYSRC:", '\n'.join(out) # dbg | |
115 | return '\n'.join(out) |
|
111 | return '\n'.join(out) | |
116 |
|
112 | |||
117 | #return dnew |
|
113 | #return dnew | |
118 |
|
114 | |||
119 |
|
115 | |||
120 | class Doc2UnitTester(object): |
|
116 | class Doc2UnitTester(object): | |
121 | """Class whose instances act as a decorator for docstring testing. |
|
117 | """Class whose instances act as a decorator for docstring testing. | |
122 |
|
118 | |||
123 | In practice we're only likely to need one instance ever, made below (though |
|
119 | In practice we're only likely to need one instance ever, made below (though | |
124 | no attempt is made at turning it into a singleton, there is no need for |
|
120 | no attempt is made at turning it into a singleton, there is no need for | |
125 | that). |
|
121 | that). | |
126 | """ |
|
122 | """ | |
127 | def __init__(self, verbose=False): |
|
123 | def __init__(self, verbose=False): | |
128 | """New decorator. |
|
124 | """New decorator. | |
129 |
|
125 | |||
130 | Parameters |
|
126 | Parameters | |
131 | ---------- |
|
127 | ---------- | |
132 |
|
128 | |||
133 | verbose : boolean, optional (False) |
|
129 | verbose : boolean, optional (False) | |
134 | Passed to the doctest finder and runner to control verbosity. |
|
130 | Passed to the doctest finder and runner to control verbosity. | |
135 | """ |
|
131 | """ | |
136 | self.verbose = verbose |
|
132 | self.verbose = verbose | |
137 | # We can reuse the same finder for all instances |
|
133 | # We can reuse the same finder for all instances | |
138 | self.finder = DocTestFinder(verbose=verbose, recurse=False) |
|
134 | self.finder = DocTestFinder(verbose=verbose, recurse=False) | |
139 |
|
135 | |||
140 | def __call__(self, func): |
|
136 | def __call__(self, func): | |
141 | """Use as a decorator: doctest a function's docstring as a unittest. |
|
137 | """Use as a decorator: doctest a function's docstring as a unittest. | |
142 |
|
138 | |||
143 | This version runs normal doctests, but the idea is to make it later run |
|
139 | This version runs normal doctests, but the idea is to make it later run | |
144 | ipython syntax instead.""" |
|
140 | ipython syntax instead.""" | |
145 |
|
141 | |||
146 | # Capture the enclosing instance with a different name, so the new |
|
142 | # Capture the enclosing instance with a different name, so the new | |
147 | # class below can see it without confusion regarding its own 'self' |
|
143 | # class below can see it without confusion regarding its own 'self' | |
148 | # that will point to the test instance at runtime |
|
144 | # that will point to the test instance at runtime | |
149 | d2u = self |
|
145 | d2u = self | |
150 |
|
146 | |||
151 | # Rewrite the function's docstring to have python syntax |
|
147 | # Rewrite the function's docstring to have python syntax | |
152 | if func.__doc__ is not None: |
|
148 | if func.__doc__ is not None: | |
153 | func.__doc__ = ip2py(func.__doc__) |
|
149 | func.__doc__ = ip2py(func.__doc__) | |
154 |
|
150 | |||
155 | # Now, create a tester object that is a real unittest instance, so |
|
151 | # Now, create a tester object that is a real unittest instance, so | |
156 | # normal unittest machinery (or Nose, or Trial) can find it. |
|
152 | # normal unittest machinery (or Nose, or Trial) can find it. | |
157 | class Tester(unittest.TestCase): |
|
153 | class Tester(unittest.TestCase): | |
158 | def test(self): |
|
154 | def test(self): | |
159 | # Make a new runner per function to be tested |
|
155 | # Make a new runner per function to be tested | |
160 | runner = DocTestRunner(verbose=d2u.verbose) |
|
156 | runner = DocTestRunner(verbose=d2u.verbose) | |
161 | map(runner.run, d2u.finder.find(func, func.__name__)) |
|
157 | map(runner.run, d2u.finder.find(func, func.__name__)) | |
162 | failed = count_failures(runner) |
|
158 | failed = count_failures(runner) | |
163 | if failed: |
|
159 | if failed: | |
164 | # Since we only looked at a single function's docstring, |
|
160 | # Since we only looked at a single function's docstring, | |
165 | # failed should contain at most one item. More than that |
|
161 | # failed should contain at most one item. More than that | |
166 | # is a case we can't handle and should error out on |
|
162 | # is a case we can't handle and should error out on | |
167 | if len(failed) > 1: |
|
163 | if len(failed) > 1: | |
168 | err = "Invalid number of test results:" % failed |
|
164 | err = "Invalid number of test results:" % failed | |
169 | raise ValueError(err) |
|
165 | raise ValueError(err) | |
170 | # Report a normal failure. |
|
166 | # Report a normal failure. | |
171 | self.fail('failed doctests: %s' % str(failed[0])) |
|
167 | self.fail('failed doctests: %s' % str(failed[0])) | |
172 |
|
168 | |||
173 | # Rename it so test reports have the original signature. |
|
169 | # Rename it so test reports have the original signature. | |
174 | Tester.__name__ = func.__name__ |
|
170 | Tester.__name__ = func.__name__ | |
175 | return Tester |
|
171 | return Tester | |
176 |
|
172 | |||
177 |
|
173 | |||
178 | def ipdocstring(func): |
|
174 | def ipdocstring(func): | |
179 | """Change the function docstring via ip2py. |
|
175 | """Change the function docstring via ip2py. | |
180 | """ |
|
176 | """ | |
181 | if func.__doc__ is not None: |
|
177 | if func.__doc__ is not None: | |
182 | func.__doc__ = ip2py(func.__doc__) |
|
178 | func.__doc__ = ip2py(func.__doc__) | |
183 | return func |
|
179 | return func | |
184 |
|
180 | |||
185 |
|
181 | |||
186 | # Make an instance of the classes for public use |
|
182 | # Make an instance of the classes for public use | |
187 | ipdoctest = Doc2UnitTester() |
|
183 | ipdoctest = Doc2UnitTester() | |
188 | ip2py = IPython2PythonConverter() |
|
184 | ip2py = IPython2PythonConverter() |
@@ -1,786 +1,793 b'' | |||||
1 | """Nose Plugin that supports IPython doctests. |
|
1 | """Nose Plugin that supports IPython doctests. | |
2 |
|
2 | |||
3 | Limitations: |
|
3 | Limitations: | |
4 |
|
4 | |||
5 | - When generating examples for use as doctests, make sure that you have |
|
5 | - When generating examples for use as doctests, make sure that you have | |
6 | pretty-printing OFF. This can be done either by starting ipython with the |
|
6 | pretty-printing OFF. This can be done either by starting ipython with the | |
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by |
|
7 | flag '--nopprint', by setting pprint to 0 in your ipythonrc file, or by | |
8 | interactively disabling it with %Pprint. This is required so that IPython |
|
8 | interactively disabling it with %Pprint. This is required so that IPython | |
9 | output matches that of normal Python, which is used by doctest for internal |
|
9 | output matches that of normal Python, which is used by doctest for internal | |
10 | execution. |
|
10 | execution. | |
11 |
|
11 | |||
12 | - Do not rely on specific prompt numbers for results (such as using |
|
12 | - Do not rely on specific prompt numbers for results (such as using | |
13 | '_34==True', for example). For IPython tests run via an external process the |
|
13 | '_34==True', for example). For IPython tests run via an external process the | |
14 | prompt numbers may be different, and IPython tests run as normal python code |
|
14 | prompt numbers may be different, and IPython tests run as normal python code | |
15 | won't even have these special _NN variables set at all. |
|
15 | won't even have these special _NN variables set at all. | |
16 | """ |
|
16 | """ | |
17 |
|
17 | |||
18 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
19 | # Module imports |
|
19 | # Module imports | |
20 |
|
20 | |||
21 | # From the standard library |
|
21 | # From the standard library | |
22 | import __builtin__ |
|
22 | import __builtin__ | |
23 | import commands |
|
23 | import commands | |
24 | import doctest |
|
24 | import doctest | |
25 | import inspect |
|
25 | import inspect | |
26 | import logging |
|
26 | import logging | |
27 | import os |
|
27 | import os | |
28 | import re |
|
28 | import re | |
29 | import sys |
|
29 | import sys | |
30 | import traceback |
|
30 | import traceback | |
31 | import unittest |
|
31 | import unittest | |
32 |
|
32 | |||
33 | from inspect import getmodule |
|
33 | from inspect import getmodule | |
34 | from StringIO import StringIO |
|
34 | from StringIO import StringIO | |
35 |
|
35 | |||
36 | # We are overriding the default doctest runner, so we need to import a few |
|
36 | # We are overriding the default doctest runner, so we need to import a few | |
37 | # things from doctest directly |
|
37 | # things from doctest directly | |
38 | from doctest import (REPORTING_FLAGS, REPORT_ONLY_FIRST_FAILURE, |
|
38 | from doctest import (REPORTING_FLAGS, REPORT_ONLY_FIRST_FAILURE, | |
39 | _unittest_reportflags, DocTestRunner, |
|
39 | _unittest_reportflags, DocTestRunner, | |
40 | _extract_future_flags, pdb, _OutputRedirectingPdb, |
|
40 | _extract_future_flags, pdb, _OutputRedirectingPdb, | |
41 | _exception_traceback, |
|
41 | _exception_traceback, | |
42 | linecache) |
|
42 | linecache) | |
43 |
|
43 | |||
44 | # Third-party modules |
|
44 | # Third-party modules | |
45 | import nose.core |
|
45 | import nose.core | |
46 |
|
46 | |||
47 | from nose.plugins import doctests, Plugin |
|
47 | from nose.plugins import doctests, Plugin | |
48 | from nose.util import anyp, getpackage, test_address, resolve_name, tolist |
|
48 | from nose.util import anyp, getpackage, test_address, resolve_name, tolist | |
49 |
|
49 | |||
50 | #----------------------------------------------------------------------------- |
|
50 | #----------------------------------------------------------------------------- | |
51 | # Module globals and other constants |
|
51 | # Module globals and other constants | |
52 | #----------------------------------------------------------------------------- |
|
52 | #----------------------------------------------------------------------------- | |
53 |
|
53 | |||
54 | log = logging.getLogger(__name__) |
|
54 | log = logging.getLogger(__name__) | |
55 |
|
55 | |||
56 |
|
56 | |||
57 | #----------------------------------------------------------------------------- |
|
57 | #----------------------------------------------------------------------------- | |
58 | # Classes and functions |
|
58 | # Classes and functions | |
59 | #----------------------------------------------------------------------------- |
|
59 | #----------------------------------------------------------------------------- | |
60 |
|
60 | |||
61 | def is_extension_module(filename): |
|
61 | def is_extension_module(filename): | |
62 | """Return whether the given filename is an extension module. |
|
62 | """Return whether the given filename is an extension module. | |
63 |
|
63 | |||
64 | This simply checks that the extension is either .so or .pyd. |
|
64 | This simply checks that the extension is either .so or .pyd. | |
65 | """ |
|
65 | """ | |
66 | return os.path.splitext(filename)[1].lower() in ('.so','.pyd') |
|
66 | return os.path.splitext(filename)[1].lower() in ('.so','.pyd') | |
67 |
|
67 | |||
68 |
|
68 | |||
69 | class DocTestSkip(object): |
|
69 | class DocTestSkip(object): | |
70 | """Object wrapper for doctests to be skipped.""" |
|
70 | """Object wrapper for doctests to be skipped.""" | |
71 |
|
71 | |||
72 | ds_skip = """Doctest to skip. |
|
72 | ds_skip = """Doctest to skip. | |
73 | >>> 1 #doctest: +SKIP |
|
73 | >>> 1 #doctest: +SKIP | |
74 | """ |
|
74 | """ | |
75 |
|
75 | |||
76 | def __init__(self,obj): |
|
76 | def __init__(self,obj): | |
77 | self.obj = obj |
|
77 | self.obj = obj | |
78 |
|
78 | |||
79 | def __getattribute__(self,key): |
|
79 | def __getattribute__(self,key): | |
80 | if key == '__doc__': |
|
80 | if key == '__doc__': | |
81 | return DocTestSkip.ds_skip |
|
81 | return DocTestSkip.ds_skip | |
82 | else: |
|
82 | else: | |
83 | return getattr(object.__getattribute__(self,'obj'),key) |
|
83 | return getattr(object.__getattribute__(self,'obj'),key) | |
84 |
|
84 | |||
85 | # Modified version of the one in the stdlib, that fixes a python bug (doctests |
|
85 | # Modified version of the one in the stdlib, that fixes a python bug (doctests | |
86 | # not found in extension modules, http://bugs.python.org/issue3158) |
|
86 | # not found in extension modules, http://bugs.python.org/issue3158) | |
87 | class DocTestFinder(doctest.DocTestFinder): |
|
87 | class DocTestFinder(doctest.DocTestFinder): | |
88 |
|
88 | |||
89 | def _from_module(self, module, object): |
|
89 | def _from_module(self, module, object): | |
90 | """ |
|
90 | """ | |
91 | Return true if the given object is defined in the given |
|
91 | Return true if the given object is defined in the given | |
92 | module. |
|
92 | module. | |
93 | """ |
|
93 | """ | |
94 | if module is None: |
|
94 | if module is None: | |
95 | return True |
|
95 | return True | |
96 | elif inspect.isfunction(object): |
|
96 | elif inspect.isfunction(object): | |
97 | return module.__dict__ is object.func_globals |
|
97 | return module.__dict__ is object.func_globals | |
98 | elif inspect.isbuiltin(object): |
|
98 | elif inspect.isbuiltin(object): | |
99 | return module.__name__ == object.__module__ |
|
99 | return module.__name__ == object.__module__ | |
100 | elif inspect.isclass(object): |
|
100 | elif inspect.isclass(object): | |
101 | return module.__name__ == object.__module__ |
|
101 | return module.__name__ == object.__module__ | |
102 | elif inspect.ismethod(object): |
|
102 | elif inspect.ismethod(object): | |
103 | # This one may be a bug in cython that fails to correctly set the |
|
103 | # This one may be a bug in cython that fails to correctly set the | |
104 | # __module__ attribute of methods, but since the same error is easy |
|
104 | # __module__ attribute of methods, but since the same error is easy | |
105 | # to make by extension code writers, having this safety in place |
|
105 | # to make by extension code writers, having this safety in place | |
106 | # isn't such a bad idea |
|
106 | # isn't such a bad idea | |
107 | return module.__name__ == object.im_class.__module__ |
|
107 | return module.__name__ == object.im_class.__module__ | |
108 | elif inspect.getmodule(object) is not None: |
|
108 | elif inspect.getmodule(object) is not None: | |
109 | return module is inspect.getmodule(object) |
|
109 | return module is inspect.getmodule(object) | |
110 | elif hasattr(object, '__module__'): |
|
110 | elif hasattr(object, '__module__'): | |
111 | return module.__name__ == object.__module__ |
|
111 | return module.__name__ == object.__module__ | |
112 | elif isinstance(object, property): |
|
112 | elif isinstance(object, property): | |
113 | return True # [XX] no way not be sure. |
|
113 | return True # [XX] no way not be sure. | |
114 | else: |
|
114 | else: | |
115 | raise ValueError("object must be a class or function") |
|
115 | raise ValueError("object must be a class or function") | |
116 |
|
116 | |||
117 | def _find(self, tests, obj, name, module, source_lines, globs, seen): |
|
117 | def _find(self, tests, obj, name, module, source_lines, globs, seen): | |
118 | """ |
|
118 | """ | |
119 | Find tests for the given object and any contained objects, and |
|
119 | Find tests for the given object and any contained objects, and | |
120 | add them to `tests`. |
|
120 | add them to `tests`. | |
121 | """ |
|
121 | """ | |
122 | #print '_find for:', obj, name, module # dbg |
|
122 | #print '_find for:', obj, name, module # dbg | |
123 | if hasattr(obj,"skip_doctest"): |
|
123 | if hasattr(obj,"skip_doctest"): | |
124 | #print 'SKIPPING DOCTEST FOR:',obj # dbg |
|
124 | #print 'SKIPPING DOCTEST FOR:',obj # dbg | |
125 | obj = DocTestSkip(obj) |
|
125 | obj = DocTestSkip(obj) | |
126 |
|
126 | |||
127 | doctest.DocTestFinder._find(self,tests, obj, name, module, |
|
127 | doctest.DocTestFinder._find(self,tests, obj, name, module, | |
128 | source_lines, globs, seen) |
|
128 | source_lines, globs, seen) | |
129 |
|
129 | |||
130 | # Below we re-run pieces of the above method with manual modifications, |
|
130 | # Below we re-run pieces of the above method with manual modifications, | |
131 | # because the original code is buggy and fails to correctly identify |
|
131 | # because the original code is buggy and fails to correctly identify | |
132 | # doctests in extension modules. |
|
132 | # doctests in extension modules. | |
133 |
|
133 | |||
134 | # Local shorthands |
|
134 | # Local shorthands | |
135 | from inspect import isroutine, isclass, ismodule |
|
135 | from inspect import isroutine, isclass, ismodule | |
136 |
|
136 | |||
137 | # Look for tests in a module's contained objects. |
|
137 | # Look for tests in a module's contained objects. | |
138 | if inspect.ismodule(obj) and self._recurse: |
|
138 | if inspect.ismodule(obj) and self._recurse: | |
139 | for valname, val in obj.__dict__.items(): |
|
139 | for valname, val in obj.__dict__.items(): | |
140 | valname1 = '%s.%s' % (name, valname) |
|
140 | valname1 = '%s.%s' % (name, valname) | |
141 | if ( (isroutine(val) or isclass(val)) |
|
141 | if ( (isroutine(val) or isclass(val)) | |
142 | and self._from_module(module, val) ): |
|
142 | and self._from_module(module, val) ): | |
143 |
|
143 | |||
144 | self._find(tests, val, valname1, module, source_lines, |
|
144 | self._find(tests, val, valname1, module, source_lines, | |
145 | globs, seen) |
|
145 | globs, seen) | |
146 |
|
146 | |||
147 | # Look for tests in a class's contained objects. |
|
147 | # Look for tests in a class's contained objects. | |
148 | if inspect.isclass(obj) and self._recurse: |
|
148 | if inspect.isclass(obj) and self._recurse: | |
149 | #print 'RECURSE into class:',obj # dbg |
|
149 | #print 'RECURSE into class:',obj # dbg | |
150 | for valname, val in obj.__dict__.items(): |
|
150 | for valname, val in obj.__dict__.items(): | |
151 | # Special handling for staticmethod/classmethod. |
|
151 | # Special handling for staticmethod/classmethod. | |
152 | if isinstance(val, staticmethod): |
|
152 | if isinstance(val, staticmethod): | |
153 | val = getattr(obj, valname) |
|
153 | val = getattr(obj, valname) | |
154 | if isinstance(val, classmethod): |
|
154 | if isinstance(val, classmethod): | |
155 | val = getattr(obj, valname).im_func |
|
155 | val = getattr(obj, valname).im_func | |
156 |
|
156 | |||
157 | # Recurse to methods, properties, and nested classes. |
|
157 | # Recurse to methods, properties, and nested classes. | |
158 | if ((inspect.isfunction(val) or inspect.isclass(val) or |
|
158 | if ((inspect.isfunction(val) or inspect.isclass(val) or | |
159 | inspect.ismethod(val) or |
|
159 | inspect.ismethod(val) or | |
160 | isinstance(val, property)) and |
|
160 | isinstance(val, property)) and | |
161 | self._from_module(module, val)): |
|
161 | self._from_module(module, val)): | |
162 | valname = '%s.%s' % (name, valname) |
|
162 | valname = '%s.%s' % (name, valname) | |
163 | self._find(tests, val, valname, module, source_lines, |
|
163 | self._find(tests, val, valname, module, source_lines, | |
164 | globs, seen) |
|
164 | globs, seen) | |
165 |
|
165 | |||
166 |
|
166 | |||
167 | class IPDoctestOutputChecker(doctest.OutputChecker): |
|
167 | class IPDoctestOutputChecker(doctest.OutputChecker): | |
168 | """Second-chance checker with support for random tests. |
|
168 | """Second-chance checker with support for random tests. | |
169 |
|
169 | |||
170 | If the default comparison doesn't pass, this checker looks in the expected |
|
170 | If the default comparison doesn't pass, this checker looks in the expected | |
171 | output string for flags that tell us to ignore the output. |
|
171 | output string for flags that tell us to ignore the output. | |
172 | """ |
|
172 | """ | |
173 |
|
173 | |||
174 | random_re = re.compile(r'#\s*random\s+') |
|
174 | random_re = re.compile(r'#\s*random\s+') | |
175 |
|
175 | |||
176 | def check_output(self, want, got, optionflags): |
|
176 | def check_output(self, want, got, optionflags): | |
177 | """Check output, accepting special markers embedded in the output. |
|
177 | """Check output, accepting special markers embedded in the output. | |
178 |
|
178 | |||
179 | If the output didn't pass the default validation but the special string |
|
179 | If the output didn't pass the default validation but the special string | |
180 | '#random' is included, we accept it.""" |
|
180 | '#random' is included, we accept it.""" | |
181 |
|
181 | |||
182 | # Let the original tester verify first, in case people have valid tests |
|
182 | # Let the original tester verify first, in case people have valid tests | |
183 | # that happen to have a comment saying '#random' embedded in. |
|
183 | # that happen to have a comment saying '#random' embedded in. | |
184 | ret = doctest.OutputChecker.check_output(self, want, got, |
|
184 | ret = doctest.OutputChecker.check_output(self, want, got, | |
185 | optionflags) |
|
185 | optionflags) | |
186 | if not ret and self.random_re.search(want): |
|
186 | if not ret and self.random_re.search(want): | |
187 | #print >> sys.stderr, 'RANDOM OK:',want # dbg |
|
187 | #print >> sys.stderr, 'RANDOM OK:',want # dbg | |
188 | return True |
|
188 | return True | |
189 |
|
189 | |||
190 | return ret |
|
190 | return ret | |
191 |
|
191 | |||
192 |
|
192 | |||
193 | class DocTestCase(doctests.DocTestCase): |
|
193 | class DocTestCase(doctests.DocTestCase): | |
194 | """Proxy for DocTestCase: provides an address() method that |
|
194 | """Proxy for DocTestCase: provides an address() method that | |
195 | returns the correct address for the doctest case. Otherwise |
|
195 | returns the correct address for the doctest case. Otherwise | |
196 | acts as a proxy to the test case. To provide hints for address(), |
|
196 | acts as a proxy to the test case. To provide hints for address(), | |
197 | an obj may also be passed -- this will be used as the test object |
|
197 | an obj may also be passed -- this will be used as the test object | |
198 | for purposes of determining the test address, if it is provided. |
|
198 | for purposes of determining the test address, if it is provided. | |
199 | """ |
|
199 | """ | |
200 |
|
200 | |||
201 | # Note: this method was taken from numpy's nosetester module. |
|
201 | # Note: this method was taken from numpy's nosetester module. | |
202 |
|
202 | |||
203 | # Subclass nose.plugins.doctests.DocTestCase to work around a bug in |
|
203 | # Subclass nose.plugins.doctests.DocTestCase to work around a bug in | |
204 | # its constructor that blocks non-default arguments from being passed |
|
204 | # its constructor that blocks non-default arguments from being passed | |
205 | # down into doctest.DocTestCase |
|
205 | # down into doctest.DocTestCase | |
206 |
|
206 | |||
207 | def __init__(self, test, optionflags=0, setUp=None, tearDown=None, |
|
207 | def __init__(self, test, optionflags=0, setUp=None, tearDown=None, | |
208 | checker=None, obj=None, result_var='_'): |
|
208 | checker=None, obj=None, result_var='_'): | |
209 | self._result_var = result_var |
|
209 | self._result_var = result_var | |
210 | doctests.DocTestCase.__init__(self, test, |
|
210 | doctests.DocTestCase.__init__(self, test, | |
211 | optionflags=optionflags, |
|
211 | optionflags=optionflags, | |
212 | setUp=setUp, tearDown=tearDown, |
|
212 | setUp=setUp, tearDown=tearDown, | |
213 | checker=checker) |
|
213 | checker=checker) | |
214 | # Now we must actually copy the original constructor from the stdlib |
|
214 | # Now we must actually copy the original constructor from the stdlib | |
215 | # doctest class, because we can't call it directly and a bug in nose |
|
215 | # doctest class, because we can't call it directly and a bug in nose | |
216 | # means it never gets passed the right arguments. |
|
216 | # means it never gets passed the right arguments. | |
217 |
|
217 | |||
218 | self._dt_optionflags = optionflags |
|
218 | self._dt_optionflags = optionflags | |
219 | self._dt_checker = checker |
|
219 | self._dt_checker = checker | |
220 | self._dt_test = test |
|
220 | self._dt_test = test | |
221 | self._dt_test_globs_ori = test.globs |
|
221 | self._dt_test_globs_ori = test.globs | |
222 | self._dt_setUp = setUp |
|
222 | self._dt_setUp = setUp | |
223 | self._dt_tearDown = tearDown |
|
223 | self._dt_tearDown = tearDown | |
224 |
|
224 | |||
225 | # XXX - store this runner once in the object! |
|
225 | # XXX - store this runner once in the object! | |
226 | runner = IPDocTestRunner(optionflags=optionflags, |
|
226 | runner = IPDocTestRunner(optionflags=optionflags, | |
227 | checker=checker, verbose=False) |
|
227 | checker=checker, verbose=False) | |
228 | self._dt_runner = runner |
|
228 | self._dt_runner = runner | |
229 |
|
229 | |||
230 |
|
230 | |||
231 | # Each doctest should remember the directory it was loaded from, so |
|
231 | # Each doctest should remember the directory it was loaded from, so | |
232 | # things like %run work without too many contortions |
|
232 | # things like %run work without too many contortions | |
233 | self._ori_dir = os.path.dirname(test.filename) |
|
233 | self._ori_dir = os.path.dirname(test.filename) | |
234 |
|
234 | |||
235 | # Modified runTest from the default stdlib |
|
235 | # Modified runTest from the default stdlib | |
236 | def runTest(self): |
|
236 | def runTest(self): | |
237 | test = self._dt_test |
|
237 | test = self._dt_test | |
238 | runner = self._dt_runner |
|
238 | runner = self._dt_runner | |
239 |
|
239 | |||
240 | old = sys.stdout |
|
240 | old = sys.stdout | |
241 | new = StringIO() |
|
241 | new = StringIO() | |
242 | optionflags = self._dt_optionflags |
|
242 | optionflags = self._dt_optionflags | |
243 |
|
243 | |||
244 | if not (optionflags & REPORTING_FLAGS): |
|
244 | if not (optionflags & REPORTING_FLAGS): | |
245 | # The option flags don't include any reporting flags, |
|
245 | # The option flags don't include any reporting flags, | |
246 | # so add the default reporting flags |
|
246 | # so add the default reporting flags | |
247 | optionflags |= _unittest_reportflags |
|
247 | optionflags |= _unittest_reportflags | |
248 |
|
248 | |||
249 | try: |
|
249 | try: | |
250 | # Save our current directory and switch out to the one where the |
|
250 | # Save our current directory and switch out to the one where the | |
251 | # test was originally created, in case another doctest did a |
|
251 | # test was originally created, in case another doctest did a | |
252 | # directory change. We'll restore this in the finally clause. |
|
252 | # directory change. We'll restore this in the finally clause. | |
253 | curdir = os.getcwd() |
|
253 | curdir = os.getcwd() | |
254 | #print 'runTest in dir:', self._ori_dir # dbg |
|
254 | #print 'runTest in dir:', self._ori_dir # dbg | |
255 | os.chdir(self._ori_dir) |
|
255 | os.chdir(self._ori_dir) | |
256 |
|
256 | |||
257 | runner.DIVIDER = "-"*70 |
|
257 | runner.DIVIDER = "-"*70 | |
258 | failures, tries = runner.run(test,out=new.write, |
|
258 | failures, tries = runner.run(test,out=new.write, | |
259 | clear_globs=False) |
|
259 | clear_globs=False) | |
260 | finally: |
|
260 | finally: | |
261 | sys.stdout = old |
|
261 | sys.stdout = old | |
262 | os.chdir(curdir) |
|
262 | os.chdir(curdir) | |
263 |
|
263 | |||
264 | if failures: |
|
264 | if failures: | |
265 | raise self.failureException(self.format_failure(new.getvalue())) |
|
265 | raise self.failureException(self.format_failure(new.getvalue())) | |
266 |
|
266 | |||
267 | def setUp(self): |
|
267 | def setUp(self): | |
268 | """Modified test setup that syncs with ipython namespace""" |
|
268 | """Modified test setup that syncs with ipython namespace""" | |
269 | #print "setUp test", self._dt_test.examples # dbg |
|
269 | #print "setUp test", self._dt_test.examples # dbg | |
270 | if isinstance(self._dt_test.examples[0],IPExample): |
|
270 | if isinstance(self._dt_test.examples[0],IPExample): | |
271 | # for IPython examples *only*, we swap the globals with the ipython |
|
271 | # for IPython examples *only*, we swap the globals with the ipython | |
272 | # namespace, after updating it with the globals (which doctest |
|
272 | # namespace, after updating it with the globals (which doctest | |
273 | # fills with the necessary info from the module being tested). |
|
273 | # fills with the necessary info from the module being tested). | |
274 | _ip.user_ns.update(self._dt_test.globs) |
|
274 | _ip.user_ns.update(self._dt_test.globs) | |
275 | self._dt_test.globs = _ip.user_ns |
|
275 | self._dt_test.globs = _ip.user_ns | |
|
276 | # IPython must protect the _ key in the namespace (it can't exist) | |||
|
277 | # so that Python's doctest code sets it naturally, so we enable | |||
|
278 | # this feature of our testing namespace. | |||
|
279 | _ip.user_ns.protect_underscore = True | |||
276 |
|
280 | |||
277 | super(DocTestCase, self).setUp() |
|
281 | super(DocTestCase, self).setUp() | |
278 |
|
282 | |||
279 | def tearDown(self): |
|
283 | def tearDown(self): | |
280 |
|
284 | |||
281 | # Undo the test.globs reassignment we made, so that the parent class |
|
285 | # Undo the test.globs reassignment we made, so that the parent class | |
282 | # teardown doesn't destroy the ipython namespace |
|
286 | # teardown doesn't destroy the ipython namespace | |
283 | if isinstance(self._dt_test.examples[0],IPExample): |
|
287 | if isinstance(self._dt_test.examples[0],IPExample): | |
284 | self._dt_test.globs = self._dt_test_globs_ori |
|
288 | self._dt_test.globs = self._dt_test_globs_ori | |
|
289 | # Restore the behavior of the '_' key in the user namespace to | |||
|
290 | # normal after each doctest, so that unittests behave normally | |||
|
291 | _ip.user_ns.protect_underscore = False | |||
285 |
|
292 | |||
286 | # XXX - fperez: I am not sure if this is truly a bug in nose 0.11, but |
|
293 | # XXX - fperez: I am not sure if this is truly a bug in nose 0.11, but | |
287 | # it does look like one to me: its tearDown method tries to run |
|
294 | # it does look like one to me: its tearDown method tries to run | |
288 | # |
|
295 | # | |
289 | # delattr(__builtin__, self._result_var) |
|
296 | # delattr(__builtin__, self._result_var) | |
290 | # |
|
297 | # | |
291 | # without checking that the attribute really is there; it implicitly |
|
298 | # without checking that the attribute really is there; it implicitly | |
292 | # assumes it should have been set via displayhook. But if the |
|
299 | # assumes it should have been set via displayhook. But if the | |
293 | # displayhook was never called, this doesn't necessarily happen. I |
|
300 | # displayhook was never called, this doesn't necessarily happen. I | |
294 | # haven't been able to find a little self-contained example outside of |
|
301 | # haven't been able to find a little self-contained example outside of | |
295 | # ipython that would show the problem so I can report it to the nose |
|
302 | # ipython that would show the problem so I can report it to the nose | |
296 | # team, but it does happen a lot in our code. |
|
303 | # team, but it does happen a lot in our code. | |
297 | # |
|
304 | # | |
298 | # So here, we just protect as narrowly as possible by trapping an |
|
305 | # So here, we just protect as narrowly as possible by trapping an | |
299 | # attribute error whose message would be the name of self._result_var, |
|
306 | # attribute error whose message would be the name of self._result_var, | |
300 | # and letting any other error propagate. |
|
307 | # and letting any other error propagate. | |
301 | try: |
|
308 | try: | |
302 | super(DocTestCase, self).tearDown() |
|
309 | super(DocTestCase, self).tearDown() | |
303 | except AttributeError, exc: |
|
310 | except AttributeError, exc: | |
304 | if exc.args[0] != self._result_var: |
|
311 | if exc.args[0] != self._result_var: | |
305 | raise |
|
312 | raise | |
306 |
|
313 | |||
307 |
|
314 | |||
308 | # A simple subclassing of the original with a different class name, so we can |
|
315 | # A simple subclassing of the original with a different class name, so we can | |
309 | # distinguish and treat differently IPython examples from pure python ones. |
|
316 | # distinguish and treat differently IPython examples from pure python ones. | |
310 | class IPExample(doctest.Example): pass |
|
317 | class IPExample(doctest.Example): pass | |
311 |
|
318 | |||
312 |
|
319 | |||
313 | class IPExternalExample(doctest.Example): |
|
320 | class IPExternalExample(doctest.Example): | |
314 | """Doctest examples to be run in an external process.""" |
|
321 | """Doctest examples to be run in an external process.""" | |
315 |
|
322 | |||
316 | def __init__(self, source, want, exc_msg=None, lineno=0, indent=0, |
|
323 | def __init__(self, source, want, exc_msg=None, lineno=0, indent=0, | |
317 | options=None): |
|
324 | options=None): | |
318 | # Parent constructor |
|
325 | # Parent constructor | |
319 | doctest.Example.__init__(self,source,want,exc_msg,lineno,indent,options) |
|
326 | doctest.Example.__init__(self,source,want,exc_msg,lineno,indent,options) | |
320 |
|
327 | |||
321 | # An EXTRA newline is needed to prevent pexpect hangs |
|
328 | # An EXTRA newline is needed to prevent pexpect hangs | |
322 | self.source += '\n' |
|
329 | self.source += '\n' | |
323 |
|
330 | |||
324 |
|
331 | |||
325 | class IPDocTestParser(doctest.DocTestParser): |
|
332 | class IPDocTestParser(doctest.DocTestParser): | |
326 | """ |
|
333 | """ | |
327 | A class used to parse strings containing doctest examples. |
|
334 | A class used to parse strings containing doctest examples. | |
328 |
|
335 | |||
329 | Note: This is a version modified to properly recognize IPython input and |
|
336 | Note: This is a version modified to properly recognize IPython input and | |
330 | convert any IPython examples into valid Python ones. |
|
337 | convert any IPython examples into valid Python ones. | |
331 | """ |
|
338 | """ | |
332 | # This regular expression is used to find doctest examples in a |
|
339 | # This regular expression is used to find doctest examples in a | |
333 | # string. It defines three groups: `source` is the source code |
|
340 | # string. It defines three groups: `source` is the source code | |
334 | # (including leading indentation and prompts); `indent` is the |
|
341 | # (including leading indentation and prompts); `indent` is the | |
335 | # indentation of the first (PS1) line of the source code; and |
|
342 | # indentation of the first (PS1) line of the source code; and | |
336 | # `want` is the expected output (including leading indentation). |
|
343 | # `want` is the expected output (including leading indentation). | |
337 |
|
344 | |||
338 | # Classic Python prompts or default IPython ones |
|
345 | # Classic Python prompts or default IPython ones | |
339 | _PS1_PY = r'>>>' |
|
346 | _PS1_PY = r'>>>' | |
340 | _PS2_PY = r'\.\.\.' |
|
347 | _PS2_PY = r'\.\.\.' | |
341 |
|
348 | |||
342 | _PS1_IP = r'In\ \[\d+\]:' |
|
349 | _PS1_IP = r'In\ \[\d+\]:' | |
343 | _PS2_IP = r'\ \ \ \.\.\.+:' |
|
350 | _PS2_IP = r'\ \ \ \.\.\.+:' | |
344 |
|
351 | |||
345 | _RE_TPL = r''' |
|
352 | _RE_TPL = r''' | |
346 | # Source consists of a PS1 line followed by zero or more PS2 lines. |
|
353 | # Source consists of a PS1 line followed by zero or more PS2 lines. | |
347 | (?P<source> |
|
354 | (?P<source> | |
348 | (?:^(?P<indent> [ ]*) (?P<ps1> %s) .*) # PS1 line |
|
355 | (?:^(?P<indent> [ ]*) (?P<ps1> %s) .*) # PS1 line | |
349 | (?:\n [ ]* (?P<ps2> %s) .*)*) # PS2 lines |
|
356 | (?:\n [ ]* (?P<ps2> %s) .*)*) # PS2 lines | |
350 | \n? # a newline |
|
357 | \n? # a newline | |
351 | # Want consists of any non-blank lines that do not start with PS1. |
|
358 | # Want consists of any non-blank lines that do not start with PS1. | |
352 | (?P<want> (?:(?![ ]*$) # Not a blank line |
|
359 | (?P<want> (?:(?![ ]*$) # Not a blank line | |
353 | (?![ ]*%s) # Not a line starting with PS1 |
|
360 | (?![ ]*%s) # Not a line starting with PS1 | |
354 | (?![ ]*%s) # Not a line starting with PS2 |
|
361 | (?![ ]*%s) # Not a line starting with PS2 | |
355 | .*$\n? # But any other line |
|
362 | .*$\n? # But any other line | |
356 | )*) |
|
363 | )*) | |
357 | ''' |
|
364 | ''' | |
358 |
|
365 | |||
359 | _EXAMPLE_RE_PY = re.compile( _RE_TPL % (_PS1_PY,_PS2_PY,_PS1_PY,_PS2_PY), |
|
366 | _EXAMPLE_RE_PY = re.compile( _RE_TPL % (_PS1_PY,_PS2_PY,_PS1_PY,_PS2_PY), | |
360 | re.MULTILINE | re.VERBOSE) |
|
367 | re.MULTILINE | re.VERBOSE) | |
361 |
|
368 | |||
362 | _EXAMPLE_RE_IP = re.compile( _RE_TPL % (_PS1_IP,_PS2_IP,_PS1_IP,_PS2_IP), |
|
369 | _EXAMPLE_RE_IP = re.compile( _RE_TPL % (_PS1_IP,_PS2_IP,_PS1_IP,_PS2_IP), | |
363 | re.MULTILINE | re.VERBOSE) |
|
370 | re.MULTILINE | re.VERBOSE) | |
364 |
|
371 | |||
365 | # Mark a test as being fully random. In this case, we simply append the |
|
372 | # Mark a test as being fully random. In this case, we simply append the | |
366 | # random marker ('#random') to each individual example's output. This way |
|
373 | # random marker ('#random') to each individual example's output. This way | |
367 | # we don't need to modify any other code. |
|
374 | # we don't need to modify any other code. | |
368 | _RANDOM_TEST = re.compile(r'#\s*all-random\s+') |
|
375 | _RANDOM_TEST = re.compile(r'#\s*all-random\s+') | |
369 |
|
376 | |||
370 | # Mark tests to be executed in an external process - currently unsupported. |
|
377 | # Mark tests to be executed in an external process - currently unsupported. | |
371 | _EXTERNAL_IP = re.compile(r'#\s*ipdoctest:\s*EXTERNAL') |
|
378 | _EXTERNAL_IP = re.compile(r'#\s*ipdoctest:\s*EXTERNAL') | |
372 |
|
379 | |||
373 | def ip2py(self,source): |
|
380 | def ip2py(self,source): | |
374 | """Convert input IPython source into valid Python.""" |
|
381 | """Convert input IPython source into valid Python.""" | |
375 | out = [] |
|
382 | out = [] | |
376 | newline = out.append |
|
383 | newline = out.append | |
377 | #print 'IPSRC:\n',source,'\n###' # dbg |
|
384 | #print 'IPSRC:\n',source,'\n###' # dbg | |
378 | # The input source must be first stripped of all bracketing whitespace |
|
385 | # The input source must be first stripped of all bracketing whitespace | |
379 | # and turned into lines, so it looks to the parser like regular user |
|
386 | # and turned into lines, so it looks to the parser like regular user | |
380 | # input |
|
387 | # input | |
381 | for lnum,line in enumerate(source.strip().splitlines()): |
|
388 | for lnum,line in enumerate(source.strip().splitlines()): | |
382 | newline(_ip.prefilter(line,lnum>0)) |
|
389 | newline(_ip.prefilter(line,lnum>0)) | |
383 | newline('') # ensure a closing newline, needed by doctest |
|
390 | newline('') # ensure a closing newline, needed by doctest | |
384 | #print "PYSRC:", '\n'.join(out) # dbg |
|
391 | #print "PYSRC:", '\n'.join(out) # dbg | |
385 | return '\n'.join(out) |
|
392 | return '\n'.join(out) | |
386 |
|
393 | |||
387 | def parse(self, string, name='<string>'): |
|
394 | def parse(self, string, name='<string>'): | |
388 | """ |
|
395 | """ | |
389 | Divide the given string into examples and intervening text, |
|
396 | Divide the given string into examples and intervening text, | |
390 | and return them as a list of alternating Examples and strings. |
|
397 | and return them as a list of alternating Examples and strings. | |
391 | Line numbers for the Examples are 0-based. The optional |
|
398 | Line numbers for the Examples are 0-based. The optional | |
392 | argument `name` is a name identifying this string, and is only |
|
399 | argument `name` is a name identifying this string, and is only | |
393 | used for error messages. |
|
400 | used for error messages. | |
394 | """ |
|
401 | """ | |
395 |
|
402 | |||
396 | #print 'Parse string:\n',string # dbg |
|
403 | #print 'Parse string:\n',string # dbg | |
397 |
|
404 | |||
398 | string = string.expandtabs() |
|
405 | string = string.expandtabs() | |
399 | # If all lines begin with the same indentation, then strip it. |
|
406 | # If all lines begin with the same indentation, then strip it. | |
400 | min_indent = self._min_indent(string) |
|
407 | min_indent = self._min_indent(string) | |
401 | if min_indent > 0: |
|
408 | if min_indent > 0: | |
402 | string = '\n'.join([l[min_indent:] for l in string.split('\n')]) |
|
409 | string = '\n'.join([l[min_indent:] for l in string.split('\n')]) | |
403 |
|
410 | |||
404 | output = [] |
|
411 | output = [] | |
405 | charno, lineno = 0, 0 |
|
412 | charno, lineno = 0, 0 | |
406 |
|
413 | |||
407 | # We make 'all random' tests by adding the '# random' mark to every |
|
414 | # We make 'all random' tests by adding the '# random' mark to every | |
408 | # block of output in the test. |
|
415 | # block of output in the test. | |
409 | if self._RANDOM_TEST.search(string): |
|
416 | if self._RANDOM_TEST.search(string): | |
410 | random_marker = '\n# random' |
|
417 | random_marker = '\n# random' | |
411 | else: |
|
418 | else: | |
412 | random_marker = '' |
|
419 | random_marker = '' | |
413 |
|
420 | |||
414 | # Whether to convert the input from ipython to python syntax |
|
421 | # Whether to convert the input from ipython to python syntax | |
415 | ip2py = False |
|
422 | ip2py = False | |
416 | # Find all doctest examples in the string. First, try them as Python |
|
423 | # Find all doctest examples in the string. First, try them as Python | |
417 | # examples, then as IPython ones |
|
424 | # examples, then as IPython ones | |
418 | terms = list(self._EXAMPLE_RE_PY.finditer(string)) |
|
425 | terms = list(self._EXAMPLE_RE_PY.finditer(string)) | |
419 | if terms: |
|
426 | if terms: | |
420 | # Normal Python example |
|
427 | # Normal Python example | |
421 | #print '-'*70 # dbg |
|
428 | #print '-'*70 # dbg | |
422 | #print 'PyExample, Source:\n',string # dbg |
|
429 | #print 'PyExample, Source:\n',string # dbg | |
423 | #print '-'*70 # dbg |
|
430 | #print '-'*70 # dbg | |
424 | Example = doctest.Example |
|
431 | Example = doctest.Example | |
425 | else: |
|
432 | else: | |
426 | # It's an ipython example. Note that IPExamples are run |
|
433 | # It's an ipython example. Note that IPExamples are run | |
427 | # in-process, so their syntax must be turned into valid python. |
|
434 | # in-process, so their syntax must be turned into valid python. | |
428 | # IPExternalExamples are run out-of-process (via pexpect) so they |
|
435 | # IPExternalExamples are run out-of-process (via pexpect) so they | |
429 | # don't need any filtering (a real ipython will be executing them). |
|
436 | # don't need any filtering (a real ipython will be executing them). | |
430 | terms = list(self._EXAMPLE_RE_IP.finditer(string)) |
|
437 | terms = list(self._EXAMPLE_RE_IP.finditer(string)) | |
431 | if self._EXTERNAL_IP.search(string): |
|
438 | if self._EXTERNAL_IP.search(string): | |
432 | #print '-'*70 # dbg |
|
439 | #print '-'*70 # dbg | |
433 | #print 'IPExternalExample, Source:\n',string # dbg |
|
440 | #print 'IPExternalExample, Source:\n',string # dbg | |
434 | #print '-'*70 # dbg |
|
441 | #print '-'*70 # dbg | |
435 | Example = IPExternalExample |
|
442 | Example = IPExternalExample | |
436 | else: |
|
443 | else: | |
437 | #print '-'*70 # dbg |
|
444 | #print '-'*70 # dbg | |
438 | #print 'IPExample, Source:\n',string # dbg |
|
445 | #print 'IPExample, Source:\n',string # dbg | |
439 | #print '-'*70 # dbg |
|
446 | #print '-'*70 # dbg | |
440 | Example = IPExample |
|
447 | Example = IPExample | |
441 | ip2py = True |
|
448 | ip2py = True | |
442 |
|
449 | |||
443 | for m in terms: |
|
450 | for m in terms: | |
444 | # Add the pre-example text to `output`. |
|
451 | # Add the pre-example text to `output`. | |
445 | output.append(string[charno:m.start()]) |
|
452 | output.append(string[charno:m.start()]) | |
446 | # Update lineno (lines before this example) |
|
453 | # Update lineno (lines before this example) | |
447 | lineno += string.count('\n', charno, m.start()) |
|
454 | lineno += string.count('\n', charno, m.start()) | |
448 | # Extract info from the regexp match. |
|
455 | # Extract info from the regexp match. | |
449 | (source, options, want, exc_msg) = \ |
|
456 | (source, options, want, exc_msg) = \ | |
450 | self._parse_example(m, name, lineno,ip2py) |
|
457 | self._parse_example(m, name, lineno,ip2py) | |
451 |
|
458 | |||
452 | # Append the random-output marker (it defaults to empty in most |
|
459 | # Append the random-output marker (it defaults to empty in most | |
453 | # cases, it's only non-empty for 'all-random' tests): |
|
460 | # cases, it's only non-empty for 'all-random' tests): | |
454 | want += random_marker |
|
461 | want += random_marker | |
455 |
|
462 | |||
456 | if Example is IPExternalExample: |
|
463 | if Example is IPExternalExample: | |
457 | options[doctest.NORMALIZE_WHITESPACE] = True |
|
464 | options[doctest.NORMALIZE_WHITESPACE] = True | |
458 | want += '\n' |
|
465 | want += '\n' | |
459 |
|
466 | |||
460 | # Create an Example, and add it to the list. |
|
467 | # Create an Example, and add it to the list. | |
461 | if not self._IS_BLANK_OR_COMMENT(source): |
|
468 | if not self._IS_BLANK_OR_COMMENT(source): | |
462 | output.append(Example(source, want, exc_msg, |
|
469 | output.append(Example(source, want, exc_msg, | |
463 | lineno=lineno, |
|
470 | lineno=lineno, | |
464 | indent=min_indent+len(m.group('indent')), |
|
471 | indent=min_indent+len(m.group('indent')), | |
465 | options=options)) |
|
472 | options=options)) | |
466 | # Update lineno (lines inside this example) |
|
473 | # Update lineno (lines inside this example) | |
467 | lineno += string.count('\n', m.start(), m.end()) |
|
474 | lineno += string.count('\n', m.start(), m.end()) | |
468 | # Update charno. |
|
475 | # Update charno. | |
469 | charno = m.end() |
|
476 | charno = m.end() | |
470 | # Add any remaining post-example text to `output`. |
|
477 | # Add any remaining post-example text to `output`. | |
471 | output.append(string[charno:]) |
|
478 | output.append(string[charno:]) | |
472 | return output |
|
479 | return output | |
473 |
|
480 | |||
474 | def _parse_example(self, m, name, lineno,ip2py=False): |
|
481 | def _parse_example(self, m, name, lineno,ip2py=False): | |
475 | """ |
|
482 | """ | |
476 | Given a regular expression match from `_EXAMPLE_RE` (`m`), |
|
483 | Given a regular expression match from `_EXAMPLE_RE` (`m`), | |
477 | return a pair `(source, want)`, where `source` is the matched |
|
484 | return a pair `(source, want)`, where `source` is the matched | |
478 | example's source code (with prompts and indentation stripped); |
|
485 | example's source code (with prompts and indentation stripped); | |
479 | and `want` is the example's expected output (with indentation |
|
486 | and `want` is the example's expected output (with indentation | |
480 | stripped). |
|
487 | stripped). | |
481 |
|
488 | |||
482 | `name` is the string's name, and `lineno` is the line number |
|
489 | `name` is the string's name, and `lineno` is the line number | |
483 | where the example starts; both are used for error messages. |
|
490 | where the example starts; both are used for error messages. | |
484 |
|
491 | |||
485 | Optional: |
|
492 | Optional: | |
486 | `ip2py`: if true, filter the input via IPython to convert the syntax |
|
493 | `ip2py`: if true, filter the input via IPython to convert the syntax | |
487 | into valid python. |
|
494 | into valid python. | |
488 | """ |
|
495 | """ | |
489 |
|
496 | |||
490 | # Get the example's indentation level. |
|
497 | # Get the example's indentation level. | |
491 | indent = len(m.group('indent')) |
|
498 | indent = len(m.group('indent')) | |
492 |
|
499 | |||
493 | # Divide source into lines; check that they're properly |
|
500 | # Divide source into lines; check that they're properly | |
494 | # indented; and then strip their indentation & prompts. |
|
501 | # indented; and then strip their indentation & prompts. | |
495 | source_lines = m.group('source').split('\n') |
|
502 | source_lines = m.group('source').split('\n') | |
496 |
|
503 | |||
497 | # We're using variable-length input prompts |
|
504 | # We're using variable-length input prompts | |
498 | ps1 = m.group('ps1') |
|
505 | ps1 = m.group('ps1') | |
499 | ps2 = m.group('ps2') |
|
506 | ps2 = m.group('ps2') | |
500 | ps1_len = len(ps1) |
|
507 | ps1_len = len(ps1) | |
501 |
|
508 | |||
502 | self._check_prompt_blank(source_lines, indent, name, lineno,ps1_len) |
|
509 | self._check_prompt_blank(source_lines, indent, name, lineno,ps1_len) | |
503 | if ps2: |
|
510 | if ps2: | |
504 | self._check_prefix(source_lines[1:], ' '*indent + ps2, name, lineno) |
|
511 | self._check_prefix(source_lines[1:], ' '*indent + ps2, name, lineno) | |
505 |
|
512 | |||
506 | source = '\n'.join([sl[indent+ps1_len+1:] for sl in source_lines]) |
|
513 | source = '\n'.join([sl[indent+ps1_len+1:] for sl in source_lines]) | |
507 |
|
514 | |||
508 | if ip2py: |
|
515 | if ip2py: | |
509 | # Convert source input from IPython into valid Python syntax |
|
516 | # Convert source input from IPython into valid Python syntax | |
510 | source = self.ip2py(source) |
|
517 | source = self.ip2py(source) | |
511 |
|
518 | |||
512 | # Divide want into lines; check that it's properly indented; and |
|
519 | # Divide want into lines; check that it's properly indented; and | |
513 | # then strip the indentation. Spaces before the last newline should |
|
520 | # then strip the indentation. Spaces before the last newline should | |
514 | # be preserved, so plain rstrip() isn't good enough. |
|
521 | # be preserved, so plain rstrip() isn't good enough. | |
515 | want = m.group('want') |
|
522 | want = m.group('want') | |
516 | want_lines = want.split('\n') |
|
523 | want_lines = want.split('\n') | |
517 | if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]): |
|
524 | if len(want_lines) > 1 and re.match(r' *$', want_lines[-1]): | |
518 | del want_lines[-1] # forget final newline & spaces after it |
|
525 | del want_lines[-1] # forget final newline & spaces after it | |
519 | self._check_prefix(want_lines, ' '*indent, name, |
|
526 | self._check_prefix(want_lines, ' '*indent, name, | |
520 | lineno + len(source_lines)) |
|
527 | lineno + len(source_lines)) | |
521 |
|
528 | |||
522 | # Remove ipython output prompt that might be present in the first line |
|
529 | # Remove ipython output prompt that might be present in the first line | |
523 | want_lines[0] = re.sub(r'Out\[\d+\]: \s*?\n?','',want_lines[0]) |
|
530 | want_lines[0] = re.sub(r'Out\[\d+\]: \s*?\n?','',want_lines[0]) | |
524 |
|
531 | |||
525 | want = '\n'.join([wl[indent:] for wl in want_lines]) |
|
532 | want = '\n'.join([wl[indent:] for wl in want_lines]) | |
526 |
|
533 | |||
527 | # If `want` contains a traceback message, then extract it. |
|
534 | # If `want` contains a traceback message, then extract it. | |
528 | m = self._EXCEPTION_RE.match(want) |
|
535 | m = self._EXCEPTION_RE.match(want) | |
529 | if m: |
|
536 | if m: | |
530 | exc_msg = m.group('msg') |
|
537 | exc_msg = m.group('msg') | |
531 | else: |
|
538 | else: | |
532 | exc_msg = None |
|
539 | exc_msg = None | |
533 |
|
540 | |||
534 | # Extract options from the source. |
|
541 | # Extract options from the source. | |
535 | options = self._find_options(source, name, lineno) |
|
542 | options = self._find_options(source, name, lineno) | |
536 |
|
543 | |||
537 | return source, options, want, exc_msg |
|
544 | return source, options, want, exc_msg | |
538 |
|
545 | |||
539 | def _check_prompt_blank(self, lines, indent, name, lineno, ps1_len): |
|
546 | def _check_prompt_blank(self, lines, indent, name, lineno, ps1_len): | |
540 | """ |
|
547 | """ | |
541 | Given the lines of a source string (including prompts and |
|
548 | Given the lines of a source string (including prompts and | |
542 | leading indentation), check to make sure that every prompt is |
|
549 | leading indentation), check to make sure that every prompt is | |
543 | followed by a space character. If any line is not followed by |
|
550 | followed by a space character. If any line is not followed by | |
544 | a space character, then raise ValueError. |
|
551 | a space character, then raise ValueError. | |
545 |
|
552 | |||
546 | Note: IPython-modified version which takes the input prompt length as a |
|
553 | Note: IPython-modified version which takes the input prompt length as a | |
547 | parameter, so that prompts of variable length can be dealt with. |
|
554 | parameter, so that prompts of variable length can be dealt with. | |
548 | """ |
|
555 | """ | |
549 | space_idx = indent+ps1_len |
|
556 | space_idx = indent+ps1_len | |
550 | min_len = space_idx+1 |
|
557 | min_len = space_idx+1 | |
551 | for i, line in enumerate(lines): |
|
558 | for i, line in enumerate(lines): | |
552 | if len(line) >= min_len and line[space_idx] != ' ': |
|
559 | if len(line) >= min_len and line[space_idx] != ' ': | |
553 | raise ValueError('line %r of the docstring for %s ' |
|
560 | raise ValueError('line %r of the docstring for %s ' | |
554 | 'lacks blank after %s: %r' % |
|
561 | 'lacks blank after %s: %r' % | |
555 | (lineno+i+1, name, |
|
562 | (lineno+i+1, name, | |
556 | line[indent:space_idx], line)) |
|
563 | line[indent:space_idx], line)) | |
557 |
|
564 | |||
558 |
|
565 | |||
559 | SKIP = doctest.register_optionflag('SKIP') |
|
566 | SKIP = doctest.register_optionflag('SKIP') | |
560 |
|
567 | |||
561 |
|
568 | |||
562 | class IPDocTestRunner(doctest.DocTestRunner,object): |
|
569 | class IPDocTestRunner(doctest.DocTestRunner,object): | |
563 | """Test runner that synchronizes the IPython namespace with test globals. |
|
570 | """Test runner that synchronizes the IPython namespace with test globals. | |
564 | """ |
|
571 | """ | |
565 |
|
572 | |||
566 | def run(self, test, compileflags=None, out=None, clear_globs=True): |
|
573 | def run(self, test, compileflags=None, out=None, clear_globs=True): | |
567 |
|
574 | |||
568 | # Hack: ipython needs access to the execution context of the example, |
|
575 | # Hack: ipython needs access to the execution context of the example, | |
569 | # so that it can propagate user variables loaded by %run into |
|
576 | # so that it can propagate user variables loaded by %run into | |
570 | # test.globs. We put them here into our modified %run as a function |
|
577 | # test.globs. We put them here into our modified %run as a function | |
571 | # attribute. Our new %run will then only make the namespace update |
|
578 | # attribute. Our new %run will then only make the namespace update | |
572 | # when called (rather than unconconditionally updating test.globs here |
|
579 | # when called (rather than unconconditionally updating test.globs here | |
573 | # for all examples, most of which won't be calling %run anyway). |
|
580 | # for all examples, most of which won't be calling %run anyway). | |
574 | #_ip._ipdoctest_test_globs = test.globs |
|
581 | #_ip._ipdoctest_test_globs = test.globs | |
575 | #_ip._ipdoctest_test_filename = test.filename |
|
582 | #_ip._ipdoctest_test_filename = test.filename | |
576 |
|
583 | |||
577 | test.globs.update(_ip.user_ns) |
|
584 | test.globs.update(_ip.user_ns) | |
578 |
|
585 | |||
579 | return super(IPDocTestRunner,self).run(test, |
|
586 | return super(IPDocTestRunner,self).run(test, | |
580 | compileflags,out,clear_globs) |
|
587 | compileflags,out,clear_globs) | |
581 |
|
588 | |||
582 |
|
589 | |||
583 | class DocFileCase(doctest.DocFileCase): |
|
590 | class DocFileCase(doctest.DocFileCase): | |
584 | """Overrides to provide filename |
|
591 | """Overrides to provide filename | |
585 | """ |
|
592 | """ | |
586 | def address(self): |
|
593 | def address(self): | |
587 | return (self._dt_test.filename, None, None) |
|
594 | return (self._dt_test.filename, None, None) | |
588 |
|
595 | |||
589 |
|
596 | |||
590 | class ExtensionDoctest(doctests.Doctest): |
|
597 | class ExtensionDoctest(doctests.Doctest): | |
591 | """Nose Plugin that supports doctests in extension modules. |
|
598 | """Nose Plugin that supports doctests in extension modules. | |
592 | """ |
|
599 | """ | |
593 | name = 'extdoctest' # call nosetests with --with-extdoctest |
|
600 | name = 'extdoctest' # call nosetests with --with-extdoctest | |
594 | enabled = True |
|
601 | enabled = True | |
595 |
|
602 | |||
596 | def __init__(self,exclude_patterns=None): |
|
603 | def __init__(self,exclude_patterns=None): | |
597 | """Create a new ExtensionDoctest plugin. |
|
604 | """Create a new ExtensionDoctest plugin. | |
598 |
|
605 | |||
599 | Parameters |
|
606 | Parameters | |
600 | ---------- |
|
607 | ---------- | |
601 |
|
608 | |||
602 | exclude_patterns : sequence of strings, optional |
|
609 | exclude_patterns : sequence of strings, optional | |
603 | These patterns are compiled as regular expressions, subsequently used |
|
610 | These patterns are compiled as regular expressions, subsequently used | |
604 | to exclude any filename which matches them from inclusion in the test |
|
611 | to exclude any filename which matches them from inclusion in the test | |
605 | suite (using pattern.search(), NOT pattern.match() ). |
|
612 | suite (using pattern.search(), NOT pattern.match() ). | |
606 | """ |
|
613 | """ | |
607 |
|
614 | |||
608 | if exclude_patterns is None: |
|
615 | if exclude_patterns is None: | |
609 | exclude_patterns = [] |
|
616 | exclude_patterns = [] | |
610 | self.exclude_patterns = map(re.compile,exclude_patterns) |
|
617 | self.exclude_patterns = map(re.compile,exclude_patterns) | |
611 | doctests.Doctest.__init__(self) |
|
618 | doctests.Doctest.__init__(self) | |
612 |
|
619 | |||
613 | def options(self, parser, env=os.environ): |
|
620 | def options(self, parser, env=os.environ): | |
614 | Plugin.options(self, parser, env) |
|
621 | Plugin.options(self, parser, env) | |
615 | parser.add_option('--doctest-tests', action='store_true', |
|
622 | parser.add_option('--doctest-tests', action='store_true', | |
616 | dest='doctest_tests', |
|
623 | dest='doctest_tests', | |
617 | default=env.get('NOSE_DOCTEST_TESTS',True), |
|
624 | default=env.get('NOSE_DOCTEST_TESTS',True), | |
618 | help="Also look for doctests in test modules. " |
|
625 | help="Also look for doctests in test modules. " | |
619 | "Note that classes, methods and functions should " |
|
626 | "Note that classes, methods and functions should " | |
620 | "have either doctests or non-doctest tests, " |
|
627 | "have either doctests or non-doctest tests, " | |
621 | "not both. [NOSE_DOCTEST_TESTS]") |
|
628 | "not both. [NOSE_DOCTEST_TESTS]") | |
622 | parser.add_option('--doctest-extension', action="append", |
|
629 | parser.add_option('--doctest-extension', action="append", | |
623 | dest="doctestExtension", |
|
630 | dest="doctestExtension", | |
624 | help="Also look for doctests in files with " |
|
631 | help="Also look for doctests in files with " | |
625 | "this extension [NOSE_DOCTEST_EXTENSION]") |
|
632 | "this extension [NOSE_DOCTEST_EXTENSION]") | |
626 | # Set the default as a list, if given in env; otherwise |
|
633 | # Set the default as a list, if given in env; otherwise | |
627 | # an additional value set on the command line will cause |
|
634 | # an additional value set on the command line will cause | |
628 | # an error. |
|
635 | # an error. | |
629 | env_setting = env.get('NOSE_DOCTEST_EXTENSION') |
|
636 | env_setting = env.get('NOSE_DOCTEST_EXTENSION') | |
630 | if env_setting is not None: |
|
637 | if env_setting is not None: | |
631 | parser.set_defaults(doctestExtension=tolist(env_setting)) |
|
638 | parser.set_defaults(doctestExtension=tolist(env_setting)) | |
632 |
|
639 | |||
633 |
|
640 | |||
634 | def configure(self, options, config): |
|
641 | def configure(self, options, config): | |
635 | Plugin.configure(self, options, config) |
|
642 | Plugin.configure(self, options, config) | |
636 | self.doctest_tests = options.doctest_tests |
|
643 | self.doctest_tests = options.doctest_tests | |
637 | self.extension = tolist(options.doctestExtension) |
|
644 | self.extension = tolist(options.doctestExtension) | |
638 |
|
645 | |||
639 | self.parser = doctest.DocTestParser() |
|
646 | self.parser = doctest.DocTestParser() | |
640 | self.finder = DocTestFinder() |
|
647 | self.finder = DocTestFinder() | |
641 | self.checker = IPDoctestOutputChecker() |
|
648 | self.checker = IPDoctestOutputChecker() | |
642 | self.globs = None |
|
649 | self.globs = None | |
643 | self.extraglobs = None |
|
650 | self.extraglobs = None | |
644 |
|
651 | |||
645 |
|
652 | |||
646 | def loadTestsFromExtensionModule(self,filename): |
|
653 | def loadTestsFromExtensionModule(self,filename): | |
647 | bpath,mod = os.path.split(filename) |
|
654 | bpath,mod = os.path.split(filename) | |
648 | modname = os.path.splitext(mod)[0] |
|
655 | modname = os.path.splitext(mod)[0] | |
649 | try: |
|
656 | try: | |
650 | sys.path.append(bpath) |
|
657 | sys.path.append(bpath) | |
651 | module = __import__(modname) |
|
658 | module = __import__(modname) | |
652 | tests = list(self.loadTestsFromModule(module)) |
|
659 | tests = list(self.loadTestsFromModule(module)) | |
653 | finally: |
|
660 | finally: | |
654 | sys.path.pop() |
|
661 | sys.path.pop() | |
655 | return tests |
|
662 | return tests | |
656 |
|
663 | |||
657 | # NOTE: the method below is almost a copy of the original one in nose, with |
|
664 | # NOTE: the method below is almost a copy of the original one in nose, with | |
658 | # a few modifications to control output checking. |
|
665 | # a few modifications to control output checking. | |
659 |
|
666 | |||
660 | def loadTestsFromModule(self, module): |
|
667 | def loadTestsFromModule(self, module): | |
661 | #print '*** ipdoctest - lTM',module # dbg |
|
668 | #print '*** ipdoctest - lTM',module # dbg | |
662 |
|
669 | |||
663 | if not self.matches(module.__name__): |
|
670 | if not self.matches(module.__name__): | |
664 | log.debug("Doctest doesn't want module %s", module) |
|
671 | log.debug("Doctest doesn't want module %s", module) | |
665 | return |
|
672 | return | |
666 |
|
673 | |||
667 | tests = self.finder.find(module,globs=self.globs, |
|
674 | tests = self.finder.find(module,globs=self.globs, | |
668 | extraglobs=self.extraglobs) |
|
675 | extraglobs=self.extraglobs) | |
669 | if not tests: |
|
676 | if not tests: | |
670 | return |
|
677 | return | |
671 |
|
678 | |||
672 | # always use whitespace and ellipsis options |
|
679 | # always use whitespace and ellipsis options | |
673 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
680 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS | |
674 |
|
681 | |||
675 | tests.sort() |
|
682 | tests.sort() | |
676 | module_file = module.__file__ |
|
683 | module_file = module.__file__ | |
677 | if module_file[-4:] in ('.pyc', '.pyo'): |
|
684 | if module_file[-4:] in ('.pyc', '.pyo'): | |
678 | module_file = module_file[:-1] |
|
685 | module_file = module_file[:-1] | |
679 | for test in tests: |
|
686 | for test in tests: | |
680 | if not test.examples: |
|
687 | if not test.examples: | |
681 | continue |
|
688 | continue | |
682 | if not test.filename: |
|
689 | if not test.filename: | |
683 | test.filename = module_file |
|
690 | test.filename = module_file | |
684 |
|
691 | |||
685 | yield DocTestCase(test, |
|
692 | yield DocTestCase(test, | |
686 | optionflags=optionflags, |
|
693 | optionflags=optionflags, | |
687 | checker=self.checker) |
|
694 | checker=self.checker) | |
688 |
|
695 | |||
689 |
|
696 | |||
690 | def loadTestsFromFile(self, filename): |
|
697 | def loadTestsFromFile(self, filename): | |
691 | #print "ipdoctest - from file", filename # dbg |
|
698 | #print "ipdoctest - from file", filename # dbg | |
692 | if is_extension_module(filename): |
|
699 | if is_extension_module(filename): | |
693 | for t in self.loadTestsFromExtensionModule(filename): |
|
700 | for t in self.loadTestsFromExtensionModule(filename): | |
694 | yield t |
|
701 | yield t | |
695 | else: |
|
702 | else: | |
696 | if self.extension and anyp(filename.endswith, self.extension): |
|
703 | if self.extension and anyp(filename.endswith, self.extension): | |
697 | name = os.path.basename(filename) |
|
704 | name = os.path.basename(filename) | |
698 | dh = open(filename) |
|
705 | dh = open(filename) | |
699 | try: |
|
706 | try: | |
700 | doc = dh.read() |
|
707 | doc = dh.read() | |
701 | finally: |
|
708 | finally: | |
702 | dh.close() |
|
709 | dh.close() | |
703 | test = self.parser.get_doctest( |
|
710 | test = self.parser.get_doctest( | |
704 | doc, globs={'__file__': filename}, name=name, |
|
711 | doc, globs={'__file__': filename}, name=name, | |
705 | filename=filename, lineno=0) |
|
712 | filename=filename, lineno=0) | |
706 | if test.examples: |
|
713 | if test.examples: | |
707 | #print 'FileCase:',test.examples # dbg |
|
714 | #print 'FileCase:',test.examples # dbg | |
708 | yield DocFileCase(test) |
|
715 | yield DocFileCase(test) | |
709 | else: |
|
716 | else: | |
710 | yield False # no tests to load |
|
717 | yield False # no tests to load | |
711 |
|
718 | |||
712 | def wantFile(self,filename): |
|
719 | def wantFile(self,filename): | |
713 | """Return whether the given filename should be scanned for tests. |
|
720 | """Return whether the given filename should be scanned for tests. | |
714 |
|
721 | |||
715 | Modified version that accepts extension modules as valid containers for |
|
722 | Modified version that accepts extension modules as valid containers for | |
716 | doctests. |
|
723 | doctests. | |
717 | """ |
|
724 | """ | |
718 | #print '*** ipdoctest- wantFile:',filename # dbg |
|
725 | #print '*** ipdoctest- wantFile:',filename # dbg | |
719 |
|
726 | |||
720 | for pat in self.exclude_patterns: |
|
727 | for pat in self.exclude_patterns: | |
721 | if pat.search(filename): |
|
728 | if pat.search(filename): | |
722 | # print '###>>> SKIP:',filename # dbg |
|
729 | # print '###>>> SKIP:',filename # dbg | |
723 | return False |
|
730 | return False | |
724 |
|
731 | |||
725 | if is_extension_module(filename): |
|
732 | if is_extension_module(filename): | |
726 | return True |
|
733 | return True | |
727 | else: |
|
734 | else: | |
728 | return doctests.Doctest.wantFile(self,filename) |
|
735 | return doctests.Doctest.wantFile(self,filename) | |
729 |
|
736 | |||
730 |
|
737 | |||
731 | class IPythonDoctest(ExtensionDoctest): |
|
738 | class IPythonDoctest(ExtensionDoctest): | |
732 | """Nose Plugin that supports doctests in extension modules. |
|
739 | """Nose Plugin that supports doctests in extension modules. | |
733 | """ |
|
740 | """ | |
734 | name = 'ipdoctest' # call nosetests with --with-ipdoctest |
|
741 | name = 'ipdoctest' # call nosetests with --with-ipdoctest | |
735 | enabled = True |
|
742 | enabled = True | |
736 |
|
743 | |||
737 | def makeTest(self, obj, parent): |
|
744 | def makeTest(self, obj, parent): | |
738 | """Look for doctests in the given object, which will be a |
|
745 | """Look for doctests in the given object, which will be a | |
739 | function, method or class. |
|
746 | function, method or class. | |
740 | """ |
|
747 | """ | |
741 | #print 'Plugin analyzing:', obj, parent # dbg |
|
748 | #print 'Plugin analyzing:', obj, parent # dbg | |
742 | # always use whitespace and ellipsis options |
|
749 | # always use whitespace and ellipsis options | |
743 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
750 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS | |
744 |
|
751 | |||
745 | doctests = self.finder.find(obj, module=getmodule(parent)) |
|
752 | doctests = self.finder.find(obj, module=getmodule(parent)) | |
746 | if doctests: |
|
753 | if doctests: | |
747 | for test in doctests: |
|
754 | for test in doctests: | |
748 | if len(test.examples) == 0: |
|
755 | if len(test.examples) == 0: | |
749 | continue |
|
756 | continue | |
750 |
|
757 | |||
751 | yield DocTestCase(test, obj=obj, |
|
758 | yield DocTestCase(test, obj=obj, | |
752 | optionflags=optionflags, |
|
759 | optionflags=optionflags, | |
753 | checker=self.checker) |
|
760 | checker=self.checker) | |
754 |
|
761 | |||
755 | def options(self, parser, env=os.environ): |
|
762 | def options(self, parser, env=os.environ): | |
756 | #print "Options for nose plugin:", self.name # dbg |
|
763 | #print "Options for nose plugin:", self.name # dbg | |
757 | Plugin.options(self, parser, env) |
|
764 | Plugin.options(self, parser, env) | |
758 | parser.add_option('--ipdoctest-tests', action='store_true', |
|
765 | parser.add_option('--ipdoctest-tests', action='store_true', | |
759 | dest='ipdoctest_tests', |
|
766 | dest='ipdoctest_tests', | |
760 | default=env.get('NOSE_IPDOCTEST_TESTS',True), |
|
767 | default=env.get('NOSE_IPDOCTEST_TESTS',True), | |
761 | help="Also look for doctests in test modules. " |
|
768 | help="Also look for doctests in test modules. " | |
762 | "Note that classes, methods and functions should " |
|
769 | "Note that classes, methods and functions should " | |
763 | "have either doctests or non-doctest tests, " |
|
770 | "have either doctests or non-doctest tests, " | |
764 | "not both. [NOSE_IPDOCTEST_TESTS]") |
|
771 | "not both. [NOSE_IPDOCTEST_TESTS]") | |
765 | parser.add_option('--ipdoctest-extension', action="append", |
|
772 | parser.add_option('--ipdoctest-extension', action="append", | |
766 | dest="ipdoctest_extension", |
|
773 | dest="ipdoctest_extension", | |
767 | help="Also look for doctests in files with " |
|
774 | help="Also look for doctests in files with " | |
768 | "this extension [NOSE_IPDOCTEST_EXTENSION]") |
|
775 | "this extension [NOSE_IPDOCTEST_EXTENSION]") | |
769 | # Set the default as a list, if given in env; otherwise |
|
776 | # Set the default as a list, if given in env; otherwise | |
770 | # an additional value set on the command line will cause |
|
777 | # an additional value set on the command line will cause | |
771 | # an error. |
|
778 | # an error. | |
772 | env_setting = env.get('NOSE_IPDOCTEST_EXTENSION') |
|
779 | env_setting = env.get('NOSE_IPDOCTEST_EXTENSION') | |
773 | if env_setting is not None: |
|
780 | if env_setting is not None: | |
774 | parser.set_defaults(ipdoctest_extension=tolist(env_setting)) |
|
781 | parser.set_defaults(ipdoctest_extension=tolist(env_setting)) | |
775 |
|
782 | |||
776 | def configure(self, options, config): |
|
783 | def configure(self, options, config): | |
777 | #print "Configuring nose plugin:", self.name # dbg |
|
784 | #print "Configuring nose plugin:", self.name # dbg | |
778 | Plugin.configure(self, options, config) |
|
785 | Plugin.configure(self, options, config) | |
779 | self.doctest_tests = options.ipdoctest_tests |
|
786 | self.doctest_tests = options.ipdoctest_tests | |
780 | self.extension = tolist(options.ipdoctest_extension) |
|
787 | self.extension = tolist(options.ipdoctest_extension) | |
781 |
|
788 | |||
782 | self.parser = IPDocTestParser() |
|
789 | self.parser = IPDocTestParser() | |
783 | self.finder = DocTestFinder(parser=self.parser) |
|
790 | self.finder = DocTestFinder(parser=self.parser) | |
784 | self.checker = IPDoctestOutputChecker() |
|
791 | self.checker = IPDoctestOutputChecker() | |
785 | self.globs = None |
|
792 | self.globs = None | |
786 | self.extraglobs = None |
|
793 | self.extraglobs = None |
1 | NO CONTENT: file was removed |
|
NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now