Show More
@@ -1,111 +1,111 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Configuration loader |
|
2 | """Configuration loader | |
3 | """ |
|
3 | """ | |
4 |
|
4 | |||
5 | #***************************************************************************** |
|
5 | #***************************************************************************** | |
6 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
7 | # |
|
7 | # | |
8 | # Distributed under the terms of the BSD License. The full license is in |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
9 | # the file COPYING, distributed as part of this software. |
|
9 | # the file COPYING, distributed as part of this software. | |
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 |
|
11 | |||
12 | import exceptions |
|
12 | import exceptions | |
13 | import os |
|
13 | import os | |
14 | from pprint import pprint |
|
14 | from pprint import pprint | |
15 |
|
15 | |||
16 |
from IPython import ultra |
|
16 | from IPython.core import ultratb | |
17 | from IPython.utils.ipstruct import Struct |
|
17 | from IPython.utils.ipstruct import Struct | |
18 | from IPython.utils.genutils import * |
|
18 | from IPython.utils.genutils import * | |
19 |
|
19 | |||
20 | class ConfigLoaderError(exceptions.Exception): |
|
20 | class ConfigLoaderError(exceptions.Exception): | |
21 | """Exception for ConfigLoader class.""" |
|
21 | """Exception for ConfigLoader class.""" | |
22 |
|
22 | |||
23 | def __init__(self,args=None): |
|
23 | def __init__(self,args=None): | |
24 | self.args = args |
|
24 | self.args = args | |
25 |
|
25 | |||
26 | class ConfigLoader: |
|
26 | class ConfigLoader: | |
27 |
|
27 | |||
28 | """Configuration file loader capable of handling recursive inclusions and |
|
28 | """Configuration file loader capable of handling recursive inclusions and | |
29 | with parametrized conflict resolution for multiply found keys.""" |
|
29 | with parametrized conflict resolution for multiply found keys.""" | |
30 |
|
30 | |||
31 | def __init__(self,conflict=None,field_sep=None,reclimit=15): |
|
31 | def __init__(self,conflict=None,field_sep=None,reclimit=15): | |
32 |
|
32 | |||
33 | """The reclimit parameter controls the number of recursive |
|
33 | """The reclimit parameter controls the number of recursive | |
34 | configuration file inclusions. This way we can stop early on (before |
|
34 | configuration file inclusions. This way we can stop early on (before | |
35 | python's own recursion limit is hit) if there is a circular |
|
35 | python's own recursion limit is hit) if there is a circular | |
36 | inclusion. |
|
36 | inclusion. | |
37 |
|
37 | |||
38 | - conflict: dictionary for conflict resolutions (see Struct.merge()) |
|
38 | - conflict: dictionary for conflict resolutions (see Struct.merge()) | |
39 |
|
39 | |||
40 | """ |
|
40 | """ | |
41 | self.conflict = conflict |
|
41 | self.conflict = conflict | |
42 | self.field_sep = field_sep |
|
42 | self.field_sep = field_sep | |
43 | self.reset(reclimit) |
|
43 | self.reset(reclimit) | |
44 |
|
44 | |||
45 | def reset(self,reclimit=15): |
|
45 | def reset(self,reclimit=15): | |
46 | self.reclimit = reclimit |
|
46 | self.reclimit = reclimit | |
47 | self.recdepth = 0 |
|
47 | self.recdepth = 0 | |
48 | self.included = [] |
|
48 | self.included = [] | |
49 |
|
49 | |||
50 | def load(self,fname,convert=None,recurse_key='',incpath = '.',**kw): |
|
50 | def load(self,fname,convert=None,recurse_key='',incpath = '.',**kw): | |
51 | """Load a configuration file, return the resulting Struct. |
|
51 | """Load a configuration file, return the resulting Struct. | |
52 |
|
52 | |||
53 | Call: load_config(fname,convert=None,conflict=None,recurse_key='') |
|
53 | Call: load_config(fname,convert=None,conflict=None,recurse_key='') | |
54 |
|
54 | |||
55 | - fname: file to load from. |
|
55 | - fname: file to load from. | |
56 | - convert: dictionary of type conversions (see read_dict()) |
|
56 | - convert: dictionary of type conversions (see read_dict()) | |
57 | - recurse_key: keyword in dictionary to trigger recursive file |
|
57 | - recurse_key: keyword in dictionary to trigger recursive file | |
58 | inclusions. |
|
58 | inclusions. | |
59 | """ |
|
59 | """ | |
60 |
|
60 | |||
61 | if self.recdepth > self.reclimit: |
|
61 | if self.recdepth > self.reclimit: | |
62 | raise ConfigLoaderError, 'maximum recursive inclusion of rcfiles '+\ |
|
62 | raise ConfigLoaderError, 'maximum recursive inclusion of rcfiles '+\ | |
63 | 'exceeded: ' + `self.recdepth` + \ |
|
63 | 'exceeded: ' + `self.recdepth` + \ | |
64 | '.\nMaybe you have a circular chain of inclusions?' |
|
64 | '.\nMaybe you have a circular chain of inclusions?' | |
65 | self.recdepth += 1 |
|
65 | self.recdepth += 1 | |
66 | fname = filefind(fname,incpath) |
|
66 | fname = filefind(fname,incpath) | |
67 | data = Struct() |
|
67 | data = Struct() | |
68 | # avoid including the same file more than once |
|
68 | # avoid including the same file more than once | |
69 | if fname in self.included: |
|
69 | if fname in self.included: | |
70 | return data |
|
70 | return data | |
71 |
Xinfo = ultra |
|
71 | Xinfo = ultratb.AutoFormattedTB(color_scheme='NoColor') | |
72 | if convert==None and recurse_key : convert = {qwflat:recurse_key} |
|
72 | if convert==None and recurse_key : convert = {qwflat:recurse_key} | |
73 | # for production, change warn to 0: |
|
73 | # for production, change warn to 0: | |
74 | data.merge(read_dict(fname,convert,fs=self.field_sep,strip=1, |
|
74 | data.merge(read_dict(fname,convert,fs=self.field_sep,strip=1, | |
75 | warn=0,no_empty=0,**kw)) |
|
75 | warn=0,no_empty=0,**kw)) | |
76 | # keep track of successfully loaded files |
|
76 | # keep track of successfully loaded files | |
77 | self.included.append(fname) |
|
77 | self.included.append(fname) | |
78 | if recurse_key in data: |
|
78 | if recurse_key in data: | |
79 | for incfilename in data[recurse_key]: |
|
79 | for incfilename in data[recurse_key]: | |
80 | found=0 |
|
80 | found=0 | |
81 | try: |
|
81 | try: | |
82 | incfile = filefind(incfilename,incpath) |
|
82 | incfile = filefind(incfilename,incpath) | |
83 | except IOError: |
|
83 | except IOError: | |
84 | if os.name in ['nt','dos']: |
|
84 | if os.name in ['nt','dos']: | |
85 | try: |
|
85 | try: | |
86 | # Try again with '.ini' extension |
|
86 | # Try again with '.ini' extension | |
87 | incfilename += '.ini' |
|
87 | incfilename += '.ini' | |
88 | incfile = filefind(incfilename,incpath) |
|
88 | incfile = filefind(incfilename,incpath) | |
89 | except IOError: |
|
89 | except IOError: | |
90 | found = 0 |
|
90 | found = 0 | |
91 | else: |
|
91 | else: | |
92 | found = 1 |
|
92 | found = 1 | |
93 | else: |
|
93 | else: | |
94 | found = 0 |
|
94 | found = 0 | |
95 | else: |
|
95 | else: | |
96 | found = 1 |
|
96 | found = 1 | |
97 | if found: |
|
97 | if found: | |
98 | try: |
|
98 | try: | |
99 | data.merge(self.load(incfile,convert,recurse_key, |
|
99 | data.merge(self.load(incfile,convert,recurse_key, | |
100 | incpath,**kw), |
|
100 | incpath,**kw), | |
101 | self.conflict) |
|
101 | self.conflict) | |
102 | except: |
|
102 | except: | |
103 | Xinfo() |
|
103 | Xinfo() | |
104 | warn('Problem loading included file: '+ |
|
104 | warn('Problem loading included file: '+ | |
105 | `incfilename` + '. Ignoring it...') |
|
105 | `incfilename` + '. Ignoring it...') | |
106 | else: |
|
106 | else: | |
107 | warn('File `%s` not found. Included by %s' % (incfilename,fname)) |
|
107 | warn('File `%s` not found. Included by %s' % (incfilename,fname)) | |
108 |
|
108 | |||
109 | return data |
|
109 | return data | |
110 |
|
110 | |||
111 | # end ConfigLoader |
|
111 | # end ConfigLoader |
@@ -1,639 +1,639 b'' | |||||
1 | """Word completion for IPython. |
|
1 | """Word completion for IPython. | |
2 |
|
2 | |||
3 | This module is a fork of the rlcompleter module in the Python standard |
|
3 | This module is a fork of the rlcompleter module in the Python standard | |
4 | library. The original enhancements made to rlcompleter have been sent |
|
4 | library. The original enhancements made to rlcompleter have been sent | |
5 | upstream and were accepted as of Python 2.3, but we need a lot more |
|
5 | upstream and were accepted as of Python 2.3, but we need a lot more | |
6 | functionality specific to IPython, so this module will continue to live as an |
|
6 | functionality specific to IPython, so this module will continue to live as an | |
7 | IPython-specific utility. |
|
7 | IPython-specific utility. | |
8 |
|
8 | |||
9 | Original rlcompleter documentation: |
|
9 | Original rlcompleter documentation: | |
10 |
|
10 | |||
11 | This requires the latest extension to the readline module (the |
|
11 | This requires the latest extension to the readline module (the | |
12 | completes keywords, built-ins and globals in __main__; when completing |
|
12 | completes keywords, built-ins and globals in __main__; when completing | |
13 | NAME.NAME..., it evaluates (!) the expression up to the last dot and |
|
13 | NAME.NAME..., it evaluates (!) the expression up to the last dot and | |
14 | completes its attributes. |
|
14 | completes its attributes. | |
15 |
|
15 | |||
16 | It's very cool to do "import string" type "string.", hit the |
|
16 | It's very cool to do "import string" type "string.", hit the | |
17 | completion key (twice), and see the list of names defined by the |
|
17 | completion key (twice), and see the list of names defined by the | |
18 | string module! |
|
18 | string module! | |
19 |
|
19 | |||
20 | Tip: to use the tab key as the completion key, call |
|
20 | Tip: to use the tab key as the completion key, call | |
21 |
|
21 | |||
22 | readline.parse_and_bind("tab: complete") |
|
22 | readline.parse_and_bind("tab: complete") | |
23 |
|
23 | |||
24 | Notes: |
|
24 | Notes: | |
25 |
|
25 | |||
26 | - Exceptions raised by the completer function are *ignored* (and |
|
26 | - Exceptions raised by the completer function are *ignored* (and | |
27 | generally cause the completion to fail). This is a feature -- since |
|
27 | generally cause the completion to fail). This is a feature -- since | |
28 | readline sets the tty device in raw (or cbreak) mode, printing a |
|
28 | readline sets the tty device in raw (or cbreak) mode, printing a | |
29 | traceback wouldn't work well without some complicated hoopla to save, |
|
29 | traceback wouldn't work well without some complicated hoopla to save, | |
30 | reset and restore the tty state. |
|
30 | reset and restore the tty state. | |
31 |
|
31 | |||
32 | - The evaluation of the NAME.NAME... form may cause arbitrary |
|
32 | - The evaluation of the NAME.NAME... form may cause arbitrary | |
33 | application defined code to be executed if an object with a |
|
33 | application defined code to be executed if an object with a | |
34 | __getattr__ hook is found. Since it is the responsibility of the |
|
34 | __getattr__ hook is found. Since it is the responsibility of the | |
35 | application (or the user) to enable this feature, I consider this an |
|
35 | application (or the user) to enable this feature, I consider this an | |
36 | acceptable risk. More complicated expressions (e.g. function calls or |
|
36 | acceptable risk. More complicated expressions (e.g. function calls or | |
37 | indexing operations) are *not* evaluated. |
|
37 | indexing operations) are *not* evaluated. | |
38 |
|
38 | |||
39 | - GNU readline is also used by the built-in functions input() and |
|
39 | - GNU readline is also used by the built-in functions input() and | |
40 | raw_input(), and thus these also benefit/suffer from the completer |
|
40 | raw_input(), and thus these also benefit/suffer from the completer | |
41 | features. Clearly an interactive application can benefit by |
|
41 | features. Clearly an interactive application can benefit by | |
42 | specifying its own completer function and using raw_input() for all |
|
42 | specifying its own completer function and using raw_input() for all | |
43 | its input. |
|
43 | its input. | |
44 |
|
44 | |||
45 | - When the original stdin is not a tty device, GNU readline is never |
|
45 | - When the original stdin is not a tty device, GNU readline is never | |
46 | used, and this module (and the readline module) are silently inactive. |
|
46 | used, and this module (and the readline module) are silently inactive. | |
47 |
|
47 | |||
48 | """ |
|
48 | """ | |
49 |
|
49 | |||
50 | #***************************************************************************** |
|
50 | #***************************************************************************** | |
51 | # |
|
51 | # | |
52 | # Since this file is essentially a minimally modified copy of the rlcompleter |
|
52 | # Since this file is essentially a minimally modified copy of the rlcompleter | |
53 | # module which is part of the standard Python distribution, I assume that the |
|
53 | # module which is part of the standard Python distribution, I assume that the | |
54 | # proper procedure is to maintain its copyright as belonging to the Python |
|
54 | # proper procedure is to maintain its copyright as belonging to the Python | |
55 | # Software Foundation (in addition to my own, for all new code). |
|
55 | # Software Foundation (in addition to my own, for all new code). | |
56 | # |
|
56 | # | |
57 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
57 | # Copyright (C) 2001 Python Software Foundation, www.python.org | |
58 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
58 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
59 | # |
|
59 | # | |
60 | # Distributed under the terms of the BSD License. The full license is in |
|
60 | # Distributed under the terms of the BSD License. The full license is in | |
61 | # the file COPYING, distributed as part of this software. |
|
61 | # the file COPYING, distributed as part of this software. | |
62 | # |
|
62 | # | |
63 | #***************************************************************************** |
|
63 | #***************************************************************************** | |
64 |
|
64 | |||
65 | import __builtin__ |
|
65 | import __builtin__ | |
66 | import __main__ |
|
66 | import __main__ | |
67 | import glob |
|
67 | import glob | |
68 | import keyword |
|
68 | import keyword | |
69 | import os |
|
69 | import os | |
70 | import re |
|
70 | import re | |
71 | import shlex |
|
71 | import shlex | |
72 | import sys |
|
72 | import sys | |
73 | import IPython.utils.rlineimpl as readline |
|
73 | import IPython.utils.rlineimpl as readline | |
74 | import itertools |
|
74 | import itertools | |
75 | from IPython.utils.ipstruct import Struct |
|
75 | from IPython.utils.ipstruct import Struct | |
76 | from IPython.core import ipapi |
|
76 | from IPython.core import ipapi | |
77 | from IPython.utils import generics |
|
77 | from IPython.utils import generics | |
78 | import types |
|
78 | import types | |
79 |
|
79 | |||
80 | # Python 2.4 offers sets as a builtin |
|
80 | # Python 2.4 offers sets as a builtin | |
81 | try: |
|
81 | try: | |
82 | set() |
|
82 | set() | |
83 | except NameError: |
|
83 | except NameError: | |
84 | from sets import Set as set |
|
84 | from sets import Set as set | |
85 |
|
85 | |||
86 | from IPython.utils.genutils import debugx, dir2 |
|
86 | from IPython.utils.genutils import debugx, dir2 | |
87 |
|
87 | |||
88 | __all__ = ['Completer','IPCompleter'] |
|
88 | __all__ = ['Completer','IPCompleter'] | |
89 |
|
89 | |||
90 | class Completer: |
|
90 | class Completer: | |
91 | def __init__(self,namespace=None,global_namespace=None): |
|
91 | def __init__(self,namespace=None,global_namespace=None): | |
92 | """Create a new completer for the command line. |
|
92 | """Create a new completer for the command line. | |
93 |
|
93 | |||
94 | Completer([namespace,global_namespace]) -> completer instance. |
|
94 | Completer([namespace,global_namespace]) -> completer instance. | |
95 |
|
95 | |||
96 | If unspecified, the default namespace where completions are performed |
|
96 | If unspecified, the default namespace where completions are performed | |
97 | is __main__ (technically, __main__.__dict__). Namespaces should be |
|
97 | is __main__ (technically, __main__.__dict__). Namespaces should be | |
98 | given as dictionaries. |
|
98 | given as dictionaries. | |
99 |
|
99 | |||
100 | An optional second namespace can be given. This allows the completer |
|
100 | An optional second namespace can be given. This allows the completer | |
101 | to handle cases where both the local and global scopes need to be |
|
101 | to handle cases where both the local and global scopes need to be | |
102 | distinguished. |
|
102 | distinguished. | |
103 |
|
103 | |||
104 | Completer instances should be used as the completion mechanism of |
|
104 | Completer instances should be used as the completion mechanism of | |
105 | readline via the set_completer() call: |
|
105 | readline via the set_completer() call: | |
106 |
|
106 | |||
107 | readline.set_completer(Completer(my_namespace).complete) |
|
107 | readline.set_completer(Completer(my_namespace).complete) | |
108 | """ |
|
108 | """ | |
109 |
|
109 | |||
110 | # Don't bind to namespace quite yet, but flag whether the user wants a |
|
110 | # Don't bind to namespace quite yet, but flag whether the user wants a | |
111 | # specific namespace or to use __main__.__dict__. This will allow us |
|
111 | # specific namespace or to use __main__.__dict__. This will allow us | |
112 | # to bind to __main__.__dict__ at completion time, not now. |
|
112 | # to bind to __main__.__dict__ at completion time, not now. | |
113 | if namespace is None: |
|
113 | if namespace is None: | |
114 | self.use_main_ns = 1 |
|
114 | self.use_main_ns = 1 | |
115 | else: |
|
115 | else: | |
116 | self.use_main_ns = 0 |
|
116 | self.use_main_ns = 0 | |
117 | self.namespace = namespace |
|
117 | self.namespace = namespace | |
118 |
|
118 | |||
119 | # The global namespace, if given, can be bound directly |
|
119 | # The global namespace, if given, can be bound directly | |
120 | if global_namespace is None: |
|
120 | if global_namespace is None: | |
121 | self.global_namespace = {} |
|
121 | self.global_namespace = {} | |
122 | else: |
|
122 | else: | |
123 | self.global_namespace = global_namespace |
|
123 | self.global_namespace = global_namespace | |
124 |
|
124 | |||
125 | def complete(self, text, state): |
|
125 | def complete(self, text, state): | |
126 | """Return the next possible completion for 'text'. |
|
126 | """Return the next possible completion for 'text'. | |
127 |
|
127 | |||
128 | This is called successively with state == 0, 1, 2, ... until it |
|
128 | This is called successively with state == 0, 1, 2, ... until it | |
129 | returns None. The completion should begin with 'text'. |
|
129 | returns None. The completion should begin with 'text'. | |
130 |
|
130 | |||
131 | """ |
|
131 | """ | |
132 | if self.use_main_ns: |
|
132 | if self.use_main_ns: | |
133 | self.namespace = __main__.__dict__ |
|
133 | self.namespace = __main__.__dict__ | |
134 |
|
134 | |||
135 | if state == 0: |
|
135 | if state == 0: | |
136 | if "." in text: |
|
136 | if "." in text: | |
137 | self.matches = self.attr_matches(text) |
|
137 | self.matches = self.attr_matches(text) | |
138 | else: |
|
138 | else: | |
139 | self.matches = self.global_matches(text) |
|
139 | self.matches = self.global_matches(text) | |
140 | try: |
|
140 | try: | |
141 | return self.matches[state] |
|
141 | return self.matches[state] | |
142 | except IndexError: |
|
142 | except IndexError: | |
143 | return None |
|
143 | return None | |
144 |
|
144 | |||
145 | def global_matches(self, text): |
|
145 | def global_matches(self, text): | |
146 | """Compute matches when text is a simple name. |
|
146 | """Compute matches when text is a simple name. | |
147 |
|
147 | |||
148 | Return a list of all keywords, built-in functions and names currently |
|
148 | Return a list of all keywords, built-in functions and names currently | |
149 | defined in self.namespace or self.global_namespace that match. |
|
149 | defined in self.namespace or self.global_namespace that match. | |
150 |
|
150 | |||
151 | """ |
|
151 | """ | |
152 | matches = [] |
|
152 | matches = [] | |
153 | match_append = matches.append |
|
153 | match_append = matches.append | |
154 | n = len(text) |
|
154 | n = len(text) | |
155 | for lst in [keyword.kwlist, |
|
155 | for lst in [keyword.kwlist, | |
156 | __builtin__.__dict__.keys(), |
|
156 | __builtin__.__dict__.keys(), | |
157 | self.namespace.keys(), |
|
157 | self.namespace.keys(), | |
158 | self.global_namespace.keys()]: |
|
158 | self.global_namespace.keys()]: | |
159 | for word in lst: |
|
159 | for word in lst: | |
160 | if word[:n] == text and word != "__builtins__": |
|
160 | if word[:n] == text and word != "__builtins__": | |
161 | match_append(word) |
|
161 | match_append(word) | |
162 | return matches |
|
162 | return matches | |
163 |
|
163 | |||
164 | def attr_matches(self, text): |
|
164 | def attr_matches(self, text): | |
165 | """Compute matches when text contains a dot. |
|
165 | """Compute matches when text contains a dot. | |
166 |
|
166 | |||
167 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
167 | Assuming the text is of the form NAME.NAME....[NAME], and is | |
168 | evaluatable in self.namespace or self.global_namespace, it will be |
|
168 | evaluatable in self.namespace or self.global_namespace, it will be | |
169 | evaluated and its attributes (as revealed by dir()) are used as |
|
169 | evaluated and its attributes (as revealed by dir()) are used as | |
170 | possible completions. (For class instances, class members are are |
|
170 | possible completions. (For class instances, class members are are | |
171 | also considered.) |
|
171 | also considered.) | |
172 |
|
172 | |||
173 | WARNING: this can still invoke arbitrary C code, if an object |
|
173 | WARNING: this can still invoke arbitrary C code, if an object | |
174 | with a __getattr__ hook is evaluated. |
|
174 | with a __getattr__ hook is evaluated. | |
175 |
|
175 | |||
176 | """ |
|
176 | """ | |
177 | import re |
|
177 | import re | |
178 |
|
178 | |||
179 | # Another option, seems to work great. Catches things like ''.<tab> |
|
179 | # Another option, seems to work great. Catches things like ''.<tab> | |
180 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
180 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) | |
181 |
|
181 | |||
182 | if not m: |
|
182 | if not m: | |
183 | return [] |
|
183 | return [] | |
184 |
|
184 | |||
185 | expr, attr = m.group(1, 3) |
|
185 | expr, attr = m.group(1, 3) | |
186 | try: |
|
186 | try: | |
187 | obj = eval(expr, self.namespace) |
|
187 | obj = eval(expr, self.namespace) | |
188 | except: |
|
188 | except: | |
189 | try: |
|
189 | try: | |
190 | obj = eval(expr, self.global_namespace) |
|
190 | obj = eval(expr, self.global_namespace) | |
191 | except: |
|
191 | except: | |
192 | return [] |
|
192 | return [] | |
193 |
|
193 | |||
194 | words = dir2(obj) |
|
194 | words = dir2(obj) | |
195 |
|
195 | |||
196 | try: |
|
196 | try: | |
197 | words = generics.complete_object(obj, words) |
|
197 | words = generics.complete_object(obj, words) | |
198 | except ipapi.TryNext: |
|
198 | except ipapi.TryNext: | |
199 | pass |
|
199 | pass | |
200 | # Build match list to return |
|
200 | # Build match list to return | |
201 | n = len(attr) |
|
201 | n = len(attr) | |
202 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
202 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] | |
203 | return res |
|
203 | return res | |
204 |
|
204 | |||
205 | class IPCompleter(Completer): |
|
205 | class IPCompleter(Completer): | |
206 | """Extension of the completer class with IPython-specific features""" |
|
206 | """Extension of the completer class with IPython-specific features""" | |
207 |
|
207 | |||
208 | def __init__(self,shell,namespace=None,global_namespace=None, |
|
208 | def __init__(self,shell,namespace=None,global_namespace=None, | |
209 | omit__names=0,alias_table=None): |
|
209 | omit__names=0,alias_table=None): | |
210 | """IPCompleter() -> completer |
|
210 | """IPCompleter() -> completer | |
211 |
|
211 | |||
212 | Return a completer object suitable for use by the readline library |
|
212 | Return a completer object suitable for use by the readline library | |
213 | via readline.set_completer(). |
|
213 | via readline.set_completer(). | |
214 |
|
214 | |||
215 | Inputs: |
|
215 | Inputs: | |
216 |
|
216 | |||
217 | - shell: a pointer to the ipython shell itself. This is needed |
|
217 | - shell: a pointer to the ipython shell itself. This is needed | |
218 | because this completer knows about magic functions, and those can |
|
218 | because this completer knows about magic functions, and those can | |
219 | only be accessed via the ipython instance. |
|
219 | only be accessed via the ipython instance. | |
220 |
|
220 | |||
221 | - namespace: an optional dict where completions are performed. |
|
221 | - namespace: an optional dict where completions are performed. | |
222 |
|
222 | |||
223 | - global_namespace: secondary optional dict for completions, to |
|
223 | - global_namespace: secondary optional dict for completions, to | |
224 | handle cases (such as IPython embedded inside functions) where |
|
224 | handle cases (such as IPython embedded inside functions) where | |
225 | both Python scopes are visible. |
|
225 | both Python scopes are visible. | |
226 |
|
226 | |||
227 | - The optional omit__names parameter sets the completer to omit the |
|
227 | - The optional omit__names parameter sets the completer to omit the | |
228 | 'magic' names (__magicname__) for python objects unless the text |
|
228 | 'magic' names (__magicname__) for python objects unless the text | |
229 | to be completed explicitly starts with one or more underscores. |
|
229 | to be completed explicitly starts with one or more underscores. | |
230 |
|
230 | |||
231 | - If alias_table is supplied, it should be a dictionary of aliases |
|
231 | - If alias_table is supplied, it should be a dictionary of aliases | |
232 | to complete. """ |
|
232 | to complete. """ | |
233 |
|
233 | |||
234 | Completer.__init__(self,namespace,global_namespace) |
|
234 | Completer.__init__(self,namespace,global_namespace) | |
235 | self.magic_prefix = shell.name+'.magic_' |
|
235 | self.magic_prefix = shell.name+'.magic_' | |
236 | self.magic_escape = shell.ESC_MAGIC |
|
236 | self.magic_escape = shell.ESC_MAGIC | |
237 | self.readline = readline |
|
237 | self.readline = readline | |
238 | delims = self.readline.get_completer_delims() |
|
238 | delims = self.readline.get_completer_delims() | |
239 | delims = delims.replace(self.magic_escape,'') |
|
239 | delims = delims.replace(self.magic_escape,'') | |
240 | self.readline.set_completer_delims(delims) |
|
240 | self.readline.set_completer_delims(delims) | |
241 | self.get_line_buffer = self.readline.get_line_buffer |
|
241 | self.get_line_buffer = self.readline.get_line_buffer | |
242 | self.get_endidx = self.readline.get_endidx |
|
242 | self.get_endidx = self.readline.get_endidx | |
243 | self.omit__names = omit__names |
|
243 | self.omit__names = omit__names | |
244 | self.merge_completions = shell.rc.readline_merge_completions |
|
244 | self.merge_completions = shell.rc.readline_merge_completions | |
245 | if alias_table is None: |
|
245 | if alias_table is None: | |
246 | alias_table = {} |
|
246 | alias_table = {} | |
247 | self.alias_table = alias_table |
|
247 | self.alias_table = alias_table | |
248 | # Regexp to split filenames with spaces in them |
|
248 | # Regexp to split filenames with spaces in them | |
249 | self.space_name_re = re.compile(r'([^\\] )') |
|
249 | self.space_name_re = re.compile(r'([^\\] )') | |
250 | # Hold a local ref. to glob.glob for speed |
|
250 | # Hold a local ref. to glob.glob for speed | |
251 | self.glob = glob.glob |
|
251 | self.glob = glob.glob | |
252 |
|
252 | |||
253 | # Determine if we are running on 'dumb' terminals, like (X)Emacs |
|
253 | # Determine if we are running on 'dumb' terminals, like (X)Emacs | |
254 | # buffers, to avoid completion problems. |
|
254 | # buffers, to avoid completion problems. | |
255 | term = os.environ.get('TERM','xterm') |
|
255 | term = os.environ.get('TERM','xterm') | |
256 | self.dumb_terminal = term in ['dumb','emacs'] |
|
256 | self.dumb_terminal = term in ['dumb','emacs'] | |
257 |
|
257 | |||
258 | # Special handling of backslashes needed in win32 platforms |
|
258 | # Special handling of backslashes needed in win32 platforms | |
259 | if sys.platform == "win32": |
|
259 | if sys.platform == "win32": | |
260 | self.clean_glob = self._clean_glob_win32 |
|
260 | self.clean_glob = self._clean_glob_win32 | |
261 | else: |
|
261 | else: | |
262 | self.clean_glob = self._clean_glob |
|
262 | self.clean_glob = self._clean_glob | |
263 | self.matchers = [self.python_matches, |
|
263 | self.matchers = [self.python_matches, | |
264 | self.file_matches, |
|
264 | self.file_matches, | |
265 | self.alias_matches, |
|
265 | self.alias_matches, | |
266 | self.python_func_kw_matches] |
|
266 | self.python_func_kw_matches] | |
267 |
|
267 | |||
268 |
|
268 | |||
269 | # Code contributed by Alex Schmolck, for ipython/emacs integration |
|
269 | # Code contributed by Alex Schmolck, for ipython/emacs integration | |
270 | def all_completions(self, text): |
|
270 | def all_completions(self, text): | |
271 | """Return all possible completions for the benefit of emacs.""" |
|
271 | """Return all possible completions for the benefit of emacs.""" | |
272 |
|
272 | |||
273 | completions = [] |
|
273 | completions = [] | |
274 | comp_append = completions.append |
|
274 | comp_append = completions.append | |
275 | try: |
|
275 | try: | |
276 | for i in xrange(sys.maxint): |
|
276 | for i in xrange(sys.maxint): | |
277 | res = self.complete(text, i) |
|
277 | res = self.complete(text, i) | |
278 |
|
278 | |||
279 | if not res: break |
|
279 | if not res: break | |
280 |
|
280 | |||
281 | comp_append(res) |
|
281 | comp_append(res) | |
282 | #XXX workaround for ``notDefined.<tab>`` |
|
282 | #XXX workaround for ``notDefined.<tab>`` | |
283 | except NameError: |
|
283 | except NameError: | |
284 | pass |
|
284 | pass | |
285 | return completions |
|
285 | return completions | |
286 | # /end Alex Schmolck code. |
|
286 | # /end Alex Schmolck code. | |
287 |
|
287 | |||
288 | def _clean_glob(self,text): |
|
288 | def _clean_glob(self,text): | |
289 | return self.glob("%s*" % text) |
|
289 | return self.glob("%s*" % text) | |
290 |
|
290 | |||
291 | def _clean_glob_win32(self,text): |
|
291 | def _clean_glob_win32(self,text): | |
292 | return [f.replace("\\","/") |
|
292 | return [f.replace("\\","/") | |
293 | for f in self.glob("%s*" % text)] |
|
293 | for f in self.glob("%s*" % text)] | |
294 |
|
294 | |||
295 | def file_matches(self, text): |
|
295 | def file_matches(self, text): | |
296 | """Match filenames, expanding ~USER type strings. |
|
296 | """Match filenames, expanding ~USER type strings. | |
297 |
|
297 | |||
298 | Most of the seemingly convoluted logic in this completer is an |
|
298 | Most of the seemingly convoluted logic in this completer is an | |
299 | attempt to handle filenames with spaces in them. And yet it's not |
|
299 | attempt to handle filenames with spaces in them. And yet it's not | |
300 | quite perfect, because Python's readline doesn't expose all of the |
|
300 | quite perfect, because Python's readline doesn't expose all of the | |
301 | GNU readline details needed for this to be done correctly. |
|
301 | GNU readline details needed for this to be done correctly. | |
302 |
|
302 | |||
303 | For a filename with a space in it, the printed completions will be |
|
303 | For a filename with a space in it, the printed completions will be | |
304 | only the parts after what's already been typed (instead of the |
|
304 | only the parts after what's already been typed (instead of the | |
305 | full completions, as is normally done). I don't think with the |
|
305 | full completions, as is normally done). I don't think with the | |
306 | current (as of Python 2.3) Python readline it's possible to do |
|
306 | current (as of Python 2.3) Python readline it's possible to do | |
307 | better.""" |
|
307 | better.""" | |
308 |
|
308 | |||
309 | #print 'Completer->file_matches: <%s>' % text # dbg |
|
309 | #print 'Completer->file_matches: <%s>' % text # dbg | |
310 |
|
310 | |||
311 | # chars that require escaping with backslash - i.e. chars |
|
311 | # chars that require escaping with backslash - i.e. chars | |
312 | # that readline treats incorrectly as delimiters, but we |
|
312 | # that readline treats incorrectly as delimiters, but we | |
313 | # don't want to treat as delimiters in filename matching |
|
313 | # don't want to treat as delimiters in filename matching | |
314 | # when escaped with backslash |
|
314 | # when escaped with backslash | |
315 |
|
315 | |||
316 | if sys.platform == 'win32': |
|
316 | if sys.platform == 'win32': | |
317 | protectables = ' ' |
|
317 | protectables = ' ' | |
318 | else: |
|
318 | else: | |
319 | protectables = ' ()' |
|
319 | protectables = ' ()' | |
320 |
|
320 | |||
321 | if text.startswith('!'): |
|
321 | if text.startswith('!'): | |
322 | text = text[1:] |
|
322 | text = text[1:] | |
323 | text_prefix = '!' |
|
323 | text_prefix = '!' | |
324 | else: |
|
324 | else: | |
325 | text_prefix = '' |
|
325 | text_prefix = '' | |
326 |
|
326 | |||
327 | def protect_filename(s): |
|
327 | def protect_filename(s): | |
328 | return "".join([(ch in protectables and '\\' + ch or ch) |
|
328 | return "".join([(ch in protectables and '\\' + ch or ch) | |
329 | for ch in s]) |
|
329 | for ch in s]) | |
330 |
|
330 | |||
331 | def single_dir_expand(matches): |
|
331 | def single_dir_expand(matches): | |
332 | "Recursively expand match lists containing a single dir." |
|
332 | "Recursively expand match lists containing a single dir." | |
333 |
|
333 | |||
334 | if len(matches) == 1 and os.path.isdir(matches[0]): |
|
334 | if len(matches) == 1 and os.path.isdir(matches[0]): | |
335 | # Takes care of links to directories also. Use '/' |
|
335 | # Takes care of links to directories also. Use '/' | |
336 | # explicitly, even under Windows, so that name completions |
|
336 | # explicitly, even under Windows, so that name completions | |
337 | # don't end up escaped. |
|
337 | # don't end up escaped. | |
338 | d = matches[0] |
|
338 | d = matches[0] | |
339 | if d[-1] in ['/','\\']: |
|
339 | if d[-1] in ['/','\\']: | |
340 | d = d[:-1] |
|
340 | d = d[:-1] | |
341 |
|
341 | |||
342 | subdirs = os.listdir(d) |
|
342 | subdirs = os.listdir(d) | |
343 | if subdirs: |
|
343 | if subdirs: | |
344 | matches = [ (d + '/' + p) for p in subdirs] |
|
344 | matches = [ (d + '/' + p) for p in subdirs] | |
345 | return single_dir_expand(matches) |
|
345 | return single_dir_expand(matches) | |
346 | else: |
|
346 | else: | |
347 | return matches |
|
347 | return matches | |
348 | else: |
|
348 | else: | |
349 | return matches |
|
349 | return matches | |
350 |
|
350 | |||
351 | lbuf = self.lbuf |
|
351 | lbuf = self.lbuf | |
352 | open_quotes = 0 # track strings with open quotes |
|
352 | open_quotes = 0 # track strings with open quotes | |
353 | try: |
|
353 | try: | |
354 | lsplit = shlex.split(lbuf)[-1] |
|
354 | lsplit = shlex.split(lbuf)[-1] | |
355 | except ValueError: |
|
355 | except ValueError: | |
356 | # typically an unmatched ", or backslash without escaped char. |
|
356 | # typically an unmatched ", or backslash without escaped char. | |
357 | if lbuf.count('"')==1: |
|
357 | if lbuf.count('"')==1: | |
358 | open_quotes = 1 |
|
358 | open_quotes = 1 | |
359 | lsplit = lbuf.split('"')[-1] |
|
359 | lsplit = lbuf.split('"')[-1] | |
360 | elif lbuf.count("'")==1: |
|
360 | elif lbuf.count("'")==1: | |
361 | open_quotes = 1 |
|
361 | open_quotes = 1 | |
362 | lsplit = lbuf.split("'")[-1] |
|
362 | lsplit = lbuf.split("'")[-1] | |
363 | else: |
|
363 | else: | |
364 | return [] |
|
364 | return [] | |
365 | except IndexError: |
|
365 | except IndexError: | |
366 | # tab pressed on empty line |
|
366 | # tab pressed on empty line | |
367 | lsplit = "" |
|
367 | lsplit = "" | |
368 |
|
368 | |||
369 | if lsplit != protect_filename(lsplit): |
|
369 | if lsplit != protect_filename(lsplit): | |
370 | # if protectables are found, do matching on the whole escaped |
|
370 | # if protectables are found, do matching on the whole escaped | |
371 | # name |
|
371 | # name | |
372 | has_protectables = 1 |
|
372 | has_protectables = 1 | |
373 | text0,text = text,lsplit |
|
373 | text0,text = text,lsplit | |
374 | else: |
|
374 | else: | |
375 | has_protectables = 0 |
|
375 | has_protectables = 0 | |
376 | text = os.path.expanduser(text) |
|
376 | text = os.path.expanduser(text) | |
377 |
|
377 | |||
378 | if text == "": |
|
378 | if text == "": | |
379 | return [text_prefix + protect_filename(f) for f in self.glob("*")] |
|
379 | return [text_prefix + protect_filename(f) for f in self.glob("*")] | |
380 |
|
380 | |||
381 | m0 = self.clean_glob(text.replace('\\','')) |
|
381 | m0 = self.clean_glob(text.replace('\\','')) | |
382 | if has_protectables: |
|
382 | if has_protectables: | |
383 | # If we had protectables, we need to revert our changes to the |
|
383 | # If we had protectables, we need to revert our changes to the | |
384 | # beginning of filename so that we don't double-write the part |
|
384 | # beginning of filename so that we don't double-write the part | |
385 | # of the filename we have so far |
|
385 | # of the filename we have so far | |
386 | len_lsplit = len(lsplit) |
|
386 | len_lsplit = len(lsplit) | |
387 | matches = [text_prefix + text0 + |
|
387 | matches = [text_prefix + text0 + | |
388 | protect_filename(f[len_lsplit:]) for f in m0] |
|
388 | protect_filename(f[len_lsplit:]) for f in m0] | |
389 | else: |
|
389 | else: | |
390 | if open_quotes: |
|
390 | if open_quotes: | |
391 | # if we have a string with an open quote, we don't need to |
|
391 | # if we have a string with an open quote, we don't need to | |
392 | # protect the names at all (and we _shouldn't_, as it |
|
392 | # protect the names at all (and we _shouldn't_, as it | |
393 | # would cause bugs when the filesystem call is made). |
|
393 | # would cause bugs when the filesystem call is made). | |
394 | matches = m0 |
|
394 | matches = m0 | |
395 | else: |
|
395 | else: | |
396 | matches = [text_prefix + |
|
396 | matches = [text_prefix + | |
397 | protect_filename(f) for f in m0] |
|
397 | protect_filename(f) for f in m0] | |
398 |
|
398 | |||
399 | #print 'mm',matches # dbg |
|
399 | #print 'mm',matches # dbg | |
400 | return single_dir_expand(matches) |
|
400 | return single_dir_expand(matches) | |
401 |
|
401 | |||
402 | def alias_matches(self, text): |
|
402 | def alias_matches(self, text): | |
403 | """Match internal system aliases""" |
|
403 | """Match internal system aliases""" | |
404 | #print 'Completer->alias_matches:',text,'lb',self.lbuf # dbg |
|
404 | #print 'Completer->alias_matches:',text,'lb',self.lbuf # dbg | |
405 |
|
405 | |||
406 | # if we are not in the first 'item', alias matching |
|
406 | # if we are not in the first 'item', alias matching | |
407 | # doesn't make sense - unless we are starting with 'sudo' command. |
|
407 | # doesn't make sense - unless we are starting with 'sudo' command. | |
408 | if ' ' in self.lbuf.lstrip() and not self.lbuf.lstrip().startswith('sudo'): |
|
408 | if ' ' in self.lbuf.lstrip() and not self.lbuf.lstrip().startswith('sudo'): | |
409 | return [] |
|
409 | return [] | |
410 | text = os.path.expanduser(text) |
|
410 | text = os.path.expanduser(text) | |
411 | aliases = self.alias_table.keys() |
|
411 | aliases = self.alias_table.keys() | |
412 | if text == "": |
|
412 | if text == "": | |
413 | return aliases |
|
413 | return aliases | |
414 | else: |
|
414 | else: | |
415 | return [alias for alias in aliases if alias.startswith(text)] |
|
415 | return [alias for alias in aliases if alias.startswith(text)] | |
416 |
|
416 | |||
417 | def python_matches(self,text): |
|
417 | def python_matches(self,text): | |
418 | """Match attributes or global python names""" |
|
418 | """Match attributes or global python names""" | |
419 |
|
419 | |||
420 | #print 'Completer->python_matches, txt=<%s>' % text # dbg |
|
420 | #print 'Completer->python_matches, txt=<%s>' % text # dbg | |
421 | if "." in text: |
|
421 | if "." in text: | |
422 | try: |
|
422 | try: | |
423 | matches = self.attr_matches(text) |
|
423 | matches = self.attr_matches(text) | |
424 | if text.endswith('.') and self.omit__names: |
|
424 | if text.endswith('.') and self.omit__names: | |
425 | if self.omit__names == 1: |
|
425 | if self.omit__names == 1: | |
426 | # true if txt is _not_ a __ name, false otherwise: |
|
426 | # true if txt is _not_ a __ name, false otherwise: | |
427 | no__name = (lambda txt: |
|
427 | no__name = (lambda txt: | |
428 | re.match(r'.*\.__.*?__',txt) is None) |
|
428 | re.match(r'.*\.__.*?__',txt) is None) | |
429 | else: |
|
429 | else: | |
430 | # true if txt is _not_ a _ name, false otherwise: |
|
430 | # true if txt is _not_ a _ name, false otherwise: | |
431 | no__name = (lambda txt: |
|
431 | no__name = (lambda txt: | |
432 | re.match(r'.*\._.*?',txt) is None) |
|
432 | re.match(r'.*\._.*?',txt) is None) | |
433 | matches = filter(no__name, matches) |
|
433 | matches = filter(no__name, matches) | |
434 | except NameError: |
|
434 | except NameError: | |
435 | # catches <undefined attributes>.<tab> |
|
435 | # catches <undefined attributes>.<tab> | |
436 | matches = [] |
|
436 | matches = [] | |
437 | else: |
|
437 | else: | |
438 | matches = self.global_matches(text) |
|
438 | matches = self.global_matches(text) | |
439 | # this is so completion finds magics when automagic is on: |
|
439 | # this is so completion finds magics when automagic is on: | |
440 | if (matches == [] and |
|
440 | if (matches == [] and | |
441 | not text.startswith(os.sep) and |
|
441 | not text.startswith(os.sep) and | |
442 | not ' ' in self.lbuf): |
|
442 | not ' ' in self.lbuf): | |
443 | matches = self.attr_matches(self.magic_prefix+text) |
|
443 | matches = self.attr_matches(self.magic_prefix+text) | |
444 | return matches |
|
444 | return matches | |
445 |
|
445 | |||
446 | def _default_arguments(self, obj): |
|
446 | def _default_arguments(self, obj): | |
447 | """Return the list of default arguments of obj if it is callable, |
|
447 | """Return the list of default arguments of obj if it is callable, | |
448 | or empty list otherwise.""" |
|
448 | or empty list otherwise.""" | |
449 |
|
449 | |||
450 | if not (inspect.isfunction(obj) or inspect.ismethod(obj)): |
|
450 | if not (inspect.isfunction(obj) or inspect.ismethod(obj)): | |
451 | # for classes, check for __init__,__new__ |
|
451 | # for classes, check for __init__,__new__ | |
452 | if inspect.isclass(obj): |
|
452 | if inspect.isclass(obj): | |
453 | obj = (getattr(obj,'__init__',None) or |
|
453 | obj = (getattr(obj,'__init__',None) or | |
454 | getattr(obj,'__new__',None)) |
|
454 | getattr(obj,'__new__',None)) | |
455 | # for all others, check if they are __call__able |
|
455 | # for all others, check if they are __call__able | |
456 | elif hasattr(obj, '__call__'): |
|
456 | elif hasattr(obj, '__call__'): | |
457 | obj = obj.__call__ |
|
457 | obj = obj.__call__ | |
458 | # XXX: is there a way to handle the builtins ? |
|
458 | # XXX: is there a way to handle the builtins ? | |
459 | try: |
|
459 | try: | |
460 | args,_,_1,defaults = inspect.getargspec(obj) |
|
460 | args,_,_1,defaults = inspect.getargspec(obj) | |
461 | if defaults: |
|
461 | if defaults: | |
462 | return args[-len(defaults):] |
|
462 | return args[-len(defaults):] | |
463 | except TypeError: pass |
|
463 | except TypeError: pass | |
464 | return [] |
|
464 | return [] | |
465 |
|
465 | |||
466 | def python_func_kw_matches(self,text): |
|
466 | def python_func_kw_matches(self,text): | |
467 | """Match named parameters (kwargs) of the last open function""" |
|
467 | """Match named parameters (kwargs) of the last open function""" | |
468 |
|
468 | |||
469 | if "." in text: # a parameter cannot be dotted |
|
469 | if "." in text: # a parameter cannot be dotted | |
470 | return [] |
|
470 | return [] | |
471 | try: regexp = self.__funcParamsRegex |
|
471 | try: regexp = self.__funcParamsRegex | |
472 | except AttributeError: |
|
472 | except AttributeError: | |
473 | regexp = self.__funcParamsRegex = re.compile(r''' |
|
473 | regexp = self.__funcParamsRegex = re.compile(r''' | |
474 | '.*?' | # single quoted strings or |
|
474 | '.*?' | # single quoted strings or | |
475 | ".*?" | # double quoted strings or |
|
475 | ".*?" | # double quoted strings or | |
476 | \w+ | # identifier |
|
476 | \w+ | # identifier | |
477 | \S # other characters |
|
477 | \S # other characters | |
478 | ''', re.VERBOSE | re.DOTALL) |
|
478 | ''', re.VERBOSE | re.DOTALL) | |
479 | # 1. find the nearest identifier that comes before an unclosed |
|
479 | # 1. find the nearest identifier that comes before an unclosed | |
480 | # parenthesis e.g. for "foo (1+bar(x), pa", the candidate is "foo" |
|
480 | # parenthesis e.g. for "foo (1+bar(x), pa", the candidate is "foo" | |
481 | tokens = regexp.findall(self.get_line_buffer()) |
|
481 | tokens = regexp.findall(self.get_line_buffer()) | |
482 | tokens.reverse() |
|
482 | tokens.reverse() | |
483 | iterTokens = iter(tokens); openPar = 0 |
|
483 | iterTokens = iter(tokens); openPar = 0 | |
484 | for token in iterTokens: |
|
484 | for token in iterTokens: | |
485 | if token == ')': |
|
485 | if token == ')': | |
486 | openPar -= 1 |
|
486 | openPar -= 1 | |
487 | elif token == '(': |
|
487 | elif token == '(': | |
488 | openPar += 1 |
|
488 | openPar += 1 | |
489 | if openPar > 0: |
|
489 | if openPar > 0: | |
490 | # found the last unclosed parenthesis |
|
490 | # found the last unclosed parenthesis | |
491 | break |
|
491 | break | |
492 | else: |
|
492 | else: | |
493 | return [] |
|
493 | return [] | |
494 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) |
|
494 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) | |
495 | ids = [] |
|
495 | ids = [] | |
496 | isId = re.compile(r'\w+$').match |
|
496 | isId = re.compile(r'\w+$').match | |
497 | while True: |
|
497 | while True: | |
498 | try: |
|
498 | try: | |
499 | ids.append(iterTokens.next()) |
|
499 | ids.append(iterTokens.next()) | |
500 | if not isId(ids[-1]): |
|
500 | if not isId(ids[-1]): | |
501 | ids.pop(); break |
|
501 | ids.pop(); break | |
502 | if not iterTokens.next() == '.': |
|
502 | if not iterTokens.next() == '.': | |
503 | break |
|
503 | break | |
504 | except StopIteration: |
|
504 | except StopIteration: | |
505 | break |
|
505 | break | |
506 | # lookup the candidate callable matches either using global_matches |
|
506 | # lookup the candidate callable matches either using global_matches | |
507 | # or attr_matches for dotted names |
|
507 | # or attr_matches for dotted names | |
508 | if len(ids) == 1: |
|
508 | if len(ids) == 1: | |
509 | callableMatches = self.global_matches(ids[0]) |
|
509 | callableMatches = self.global_matches(ids[0]) | |
510 | else: |
|
510 | else: | |
511 | callableMatches = self.attr_matches('.'.join(ids[::-1])) |
|
511 | callableMatches = self.attr_matches('.'.join(ids[::-1])) | |
512 | argMatches = [] |
|
512 | argMatches = [] | |
513 | for callableMatch in callableMatches: |
|
513 | for callableMatch in callableMatches: | |
514 | try: namedArgs = self._default_arguments(eval(callableMatch, |
|
514 | try: namedArgs = self._default_arguments(eval(callableMatch, | |
515 | self.namespace)) |
|
515 | self.namespace)) | |
516 | except: continue |
|
516 | except: continue | |
517 | for namedArg in namedArgs: |
|
517 | for namedArg in namedArgs: | |
518 | if namedArg.startswith(text): |
|
518 | if namedArg.startswith(text): | |
519 | argMatches.append("%s=" %namedArg) |
|
519 | argMatches.append("%s=" %namedArg) | |
520 | return argMatches |
|
520 | return argMatches | |
521 |
|
521 | |||
522 | def dispatch_custom_completer(self,text): |
|
522 | def dispatch_custom_completer(self,text): | |
523 | #print "Custom! '%s' %s" % (text, self.custom_completers) # dbg |
|
523 | #print "Custom! '%s' %s" % (text, self.custom_completers) # dbg | |
524 | line = self.full_lbuf |
|
524 | line = self.full_lbuf | |
525 | if not line.strip(): |
|
525 | if not line.strip(): | |
526 | return None |
|
526 | return None | |
527 |
|
527 | |||
528 | event = Struct() |
|
528 | event = Struct() | |
529 | event.line = line |
|
529 | event.line = line | |
530 | event.symbol = text |
|
530 | event.symbol = text | |
531 | cmd = line.split(None,1)[0] |
|
531 | cmd = line.split(None,1)[0] | |
532 | event.command = cmd |
|
532 | event.command = cmd | |
533 | #print "\ncustom:{%s]\n" % event # dbg |
|
533 | #print "\ncustom:{%s]\n" % event # dbg | |
534 |
|
534 | |||
535 | # for foo etc, try also to find completer for %foo |
|
535 | # for foo etc, try also to find completer for %foo | |
536 | if not cmd.startswith(self.magic_escape): |
|
536 | if not cmd.startswith(self.magic_escape): | |
537 | try_magic = self.custom_completers.s_matches( |
|
537 | try_magic = self.custom_completers.s_matches( | |
538 | self.magic_escape + cmd) |
|
538 | self.magic_escape + cmd) | |
539 | else: |
|
539 | else: | |
540 | try_magic = [] |
|
540 | try_magic = [] | |
541 |
|
541 | |||
542 |
|
542 | |||
543 | for c in itertools.chain( |
|
543 | for c in itertools.chain( | |
544 | self.custom_completers.s_matches(cmd), |
|
544 | self.custom_completers.s_matches(cmd), | |
545 | try_magic, |
|
545 | try_magic, | |
546 | self.custom_completers.flat_matches(self.lbuf)): |
|
546 | self.custom_completers.flat_matches(self.lbuf)): | |
547 | #print "try",c # dbg |
|
547 | #print "try",c # dbg | |
548 | try: |
|
548 | try: | |
549 | res = c(event) |
|
549 | res = c(event) | |
550 | # first, try case sensitive match |
|
550 | # first, try case sensitive match | |
551 | withcase = [r for r in res if r.startswith(text)] |
|
551 | withcase = [r for r in res if r.startswith(text)] | |
552 | if withcase: |
|
552 | if withcase: | |
553 | return withcase |
|
553 | return withcase | |
554 | # if none, then case insensitive ones are ok too |
|
554 | # if none, then case insensitive ones are ok too | |
555 | return [r for r in res if r.lower().startswith(text.lower())] |
|
555 | return [r for r in res if r.lower().startswith(text.lower())] | |
556 | except ipapi.TryNext: |
|
556 | except ipapi.TryNext: | |
557 | pass |
|
557 | pass | |
558 |
|
558 | |||
559 | return None |
|
559 | return None | |
560 |
|
560 | |||
561 | def complete(self, text, state,line_buffer=None): |
|
561 | def complete(self, text, state,line_buffer=None): | |
562 | """Return the next possible completion for 'text'. |
|
562 | """Return the next possible completion for 'text'. | |
563 |
|
563 | |||
564 | This is called successively with state == 0, 1, 2, ... until it |
|
564 | This is called successively with state == 0, 1, 2, ... until it | |
565 | returns None. The completion should begin with 'text'. |
|
565 | returns None. The completion should begin with 'text'. | |
566 |
|
566 | |||
567 | :Keywords: |
|
567 | :Keywords: | |
568 | - line_buffer: string |
|
568 | - line_buffer: string | |
569 | If not given, the completer attempts to obtain the current line buffer |
|
569 | If not given, the completer attempts to obtain the current line buffer | |
570 | via readline. This keyword allows clients which are requesting for |
|
570 | via readline. This keyword allows clients which are requesting for | |
571 | text completions in non-readline contexts to inform the completer of |
|
571 | text completions in non-readline contexts to inform the completer of | |
572 | the entire text. |
|
572 | the entire text. | |
573 | """ |
|
573 | """ | |
574 |
|
574 | |||
575 | #print '\n*** COMPLETE: <%s> (%s)' % (text,state) # dbg |
|
575 | #print '\n*** COMPLETE: <%s> (%s)' % (text,state) # dbg | |
576 |
|
576 | |||
577 | # if there is only a tab on a line with only whitespace, instead |
|
577 | # if there is only a tab on a line with only whitespace, instead | |
578 | # of the mostly useless 'do you want to see all million |
|
578 | # of the mostly useless 'do you want to see all million | |
579 | # completions' message, just do the right thing and give the user |
|
579 | # completions' message, just do the right thing and give the user | |
580 | # his tab! Incidentally, this enables pasting of tabbed text from |
|
580 | # his tab! Incidentally, this enables pasting of tabbed text from | |
581 | # an editor (as long as autoindent is off). |
|
581 | # an editor (as long as autoindent is off). | |
582 |
|
582 | |||
583 | # It should be noted that at least pyreadline still shows |
|
583 | # It should be noted that at least pyreadline still shows | |
584 | # file completions - is there a way around it? |
|
584 | # file completions - is there a way around it? | |
585 |
|
585 | |||
586 | # don't apply this on 'dumb' terminals, such as emacs buffers, so we |
|
586 | # don't apply this on 'dumb' terminals, such as emacs buffers, so we | |
587 | # don't interfere with their own tab-completion mechanism. |
|
587 | # don't interfere with their own tab-completion mechanism. | |
588 | if line_buffer is None: |
|
588 | if line_buffer is None: | |
589 | self.full_lbuf = self.get_line_buffer() |
|
589 | self.full_lbuf = self.get_line_buffer() | |
590 | else: |
|
590 | else: | |
591 | self.full_lbuf = line_buffer |
|
591 | self.full_lbuf = line_buffer | |
592 |
|
592 | |||
593 | if not (self.dumb_terminal or self.full_lbuf.strip()): |
|
593 | if not (self.dumb_terminal or self.full_lbuf.strip()): | |
594 | self.readline.insert_text('\t') |
|
594 | self.readline.insert_text('\t') | |
595 | return None |
|
595 | return None | |
596 |
|
596 | |||
597 | magic_escape = self.magic_escape |
|
597 | magic_escape = self.magic_escape | |
598 | magic_prefix = self.magic_prefix |
|
598 | magic_prefix = self.magic_prefix | |
599 |
|
599 | |||
600 | self.lbuf = self.full_lbuf[:self.get_endidx()] |
|
600 | self.lbuf = self.full_lbuf[:self.get_endidx()] | |
601 |
|
601 | |||
602 | try: |
|
602 | try: | |
603 | if text.startswith(magic_escape): |
|
603 | if text.startswith(magic_escape): | |
604 | text = text.replace(magic_escape,magic_prefix) |
|
604 | text = text.replace(magic_escape,magic_prefix) | |
605 | elif text.startswith('~'): |
|
605 | elif text.startswith('~'): | |
606 | text = os.path.expanduser(text) |
|
606 | text = os.path.expanduser(text) | |
607 | if state == 0: |
|
607 | if state == 0: | |
608 | custom_res = self.dispatch_custom_completer(text) |
|
608 | custom_res = self.dispatch_custom_completer(text) | |
609 | if custom_res is not None: |
|
609 | if custom_res is not None: | |
610 | # did custom completers produce something? |
|
610 | # did custom completers produce something? | |
611 | self.matches = custom_res |
|
611 | self.matches = custom_res | |
612 | else: |
|
612 | else: | |
613 | # Extend the list of completions with the results of each |
|
613 | # Extend the list of completions with the results of each | |
614 | # matcher, so we return results to the user from all |
|
614 | # matcher, so we return results to the user from all | |
615 | # namespaces. |
|
615 | # namespaces. | |
616 | if self.merge_completions: |
|
616 | if self.merge_completions: | |
617 | self.matches = [] |
|
617 | self.matches = [] | |
618 | for matcher in self.matchers: |
|
618 | for matcher in self.matchers: | |
619 | self.matches.extend(matcher(text)) |
|
619 | self.matches.extend(matcher(text)) | |
620 | else: |
|
620 | else: | |
621 | for matcher in self.matchers: |
|
621 | for matcher in self.matchers: | |
622 | self.matches = matcher(text) |
|
622 | self.matches = matcher(text) | |
623 | if self.matches: |
|
623 | if self.matches: | |
624 | break |
|
624 | break | |
625 | def uniq(alist): |
|
625 | def uniq(alist): | |
626 | set = {} |
|
626 | set = {} | |
627 | return [set.setdefault(e,e) for e in alist if e not in set] |
|
627 | return [set.setdefault(e,e) for e in alist if e not in set] | |
628 | self.matches = uniq(self.matches) |
|
628 | self.matches = uniq(self.matches) | |
629 | try: |
|
629 | try: | |
630 | ret = self.matches[state].replace(magic_prefix,magic_escape) |
|
630 | ret = self.matches[state].replace(magic_prefix,magic_escape) | |
631 | return ret |
|
631 | return ret | |
632 | except IndexError: |
|
632 | except IndexError: | |
633 | return None |
|
633 | return None | |
634 | except: |
|
634 | except: | |
635 |
#from IPython. |
|
635 | #from IPython.core.ultratb import AutoFormattedTB; # dbg | |
636 | #tb=AutoFormattedTB('Verbose');tb() #dbg |
|
636 | #tb=AutoFormattedTB('Verbose');tb() #dbg | |
637 |
|
637 | |||
638 | # If completion fails, don't annoy the user. |
|
638 | # If completion fails, don't annoy the user. | |
639 | return None |
|
639 | return None |
@@ -1,229 +1,229 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """sys.excepthook for IPython itself, leaves a detailed report on disk. |
|
2 | """sys.excepthook for IPython itself, leaves a detailed report on disk. | |
3 |
|
3 | |||
4 |
|
4 | |||
5 | Authors |
|
5 | Authors | |
6 | ------- |
|
6 | ------- | |
7 | - Fernando Perez <Fernando.Perez@berkeley.edu> |
|
7 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2008-2009 The IPython Development Team |
|
11 | # Copyright (C) 2008-2009 The IPython Development Team | |
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
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 | # Required modules |
|
19 | # Required modules | |
20 |
|
20 | |||
21 | # From the standard library |
|
21 | # From the standard library | |
22 | import os |
|
22 | import os | |
23 | import sys |
|
23 | import sys | |
24 | from pprint import pformat |
|
24 | from pprint import pformat | |
25 |
|
25 | |||
26 | # Our own |
|
26 | # Our own | |
27 | from IPython.core import release |
|
27 | from IPython.core import release | |
28 |
from IPython import ultra |
|
28 | from IPython.core import ultratb | |
29 | from IPython.external.Itpl import itpl |
|
29 | from IPython.external.Itpl import itpl | |
30 |
|
30 | |||
31 | from IPython.utils.genutils import * |
|
31 | from IPython.utils.genutils import * | |
32 |
|
32 | |||
33 | #**************************************************************************** |
|
33 | #**************************************************************************** | |
34 | class CrashHandler: |
|
34 | class CrashHandler: | |
35 | """Customizable crash handlers for IPython-based systems. |
|
35 | """Customizable crash handlers for IPython-based systems. | |
36 |
|
36 | |||
37 | Instances of this class provide a __call__ method which can be used as a |
|
37 | Instances of this class provide a __call__ method which can be used as a | |
38 | sys.excepthook, i.e., the __call__ signature is: |
|
38 | sys.excepthook, i.e., the __call__ signature is: | |
39 |
|
39 | |||
40 | def __call__(self,etype, evalue, etb) |
|
40 | def __call__(self,etype, evalue, etb) | |
41 |
|
41 | |||
42 | """ |
|
42 | """ | |
43 |
|
43 | |||
44 | def __init__(self,IP,app_name,contact_name,contact_email, |
|
44 | def __init__(self,IP,app_name,contact_name,contact_email, | |
45 | bug_tracker,crash_report_fname, |
|
45 | bug_tracker,crash_report_fname, | |
46 | show_crash_traceback=True): |
|
46 | show_crash_traceback=True): | |
47 | """New crash handler. |
|
47 | """New crash handler. | |
48 |
|
48 | |||
49 | Inputs: |
|
49 | Inputs: | |
50 |
|
50 | |||
51 | - IP: a running IPython instance, which will be queried at crash time |
|
51 | - IP: a running IPython instance, which will be queried at crash time | |
52 | for internal information. |
|
52 | for internal information. | |
53 |
|
53 | |||
54 | - app_name: a string containing the name of your application. |
|
54 | - app_name: a string containing the name of your application. | |
55 |
|
55 | |||
56 | - contact_name: a string with the name of the person to contact. |
|
56 | - contact_name: a string with the name of the person to contact. | |
57 |
|
57 | |||
58 | - contact_email: a string with the email address of the contact. |
|
58 | - contact_email: a string with the email address of the contact. | |
59 |
|
59 | |||
60 | - bug_tracker: a string with the URL for your project's bug tracker. |
|
60 | - bug_tracker: a string with the URL for your project's bug tracker. | |
61 |
|
61 | |||
62 | - crash_report_fname: a string with the filename for the crash report |
|
62 | - crash_report_fname: a string with the filename for the crash report | |
63 | to be saved in. These reports are left in the ipython user directory |
|
63 | to be saved in. These reports are left in the ipython user directory | |
64 | as determined by the running IPython instance. |
|
64 | as determined by the running IPython instance. | |
65 |
|
65 | |||
66 | Optional inputs: |
|
66 | Optional inputs: | |
67 |
|
67 | |||
68 | - show_crash_traceback(True): if false, don't print the crash |
|
68 | - show_crash_traceback(True): if false, don't print the crash | |
69 | traceback on stderr, only generate the on-disk report |
|
69 | traceback on stderr, only generate the on-disk report | |
70 |
|
70 | |||
71 |
|
71 | |||
72 | Non-argument instance attributes: |
|
72 | Non-argument instance attributes: | |
73 |
|
73 | |||
74 | These instances contain some non-argument attributes which allow for |
|
74 | These instances contain some non-argument attributes which allow for | |
75 | further customization of the crash handler's behavior. Please see the |
|
75 | further customization of the crash handler's behavior. Please see the | |
76 | source for further details. |
|
76 | source for further details. | |
77 | """ |
|
77 | """ | |
78 |
|
78 | |||
79 | # apply args into instance |
|
79 | # apply args into instance | |
80 | self.IP = IP # IPython instance |
|
80 | self.IP = IP # IPython instance | |
81 | self.app_name = app_name |
|
81 | self.app_name = app_name | |
82 | self.contact_name = contact_name |
|
82 | self.contact_name = contact_name | |
83 | self.contact_email = contact_email |
|
83 | self.contact_email = contact_email | |
84 | self.bug_tracker = bug_tracker |
|
84 | self.bug_tracker = bug_tracker | |
85 | self.crash_report_fname = crash_report_fname |
|
85 | self.crash_report_fname = crash_report_fname | |
86 | self.show_crash_traceback = show_crash_traceback |
|
86 | self.show_crash_traceback = show_crash_traceback | |
87 |
|
87 | |||
88 | # Hardcoded defaults, which can be overridden either by subclasses or |
|
88 | # Hardcoded defaults, which can be overridden either by subclasses or | |
89 | # at runtime for the instance. |
|
89 | # at runtime for the instance. | |
90 |
|
90 | |||
91 | # Template for the user message. Subclasses which completely override |
|
91 | # Template for the user message. Subclasses which completely override | |
92 | # this, or user apps, can modify it to suit their tastes. It gets |
|
92 | # this, or user apps, can modify it to suit their tastes. It gets | |
93 | # expanded using itpl, so calls of the kind $self.foo are valid. |
|
93 | # expanded using itpl, so calls of the kind $self.foo are valid. | |
94 | self.user_message_template = """ |
|
94 | self.user_message_template = """ | |
95 | Oops, $self.app_name crashed. We do our best to make it stable, but... |
|
95 | Oops, $self.app_name crashed. We do our best to make it stable, but... | |
96 |
|
96 | |||
97 | A crash report was automatically generated with the following information: |
|
97 | A crash report was automatically generated with the following information: | |
98 | - A verbatim copy of the crash traceback. |
|
98 | - A verbatim copy of the crash traceback. | |
99 | - A copy of your input history during this session. |
|
99 | - A copy of your input history during this session. | |
100 | - Data on your current $self.app_name configuration. |
|
100 | - Data on your current $self.app_name configuration. | |
101 |
|
101 | |||
102 | It was left in the file named: |
|
102 | It was left in the file named: | |
103 | \t'$self.crash_report_fname' |
|
103 | \t'$self.crash_report_fname' | |
104 | If you can email this file to the developers, the information in it will help |
|
104 | If you can email this file to the developers, the information in it will help | |
105 | them in understanding and correcting the problem. |
|
105 | them in understanding and correcting the problem. | |
106 |
|
106 | |||
107 | You can mail it to: $self.contact_name at $self.contact_email |
|
107 | You can mail it to: $self.contact_name at $self.contact_email | |
108 | with the subject '$self.app_name Crash Report'. |
|
108 | with the subject '$self.app_name Crash Report'. | |
109 |
|
109 | |||
110 | If you want to do it now, the following command will work (under Unix): |
|
110 | If you want to do it now, the following command will work (under Unix): | |
111 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname |
|
111 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname | |
112 |
|
112 | |||
113 | To ensure accurate tracking of this issue, please file a report about it at: |
|
113 | To ensure accurate tracking of this issue, please file a report about it at: | |
114 | $self.bug_tracker |
|
114 | $self.bug_tracker | |
115 | """ |
|
115 | """ | |
116 |
|
116 | |||
117 | def __call__(self,etype, evalue, etb): |
|
117 | def __call__(self,etype, evalue, etb): | |
118 | """Handle an exception, call for compatible with sys.excepthook""" |
|
118 | """Handle an exception, call for compatible with sys.excepthook""" | |
119 |
|
119 | |||
120 | # Report tracebacks shouldn't use color in general (safer for users) |
|
120 | # Report tracebacks shouldn't use color in general (safer for users) | |
121 | color_scheme = 'NoColor' |
|
121 | color_scheme = 'NoColor' | |
122 |
|
122 | |||
123 | # Use this ONLY for developer debugging (keep commented out for release) |
|
123 | # Use this ONLY for developer debugging (keep commented out for release) | |
124 | #color_scheme = 'Linux' # dbg |
|
124 | #color_scheme = 'Linux' # dbg | |
125 |
|
125 | |||
126 | try: |
|
126 | try: | |
127 | rptdir = self.IP.rc.ipythondir |
|
127 | rptdir = self.IP.rc.ipythondir | |
128 | except: |
|
128 | except: | |
129 | rptdir = os.getcwd() |
|
129 | rptdir = os.getcwd() | |
130 | if not os.path.isdir(rptdir): |
|
130 | if not os.path.isdir(rptdir): | |
131 | rptdir = os.getcwd() |
|
131 | rptdir = os.getcwd() | |
132 | report_name = os.path.join(rptdir,self.crash_report_fname) |
|
132 | report_name = os.path.join(rptdir,self.crash_report_fname) | |
133 | # write the report filename into the instance dict so it can get |
|
133 | # write the report filename into the instance dict so it can get | |
134 | # properly expanded out in the user message template |
|
134 | # properly expanded out in the user message template | |
135 | self.crash_report_fname = report_name |
|
135 | self.crash_report_fname = report_name | |
136 |
TBhandler = ultra |
|
136 | TBhandler = ultratb.VerboseTB(color_scheme=color_scheme, | |
137 | long_header=1) |
|
137 | long_header=1) | |
138 | traceback = TBhandler.text(etype,evalue,etb,context=31) |
|
138 | traceback = TBhandler.text(etype,evalue,etb,context=31) | |
139 |
|
139 | |||
140 | # print traceback to screen |
|
140 | # print traceback to screen | |
141 | if self.show_crash_traceback: |
|
141 | if self.show_crash_traceback: | |
142 | print >> sys.stderr, traceback |
|
142 | print >> sys.stderr, traceback | |
143 |
|
143 | |||
144 | # and generate a complete report on disk |
|
144 | # and generate a complete report on disk | |
145 | try: |
|
145 | try: | |
146 | report = open(report_name,'w') |
|
146 | report = open(report_name,'w') | |
147 | except: |
|
147 | except: | |
148 | print >> sys.stderr, 'Could not create crash report on disk.' |
|
148 | print >> sys.stderr, 'Could not create crash report on disk.' | |
149 | return |
|
149 | return | |
150 |
|
150 | |||
151 | # Inform user on stderr of what happened |
|
151 | # Inform user on stderr of what happened | |
152 | msg = itpl('\n'+'*'*70+'\n'+self.user_message_template) |
|
152 | msg = itpl('\n'+'*'*70+'\n'+self.user_message_template) | |
153 | print >> sys.stderr, msg |
|
153 | print >> sys.stderr, msg | |
154 |
|
154 | |||
155 | # Construct report on disk |
|
155 | # Construct report on disk | |
156 | report.write(self.make_report(traceback)) |
|
156 | report.write(self.make_report(traceback)) | |
157 | report.close() |
|
157 | report.close() | |
158 | raw_input("Press enter to exit:") |
|
158 | raw_input("Press enter to exit:") | |
159 |
|
159 | |||
160 | def make_report(self,traceback): |
|
160 | def make_report(self,traceback): | |
161 | """Return a string containing a crash report.""" |
|
161 | """Return a string containing a crash report.""" | |
162 |
|
162 | |||
163 | sec_sep = '\n\n'+'*'*75+'\n\n' |
|
163 | sec_sep = '\n\n'+'*'*75+'\n\n' | |
164 |
|
164 | |||
165 | report = [] |
|
165 | report = [] | |
166 | rpt_add = report.append |
|
166 | rpt_add = report.append | |
167 |
|
167 | |||
168 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') |
|
168 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') | |
169 | rpt_add('IPython version: %s \n\n' % release.version) |
|
169 | rpt_add('IPython version: %s \n\n' % release.version) | |
170 | rpt_add('BZR revision : %s \n\n' % release.revision) |
|
170 | rpt_add('BZR revision : %s \n\n' % release.revision) | |
171 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % |
|
171 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % | |
172 | (os.name,sys.platform) ) |
|
172 | (os.name,sys.platform) ) | |
173 | rpt_add(sec_sep+'Current user configuration structure:\n\n') |
|
173 | rpt_add(sec_sep+'Current user configuration structure:\n\n') | |
174 | rpt_add(pformat(self.IP.rc.dict())) |
|
174 | rpt_add(pformat(self.IP.rc.dict())) | |
175 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) |
|
175 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) | |
176 | try: |
|
176 | try: | |
177 | rpt_add(sec_sep+"History of session input:") |
|
177 | rpt_add(sec_sep+"History of session input:") | |
178 | for line in self.IP.user_ns['_ih']: |
|
178 | for line in self.IP.user_ns['_ih']: | |
179 | rpt_add(line) |
|
179 | rpt_add(line) | |
180 | rpt_add('\n*** Last line of input (may not be in above history):\n') |
|
180 | rpt_add('\n*** Last line of input (may not be in above history):\n') | |
181 | rpt_add(self.IP._last_input_line+'\n') |
|
181 | rpt_add(self.IP._last_input_line+'\n') | |
182 | except: |
|
182 | except: | |
183 | pass |
|
183 | pass | |
184 |
|
184 | |||
185 | return ''.join(report) |
|
185 | return ''.join(report) | |
186 |
|
186 | |||
187 | class IPythonCrashHandler(CrashHandler): |
|
187 | class IPythonCrashHandler(CrashHandler): | |
188 | """sys.excepthook for IPython itself, leaves a detailed report on disk.""" |
|
188 | """sys.excepthook for IPython itself, leaves a detailed report on disk.""" | |
189 |
|
189 | |||
190 | def __init__(self,IP): |
|
190 | def __init__(self,IP): | |
191 |
|
191 | |||
192 | # Set here which of the IPython authors should be listed as contact |
|
192 | # Set here which of the IPython authors should be listed as contact | |
193 | AUTHOR_CONTACT = 'Ville' |
|
193 | AUTHOR_CONTACT = 'Ville' | |
194 |
|
194 | |||
195 | # Set argument defaults |
|
195 | # Set argument defaults | |
196 | app_name = 'IPython' |
|
196 | app_name = 'IPython' | |
197 | bug_tracker = 'https://bugs.launchpad.net/ipython/+filebug' |
|
197 | bug_tracker = 'https://bugs.launchpad.net/ipython/+filebug' | |
198 | contact_name,contact_email = release.authors[AUTHOR_CONTACT][:2] |
|
198 | contact_name,contact_email = release.authors[AUTHOR_CONTACT][:2] | |
199 | crash_report_fname = 'IPython_crash_report.txt' |
|
199 | crash_report_fname = 'IPython_crash_report.txt' | |
200 | # Call parent constructor |
|
200 | # Call parent constructor | |
201 | CrashHandler.__init__(self,IP,app_name,contact_name,contact_email, |
|
201 | CrashHandler.__init__(self,IP,app_name,contact_name,contact_email, | |
202 | bug_tracker,crash_report_fname) |
|
202 | bug_tracker,crash_report_fname) | |
203 |
|
203 | |||
204 | def make_report(self,traceback): |
|
204 | def make_report(self,traceback): | |
205 | """Return a string containing a crash report.""" |
|
205 | """Return a string containing a crash report.""" | |
206 |
|
206 | |||
207 | sec_sep = '\n\n'+'*'*75+'\n\n' |
|
207 | sec_sep = '\n\n'+'*'*75+'\n\n' | |
208 |
|
208 | |||
209 | report = [] |
|
209 | report = [] | |
210 | rpt_add = report.append |
|
210 | rpt_add = report.append | |
211 |
|
211 | |||
212 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') |
|
212 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') | |
213 | rpt_add('IPython version: %s \n\n' % release.version) |
|
213 | rpt_add('IPython version: %s \n\n' % release.version) | |
214 | rpt_add('BZR revision : %s \n\n' % release.revision) |
|
214 | rpt_add('BZR revision : %s \n\n' % release.revision) | |
215 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % |
|
215 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % | |
216 | (os.name,sys.platform) ) |
|
216 | (os.name,sys.platform) ) | |
217 | rpt_add(sec_sep+'Current user configuration structure:\n\n') |
|
217 | rpt_add(sec_sep+'Current user configuration structure:\n\n') | |
218 | rpt_add(pformat(self.IP.rc.dict())) |
|
218 | rpt_add(pformat(self.IP.rc.dict())) | |
219 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) |
|
219 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) | |
220 | try: |
|
220 | try: | |
221 | rpt_add(sec_sep+"History of session input:") |
|
221 | rpt_add(sec_sep+"History of session input:") | |
222 | for line in self.IP.user_ns['_ih']: |
|
222 | for line in self.IP.user_ns['_ih']: | |
223 | rpt_add(line) |
|
223 | rpt_add(line) | |
224 | rpt_add('\n*** Last line of input (may not be in above history):\n') |
|
224 | rpt_add('\n*** Last line of input (may not be in above history):\n') | |
225 | rpt_add(self.IP._last_input_line+'\n') |
|
225 | rpt_add(self.IP._last_input_line+'\n') | |
226 | except: |
|
226 | except: | |
227 | pass |
|
227 | pass | |
228 |
|
228 | |||
229 | return ''.join(report) |
|
229 | return ''.join(report) |
@@ -1,2865 +1,2865 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | IPython -- An enhanced Interactive Python |
|
3 | IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | Requires Python 2.4 or newer. |
|
5 | Requires Python 2.4 or newer. | |
6 |
|
6 | |||
7 | This file contains all the classes and helper functions specific to IPython. |
|
7 | This file contains all the classes and helper functions specific to IPython. | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
11 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | |
12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> |
|
12 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
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 | # Note: this code originally subclassed code.InteractiveConsole from the |
|
17 | # Note: this code originally subclassed code.InteractiveConsole from the | |
18 | # Python standard library. Over time, all of that class has been copied |
|
18 | # Python standard library. Over time, all of that class has been copied | |
19 | # verbatim here for modifications which could not be accomplished by |
|
19 | # verbatim here for modifications which could not be accomplished by | |
20 | # subclassing. At this point, there are no dependencies at all on the code |
|
20 | # subclassing. At this point, there are no dependencies at all on the code | |
21 | # module anymore (it is not even imported). The Python License (sec. 2) |
|
21 | # module anymore (it is not even imported). The Python License (sec. 2) | |
22 | # allows for this, but it's always nice to acknowledge credit where credit is |
|
22 | # allows for this, but it's always nice to acknowledge credit where credit is | |
23 | # due. |
|
23 | # due. | |
24 | #***************************************************************************** |
|
24 | #***************************************************************************** | |
25 |
|
25 | |||
26 | #**************************************************************************** |
|
26 | #**************************************************************************** | |
27 | # Modules and globals |
|
27 | # Modules and globals | |
28 |
|
28 | |||
29 | # Python standard modules |
|
29 | # Python standard modules | |
30 | import __main__ |
|
30 | import __main__ | |
31 | import __builtin__ |
|
31 | import __builtin__ | |
32 | import StringIO |
|
32 | import StringIO | |
33 | import bdb |
|
33 | import bdb | |
34 | import codeop |
|
34 | import codeop | |
35 | import exceptions |
|
35 | import exceptions | |
36 | import glob |
|
36 | import glob | |
37 | import keyword |
|
37 | import keyword | |
38 | import new |
|
38 | import new | |
39 | import os |
|
39 | import os | |
40 | import re |
|
40 | import re | |
41 | import shutil |
|
41 | import shutil | |
42 | import string |
|
42 | import string | |
43 | import sys |
|
43 | import sys | |
44 | import tempfile |
|
44 | import tempfile | |
45 |
|
45 | |||
46 | # IPython's own modules |
|
46 | # IPython's own modules | |
47 | #import IPython |
|
47 | #import IPython | |
48 |
from IPython import ultra |
|
48 | from IPython.core import ultratb | |
49 | from IPython.utils import PyColorize |
|
49 | from IPython.utils import PyColorize | |
50 | from IPython.core import debugger, oinspect |
|
50 | from IPython.core import debugger, oinspect | |
51 | from IPython.Extensions import pickleshare |
|
51 | from IPython.Extensions import pickleshare | |
52 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
52 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
53 | from IPython.external.Itpl import ItplNS |
|
53 | from IPython.external.Itpl import ItplNS | |
54 | from IPython.core.logger import Logger |
|
54 | from IPython.core.logger import Logger | |
55 | from IPython.core.magic import Magic |
|
55 | from IPython.core.magic import Magic | |
56 | from IPython.core.prompts import CachedOutput |
|
56 | from IPython.core.prompts import CachedOutput | |
57 | from IPython.utils.ipstruct import Struct |
|
57 | from IPython.utils.ipstruct import Struct | |
58 | from IPython.lib.backgroundjobs import BackgroundJobManager |
|
58 | from IPython.lib.backgroundjobs import BackgroundJobManager | |
59 | from IPython.utils.genutils import * |
|
59 | from IPython.utils.genutils import * | |
60 | from IPython.strdispatch import StrDispatch |
|
60 | from IPython.utils.strdispatch import StrDispatch | |
61 | from IPython.core import ipapi |
|
61 | from IPython.core import ipapi | |
62 | import IPython.core.history |
|
62 | import IPython.core.history | |
63 | import IPython.core.prefilter as prefilter |
|
63 | import IPython.core.prefilter as prefilter | |
64 | from IPython.core import shadowns |
|
64 | from IPython.core import shadowns | |
65 | # Globals |
|
65 | # Globals | |
66 |
|
66 | |||
67 | # store the builtin raw_input globally, and use this always, in case user code |
|
67 | # store the builtin raw_input globally, and use this always, in case user code | |
68 | # overwrites it (like wx.py.PyShell does) |
|
68 | # overwrites it (like wx.py.PyShell does) | |
69 | raw_input_original = raw_input |
|
69 | raw_input_original = raw_input | |
70 |
|
70 | |||
71 | # compiled regexps for autoindent management |
|
71 | # compiled regexps for autoindent management | |
72 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
72 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
73 |
|
73 | |||
74 |
|
74 | |||
75 | #**************************************************************************** |
|
75 | #**************************************************************************** | |
76 | # Some utility function definitions |
|
76 | # Some utility function definitions | |
77 |
|
77 | |||
78 | ini_spaces_re = re.compile(r'^(\s+)') |
|
78 | ini_spaces_re = re.compile(r'^(\s+)') | |
79 |
|
79 | |||
80 | def num_ini_spaces(strng): |
|
80 | def num_ini_spaces(strng): | |
81 | """Return the number of initial spaces in a string""" |
|
81 | """Return the number of initial spaces in a string""" | |
82 |
|
82 | |||
83 | ini_spaces = ini_spaces_re.match(strng) |
|
83 | ini_spaces = ini_spaces_re.match(strng) | |
84 | if ini_spaces: |
|
84 | if ini_spaces: | |
85 | return ini_spaces.end() |
|
85 | return ini_spaces.end() | |
86 | else: |
|
86 | else: | |
87 | return 0 |
|
87 | return 0 | |
88 |
|
88 | |||
89 | def softspace(file, newvalue): |
|
89 | def softspace(file, newvalue): | |
90 | """Copied from code.py, to remove the dependency""" |
|
90 | """Copied from code.py, to remove the dependency""" | |
91 |
|
91 | |||
92 | oldvalue = 0 |
|
92 | oldvalue = 0 | |
93 | try: |
|
93 | try: | |
94 | oldvalue = file.softspace |
|
94 | oldvalue = file.softspace | |
95 | except AttributeError: |
|
95 | except AttributeError: | |
96 | pass |
|
96 | pass | |
97 | try: |
|
97 | try: | |
98 | file.softspace = newvalue |
|
98 | file.softspace = newvalue | |
99 | except (AttributeError, TypeError): |
|
99 | except (AttributeError, TypeError): | |
100 | # "attribute-less object" or "read-only attributes" |
|
100 | # "attribute-less object" or "read-only attributes" | |
101 | pass |
|
101 | pass | |
102 | return oldvalue |
|
102 | return oldvalue | |
103 |
|
103 | |||
104 |
|
104 | |||
105 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): |
|
105 | def user_setup(ipythondir,rc_suffix,mode='install',interactive=True): | |
106 | """Install or upgrade the user configuration directory. |
|
106 | """Install or upgrade the user configuration directory. | |
107 |
|
107 | |||
108 | Can be called when running for the first time or to upgrade the user's |
|
108 | Can be called when running for the first time or to upgrade the user's | |
109 | .ipython/ directory. |
|
109 | .ipython/ directory. | |
110 |
|
110 | |||
111 | Parameters |
|
111 | Parameters | |
112 | ---------- |
|
112 | ---------- | |
113 | ipythondir : path |
|
113 | ipythondir : path | |
114 | The directory to be used for installation/upgrade. In 'install' mode, |
|
114 | The directory to be used for installation/upgrade. In 'install' mode, | |
115 | if this path already exists, the function exits immediately. |
|
115 | if this path already exists, the function exits immediately. | |
116 |
|
116 | |||
117 | rc_suffix : str |
|
117 | rc_suffix : str | |
118 | Extension for the config files. On *nix platforms it is typically the |
|
118 | Extension for the config files. On *nix platforms it is typically the | |
119 | empty string, while Windows normally uses '.ini'. |
|
119 | empty string, while Windows normally uses '.ini'. | |
120 |
|
120 | |||
121 | mode : str, optional |
|
121 | mode : str, optional | |
122 | Valid modes are 'install' and 'upgrade'. |
|
122 | Valid modes are 'install' and 'upgrade'. | |
123 |
|
123 | |||
124 | interactive : bool, optional |
|
124 | interactive : bool, optional | |
125 | If False, do not wait for user input on any errors. Normally after |
|
125 | If False, do not wait for user input on any errors. Normally after | |
126 | printing its status information, this function waits for the user to |
|
126 | printing its status information, this function waits for the user to | |
127 | hit Return before proceeding. This is because the default use case is |
|
127 | hit Return before proceeding. This is because the default use case is | |
128 | when first installing the IPython configuration, so we want the user to |
|
128 | when first installing the IPython configuration, so we want the user to | |
129 | acknowledge the initial message, which contains some useful |
|
129 | acknowledge the initial message, which contains some useful | |
130 | information. |
|
130 | information. | |
131 | """ |
|
131 | """ | |
132 |
|
132 | |||
133 | # For automatic use, deactivate all i/o |
|
133 | # For automatic use, deactivate all i/o | |
134 | if interactive: |
|
134 | if interactive: | |
135 | def wait(): |
|
135 | def wait(): | |
136 | try: |
|
136 | try: | |
137 | raw_input("Please press <RETURN> to start IPython.") |
|
137 | raw_input("Please press <RETURN> to start IPython.") | |
138 | except EOFError: |
|
138 | except EOFError: | |
139 | print >> Term.cout |
|
139 | print >> Term.cout | |
140 | print '*'*70 |
|
140 | print '*'*70 | |
141 |
|
141 | |||
142 | def printf(s): |
|
142 | def printf(s): | |
143 | print s |
|
143 | print s | |
144 | else: |
|
144 | else: | |
145 | wait = lambda : None |
|
145 | wait = lambda : None | |
146 | printf = lambda s : None |
|
146 | printf = lambda s : None | |
147 |
|
147 | |||
148 | # Install mode should be re-entrant: if the install dir already exists, |
|
148 | # Install mode should be re-entrant: if the install dir already exists, | |
149 | # bail out cleanly. |
|
149 | # bail out cleanly. | |
150 | # XXX. This is too hasty to return. We need to check to make sure that |
|
150 | # XXX. This is too hasty to return. We need to check to make sure that | |
151 | # all the expected config files and directories are actually there. We |
|
151 | # all the expected config files and directories are actually there. We | |
152 | # currently have a failure mode if someone deletes a needed config file |
|
152 | # currently have a failure mode if someone deletes a needed config file | |
153 | # but still has the ipythondir. |
|
153 | # but still has the ipythondir. | |
154 | if mode == 'install' and os.path.isdir(ipythondir): |
|
154 | if mode == 'install' and os.path.isdir(ipythondir): | |
155 | return |
|
155 | return | |
156 |
|
156 | |||
157 | cwd = os.getcwd() # remember where we started |
|
157 | cwd = os.getcwd() # remember where we started | |
158 | glb = glob.glob |
|
158 | glb = glob.glob | |
159 |
|
159 | |||
160 | printf('*'*70) |
|
160 | printf('*'*70) | |
161 | if mode == 'install': |
|
161 | if mode == 'install': | |
162 | printf( |
|
162 | printf( | |
163 | """Welcome to IPython. I will try to create a personal configuration directory |
|
163 | """Welcome to IPython. I will try to create a personal configuration directory | |
164 | where you can customize many aspects of IPython's functionality in:\n""") |
|
164 | where you can customize many aspects of IPython's functionality in:\n""") | |
165 | else: |
|
165 | else: | |
166 | printf('I am going to upgrade your configuration in:') |
|
166 | printf('I am going to upgrade your configuration in:') | |
167 |
|
167 | |||
168 | printf(ipythondir) |
|
168 | printf(ipythondir) | |
169 |
|
169 | |||
170 | rcdirend = os.path.join('IPython','UserConfig') |
|
170 | rcdirend = os.path.join('IPython','UserConfig') | |
171 | cfg = lambda d: os.path.join(d,rcdirend) |
|
171 | cfg = lambda d: os.path.join(d,rcdirend) | |
172 | try: |
|
172 | try: | |
173 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] |
|
173 | rcdir = filter(os.path.isdir,map(cfg,sys.path))[0] | |
174 | printf("Initializing from configuration: %s" % rcdir) |
|
174 | printf("Initializing from configuration: %s" % rcdir) | |
175 | except IndexError: |
|
175 | except IndexError: | |
176 | warning = """ |
|
176 | warning = """ | |
177 | Installation error. IPython's directory was not found. |
|
177 | Installation error. IPython's directory was not found. | |
178 |
|
178 | |||
179 | Check the following: |
|
179 | Check the following: | |
180 |
|
180 | |||
181 | The ipython/IPython directory should be in a directory belonging to your |
|
181 | The ipython/IPython directory should be in a directory belonging to your | |
182 | PYTHONPATH environment variable (that is, it should be in a directory |
|
182 | PYTHONPATH environment variable (that is, it should be in a directory | |
183 | belonging to sys.path). You can copy it explicitly there or just link to it. |
|
183 | belonging to sys.path). You can copy it explicitly there or just link to it. | |
184 |
|
184 | |||
185 | IPython will create a minimal default configuration for you. |
|
185 | IPython will create a minimal default configuration for you. | |
186 |
|
186 | |||
187 | """ |
|
187 | """ | |
188 | warn(warning) |
|
188 | warn(warning) | |
189 | wait() |
|
189 | wait() | |
190 |
|
190 | |||
191 | if sys.platform =='win32': |
|
191 | if sys.platform =='win32': | |
192 | inif = 'ipythonrc.ini' |
|
192 | inif = 'ipythonrc.ini' | |
193 | else: |
|
193 | else: | |
194 | inif = 'ipythonrc' |
|
194 | inif = 'ipythonrc' | |
195 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', |
|
195 | minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', | |
196 | inif : '# intentionally left blank' } |
|
196 | inif : '# intentionally left blank' } | |
197 | os.makedirs(ipythondir, mode = 0777) |
|
197 | os.makedirs(ipythondir, mode = 0777) | |
198 | for f, cont in minimal_setup.items(): |
|
198 | for f, cont in minimal_setup.items(): | |
199 | # In 2.5, this can be more cleanly done using 'with' |
|
199 | # In 2.5, this can be more cleanly done using 'with' | |
200 | fobj = file(ipythondir + '/' + f,'w') |
|
200 | fobj = file(ipythondir + '/' + f,'w') | |
201 | fobj.write(cont) |
|
201 | fobj.write(cont) | |
202 | fobj.close() |
|
202 | fobj.close() | |
203 |
|
203 | |||
204 | return |
|
204 | return | |
205 |
|
205 | |||
206 | if mode == 'install': |
|
206 | if mode == 'install': | |
207 | try: |
|
207 | try: | |
208 | shutil.copytree(rcdir,ipythondir) |
|
208 | shutil.copytree(rcdir,ipythondir) | |
209 | os.chdir(ipythondir) |
|
209 | os.chdir(ipythondir) | |
210 | rc_files = glb("ipythonrc*") |
|
210 | rc_files = glb("ipythonrc*") | |
211 | for rc_file in rc_files: |
|
211 | for rc_file in rc_files: | |
212 | os.rename(rc_file,rc_file+rc_suffix) |
|
212 | os.rename(rc_file,rc_file+rc_suffix) | |
213 | except: |
|
213 | except: | |
214 | warning = """ |
|
214 | warning = """ | |
215 |
|
215 | |||
216 | There was a problem with the installation: |
|
216 | There was a problem with the installation: | |
217 | %s |
|
217 | %s | |
218 | Try to correct it or contact the developers if you think it's a bug. |
|
218 | Try to correct it or contact the developers if you think it's a bug. | |
219 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] |
|
219 | IPython will proceed with builtin defaults.""" % sys.exc_info()[1] | |
220 | warn(warning) |
|
220 | warn(warning) | |
221 | wait() |
|
221 | wait() | |
222 | return |
|
222 | return | |
223 |
|
223 | |||
224 | elif mode == 'upgrade': |
|
224 | elif mode == 'upgrade': | |
225 | try: |
|
225 | try: | |
226 | os.chdir(ipythondir) |
|
226 | os.chdir(ipythondir) | |
227 | except: |
|
227 | except: | |
228 | printf(""" |
|
228 | printf(""" | |
229 | Can not upgrade: changing to directory %s failed. Details: |
|
229 | Can not upgrade: changing to directory %s failed. Details: | |
230 | %s |
|
230 | %s | |
231 | """ % (ipythondir,sys.exc_info()[1]) ) |
|
231 | """ % (ipythondir,sys.exc_info()[1]) ) | |
232 | wait() |
|
232 | wait() | |
233 | return |
|
233 | return | |
234 | else: |
|
234 | else: | |
235 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) |
|
235 | sources = glb(os.path.join(rcdir,'[A-Za-z]*')) | |
236 | for new_full_path in sources: |
|
236 | for new_full_path in sources: | |
237 | new_filename = os.path.basename(new_full_path) |
|
237 | new_filename = os.path.basename(new_full_path) | |
238 | if new_filename.startswith('ipythonrc'): |
|
238 | if new_filename.startswith('ipythonrc'): | |
239 | new_filename = new_filename + rc_suffix |
|
239 | new_filename = new_filename + rc_suffix | |
240 | # The config directory should only contain files, skip any |
|
240 | # The config directory should only contain files, skip any | |
241 | # directories which may be there (like CVS) |
|
241 | # directories which may be there (like CVS) | |
242 | if os.path.isdir(new_full_path): |
|
242 | if os.path.isdir(new_full_path): | |
243 | continue |
|
243 | continue | |
244 | if os.path.exists(new_filename): |
|
244 | if os.path.exists(new_filename): | |
245 | old_file = new_filename+'.old' |
|
245 | old_file = new_filename+'.old' | |
246 | if os.path.exists(old_file): |
|
246 | if os.path.exists(old_file): | |
247 | os.remove(old_file) |
|
247 | os.remove(old_file) | |
248 | os.rename(new_filename,old_file) |
|
248 | os.rename(new_filename,old_file) | |
249 | shutil.copy(new_full_path,new_filename) |
|
249 | shutil.copy(new_full_path,new_filename) | |
250 | else: |
|
250 | else: | |
251 | raise ValueError('unrecognized mode for install: %r' % mode) |
|
251 | raise ValueError('unrecognized mode for install: %r' % mode) | |
252 |
|
252 | |||
253 | # Fix line-endings to those native to each platform in the config |
|
253 | # Fix line-endings to those native to each platform in the config | |
254 | # directory. |
|
254 | # directory. | |
255 | try: |
|
255 | try: | |
256 | os.chdir(ipythondir) |
|
256 | os.chdir(ipythondir) | |
257 | except: |
|
257 | except: | |
258 | printf(""" |
|
258 | printf(""" | |
259 | Problem: changing to directory %s failed. |
|
259 | Problem: changing to directory %s failed. | |
260 | Details: |
|
260 | Details: | |
261 | %s |
|
261 | %s | |
262 |
|
262 | |||
263 | Some configuration files may have incorrect line endings. This should not |
|
263 | Some configuration files may have incorrect line endings. This should not | |
264 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) |
|
264 | cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) ) | |
265 | wait() |
|
265 | wait() | |
266 | else: |
|
266 | else: | |
267 | for fname in glb('ipythonrc*'): |
|
267 | for fname in glb('ipythonrc*'): | |
268 | try: |
|
268 | try: | |
269 | native_line_ends(fname,backup=0) |
|
269 | native_line_ends(fname,backup=0) | |
270 | except IOError: |
|
270 | except IOError: | |
271 | pass |
|
271 | pass | |
272 |
|
272 | |||
273 | if mode == 'install': |
|
273 | if mode == 'install': | |
274 | printf(""" |
|
274 | printf(""" | |
275 | Successful installation! |
|
275 | Successful installation! | |
276 |
|
276 | |||
277 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the |
|
277 | Please read the sections 'Initial Configuration' and 'Quick Tips' in the | |
278 | IPython manual (there are both HTML and PDF versions supplied with the |
|
278 | IPython manual (there are both HTML and PDF versions supplied with the | |
279 | distribution) to make sure that your system environment is properly configured |
|
279 | distribution) to make sure that your system environment is properly configured | |
280 | to take advantage of IPython's features. |
|
280 | to take advantage of IPython's features. | |
281 |
|
281 | |||
282 | Important note: the configuration system has changed! The old system is |
|
282 | Important note: the configuration system has changed! The old system is | |
283 | still in place, but its setting may be partly overridden by the settings in |
|
283 | still in place, but its setting may be partly overridden by the settings in | |
284 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file |
|
284 | "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file | |
285 | if some of the new settings bother you. |
|
285 | if some of the new settings bother you. | |
286 |
|
286 | |||
287 | """) |
|
287 | """) | |
288 | else: |
|
288 | else: | |
289 | printf(""" |
|
289 | printf(""" | |
290 | Successful upgrade! |
|
290 | Successful upgrade! | |
291 |
|
291 | |||
292 | All files in your directory: |
|
292 | All files in your directory: | |
293 | %(ipythondir)s |
|
293 | %(ipythondir)s | |
294 | which would have been overwritten by the upgrade were backed up with a .old |
|
294 | which would have been overwritten by the upgrade were backed up with a .old | |
295 | extension. If you had made particular customizations in those files you may |
|
295 | extension. If you had made particular customizations in those files you may | |
296 | want to merge them back into the new files.""" % locals() ) |
|
296 | want to merge them back into the new files.""" % locals() ) | |
297 | wait() |
|
297 | wait() | |
298 | os.chdir(cwd) |
|
298 | os.chdir(cwd) | |
299 |
|
299 | |||
300 | #**************************************************************************** |
|
300 | #**************************************************************************** | |
301 | # Local use exceptions |
|
301 | # Local use exceptions | |
302 | class SpaceInInput(exceptions.Exception): pass |
|
302 | class SpaceInInput(exceptions.Exception): pass | |
303 |
|
303 | |||
304 |
|
304 | |||
305 | #**************************************************************************** |
|
305 | #**************************************************************************** | |
306 | # Local use classes |
|
306 | # Local use classes | |
307 | class Bunch: pass |
|
307 | class Bunch: pass | |
308 |
|
308 | |||
309 | class Undefined: pass |
|
309 | class Undefined: pass | |
310 |
|
310 | |||
311 | class Quitter(object): |
|
311 | class Quitter(object): | |
312 | """Simple class to handle exit, similar to Python 2.5's. |
|
312 | """Simple class to handle exit, similar to Python 2.5's. | |
313 |
|
313 | |||
314 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 |
|
314 | It handles exiting in an ipython-safe manner, which the one in Python 2.5 | |
315 | doesn't do (obviously, since it doesn't know about ipython).""" |
|
315 | doesn't do (obviously, since it doesn't know about ipython).""" | |
316 |
|
316 | |||
317 | def __init__(self,shell,name): |
|
317 | def __init__(self,shell,name): | |
318 | self.shell = shell |
|
318 | self.shell = shell | |
319 | self.name = name |
|
319 | self.name = name | |
320 |
|
320 | |||
321 | def __repr__(self): |
|
321 | def __repr__(self): | |
322 | return 'Type %s() to exit.' % self.name |
|
322 | return 'Type %s() to exit.' % self.name | |
323 | __str__ = __repr__ |
|
323 | __str__ = __repr__ | |
324 |
|
324 | |||
325 | def __call__(self): |
|
325 | def __call__(self): | |
326 | self.shell.exit() |
|
326 | self.shell.exit() | |
327 |
|
327 | |||
328 | class InputList(list): |
|
328 | class InputList(list): | |
329 | """Class to store user input. |
|
329 | """Class to store user input. | |
330 |
|
330 | |||
331 | It's basically a list, but slices return a string instead of a list, thus |
|
331 | It's basically a list, but slices return a string instead of a list, thus | |
332 | allowing things like (assuming 'In' is an instance): |
|
332 | allowing things like (assuming 'In' is an instance): | |
333 |
|
333 | |||
334 | exec In[4:7] |
|
334 | exec In[4:7] | |
335 |
|
335 | |||
336 | or |
|
336 | or | |
337 |
|
337 | |||
338 | exec In[5:9] + In[14] + In[21:25]""" |
|
338 | exec In[5:9] + In[14] + In[21:25]""" | |
339 |
|
339 | |||
340 | def __getslice__(self,i,j): |
|
340 | def __getslice__(self,i,j): | |
341 | return ''.join(list.__getslice__(self,i,j)) |
|
341 | return ''.join(list.__getslice__(self,i,j)) | |
342 |
|
342 | |||
343 |
class SyntaxTB(ultra |
|
343 | class SyntaxTB(ultratb.ListTB): | |
344 | """Extension which holds some state: the last exception value""" |
|
344 | """Extension which holds some state: the last exception value""" | |
345 |
|
345 | |||
346 | def __init__(self,color_scheme = 'NoColor'): |
|
346 | def __init__(self,color_scheme = 'NoColor'): | |
347 |
ultra |
|
347 | ultratb.ListTB.__init__(self,color_scheme) | |
348 | self.last_syntax_error = None |
|
348 | self.last_syntax_error = None | |
349 |
|
349 | |||
350 | def __call__(self, etype, value, elist): |
|
350 | def __call__(self, etype, value, elist): | |
351 | self.last_syntax_error = value |
|
351 | self.last_syntax_error = value | |
352 |
ultra |
|
352 | ultratb.ListTB.__call__(self,etype,value,elist) | |
353 |
|
353 | |||
354 | def clear_err_state(self): |
|
354 | def clear_err_state(self): | |
355 | """Return the current error state and clear it""" |
|
355 | """Return the current error state and clear it""" | |
356 | e = self.last_syntax_error |
|
356 | e = self.last_syntax_error | |
357 | self.last_syntax_error = None |
|
357 | self.last_syntax_error = None | |
358 | return e |
|
358 | return e | |
359 |
|
359 | |||
360 | #**************************************************************************** |
|
360 | #**************************************************************************** | |
361 | # Main IPython class |
|
361 | # Main IPython class | |
362 |
|
362 | |||
363 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so |
|
363 | # FIXME: the Magic class is a mixin for now, and will unfortunately remain so | |
364 | # until a full rewrite is made. I've cleaned all cross-class uses of |
|
364 | # until a full rewrite is made. I've cleaned all cross-class uses of | |
365 | # attributes and methods, but too much user code out there relies on the |
|
365 | # attributes and methods, but too much user code out there relies on the | |
366 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. |
|
366 | # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage. | |
367 | # |
|
367 | # | |
368 | # But at least now, all the pieces have been separated and we could, in |
|
368 | # But at least now, all the pieces have been separated and we could, in | |
369 | # principle, stop using the mixin. This will ease the transition to the |
|
369 | # principle, stop using the mixin. This will ease the transition to the | |
370 | # chainsaw branch. |
|
370 | # chainsaw branch. | |
371 |
|
371 | |||
372 | # For reference, the following is the list of 'self.foo' uses in the Magic |
|
372 | # For reference, the following is the list of 'self.foo' uses in the Magic | |
373 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython |
|
373 | # class as of 2005-12-28. These are names we CAN'T use in the main ipython | |
374 | # class, to prevent clashes. |
|
374 | # class, to prevent clashes. | |
375 |
|
375 | |||
376 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', |
|
376 | # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind', | |
377 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', |
|
377 | # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic', | |
378 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', |
|
378 | # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell', | |
379 | # 'self.value'] |
|
379 | # 'self.value'] | |
380 |
|
380 | |||
381 | class InteractiveShell(object,Magic): |
|
381 | class InteractiveShell(object,Magic): | |
382 | """An enhanced console for Python.""" |
|
382 | """An enhanced console for Python.""" | |
383 |
|
383 | |||
384 | # class attribute to indicate whether the class supports threads or not. |
|
384 | # class attribute to indicate whether the class supports threads or not. | |
385 | # Subclasses with thread support should override this as needed. |
|
385 | # Subclasses with thread support should override this as needed. | |
386 | isthreaded = False |
|
386 | isthreaded = False | |
387 |
|
387 | |||
388 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
388 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
389 | user_ns=None,user_global_ns=None,banner2='', |
|
389 | user_ns=None,user_global_ns=None,banner2='', | |
390 | custom_exceptions=((),None),embedded=False): |
|
390 | custom_exceptions=((),None),embedded=False): | |
391 |
|
391 | |||
392 | # log system |
|
392 | # log system | |
393 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') |
|
393 | self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate') | |
394 |
|
394 | |||
395 | # Job manager (for jobs run as background threads) |
|
395 | # Job manager (for jobs run as background threads) | |
396 | self.jobs = BackgroundJobManager() |
|
396 | self.jobs = BackgroundJobManager() | |
397 |
|
397 | |||
398 | # Store the actual shell's name |
|
398 | # Store the actual shell's name | |
399 | self.name = name |
|
399 | self.name = name | |
400 | self.more = False |
|
400 | self.more = False | |
401 |
|
401 | |||
402 | # We need to know whether the instance is meant for embedding, since |
|
402 | # We need to know whether the instance is meant for embedding, since | |
403 | # global/local namespaces need to be handled differently in that case |
|
403 | # global/local namespaces need to be handled differently in that case | |
404 | self.embedded = embedded |
|
404 | self.embedded = embedded | |
405 | if embedded: |
|
405 | if embedded: | |
406 | # Control variable so users can, from within the embedded instance, |
|
406 | # Control variable so users can, from within the embedded instance, | |
407 | # permanently deactivate it. |
|
407 | # permanently deactivate it. | |
408 | self.embedded_active = True |
|
408 | self.embedded_active = True | |
409 |
|
409 | |||
410 | # command compiler |
|
410 | # command compiler | |
411 | self.compile = codeop.CommandCompiler() |
|
411 | self.compile = codeop.CommandCompiler() | |
412 |
|
412 | |||
413 | # User input buffer |
|
413 | # User input buffer | |
414 | self.buffer = [] |
|
414 | self.buffer = [] | |
415 |
|
415 | |||
416 | # Default name given in compilation of code |
|
416 | # Default name given in compilation of code | |
417 | self.filename = '<ipython console>' |
|
417 | self.filename = '<ipython console>' | |
418 |
|
418 | |||
419 | # Install our own quitter instead of the builtins. For python2.3-2.4, |
|
419 | # Install our own quitter instead of the builtins. For python2.3-2.4, | |
420 | # this brings in behavior like 2.5, and for 2.5 it's identical. |
|
420 | # this brings in behavior like 2.5, and for 2.5 it's identical. | |
421 | __builtin__.exit = Quitter(self,'exit') |
|
421 | __builtin__.exit = Quitter(self,'exit') | |
422 | __builtin__.quit = Quitter(self,'quit') |
|
422 | __builtin__.quit = Quitter(self,'quit') | |
423 |
|
423 | |||
424 | # Make an empty namespace, which extension writers can rely on both |
|
424 | # Make an empty namespace, which extension writers can rely on both | |
425 | # existing and NEVER being used by ipython itself. This gives them a |
|
425 | # existing and NEVER being used by ipython itself. This gives them a | |
426 | # convenient location for storing additional information and state |
|
426 | # convenient location for storing additional information and state | |
427 | # their extensions may require, without fear of collisions with other |
|
427 | # their extensions may require, without fear of collisions with other | |
428 | # ipython names that may develop later. |
|
428 | # ipython names that may develop later. | |
429 | self.meta = Struct() |
|
429 | self.meta = Struct() | |
430 |
|
430 | |||
431 | # Create the namespace where the user will operate. user_ns is |
|
431 | # Create the namespace where the user will operate. user_ns is | |
432 | # normally the only one used, and it is passed to the exec calls as |
|
432 | # normally the only one used, and it is passed to the exec calls as | |
433 | # the locals argument. But we do carry a user_global_ns namespace |
|
433 | # the locals argument. But we do carry a user_global_ns namespace | |
434 | # given as the exec 'globals' argument, This is useful in embedding |
|
434 | # given as the exec 'globals' argument, This is useful in embedding | |
435 | # situations where the ipython shell opens in a context where the |
|
435 | # situations where the ipython shell opens in a context where the | |
436 | # distinction between locals and globals is meaningful. For |
|
436 | # distinction between locals and globals is meaningful. For | |
437 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
437 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
438 |
|
438 | |||
439 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
439 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
440 | # level as a dict instead of a module. This is a manual fix, but I |
|
440 | # level as a dict instead of a module. This is a manual fix, but I | |
441 | # should really track down where the problem is coming from. Alex |
|
441 | # should really track down where the problem is coming from. Alex | |
442 | # Schmolck reported this problem first. |
|
442 | # Schmolck reported this problem first. | |
443 |
|
443 | |||
444 | # A useful post by Alex Martelli on this topic: |
|
444 | # A useful post by Alex Martelli on this topic: | |
445 | # Re: inconsistent value from __builtins__ |
|
445 | # Re: inconsistent value from __builtins__ | |
446 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
446 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
447 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
447 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
448 | # Gruppen: comp.lang.python |
|
448 | # Gruppen: comp.lang.python | |
449 |
|
449 | |||
450 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
450 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
451 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
451 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
452 | # > <type 'dict'> |
|
452 | # > <type 'dict'> | |
453 | # > >>> print type(__builtins__) |
|
453 | # > >>> print type(__builtins__) | |
454 | # > <type 'module'> |
|
454 | # > <type 'module'> | |
455 | # > Is this difference in return value intentional? |
|
455 | # > Is this difference in return value intentional? | |
456 |
|
456 | |||
457 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
457 | # Well, it's documented that '__builtins__' can be either a dictionary | |
458 | # or a module, and it's been that way for a long time. Whether it's |
|
458 | # or a module, and it's been that way for a long time. Whether it's | |
459 | # intentional (or sensible), I don't know. In any case, the idea is |
|
459 | # intentional (or sensible), I don't know. In any case, the idea is | |
460 | # that if you need to access the built-in namespace directly, you |
|
460 | # that if you need to access the built-in namespace directly, you | |
461 | # should start with "import __builtin__" (note, no 's') which will |
|
461 | # should start with "import __builtin__" (note, no 's') which will | |
462 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
462 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
463 |
|
463 | |||
464 | # These routines return properly built dicts as needed by the rest of |
|
464 | # These routines return properly built dicts as needed by the rest of | |
465 | # the code, and can also be used by extension writers to generate |
|
465 | # the code, and can also be used by extension writers to generate | |
466 | # properly initialized namespaces. |
|
466 | # properly initialized namespaces. | |
467 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, |
|
467 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, | |
468 | user_global_ns) |
|
468 | user_global_ns) | |
469 |
|
469 | |||
470 | # Assign namespaces |
|
470 | # Assign namespaces | |
471 | # This is the namespace where all normal user variables live |
|
471 | # This is the namespace where all normal user variables live | |
472 | self.user_ns = user_ns |
|
472 | self.user_ns = user_ns | |
473 | self.user_global_ns = user_global_ns |
|
473 | self.user_global_ns = user_global_ns | |
474 |
|
474 | |||
475 | # An auxiliary namespace that checks what parts of the user_ns were |
|
475 | # An auxiliary namespace that checks what parts of the user_ns were | |
476 | # loaded at startup, so we can list later only variables defined in |
|
476 | # loaded at startup, so we can list later only variables defined in | |
477 | # actual interactive use. Since it is always a subset of user_ns, it |
|
477 | # actual interactive use. Since it is always a subset of user_ns, it | |
478 | # doesn't need to be seaparately tracked in the ns_table |
|
478 | # doesn't need to be seaparately tracked in the ns_table | |
479 | self.user_config_ns = {} |
|
479 | self.user_config_ns = {} | |
480 |
|
480 | |||
481 | # A namespace to keep track of internal data structures to prevent |
|
481 | # A namespace to keep track of internal data structures to prevent | |
482 | # them from cluttering user-visible stuff. Will be updated later |
|
482 | # them from cluttering user-visible stuff. Will be updated later | |
483 | self.internal_ns = {} |
|
483 | self.internal_ns = {} | |
484 |
|
484 | |||
485 | # Namespace of system aliases. Each entry in the alias |
|
485 | # Namespace of system aliases. Each entry in the alias | |
486 | # table must be a 2-tuple of the form (N,name), where N is the number |
|
486 | # table must be a 2-tuple of the form (N,name), where N is the number | |
487 | # of positional arguments of the alias. |
|
487 | # of positional arguments of the alias. | |
488 | self.alias_table = {} |
|
488 | self.alias_table = {} | |
489 |
|
489 | |||
490 | # Now that FakeModule produces a real module, we've run into a nasty |
|
490 | # Now that FakeModule produces a real module, we've run into a nasty | |
491 | # problem: after script execution (via %run), the module where the user |
|
491 | # problem: after script execution (via %run), the module where the user | |
492 | # code ran is deleted. Now that this object is a true module (needed |
|
492 | # code ran is deleted. Now that this object is a true module (needed | |
493 | # so docetst and other tools work correctly), the Python module |
|
493 | # so docetst and other tools work correctly), the Python module | |
494 | # teardown mechanism runs over it, and sets to None every variable |
|
494 | # teardown mechanism runs over it, and sets to None every variable | |
495 | # present in that module. Top-level references to objects from the |
|
495 | # present in that module. Top-level references to objects from the | |
496 | # script survive, because the user_ns is updated with them. However, |
|
496 | # script survive, because the user_ns is updated with them. However, | |
497 | # calling functions defined in the script that use other things from |
|
497 | # calling functions defined in the script that use other things from | |
498 | # the script will fail, because the function's closure had references |
|
498 | # the script will fail, because the function's closure had references | |
499 | # to the original objects, which are now all None. So we must protect |
|
499 | # to the original objects, which are now all None. So we must protect | |
500 | # these modules from deletion by keeping a cache. |
|
500 | # these modules from deletion by keeping a cache. | |
501 | # |
|
501 | # | |
502 | # To avoid keeping stale modules around (we only need the one from the |
|
502 | # To avoid keeping stale modules around (we only need the one from the | |
503 | # last run), we use a dict keyed with the full path to the script, so |
|
503 | # last run), we use a dict keyed with the full path to the script, so | |
504 | # only the last version of the module is held in the cache. Note, |
|
504 | # only the last version of the module is held in the cache. Note, | |
505 | # however, that we must cache the module *namespace contents* (their |
|
505 | # however, that we must cache the module *namespace contents* (their | |
506 | # __dict__). Because if we try to cache the actual modules, old ones |
|
506 | # __dict__). Because if we try to cache the actual modules, old ones | |
507 | # (uncached) could be destroyed while still holding references (such as |
|
507 | # (uncached) could be destroyed while still holding references (such as | |
508 | # those held by GUI objects that tend to be long-lived)> |
|
508 | # those held by GUI objects that tend to be long-lived)> | |
509 | # |
|
509 | # | |
510 | # The %reset command will flush this cache. See the cache_main_mod() |
|
510 | # The %reset command will flush this cache. See the cache_main_mod() | |
511 | # and clear_main_mod_cache() methods for details on use. |
|
511 | # and clear_main_mod_cache() methods for details on use. | |
512 |
|
512 | |||
513 | # This is the cache used for 'main' namespaces |
|
513 | # This is the cache used for 'main' namespaces | |
514 | self._main_ns_cache = {} |
|
514 | self._main_ns_cache = {} | |
515 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
515 | # And this is the single instance of FakeModule whose __dict__ we keep | |
516 | # copying and clearing for reuse on each %run |
|
516 | # copying and clearing for reuse on each %run | |
517 | self._user_main_module = FakeModule() |
|
517 | self._user_main_module = FakeModule() | |
518 |
|
518 | |||
519 | # A table holding all the namespaces IPython deals with, so that |
|
519 | # A table holding all the namespaces IPython deals with, so that | |
520 | # introspection facilities can search easily. |
|
520 | # introspection facilities can search easily. | |
521 | self.ns_table = {'user':user_ns, |
|
521 | self.ns_table = {'user':user_ns, | |
522 | 'user_global':user_global_ns, |
|
522 | 'user_global':user_global_ns, | |
523 | 'alias':self.alias_table, |
|
523 | 'alias':self.alias_table, | |
524 | 'internal':self.internal_ns, |
|
524 | 'internal':self.internal_ns, | |
525 | 'builtin':__builtin__.__dict__ |
|
525 | 'builtin':__builtin__.__dict__ | |
526 | } |
|
526 | } | |
527 |
|
527 | |||
528 | # Similarly, track all namespaces where references can be held and that |
|
528 | # Similarly, track all namespaces where references can be held and that | |
529 | # we can safely clear (so it can NOT include builtin). This one can be |
|
529 | # we can safely clear (so it can NOT include builtin). This one can be | |
530 | # a simple list. |
|
530 | # a simple list. | |
531 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, |
|
531 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, | |
532 | self.alias_table, self.internal_ns, |
|
532 | self.alias_table, self.internal_ns, | |
533 | self._main_ns_cache ] |
|
533 | self._main_ns_cache ] | |
534 |
|
534 | |||
535 | # We need to insert into sys.modules something that looks like a |
|
535 | # We need to insert into sys.modules something that looks like a | |
536 | # module but which accesses the IPython namespace, for shelve and |
|
536 | # module but which accesses the IPython namespace, for shelve and | |
537 | # pickle to work interactively. Normally they rely on getting |
|
537 | # pickle to work interactively. Normally they rely on getting | |
538 | # everything out of __main__, but for embedding purposes each IPython |
|
538 | # everything out of __main__, but for embedding purposes each IPython | |
539 | # instance has its own private namespace, so we can't go shoving |
|
539 | # instance has its own private namespace, so we can't go shoving | |
540 | # everything into __main__. |
|
540 | # everything into __main__. | |
541 |
|
541 | |||
542 | # note, however, that we should only do this for non-embedded |
|
542 | # note, however, that we should only do this for non-embedded | |
543 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
543 | # ipythons, which really mimic the __main__.__dict__ with their own | |
544 | # namespace. Embedded instances, on the other hand, should not do |
|
544 | # namespace. Embedded instances, on the other hand, should not do | |
545 | # this because they need to manage the user local/global namespaces |
|
545 | # this because they need to manage the user local/global namespaces | |
546 | # only, but they live within a 'normal' __main__ (meaning, they |
|
546 | # only, but they live within a 'normal' __main__ (meaning, they | |
547 | # shouldn't overtake the execution environment of the script they're |
|
547 | # shouldn't overtake the execution environment of the script they're | |
548 | # embedded in). |
|
548 | # embedded in). | |
549 |
|
549 | |||
550 | if not embedded: |
|
550 | if not embedded: | |
551 | try: |
|
551 | try: | |
552 | main_name = self.user_ns['__name__'] |
|
552 | main_name = self.user_ns['__name__'] | |
553 | except KeyError: |
|
553 | except KeyError: | |
554 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' |
|
554 | raise KeyError,'user_ns dictionary MUST have a "__name__" key' | |
555 | else: |
|
555 | else: | |
556 | #print "pickle hack in place" # dbg |
|
556 | #print "pickle hack in place" # dbg | |
557 | #print 'main_name:',main_name # dbg |
|
557 | #print 'main_name:',main_name # dbg | |
558 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
558 | sys.modules[main_name] = FakeModule(self.user_ns) | |
559 |
|
559 | |||
560 | # List of input with multi-line handling. |
|
560 | # List of input with multi-line handling. | |
561 | self.input_hist = InputList() |
|
561 | self.input_hist = InputList() | |
562 | # This one will hold the 'raw' input history, without any |
|
562 | # This one will hold the 'raw' input history, without any | |
563 | # pre-processing. This will allow users to retrieve the input just as |
|
563 | # pre-processing. This will allow users to retrieve the input just as | |
564 | # it was exactly typed in by the user, with %hist -r. |
|
564 | # it was exactly typed in by the user, with %hist -r. | |
565 | self.input_hist_raw = InputList() |
|
565 | self.input_hist_raw = InputList() | |
566 |
|
566 | |||
567 | # list of visited directories |
|
567 | # list of visited directories | |
568 | try: |
|
568 | try: | |
569 | self.dir_hist = [os.getcwd()] |
|
569 | self.dir_hist = [os.getcwd()] | |
570 | except OSError: |
|
570 | except OSError: | |
571 | self.dir_hist = [] |
|
571 | self.dir_hist = [] | |
572 |
|
572 | |||
573 | # dict of output history |
|
573 | # dict of output history | |
574 | self.output_hist = {} |
|
574 | self.output_hist = {} | |
575 |
|
575 | |||
576 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
576 | # Get system encoding at startup time. Certain terminals (like Emacs | |
577 | # under Win32 have it set to None, and we need to have a known valid |
|
577 | # under Win32 have it set to None, and we need to have a known valid | |
578 | # encoding to use in the raw_input() method |
|
578 | # encoding to use in the raw_input() method | |
579 | try: |
|
579 | try: | |
580 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
580 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
581 | except AttributeError: |
|
581 | except AttributeError: | |
582 | self.stdin_encoding = 'ascii' |
|
582 | self.stdin_encoding = 'ascii' | |
583 |
|
583 | |||
584 | # dict of things NOT to alias (keywords, builtins and some magics) |
|
584 | # dict of things NOT to alias (keywords, builtins and some magics) | |
585 | no_alias = {} |
|
585 | no_alias = {} | |
586 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] |
|
586 | no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias'] | |
587 | for key in keyword.kwlist + no_alias_magics: |
|
587 | for key in keyword.kwlist + no_alias_magics: | |
588 | no_alias[key] = 1 |
|
588 | no_alias[key] = 1 | |
589 | no_alias.update(__builtin__.__dict__) |
|
589 | no_alias.update(__builtin__.__dict__) | |
590 | self.no_alias = no_alias |
|
590 | self.no_alias = no_alias | |
591 |
|
591 | |||
592 | # Object variable to store code object waiting execution. This is |
|
592 | # Object variable to store code object waiting execution. This is | |
593 | # used mainly by the multithreaded shells, but it can come in handy in |
|
593 | # used mainly by the multithreaded shells, but it can come in handy in | |
594 | # other situations. No need to use a Queue here, since it's a single |
|
594 | # other situations. No need to use a Queue here, since it's a single | |
595 | # item which gets cleared once run. |
|
595 | # item which gets cleared once run. | |
596 | self.code_to_run = None |
|
596 | self.code_to_run = None | |
597 |
|
597 | |||
598 | # escapes for automatic behavior on the command line |
|
598 | # escapes for automatic behavior on the command line | |
599 | self.ESC_SHELL = '!' |
|
599 | self.ESC_SHELL = '!' | |
600 | self.ESC_SH_CAP = '!!' |
|
600 | self.ESC_SH_CAP = '!!' | |
601 | self.ESC_HELP = '?' |
|
601 | self.ESC_HELP = '?' | |
602 | self.ESC_MAGIC = '%' |
|
602 | self.ESC_MAGIC = '%' | |
603 | self.ESC_QUOTE = ',' |
|
603 | self.ESC_QUOTE = ',' | |
604 | self.ESC_QUOTE2 = ';' |
|
604 | self.ESC_QUOTE2 = ';' | |
605 | self.ESC_PAREN = '/' |
|
605 | self.ESC_PAREN = '/' | |
606 |
|
606 | |||
607 | # And their associated handlers |
|
607 | # And their associated handlers | |
608 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, |
|
608 | self.esc_handlers = {self.ESC_PAREN : self.handle_auto, | |
609 | self.ESC_QUOTE : self.handle_auto, |
|
609 | self.ESC_QUOTE : self.handle_auto, | |
610 | self.ESC_QUOTE2 : self.handle_auto, |
|
610 | self.ESC_QUOTE2 : self.handle_auto, | |
611 | self.ESC_MAGIC : self.handle_magic, |
|
611 | self.ESC_MAGIC : self.handle_magic, | |
612 | self.ESC_HELP : self.handle_help, |
|
612 | self.ESC_HELP : self.handle_help, | |
613 | self.ESC_SHELL : self.handle_shell_escape, |
|
613 | self.ESC_SHELL : self.handle_shell_escape, | |
614 | self.ESC_SH_CAP : self.handle_shell_escape, |
|
614 | self.ESC_SH_CAP : self.handle_shell_escape, | |
615 | } |
|
615 | } | |
616 |
|
616 | |||
617 | # class initializations |
|
617 | # class initializations | |
618 | Magic.__init__(self,self) |
|
618 | Magic.__init__(self,self) | |
619 |
|
619 | |||
620 | # Python source parser/formatter for syntax highlighting |
|
620 | # Python source parser/formatter for syntax highlighting | |
621 | pyformat = PyColorize.Parser().format |
|
621 | pyformat = PyColorize.Parser().format | |
622 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) |
|
622 | self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors']) | |
623 |
|
623 | |||
624 | # hooks holds pointers used for user-side customizations |
|
624 | # hooks holds pointers used for user-side customizations | |
625 | self.hooks = Struct() |
|
625 | self.hooks = Struct() | |
626 |
|
626 | |||
627 | self.strdispatchers = {} |
|
627 | self.strdispatchers = {} | |
628 |
|
628 | |||
629 | # Set all default hooks, defined in the IPython.hooks module. |
|
629 | # Set all default hooks, defined in the IPython.hooks module. | |
630 | import IPython.core.hooks |
|
630 | import IPython.core.hooks | |
631 | hooks = IPython.core.hooks |
|
631 | hooks = IPython.core.hooks | |
632 | for hook_name in hooks.__all__: |
|
632 | for hook_name in hooks.__all__: | |
633 | # default hooks have priority 100, i.e. low; user hooks should have |
|
633 | # default hooks have priority 100, i.e. low; user hooks should have | |
634 | # 0-100 priority |
|
634 | # 0-100 priority | |
635 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
635 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
636 | #print "bound hook",hook_name |
|
636 | #print "bound hook",hook_name | |
637 |
|
637 | |||
638 | # Flag to mark unconditional exit |
|
638 | # Flag to mark unconditional exit | |
639 | self.exit_now = False |
|
639 | self.exit_now = False | |
640 |
|
640 | |||
641 | self.usage_min = """\ |
|
641 | self.usage_min = """\ | |
642 | An enhanced console for Python. |
|
642 | An enhanced console for Python. | |
643 | Some of its features are: |
|
643 | Some of its features are: | |
644 | - Readline support if the readline library is present. |
|
644 | - Readline support if the readline library is present. | |
645 | - Tab completion in the local namespace. |
|
645 | - Tab completion in the local namespace. | |
646 | - Logging of input, see command-line options. |
|
646 | - Logging of input, see command-line options. | |
647 | - System shell escape via ! , eg !ls. |
|
647 | - System shell escape via ! , eg !ls. | |
648 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) |
|
648 | - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.) | |
649 | - Keeps track of locally defined variables via %who, %whos. |
|
649 | - Keeps track of locally defined variables via %who, %whos. | |
650 | - Show object information with a ? eg ?x or x? (use ?? for more info). |
|
650 | - Show object information with a ? eg ?x or x? (use ?? for more info). | |
651 | """ |
|
651 | """ | |
652 | if usage: self.usage = usage |
|
652 | if usage: self.usage = usage | |
653 | else: self.usage = self.usage_min |
|
653 | else: self.usage = self.usage_min | |
654 |
|
654 | |||
655 | # Storage |
|
655 | # Storage | |
656 | self.rc = rc # This will hold all configuration information |
|
656 | self.rc = rc # This will hold all configuration information | |
657 | self.pager = 'less' |
|
657 | self.pager = 'less' | |
658 | # temporary files used for various purposes. Deleted at exit. |
|
658 | # temporary files used for various purposes. Deleted at exit. | |
659 | self.tempfiles = [] |
|
659 | self.tempfiles = [] | |
660 |
|
660 | |||
661 | # Keep track of readline usage (later set by init_readline) |
|
661 | # Keep track of readline usage (later set by init_readline) | |
662 | self.has_readline = False |
|
662 | self.has_readline = False | |
663 |
|
663 | |||
664 | # template for logfile headers. It gets resolved at runtime by the |
|
664 | # template for logfile headers. It gets resolved at runtime by the | |
665 | # logstart method. |
|
665 | # logstart method. | |
666 | self.loghead_tpl = \ |
|
666 | self.loghead_tpl = \ | |
667 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** |
|
667 | """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE *** | |
668 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW |
|
668 | #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW | |
669 | #log# opts = %s |
|
669 | #log# opts = %s | |
670 | #log# args = %s |
|
670 | #log# args = %s | |
671 | #log# It is safe to make manual edits below here. |
|
671 | #log# It is safe to make manual edits below here. | |
672 | #log#----------------------------------------------------------------------- |
|
672 | #log#----------------------------------------------------------------------- | |
673 | """ |
|
673 | """ | |
674 | # for pushd/popd management |
|
674 | # for pushd/popd management | |
675 | try: |
|
675 | try: | |
676 | self.home_dir = get_home_dir() |
|
676 | self.home_dir = get_home_dir() | |
677 | except HomeDirError,msg: |
|
677 | except HomeDirError,msg: | |
678 | fatal(msg) |
|
678 | fatal(msg) | |
679 |
|
679 | |||
680 | self.dir_stack = [] |
|
680 | self.dir_stack = [] | |
681 |
|
681 | |||
682 | # Functions to call the underlying shell. |
|
682 | # Functions to call the underlying shell. | |
683 |
|
683 | |||
684 | # The first is similar to os.system, but it doesn't return a value, |
|
684 | # The first is similar to os.system, but it doesn't return a value, | |
685 | # and it allows interpolation of variables in the user's namespace. |
|
685 | # and it allows interpolation of variables in the user's namespace. | |
686 | self.system = lambda cmd: \ |
|
686 | self.system = lambda cmd: \ | |
687 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) |
|
687 | self.hooks.shell_hook(self.var_expand(cmd,depth=2)) | |
688 |
|
688 | |||
689 | # These are for getoutput and getoutputerror: |
|
689 | # These are for getoutput and getoutputerror: | |
690 | self.getoutput = lambda cmd: \ |
|
690 | self.getoutput = lambda cmd: \ | |
691 | getoutput(self.var_expand(cmd,depth=2), |
|
691 | getoutput(self.var_expand(cmd,depth=2), | |
692 | header=self.rc.system_header, |
|
692 | header=self.rc.system_header, | |
693 | verbose=self.rc.system_verbose) |
|
693 | verbose=self.rc.system_verbose) | |
694 |
|
694 | |||
695 | self.getoutputerror = lambda cmd: \ |
|
695 | self.getoutputerror = lambda cmd: \ | |
696 | getoutputerror(self.var_expand(cmd,depth=2), |
|
696 | getoutputerror(self.var_expand(cmd,depth=2), | |
697 | header=self.rc.system_header, |
|
697 | header=self.rc.system_header, | |
698 | verbose=self.rc.system_verbose) |
|
698 | verbose=self.rc.system_verbose) | |
699 |
|
699 | |||
700 |
|
700 | |||
701 | # keep track of where we started running (mainly for crash post-mortem) |
|
701 | # keep track of where we started running (mainly for crash post-mortem) | |
702 | self.starting_dir = os.getcwd() |
|
702 | self.starting_dir = os.getcwd() | |
703 |
|
703 | |||
704 | # Various switches which can be set |
|
704 | # Various switches which can be set | |
705 | self.CACHELENGTH = 5000 # this is cheap, it's just text |
|
705 | self.CACHELENGTH = 5000 # this is cheap, it's just text | |
706 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ |
|
706 | self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__ | |
707 | self.banner2 = banner2 |
|
707 | self.banner2 = banner2 | |
708 |
|
708 | |||
709 | # TraceBack handlers: |
|
709 | # TraceBack handlers: | |
710 |
|
710 | |||
711 | # Syntax error handler. |
|
711 | # Syntax error handler. | |
712 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
712 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') | |
713 |
|
713 | |||
714 | # The interactive one is initialized with an offset, meaning we always |
|
714 | # The interactive one is initialized with an offset, meaning we always | |
715 | # want to remove the topmost item in the traceback, which is our own |
|
715 | # want to remove the topmost item in the traceback, which is our own | |
716 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
716 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
717 |
self.InteractiveTB = ultra |
|
717 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
718 | color_scheme='NoColor', |
|
718 | color_scheme='NoColor', | |
719 | tb_offset = 1) |
|
719 | tb_offset = 1) | |
720 |
|
720 | |||
721 | # IPython itself shouldn't crash. This will produce a detailed |
|
721 | # IPython itself shouldn't crash. This will produce a detailed | |
722 | # post-mortem if it does. But we only install the crash handler for |
|
722 | # post-mortem if it does. But we only install the crash handler for | |
723 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
723 | # non-threaded shells, the threaded ones use a normal verbose reporter | |
724 | # and lose the crash handler. This is because exceptions in the main |
|
724 | # and lose the crash handler. This is because exceptions in the main | |
725 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
725 | # thread (such as in GUI code) propagate directly to sys.excepthook, | |
726 | # and there's no point in printing crash dumps for every user exception. |
|
726 | # and there's no point in printing crash dumps for every user exception. | |
727 | if self.isthreaded: |
|
727 | if self.isthreaded: | |
728 |
ipCrashHandler = ultra |
|
728 | ipCrashHandler = ultratb.FormattedTB() | |
729 | else: |
|
729 | else: | |
730 | from IPython.core import crashhandler |
|
730 | from IPython.core import crashhandler | |
731 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) |
|
731 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) | |
732 | self.set_crash_handler(ipCrashHandler) |
|
732 | self.set_crash_handler(ipCrashHandler) | |
733 |
|
733 | |||
734 | # and add any custom exception handlers the user may have specified |
|
734 | # and add any custom exception handlers the user may have specified | |
735 | self.set_custom_exc(*custom_exceptions) |
|
735 | self.set_custom_exc(*custom_exceptions) | |
736 |
|
736 | |||
737 | # indentation management |
|
737 | # indentation management | |
738 | self.autoindent = False |
|
738 | self.autoindent = False | |
739 | self.indent_current_nsp = 0 |
|
739 | self.indent_current_nsp = 0 | |
740 |
|
740 | |||
741 | # Make some aliases automatically |
|
741 | # Make some aliases automatically | |
742 | # Prepare list of shell aliases to auto-define |
|
742 | # Prepare list of shell aliases to auto-define | |
743 | if os.name == 'posix': |
|
743 | if os.name == 'posix': | |
744 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', |
|
744 | auto_alias = ('mkdir mkdir', 'rmdir rmdir', | |
745 | 'mv mv -i','rm rm -i','cp cp -i', |
|
745 | 'mv mv -i','rm rm -i','cp cp -i', | |
746 | 'cat cat','less less','clear clear', |
|
746 | 'cat cat','less less','clear clear', | |
747 | # a better ls |
|
747 | # a better ls | |
748 | 'ls ls -F', |
|
748 | 'ls ls -F', | |
749 | # long ls |
|
749 | # long ls | |
750 | 'll ls -lF') |
|
750 | 'll ls -lF') | |
751 | # Extra ls aliases with color, which need special treatment on BSD |
|
751 | # Extra ls aliases with color, which need special treatment on BSD | |
752 | # variants |
|
752 | # variants | |
753 | ls_extra = ( # color ls |
|
753 | ls_extra = ( # color ls | |
754 | 'lc ls -F -o --color', |
|
754 | 'lc ls -F -o --color', | |
755 | # ls normal files only |
|
755 | # ls normal files only | |
756 | 'lf ls -F -o --color %l | grep ^-', |
|
756 | 'lf ls -F -o --color %l | grep ^-', | |
757 | # ls symbolic links |
|
757 | # ls symbolic links | |
758 | 'lk ls -F -o --color %l | grep ^l', |
|
758 | 'lk ls -F -o --color %l | grep ^l', | |
759 | # directories or links to directories, |
|
759 | # directories or links to directories, | |
760 | 'ldir ls -F -o --color %l | grep /$', |
|
760 | 'ldir ls -F -o --color %l | grep /$', | |
761 | # things which are executable |
|
761 | # things which are executable | |
762 | 'lx ls -F -o --color %l | grep ^-..x', |
|
762 | 'lx ls -F -o --color %l | grep ^-..x', | |
763 | ) |
|
763 | ) | |
764 | # The BSDs don't ship GNU ls, so they don't understand the |
|
764 | # The BSDs don't ship GNU ls, so they don't understand the | |
765 | # --color switch out of the box |
|
765 | # --color switch out of the box | |
766 | if 'bsd' in sys.platform: |
|
766 | if 'bsd' in sys.platform: | |
767 | ls_extra = ( # ls normal files only |
|
767 | ls_extra = ( # ls normal files only | |
768 | 'lf ls -lF | grep ^-', |
|
768 | 'lf ls -lF | grep ^-', | |
769 | # ls symbolic links |
|
769 | # ls symbolic links | |
770 | 'lk ls -lF | grep ^l', |
|
770 | 'lk ls -lF | grep ^l', | |
771 | # directories or links to directories, |
|
771 | # directories or links to directories, | |
772 | 'ldir ls -lF | grep /$', |
|
772 | 'ldir ls -lF | grep /$', | |
773 | # things which are executable |
|
773 | # things which are executable | |
774 | 'lx ls -lF | grep ^-..x', |
|
774 | 'lx ls -lF | grep ^-..x', | |
775 | ) |
|
775 | ) | |
776 | auto_alias = auto_alias + ls_extra |
|
776 | auto_alias = auto_alias + ls_extra | |
777 | elif os.name in ['nt','dos']: |
|
777 | elif os.name in ['nt','dos']: | |
778 | auto_alias = ('ls dir /on', |
|
778 | auto_alias = ('ls dir /on', | |
779 | 'ddir dir /ad /on', 'ldir dir /ad /on', |
|
779 | 'ddir dir /ad /on', 'ldir dir /ad /on', | |
780 | 'mkdir mkdir','rmdir rmdir','echo echo', |
|
780 | 'mkdir mkdir','rmdir rmdir','echo echo', | |
781 | 'ren ren','cls cls','copy copy') |
|
781 | 'ren ren','cls cls','copy copy') | |
782 | else: |
|
782 | else: | |
783 | auto_alias = () |
|
783 | auto_alias = () | |
784 | self.auto_alias = [s.split(None,1) for s in auto_alias] |
|
784 | self.auto_alias = [s.split(None,1) for s in auto_alias] | |
785 |
|
785 | |||
786 | # Produce a public API instance |
|
786 | # Produce a public API instance | |
787 | self.api = ipapi.IPApi(self) |
|
787 | self.api = ipapi.IPApi(self) | |
788 |
|
788 | |||
789 | # Initialize all user-visible namespaces |
|
789 | # Initialize all user-visible namespaces | |
790 | self.init_namespaces() |
|
790 | self.init_namespaces() | |
791 |
|
791 | |||
792 | # Call the actual (public) initializer |
|
792 | # Call the actual (public) initializer | |
793 | self.init_auto_alias() |
|
793 | self.init_auto_alias() | |
794 |
|
794 | |||
795 | # track which builtins we add, so we can clean up later |
|
795 | # track which builtins we add, so we can clean up later | |
796 | self.builtins_added = {} |
|
796 | self.builtins_added = {} | |
797 | # This method will add the necessary builtins for operation, but |
|
797 | # This method will add the necessary builtins for operation, but | |
798 | # tracking what it did via the builtins_added dict. |
|
798 | # tracking what it did via the builtins_added dict. | |
799 |
|
799 | |||
800 | #TODO: remove this, redundant |
|
800 | #TODO: remove this, redundant | |
801 | self.add_builtins() |
|
801 | self.add_builtins() | |
802 | # end __init__ |
|
802 | # end __init__ | |
803 |
|
803 | |||
804 | def var_expand(self,cmd,depth=0): |
|
804 | def var_expand(self,cmd,depth=0): | |
805 | """Expand python variables in a string. |
|
805 | """Expand python variables in a string. | |
806 |
|
806 | |||
807 | The depth argument indicates how many frames above the caller should |
|
807 | The depth argument indicates how many frames above the caller should | |
808 | be walked to look for the local namespace where to expand variables. |
|
808 | be walked to look for the local namespace where to expand variables. | |
809 |
|
809 | |||
810 | The global namespace for expansion is always the user's interactive |
|
810 | The global namespace for expansion is always the user's interactive | |
811 | namespace. |
|
811 | namespace. | |
812 | """ |
|
812 | """ | |
813 |
|
813 | |||
814 | return str(ItplNS(cmd, |
|
814 | return str(ItplNS(cmd, | |
815 | self.user_ns, # globals |
|
815 | self.user_ns, # globals | |
816 | # Skip our own frame in searching for locals: |
|
816 | # Skip our own frame in searching for locals: | |
817 | sys._getframe(depth+1).f_locals # locals |
|
817 | sys._getframe(depth+1).f_locals # locals | |
818 | )) |
|
818 | )) | |
819 |
|
819 | |||
820 | def pre_config_initialization(self): |
|
820 | def pre_config_initialization(self): | |
821 | """Pre-configuration init method |
|
821 | """Pre-configuration init method | |
822 |
|
822 | |||
823 | This is called before the configuration files are processed to |
|
823 | This is called before the configuration files are processed to | |
824 | prepare the services the config files might need. |
|
824 | prepare the services the config files might need. | |
825 |
|
825 | |||
826 | self.rc already has reasonable default values at this point. |
|
826 | self.rc already has reasonable default values at this point. | |
827 | """ |
|
827 | """ | |
828 | rc = self.rc |
|
828 | rc = self.rc | |
829 | try: |
|
829 | try: | |
830 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") |
|
830 | self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db") | |
831 | except exceptions.UnicodeDecodeError: |
|
831 | except exceptions.UnicodeDecodeError: | |
832 | print "Your ipythondir can't be decoded to unicode!" |
|
832 | print "Your ipythondir can't be decoded to unicode!" | |
833 | print "Please set HOME environment variable to something that" |
|
833 | print "Please set HOME environment variable to something that" | |
834 | print r"only has ASCII characters, e.g. c:\home" |
|
834 | print r"only has ASCII characters, e.g. c:\home" | |
835 | print "Now it is",rc.ipythondir |
|
835 | print "Now it is",rc.ipythondir | |
836 | sys.exit() |
|
836 | sys.exit() | |
837 | self.shadowhist = IPython.core.history.ShadowHist(self.db) |
|
837 | self.shadowhist = IPython.core.history.ShadowHist(self.db) | |
838 |
|
838 | |||
839 | def post_config_initialization(self): |
|
839 | def post_config_initialization(self): | |
840 | """Post configuration init method |
|
840 | """Post configuration init method | |
841 |
|
841 | |||
842 | This is called after the configuration files have been processed to |
|
842 | This is called after the configuration files have been processed to | |
843 | 'finalize' the initialization.""" |
|
843 | 'finalize' the initialization.""" | |
844 |
|
844 | |||
845 | rc = self.rc |
|
845 | rc = self.rc | |
846 |
|
846 | |||
847 | # Object inspector |
|
847 | # Object inspector | |
848 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
848 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
849 | PyColorize.ANSICodeColors, |
|
849 | PyColorize.ANSICodeColors, | |
850 | 'NoColor', |
|
850 | 'NoColor', | |
851 | rc.object_info_string_level) |
|
851 | rc.object_info_string_level) | |
852 |
|
852 | |||
853 | self.rl_next_input = None |
|
853 | self.rl_next_input = None | |
854 | self.rl_do_indent = False |
|
854 | self.rl_do_indent = False | |
855 | # Load readline proper |
|
855 | # Load readline proper | |
856 | if rc.readline: |
|
856 | if rc.readline: | |
857 | self.init_readline() |
|
857 | self.init_readline() | |
858 |
|
858 | |||
859 | # local shortcut, this is used a LOT |
|
859 | # local shortcut, this is used a LOT | |
860 | self.log = self.logger.log |
|
860 | self.log = self.logger.log | |
861 |
|
861 | |||
862 | # Initialize cache, set in/out prompts and printing system |
|
862 | # Initialize cache, set in/out prompts and printing system | |
863 | self.outputcache = CachedOutput(self, |
|
863 | self.outputcache = CachedOutput(self, | |
864 | rc.cache_size, |
|
864 | rc.cache_size, | |
865 | rc.pprint, |
|
865 | rc.pprint, | |
866 | input_sep = rc.separate_in, |
|
866 | input_sep = rc.separate_in, | |
867 | output_sep = rc.separate_out, |
|
867 | output_sep = rc.separate_out, | |
868 | output_sep2 = rc.separate_out2, |
|
868 | output_sep2 = rc.separate_out2, | |
869 | ps1 = rc.prompt_in1, |
|
869 | ps1 = rc.prompt_in1, | |
870 | ps2 = rc.prompt_in2, |
|
870 | ps2 = rc.prompt_in2, | |
871 | ps_out = rc.prompt_out, |
|
871 | ps_out = rc.prompt_out, | |
872 | pad_left = rc.prompts_pad_left) |
|
872 | pad_left = rc.prompts_pad_left) | |
873 |
|
873 | |||
874 | # user may have over-ridden the default print hook: |
|
874 | # user may have over-ridden the default print hook: | |
875 | try: |
|
875 | try: | |
876 | self.outputcache.__class__.display = self.hooks.display |
|
876 | self.outputcache.__class__.display = self.hooks.display | |
877 | except AttributeError: |
|
877 | except AttributeError: | |
878 | pass |
|
878 | pass | |
879 |
|
879 | |||
880 | # I don't like assigning globally to sys, because it means when |
|
880 | # I don't like assigning globally to sys, because it means when | |
881 | # embedding instances, each embedded instance overrides the previous |
|
881 | # embedding instances, each embedded instance overrides the previous | |
882 | # choice. But sys.displayhook seems to be called internally by exec, |
|
882 | # choice. But sys.displayhook seems to be called internally by exec, | |
883 | # so I don't see a way around it. We first save the original and then |
|
883 | # so I don't see a way around it. We first save the original and then | |
884 | # overwrite it. |
|
884 | # overwrite it. | |
885 | self.sys_displayhook = sys.displayhook |
|
885 | self.sys_displayhook = sys.displayhook | |
886 | sys.displayhook = self.outputcache |
|
886 | sys.displayhook = self.outputcache | |
887 |
|
887 | |||
888 | # Do a proper resetting of doctest, including the necessary displayhook |
|
888 | # Do a proper resetting of doctest, including the necessary displayhook | |
889 | # monkeypatching |
|
889 | # monkeypatching | |
890 | try: |
|
890 | try: | |
891 | doctest_reload() |
|
891 | doctest_reload() | |
892 | except ImportError: |
|
892 | except ImportError: | |
893 | warn("doctest module does not exist.") |
|
893 | warn("doctest module does not exist.") | |
894 |
|
894 | |||
895 | # Set user colors (don't do it in the constructor above so that it |
|
895 | # Set user colors (don't do it in the constructor above so that it | |
896 | # doesn't crash if colors option is invalid) |
|
896 | # doesn't crash if colors option is invalid) | |
897 | self.magic_colors(rc.colors) |
|
897 | self.magic_colors(rc.colors) | |
898 |
|
898 | |||
899 | # Set calling of pdb on exceptions |
|
899 | # Set calling of pdb on exceptions | |
900 | self.call_pdb = rc.pdb |
|
900 | self.call_pdb = rc.pdb | |
901 |
|
901 | |||
902 | # Load user aliases |
|
902 | # Load user aliases | |
903 | for alias in rc.alias: |
|
903 | for alias in rc.alias: | |
904 | self.magic_alias(alias) |
|
904 | self.magic_alias(alias) | |
905 |
|
905 | |||
906 | self.hooks.late_startup_hook() |
|
906 | self.hooks.late_startup_hook() | |
907 |
|
907 | |||
908 | for cmd in self.rc.autoexec: |
|
908 | for cmd in self.rc.autoexec: | |
909 | #print "autoexec>",cmd #dbg |
|
909 | #print "autoexec>",cmd #dbg | |
910 | self.api.runlines(cmd) |
|
910 | self.api.runlines(cmd) | |
911 |
|
911 | |||
912 | batchrun = False |
|
912 | batchrun = False | |
913 | for batchfile in [path(arg) for arg in self.rc.args |
|
913 | for batchfile in [path(arg) for arg in self.rc.args | |
914 | if arg.lower().endswith('.ipy')]: |
|
914 | if arg.lower().endswith('.ipy')]: | |
915 | if not batchfile.isfile(): |
|
915 | if not batchfile.isfile(): | |
916 | print "No such batch file:", batchfile |
|
916 | print "No such batch file:", batchfile | |
917 | continue |
|
917 | continue | |
918 | self.api.runlines(batchfile.text()) |
|
918 | self.api.runlines(batchfile.text()) | |
919 | batchrun = True |
|
919 | batchrun = True | |
920 | # without -i option, exit after running the batch file |
|
920 | # without -i option, exit after running the batch file | |
921 | if batchrun and not self.rc.interact: |
|
921 | if batchrun and not self.rc.interact: | |
922 | self.ask_exit() |
|
922 | self.ask_exit() | |
923 |
|
923 | |||
924 | def init_namespaces(self): |
|
924 | def init_namespaces(self): | |
925 | """Initialize all user-visible namespaces to their minimum defaults. |
|
925 | """Initialize all user-visible namespaces to their minimum defaults. | |
926 |
|
926 | |||
927 | Certain history lists are also initialized here, as they effectively |
|
927 | Certain history lists are also initialized here, as they effectively | |
928 | act as user namespaces. |
|
928 | act as user namespaces. | |
929 |
|
929 | |||
930 | Note |
|
930 | Note | |
931 | ---- |
|
931 | ---- | |
932 | All data structures here are only filled in, they are NOT reset by this |
|
932 | All data structures here are only filled in, they are NOT reset by this | |
933 | method. If they were not empty before, data will simply be added to |
|
933 | method. If they were not empty before, data will simply be added to | |
934 | therm. |
|
934 | therm. | |
935 | """ |
|
935 | """ | |
936 | # The user namespace MUST have a pointer to the shell itself. |
|
936 | # The user namespace MUST have a pointer to the shell itself. | |
937 | self.user_ns[self.name] = self |
|
937 | self.user_ns[self.name] = self | |
938 |
|
938 | |||
939 | # Store the public api instance |
|
939 | # Store the public api instance | |
940 | self.user_ns['_ip'] = self.api |
|
940 | self.user_ns['_ip'] = self.api | |
941 |
|
941 | |||
942 | # make global variables for user access to the histories |
|
942 | # make global variables for user access to the histories | |
943 | self.user_ns['_ih'] = self.input_hist |
|
943 | self.user_ns['_ih'] = self.input_hist | |
944 | self.user_ns['_oh'] = self.output_hist |
|
944 | self.user_ns['_oh'] = self.output_hist | |
945 | self.user_ns['_dh'] = self.dir_hist |
|
945 | self.user_ns['_dh'] = self.dir_hist | |
946 |
|
946 | |||
947 | # user aliases to input and output histories |
|
947 | # user aliases to input and output histories | |
948 | self.user_ns['In'] = self.input_hist |
|
948 | self.user_ns['In'] = self.input_hist | |
949 | self.user_ns['Out'] = self.output_hist |
|
949 | self.user_ns['Out'] = self.output_hist | |
950 |
|
950 | |||
951 | self.user_ns['_sh'] = shadowns |
|
951 | self.user_ns['_sh'] = shadowns | |
952 |
|
952 | |||
953 | # Fill the history zero entry, user counter starts at 1 |
|
953 | # Fill the history zero entry, user counter starts at 1 | |
954 | self.input_hist.append('\n') |
|
954 | self.input_hist.append('\n') | |
955 | self.input_hist_raw.append('\n') |
|
955 | self.input_hist_raw.append('\n') | |
956 |
|
956 | |||
957 | def add_builtins(self): |
|
957 | def add_builtins(self): | |
958 | """Store ipython references into the builtin namespace. |
|
958 | """Store ipython references into the builtin namespace. | |
959 |
|
959 | |||
960 | Some parts of ipython operate via builtins injected here, which hold a |
|
960 | Some parts of ipython operate via builtins injected here, which hold a | |
961 | reference to IPython itself.""" |
|
961 | reference to IPython itself.""" | |
962 |
|
962 | |||
963 | # TODO: deprecate all of these, they are unsafe |
|
963 | # TODO: deprecate all of these, they are unsafe | |
964 | builtins_new = dict(__IPYTHON__ = self, |
|
964 | builtins_new = dict(__IPYTHON__ = self, | |
965 | ip_set_hook = self.set_hook, |
|
965 | ip_set_hook = self.set_hook, | |
966 | jobs = self.jobs, |
|
966 | jobs = self.jobs, | |
967 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), |
|
967 | ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'), | |
968 | ipalias = wrap_deprecated(self.ipalias), |
|
968 | ipalias = wrap_deprecated(self.ipalias), | |
969 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), |
|
969 | ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'), | |
970 | #_ip = self.api |
|
970 | #_ip = self.api | |
971 | ) |
|
971 | ) | |
972 | for biname,bival in builtins_new.items(): |
|
972 | for biname,bival in builtins_new.items(): | |
973 | try: |
|
973 | try: | |
974 | # store the orignal value so we can restore it |
|
974 | # store the orignal value so we can restore it | |
975 | self.builtins_added[biname] = __builtin__.__dict__[biname] |
|
975 | self.builtins_added[biname] = __builtin__.__dict__[biname] | |
976 | except KeyError: |
|
976 | except KeyError: | |
977 | # or mark that it wasn't defined, and we'll just delete it at |
|
977 | # or mark that it wasn't defined, and we'll just delete it at | |
978 | # cleanup |
|
978 | # cleanup | |
979 | self.builtins_added[biname] = Undefined |
|
979 | self.builtins_added[biname] = Undefined | |
980 | __builtin__.__dict__[biname] = bival |
|
980 | __builtin__.__dict__[biname] = bival | |
981 |
|
981 | |||
982 | # Keep in the builtins a flag for when IPython is active. We set it |
|
982 | # Keep in the builtins a flag for when IPython is active. We set it | |
983 | # with setdefault so that multiple nested IPythons don't clobber one |
|
983 | # with setdefault so that multiple nested IPythons don't clobber one | |
984 | # another. Each will increase its value by one upon being activated, |
|
984 | # another. Each will increase its value by one upon being activated, | |
985 | # which also gives us a way to determine the nesting level. |
|
985 | # which also gives us a way to determine the nesting level. | |
986 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) |
|
986 | __builtin__.__dict__.setdefault('__IPYTHON__active',0) | |
987 |
|
987 | |||
988 | def clean_builtins(self): |
|
988 | def clean_builtins(self): | |
989 | """Remove any builtins which might have been added by add_builtins, or |
|
989 | """Remove any builtins which might have been added by add_builtins, or | |
990 | restore overwritten ones to their previous values.""" |
|
990 | restore overwritten ones to their previous values.""" | |
991 | for biname,bival in self.builtins_added.items(): |
|
991 | for biname,bival in self.builtins_added.items(): | |
992 | if bival is Undefined: |
|
992 | if bival is Undefined: | |
993 | del __builtin__.__dict__[biname] |
|
993 | del __builtin__.__dict__[biname] | |
994 | else: |
|
994 | else: | |
995 | __builtin__.__dict__[biname] = bival |
|
995 | __builtin__.__dict__[biname] = bival | |
996 | self.builtins_added.clear() |
|
996 | self.builtins_added.clear() | |
997 |
|
997 | |||
998 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
998 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
999 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
999 | """set_hook(name,hook) -> sets an internal IPython hook. | |
1000 |
|
1000 | |||
1001 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1001 | IPython exposes some of its internal API as user-modifiable hooks. By | |
1002 | adding your function to one of these hooks, you can modify IPython's |
|
1002 | adding your function to one of these hooks, you can modify IPython's | |
1003 | behavior to call at runtime your own routines.""" |
|
1003 | behavior to call at runtime your own routines.""" | |
1004 |
|
1004 | |||
1005 | # At some point in the future, this should validate the hook before it |
|
1005 | # At some point in the future, this should validate the hook before it | |
1006 | # accepts it. Probably at least check that the hook takes the number |
|
1006 | # accepts it. Probably at least check that the hook takes the number | |
1007 | # of args it's supposed to. |
|
1007 | # of args it's supposed to. | |
1008 |
|
1008 | |||
1009 | f = new.instancemethod(hook,self,self.__class__) |
|
1009 | f = new.instancemethod(hook,self,self.__class__) | |
1010 |
|
1010 | |||
1011 | # check if the hook is for strdispatcher first |
|
1011 | # check if the hook is for strdispatcher first | |
1012 | if str_key is not None: |
|
1012 | if str_key is not None: | |
1013 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1013 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1014 | sdp.add_s(str_key, f, priority ) |
|
1014 | sdp.add_s(str_key, f, priority ) | |
1015 | self.strdispatchers[name] = sdp |
|
1015 | self.strdispatchers[name] = sdp | |
1016 | return |
|
1016 | return | |
1017 | if re_key is not None: |
|
1017 | if re_key is not None: | |
1018 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1018 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
1019 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1019 | sdp.add_re(re.compile(re_key), f, priority ) | |
1020 | self.strdispatchers[name] = sdp |
|
1020 | self.strdispatchers[name] = sdp | |
1021 | return |
|
1021 | return | |
1022 |
|
1022 | |||
1023 | dp = getattr(self.hooks, name, None) |
|
1023 | dp = getattr(self.hooks, name, None) | |
1024 | if name not in IPython.core.hooks.__all__: |
|
1024 | if name not in IPython.core.hooks.__all__: | |
1025 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) |
|
1025 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) | |
1026 | if not dp: |
|
1026 | if not dp: | |
1027 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1027 | dp = IPython.core.hooks.CommandChainDispatcher() | |
1028 |
|
1028 | |||
1029 | try: |
|
1029 | try: | |
1030 | dp.add(f,priority) |
|
1030 | dp.add(f,priority) | |
1031 | except AttributeError: |
|
1031 | except AttributeError: | |
1032 | # it was not commandchain, plain old func - replace |
|
1032 | # it was not commandchain, plain old func - replace | |
1033 | dp = f |
|
1033 | dp = f | |
1034 |
|
1034 | |||
1035 | setattr(self.hooks,name, dp) |
|
1035 | setattr(self.hooks,name, dp) | |
1036 |
|
1036 | |||
1037 |
|
1037 | |||
1038 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) |
|
1038 | #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__)) | |
1039 |
|
1039 | |||
1040 | def set_crash_handler(self,crashHandler): |
|
1040 | def set_crash_handler(self,crashHandler): | |
1041 | """Set the IPython crash handler. |
|
1041 | """Set the IPython crash handler. | |
1042 |
|
1042 | |||
1043 | This must be a callable with a signature suitable for use as |
|
1043 | This must be a callable with a signature suitable for use as | |
1044 | sys.excepthook.""" |
|
1044 | sys.excepthook.""" | |
1045 |
|
1045 | |||
1046 | # Install the given crash handler as the Python exception hook |
|
1046 | # Install the given crash handler as the Python exception hook | |
1047 | sys.excepthook = crashHandler |
|
1047 | sys.excepthook = crashHandler | |
1048 |
|
1048 | |||
1049 | # The instance will store a pointer to this, so that runtime code |
|
1049 | # The instance will store a pointer to this, so that runtime code | |
1050 | # (such as magics) can access it. This is because during the |
|
1050 | # (such as magics) can access it. This is because during the | |
1051 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
1051 | # read-eval loop, it gets temporarily overwritten (to deal with GUI | |
1052 | # frameworks). |
|
1052 | # frameworks). | |
1053 | self.sys_excepthook = sys.excepthook |
|
1053 | self.sys_excepthook = sys.excepthook | |
1054 |
|
1054 | |||
1055 |
|
1055 | |||
1056 | def set_custom_exc(self,exc_tuple,handler): |
|
1056 | def set_custom_exc(self,exc_tuple,handler): | |
1057 | """set_custom_exc(exc_tuple,handler) |
|
1057 | """set_custom_exc(exc_tuple,handler) | |
1058 |
|
1058 | |||
1059 | Set a custom exception handler, which will be called if any of the |
|
1059 | Set a custom exception handler, which will be called if any of the | |
1060 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1060 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1061 | runcode() method. |
|
1061 | runcode() method. | |
1062 |
|
1062 | |||
1063 | Inputs: |
|
1063 | Inputs: | |
1064 |
|
1064 | |||
1065 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1065 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
1066 | handler for. It is very important that you use a tuple, and NOT A |
|
1066 | handler for. It is very important that you use a tuple, and NOT A | |
1067 | LIST here, because of the way Python's except statement works. If |
|
1067 | LIST here, because of the way Python's except statement works. If | |
1068 | you only want to trap a single exception, use a singleton tuple: |
|
1068 | you only want to trap a single exception, use a singleton tuple: | |
1069 |
|
1069 | |||
1070 | exc_tuple == (MyCustomException,) |
|
1070 | exc_tuple == (MyCustomException,) | |
1071 |
|
1071 | |||
1072 | - handler: this must be defined as a function with the following |
|
1072 | - handler: this must be defined as a function with the following | |
1073 | basic interface: def my_handler(self,etype,value,tb). |
|
1073 | basic interface: def my_handler(self,etype,value,tb). | |
1074 |
|
1074 | |||
1075 | This will be made into an instance method (via new.instancemethod) |
|
1075 | This will be made into an instance method (via new.instancemethod) | |
1076 | of IPython itself, and it will be called if any of the exceptions |
|
1076 | of IPython itself, and it will be called if any of the exceptions | |
1077 | listed in the exc_tuple are caught. If the handler is None, an |
|
1077 | listed in the exc_tuple are caught. If the handler is None, an | |
1078 | internal basic one is used, which just prints basic info. |
|
1078 | internal basic one is used, which just prints basic info. | |
1079 |
|
1079 | |||
1080 | WARNING: by putting in your own exception handler into IPython's main |
|
1080 | WARNING: by putting in your own exception handler into IPython's main | |
1081 | execution loop, you run a very good chance of nasty crashes. This |
|
1081 | execution loop, you run a very good chance of nasty crashes. This | |
1082 | facility should only be used if you really know what you are doing.""" |
|
1082 | facility should only be used if you really know what you are doing.""" | |
1083 |
|
1083 | |||
1084 | assert type(exc_tuple)==type(()) , \ |
|
1084 | assert type(exc_tuple)==type(()) , \ | |
1085 | "The custom exceptions must be given AS A TUPLE." |
|
1085 | "The custom exceptions must be given AS A TUPLE." | |
1086 |
|
1086 | |||
1087 | def dummy_handler(self,etype,value,tb): |
|
1087 | def dummy_handler(self,etype,value,tb): | |
1088 | print '*** Simple custom exception handler ***' |
|
1088 | print '*** Simple custom exception handler ***' | |
1089 | print 'Exception type :',etype |
|
1089 | print 'Exception type :',etype | |
1090 | print 'Exception value:',value |
|
1090 | print 'Exception value:',value | |
1091 | print 'Traceback :',tb |
|
1091 | print 'Traceback :',tb | |
1092 | print 'Source code :','\n'.join(self.buffer) |
|
1092 | print 'Source code :','\n'.join(self.buffer) | |
1093 |
|
1093 | |||
1094 | if handler is None: handler = dummy_handler |
|
1094 | if handler is None: handler = dummy_handler | |
1095 |
|
1095 | |||
1096 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
1096 | self.CustomTB = new.instancemethod(handler,self,self.__class__) | |
1097 | self.custom_exceptions = exc_tuple |
|
1097 | self.custom_exceptions = exc_tuple | |
1098 |
|
1098 | |||
1099 | def set_custom_completer(self,completer,pos=0): |
|
1099 | def set_custom_completer(self,completer,pos=0): | |
1100 | """set_custom_completer(completer,pos=0) |
|
1100 | """set_custom_completer(completer,pos=0) | |
1101 |
|
1101 | |||
1102 | Adds a new custom completer function. |
|
1102 | Adds a new custom completer function. | |
1103 |
|
1103 | |||
1104 | The position argument (defaults to 0) is the index in the completers |
|
1104 | The position argument (defaults to 0) is the index in the completers | |
1105 | list where you want the completer to be inserted.""" |
|
1105 | list where you want the completer to be inserted.""" | |
1106 |
|
1106 | |||
1107 | newcomp = new.instancemethod(completer,self.Completer, |
|
1107 | newcomp = new.instancemethod(completer,self.Completer, | |
1108 | self.Completer.__class__) |
|
1108 | self.Completer.__class__) | |
1109 | self.Completer.matchers.insert(pos,newcomp) |
|
1109 | self.Completer.matchers.insert(pos,newcomp) | |
1110 |
|
1110 | |||
1111 | def set_completer(self): |
|
1111 | def set_completer(self): | |
1112 | """reset readline's completer to be our own.""" |
|
1112 | """reset readline's completer to be our own.""" | |
1113 | self.readline.set_completer(self.Completer.complete) |
|
1113 | self.readline.set_completer(self.Completer.complete) | |
1114 |
|
1114 | |||
1115 | def _get_call_pdb(self): |
|
1115 | def _get_call_pdb(self): | |
1116 | return self._call_pdb |
|
1116 | return self._call_pdb | |
1117 |
|
1117 | |||
1118 | def _set_call_pdb(self,val): |
|
1118 | def _set_call_pdb(self,val): | |
1119 |
|
1119 | |||
1120 | if val not in (0,1,False,True): |
|
1120 | if val not in (0,1,False,True): | |
1121 | raise ValueError,'new call_pdb value must be boolean' |
|
1121 | raise ValueError,'new call_pdb value must be boolean' | |
1122 |
|
1122 | |||
1123 | # store value in instance |
|
1123 | # store value in instance | |
1124 | self._call_pdb = val |
|
1124 | self._call_pdb = val | |
1125 |
|
1125 | |||
1126 | # notify the actual exception handlers |
|
1126 | # notify the actual exception handlers | |
1127 | self.InteractiveTB.call_pdb = val |
|
1127 | self.InteractiveTB.call_pdb = val | |
1128 | if self.isthreaded: |
|
1128 | if self.isthreaded: | |
1129 | try: |
|
1129 | try: | |
1130 | self.sys_excepthook.call_pdb = val |
|
1130 | self.sys_excepthook.call_pdb = val | |
1131 | except: |
|
1131 | except: | |
1132 | warn('Failed to activate pdb for threaded exception handler') |
|
1132 | warn('Failed to activate pdb for threaded exception handler') | |
1133 |
|
1133 | |||
1134 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1134 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
1135 | 'Control auto-activation of pdb at exceptions') |
|
1135 | 'Control auto-activation of pdb at exceptions') | |
1136 |
|
1136 | |||
1137 | # These special functions get installed in the builtin namespace, to |
|
1137 | # These special functions get installed in the builtin namespace, to | |
1138 | # provide programmatic (pure python) access to magics, aliases and system |
|
1138 | # provide programmatic (pure python) access to magics, aliases and system | |
1139 | # calls. This is important for logging, user scripting, and more. |
|
1139 | # calls. This is important for logging, user scripting, and more. | |
1140 |
|
1140 | |||
1141 | # We are basically exposing, via normal python functions, the three |
|
1141 | # We are basically exposing, via normal python functions, the three | |
1142 | # mechanisms in which ipython offers special call modes (magics for |
|
1142 | # mechanisms in which ipython offers special call modes (magics for | |
1143 | # internal control, aliases for direct system access via pre-selected |
|
1143 | # internal control, aliases for direct system access via pre-selected | |
1144 | # names, and !cmd for calling arbitrary system commands). |
|
1144 | # names, and !cmd for calling arbitrary system commands). | |
1145 |
|
1145 | |||
1146 | def ipmagic(self,arg_s): |
|
1146 | def ipmagic(self,arg_s): | |
1147 | """Call a magic function by name. |
|
1147 | """Call a magic function by name. | |
1148 |
|
1148 | |||
1149 | Input: a string containing the name of the magic function to call and any |
|
1149 | Input: a string containing the name of the magic function to call and any | |
1150 | additional arguments to be passed to the magic. |
|
1150 | additional arguments to be passed to the magic. | |
1151 |
|
1151 | |||
1152 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython |
|
1152 | ipmagic('name -opt foo bar') is equivalent to typing at the ipython | |
1153 | prompt: |
|
1153 | prompt: | |
1154 |
|
1154 | |||
1155 | In[1]: %name -opt foo bar |
|
1155 | In[1]: %name -opt foo bar | |
1156 |
|
1156 | |||
1157 | To call a magic without arguments, simply use ipmagic('name'). |
|
1157 | To call a magic without arguments, simply use ipmagic('name'). | |
1158 |
|
1158 | |||
1159 | This provides a proper Python function to call IPython's magics in any |
|
1159 | This provides a proper Python function to call IPython's magics in any | |
1160 | valid Python code you can type at the interpreter, including loops and |
|
1160 | valid Python code you can type at the interpreter, including loops and | |
1161 | compound statements. It is added by IPython to the Python builtin |
|
1161 | compound statements. It is added by IPython to the Python builtin | |
1162 | namespace upon initialization.""" |
|
1162 | namespace upon initialization.""" | |
1163 |
|
1163 | |||
1164 | args = arg_s.split(' ',1) |
|
1164 | args = arg_s.split(' ',1) | |
1165 | magic_name = args[0] |
|
1165 | magic_name = args[0] | |
1166 | magic_name = magic_name.lstrip(self.ESC_MAGIC) |
|
1166 | magic_name = magic_name.lstrip(self.ESC_MAGIC) | |
1167 |
|
1167 | |||
1168 | try: |
|
1168 | try: | |
1169 | magic_args = args[1] |
|
1169 | magic_args = args[1] | |
1170 | except IndexError: |
|
1170 | except IndexError: | |
1171 | magic_args = '' |
|
1171 | magic_args = '' | |
1172 | fn = getattr(self,'magic_'+magic_name,None) |
|
1172 | fn = getattr(self,'magic_'+magic_name,None) | |
1173 | if fn is None: |
|
1173 | if fn is None: | |
1174 | error("Magic function `%s` not found." % magic_name) |
|
1174 | error("Magic function `%s` not found." % magic_name) | |
1175 | else: |
|
1175 | else: | |
1176 | magic_args = self.var_expand(magic_args,1) |
|
1176 | magic_args = self.var_expand(magic_args,1) | |
1177 | return fn(magic_args) |
|
1177 | return fn(magic_args) | |
1178 |
|
1178 | |||
1179 | def ipalias(self,arg_s): |
|
1179 | def ipalias(self,arg_s): | |
1180 | """Call an alias by name. |
|
1180 | """Call an alias by name. | |
1181 |
|
1181 | |||
1182 | Input: a string containing the name of the alias to call and any |
|
1182 | Input: a string containing the name of the alias to call and any | |
1183 | additional arguments to be passed to the magic. |
|
1183 | additional arguments to be passed to the magic. | |
1184 |
|
1184 | |||
1185 | ipalias('name -opt foo bar') is equivalent to typing at the ipython |
|
1185 | ipalias('name -opt foo bar') is equivalent to typing at the ipython | |
1186 | prompt: |
|
1186 | prompt: | |
1187 |
|
1187 | |||
1188 | In[1]: name -opt foo bar |
|
1188 | In[1]: name -opt foo bar | |
1189 |
|
1189 | |||
1190 | To call an alias without arguments, simply use ipalias('name'). |
|
1190 | To call an alias without arguments, simply use ipalias('name'). | |
1191 |
|
1191 | |||
1192 | This provides a proper Python function to call IPython's aliases in any |
|
1192 | This provides a proper Python function to call IPython's aliases in any | |
1193 | valid Python code you can type at the interpreter, including loops and |
|
1193 | valid Python code you can type at the interpreter, including loops and | |
1194 | compound statements. It is added by IPython to the Python builtin |
|
1194 | compound statements. It is added by IPython to the Python builtin | |
1195 | namespace upon initialization.""" |
|
1195 | namespace upon initialization.""" | |
1196 |
|
1196 | |||
1197 | args = arg_s.split(' ',1) |
|
1197 | args = arg_s.split(' ',1) | |
1198 | alias_name = args[0] |
|
1198 | alias_name = args[0] | |
1199 | try: |
|
1199 | try: | |
1200 | alias_args = args[1] |
|
1200 | alias_args = args[1] | |
1201 | except IndexError: |
|
1201 | except IndexError: | |
1202 | alias_args = '' |
|
1202 | alias_args = '' | |
1203 | if alias_name in self.alias_table: |
|
1203 | if alias_name in self.alias_table: | |
1204 | self.call_alias(alias_name,alias_args) |
|
1204 | self.call_alias(alias_name,alias_args) | |
1205 | else: |
|
1205 | else: | |
1206 | error("Alias `%s` not found." % alias_name) |
|
1206 | error("Alias `%s` not found." % alias_name) | |
1207 |
|
1207 | |||
1208 | def ipsystem(self,arg_s): |
|
1208 | def ipsystem(self,arg_s): | |
1209 | """Make a system call, using IPython.""" |
|
1209 | """Make a system call, using IPython.""" | |
1210 |
|
1210 | |||
1211 | self.system(arg_s) |
|
1211 | self.system(arg_s) | |
1212 |
|
1212 | |||
1213 | def complete(self,text): |
|
1213 | def complete(self,text): | |
1214 | """Return a sorted list of all possible completions on text. |
|
1214 | """Return a sorted list of all possible completions on text. | |
1215 |
|
1215 | |||
1216 | Inputs: |
|
1216 | Inputs: | |
1217 |
|
1217 | |||
1218 | - text: a string of text to be completed on. |
|
1218 | - text: a string of text to be completed on. | |
1219 |
|
1219 | |||
1220 | This is a wrapper around the completion mechanism, similar to what |
|
1220 | This is a wrapper around the completion mechanism, similar to what | |
1221 | readline does at the command line when the TAB key is hit. By |
|
1221 | readline does at the command line when the TAB key is hit. By | |
1222 | exposing it as a method, it can be used by other non-readline |
|
1222 | exposing it as a method, it can be used by other non-readline | |
1223 | environments (such as GUIs) for text completion. |
|
1223 | environments (such as GUIs) for text completion. | |
1224 |
|
1224 | |||
1225 | Simple usage example: |
|
1225 | Simple usage example: | |
1226 |
|
1226 | |||
1227 | In [7]: x = 'hello' |
|
1227 | In [7]: x = 'hello' | |
1228 |
|
1228 | |||
1229 | In [8]: x |
|
1229 | In [8]: x | |
1230 | Out[8]: 'hello' |
|
1230 | Out[8]: 'hello' | |
1231 |
|
1231 | |||
1232 | In [9]: print x |
|
1232 | In [9]: print x | |
1233 | hello |
|
1233 | hello | |
1234 |
|
1234 | |||
1235 | In [10]: _ip.IP.complete('x.l') |
|
1235 | In [10]: _ip.IP.complete('x.l') | |
1236 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1236 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] | |
1237 | """ |
|
1237 | """ | |
1238 |
|
1238 | |||
1239 | complete = self.Completer.complete |
|
1239 | complete = self.Completer.complete | |
1240 | state = 0 |
|
1240 | state = 0 | |
1241 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1241 | # use a dict so we get unique keys, since ipyhton's multiple | |
1242 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1242 | # completers can return duplicates. When we make 2.4 a requirement, | |
1243 | # start using sets instead, which are faster. |
|
1243 | # start using sets instead, which are faster. | |
1244 | comps = {} |
|
1244 | comps = {} | |
1245 | while True: |
|
1245 | while True: | |
1246 | newcomp = complete(text,state,line_buffer=text) |
|
1246 | newcomp = complete(text,state,line_buffer=text) | |
1247 | if newcomp is None: |
|
1247 | if newcomp is None: | |
1248 | break |
|
1248 | break | |
1249 | comps[newcomp] = 1 |
|
1249 | comps[newcomp] = 1 | |
1250 | state += 1 |
|
1250 | state += 1 | |
1251 | outcomps = comps.keys() |
|
1251 | outcomps = comps.keys() | |
1252 | outcomps.sort() |
|
1252 | outcomps.sort() | |
1253 | #print "T:",text,"OC:",outcomps # dbg |
|
1253 | #print "T:",text,"OC:",outcomps # dbg | |
1254 | #print "vars:",self.user_ns.keys() |
|
1254 | #print "vars:",self.user_ns.keys() | |
1255 | return outcomps |
|
1255 | return outcomps | |
1256 |
|
1256 | |||
1257 | def set_completer_frame(self, frame=None): |
|
1257 | def set_completer_frame(self, frame=None): | |
1258 | if frame: |
|
1258 | if frame: | |
1259 | self.Completer.namespace = frame.f_locals |
|
1259 | self.Completer.namespace = frame.f_locals | |
1260 | self.Completer.global_namespace = frame.f_globals |
|
1260 | self.Completer.global_namespace = frame.f_globals | |
1261 | else: |
|
1261 | else: | |
1262 | self.Completer.namespace = self.user_ns |
|
1262 | self.Completer.namespace = self.user_ns | |
1263 | self.Completer.global_namespace = self.user_global_ns |
|
1263 | self.Completer.global_namespace = self.user_global_ns | |
1264 |
|
1264 | |||
1265 | def init_auto_alias(self): |
|
1265 | def init_auto_alias(self): | |
1266 | """Define some aliases automatically. |
|
1266 | """Define some aliases automatically. | |
1267 |
|
1267 | |||
1268 | These are ALL parameter-less aliases""" |
|
1268 | These are ALL parameter-less aliases""" | |
1269 |
|
1269 | |||
1270 | for alias,cmd in self.auto_alias: |
|
1270 | for alias,cmd in self.auto_alias: | |
1271 | self.getapi().defalias(alias,cmd) |
|
1271 | self.getapi().defalias(alias,cmd) | |
1272 |
|
1272 | |||
1273 |
|
1273 | |||
1274 | def alias_table_validate(self,verbose=0): |
|
1274 | def alias_table_validate(self,verbose=0): | |
1275 | """Update information about the alias table. |
|
1275 | """Update information about the alias table. | |
1276 |
|
1276 | |||
1277 | In particular, make sure no Python keywords/builtins are in it.""" |
|
1277 | In particular, make sure no Python keywords/builtins are in it.""" | |
1278 |
|
1278 | |||
1279 | no_alias = self.no_alias |
|
1279 | no_alias = self.no_alias | |
1280 | for k in self.alias_table.keys(): |
|
1280 | for k in self.alias_table.keys(): | |
1281 | if k in no_alias: |
|
1281 | if k in no_alias: | |
1282 | del self.alias_table[k] |
|
1282 | del self.alias_table[k] | |
1283 | if verbose: |
|
1283 | if verbose: | |
1284 | print ("Deleting alias <%s>, it's a Python " |
|
1284 | print ("Deleting alias <%s>, it's a Python " | |
1285 | "keyword or builtin." % k) |
|
1285 | "keyword or builtin." % k) | |
1286 |
|
1286 | |||
1287 | def set_autoindent(self,value=None): |
|
1287 | def set_autoindent(self,value=None): | |
1288 | """Set the autoindent flag, checking for readline support. |
|
1288 | """Set the autoindent flag, checking for readline support. | |
1289 |
|
1289 | |||
1290 | If called with no arguments, it acts as a toggle.""" |
|
1290 | If called with no arguments, it acts as a toggle.""" | |
1291 |
|
1291 | |||
1292 | if not self.has_readline: |
|
1292 | if not self.has_readline: | |
1293 | if os.name == 'posix': |
|
1293 | if os.name == 'posix': | |
1294 | warn("The auto-indent feature requires the readline library") |
|
1294 | warn("The auto-indent feature requires the readline library") | |
1295 | self.autoindent = 0 |
|
1295 | self.autoindent = 0 | |
1296 | return |
|
1296 | return | |
1297 | if value is None: |
|
1297 | if value is None: | |
1298 | self.autoindent = not self.autoindent |
|
1298 | self.autoindent = not self.autoindent | |
1299 | else: |
|
1299 | else: | |
1300 | self.autoindent = value |
|
1300 | self.autoindent = value | |
1301 |
|
1301 | |||
1302 | def rc_set_toggle(self,rc_field,value=None): |
|
1302 | def rc_set_toggle(self,rc_field,value=None): | |
1303 | """Set or toggle a field in IPython's rc config. structure. |
|
1303 | """Set or toggle a field in IPython's rc config. structure. | |
1304 |
|
1304 | |||
1305 | If called with no arguments, it acts as a toggle. |
|
1305 | If called with no arguments, it acts as a toggle. | |
1306 |
|
1306 | |||
1307 | If called with a non-existent field, the resulting AttributeError |
|
1307 | If called with a non-existent field, the resulting AttributeError | |
1308 | exception will propagate out.""" |
|
1308 | exception will propagate out.""" | |
1309 |
|
1309 | |||
1310 | rc_val = getattr(self.rc,rc_field) |
|
1310 | rc_val = getattr(self.rc,rc_field) | |
1311 | if value is None: |
|
1311 | if value is None: | |
1312 | value = not rc_val |
|
1312 | value = not rc_val | |
1313 | setattr(self.rc,rc_field,value) |
|
1313 | setattr(self.rc,rc_field,value) | |
1314 |
|
1314 | |||
1315 | def user_setup(self,ipythondir,rc_suffix,mode='install'): |
|
1315 | def user_setup(self,ipythondir,rc_suffix,mode='install'): | |
1316 | """Install the user configuration directory. |
|
1316 | """Install the user configuration directory. | |
1317 |
|
1317 | |||
1318 | Note |
|
1318 | Note | |
1319 | ---- |
|
1319 | ---- | |
1320 | DEPRECATED: use the top-level user_setup() function instead. |
|
1320 | DEPRECATED: use the top-level user_setup() function instead. | |
1321 | """ |
|
1321 | """ | |
1322 | return user_setup(ipythondir,rc_suffix,mode) |
|
1322 | return user_setup(ipythondir,rc_suffix,mode) | |
1323 |
|
1323 | |||
1324 | def atexit_operations(self): |
|
1324 | def atexit_operations(self): | |
1325 | """This will be executed at the time of exit. |
|
1325 | """This will be executed at the time of exit. | |
1326 |
|
1326 | |||
1327 | Saving of persistent data should be performed here. """ |
|
1327 | Saving of persistent data should be performed here. """ | |
1328 |
|
1328 | |||
1329 | #print '*** IPython exit cleanup ***' # dbg |
|
1329 | #print '*** IPython exit cleanup ***' # dbg | |
1330 | # input history |
|
1330 | # input history | |
1331 | self.savehist() |
|
1331 | self.savehist() | |
1332 |
|
1332 | |||
1333 | # Cleanup all tempfiles left around |
|
1333 | # Cleanup all tempfiles left around | |
1334 | for tfile in self.tempfiles: |
|
1334 | for tfile in self.tempfiles: | |
1335 | try: |
|
1335 | try: | |
1336 | os.unlink(tfile) |
|
1336 | os.unlink(tfile) | |
1337 | except OSError: |
|
1337 | except OSError: | |
1338 | pass |
|
1338 | pass | |
1339 |
|
1339 | |||
1340 | # Clear all user namespaces to release all references cleanly. |
|
1340 | # Clear all user namespaces to release all references cleanly. | |
1341 | self.reset() |
|
1341 | self.reset() | |
1342 |
|
1342 | |||
1343 | # Run user hooks |
|
1343 | # Run user hooks | |
1344 | self.hooks.shutdown_hook() |
|
1344 | self.hooks.shutdown_hook() | |
1345 |
|
1345 | |||
1346 | def reset(self): |
|
1346 | def reset(self): | |
1347 | """Clear all internal namespaces. |
|
1347 | """Clear all internal namespaces. | |
1348 |
|
1348 | |||
1349 | Note that this is much more aggressive than %reset, since it clears |
|
1349 | Note that this is much more aggressive than %reset, since it clears | |
1350 | fully all namespaces, as well as all input/output lists. |
|
1350 | fully all namespaces, as well as all input/output lists. | |
1351 | """ |
|
1351 | """ | |
1352 | for ns in self.ns_refs_table: |
|
1352 | for ns in self.ns_refs_table: | |
1353 | ns.clear() |
|
1353 | ns.clear() | |
1354 |
|
1354 | |||
1355 | # Clear input and output histories |
|
1355 | # Clear input and output histories | |
1356 | self.input_hist[:] = [] |
|
1356 | self.input_hist[:] = [] | |
1357 | self.input_hist_raw[:] = [] |
|
1357 | self.input_hist_raw[:] = [] | |
1358 | self.output_hist.clear() |
|
1358 | self.output_hist.clear() | |
1359 | # Restore the user namespaces to minimal usability |
|
1359 | # Restore the user namespaces to minimal usability | |
1360 | self.init_namespaces() |
|
1360 | self.init_namespaces() | |
1361 |
|
1361 | |||
1362 | def savehist(self): |
|
1362 | def savehist(self): | |
1363 | """Save input history to a file (via readline library).""" |
|
1363 | """Save input history to a file (via readline library).""" | |
1364 |
|
1364 | |||
1365 | if not self.has_readline: |
|
1365 | if not self.has_readline: | |
1366 | return |
|
1366 | return | |
1367 |
|
1367 | |||
1368 | try: |
|
1368 | try: | |
1369 | self.readline.write_history_file(self.histfile) |
|
1369 | self.readline.write_history_file(self.histfile) | |
1370 | except: |
|
1370 | except: | |
1371 | print 'Unable to save IPython command history to file: ' + \ |
|
1371 | print 'Unable to save IPython command history to file: ' + \ | |
1372 | `self.histfile` |
|
1372 | `self.histfile` | |
1373 |
|
1373 | |||
1374 | def reloadhist(self): |
|
1374 | def reloadhist(self): | |
1375 | """Reload the input history from disk file.""" |
|
1375 | """Reload the input history from disk file.""" | |
1376 |
|
1376 | |||
1377 | if self.has_readline: |
|
1377 | if self.has_readline: | |
1378 | try: |
|
1378 | try: | |
1379 | self.readline.clear_history() |
|
1379 | self.readline.clear_history() | |
1380 | self.readline.read_history_file(self.shell.histfile) |
|
1380 | self.readline.read_history_file(self.shell.histfile) | |
1381 | except AttributeError: |
|
1381 | except AttributeError: | |
1382 | pass |
|
1382 | pass | |
1383 |
|
1383 | |||
1384 |
|
1384 | |||
1385 | def history_saving_wrapper(self, func): |
|
1385 | def history_saving_wrapper(self, func): | |
1386 | """ Wrap func for readline history saving |
|
1386 | """ Wrap func for readline history saving | |
1387 |
|
1387 | |||
1388 | Convert func into callable that saves & restores |
|
1388 | Convert func into callable that saves & restores | |
1389 | history around the call """ |
|
1389 | history around the call """ | |
1390 |
|
1390 | |||
1391 | if not self.has_readline: |
|
1391 | if not self.has_readline: | |
1392 | return func |
|
1392 | return func | |
1393 |
|
1393 | |||
1394 | def wrapper(): |
|
1394 | def wrapper(): | |
1395 | self.savehist() |
|
1395 | self.savehist() | |
1396 | try: |
|
1396 | try: | |
1397 | func() |
|
1397 | func() | |
1398 | finally: |
|
1398 | finally: | |
1399 | readline.read_history_file(self.histfile) |
|
1399 | readline.read_history_file(self.histfile) | |
1400 | return wrapper |
|
1400 | return wrapper | |
1401 |
|
1401 | |||
1402 | def pre_readline(self): |
|
1402 | def pre_readline(self): | |
1403 | """readline hook to be used at the start of each line. |
|
1403 | """readline hook to be used at the start of each line. | |
1404 |
|
1404 | |||
1405 | Currently it handles auto-indent only.""" |
|
1405 | Currently it handles auto-indent only.""" | |
1406 |
|
1406 | |||
1407 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1407 | #debugx('self.indent_current_nsp','pre_readline:') | |
1408 |
|
1408 | |||
1409 | if self.rl_do_indent: |
|
1409 | if self.rl_do_indent: | |
1410 | self.readline.insert_text(self.indent_current_str()) |
|
1410 | self.readline.insert_text(self.indent_current_str()) | |
1411 | if self.rl_next_input is not None: |
|
1411 | if self.rl_next_input is not None: | |
1412 | self.readline.insert_text(self.rl_next_input) |
|
1412 | self.readline.insert_text(self.rl_next_input) | |
1413 | self.rl_next_input = None |
|
1413 | self.rl_next_input = None | |
1414 |
|
1414 | |||
1415 | def init_readline(self): |
|
1415 | def init_readline(self): | |
1416 | """Command history completion/saving/reloading.""" |
|
1416 | """Command history completion/saving/reloading.""" | |
1417 |
|
1417 | |||
1418 |
|
1418 | |||
1419 | import IPython.utils.rlineimpl as readline |
|
1419 | import IPython.utils.rlineimpl as readline | |
1420 |
|
1420 | |||
1421 | if not readline.have_readline: |
|
1421 | if not readline.have_readline: | |
1422 | self.has_readline = 0 |
|
1422 | self.has_readline = 0 | |
1423 | self.readline = None |
|
1423 | self.readline = None | |
1424 | # no point in bugging windows users with this every time: |
|
1424 | # no point in bugging windows users with this every time: | |
1425 | warn('Readline services not available on this platform.') |
|
1425 | warn('Readline services not available on this platform.') | |
1426 | else: |
|
1426 | else: | |
1427 | sys.modules['readline'] = readline |
|
1427 | sys.modules['readline'] = readline | |
1428 | import atexit |
|
1428 | import atexit | |
1429 | from IPython.core.completer import IPCompleter |
|
1429 | from IPython.core.completer import IPCompleter | |
1430 | self.Completer = IPCompleter(self, |
|
1430 | self.Completer = IPCompleter(self, | |
1431 | self.user_ns, |
|
1431 | self.user_ns, | |
1432 | self.user_global_ns, |
|
1432 | self.user_global_ns, | |
1433 | self.rc.readline_omit__names, |
|
1433 | self.rc.readline_omit__names, | |
1434 | self.alias_table) |
|
1434 | self.alias_table) | |
1435 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1435 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1436 | self.strdispatchers['complete_command'] = sdisp |
|
1436 | self.strdispatchers['complete_command'] = sdisp | |
1437 | self.Completer.custom_completers = sdisp |
|
1437 | self.Completer.custom_completers = sdisp | |
1438 | # Platform-specific configuration |
|
1438 | # Platform-specific configuration | |
1439 | if os.name == 'nt': |
|
1439 | if os.name == 'nt': | |
1440 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1440 | self.readline_startup_hook = readline.set_pre_input_hook | |
1441 | else: |
|
1441 | else: | |
1442 | self.readline_startup_hook = readline.set_startup_hook |
|
1442 | self.readline_startup_hook = readline.set_startup_hook | |
1443 |
|
1443 | |||
1444 | # Load user's initrc file (readline config) |
|
1444 | # Load user's initrc file (readline config) | |
1445 | # Or if libedit is used, load editrc. |
|
1445 | # Or if libedit is used, load editrc. | |
1446 | inputrc_name = os.environ.get('INPUTRC') |
|
1446 | inputrc_name = os.environ.get('INPUTRC') | |
1447 | if inputrc_name is None: |
|
1447 | if inputrc_name is None: | |
1448 | home_dir = get_home_dir() |
|
1448 | home_dir = get_home_dir() | |
1449 | if home_dir is not None: |
|
1449 | if home_dir is not None: | |
1450 | inputrc_name = '.inputrc' |
|
1450 | inputrc_name = '.inputrc' | |
1451 | if readline.uses_libedit: |
|
1451 | if readline.uses_libedit: | |
1452 | inputrc_name = '.editrc' |
|
1452 | inputrc_name = '.editrc' | |
1453 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1453 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1454 | if os.path.isfile(inputrc_name): |
|
1454 | if os.path.isfile(inputrc_name): | |
1455 | try: |
|
1455 | try: | |
1456 | readline.read_init_file(inputrc_name) |
|
1456 | readline.read_init_file(inputrc_name) | |
1457 | except: |
|
1457 | except: | |
1458 | warn('Problems reading readline initialization file <%s>' |
|
1458 | warn('Problems reading readline initialization file <%s>' | |
1459 | % inputrc_name) |
|
1459 | % inputrc_name) | |
1460 |
|
1460 | |||
1461 | self.has_readline = 1 |
|
1461 | self.has_readline = 1 | |
1462 | self.readline = readline |
|
1462 | self.readline = readline | |
1463 | # save this in sys so embedded copies can restore it properly |
|
1463 | # save this in sys so embedded copies can restore it properly | |
1464 | sys.ipcompleter = self.Completer.complete |
|
1464 | sys.ipcompleter = self.Completer.complete | |
1465 | self.set_completer() |
|
1465 | self.set_completer() | |
1466 |
|
1466 | |||
1467 | # Configure readline according to user's prefs |
|
1467 | # Configure readline according to user's prefs | |
1468 | # This is only done if GNU readline is being used. If libedit |
|
1468 | # This is only done if GNU readline is being used. If libedit | |
1469 | # is being used (as on Leopard) the readline config is |
|
1469 | # is being used (as on Leopard) the readline config is | |
1470 | # not run as the syntax for libedit is different. |
|
1470 | # not run as the syntax for libedit is different. | |
1471 | if not readline.uses_libedit: |
|
1471 | if not readline.uses_libedit: | |
1472 | for rlcommand in self.rc.readline_parse_and_bind: |
|
1472 | for rlcommand in self.rc.readline_parse_and_bind: | |
1473 | #print "loading rl:",rlcommand # dbg |
|
1473 | #print "loading rl:",rlcommand # dbg | |
1474 | readline.parse_and_bind(rlcommand) |
|
1474 | readline.parse_and_bind(rlcommand) | |
1475 |
|
1475 | |||
1476 | # Remove some chars from the delimiters list. If we encounter |
|
1476 | # Remove some chars from the delimiters list. If we encounter | |
1477 | # unicode chars, discard them. |
|
1477 | # unicode chars, discard them. | |
1478 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1478 | delims = readline.get_completer_delims().encode("ascii", "ignore") | |
1479 | delims = delims.translate(string._idmap, |
|
1479 | delims = delims.translate(string._idmap, | |
1480 | self.rc.readline_remove_delims) |
|
1480 | self.rc.readline_remove_delims) | |
1481 | readline.set_completer_delims(delims) |
|
1481 | readline.set_completer_delims(delims) | |
1482 | # otherwise we end up with a monster history after a while: |
|
1482 | # otherwise we end up with a monster history after a while: | |
1483 | readline.set_history_length(1000) |
|
1483 | readline.set_history_length(1000) | |
1484 | try: |
|
1484 | try: | |
1485 | #print '*** Reading readline history' # dbg |
|
1485 | #print '*** Reading readline history' # dbg | |
1486 | readline.read_history_file(self.histfile) |
|
1486 | readline.read_history_file(self.histfile) | |
1487 | except IOError: |
|
1487 | except IOError: | |
1488 | pass # It doesn't exist yet. |
|
1488 | pass # It doesn't exist yet. | |
1489 |
|
1489 | |||
1490 | atexit.register(self.atexit_operations) |
|
1490 | atexit.register(self.atexit_operations) | |
1491 | del atexit |
|
1491 | del atexit | |
1492 |
|
1492 | |||
1493 | # Configure auto-indent for all platforms |
|
1493 | # Configure auto-indent for all platforms | |
1494 | self.set_autoindent(self.rc.autoindent) |
|
1494 | self.set_autoindent(self.rc.autoindent) | |
1495 |
|
1495 | |||
1496 | def ask_yes_no(self,prompt,default=True): |
|
1496 | def ask_yes_no(self,prompt,default=True): | |
1497 | if self.rc.quiet: |
|
1497 | if self.rc.quiet: | |
1498 | return True |
|
1498 | return True | |
1499 | return ask_yes_no(prompt,default) |
|
1499 | return ask_yes_no(prompt,default) | |
1500 |
|
1500 | |||
1501 | def new_main_mod(self,ns=None): |
|
1501 | def new_main_mod(self,ns=None): | |
1502 | """Return a new 'main' module object for user code execution. |
|
1502 | """Return a new 'main' module object for user code execution. | |
1503 | """ |
|
1503 | """ | |
1504 | main_mod = self._user_main_module |
|
1504 | main_mod = self._user_main_module | |
1505 | init_fakemod_dict(main_mod,ns) |
|
1505 | init_fakemod_dict(main_mod,ns) | |
1506 | return main_mod |
|
1506 | return main_mod | |
1507 |
|
1507 | |||
1508 | def cache_main_mod(self,ns,fname): |
|
1508 | def cache_main_mod(self,ns,fname): | |
1509 | """Cache a main module's namespace. |
|
1509 | """Cache a main module's namespace. | |
1510 |
|
1510 | |||
1511 | When scripts are executed via %run, we must keep a reference to the |
|
1511 | When scripts are executed via %run, we must keep a reference to the | |
1512 | namespace of their __main__ module (a FakeModule instance) around so |
|
1512 | namespace of their __main__ module (a FakeModule instance) around so | |
1513 | that Python doesn't clear it, rendering objects defined therein |
|
1513 | that Python doesn't clear it, rendering objects defined therein | |
1514 | useless. |
|
1514 | useless. | |
1515 |
|
1515 | |||
1516 | This method keeps said reference in a private dict, keyed by the |
|
1516 | This method keeps said reference in a private dict, keyed by the | |
1517 | absolute path of the module object (which corresponds to the script |
|
1517 | absolute path of the module object (which corresponds to the script | |
1518 | path). This way, for multiple executions of the same script we only |
|
1518 | path). This way, for multiple executions of the same script we only | |
1519 | keep one copy of the namespace (the last one), thus preventing memory |
|
1519 | keep one copy of the namespace (the last one), thus preventing memory | |
1520 | leaks from old references while allowing the objects from the last |
|
1520 | leaks from old references while allowing the objects from the last | |
1521 | execution to be accessible. |
|
1521 | execution to be accessible. | |
1522 |
|
1522 | |||
1523 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
1523 | Note: we can not allow the actual FakeModule instances to be deleted, | |
1524 | because of how Python tears down modules (it hard-sets all their |
|
1524 | because of how Python tears down modules (it hard-sets all their | |
1525 | references to None without regard for reference counts). This method |
|
1525 | references to None without regard for reference counts). This method | |
1526 | must therefore make a *copy* of the given namespace, to allow the |
|
1526 | must therefore make a *copy* of the given namespace, to allow the | |
1527 | original module's __dict__ to be cleared and reused. |
|
1527 | original module's __dict__ to be cleared and reused. | |
1528 |
|
1528 | |||
1529 |
|
1529 | |||
1530 | Parameters |
|
1530 | Parameters | |
1531 | ---------- |
|
1531 | ---------- | |
1532 | ns : a namespace (a dict, typically) |
|
1532 | ns : a namespace (a dict, typically) | |
1533 |
|
1533 | |||
1534 | fname : str |
|
1534 | fname : str | |
1535 | Filename associated with the namespace. |
|
1535 | Filename associated with the namespace. | |
1536 |
|
1536 | |||
1537 | Examples |
|
1537 | Examples | |
1538 | -------- |
|
1538 | -------- | |
1539 |
|
1539 | |||
1540 | In [10]: import IPython |
|
1540 | In [10]: import IPython | |
1541 |
|
1541 | |||
1542 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1542 | In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) | |
1543 |
|
1543 | |||
1544 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache |
|
1544 | In [12]: IPython.__file__ in _ip.IP._main_ns_cache | |
1545 | Out[12]: True |
|
1545 | Out[12]: True | |
1546 | """ |
|
1546 | """ | |
1547 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
1547 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
1548 |
|
1548 | |||
1549 | def clear_main_mod_cache(self): |
|
1549 | def clear_main_mod_cache(self): | |
1550 | """Clear the cache of main modules. |
|
1550 | """Clear the cache of main modules. | |
1551 |
|
1551 | |||
1552 | Mainly for use by utilities like %reset. |
|
1552 | Mainly for use by utilities like %reset. | |
1553 |
|
1553 | |||
1554 | Examples |
|
1554 | Examples | |
1555 | -------- |
|
1555 | -------- | |
1556 |
|
1556 | |||
1557 | In [15]: import IPython |
|
1557 | In [15]: import IPython | |
1558 |
|
1558 | |||
1559 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
1559 | In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__) | |
1560 |
|
1560 | |||
1561 | In [17]: len(_ip.IP._main_ns_cache) > 0 |
|
1561 | In [17]: len(_ip.IP._main_ns_cache) > 0 | |
1562 | Out[17]: True |
|
1562 | Out[17]: True | |
1563 |
|
1563 | |||
1564 | In [18]: _ip.IP.clear_main_mod_cache() |
|
1564 | In [18]: _ip.IP.clear_main_mod_cache() | |
1565 |
|
1565 | |||
1566 | In [19]: len(_ip.IP._main_ns_cache) == 0 |
|
1566 | In [19]: len(_ip.IP._main_ns_cache) == 0 | |
1567 | Out[19]: True |
|
1567 | Out[19]: True | |
1568 | """ |
|
1568 | """ | |
1569 | self._main_ns_cache.clear() |
|
1569 | self._main_ns_cache.clear() | |
1570 |
|
1570 | |||
1571 | def _should_recompile(self,e): |
|
1571 | def _should_recompile(self,e): | |
1572 | """Utility routine for edit_syntax_error""" |
|
1572 | """Utility routine for edit_syntax_error""" | |
1573 |
|
1573 | |||
1574 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1574 | if e.filename in ('<ipython console>','<input>','<string>', | |
1575 | '<console>','<BackgroundJob compilation>', |
|
1575 | '<console>','<BackgroundJob compilation>', | |
1576 | None): |
|
1576 | None): | |
1577 |
|
1577 | |||
1578 | return False |
|
1578 | return False | |
1579 | try: |
|
1579 | try: | |
1580 | if (self.rc.autoedit_syntax and |
|
1580 | if (self.rc.autoedit_syntax and | |
1581 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1581 | not self.ask_yes_no('Return to editor to correct syntax error? ' | |
1582 | '[Y/n] ','y')): |
|
1582 | '[Y/n] ','y')): | |
1583 | return False |
|
1583 | return False | |
1584 | except EOFError: |
|
1584 | except EOFError: | |
1585 | return False |
|
1585 | return False | |
1586 |
|
1586 | |||
1587 | def int0(x): |
|
1587 | def int0(x): | |
1588 | try: |
|
1588 | try: | |
1589 | return int(x) |
|
1589 | return int(x) | |
1590 | except TypeError: |
|
1590 | except TypeError: | |
1591 | return 0 |
|
1591 | return 0 | |
1592 | # always pass integer line and offset values to editor hook |
|
1592 | # always pass integer line and offset values to editor hook | |
1593 | try: |
|
1593 | try: | |
1594 | self.hooks.fix_error_editor(e.filename, |
|
1594 | self.hooks.fix_error_editor(e.filename, | |
1595 | int0(e.lineno),int0(e.offset),e.msg) |
|
1595 | int0(e.lineno),int0(e.offset),e.msg) | |
1596 | except ipapi.TryNext: |
|
1596 | except ipapi.TryNext: | |
1597 | warn('Could not open editor') |
|
1597 | warn('Could not open editor') | |
1598 | return False |
|
1598 | return False | |
1599 | return True |
|
1599 | return True | |
1600 |
|
1600 | |||
1601 | def edit_syntax_error(self): |
|
1601 | def edit_syntax_error(self): | |
1602 | """The bottom half of the syntax error handler called in the main loop. |
|
1602 | """The bottom half of the syntax error handler called in the main loop. | |
1603 |
|
1603 | |||
1604 | Loop until syntax error is fixed or user cancels. |
|
1604 | Loop until syntax error is fixed or user cancels. | |
1605 | """ |
|
1605 | """ | |
1606 |
|
1606 | |||
1607 | while self.SyntaxTB.last_syntax_error: |
|
1607 | while self.SyntaxTB.last_syntax_error: | |
1608 | # copy and clear last_syntax_error |
|
1608 | # copy and clear last_syntax_error | |
1609 | err = self.SyntaxTB.clear_err_state() |
|
1609 | err = self.SyntaxTB.clear_err_state() | |
1610 | if not self._should_recompile(err): |
|
1610 | if not self._should_recompile(err): | |
1611 | return |
|
1611 | return | |
1612 | try: |
|
1612 | try: | |
1613 | # may set last_syntax_error again if a SyntaxError is raised |
|
1613 | # may set last_syntax_error again if a SyntaxError is raised | |
1614 | self.safe_execfile(err.filename,self.user_ns) |
|
1614 | self.safe_execfile(err.filename,self.user_ns) | |
1615 | except: |
|
1615 | except: | |
1616 | self.showtraceback() |
|
1616 | self.showtraceback() | |
1617 | else: |
|
1617 | else: | |
1618 | try: |
|
1618 | try: | |
1619 | f = file(err.filename) |
|
1619 | f = file(err.filename) | |
1620 | try: |
|
1620 | try: | |
1621 | sys.displayhook(f.read()) |
|
1621 | sys.displayhook(f.read()) | |
1622 | finally: |
|
1622 | finally: | |
1623 | f.close() |
|
1623 | f.close() | |
1624 | except: |
|
1624 | except: | |
1625 | self.showtraceback() |
|
1625 | self.showtraceback() | |
1626 |
|
1626 | |||
1627 | def showsyntaxerror(self, filename=None): |
|
1627 | def showsyntaxerror(self, filename=None): | |
1628 | """Display the syntax error that just occurred. |
|
1628 | """Display the syntax error that just occurred. | |
1629 |
|
1629 | |||
1630 | This doesn't display a stack trace because there isn't one. |
|
1630 | This doesn't display a stack trace because there isn't one. | |
1631 |
|
1631 | |||
1632 | If a filename is given, it is stuffed in the exception instead |
|
1632 | If a filename is given, it is stuffed in the exception instead | |
1633 | of what was there before (because Python's parser always uses |
|
1633 | of what was there before (because Python's parser always uses | |
1634 | "<string>" when reading from a string). |
|
1634 | "<string>" when reading from a string). | |
1635 | """ |
|
1635 | """ | |
1636 | etype, value, last_traceback = sys.exc_info() |
|
1636 | etype, value, last_traceback = sys.exc_info() | |
1637 |
|
1637 | |||
1638 | # See note about these variables in showtraceback() below |
|
1638 | # See note about these variables in showtraceback() below | |
1639 | sys.last_type = etype |
|
1639 | sys.last_type = etype | |
1640 | sys.last_value = value |
|
1640 | sys.last_value = value | |
1641 | sys.last_traceback = last_traceback |
|
1641 | sys.last_traceback = last_traceback | |
1642 |
|
1642 | |||
1643 | if filename and etype is SyntaxError: |
|
1643 | if filename and etype is SyntaxError: | |
1644 | # Work hard to stuff the correct filename in the exception |
|
1644 | # Work hard to stuff the correct filename in the exception | |
1645 | try: |
|
1645 | try: | |
1646 | msg, (dummy_filename, lineno, offset, line) = value |
|
1646 | msg, (dummy_filename, lineno, offset, line) = value | |
1647 | except: |
|
1647 | except: | |
1648 | # Not the format we expect; leave it alone |
|
1648 | # Not the format we expect; leave it alone | |
1649 | pass |
|
1649 | pass | |
1650 | else: |
|
1650 | else: | |
1651 | # Stuff in the right filename |
|
1651 | # Stuff in the right filename | |
1652 | try: |
|
1652 | try: | |
1653 | # Assume SyntaxError is a class exception |
|
1653 | # Assume SyntaxError is a class exception | |
1654 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1654 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1655 | except: |
|
1655 | except: | |
1656 | # If that failed, assume SyntaxError is a string |
|
1656 | # If that failed, assume SyntaxError is a string | |
1657 | value = msg, (filename, lineno, offset, line) |
|
1657 | value = msg, (filename, lineno, offset, line) | |
1658 | self.SyntaxTB(etype,value,[]) |
|
1658 | self.SyntaxTB(etype,value,[]) | |
1659 |
|
1659 | |||
1660 | def debugger(self,force=False): |
|
1660 | def debugger(self,force=False): | |
1661 | """Call the pydb/pdb debugger. |
|
1661 | """Call the pydb/pdb debugger. | |
1662 |
|
1662 | |||
1663 | Keywords: |
|
1663 | Keywords: | |
1664 |
|
1664 | |||
1665 | - force(False): by default, this routine checks the instance call_pdb |
|
1665 | - force(False): by default, this routine checks the instance call_pdb | |
1666 | flag and does not actually invoke the debugger if the flag is false. |
|
1666 | flag and does not actually invoke the debugger if the flag is false. | |
1667 | The 'force' option forces the debugger to activate even if the flag |
|
1667 | The 'force' option forces the debugger to activate even if the flag | |
1668 | is false. |
|
1668 | is false. | |
1669 | """ |
|
1669 | """ | |
1670 |
|
1670 | |||
1671 | if not (force or self.call_pdb): |
|
1671 | if not (force or self.call_pdb): | |
1672 | return |
|
1672 | return | |
1673 |
|
1673 | |||
1674 | if not hasattr(sys,'last_traceback'): |
|
1674 | if not hasattr(sys,'last_traceback'): | |
1675 | error('No traceback has been produced, nothing to debug.') |
|
1675 | error('No traceback has been produced, nothing to debug.') | |
1676 | return |
|
1676 | return | |
1677 |
|
1677 | |||
1678 | # use pydb if available |
|
1678 | # use pydb if available | |
1679 | if debugger.has_pydb: |
|
1679 | if debugger.has_pydb: | |
1680 | from pydb import pm |
|
1680 | from pydb import pm | |
1681 | else: |
|
1681 | else: | |
1682 | # fallback to our internal debugger |
|
1682 | # fallback to our internal debugger | |
1683 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
1683 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
1684 | self.history_saving_wrapper(pm)() |
|
1684 | self.history_saving_wrapper(pm)() | |
1685 |
|
1685 | |||
1686 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1686 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): | |
1687 | """Display the exception that just occurred. |
|
1687 | """Display the exception that just occurred. | |
1688 |
|
1688 | |||
1689 | If nothing is known about the exception, this is the method which |
|
1689 | If nothing is known about the exception, this is the method which | |
1690 | should be used throughout the code for presenting user tracebacks, |
|
1690 | should be used throughout the code for presenting user tracebacks, | |
1691 | rather than directly invoking the InteractiveTB object. |
|
1691 | rather than directly invoking the InteractiveTB object. | |
1692 |
|
1692 | |||
1693 | A specific showsyntaxerror() also exists, but this method can take |
|
1693 | A specific showsyntaxerror() also exists, but this method can take | |
1694 | care of calling it if needed, so unless you are explicitly catching a |
|
1694 | care of calling it if needed, so unless you are explicitly catching a | |
1695 | SyntaxError exception, don't try to analyze the stack manually and |
|
1695 | SyntaxError exception, don't try to analyze the stack manually and | |
1696 | simply call this method.""" |
|
1696 | simply call this method.""" | |
1697 |
|
1697 | |||
1698 |
|
1698 | |||
1699 | # Though this won't be called by syntax errors in the input line, |
|
1699 | # Though this won't be called by syntax errors in the input line, | |
1700 | # there may be SyntaxError cases whith imported code. |
|
1700 | # there may be SyntaxError cases whith imported code. | |
1701 |
|
1701 | |||
1702 | try: |
|
1702 | try: | |
1703 | if exc_tuple is None: |
|
1703 | if exc_tuple is None: | |
1704 | etype, value, tb = sys.exc_info() |
|
1704 | etype, value, tb = sys.exc_info() | |
1705 | else: |
|
1705 | else: | |
1706 | etype, value, tb = exc_tuple |
|
1706 | etype, value, tb = exc_tuple | |
1707 |
|
1707 | |||
1708 | if etype is SyntaxError: |
|
1708 | if etype is SyntaxError: | |
1709 | self.showsyntaxerror(filename) |
|
1709 | self.showsyntaxerror(filename) | |
1710 | elif etype is ipapi.UsageError: |
|
1710 | elif etype is ipapi.UsageError: | |
1711 | print "UsageError:", value |
|
1711 | print "UsageError:", value | |
1712 | else: |
|
1712 | else: | |
1713 | # WARNING: these variables are somewhat deprecated and not |
|
1713 | # WARNING: these variables are somewhat deprecated and not | |
1714 | # necessarily safe to use in a threaded environment, but tools |
|
1714 | # necessarily safe to use in a threaded environment, but tools | |
1715 | # like pdb depend on their existence, so let's set them. If we |
|
1715 | # like pdb depend on their existence, so let's set them. If we | |
1716 | # find problems in the field, we'll need to revisit their use. |
|
1716 | # find problems in the field, we'll need to revisit their use. | |
1717 | sys.last_type = etype |
|
1717 | sys.last_type = etype | |
1718 | sys.last_value = value |
|
1718 | sys.last_value = value | |
1719 | sys.last_traceback = tb |
|
1719 | sys.last_traceback = tb | |
1720 |
|
1720 | |||
1721 | if etype in self.custom_exceptions: |
|
1721 | if etype in self.custom_exceptions: | |
1722 | self.CustomTB(etype,value,tb) |
|
1722 | self.CustomTB(etype,value,tb) | |
1723 | else: |
|
1723 | else: | |
1724 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1724 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) | |
1725 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1725 | if self.InteractiveTB.call_pdb and self.has_readline: | |
1726 | # pdb mucks up readline, fix it back |
|
1726 | # pdb mucks up readline, fix it back | |
1727 | self.set_completer() |
|
1727 | self.set_completer() | |
1728 | except KeyboardInterrupt: |
|
1728 | except KeyboardInterrupt: | |
1729 | self.write("\nKeyboardInterrupt\n") |
|
1729 | self.write("\nKeyboardInterrupt\n") | |
1730 |
|
1730 | |||
1731 | def mainloop(self,banner=None): |
|
1731 | def mainloop(self,banner=None): | |
1732 | """Creates the local namespace and starts the mainloop. |
|
1732 | """Creates the local namespace and starts the mainloop. | |
1733 |
|
1733 | |||
1734 | If an optional banner argument is given, it will override the |
|
1734 | If an optional banner argument is given, it will override the | |
1735 | internally created default banner.""" |
|
1735 | internally created default banner.""" | |
1736 |
|
1736 | |||
1737 | if self.rc.c: # Emulate Python's -c option |
|
1737 | if self.rc.c: # Emulate Python's -c option | |
1738 | self.exec_init_cmd() |
|
1738 | self.exec_init_cmd() | |
1739 | if banner is None: |
|
1739 | if banner is None: | |
1740 | if not self.rc.banner: |
|
1740 | if not self.rc.banner: | |
1741 | banner = '' |
|
1741 | banner = '' | |
1742 | # banner is string? Use it directly! |
|
1742 | # banner is string? Use it directly! | |
1743 | elif isinstance(self.rc.banner,basestring): |
|
1743 | elif isinstance(self.rc.banner,basestring): | |
1744 | banner = self.rc.banner |
|
1744 | banner = self.rc.banner | |
1745 | else: |
|
1745 | else: | |
1746 | banner = self.BANNER+self.banner2 |
|
1746 | banner = self.BANNER+self.banner2 | |
1747 |
|
1747 | |||
1748 | # if you run stuff with -c <cmd>, raw hist is not updated |
|
1748 | # if you run stuff with -c <cmd>, raw hist is not updated | |
1749 | # ensure that it's in sync |
|
1749 | # ensure that it's in sync | |
1750 | if len(self.input_hist) != len (self.input_hist_raw): |
|
1750 | if len(self.input_hist) != len (self.input_hist_raw): | |
1751 | self.input_hist_raw = InputList(self.input_hist) |
|
1751 | self.input_hist_raw = InputList(self.input_hist) | |
1752 |
|
1752 | |||
1753 | while 1: |
|
1753 | while 1: | |
1754 | try: |
|
1754 | try: | |
1755 | self.interact(banner) |
|
1755 | self.interact(banner) | |
1756 | #self.interact_with_readline() |
|
1756 | #self.interact_with_readline() | |
1757 |
|
1757 | |||
1758 | # XXX for testing of a readline-decoupled repl loop, call |
|
1758 | # XXX for testing of a readline-decoupled repl loop, call | |
1759 | # interact_with_readline above |
|
1759 | # interact_with_readline above | |
1760 |
|
1760 | |||
1761 | break |
|
1761 | break | |
1762 | except KeyboardInterrupt: |
|
1762 | except KeyboardInterrupt: | |
1763 | # this should not be necessary, but KeyboardInterrupt |
|
1763 | # this should not be necessary, but KeyboardInterrupt | |
1764 | # handling seems rather unpredictable... |
|
1764 | # handling seems rather unpredictable... | |
1765 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1765 | self.write("\nKeyboardInterrupt in interact()\n") | |
1766 |
|
1766 | |||
1767 | def exec_init_cmd(self): |
|
1767 | def exec_init_cmd(self): | |
1768 | """Execute a command given at the command line. |
|
1768 | """Execute a command given at the command line. | |
1769 |
|
1769 | |||
1770 | This emulates Python's -c option.""" |
|
1770 | This emulates Python's -c option.""" | |
1771 |
|
1771 | |||
1772 | #sys.argv = ['-c'] |
|
1772 | #sys.argv = ['-c'] | |
1773 | self.push(self.prefilter(self.rc.c, False)) |
|
1773 | self.push(self.prefilter(self.rc.c, False)) | |
1774 | if not self.rc.interact: |
|
1774 | if not self.rc.interact: | |
1775 | self.ask_exit() |
|
1775 | self.ask_exit() | |
1776 |
|
1776 | |||
1777 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): |
|
1777 | def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0): | |
1778 | """Embeds IPython into a running python program. |
|
1778 | """Embeds IPython into a running python program. | |
1779 |
|
1779 | |||
1780 | Input: |
|
1780 | Input: | |
1781 |
|
1781 | |||
1782 | - header: An optional header message can be specified. |
|
1782 | - header: An optional header message can be specified. | |
1783 |
|
1783 | |||
1784 | - local_ns, global_ns: working namespaces. If given as None, the |
|
1784 | - local_ns, global_ns: working namespaces. If given as None, the | |
1785 | IPython-initialized one is updated with __main__.__dict__, so that |
|
1785 | IPython-initialized one is updated with __main__.__dict__, so that | |
1786 | program variables become visible but user-specific configuration |
|
1786 | program variables become visible but user-specific configuration | |
1787 | remains possible. |
|
1787 | remains possible. | |
1788 |
|
1788 | |||
1789 | - stack_depth: specifies how many levels in the stack to go to |
|
1789 | - stack_depth: specifies how many levels in the stack to go to | |
1790 | looking for namespaces (when local_ns and global_ns are None). This |
|
1790 | looking for namespaces (when local_ns and global_ns are None). This | |
1791 | allows an intermediate caller to make sure that this function gets |
|
1791 | allows an intermediate caller to make sure that this function gets | |
1792 | the namespace from the intended level in the stack. By default (0) |
|
1792 | the namespace from the intended level in the stack. By default (0) | |
1793 | it will get its locals and globals from the immediate caller. |
|
1793 | it will get its locals and globals from the immediate caller. | |
1794 |
|
1794 | |||
1795 | Warning: it's possible to use this in a program which is being run by |
|
1795 | Warning: it's possible to use this in a program which is being run by | |
1796 | IPython itself (via %run), but some funny things will happen (a few |
|
1796 | IPython itself (via %run), but some funny things will happen (a few | |
1797 | globals get overwritten). In the future this will be cleaned up, as |
|
1797 | globals get overwritten). In the future this will be cleaned up, as | |
1798 | there is no fundamental reason why it can't work perfectly.""" |
|
1798 | there is no fundamental reason why it can't work perfectly.""" | |
1799 |
|
1799 | |||
1800 | # Get locals and globals from caller |
|
1800 | # Get locals and globals from caller | |
1801 | if local_ns is None or global_ns is None: |
|
1801 | if local_ns is None or global_ns is None: | |
1802 | call_frame = sys._getframe(stack_depth).f_back |
|
1802 | call_frame = sys._getframe(stack_depth).f_back | |
1803 |
|
1803 | |||
1804 | if local_ns is None: |
|
1804 | if local_ns is None: | |
1805 | local_ns = call_frame.f_locals |
|
1805 | local_ns = call_frame.f_locals | |
1806 | if global_ns is None: |
|
1806 | if global_ns is None: | |
1807 | global_ns = call_frame.f_globals |
|
1807 | global_ns = call_frame.f_globals | |
1808 |
|
1808 | |||
1809 | # Update namespaces and fire up interpreter |
|
1809 | # Update namespaces and fire up interpreter | |
1810 |
|
1810 | |||
1811 | # The global one is easy, we can just throw it in |
|
1811 | # The global one is easy, we can just throw it in | |
1812 | self.user_global_ns = global_ns |
|
1812 | self.user_global_ns = global_ns | |
1813 |
|
1813 | |||
1814 | # but the user/local one is tricky: ipython needs it to store internal |
|
1814 | # but the user/local one is tricky: ipython needs it to store internal | |
1815 | # data, but we also need the locals. We'll copy locals in the user |
|
1815 | # data, but we also need the locals. We'll copy locals in the user | |
1816 | # one, but will track what got copied so we can delete them at exit. |
|
1816 | # one, but will track what got copied so we can delete them at exit. | |
1817 | # This is so that a later embedded call doesn't see locals from a |
|
1817 | # This is so that a later embedded call doesn't see locals from a | |
1818 | # previous call (which most likely existed in a separate scope). |
|
1818 | # previous call (which most likely existed in a separate scope). | |
1819 | local_varnames = local_ns.keys() |
|
1819 | local_varnames = local_ns.keys() | |
1820 | self.user_ns.update(local_ns) |
|
1820 | self.user_ns.update(local_ns) | |
1821 | #self.user_ns['local_ns'] = local_ns # dbg |
|
1821 | #self.user_ns['local_ns'] = local_ns # dbg | |
1822 |
|
1822 | |||
1823 | # Patch for global embedding to make sure that things don't overwrite |
|
1823 | # Patch for global embedding to make sure that things don't overwrite | |
1824 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
1824 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> | |
1825 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
1825 | # FIXME. Test this a bit more carefully (the if.. is new) | |
1826 | if local_ns is None and global_ns is None: |
|
1826 | if local_ns is None and global_ns is None: | |
1827 | self.user_global_ns.update(__main__.__dict__) |
|
1827 | self.user_global_ns.update(__main__.__dict__) | |
1828 |
|
1828 | |||
1829 | # make sure the tab-completer has the correct frame information, so it |
|
1829 | # make sure the tab-completer has the correct frame information, so it | |
1830 | # actually completes using the frame's locals/globals |
|
1830 | # actually completes using the frame's locals/globals | |
1831 | self.set_completer_frame() |
|
1831 | self.set_completer_frame() | |
1832 |
|
1832 | |||
1833 | # before activating the interactive mode, we need to make sure that |
|
1833 | # before activating the interactive mode, we need to make sure that | |
1834 | # all names in the builtin namespace needed by ipython point to |
|
1834 | # all names in the builtin namespace needed by ipython point to | |
1835 | # ourselves, and not to other instances. |
|
1835 | # ourselves, and not to other instances. | |
1836 | self.add_builtins() |
|
1836 | self.add_builtins() | |
1837 |
|
1837 | |||
1838 | self.interact(header) |
|
1838 | self.interact(header) | |
1839 |
|
1839 | |||
1840 | # now, purge out the user namespace from anything we might have added |
|
1840 | # now, purge out the user namespace from anything we might have added | |
1841 | # from the caller's local namespace |
|
1841 | # from the caller's local namespace | |
1842 | delvar = self.user_ns.pop |
|
1842 | delvar = self.user_ns.pop | |
1843 | for var in local_varnames: |
|
1843 | for var in local_varnames: | |
1844 | delvar(var,None) |
|
1844 | delvar(var,None) | |
1845 | # and clean builtins we may have overridden |
|
1845 | # and clean builtins we may have overridden | |
1846 | self.clean_builtins() |
|
1846 | self.clean_builtins() | |
1847 |
|
1847 | |||
1848 | def interact_prompt(self): |
|
1848 | def interact_prompt(self): | |
1849 | """ Print the prompt (in read-eval-print loop) |
|
1849 | """ Print the prompt (in read-eval-print loop) | |
1850 |
|
1850 | |||
1851 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1851 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1852 | used in standard IPython flow. |
|
1852 | used in standard IPython flow. | |
1853 | """ |
|
1853 | """ | |
1854 | if self.more: |
|
1854 | if self.more: | |
1855 | try: |
|
1855 | try: | |
1856 | prompt = self.hooks.generate_prompt(True) |
|
1856 | prompt = self.hooks.generate_prompt(True) | |
1857 | except: |
|
1857 | except: | |
1858 | self.showtraceback() |
|
1858 | self.showtraceback() | |
1859 | if self.autoindent: |
|
1859 | if self.autoindent: | |
1860 | self.rl_do_indent = True |
|
1860 | self.rl_do_indent = True | |
1861 |
|
1861 | |||
1862 | else: |
|
1862 | else: | |
1863 | try: |
|
1863 | try: | |
1864 | prompt = self.hooks.generate_prompt(False) |
|
1864 | prompt = self.hooks.generate_prompt(False) | |
1865 | except: |
|
1865 | except: | |
1866 | self.showtraceback() |
|
1866 | self.showtraceback() | |
1867 | self.write(prompt) |
|
1867 | self.write(prompt) | |
1868 |
|
1868 | |||
1869 | def interact_handle_input(self,line): |
|
1869 | def interact_handle_input(self,line): | |
1870 | """ Handle the input line (in read-eval-print loop) |
|
1870 | """ Handle the input line (in read-eval-print loop) | |
1871 |
|
1871 | |||
1872 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1872 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1873 | used in standard IPython flow. |
|
1873 | used in standard IPython flow. | |
1874 | """ |
|
1874 | """ | |
1875 | if line.lstrip() == line: |
|
1875 | if line.lstrip() == line: | |
1876 | self.shadowhist.add(line.strip()) |
|
1876 | self.shadowhist.add(line.strip()) | |
1877 | lineout = self.prefilter(line,self.more) |
|
1877 | lineout = self.prefilter(line,self.more) | |
1878 |
|
1878 | |||
1879 | if line.strip(): |
|
1879 | if line.strip(): | |
1880 | if self.more: |
|
1880 | if self.more: | |
1881 | self.input_hist_raw[-1] += '%s\n' % line |
|
1881 | self.input_hist_raw[-1] += '%s\n' % line | |
1882 | else: |
|
1882 | else: | |
1883 | self.input_hist_raw.append('%s\n' % line) |
|
1883 | self.input_hist_raw.append('%s\n' % line) | |
1884 |
|
1884 | |||
1885 |
|
1885 | |||
1886 | self.more = self.push(lineout) |
|
1886 | self.more = self.push(lineout) | |
1887 | if (self.SyntaxTB.last_syntax_error and |
|
1887 | if (self.SyntaxTB.last_syntax_error and | |
1888 | self.rc.autoedit_syntax): |
|
1888 | self.rc.autoedit_syntax): | |
1889 | self.edit_syntax_error() |
|
1889 | self.edit_syntax_error() | |
1890 |
|
1890 | |||
1891 | def interact_with_readline(self): |
|
1891 | def interact_with_readline(self): | |
1892 | """ Demo of using interact_handle_input, interact_prompt |
|
1892 | """ Demo of using interact_handle_input, interact_prompt | |
1893 |
|
1893 | |||
1894 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1894 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), | |
1895 | it should work like this. |
|
1895 | it should work like this. | |
1896 | """ |
|
1896 | """ | |
1897 | self.readline_startup_hook(self.pre_readline) |
|
1897 | self.readline_startup_hook(self.pre_readline) | |
1898 | while not self.exit_now: |
|
1898 | while not self.exit_now: | |
1899 | self.interact_prompt() |
|
1899 | self.interact_prompt() | |
1900 | if self.more: |
|
1900 | if self.more: | |
1901 | self.rl_do_indent = True |
|
1901 | self.rl_do_indent = True | |
1902 | else: |
|
1902 | else: | |
1903 | self.rl_do_indent = False |
|
1903 | self.rl_do_indent = False | |
1904 | line = raw_input_original().decode(self.stdin_encoding) |
|
1904 | line = raw_input_original().decode(self.stdin_encoding) | |
1905 | self.interact_handle_input(line) |
|
1905 | self.interact_handle_input(line) | |
1906 |
|
1906 | |||
1907 |
|
1907 | |||
1908 | def interact(self, banner=None): |
|
1908 | def interact(self, banner=None): | |
1909 | """Closely emulate the interactive Python console. |
|
1909 | """Closely emulate the interactive Python console. | |
1910 |
|
1910 | |||
1911 | The optional banner argument specify the banner to print |
|
1911 | The optional banner argument specify the banner to print | |
1912 | before the first interaction; by default it prints a banner |
|
1912 | before the first interaction; by default it prints a banner | |
1913 | similar to the one printed by the real Python interpreter, |
|
1913 | similar to the one printed by the real Python interpreter, | |
1914 | followed by the current class name in parentheses (so as not |
|
1914 | followed by the current class name in parentheses (so as not | |
1915 | to confuse this with the real interpreter -- since it's so |
|
1915 | to confuse this with the real interpreter -- since it's so | |
1916 | close!). |
|
1916 | close!). | |
1917 |
|
1917 | |||
1918 | """ |
|
1918 | """ | |
1919 |
|
1919 | |||
1920 | if self.exit_now: |
|
1920 | if self.exit_now: | |
1921 | # batch run -> do not interact |
|
1921 | # batch run -> do not interact | |
1922 | return |
|
1922 | return | |
1923 | cprt = 'Type "copyright", "credits" or "license" for more information.' |
|
1923 | cprt = 'Type "copyright", "credits" or "license" for more information.' | |
1924 | if banner is None: |
|
1924 | if banner is None: | |
1925 | self.write("Python %s on %s\n%s\n(%s)\n" % |
|
1925 | self.write("Python %s on %s\n%s\n(%s)\n" % | |
1926 | (sys.version, sys.platform, cprt, |
|
1926 | (sys.version, sys.platform, cprt, | |
1927 | self.__class__.__name__)) |
|
1927 | self.__class__.__name__)) | |
1928 | else: |
|
1928 | else: | |
1929 | self.write(banner) |
|
1929 | self.write(banner) | |
1930 |
|
1930 | |||
1931 | more = 0 |
|
1931 | more = 0 | |
1932 |
|
1932 | |||
1933 | # Mark activity in the builtins |
|
1933 | # Mark activity in the builtins | |
1934 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1934 | __builtin__.__dict__['__IPYTHON__active'] += 1 | |
1935 |
|
1935 | |||
1936 | if self.has_readline: |
|
1936 | if self.has_readline: | |
1937 | self.readline_startup_hook(self.pre_readline) |
|
1937 | self.readline_startup_hook(self.pre_readline) | |
1938 | # exit_now is set by a call to %Exit or %Quit, through the |
|
1938 | # exit_now is set by a call to %Exit or %Quit, through the | |
1939 | # ask_exit callback. |
|
1939 | # ask_exit callback. | |
1940 |
|
1940 | |||
1941 | while not self.exit_now: |
|
1941 | while not self.exit_now: | |
1942 | self.hooks.pre_prompt_hook() |
|
1942 | self.hooks.pre_prompt_hook() | |
1943 | if more: |
|
1943 | if more: | |
1944 | try: |
|
1944 | try: | |
1945 | prompt = self.hooks.generate_prompt(True) |
|
1945 | prompt = self.hooks.generate_prompt(True) | |
1946 | except: |
|
1946 | except: | |
1947 | self.showtraceback() |
|
1947 | self.showtraceback() | |
1948 | if self.autoindent: |
|
1948 | if self.autoindent: | |
1949 | self.rl_do_indent = True |
|
1949 | self.rl_do_indent = True | |
1950 |
|
1950 | |||
1951 | else: |
|
1951 | else: | |
1952 | try: |
|
1952 | try: | |
1953 | prompt = self.hooks.generate_prompt(False) |
|
1953 | prompt = self.hooks.generate_prompt(False) | |
1954 | except: |
|
1954 | except: | |
1955 | self.showtraceback() |
|
1955 | self.showtraceback() | |
1956 | try: |
|
1956 | try: | |
1957 | line = self.raw_input(prompt,more) |
|
1957 | line = self.raw_input(prompt,more) | |
1958 | if self.exit_now: |
|
1958 | if self.exit_now: | |
1959 | # quick exit on sys.std[in|out] close |
|
1959 | # quick exit on sys.std[in|out] close | |
1960 | break |
|
1960 | break | |
1961 | if self.autoindent: |
|
1961 | if self.autoindent: | |
1962 | self.rl_do_indent = False |
|
1962 | self.rl_do_indent = False | |
1963 |
|
1963 | |||
1964 | except KeyboardInterrupt: |
|
1964 | except KeyboardInterrupt: | |
1965 | #double-guard against keyboardinterrupts during kbdint handling |
|
1965 | #double-guard against keyboardinterrupts during kbdint handling | |
1966 | try: |
|
1966 | try: | |
1967 | self.write('\nKeyboardInterrupt\n') |
|
1967 | self.write('\nKeyboardInterrupt\n') | |
1968 | self.resetbuffer() |
|
1968 | self.resetbuffer() | |
1969 | # keep cache in sync with the prompt counter: |
|
1969 | # keep cache in sync with the prompt counter: | |
1970 | self.outputcache.prompt_count -= 1 |
|
1970 | self.outputcache.prompt_count -= 1 | |
1971 |
|
1971 | |||
1972 | if self.autoindent: |
|
1972 | if self.autoindent: | |
1973 | self.indent_current_nsp = 0 |
|
1973 | self.indent_current_nsp = 0 | |
1974 | more = 0 |
|
1974 | more = 0 | |
1975 | except KeyboardInterrupt: |
|
1975 | except KeyboardInterrupt: | |
1976 | pass |
|
1976 | pass | |
1977 | except EOFError: |
|
1977 | except EOFError: | |
1978 | if self.autoindent: |
|
1978 | if self.autoindent: | |
1979 | self.rl_do_indent = False |
|
1979 | self.rl_do_indent = False | |
1980 | self.readline_startup_hook(None) |
|
1980 | self.readline_startup_hook(None) | |
1981 | self.write('\n') |
|
1981 | self.write('\n') | |
1982 | self.exit() |
|
1982 | self.exit() | |
1983 | except bdb.BdbQuit: |
|
1983 | except bdb.BdbQuit: | |
1984 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1984 | warn('The Python debugger has exited with a BdbQuit exception.\n' | |
1985 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1985 | 'Because of how pdb handles the stack, it is impossible\n' | |
1986 | 'for IPython to properly format this particular exception.\n' |
|
1986 | 'for IPython to properly format this particular exception.\n' | |
1987 | 'IPython will resume normal operation.') |
|
1987 | 'IPython will resume normal operation.') | |
1988 | except: |
|
1988 | except: | |
1989 | # exceptions here are VERY RARE, but they can be triggered |
|
1989 | # exceptions here are VERY RARE, but they can be triggered | |
1990 | # asynchronously by signal handlers, for example. |
|
1990 | # asynchronously by signal handlers, for example. | |
1991 | self.showtraceback() |
|
1991 | self.showtraceback() | |
1992 | else: |
|
1992 | else: | |
1993 | more = self.push(line) |
|
1993 | more = self.push(line) | |
1994 | if (self.SyntaxTB.last_syntax_error and |
|
1994 | if (self.SyntaxTB.last_syntax_error and | |
1995 | self.rc.autoedit_syntax): |
|
1995 | self.rc.autoedit_syntax): | |
1996 | self.edit_syntax_error() |
|
1996 | self.edit_syntax_error() | |
1997 |
|
1997 | |||
1998 | # We are off again... |
|
1998 | # We are off again... | |
1999 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1999 | __builtin__.__dict__['__IPYTHON__active'] -= 1 | |
2000 |
|
2000 | |||
2001 | def excepthook(self, etype, value, tb): |
|
2001 | def excepthook(self, etype, value, tb): | |
2002 | """One more defense for GUI apps that call sys.excepthook. |
|
2002 | """One more defense for GUI apps that call sys.excepthook. | |
2003 |
|
2003 | |||
2004 | GUI frameworks like wxPython trap exceptions and call |
|
2004 | GUI frameworks like wxPython trap exceptions and call | |
2005 | sys.excepthook themselves. I guess this is a feature that |
|
2005 | sys.excepthook themselves. I guess this is a feature that | |
2006 | enables them to keep running after exceptions that would |
|
2006 | enables them to keep running after exceptions that would | |
2007 | otherwise kill their mainloop. This is a bother for IPython |
|
2007 | otherwise kill their mainloop. This is a bother for IPython | |
2008 | which excepts to catch all of the program exceptions with a try: |
|
2008 | which excepts to catch all of the program exceptions with a try: | |
2009 | except: statement. |
|
2009 | except: statement. | |
2010 |
|
2010 | |||
2011 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
2011 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
2012 | any app directly invokes sys.excepthook, it will look to the user like |
|
2012 | any app directly invokes sys.excepthook, it will look to the user like | |
2013 | IPython crashed. In order to work around this, we can disable the |
|
2013 | IPython crashed. In order to work around this, we can disable the | |
2014 | CrashHandler and replace it with this excepthook instead, which prints a |
|
2014 | CrashHandler and replace it with this excepthook instead, which prints a | |
2015 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
2015 | regular traceback using our InteractiveTB. In this fashion, apps which | |
2016 | call sys.excepthook will generate a regular-looking exception from |
|
2016 | call sys.excepthook will generate a regular-looking exception from | |
2017 | IPython, and the CrashHandler will only be triggered by real IPython |
|
2017 | IPython, and the CrashHandler will only be triggered by real IPython | |
2018 | crashes. |
|
2018 | crashes. | |
2019 |
|
2019 | |||
2020 | This hook should be used sparingly, only in places which are not likely |
|
2020 | This hook should be used sparingly, only in places which are not likely | |
2021 | to be true IPython errors. |
|
2021 | to be true IPython errors. | |
2022 | """ |
|
2022 | """ | |
2023 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
2023 | self.showtraceback((etype,value,tb),tb_offset=0) | |
2024 |
|
2024 | |||
2025 | def expand_aliases(self,fn,rest): |
|
2025 | def expand_aliases(self,fn,rest): | |
2026 | """ Expand multiple levels of aliases: |
|
2026 | """ Expand multiple levels of aliases: | |
2027 |
|
2027 | |||
2028 | if: |
|
2028 | if: | |
2029 |
|
2029 | |||
2030 | alias foo bar /tmp |
|
2030 | alias foo bar /tmp | |
2031 | alias baz foo |
|
2031 | alias baz foo | |
2032 |
|
2032 | |||
2033 | then: |
|
2033 | then: | |
2034 |
|
2034 | |||
2035 | baz huhhahhei -> bar /tmp huhhahhei |
|
2035 | baz huhhahhei -> bar /tmp huhhahhei | |
2036 |
|
2036 | |||
2037 | """ |
|
2037 | """ | |
2038 | line = fn + " " + rest |
|
2038 | line = fn + " " + rest | |
2039 |
|
2039 | |||
2040 | done = set() |
|
2040 | done = set() | |
2041 | while 1: |
|
2041 | while 1: | |
2042 | pre,fn,rest = prefilter.splitUserInput(line, |
|
2042 | pre,fn,rest = prefilter.splitUserInput(line, | |
2043 | prefilter.shell_line_split) |
|
2043 | prefilter.shell_line_split) | |
2044 | if fn in self.alias_table: |
|
2044 | if fn in self.alias_table: | |
2045 | if fn in done: |
|
2045 | if fn in done: | |
2046 | warn("Cyclic alias definition, repeated '%s'" % fn) |
|
2046 | warn("Cyclic alias definition, repeated '%s'" % fn) | |
2047 | return "" |
|
2047 | return "" | |
2048 | done.add(fn) |
|
2048 | done.add(fn) | |
2049 |
|
2049 | |||
2050 | l2 = self.transform_alias(fn,rest) |
|
2050 | l2 = self.transform_alias(fn,rest) | |
2051 | # dir -> dir |
|
2051 | # dir -> dir | |
2052 | # print "alias",line, "->",l2 #dbg |
|
2052 | # print "alias",line, "->",l2 #dbg | |
2053 | if l2 == line: |
|
2053 | if l2 == line: | |
2054 | break |
|
2054 | break | |
2055 | # ls -> ls -F should not recurse forever |
|
2055 | # ls -> ls -F should not recurse forever | |
2056 | if l2.split(None,1)[0] == line.split(None,1)[0]: |
|
2056 | if l2.split(None,1)[0] == line.split(None,1)[0]: | |
2057 | line = l2 |
|
2057 | line = l2 | |
2058 | break |
|
2058 | break | |
2059 |
|
2059 | |||
2060 | line=l2 |
|
2060 | line=l2 | |
2061 |
|
2061 | |||
2062 |
|
2062 | |||
2063 | # print "al expand to",line #dbg |
|
2063 | # print "al expand to",line #dbg | |
2064 | else: |
|
2064 | else: | |
2065 | break |
|
2065 | break | |
2066 |
|
2066 | |||
2067 | return line |
|
2067 | return line | |
2068 |
|
2068 | |||
2069 | def transform_alias(self, alias,rest=''): |
|
2069 | def transform_alias(self, alias,rest=''): | |
2070 | """ Transform alias to system command string. |
|
2070 | """ Transform alias to system command string. | |
2071 | """ |
|
2071 | """ | |
2072 | trg = self.alias_table[alias] |
|
2072 | trg = self.alias_table[alias] | |
2073 |
|
2073 | |||
2074 | nargs,cmd = trg |
|
2074 | nargs,cmd = trg | |
2075 | # print trg #dbg |
|
2075 | # print trg #dbg | |
2076 | if ' ' in cmd and os.path.isfile(cmd): |
|
2076 | if ' ' in cmd and os.path.isfile(cmd): | |
2077 | cmd = '"%s"' % cmd |
|
2077 | cmd = '"%s"' % cmd | |
2078 |
|
2078 | |||
2079 | # Expand the %l special to be the user's input line |
|
2079 | # Expand the %l special to be the user's input line | |
2080 | if cmd.find('%l') >= 0: |
|
2080 | if cmd.find('%l') >= 0: | |
2081 | cmd = cmd.replace('%l',rest) |
|
2081 | cmd = cmd.replace('%l',rest) | |
2082 | rest = '' |
|
2082 | rest = '' | |
2083 | if nargs==0: |
|
2083 | if nargs==0: | |
2084 | # Simple, argument-less aliases |
|
2084 | # Simple, argument-less aliases | |
2085 | cmd = '%s %s' % (cmd,rest) |
|
2085 | cmd = '%s %s' % (cmd,rest) | |
2086 | else: |
|
2086 | else: | |
2087 | # Handle aliases with positional arguments |
|
2087 | # Handle aliases with positional arguments | |
2088 | args = rest.split(None,nargs) |
|
2088 | args = rest.split(None,nargs) | |
2089 | if len(args)< nargs: |
|
2089 | if len(args)< nargs: | |
2090 | error('Alias <%s> requires %s arguments, %s given.' % |
|
2090 | error('Alias <%s> requires %s arguments, %s given.' % | |
2091 | (alias,nargs,len(args))) |
|
2091 | (alias,nargs,len(args))) | |
2092 | return None |
|
2092 | return None | |
2093 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) |
|
2093 | cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:])) | |
2094 | # Now call the macro, evaluating in the user's namespace |
|
2094 | # Now call the macro, evaluating in the user's namespace | |
2095 | #print 'new command: <%r>' % cmd # dbg |
|
2095 | #print 'new command: <%r>' % cmd # dbg | |
2096 | return cmd |
|
2096 | return cmd | |
2097 |
|
2097 | |||
2098 | def call_alias(self,alias,rest=''): |
|
2098 | def call_alias(self,alias,rest=''): | |
2099 | """Call an alias given its name and the rest of the line. |
|
2099 | """Call an alias given its name and the rest of the line. | |
2100 |
|
2100 | |||
2101 | This is only used to provide backwards compatibility for users of |
|
2101 | This is only used to provide backwards compatibility for users of | |
2102 | ipalias(), use of which is not recommended for anymore.""" |
|
2102 | ipalias(), use of which is not recommended for anymore.""" | |
2103 |
|
2103 | |||
2104 | # Now call the macro, evaluating in the user's namespace |
|
2104 | # Now call the macro, evaluating in the user's namespace | |
2105 | cmd = self.transform_alias(alias, rest) |
|
2105 | cmd = self.transform_alias(alias, rest) | |
2106 | try: |
|
2106 | try: | |
2107 | self.system(cmd) |
|
2107 | self.system(cmd) | |
2108 | except: |
|
2108 | except: | |
2109 | self.showtraceback() |
|
2109 | self.showtraceback() | |
2110 |
|
2110 | |||
2111 | def indent_current_str(self): |
|
2111 | def indent_current_str(self): | |
2112 | """return the current level of indentation as a string""" |
|
2112 | """return the current level of indentation as a string""" | |
2113 | return self.indent_current_nsp * ' ' |
|
2113 | return self.indent_current_nsp * ' ' | |
2114 |
|
2114 | |||
2115 | def autoindent_update(self,line): |
|
2115 | def autoindent_update(self,line): | |
2116 | """Keep track of the indent level.""" |
|
2116 | """Keep track of the indent level.""" | |
2117 |
|
2117 | |||
2118 | #debugx('line') |
|
2118 | #debugx('line') | |
2119 | #debugx('self.indent_current_nsp') |
|
2119 | #debugx('self.indent_current_nsp') | |
2120 | if self.autoindent: |
|
2120 | if self.autoindent: | |
2121 | if line: |
|
2121 | if line: | |
2122 | inisp = num_ini_spaces(line) |
|
2122 | inisp = num_ini_spaces(line) | |
2123 | if inisp < self.indent_current_nsp: |
|
2123 | if inisp < self.indent_current_nsp: | |
2124 | self.indent_current_nsp = inisp |
|
2124 | self.indent_current_nsp = inisp | |
2125 |
|
2125 | |||
2126 | if line[-1] == ':': |
|
2126 | if line[-1] == ':': | |
2127 | self.indent_current_nsp += 4 |
|
2127 | self.indent_current_nsp += 4 | |
2128 | elif dedent_re.match(line): |
|
2128 | elif dedent_re.match(line): | |
2129 | self.indent_current_nsp -= 4 |
|
2129 | self.indent_current_nsp -= 4 | |
2130 | else: |
|
2130 | else: | |
2131 | self.indent_current_nsp = 0 |
|
2131 | self.indent_current_nsp = 0 | |
2132 |
|
2132 | |||
2133 | def runlines(self,lines): |
|
2133 | def runlines(self,lines): | |
2134 | """Run a string of one or more lines of source. |
|
2134 | """Run a string of one or more lines of source. | |
2135 |
|
2135 | |||
2136 | This method is capable of running a string containing multiple source |
|
2136 | This method is capable of running a string containing multiple source | |
2137 | lines, as if they had been entered at the IPython prompt. Since it |
|
2137 | lines, as if they had been entered at the IPython prompt. Since it | |
2138 | exposes IPython's processing machinery, the given strings can contain |
|
2138 | exposes IPython's processing machinery, the given strings can contain | |
2139 | magic calls (%magic), special shell access (!cmd), etc.""" |
|
2139 | magic calls (%magic), special shell access (!cmd), etc.""" | |
2140 |
|
2140 | |||
2141 | # We must start with a clean buffer, in case this is run from an |
|
2141 | # We must start with a clean buffer, in case this is run from an | |
2142 | # interactive IPython session (via a magic, for example). |
|
2142 | # interactive IPython session (via a magic, for example). | |
2143 | self.resetbuffer() |
|
2143 | self.resetbuffer() | |
2144 | lines = lines.split('\n') |
|
2144 | lines = lines.split('\n') | |
2145 | more = 0 |
|
2145 | more = 0 | |
2146 |
|
2146 | |||
2147 | for line in lines: |
|
2147 | for line in lines: | |
2148 | # skip blank lines so we don't mess up the prompt counter, but do |
|
2148 | # skip blank lines so we don't mess up the prompt counter, but do | |
2149 | # NOT skip even a blank line if we are in a code block (more is |
|
2149 | # NOT skip even a blank line if we are in a code block (more is | |
2150 | # true) |
|
2150 | # true) | |
2151 |
|
2151 | |||
2152 | if line or more: |
|
2152 | if line or more: | |
2153 | # push to raw history, so hist line numbers stay in sync |
|
2153 | # push to raw history, so hist line numbers stay in sync | |
2154 | self.input_hist_raw.append("# " + line + "\n") |
|
2154 | self.input_hist_raw.append("# " + line + "\n") | |
2155 | more = self.push(self.prefilter(line,more)) |
|
2155 | more = self.push(self.prefilter(line,more)) | |
2156 | # IPython's runsource returns None if there was an error |
|
2156 | # IPython's runsource returns None if there was an error | |
2157 | # compiling the code. This allows us to stop processing right |
|
2157 | # compiling the code. This allows us to stop processing right | |
2158 | # away, so the user gets the error message at the right place. |
|
2158 | # away, so the user gets the error message at the right place. | |
2159 | if more is None: |
|
2159 | if more is None: | |
2160 | break |
|
2160 | break | |
2161 | else: |
|
2161 | else: | |
2162 | self.input_hist_raw.append("\n") |
|
2162 | self.input_hist_raw.append("\n") | |
2163 | # final newline in case the input didn't have it, so that the code |
|
2163 | # final newline in case the input didn't have it, so that the code | |
2164 | # actually does get executed |
|
2164 | # actually does get executed | |
2165 | if more: |
|
2165 | if more: | |
2166 | self.push('\n') |
|
2166 | self.push('\n') | |
2167 |
|
2167 | |||
2168 | def runsource(self, source, filename='<input>', symbol='single'): |
|
2168 | def runsource(self, source, filename='<input>', symbol='single'): | |
2169 | """Compile and run some source in the interpreter. |
|
2169 | """Compile and run some source in the interpreter. | |
2170 |
|
2170 | |||
2171 | Arguments are as for compile_command(). |
|
2171 | Arguments are as for compile_command(). | |
2172 |
|
2172 | |||
2173 | One several things can happen: |
|
2173 | One several things can happen: | |
2174 |
|
2174 | |||
2175 | 1) The input is incorrect; compile_command() raised an |
|
2175 | 1) The input is incorrect; compile_command() raised an | |
2176 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2176 | exception (SyntaxError or OverflowError). A syntax traceback | |
2177 | will be printed by calling the showsyntaxerror() method. |
|
2177 | will be printed by calling the showsyntaxerror() method. | |
2178 |
|
2178 | |||
2179 | 2) The input is incomplete, and more input is required; |
|
2179 | 2) The input is incomplete, and more input is required; | |
2180 | compile_command() returned None. Nothing happens. |
|
2180 | compile_command() returned None. Nothing happens. | |
2181 |
|
2181 | |||
2182 | 3) The input is complete; compile_command() returned a code |
|
2182 | 3) The input is complete; compile_command() returned a code | |
2183 | object. The code is executed by calling self.runcode() (which |
|
2183 | object. The code is executed by calling self.runcode() (which | |
2184 | also handles run-time exceptions, except for SystemExit). |
|
2184 | also handles run-time exceptions, except for SystemExit). | |
2185 |
|
2185 | |||
2186 | The return value is: |
|
2186 | The return value is: | |
2187 |
|
2187 | |||
2188 | - True in case 2 |
|
2188 | - True in case 2 | |
2189 |
|
2189 | |||
2190 | - False in the other cases, unless an exception is raised, where |
|
2190 | - False in the other cases, unless an exception is raised, where | |
2191 | None is returned instead. This can be used by external callers to |
|
2191 | None is returned instead. This can be used by external callers to | |
2192 | know whether to continue feeding input or not. |
|
2192 | know whether to continue feeding input or not. | |
2193 |
|
2193 | |||
2194 | The return value can be used to decide whether to use sys.ps1 or |
|
2194 | The return value can be used to decide whether to use sys.ps1 or | |
2195 | sys.ps2 to prompt the next line.""" |
|
2195 | sys.ps2 to prompt the next line.""" | |
2196 |
|
2196 | |||
2197 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2197 | # if the source code has leading blanks, add 'if 1:\n' to it | |
2198 | # this allows execution of indented pasted code. It is tempting |
|
2198 | # this allows execution of indented pasted code. It is tempting | |
2199 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2199 | # to add '\n' at the end of source to run commands like ' a=1' | |
2200 | # directly, but this fails for more complicated scenarios |
|
2200 | # directly, but this fails for more complicated scenarios | |
2201 | source=source.encode(self.stdin_encoding) |
|
2201 | source=source.encode(self.stdin_encoding) | |
2202 | if source[:1] in [' ', '\t']: |
|
2202 | if source[:1] in [' ', '\t']: | |
2203 | source = 'if 1:\n%s' % source |
|
2203 | source = 'if 1:\n%s' % source | |
2204 |
|
2204 | |||
2205 | try: |
|
2205 | try: | |
2206 | code = self.compile(source,filename,symbol) |
|
2206 | code = self.compile(source,filename,symbol) | |
2207 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2207 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2208 | # Case 1 |
|
2208 | # Case 1 | |
2209 | self.showsyntaxerror(filename) |
|
2209 | self.showsyntaxerror(filename) | |
2210 | return None |
|
2210 | return None | |
2211 |
|
2211 | |||
2212 | if code is None: |
|
2212 | if code is None: | |
2213 | # Case 2 |
|
2213 | # Case 2 | |
2214 | return True |
|
2214 | return True | |
2215 |
|
2215 | |||
2216 | # Case 3 |
|
2216 | # Case 3 | |
2217 | # We store the code object so that threaded shells and |
|
2217 | # We store the code object so that threaded shells and | |
2218 | # custom exception handlers can access all this info if needed. |
|
2218 | # custom exception handlers can access all this info if needed. | |
2219 | # The source corresponding to this can be obtained from the |
|
2219 | # The source corresponding to this can be obtained from the | |
2220 | # buffer attribute as '\n'.join(self.buffer). |
|
2220 | # buffer attribute as '\n'.join(self.buffer). | |
2221 | self.code_to_run = code |
|
2221 | self.code_to_run = code | |
2222 | # now actually execute the code object |
|
2222 | # now actually execute the code object | |
2223 | if self.runcode(code) == 0: |
|
2223 | if self.runcode(code) == 0: | |
2224 | return False |
|
2224 | return False | |
2225 | else: |
|
2225 | else: | |
2226 | return None |
|
2226 | return None | |
2227 |
|
2227 | |||
2228 | def runcode(self,code_obj): |
|
2228 | def runcode(self,code_obj): | |
2229 | """Execute a code object. |
|
2229 | """Execute a code object. | |
2230 |
|
2230 | |||
2231 | When an exception occurs, self.showtraceback() is called to display a |
|
2231 | When an exception occurs, self.showtraceback() is called to display a | |
2232 | traceback. |
|
2232 | traceback. | |
2233 |
|
2233 | |||
2234 | Return value: a flag indicating whether the code to be run completed |
|
2234 | Return value: a flag indicating whether the code to be run completed | |
2235 | successfully: |
|
2235 | successfully: | |
2236 |
|
2236 | |||
2237 | - 0: successful execution. |
|
2237 | - 0: successful execution. | |
2238 | - 1: an error occurred. |
|
2238 | - 1: an error occurred. | |
2239 | """ |
|
2239 | """ | |
2240 |
|
2240 | |||
2241 | # Set our own excepthook in case the user code tries to call it |
|
2241 | # Set our own excepthook in case the user code tries to call it | |
2242 | # directly, so that the IPython crash handler doesn't get triggered |
|
2242 | # directly, so that the IPython crash handler doesn't get triggered | |
2243 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2243 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2244 |
|
2244 | |||
2245 | # we save the original sys.excepthook in the instance, in case config |
|
2245 | # we save the original sys.excepthook in the instance, in case config | |
2246 | # code (such as magics) needs access to it. |
|
2246 | # code (such as magics) needs access to it. | |
2247 | self.sys_excepthook = old_excepthook |
|
2247 | self.sys_excepthook = old_excepthook | |
2248 | outflag = 1 # happens in more places, so it's easier as default |
|
2248 | outflag = 1 # happens in more places, so it's easier as default | |
2249 | try: |
|
2249 | try: | |
2250 | try: |
|
2250 | try: | |
2251 | self.hooks.pre_runcode_hook() |
|
2251 | self.hooks.pre_runcode_hook() | |
2252 | exec code_obj in self.user_global_ns, self.user_ns |
|
2252 | exec code_obj in self.user_global_ns, self.user_ns | |
2253 | finally: |
|
2253 | finally: | |
2254 | # Reset our crash handler in place |
|
2254 | # Reset our crash handler in place | |
2255 | sys.excepthook = old_excepthook |
|
2255 | sys.excepthook = old_excepthook | |
2256 | except SystemExit: |
|
2256 | except SystemExit: | |
2257 | self.resetbuffer() |
|
2257 | self.resetbuffer() | |
2258 | self.showtraceback() |
|
2258 | self.showtraceback() | |
2259 | warn("Type %exit or %quit to exit IPython " |
|
2259 | warn("Type %exit or %quit to exit IPython " | |
2260 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2260 | "(%Exit or %Quit do so unconditionally).",level=1) | |
2261 | except self.custom_exceptions: |
|
2261 | except self.custom_exceptions: | |
2262 | etype,value,tb = sys.exc_info() |
|
2262 | etype,value,tb = sys.exc_info() | |
2263 | self.CustomTB(etype,value,tb) |
|
2263 | self.CustomTB(etype,value,tb) | |
2264 | except: |
|
2264 | except: | |
2265 | self.showtraceback() |
|
2265 | self.showtraceback() | |
2266 | else: |
|
2266 | else: | |
2267 | outflag = 0 |
|
2267 | outflag = 0 | |
2268 | if softspace(sys.stdout, 0): |
|
2268 | if softspace(sys.stdout, 0): | |
2269 |
|
2269 | |||
2270 | # Flush out code object which has been run (and source) |
|
2270 | # Flush out code object which has been run (and source) | |
2271 | self.code_to_run = None |
|
2271 | self.code_to_run = None | |
2272 | return outflag |
|
2272 | return outflag | |
2273 |
|
2273 | |||
2274 | def push(self, line): |
|
2274 | def push(self, line): | |
2275 | """Push a line to the interpreter. |
|
2275 | """Push a line to the interpreter. | |
2276 |
|
2276 | |||
2277 | The line should not have a trailing newline; it may have |
|
2277 | The line should not have a trailing newline; it may have | |
2278 | internal newlines. The line is appended to a buffer and the |
|
2278 | internal newlines. The line is appended to a buffer and the | |
2279 | interpreter's runsource() method is called with the |
|
2279 | interpreter's runsource() method is called with the | |
2280 | concatenated contents of the buffer as source. If this |
|
2280 | concatenated contents of the buffer as source. If this | |
2281 | indicates that the command was executed or invalid, the buffer |
|
2281 | indicates that the command was executed or invalid, the buffer | |
2282 | is reset; otherwise, the command is incomplete, and the buffer |
|
2282 | is reset; otherwise, the command is incomplete, and the buffer | |
2283 | is left as it was after the line was appended. The return |
|
2283 | is left as it was after the line was appended. The return | |
2284 | value is 1 if more input is required, 0 if the line was dealt |
|
2284 | value is 1 if more input is required, 0 if the line was dealt | |
2285 | with in some way (this is the same as runsource()). |
|
2285 | with in some way (this is the same as runsource()). | |
2286 | """ |
|
2286 | """ | |
2287 |
|
2287 | |||
2288 | # autoindent management should be done here, and not in the |
|
2288 | # autoindent management should be done here, and not in the | |
2289 | # interactive loop, since that one is only seen by keyboard input. We |
|
2289 | # interactive loop, since that one is only seen by keyboard input. We | |
2290 | # need this done correctly even for code run via runlines (which uses |
|
2290 | # need this done correctly even for code run via runlines (which uses | |
2291 | # push). |
|
2291 | # push). | |
2292 |
|
2292 | |||
2293 | #print 'push line: <%s>' % line # dbg |
|
2293 | #print 'push line: <%s>' % line # dbg | |
2294 | for subline in line.splitlines(): |
|
2294 | for subline in line.splitlines(): | |
2295 | self.autoindent_update(subline) |
|
2295 | self.autoindent_update(subline) | |
2296 | self.buffer.append(line) |
|
2296 | self.buffer.append(line) | |
2297 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2297 | more = self.runsource('\n'.join(self.buffer), self.filename) | |
2298 | if not more: |
|
2298 | if not more: | |
2299 | self.resetbuffer() |
|
2299 | self.resetbuffer() | |
2300 | return more |
|
2300 | return more | |
2301 |
|
2301 | |||
2302 | def split_user_input(self, line): |
|
2302 | def split_user_input(self, line): | |
2303 | # This is really a hold-over to support ipapi and some extensions |
|
2303 | # This is really a hold-over to support ipapi and some extensions | |
2304 | return prefilter.splitUserInput(line) |
|
2304 | return prefilter.splitUserInput(line) | |
2305 |
|
2305 | |||
2306 | def resetbuffer(self): |
|
2306 | def resetbuffer(self): | |
2307 | """Reset the input buffer.""" |
|
2307 | """Reset the input buffer.""" | |
2308 | self.buffer[:] = [] |
|
2308 | self.buffer[:] = [] | |
2309 |
|
2309 | |||
2310 | def raw_input(self,prompt='',continue_prompt=False): |
|
2310 | def raw_input(self,prompt='',continue_prompt=False): | |
2311 | """Write a prompt and read a line. |
|
2311 | """Write a prompt and read a line. | |
2312 |
|
2312 | |||
2313 | The returned line does not include the trailing newline. |
|
2313 | The returned line does not include the trailing newline. | |
2314 | When the user enters the EOF key sequence, EOFError is raised. |
|
2314 | When the user enters the EOF key sequence, EOFError is raised. | |
2315 |
|
2315 | |||
2316 | Optional inputs: |
|
2316 | Optional inputs: | |
2317 |
|
2317 | |||
2318 | - prompt(''): a string to be printed to prompt the user. |
|
2318 | - prompt(''): a string to be printed to prompt the user. | |
2319 |
|
2319 | |||
2320 | - continue_prompt(False): whether this line is the first one or a |
|
2320 | - continue_prompt(False): whether this line is the first one or a | |
2321 | continuation in a sequence of inputs. |
|
2321 | continuation in a sequence of inputs. | |
2322 | """ |
|
2322 | """ | |
2323 |
|
2323 | |||
2324 | # Code run by the user may have modified the readline completer state. |
|
2324 | # Code run by the user may have modified the readline completer state. | |
2325 | # We must ensure that our completer is back in place. |
|
2325 | # We must ensure that our completer is back in place. | |
2326 | if self.has_readline: |
|
2326 | if self.has_readline: | |
2327 | self.set_completer() |
|
2327 | self.set_completer() | |
2328 |
|
2328 | |||
2329 | try: |
|
2329 | try: | |
2330 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2330 | line = raw_input_original(prompt).decode(self.stdin_encoding) | |
2331 | except ValueError: |
|
2331 | except ValueError: | |
2332 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2332 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" | |
2333 | " or sys.stdout.close()!\nExiting IPython!") |
|
2333 | " or sys.stdout.close()!\nExiting IPython!") | |
2334 | self.ask_exit() |
|
2334 | self.ask_exit() | |
2335 | return "" |
|
2335 | return "" | |
2336 |
|
2336 | |||
2337 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2337 | # Try to be reasonably smart about not re-indenting pasted input more | |
2338 | # than necessary. We do this by trimming out the auto-indent initial |
|
2338 | # than necessary. We do this by trimming out the auto-indent initial | |
2339 | # spaces, if the user's actual input started itself with whitespace. |
|
2339 | # spaces, if the user's actual input started itself with whitespace. | |
2340 | #debugx('self.buffer[-1]') |
|
2340 | #debugx('self.buffer[-1]') | |
2341 |
|
2341 | |||
2342 | if self.autoindent: |
|
2342 | if self.autoindent: | |
2343 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2343 | if num_ini_spaces(line) > self.indent_current_nsp: | |
2344 | line = line[self.indent_current_nsp:] |
|
2344 | line = line[self.indent_current_nsp:] | |
2345 | self.indent_current_nsp = 0 |
|
2345 | self.indent_current_nsp = 0 | |
2346 |
|
2346 | |||
2347 | # store the unfiltered input before the user has any chance to modify |
|
2347 | # store the unfiltered input before the user has any chance to modify | |
2348 | # it. |
|
2348 | # it. | |
2349 | if line.strip(): |
|
2349 | if line.strip(): | |
2350 | if continue_prompt: |
|
2350 | if continue_prompt: | |
2351 | self.input_hist_raw[-1] += '%s\n' % line |
|
2351 | self.input_hist_raw[-1] += '%s\n' % line | |
2352 | if self.has_readline: # and some config option is set? |
|
2352 | if self.has_readline: # and some config option is set? | |
2353 | try: |
|
2353 | try: | |
2354 | histlen = self.readline.get_current_history_length() |
|
2354 | histlen = self.readline.get_current_history_length() | |
2355 | if histlen > 1: |
|
2355 | if histlen > 1: | |
2356 | newhist = self.input_hist_raw[-1].rstrip() |
|
2356 | newhist = self.input_hist_raw[-1].rstrip() | |
2357 | self.readline.remove_history_item(histlen-1) |
|
2357 | self.readline.remove_history_item(histlen-1) | |
2358 | self.readline.replace_history_item(histlen-2, |
|
2358 | self.readline.replace_history_item(histlen-2, | |
2359 | newhist.encode(self.stdin_encoding)) |
|
2359 | newhist.encode(self.stdin_encoding)) | |
2360 | except AttributeError: |
|
2360 | except AttributeError: | |
2361 | pass # re{move,place}_history_item are new in 2.4. |
|
2361 | pass # re{move,place}_history_item are new in 2.4. | |
2362 | else: |
|
2362 | else: | |
2363 | self.input_hist_raw.append('%s\n' % line) |
|
2363 | self.input_hist_raw.append('%s\n' % line) | |
2364 | # only entries starting at first column go to shadow history |
|
2364 | # only entries starting at first column go to shadow history | |
2365 | if line.lstrip() == line: |
|
2365 | if line.lstrip() == line: | |
2366 | self.shadowhist.add(line.strip()) |
|
2366 | self.shadowhist.add(line.strip()) | |
2367 | elif not continue_prompt: |
|
2367 | elif not continue_prompt: | |
2368 | self.input_hist_raw.append('\n') |
|
2368 | self.input_hist_raw.append('\n') | |
2369 | try: |
|
2369 | try: | |
2370 | lineout = self.prefilter(line,continue_prompt) |
|
2370 | lineout = self.prefilter(line,continue_prompt) | |
2371 | except: |
|
2371 | except: | |
2372 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2372 | # blanket except, in case a user-defined prefilter crashes, so it | |
2373 | # can't take all of ipython with it. |
|
2373 | # can't take all of ipython with it. | |
2374 | self.showtraceback() |
|
2374 | self.showtraceback() | |
2375 | return '' |
|
2375 | return '' | |
2376 | else: |
|
2376 | else: | |
2377 | return lineout |
|
2377 | return lineout | |
2378 |
|
2378 | |||
2379 | def _prefilter(self, line, continue_prompt): |
|
2379 | def _prefilter(self, line, continue_prompt): | |
2380 | """Calls different preprocessors, depending on the form of line.""" |
|
2380 | """Calls different preprocessors, depending on the form of line.""" | |
2381 |
|
2381 | |||
2382 | # All handlers *must* return a value, even if it's blank (''). |
|
2382 | # All handlers *must* return a value, even if it's blank (''). | |
2383 |
|
2383 | |||
2384 | # Lines are NOT logged here. Handlers should process the line as |
|
2384 | # Lines are NOT logged here. Handlers should process the line as | |
2385 | # needed, update the cache AND log it (so that the input cache array |
|
2385 | # needed, update the cache AND log it (so that the input cache array | |
2386 | # stays synced). |
|
2386 | # stays synced). | |
2387 |
|
2387 | |||
2388 | #..................................................................... |
|
2388 | #..................................................................... | |
2389 | # Code begins |
|
2389 | # Code begins | |
2390 |
|
2390 | |||
2391 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg |
|
2391 | #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg | |
2392 |
|
2392 | |||
2393 | # save the line away in case we crash, so the post-mortem handler can |
|
2393 | # save the line away in case we crash, so the post-mortem handler can | |
2394 | # record it |
|
2394 | # record it | |
2395 | self._last_input_line = line |
|
2395 | self._last_input_line = line | |
2396 |
|
2396 | |||
2397 | #print '***line: <%s>' % line # dbg |
|
2397 | #print '***line: <%s>' % line # dbg | |
2398 |
|
2398 | |||
2399 | if not line: |
|
2399 | if not line: | |
2400 | # Return immediately on purely empty lines, so that if the user |
|
2400 | # Return immediately on purely empty lines, so that if the user | |
2401 | # previously typed some whitespace that started a continuation |
|
2401 | # previously typed some whitespace that started a continuation | |
2402 | # prompt, he can break out of that loop with just an empty line. |
|
2402 | # prompt, he can break out of that loop with just an empty line. | |
2403 | # This is how the default python prompt works. |
|
2403 | # This is how the default python prompt works. | |
2404 |
|
2404 | |||
2405 | # Only return if the accumulated input buffer was just whitespace! |
|
2405 | # Only return if the accumulated input buffer was just whitespace! | |
2406 | if ''.join(self.buffer).isspace(): |
|
2406 | if ''.join(self.buffer).isspace(): | |
2407 | self.buffer[:] = [] |
|
2407 | self.buffer[:] = [] | |
2408 | return '' |
|
2408 | return '' | |
2409 |
|
2409 | |||
2410 | line_info = prefilter.LineInfo(line, continue_prompt) |
|
2410 | line_info = prefilter.LineInfo(line, continue_prompt) | |
2411 |
|
2411 | |||
2412 | # the input history needs to track even empty lines |
|
2412 | # the input history needs to track even empty lines | |
2413 | stripped = line.strip() |
|
2413 | stripped = line.strip() | |
2414 |
|
2414 | |||
2415 | if not stripped: |
|
2415 | if not stripped: | |
2416 | if not continue_prompt: |
|
2416 | if not continue_prompt: | |
2417 | self.outputcache.prompt_count -= 1 |
|
2417 | self.outputcache.prompt_count -= 1 | |
2418 | return self.handle_normal(line_info) |
|
2418 | return self.handle_normal(line_info) | |
2419 |
|
2419 | |||
2420 | # print '***cont',continue_prompt # dbg |
|
2420 | # print '***cont',continue_prompt # dbg | |
2421 | # special handlers are only allowed for single line statements |
|
2421 | # special handlers are only allowed for single line statements | |
2422 | if continue_prompt and not self.rc.multi_line_specials: |
|
2422 | if continue_prompt and not self.rc.multi_line_specials: | |
2423 | return self.handle_normal(line_info) |
|
2423 | return self.handle_normal(line_info) | |
2424 |
|
2424 | |||
2425 |
|
2425 | |||
2426 | # See whether any pre-existing handler can take care of it |
|
2426 | # See whether any pre-existing handler can take care of it | |
2427 | rewritten = self.hooks.input_prefilter(stripped) |
|
2427 | rewritten = self.hooks.input_prefilter(stripped) | |
2428 | if rewritten != stripped: # ok, some prefilter did something |
|
2428 | if rewritten != stripped: # ok, some prefilter did something | |
2429 | rewritten = line_info.pre + rewritten # add indentation |
|
2429 | rewritten = line_info.pre + rewritten # add indentation | |
2430 | return self.handle_normal(prefilter.LineInfo(rewritten, |
|
2430 | return self.handle_normal(prefilter.LineInfo(rewritten, | |
2431 | continue_prompt)) |
|
2431 | continue_prompt)) | |
2432 |
|
2432 | |||
2433 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2433 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2434 |
|
2434 | |||
2435 | return prefilter.prefilter(line_info, self) |
|
2435 | return prefilter.prefilter(line_info, self) | |
2436 |
|
2436 | |||
2437 |
|
2437 | |||
2438 | def _prefilter_dumb(self, line, continue_prompt): |
|
2438 | def _prefilter_dumb(self, line, continue_prompt): | |
2439 | """simple prefilter function, for debugging""" |
|
2439 | """simple prefilter function, for debugging""" | |
2440 | return self.handle_normal(line,continue_prompt) |
|
2440 | return self.handle_normal(line,continue_prompt) | |
2441 |
|
2441 | |||
2442 |
|
2442 | |||
2443 | def multiline_prefilter(self, line, continue_prompt): |
|
2443 | def multiline_prefilter(self, line, continue_prompt): | |
2444 | """ Run _prefilter for each line of input |
|
2444 | """ Run _prefilter for each line of input | |
2445 |
|
2445 | |||
2446 | Covers cases where there are multiple lines in the user entry, |
|
2446 | Covers cases where there are multiple lines in the user entry, | |
2447 | which is the case when the user goes back to a multiline history |
|
2447 | which is the case when the user goes back to a multiline history | |
2448 | entry and presses enter. |
|
2448 | entry and presses enter. | |
2449 |
|
2449 | |||
2450 | """ |
|
2450 | """ | |
2451 | out = [] |
|
2451 | out = [] | |
2452 | for l in line.rstrip('\n').split('\n'): |
|
2452 | for l in line.rstrip('\n').split('\n'): | |
2453 | out.append(self._prefilter(l, continue_prompt)) |
|
2453 | out.append(self._prefilter(l, continue_prompt)) | |
2454 | return '\n'.join(out) |
|
2454 | return '\n'.join(out) | |
2455 |
|
2455 | |||
2456 | # Set the default prefilter() function (this can be user-overridden) |
|
2456 | # Set the default prefilter() function (this can be user-overridden) | |
2457 | prefilter = multiline_prefilter |
|
2457 | prefilter = multiline_prefilter | |
2458 |
|
2458 | |||
2459 | def handle_normal(self,line_info): |
|
2459 | def handle_normal(self,line_info): | |
2460 | """Handle normal input lines. Use as a template for handlers.""" |
|
2460 | """Handle normal input lines. Use as a template for handlers.""" | |
2461 |
|
2461 | |||
2462 | # With autoindent on, we need some way to exit the input loop, and I |
|
2462 | # With autoindent on, we need some way to exit the input loop, and I | |
2463 | # don't want to force the user to have to backspace all the way to |
|
2463 | # don't want to force the user to have to backspace all the way to | |
2464 | # clear the line. The rule will be in this case, that either two |
|
2464 | # clear the line. The rule will be in this case, that either two | |
2465 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
2465 | # lines of pure whitespace in a row, or a line of pure whitespace but | |
2466 | # of a size different to the indent level, will exit the input loop. |
|
2466 | # of a size different to the indent level, will exit the input loop. | |
2467 | line = line_info.line |
|
2467 | line = line_info.line | |
2468 | continue_prompt = line_info.continue_prompt |
|
2468 | continue_prompt = line_info.continue_prompt | |
2469 |
|
2469 | |||
2470 | if (continue_prompt and self.autoindent and line.isspace() and |
|
2470 | if (continue_prompt and self.autoindent and line.isspace() and | |
2471 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or |
|
2471 | (0 < abs(len(line) - self.indent_current_nsp) <= 2 or | |
2472 | (self.buffer[-1]).isspace() )): |
|
2472 | (self.buffer[-1]).isspace() )): | |
2473 | line = '' |
|
2473 | line = '' | |
2474 |
|
2474 | |||
2475 | self.log(line,line,continue_prompt) |
|
2475 | self.log(line,line,continue_prompt) | |
2476 | return line |
|
2476 | return line | |
2477 |
|
2477 | |||
2478 | def handle_alias(self,line_info): |
|
2478 | def handle_alias(self,line_info): | |
2479 | """Handle alias input lines. """ |
|
2479 | """Handle alias input lines. """ | |
2480 | tgt = self.alias_table[line_info.iFun] |
|
2480 | tgt = self.alias_table[line_info.iFun] | |
2481 | # print "=>",tgt #dbg |
|
2481 | # print "=>",tgt #dbg | |
2482 | if callable(tgt): |
|
2482 | if callable(tgt): | |
2483 | if '$' in line_info.line: |
|
2483 | if '$' in line_info.line: | |
2484 | call_meth = '(_ip, _ip.itpl(%s))' |
|
2484 | call_meth = '(_ip, _ip.itpl(%s))' | |
2485 | else: |
|
2485 | else: | |
2486 | call_meth = '(_ip,%s)' |
|
2486 | call_meth = '(_ip,%s)' | |
2487 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, |
|
2487 | line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace, | |
2488 | line_info.iFun, |
|
2488 | line_info.iFun, | |
2489 | make_quoted_expr(line_info.line)) |
|
2489 | make_quoted_expr(line_info.line)) | |
2490 | else: |
|
2490 | else: | |
2491 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) |
|
2491 | transformed = self.expand_aliases(line_info.iFun,line_info.theRest) | |
2492 |
|
2492 | |||
2493 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
2493 | # pre is needed, because it carries the leading whitespace. Otherwise | |
2494 | # aliases won't work in indented sections. |
|
2494 | # aliases won't work in indented sections. | |
2495 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2495 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2496 | make_quoted_expr( transformed )) |
|
2496 | make_quoted_expr( transformed )) | |
2497 |
|
2497 | |||
2498 | self.log(line_info.line,line_out,line_info.continue_prompt) |
|
2498 | self.log(line_info.line,line_out,line_info.continue_prompt) | |
2499 | #print 'line out:',line_out # dbg |
|
2499 | #print 'line out:',line_out # dbg | |
2500 | return line_out |
|
2500 | return line_out | |
2501 |
|
2501 | |||
2502 | def handle_shell_escape(self, line_info): |
|
2502 | def handle_shell_escape(self, line_info): | |
2503 | """Execute the line in a shell, empty return value""" |
|
2503 | """Execute the line in a shell, empty return value""" | |
2504 | #print 'line in :', `line` # dbg |
|
2504 | #print 'line in :', `line` # dbg | |
2505 | line = line_info.line |
|
2505 | line = line_info.line | |
2506 | if line.lstrip().startswith('!!'): |
|
2506 | if line.lstrip().startswith('!!'): | |
2507 | # rewrite LineInfo's line, iFun and theRest to properly hold the |
|
2507 | # rewrite LineInfo's line, iFun and theRest to properly hold the | |
2508 | # call to %sx and the actual command to be executed, so |
|
2508 | # call to %sx and the actual command to be executed, so | |
2509 | # handle_magic can work correctly. Note that this works even if |
|
2509 | # handle_magic can work correctly. Note that this works even if | |
2510 | # the line is indented, so it handles multi_line_specials |
|
2510 | # the line is indented, so it handles multi_line_specials | |
2511 | # properly. |
|
2511 | # properly. | |
2512 | new_rest = line.lstrip()[2:] |
|
2512 | new_rest = line.lstrip()[2:] | |
2513 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) |
|
2513 | line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest) | |
2514 | line_info.iFun = 'sx' |
|
2514 | line_info.iFun = 'sx' | |
2515 | line_info.theRest = new_rest |
|
2515 | line_info.theRest = new_rest | |
2516 | return self.handle_magic(line_info) |
|
2516 | return self.handle_magic(line_info) | |
2517 | else: |
|
2517 | else: | |
2518 | cmd = line.lstrip().lstrip('!') |
|
2518 | cmd = line.lstrip().lstrip('!') | |
2519 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, |
|
2519 | line_out = '%s_ip.system(%s)' % (line_info.preWhitespace, | |
2520 | make_quoted_expr(cmd)) |
|
2520 | make_quoted_expr(cmd)) | |
2521 | # update cache/log and return |
|
2521 | # update cache/log and return | |
2522 | self.log(line,line_out,line_info.continue_prompt) |
|
2522 | self.log(line,line_out,line_info.continue_prompt) | |
2523 | return line_out |
|
2523 | return line_out | |
2524 |
|
2524 | |||
2525 | def handle_magic(self, line_info): |
|
2525 | def handle_magic(self, line_info): | |
2526 | """Execute magic functions.""" |
|
2526 | """Execute magic functions.""" | |
2527 | iFun = line_info.iFun |
|
2527 | iFun = line_info.iFun | |
2528 | theRest = line_info.theRest |
|
2528 | theRest = line_info.theRest | |
2529 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, |
|
2529 | cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace, | |
2530 | make_quoted_expr(iFun + " " + theRest)) |
|
2530 | make_quoted_expr(iFun + " " + theRest)) | |
2531 | self.log(line_info.line,cmd,line_info.continue_prompt) |
|
2531 | self.log(line_info.line,cmd,line_info.continue_prompt) | |
2532 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg |
|
2532 | #print 'in handle_magic, cmd=<%s>' % cmd # dbg | |
2533 | return cmd |
|
2533 | return cmd | |
2534 |
|
2534 | |||
2535 | def handle_auto(self, line_info): |
|
2535 | def handle_auto(self, line_info): | |
2536 | """Hande lines which can be auto-executed, quoting if requested.""" |
|
2536 | """Hande lines which can be auto-executed, quoting if requested.""" | |
2537 |
|
2537 | |||
2538 | line = line_info.line |
|
2538 | line = line_info.line | |
2539 | iFun = line_info.iFun |
|
2539 | iFun = line_info.iFun | |
2540 | theRest = line_info.theRest |
|
2540 | theRest = line_info.theRest | |
2541 | pre = line_info.pre |
|
2541 | pre = line_info.pre | |
2542 | continue_prompt = line_info.continue_prompt |
|
2542 | continue_prompt = line_info.continue_prompt | |
2543 | obj = line_info.ofind(self)['obj'] |
|
2543 | obj = line_info.ofind(self)['obj'] | |
2544 |
|
2544 | |||
2545 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg |
|
2545 | #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg | |
2546 |
|
2546 | |||
2547 | # This should only be active for single-line input! |
|
2547 | # This should only be active for single-line input! | |
2548 | if continue_prompt: |
|
2548 | if continue_prompt: | |
2549 | self.log(line,line,continue_prompt) |
|
2549 | self.log(line,line,continue_prompt) | |
2550 | return line |
|
2550 | return line | |
2551 |
|
2551 | |||
2552 | force_auto = isinstance(obj, ipapi.IPyAutocall) |
|
2552 | force_auto = isinstance(obj, ipapi.IPyAutocall) | |
2553 | auto_rewrite = True |
|
2553 | auto_rewrite = True | |
2554 |
|
2554 | |||
2555 | if pre == self.ESC_QUOTE: |
|
2555 | if pre == self.ESC_QUOTE: | |
2556 | # Auto-quote splitting on whitespace |
|
2556 | # Auto-quote splitting on whitespace | |
2557 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) |
|
2557 | newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) ) | |
2558 | elif pre == self.ESC_QUOTE2: |
|
2558 | elif pre == self.ESC_QUOTE2: | |
2559 | # Auto-quote whole string |
|
2559 | # Auto-quote whole string | |
2560 | newcmd = '%s("%s")' % (iFun,theRest) |
|
2560 | newcmd = '%s("%s")' % (iFun,theRest) | |
2561 | elif pre == self.ESC_PAREN: |
|
2561 | elif pre == self.ESC_PAREN: | |
2562 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) |
|
2562 | newcmd = '%s(%s)' % (iFun,",".join(theRest.split())) | |
2563 | else: |
|
2563 | else: | |
2564 | # Auto-paren. |
|
2564 | # Auto-paren. | |
2565 | # We only apply it to argument-less calls if the autocall |
|
2565 | # We only apply it to argument-less calls if the autocall | |
2566 | # parameter is set to 2. We only need to check that autocall is < |
|
2566 | # parameter is set to 2. We only need to check that autocall is < | |
2567 | # 2, since this function isn't called unless it's at least 1. |
|
2567 | # 2, since this function isn't called unless it's at least 1. | |
2568 | if not theRest and (self.rc.autocall < 2) and not force_auto: |
|
2568 | if not theRest and (self.rc.autocall < 2) and not force_auto: | |
2569 | newcmd = '%s %s' % (iFun,theRest) |
|
2569 | newcmd = '%s %s' % (iFun,theRest) | |
2570 | auto_rewrite = False |
|
2570 | auto_rewrite = False | |
2571 | else: |
|
2571 | else: | |
2572 | if not force_auto and theRest.startswith('['): |
|
2572 | if not force_auto and theRest.startswith('['): | |
2573 | if hasattr(obj,'__getitem__'): |
|
2573 | if hasattr(obj,'__getitem__'): | |
2574 | # Don't autocall in this case: item access for an object |
|
2574 | # Don't autocall in this case: item access for an object | |
2575 | # which is BOTH callable and implements __getitem__. |
|
2575 | # which is BOTH callable and implements __getitem__. | |
2576 | newcmd = '%s %s' % (iFun,theRest) |
|
2576 | newcmd = '%s %s' % (iFun,theRest) | |
2577 | auto_rewrite = False |
|
2577 | auto_rewrite = False | |
2578 | else: |
|
2578 | else: | |
2579 | # if the object doesn't support [] access, go ahead and |
|
2579 | # if the object doesn't support [] access, go ahead and | |
2580 | # autocall |
|
2580 | # autocall | |
2581 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) |
|
2581 | newcmd = '%s(%s)' % (iFun.rstrip(),theRest) | |
2582 | elif theRest.endswith(';'): |
|
2582 | elif theRest.endswith(';'): | |
2583 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) |
|
2583 | newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1]) | |
2584 | else: |
|
2584 | else: | |
2585 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) |
|
2585 | newcmd = '%s(%s)' % (iFun.rstrip(), theRest) | |
2586 |
|
2586 | |||
2587 | if auto_rewrite: |
|
2587 | if auto_rewrite: | |
2588 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd |
|
2588 | rw = self.outputcache.prompt1.auto_rewrite() + newcmd | |
2589 |
|
2589 | |||
2590 | try: |
|
2590 | try: | |
2591 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2591 | # plain ascii works better w/ pyreadline, on some machines, so | |
2592 | # we use it and only print uncolored rewrite if we have unicode |
|
2592 | # we use it and only print uncolored rewrite if we have unicode | |
2593 | rw = str(rw) |
|
2593 | rw = str(rw) | |
2594 | print >>Term.cout, rw |
|
2594 | print >>Term.cout, rw | |
2595 | except UnicodeEncodeError: |
|
2595 | except UnicodeEncodeError: | |
2596 | print "-------------->" + newcmd |
|
2596 | print "-------------->" + newcmd | |
2597 |
|
2597 | |||
2598 | # log what is now valid Python, not the actual user input (without the |
|
2598 | # log what is now valid Python, not the actual user input (without the | |
2599 | # final newline) |
|
2599 | # final newline) | |
2600 | self.log(line,newcmd,continue_prompt) |
|
2600 | self.log(line,newcmd,continue_prompt) | |
2601 | return newcmd |
|
2601 | return newcmd | |
2602 |
|
2602 | |||
2603 | def handle_help(self, line_info): |
|
2603 | def handle_help(self, line_info): | |
2604 | """Try to get some help for the object. |
|
2604 | """Try to get some help for the object. | |
2605 |
|
2605 | |||
2606 | obj? or ?obj -> basic information. |
|
2606 | obj? or ?obj -> basic information. | |
2607 | obj?? or ??obj -> more details. |
|
2607 | obj?? or ??obj -> more details. | |
2608 | """ |
|
2608 | """ | |
2609 |
|
2609 | |||
2610 | line = line_info.line |
|
2610 | line = line_info.line | |
2611 | # We need to make sure that we don't process lines which would be |
|
2611 | # We need to make sure that we don't process lines which would be | |
2612 | # otherwise valid python, such as "x=1 # what?" |
|
2612 | # otherwise valid python, such as "x=1 # what?" | |
2613 | try: |
|
2613 | try: | |
2614 | codeop.compile_command(line) |
|
2614 | codeop.compile_command(line) | |
2615 | except SyntaxError: |
|
2615 | except SyntaxError: | |
2616 | # We should only handle as help stuff which is NOT valid syntax |
|
2616 | # We should only handle as help stuff which is NOT valid syntax | |
2617 | if line[0]==self.ESC_HELP: |
|
2617 | if line[0]==self.ESC_HELP: | |
2618 | line = line[1:] |
|
2618 | line = line[1:] | |
2619 | elif line[-1]==self.ESC_HELP: |
|
2619 | elif line[-1]==self.ESC_HELP: | |
2620 | line = line[:-1] |
|
2620 | line = line[:-1] | |
2621 | self.log(line,'#?'+line,line_info.continue_prompt) |
|
2621 | self.log(line,'#?'+line,line_info.continue_prompt) | |
2622 | if line: |
|
2622 | if line: | |
2623 | #print 'line:<%r>' % line # dbg |
|
2623 | #print 'line:<%r>' % line # dbg | |
2624 | self.magic_pinfo(line) |
|
2624 | self.magic_pinfo(line) | |
2625 | else: |
|
2625 | else: | |
2626 | page(self.usage,screen_lines=self.rc.screen_length) |
|
2626 | page(self.usage,screen_lines=self.rc.screen_length) | |
2627 | return '' # Empty string is needed here! |
|
2627 | return '' # Empty string is needed here! | |
2628 | except: |
|
2628 | except: | |
2629 | # Pass any other exceptions through to the normal handler |
|
2629 | # Pass any other exceptions through to the normal handler | |
2630 | return self.handle_normal(line_info) |
|
2630 | return self.handle_normal(line_info) | |
2631 | else: |
|
2631 | else: | |
2632 | # If the code compiles ok, we should handle it normally |
|
2632 | # If the code compiles ok, we should handle it normally | |
2633 | return self.handle_normal(line_info) |
|
2633 | return self.handle_normal(line_info) | |
2634 |
|
2634 | |||
2635 | def getapi(self): |
|
2635 | def getapi(self): | |
2636 | """ Get an IPApi object for this shell instance |
|
2636 | """ Get an IPApi object for this shell instance | |
2637 |
|
2637 | |||
2638 | Getting an IPApi object is always preferable to accessing the shell |
|
2638 | Getting an IPApi object is always preferable to accessing the shell | |
2639 | directly, but this holds true especially for extensions. |
|
2639 | directly, but this holds true especially for extensions. | |
2640 |
|
2640 | |||
2641 | It should always be possible to implement an extension with IPApi |
|
2641 | It should always be possible to implement an extension with IPApi | |
2642 | alone. If not, contact maintainer to request an addition. |
|
2642 | alone. If not, contact maintainer to request an addition. | |
2643 |
|
2643 | |||
2644 | """ |
|
2644 | """ | |
2645 | return self.api |
|
2645 | return self.api | |
2646 |
|
2646 | |||
2647 | def handle_emacs(self, line_info): |
|
2647 | def handle_emacs(self, line_info): | |
2648 | """Handle input lines marked by python-mode.""" |
|
2648 | """Handle input lines marked by python-mode.""" | |
2649 |
|
2649 | |||
2650 | # Currently, nothing is done. Later more functionality can be added |
|
2650 | # Currently, nothing is done. Later more functionality can be added | |
2651 | # here if needed. |
|
2651 | # here if needed. | |
2652 |
|
2652 | |||
2653 | # The input cache shouldn't be updated |
|
2653 | # The input cache shouldn't be updated | |
2654 | return line_info.line |
|
2654 | return line_info.line | |
2655 |
|
2655 | |||
2656 |
|
2656 | |||
2657 | def mktempfile(self,data=None): |
|
2657 | def mktempfile(self,data=None): | |
2658 | """Make a new tempfile and return its filename. |
|
2658 | """Make a new tempfile and return its filename. | |
2659 |
|
2659 | |||
2660 | This makes a call to tempfile.mktemp, but it registers the created |
|
2660 | This makes a call to tempfile.mktemp, but it registers the created | |
2661 | filename internally so ipython cleans it up at exit time. |
|
2661 | filename internally so ipython cleans it up at exit time. | |
2662 |
|
2662 | |||
2663 | Optional inputs: |
|
2663 | Optional inputs: | |
2664 |
|
2664 | |||
2665 | - data(None): if data is given, it gets written out to the temp file |
|
2665 | - data(None): if data is given, it gets written out to the temp file | |
2666 | immediately, and the file is closed again.""" |
|
2666 | immediately, and the file is closed again.""" | |
2667 |
|
2667 | |||
2668 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2668 | filename = tempfile.mktemp('.py','ipython_edit_') | |
2669 | self.tempfiles.append(filename) |
|
2669 | self.tempfiles.append(filename) | |
2670 |
|
2670 | |||
2671 | if data: |
|
2671 | if data: | |
2672 | tmp_file = open(filename,'w') |
|
2672 | tmp_file = open(filename,'w') | |
2673 | tmp_file.write(data) |
|
2673 | tmp_file.write(data) | |
2674 | tmp_file.close() |
|
2674 | tmp_file.close() | |
2675 | return filename |
|
2675 | return filename | |
2676 |
|
2676 | |||
2677 | def write(self,data): |
|
2677 | def write(self,data): | |
2678 | """Write a string to the default output""" |
|
2678 | """Write a string to the default output""" | |
2679 | Term.cout.write(data) |
|
2679 | Term.cout.write(data) | |
2680 |
|
2680 | |||
2681 | def write_err(self,data): |
|
2681 | def write_err(self,data): | |
2682 | """Write a string to the default error output""" |
|
2682 | """Write a string to the default error output""" | |
2683 | Term.cerr.write(data) |
|
2683 | Term.cerr.write(data) | |
2684 |
|
2684 | |||
2685 | def ask_exit(self): |
|
2685 | def ask_exit(self): | |
2686 | """ Call for exiting. Can be overiden and used as a callback. """ |
|
2686 | """ Call for exiting. Can be overiden and used as a callback. """ | |
2687 | self.exit_now = True |
|
2687 | self.exit_now = True | |
2688 |
|
2688 | |||
2689 | def exit(self): |
|
2689 | def exit(self): | |
2690 | """Handle interactive exit. |
|
2690 | """Handle interactive exit. | |
2691 |
|
2691 | |||
2692 | This method calls the ask_exit callback.""" |
|
2692 | This method calls the ask_exit callback.""" | |
2693 |
|
2693 | |||
2694 | if self.rc.confirm_exit: |
|
2694 | if self.rc.confirm_exit: | |
2695 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2695 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): | |
2696 | self.ask_exit() |
|
2696 | self.ask_exit() | |
2697 | else: |
|
2697 | else: | |
2698 | self.ask_exit() |
|
2698 | self.ask_exit() | |
2699 |
|
2699 | |||
2700 | def safe_execfile(self,fname,*where,**kw): |
|
2700 | def safe_execfile(self,fname,*where,**kw): | |
2701 | """A safe version of the builtin execfile(). |
|
2701 | """A safe version of the builtin execfile(). | |
2702 |
|
2702 | |||
2703 | This version will never throw an exception, and knows how to handle |
|
2703 | This version will never throw an exception, and knows how to handle | |
2704 | ipython logs as well. |
|
2704 | ipython logs as well. | |
2705 |
|
2705 | |||
2706 | :Parameters: |
|
2706 | :Parameters: | |
2707 | fname : string |
|
2707 | fname : string | |
2708 | Name of the file to be executed. |
|
2708 | Name of the file to be executed. | |
2709 |
|
2709 | |||
2710 | where : tuple |
|
2710 | where : tuple | |
2711 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2711 | One or two namespaces, passed to execfile() as (globals,locals). | |
2712 | If only one is given, it is passed as both. |
|
2712 | If only one is given, it is passed as both. | |
2713 |
|
2713 | |||
2714 | :Keywords: |
|
2714 | :Keywords: | |
2715 | islog : boolean (False) |
|
2715 | islog : boolean (False) | |
2716 |
|
2716 | |||
2717 | quiet : boolean (True) |
|
2717 | quiet : boolean (True) | |
2718 |
|
2718 | |||
2719 | exit_ignore : boolean (False) |
|
2719 | exit_ignore : boolean (False) | |
2720 | """ |
|
2720 | """ | |
2721 |
|
2721 | |||
2722 | def syspath_cleanup(): |
|
2722 | def syspath_cleanup(): | |
2723 | """Internal cleanup routine for sys.path.""" |
|
2723 | """Internal cleanup routine for sys.path.""" | |
2724 | if add_dname: |
|
2724 | if add_dname: | |
2725 | try: |
|
2725 | try: | |
2726 | sys.path.remove(dname) |
|
2726 | sys.path.remove(dname) | |
2727 | except ValueError: |
|
2727 | except ValueError: | |
2728 | # For some reason the user has already removed it, ignore. |
|
2728 | # For some reason the user has already removed it, ignore. | |
2729 | pass |
|
2729 | pass | |
2730 |
|
2730 | |||
2731 | fname = os.path.expanduser(fname) |
|
2731 | fname = os.path.expanduser(fname) | |
2732 |
|
2732 | |||
2733 | # Find things also in current directory. This is needed to mimic the |
|
2733 | # Find things also in current directory. This is needed to mimic the | |
2734 | # behavior of running a script from the system command line, where |
|
2734 | # behavior of running a script from the system command line, where | |
2735 | # Python inserts the script's directory into sys.path |
|
2735 | # Python inserts the script's directory into sys.path | |
2736 | dname = os.path.dirname(os.path.abspath(fname)) |
|
2736 | dname = os.path.dirname(os.path.abspath(fname)) | |
2737 | add_dname = False |
|
2737 | add_dname = False | |
2738 | if dname not in sys.path: |
|
2738 | if dname not in sys.path: | |
2739 | sys.path.insert(0,dname) |
|
2739 | sys.path.insert(0,dname) | |
2740 | add_dname = True |
|
2740 | add_dname = True | |
2741 |
|
2741 | |||
2742 | try: |
|
2742 | try: | |
2743 | xfile = open(fname) |
|
2743 | xfile = open(fname) | |
2744 | except: |
|
2744 | except: | |
2745 | print >> Term.cerr, \ |
|
2745 | print >> Term.cerr, \ | |
2746 | 'Could not open file <%s> for safe execution.' % fname |
|
2746 | 'Could not open file <%s> for safe execution.' % fname | |
2747 | syspath_cleanup() |
|
2747 | syspath_cleanup() | |
2748 | return None |
|
2748 | return None | |
2749 |
|
2749 | |||
2750 | kw.setdefault('islog',0) |
|
2750 | kw.setdefault('islog',0) | |
2751 | kw.setdefault('quiet',1) |
|
2751 | kw.setdefault('quiet',1) | |
2752 | kw.setdefault('exit_ignore',0) |
|
2752 | kw.setdefault('exit_ignore',0) | |
2753 |
|
2753 | |||
2754 | first = xfile.readline() |
|
2754 | first = xfile.readline() | |
2755 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() |
|
2755 | loghead = str(self.loghead_tpl).split('\n',1)[0].strip() | |
2756 | xfile.close() |
|
2756 | xfile.close() | |
2757 | # line by line execution |
|
2757 | # line by line execution | |
2758 | if first.startswith(loghead) or kw['islog']: |
|
2758 | if first.startswith(loghead) or kw['islog']: | |
2759 | print 'Loading log file <%s> one line at a time...' % fname |
|
2759 | print 'Loading log file <%s> one line at a time...' % fname | |
2760 | if kw['quiet']: |
|
2760 | if kw['quiet']: | |
2761 | stdout_save = sys.stdout |
|
2761 | stdout_save = sys.stdout | |
2762 | sys.stdout = StringIO.StringIO() |
|
2762 | sys.stdout = StringIO.StringIO() | |
2763 | try: |
|
2763 | try: | |
2764 | globs,locs = where[0:2] |
|
2764 | globs,locs = where[0:2] | |
2765 | except: |
|
2765 | except: | |
2766 | try: |
|
2766 | try: | |
2767 | globs = locs = where[0] |
|
2767 | globs = locs = where[0] | |
2768 | except: |
|
2768 | except: | |
2769 | globs = locs = globals() |
|
2769 | globs = locs = globals() | |
2770 | badblocks = [] |
|
2770 | badblocks = [] | |
2771 |
|
2771 | |||
2772 | # we also need to identify indented blocks of code when replaying |
|
2772 | # we also need to identify indented blocks of code when replaying | |
2773 | # logs and put them together before passing them to an exec |
|
2773 | # logs and put them together before passing them to an exec | |
2774 | # statement. This takes a bit of regexp and look-ahead work in the |
|
2774 | # statement. This takes a bit of regexp and look-ahead work in the | |
2775 | # file. It's easiest if we swallow the whole thing in memory |
|
2775 | # file. It's easiest if we swallow the whole thing in memory | |
2776 | # first, and manually walk through the lines list moving the |
|
2776 | # first, and manually walk through the lines list moving the | |
2777 | # counter ourselves. |
|
2777 | # counter ourselves. | |
2778 | indent_re = re.compile('\s+\S') |
|
2778 | indent_re = re.compile('\s+\S') | |
2779 | xfile = open(fname) |
|
2779 | xfile = open(fname) | |
2780 | filelines = xfile.readlines() |
|
2780 | filelines = xfile.readlines() | |
2781 | xfile.close() |
|
2781 | xfile.close() | |
2782 | nlines = len(filelines) |
|
2782 | nlines = len(filelines) | |
2783 | lnum = 0 |
|
2783 | lnum = 0 | |
2784 | while lnum < nlines: |
|
2784 | while lnum < nlines: | |
2785 | line = filelines[lnum] |
|
2785 | line = filelines[lnum] | |
2786 | lnum += 1 |
|
2786 | lnum += 1 | |
2787 | # don't re-insert logger status info into cache |
|
2787 | # don't re-insert logger status info into cache | |
2788 | if line.startswith('#log#'): |
|
2788 | if line.startswith('#log#'): | |
2789 | continue |
|
2789 | continue | |
2790 | else: |
|
2790 | else: | |
2791 | # build a block of code (maybe a single line) for execution |
|
2791 | # build a block of code (maybe a single line) for execution | |
2792 | block = line |
|
2792 | block = line | |
2793 | try: |
|
2793 | try: | |
2794 | next = filelines[lnum] # lnum has already incremented |
|
2794 | next = filelines[lnum] # lnum has already incremented | |
2795 | except: |
|
2795 | except: | |
2796 | next = None |
|
2796 | next = None | |
2797 | while next and indent_re.match(next): |
|
2797 | while next and indent_re.match(next): | |
2798 | block += next |
|
2798 | block += next | |
2799 | lnum += 1 |
|
2799 | lnum += 1 | |
2800 | try: |
|
2800 | try: | |
2801 | next = filelines[lnum] |
|
2801 | next = filelines[lnum] | |
2802 | except: |
|
2802 | except: | |
2803 | next = None |
|
2803 | next = None | |
2804 | # now execute the block of one or more lines |
|
2804 | # now execute the block of one or more lines | |
2805 | try: |
|
2805 | try: | |
2806 | exec block in globs,locs |
|
2806 | exec block in globs,locs | |
2807 | except SystemExit: |
|
2807 | except SystemExit: | |
2808 | pass |
|
2808 | pass | |
2809 | except: |
|
2809 | except: | |
2810 | badblocks.append(block.rstrip()) |
|
2810 | badblocks.append(block.rstrip()) | |
2811 | if kw['quiet']: # restore stdout |
|
2811 | if kw['quiet']: # restore stdout | |
2812 | sys.stdout.close() |
|
2812 | sys.stdout.close() | |
2813 | sys.stdout = stdout_save |
|
2813 | sys.stdout = stdout_save | |
2814 | print 'Finished replaying log file <%s>' % fname |
|
2814 | print 'Finished replaying log file <%s>' % fname | |
2815 | if badblocks: |
|
2815 | if badblocks: | |
2816 | print >> sys.stderr, ('\nThe following lines/blocks in file ' |
|
2816 | print >> sys.stderr, ('\nThe following lines/blocks in file ' | |
2817 | '<%s> reported errors:' % fname) |
|
2817 | '<%s> reported errors:' % fname) | |
2818 |
|
2818 | |||
2819 | for badline in badblocks: |
|
2819 | for badline in badblocks: | |
2820 | print >> sys.stderr, badline |
|
2820 | print >> sys.stderr, badline | |
2821 | else: # regular file execution |
|
2821 | else: # regular file execution | |
2822 | try: |
|
2822 | try: | |
2823 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
2823 | if sys.platform == 'win32' and sys.version_info < (2,5,1): | |
2824 | # Work around a bug in Python for Windows. The bug was |
|
2824 | # Work around a bug in Python for Windows. The bug was | |
2825 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
2825 | # fixed in in Python 2.5 r54159 and 54158, but that's still | |
2826 | # SVN Python as of March/07. For details, see: |
|
2826 | # SVN Python as of March/07. For details, see: | |
2827 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
2827 | # http://projects.scipy.org/ipython/ipython/ticket/123 | |
2828 | try: |
|
2828 | try: | |
2829 | globs,locs = where[0:2] |
|
2829 | globs,locs = where[0:2] | |
2830 | except: |
|
2830 | except: | |
2831 | try: |
|
2831 | try: | |
2832 | globs = locs = where[0] |
|
2832 | globs = locs = where[0] | |
2833 | except: |
|
2833 | except: | |
2834 | globs = locs = globals() |
|
2834 | globs = locs = globals() | |
2835 | exec file(fname) in globs,locs |
|
2835 | exec file(fname) in globs,locs | |
2836 | else: |
|
2836 | else: | |
2837 | execfile(fname,*where) |
|
2837 | execfile(fname,*where) | |
2838 | except SyntaxError: |
|
2838 | except SyntaxError: | |
2839 | self.showsyntaxerror() |
|
2839 | self.showsyntaxerror() | |
2840 | warn('Failure executing file: <%s>' % fname) |
|
2840 | warn('Failure executing file: <%s>' % fname) | |
2841 | except SystemExit,status: |
|
2841 | except SystemExit,status: | |
2842 | # Code that correctly sets the exit status flag to success (0) |
|
2842 | # Code that correctly sets the exit status flag to success (0) | |
2843 | # shouldn't be bothered with a traceback. Note that a plain |
|
2843 | # shouldn't be bothered with a traceback. Note that a plain | |
2844 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
2844 | # sys.exit() does NOT set the message to 0 (it's empty) so that | |
2845 | # will still get a traceback. Note that the structure of the |
|
2845 | # will still get a traceback. Note that the structure of the | |
2846 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
2846 | # SystemExit exception changed between Python 2.4 and 2.5, so | |
2847 | # the checks must be done in a version-dependent way. |
|
2847 | # the checks must be done in a version-dependent way. | |
2848 | show = False |
|
2848 | show = False | |
2849 |
|
2849 | |||
2850 | if sys.version_info[:2] > (2,5): |
|
2850 | if sys.version_info[:2] > (2,5): | |
2851 | if status.message!=0 and not kw['exit_ignore']: |
|
2851 | if status.message!=0 and not kw['exit_ignore']: | |
2852 | show = True |
|
2852 | show = True | |
2853 | else: |
|
2853 | else: | |
2854 | if status.code and not kw['exit_ignore']: |
|
2854 | if status.code and not kw['exit_ignore']: | |
2855 | show = True |
|
2855 | show = True | |
2856 | if show: |
|
2856 | if show: | |
2857 | self.showtraceback() |
|
2857 | self.showtraceback() | |
2858 | warn('Failure executing file: <%s>' % fname) |
|
2858 | warn('Failure executing file: <%s>' % fname) | |
2859 | except: |
|
2859 | except: | |
2860 | self.showtraceback() |
|
2860 | self.showtraceback() | |
2861 | warn('Failure executing file: <%s>' % fname) |
|
2861 | warn('Failure executing file: <%s>' % fname) | |
2862 |
|
2862 | |||
2863 | syspath_cleanup() |
|
2863 | syspath_cleanup() | |
2864 |
|
2864 | |||
2865 | #************************* end of file <iplib.py> ***************************** |
|
2865 | #************************* end of file <iplib.py> ***************************** |
@@ -1,771 +1,771 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | IPython -- An enhanced Interactive Python |
|
3 | IPython -- An enhanced Interactive Python | |
4 |
|
4 | |||
5 | Requires Python 2.1 or better. |
|
5 | Requires Python 2.1 or better. | |
6 |
|
6 | |||
7 | This file contains the main make_IPython() starter function. |
|
7 | This file contains the main make_IPython() starter function. | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | #***************************************************************************** |
|
10 | #***************************************************************************** | |
11 | # Copyright (C) 2008-2009 The IPython Development Team |
|
11 | # Copyright (C) 2008-2009 The IPython Development Team | |
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
12 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
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 | try: |
|
18 | try: | |
19 | credits._Printer__data = """ |
|
19 | credits._Printer__data = """ | |
20 | Python: %s |
|
20 | Python: %s | |
21 |
|
21 | |||
22 | IPython: The IPython Development Team. |
|
22 | IPython: The IPython Development Team. | |
23 | See http://ipython.scipy.org for more information.""" \ |
|
23 | See http://ipython.scipy.org for more information.""" \ | |
24 | % credits._Printer__data |
|
24 | % credits._Printer__data | |
25 |
|
25 | |||
26 | copyright._Printer__data += """ |
|
26 | copyright._Printer__data += """ | |
27 |
|
27 | |||
28 | Copyright (c) 2008-2009 The IPython Development Team. |
|
28 | Copyright (c) 2008-2009 The IPython Development Team. | |
29 | Copyright (c) 2001-2007 Fernando Perez, Janko Hauser, Nathan Gray. |
|
29 | Copyright (c) 2001-2007 Fernando Perez, Janko Hauser, Nathan Gray. | |
30 | All Rights Reserved.""" |
|
30 | All Rights Reserved.""" | |
31 | except NameError: |
|
31 | except NameError: | |
32 | # Can happen if ipython was started with 'python -S', so that site.py is |
|
32 | # Can happen if ipython was started with 'python -S', so that site.py is | |
33 | # not loaded |
|
33 | # not loaded | |
34 | pass |
|
34 | pass | |
35 |
|
35 | |||
36 | #**************************************************************************** |
|
36 | #**************************************************************************** | |
37 | # Required modules |
|
37 | # Required modules | |
38 |
|
38 | |||
39 | # From the standard library |
|
39 | # From the standard library | |
40 | import __main__ |
|
40 | import __main__ | |
41 | import __builtin__ |
|
41 | import __builtin__ | |
42 | import os |
|
42 | import os | |
43 | import sys |
|
43 | import sys | |
44 | from pprint import pprint |
|
44 | from pprint import pprint | |
45 |
|
45 | |||
46 | # Our own |
|
46 | # Our own | |
47 | from IPython.utils import DPyGetOpt |
|
47 | from IPython.utils import DPyGetOpt | |
48 | from IPython.core import release |
|
48 | from IPython.core import release | |
49 | from IPython.utils.ipstruct import Struct |
|
49 | from IPython.utils.ipstruct import Struct | |
50 | from IPython.core.outputtrap import OutputTrap |
|
50 | from IPython.core.outputtrap import OutputTrap | |
51 | from IPython.config.configloader import ConfigLoader |
|
51 | from IPython.config.configloader import ConfigLoader | |
52 | from IPython.core.iplib import InteractiveShell |
|
52 | from IPython.core.iplib import InteractiveShell | |
53 | from IPython.usage import cmd_line_usage,interactive_usage |
|
53 | from IPython.usage import cmd_line_usage,interactive_usage | |
54 | from IPython.utils.genutils import * |
|
54 | from IPython.utils.genutils import * | |
55 |
|
55 | |||
56 | def force_import(modname,force_reload=False): |
|
56 | def force_import(modname,force_reload=False): | |
57 | if modname in sys.modules and force_reload: |
|
57 | if modname in sys.modules and force_reload: | |
58 | info("reloading: %s" % modname) |
|
58 | info("reloading: %s" % modname) | |
59 | reload(sys.modules[modname]) |
|
59 | reload(sys.modules[modname]) | |
60 | else: |
|
60 | else: | |
61 | __import__(modname) |
|
61 | __import__(modname) | |
62 |
|
62 | |||
63 |
|
63 | |||
64 | #----------------------------------------------------------------------------- |
|
64 | #----------------------------------------------------------------------------- | |
65 | def make_IPython(argv=None,user_ns=None,user_global_ns=None,debug=1, |
|
65 | def make_IPython(argv=None,user_ns=None,user_global_ns=None,debug=1, | |
66 | rc_override=None,shell_class=InteractiveShell, |
|
66 | rc_override=None,shell_class=InteractiveShell, | |
67 | embedded=False,**kw): |
|
67 | embedded=False,**kw): | |
68 | """This is a dump of IPython into a single function. |
|
68 | """This is a dump of IPython into a single function. | |
69 |
|
69 | |||
70 | Later it will have to be broken up in a sensible manner. |
|
70 | Later it will have to be broken up in a sensible manner. | |
71 |
|
71 | |||
72 | Arguments: |
|
72 | Arguments: | |
73 |
|
73 | |||
74 | - argv: a list similar to sys.argv[1:]. It should NOT contain the desired |
|
74 | - argv: a list similar to sys.argv[1:]. It should NOT contain the desired | |
75 | script name, b/c DPyGetOpt strips the first argument only for the real |
|
75 | script name, b/c DPyGetOpt strips the first argument only for the real | |
76 | sys.argv. |
|
76 | sys.argv. | |
77 |
|
77 | |||
78 | - user_ns: a dict to be used as the user's namespace.""" |
|
78 | - user_ns: a dict to be used as the user's namespace.""" | |
79 |
|
79 | |||
80 | #---------------------------------------------------------------------- |
|
80 | #---------------------------------------------------------------------- | |
81 | # Defaults and initialization |
|
81 | # Defaults and initialization | |
82 |
|
82 | |||
83 | # For developer debugging, deactivates crash handler and uses pdb. |
|
83 | # For developer debugging, deactivates crash handler and uses pdb. | |
84 | DEVDEBUG = False |
|
84 | DEVDEBUG = False | |
85 |
|
85 | |||
86 | if argv is None: |
|
86 | if argv is None: | |
87 | argv = sys.argv |
|
87 | argv = sys.argv | |
88 |
|
88 | |||
89 | # __IP is the main global that lives throughout and represents the whole |
|
89 | # __IP is the main global that lives throughout and represents the whole | |
90 | # application. If the user redefines it, all bets are off as to what |
|
90 | # application. If the user redefines it, all bets are off as to what | |
91 | # happens. |
|
91 | # happens. | |
92 |
|
92 | |||
93 | # __IP is the name of he global which the caller will have accessible as |
|
93 | # __IP is the name of he global which the caller will have accessible as | |
94 | # __IP.name. We set its name via the first parameter passed to |
|
94 | # __IP.name. We set its name via the first parameter passed to | |
95 | # InteractiveShell: |
|
95 | # InteractiveShell: | |
96 |
|
96 | |||
97 | IP = shell_class('__IP',user_ns=user_ns,user_global_ns=user_global_ns, |
|
97 | IP = shell_class('__IP',user_ns=user_ns,user_global_ns=user_global_ns, | |
98 | embedded=embedded,**kw) |
|
98 | embedded=embedded,**kw) | |
99 |
|
99 | |||
100 | # Put 'help' in the user namespace |
|
100 | # Put 'help' in the user namespace | |
101 | try: |
|
101 | try: | |
102 | from site import _Helper |
|
102 | from site import _Helper | |
103 | IP.user_ns['help'] = _Helper() |
|
103 | IP.user_ns['help'] = _Helper() | |
104 | except ImportError: |
|
104 | except ImportError: | |
105 | warn('help() not available - check site.py') |
|
105 | warn('help() not available - check site.py') | |
106 |
|
106 | |||
107 | if DEVDEBUG: |
|
107 | if DEVDEBUG: | |
108 | # For developer debugging only (global flag) |
|
108 | # For developer debugging only (global flag) | |
109 |
from IPython import ultra |
|
109 | from IPython.core import ultratb | |
110 |
sys.excepthook = ultra |
|
110 | sys.excepthook = ultratb.VerboseTB(call_pdb=1) | |
111 |
|
111 | |||
112 | IP.BANNER_PARTS = ['Python %s\n' |
|
112 | IP.BANNER_PARTS = ['Python %s\n' | |
113 | 'Type "copyright", "credits" or "license" ' |
|
113 | 'Type "copyright", "credits" or "license" ' | |
114 | 'for more information.\n' |
|
114 | 'for more information.\n' | |
115 | % (sys.version.split('\n')[0],), |
|
115 | % (sys.version.split('\n')[0],), | |
116 | "IPython %s -- An enhanced Interactive Python." |
|
116 | "IPython %s -- An enhanced Interactive Python." | |
117 | % (release.version,), |
|
117 | % (release.version,), | |
118 | """\ |
|
118 | """\ | |
119 | ? -> Introduction and overview of IPython's features. |
|
119 | ? -> Introduction and overview of IPython's features. | |
120 | %quickref -> Quick reference. |
|
120 | %quickref -> Quick reference. | |
121 | help -> Python's own help system. |
|
121 | help -> Python's own help system. | |
122 | object? -> Details about 'object'. ?object also works, ?? prints more. |
|
122 | object? -> Details about 'object'. ?object also works, ?? prints more. | |
123 | """ ] |
|
123 | """ ] | |
124 |
|
124 | |||
125 | IP.usage = interactive_usage |
|
125 | IP.usage = interactive_usage | |
126 |
|
126 | |||
127 | # Platform-dependent suffix. |
|
127 | # Platform-dependent suffix. | |
128 | if os.name == 'posix': |
|
128 | if os.name == 'posix': | |
129 | rc_suffix = '' |
|
129 | rc_suffix = '' | |
130 | else: |
|
130 | else: | |
131 | rc_suffix = '.ini' |
|
131 | rc_suffix = '.ini' | |
132 |
|
132 | |||
133 | # default directory for configuration |
|
133 | # default directory for configuration | |
134 | ipythondir_def = get_ipython_dir() |
|
134 | ipythondir_def = get_ipython_dir() | |
135 |
|
135 | |||
136 | sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran |
|
136 | sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran | |
137 |
|
137 | |||
138 | # we need the directory where IPython itself is installed |
|
138 | # we need the directory where IPython itself is installed | |
139 | import IPython |
|
139 | import IPython | |
140 | IPython_dir = os.path.dirname(IPython.__file__) |
|
140 | IPython_dir = os.path.dirname(IPython.__file__) | |
141 | del IPython |
|
141 | del IPython | |
142 |
|
142 | |||
143 | #------------------------------------------------------------------------- |
|
143 | #------------------------------------------------------------------------- | |
144 | # Command line handling |
|
144 | # Command line handling | |
145 |
|
145 | |||
146 | # Valid command line options (uses DPyGetOpt syntax, like Perl's |
|
146 | # Valid command line options (uses DPyGetOpt syntax, like Perl's | |
147 | # GetOpt::Long) |
|
147 | # GetOpt::Long) | |
148 |
|
148 | |||
149 | # Any key not listed here gets deleted even if in the file (like session |
|
149 | # Any key not listed here gets deleted even if in the file (like session | |
150 | # or profile). That's deliberate, to maintain the rc namespace clean. |
|
150 | # or profile). That's deliberate, to maintain the rc namespace clean. | |
151 |
|
151 | |||
152 | # Each set of options appears twice: under _conv only the names are |
|
152 | # Each set of options appears twice: under _conv only the names are | |
153 | # listed, indicating which type they must be converted to when reading the |
|
153 | # listed, indicating which type they must be converted to when reading the | |
154 | # ipythonrc file. And under DPyGetOpt they are listed with the regular |
|
154 | # ipythonrc file. And under DPyGetOpt they are listed with the regular | |
155 | # DPyGetOpt syntax (=s,=i,:f,etc). |
|
155 | # DPyGetOpt syntax (=s,=i,:f,etc). | |
156 |
|
156 | |||
157 | # Make sure there's a space before each end of line (they get auto-joined!) |
|
157 | # Make sure there's a space before each end of line (they get auto-joined!) | |
158 | cmdline_opts = ('autocall=i autoindent! automagic! banner! cache_size|cs=i ' |
|
158 | cmdline_opts = ('autocall=i autoindent! automagic! banner! cache_size|cs=i ' | |
159 | 'c=s classic|cl color_info! colors=s confirm_exit! ' |
|
159 | 'c=s classic|cl color_info! colors=s confirm_exit! ' | |
160 | 'debug! deep_reload! editor=s log|l messages! nosep ' |
|
160 | 'debug! deep_reload! editor=s log|l messages! nosep ' | |
161 | 'object_info_string_level=i pdb! ' |
|
161 | 'object_info_string_level=i pdb! ' | |
162 | 'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s ' |
|
162 | 'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s ' | |
163 | 'pydb! ' |
|
163 | 'pydb! ' | |
164 | 'pylab_import_all! ' |
|
164 | 'pylab_import_all! ' | |
165 | 'quick screen_length|sl=i prompts_pad_left=i ' |
|
165 | 'quick screen_length|sl=i prompts_pad_left=i ' | |
166 | 'logfile|lf=s logplay|lp=s profile|p=s ' |
|
166 | 'logfile|lf=s logplay|lp=s profile|p=s ' | |
167 | 'readline! readline_merge_completions! ' |
|
167 | 'readline! readline_merge_completions! ' | |
168 | 'readline_omit__names! ' |
|
168 | 'readline_omit__names! ' | |
169 | 'rcfile=s separate_in|si=s separate_out|so=s ' |
|
169 | 'rcfile=s separate_in|si=s separate_out|so=s ' | |
170 | 'separate_out2|so2=s xmode=s wildcards_case_sensitive! ' |
|
170 | 'separate_out2|so2=s xmode=s wildcards_case_sensitive! ' | |
171 | 'magic_docstrings system_verbose! ' |
|
171 | 'magic_docstrings system_verbose! ' | |
172 | 'multi_line_specials! ' |
|
172 | 'multi_line_specials! ' | |
173 | 'term_title! wxversion=s ' |
|
173 | 'term_title! wxversion=s ' | |
174 | 'autoedit_syntax!') |
|
174 | 'autoedit_syntax!') | |
175 |
|
175 | |||
176 | # Options that can *only* appear at the cmd line (not in rcfiles). |
|
176 | # Options that can *only* appear at the cmd line (not in rcfiles). | |
177 |
|
177 | |||
178 | cmdline_only = ('help interact|i ipythondir=s Version upgrade ' |
|
178 | cmdline_only = ('help interact|i ipythondir=s Version upgrade ' | |
179 | 'gthread! qthread! q4thread! wthread! tkthread! pylab! tk! ' |
|
179 | 'gthread! qthread! q4thread! wthread! tkthread! pylab! tk! ' | |
180 | # 'twisted!' # disabled for now. |
|
180 | # 'twisted!' # disabled for now. | |
181 | ) |
|
181 | ) | |
182 |
|
182 | |||
183 | # Build the actual name list to be used by DPyGetOpt |
|
183 | # Build the actual name list to be used by DPyGetOpt | |
184 | opts_names = qw(cmdline_opts) + qw(cmdline_only) |
|
184 | opts_names = qw(cmdline_opts) + qw(cmdline_only) | |
185 |
|
185 | |||
186 | # Set sensible command line defaults. |
|
186 | # Set sensible command line defaults. | |
187 | # This should have everything from cmdline_opts and cmdline_only |
|
187 | # This should have everything from cmdline_opts and cmdline_only | |
188 | opts_def = Struct(autocall = 1, |
|
188 | opts_def = Struct(autocall = 1, | |
189 | autoedit_syntax = 0, |
|
189 | autoedit_syntax = 0, | |
190 | autoindent = 0, |
|
190 | autoindent = 0, | |
191 | automagic = 1, |
|
191 | automagic = 1, | |
192 | autoexec = [], |
|
192 | autoexec = [], | |
193 | banner = 1, |
|
193 | banner = 1, | |
194 | c = '', |
|
194 | c = '', | |
195 | cache_size = 1000, |
|
195 | cache_size = 1000, | |
196 | classic = 0, |
|
196 | classic = 0, | |
197 | color_info = 0, |
|
197 | color_info = 0, | |
198 | colors = 'NoColor', |
|
198 | colors = 'NoColor', | |
199 | confirm_exit = 1, |
|
199 | confirm_exit = 1, | |
200 | debug = 0, |
|
200 | debug = 0, | |
201 | deep_reload = 0, |
|
201 | deep_reload = 0, | |
202 | editor = '0', |
|
202 | editor = '0', | |
203 | gthread = 0, |
|
203 | gthread = 0, | |
204 | help = 0, |
|
204 | help = 0, | |
205 | interact = 0, |
|
205 | interact = 0, | |
206 | ipythondir = ipythondir_def, |
|
206 | ipythondir = ipythondir_def, | |
207 | log = 0, |
|
207 | log = 0, | |
208 | logfile = '', |
|
208 | logfile = '', | |
209 | logplay = '', |
|
209 | logplay = '', | |
210 | messages = 1, |
|
210 | messages = 1, | |
211 | multi_line_specials = 1, |
|
211 | multi_line_specials = 1, | |
212 | nosep = 0, |
|
212 | nosep = 0, | |
213 | object_info_string_level = 0, |
|
213 | object_info_string_level = 0, | |
214 | pdb = 0, |
|
214 | pdb = 0, | |
215 | pprint = 0, |
|
215 | pprint = 0, | |
216 | profile = '', |
|
216 | profile = '', | |
217 | prompt_in1 = 'In [\\#]: ', |
|
217 | prompt_in1 = 'In [\\#]: ', | |
218 | prompt_in2 = ' .\\D.: ', |
|
218 | prompt_in2 = ' .\\D.: ', | |
219 | prompt_out = 'Out[\\#]: ', |
|
219 | prompt_out = 'Out[\\#]: ', | |
220 | prompts_pad_left = 1, |
|
220 | prompts_pad_left = 1, | |
221 | pydb = 0, |
|
221 | pydb = 0, | |
222 | pylab = 0, |
|
222 | pylab = 0, | |
223 | pylab_import_all = 1, |
|
223 | pylab_import_all = 1, | |
224 | q4thread = 0, |
|
224 | q4thread = 0, | |
225 | qthread = 0, |
|
225 | qthread = 0, | |
226 | quick = 0, |
|
226 | quick = 0, | |
227 | quiet = 0, |
|
227 | quiet = 0, | |
228 | rcfile = 'ipythonrc' + rc_suffix, |
|
228 | rcfile = 'ipythonrc' + rc_suffix, | |
229 | readline = 1, |
|
229 | readline = 1, | |
230 | readline_merge_completions = 1, |
|
230 | readline_merge_completions = 1, | |
231 | readline_omit__names = 0, |
|
231 | readline_omit__names = 0, | |
232 | screen_length = 0, |
|
232 | screen_length = 0, | |
233 | separate_in = '\n', |
|
233 | separate_in = '\n', | |
234 | separate_out = '\n', |
|
234 | separate_out = '\n', | |
235 | separate_out2 = '', |
|
235 | separate_out2 = '', | |
236 | system_header = 'IPython system call: ', |
|
236 | system_header = 'IPython system call: ', | |
237 | system_verbose = 0, |
|
237 | system_verbose = 0, | |
238 | term_title = 1, |
|
238 | term_title = 1, | |
239 | tk = 0, |
|
239 | tk = 0, | |
240 | #twisted= 0, # disabled for now |
|
240 | #twisted= 0, # disabled for now | |
241 | upgrade = 0, |
|
241 | upgrade = 0, | |
242 | Version = 0, |
|
242 | Version = 0, | |
243 | wildcards_case_sensitive = 1, |
|
243 | wildcards_case_sensitive = 1, | |
244 | wthread = 0, |
|
244 | wthread = 0, | |
245 | wxversion = '0', |
|
245 | wxversion = '0', | |
246 | xmode = 'Context', |
|
246 | xmode = 'Context', | |
247 | magic_docstrings = 0, # undocumented, for doc generation |
|
247 | magic_docstrings = 0, # undocumented, for doc generation | |
248 | ) |
|
248 | ) | |
249 |
|
249 | |||
250 | # Things that will *only* appear in rcfiles (not at the command line). |
|
250 | # Things that will *only* appear in rcfiles (not at the command line). | |
251 | # Make sure there's a space before each end of line (they get auto-joined!) |
|
251 | # Make sure there's a space before each end of line (they get auto-joined!) | |
252 | rcfile_opts = { qwflat: 'include import_mod import_all execfile ', |
|
252 | rcfile_opts = { qwflat: 'include import_mod import_all execfile ', | |
253 | qw_lol: 'import_some ', |
|
253 | qw_lol: 'import_some ', | |
254 | # for things with embedded whitespace: |
|
254 | # for things with embedded whitespace: | |
255 | list_strings:'execute alias readline_parse_and_bind ', |
|
255 | list_strings:'execute alias readline_parse_and_bind ', | |
256 | # Regular strings need no conversion: |
|
256 | # Regular strings need no conversion: | |
257 | None:'readline_remove_delims ', |
|
257 | None:'readline_remove_delims ', | |
258 | } |
|
258 | } | |
259 | # Default values for these |
|
259 | # Default values for these | |
260 | rc_def = Struct(include = [], |
|
260 | rc_def = Struct(include = [], | |
261 | import_mod = [], |
|
261 | import_mod = [], | |
262 | import_all = [], |
|
262 | import_all = [], | |
263 | import_some = [[]], |
|
263 | import_some = [[]], | |
264 | execute = [], |
|
264 | execute = [], | |
265 | execfile = [], |
|
265 | execfile = [], | |
266 | alias = [], |
|
266 | alias = [], | |
267 | readline_parse_and_bind = [], |
|
267 | readline_parse_and_bind = [], | |
268 | readline_remove_delims = '', |
|
268 | readline_remove_delims = '', | |
269 | ) |
|
269 | ) | |
270 |
|
270 | |||
271 | # Build the type conversion dictionary from the above tables: |
|
271 | # Build the type conversion dictionary from the above tables: | |
272 | typeconv = rcfile_opts.copy() |
|
272 | typeconv = rcfile_opts.copy() | |
273 | typeconv.update(optstr2types(cmdline_opts)) |
|
273 | typeconv.update(optstr2types(cmdline_opts)) | |
274 |
|
274 | |||
275 | # FIXME: the None key appears in both, put that back together by hand. Ugly! |
|
275 | # FIXME: the None key appears in both, put that back together by hand. Ugly! | |
276 | typeconv[None] += ' ' + rcfile_opts[None] |
|
276 | typeconv[None] += ' ' + rcfile_opts[None] | |
277 |
|
277 | |||
278 | # Remove quotes at ends of all strings (used to protect spaces) |
|
278 | # Remove quotes at ends of all strings (used to protect spaces) | |
279 | typeconv[unquote_ends] = typeconv[None] |
|
279 | typeconv[unquote_ends] = typeconv[None] | |
280 | del typeconv[None] |
|
280 | del typeconv[None] | |
281 |
|
281 | |||
282 | # Build the list we'll use to make all config decisions with defaults: |
|
282 | # Build the list we'll use to make all config decisions with defaults: | |
283 | opts_all = opts_def.copy() |
|
283 | opts_all = opts_def.copy() | |
284 | opts_all.update(rc_def) |
|
284 | opts_all.update(rc_def) | |
285 |
|
285 | |||
286 | # Build conflict resolver for recursive loading of config files: |
|
286 | # Build conflict resolver for recursive loading of config files: | |
287 | # - preserve means the outermost file maintains the value, it is not |
|
287 | # - preserve means the outermost file maintains the value, it is not | |
288 | # overwritten if an included file has the same key. |
|
288 | # overwritten if an included file has the same key. | |
289 | # - add_flip applies + to the two values, so it better make sense to add |
|
289 | # - add_flip applies + to the two values, so it better make sense to add | |
290 | # those types of keys. But it flips them first so that things loaded |
|
290 | # those types of keys. But it flips them first so that things loaded | |
291 | # deeper in the inclusion chain have lower precedence. |
|
291 | # deeper in the inclusion chain have lower precedence. | |
292 | conflict = {'preserve': ' '.join([ typeconv[int], |
|
292 | conflict = {'preserve': ' '.join([ typeconv[int], | |
293 | typeconv[unquote_ends] ]), |
|
293 | typeconv[unquote_ends] ]), | |
294 | 'add_flip': ' '.join([ typeconv[qwflat], |
|
294 | 'add_flip': ' '.join([ typeconv[qwflat], | |
295 | typeconv[qw_lol], |
|
295 | typeconv[qw_lol], | |
296 | typeconv[list_strings] ]) |
|
296 | typeconv[list_strings] ]) | |
297 | } |
|
297 | } | |
298 |
|
298 | |||
299 | # Now actually process the command line |
|
299 | # Now actually process the command line | |
300 | getopt = DPyGetOpt.DPyGetOpt() |
|
300 | getopt = DPyGetOpt.DPyGetOpt() | |
301 | getopt.setIgnoreCase(0) |
|
301 | getopt.setIgnoreCase(0) | |
302 |
|
302 | |||
303 | getopt.parseConfiguration(opts_names) |
|
303 | getopt.parseConfiguration(opts_names) | |
304 |
|
304 | |||
305 | try: |
|
305 | try: | |
306 | getopt.processArguments(argv) |
|
306 | getopt.processArguments(argv) | |
307 | except DPyGetOpt.ArgumentError, exc: |
|
307 | except DPyGetOpt.ArgumentError, exc: | |
308 | print cmd_line_usage |
|
308 | print cmd_line_usage | |
309 | warn('\nError in Arguments: "%s"' % exc) |
|
309 | warn('\nError in Arguments: "%s"' % exc) | |
310 | sys.exit(1) |
|
310 | sys.exit(1) | |
311 |
|
311 | |||
312 | # convert the options dict to a struct for much lighter syntax later |
|
312 | # convert the options dict to a struct for much lighter syntax later | |
313 | opts = Struct(getopt.optionValues) |
|
313 | opts = Struct(getopt.optionValues) | |
314 | args = getopt.freeValues |
|
314 | args = getopt.freeValues | |
315 |
|
315 | |||
316 | # this is the struct (which has default values at this point) with which |
|
316 | # this is the struct (which has default values at this point) with which | |
317 | # we make all decisions: |
|
317 | # we make all decisions: | |
318 | opts_all.update(opts) |
|
318 | opts_all.update(opts) | |
319 |
|
319 | |||
320 | # Options that force an immediate exit |
|
320 | # Options that force an immediate exit | |
321 | if opts_all.help: |
|
321 | if opts_all.help: | |
322 | page(cmd_line_usage) |
|
322 | page(cmd_line_usage) | |
323 | sys.exit() |
|
323 | sys.exit() | |
324 |
|
324 | |||
325 | if opts_all.Version: |
|
325 | if opts_all.Version: | |
326 | print release.version |
|
326 | print release.version | |
327 | sys.exit() |
|
327 | sys.exit() | |
328 |
|
328 | |||
329 | if opts_all.magic_docstrings: |
|
329 | if opts_all.magic_docstrings: | |
330 | IP.magic_magic('-latex') |
|
330 | IP.magic_magic('-latex') | |
331 | sys.exit() |
|
331 | sys.exit() | |
332 |
|
332 | |||
333 | # add personal ipythondir to sys.path so that users can put things in |
|
333 | # add personal ipythondir to sys.path so that users can put things in | |
334 | # there for customization |
|
334 | # there for customization | |
335 | sys.path.append(os.path.abspath(opts_all.ipythondir)) |
|
335 | sys.path.append(os.path.abspath(opts_all.ipythondir)) | |
336 |
|
336 | |||
337 | # Create user config directory if it doesn't exist. This must be done |
|
337 | # Create user config directory if it doesn't exist. This must be done | |
338 | # *after* getting the cmd line options. |
|
338 | # *after* getting the cmd line options. | |
339 | if not os.path.isdir(opts_all.ipythondir): |
|
339 | if not os.path.isdir(opts_all.ipythondir): | |
340 | IP.user_setup(opts_all.ipythondir,rc_suffix,'install') |
|
340 | IP.user_setup(opts_all.ipythondir,rc_suffix,'install') | |
341 |
|
341 | |||
342 | # upgrade user config files while preserving a copy of the originals |
|
342 | # upgrade user config files while preserving a copy of the originals | |
343 | if opts_all.upgrade: |
|
343 | if opts_all.upgrade: | |
344 | IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade') |
|
344 | IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade') | |
345 |
|
345 | |||
346 | # check mutually exclusive options in the *original* command line |
|
346 | # check mutually exclusive options in the *original* command line | |
347 | mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'), |
|
347 | mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'), | |
348 | qw('classic profile'),qw('classic rcfile')]) |
|
348 | qw('classic profile'),qw('classic rcfile')]) | |
349 |
|
349 | |||
350 | #--------------------------------------------------------------------------- |
|
350 | #--------------------------------------------------------------------------- | |
351 | # Log replay |
|
351 | # Log replay | |
352 |
|
352 | |||
353 | # if -logplay, we need to 'become' the other session. That basically means |
|
353 | # if -logplay, we need to 'become' the other session. That basically means | |
354 | # replacing the current command line environment with that of the old |
|
354 | # replacing the current command line environment with that of the old | |
355 | # session and moving on. |
|
355 | # session and moving on. | |
356 |
|
356 | |||
357 | # this is needed so that later we know we're in session reload mode, as |
|
357 | # this is needed so that later we know we're in session reload mode, as | |
358 | # opts_all will get overwritten: |
|
358 | # opts_all will get overwritten: | |
359 | load_logplay = 0 |
|
359 | load_logplay = 0 | |
360 |
|
360 | |||
361 | if opts_all.logplay: |
|
361 | if opts_all.logplay: | |
362 | load_logplay = opts_all.logplay |
|
362 | load_logplay = opts_all.logplay | |
363 | opts_debug_save = opts_all.debug |
|
363 | opts_debug_save = opts_all.debug | |
364 | try: |
|
364 | try: | |
365 | logplay = open(opts_all.logplay) |
|
365 | logplay = open(opts_all.logplay) | |
366 | except IOError: |
|
366 | except IOError: | |
367 | if opts_all.debug: IP.InteractiveTB() |
|
367 | if opts_all.debug: IP.InteractiveTB() | |
368 | warn('Could not open logplay file '+`opts_all.logplay`) |
|
368 | warn('Could not open logplay file '+`opts_all.logplay`) | |
369 | # restore state as if nothing had happened and move on, but make |
|
369 | # restore state as if nothing had happened and move on, but make | |
370 | # sure that later we don't try to actually load the session file |
|
370 | # sure that later we don't try to actually load the session file | |
371 | logplay = None |
|
371 | logplay = None | |
372 | load_logplay = 0 |
|
372 | load_logplay = 0 | |
373 | del opts_all.logplay |
|
373 | del opts_all.logplay | |
374 | else: |
|
374 | else: | |
375 | try: |
|
375 | try: | |
376 | logplay.readline() |
|
376 | logplay.readline() | |
377 | logplay.readline(); |
|
377 | logplay.readline(); | |
378 | # this reloads that session's command line |
|
378 | # this reloads that session's command line | |
379 | cmd = logplay.readline()[6:] |
|
379 | cmd = logplay.readline()[6:] | |
380 | exec cmd |
|
380 | exec cmd | |
381 | # restore the true debug flag given so that the process of |
|
381 | # restore the true debug flag given so that the process of | |
382 | # session loading itself can be monitored. |
|
382 | # session loading itself can be monitored. | |
383 | opts.debug = opts_debug_save |
|
383 | opts.debug = opts_debug_save | |
384 | # save the logplay flag so later we don't overwrite the log |
|
384 | # save the logplay flag so later we don't overwrite the log | |
385 | opts.logplay = load_logplay |
|
385 | opts.logplay = load_logplay | |
386 | # now we must update our own structure with defaults |
|
386 | # now we must update our own structure with defaults | |
387 | opts_all.update(opts) |
|
387 | opts_all.update(opts) | |
388 | # now load args |
|
388 | # now load args | |
389 | cmd = logplay.readline()[6:] |
|
389 | cmd = logplay.readline()[6:] | |
390 | exec cmd |
|
390 | exec cmd | |
391 | logplay.close() |
|
391 | logplay.close() | |
392 | except: |
|
392 | except: | |
393 | logplay.close() |
|
393 | logplay.close() | |
394 | if opts_all.debug: IP.InteractiveTB() |
|
394 | if opts_all.debug: IP.InteractiveTB() | |
395 | warn("Logplay file lacking full configuration information.\n" |
|
395 | warn("Logplay file lacking full configuration information.\n" | |
396 | "I'll try to read it, but some things may not work.") |
|
396 | "I'll try to read it, but some things may not work.") | |
397 |
|
397 | |||
398 | #------------------------------------------------------------------------- |
|
398 | #------------------------------------------------------------------------- | |
399 | # set up output traps: catch all output from files, being run, modules |
|
399 | # set up output traps: catch all output from files, being run, modules | |
400 | # loaded, etc. Then give it to the user in a clean form at the end. |
|
400 | # loaded, etc. Then give it to the user in a clean form at the end. | |
401 |
|
401 | |||
402 | msg_out = 'Output messages. ' |
|
402 | msg_out = 'Output messages. ' | |
403 | msg_err = 'Error messages. ' |
|
403 | msg_err = 'Error messages. ' | |
404 | msg_sep = '\n' |
|
404 | msg_sep = '\n' | |
405 | msg = Struct(config = OutputTrap('Configuration Loader',msg_out, |
|
405 | msg = Struct(config = OutputTrap('Configuration Loader',msg_out, | |
406 | msg_err,msg_sep,debug, |
|
406 | msg_err,msg_sep,debug, | |
407 | quiet_out=1), |
|
407 | quiet_out=1), | |
408 | user_exec = OutputTrap('User File Execution',msg_out, |
|
408 | user_exec = OutputTrap('User File Execution',msg_out, | |
409 | msg_err,msg_sep,debug), |
|
409 | msg_err,msg_sep,debug), | |
410 | logplay = OutputTrap('Log Loader',msg_out, |
|
410 | logplay = OutputTrap('Log Loader',msg_out, | |
411 | msg_err,msg_sep,debug), |
|
411 | msg_err,msg_sep,debug), | |
412 | summary = '' |
|
412 | summary = '' | |
413 | ) |
|
413 | ) | |
414 |
|
414 | |||
415 | #------------------------------------------------------------------------- |
|
415 | #------------------------------------------------------------------------- | |
416 | # Process user ipythonrc-type configuration files |
|
416 | # Process user ipythonrc-type configuration files | |
417 |
|
417 | |||
418 | # turn on output trapping and log to msg.config |
|
418 | # turn on output trapping and log to msg.config | |
419 | # remember that with debug on, trapping is actually disabled |
|
419 | # remember that with debug on, trapping is actually disabled | |
420 | msg.config.trap_all() |
|
420 | msg.config.trap_all() | |
421 |
|
421 | |||
422 | # look for rcfile in current or default directory |
|
422 | # look for rcfile in current or default directory | |
423 | try: |
|
423 | try: | |
424 | opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir) |
|
424 | opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir) | |
425 | except IOError: |
|
425 | except IOError: | |
426 | if opts_all.debug: IP.InteractiveTB() |
|
426 | if opts_all.debug: IP.InteractiveTB() | |
427 | warn('Configuration file %s not found. Ignoring request.' |
|
427 | warn('Configuration file %s not found. Ignoring request.' | |
428 | % (opts_all.rcfile) ) |
|
428 | % (opts_all.rcfile) ) | |
429 |
|
429 | |||
430 | # 'profiles' are a shorthand notation for config filenames |
|
430 | # 'profiles' are a shorthand notation for config filenames | |
431 | profile_handled_by_legacy = False |
|
431 | profile_handled_by_legacy = False | |
432 | if opts_all.profile: |
|
432 | if opts_all.profile: | |
433 |
|
433 | |||
434 | try: |
|
434 | try: | |
435 | opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile |
|
435 | opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile | |
436 | + rc_suffix, |
|
436 | + rc_suffix, | |
437 | opts_all.ipythondir) |
|
437 | opts_all.ipythondir) | |
438 | profile_handled_by_legacy = True |
|
438 | profile_handled_by_legacy = True | |
439 | except IOError: |
|
439 | except IOError: | |
440 | if opts_all.debug: IP.InteractiveTB() |
|
440 | if opts_all.debug: IP.InteractiveTB() | |
441 | opts.profile = '' # remove profile from options if invalid |
|
441 | opts.profile = '' # remove profile from options if invalid | |
442 | # We won't warn anymore, primary method is ipy_profile_PROFNAME |
|
442 | # We won't warn anymore, primary method is ipy_profile_PROFNAME | |
443 | # which does trigger a warning. |
|
443 | # which does trigger a warning. | |
444 |
|
444 | |||
445 | # load the config file |
|
445 | # load the config file | |
446 | rcfiledata = None |
|
446 | rcfiledata = None | |
447 | if opts_all.quick: |
|
447 | if opts_all.quick: | |
448 | print 'Launching IPython in quick mode. No config file read.' |
|
448 | print 'Launching IPython in quick mode. No config file read.' | |
449 | elif opts_all.rcfile: |
|
449 | elif opts_all.rcfile: | |
450 | try: |
|
450 | try: | |
451 | cfg_loader = ConfigLoader(conflict) |
|
451 | cfg_loader = ConfigLoader(conflict) | |
452 | rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv, |
|
452 | rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv, | |
453 | 'include',opts_all.ipythondir, |
|
453 | 'include',opts_all.ipythondir, | |
454 | purge = 1, |
|
454 | purge = 1, | |
455 | unique = conflict['preserve']) |
|
455 | unique = conflict['preserve']) | |
456 | except: |
|
456 | except: | |
457 | IP.InteractiveTB() |
|
457 | IP.InteractiveTB() | |
458 | warn('Problems loading configuration file '+ |
|
458 | warn('Problems loading configuration file '+ | |
459 | `opts_all.rcfile`+ |
|
459 | `opts_all.rcfile`+ | |
460 | '\nStarting with default -bare bones- configuration.') |
|
460 | '\nStarting with default -bare bones- configuration.') | |
461 | else: |
|
461 | else: | |
462 | warn('No valid configuration file found in either currrent directory\n'+ |
|
462 | warn('No valid configuration file found in either currrent directory\n'+ | |
463 | 'or in the IPython config. directory: '+`opts_all.ipythondir`+ |
|
463 | 'or in the IPython config. directory: '+`opts_all.ipythondir`+ | |
464 | '\nProceeding with internal defaults.') |
|
464 | '\nProceeding with internal defaults.') | |
465 |
|
465 | |||
466 | #------------------------------------------------------------------------ |
|
466 | #------------------------------------------------------------------------ | |
467 | # Set exception handlers in mode requested by user. |
|
467 | # Set exception handlers in mode requested by user. | |
468 | otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode |
|
468 | otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode | |
469 | IP.magic_xmode(opts_all.xmode) |
|
469 | IP.magic_xmode(opts_all.xmode) | |
470 | otrap.release_out() |
|
470 | otrap.release_out() | |
471 |
|
471 | |||
472 | #------------------------------------------------------------------------ |
|
472 | #------------------------------------------------------------------------ | |
473 | # Execute user config |
|
473 | # Execute user config | |
474 |
|
474 | |||
475 | # Create a valid config structure with the right precedence order: |
|
475 | # Create a valid config structure with the right precedence order: | |
476 | # defaults < rcfile < command line. This needs to be in the instance, so |
|
476 | # defaults < rcfile < command line. This needs to be in the instance, so | |
477 | # that method calls below that rely on it find it. |
|
477 | # that method calls below that rely on it find it. | |
478 | IP.rc = rc_def.copy() |
|
478 | IP.rc = rc_def.copy() | |
479 |
|
479 | |||
480 | # Work with a local alias inside this routine to avoid unnecessary |
|
480 | # Work with a local alias inside this routine to avoid unnecessary | |
481 | # attribute lookups. |
|
481 | # attribute lookups. | |
482 | IP_rc = IP.rc |
|
482 | IP_rc = IP.rc | |
483 |
|
483 | |||
484 | IP_rc.update(opts_def) |
|
484 | IP_rc.update(opts_def) | |
485 | if rcfiledata: |
|
485 | if rcfiledata: | |
486 | # now we can update |
|
486 | # now we can update | |
487 | IP_rc.update(rcfiledata) |
|
487 | IP_rc.update(rcfiledata) | |
488 | IP_rc.update(opts) |
|
488 | IP_rc.update(opts) | |
489 | IP_rc.update(rc_override) |
|
489 | IP_rc.update(rc_override) | |
490 |
|
490 | |||
491 | # Store the original cmd line for reference: |
|
491 | # Store the original cmd line for reference: | |
492 | IP_rc.opts = opts |
|
492 | IP_rc.opts = opts | |
493 | IP_rc.args = args |
|
493 | IP_rc.args = args | |
494 |
|
494 | |||
495 | # create a *runtime* Struct like rc for holding parameters which may be |
|
495 | # create a *runtime* Struct like rc for holding parameters which may be | |
496 | # created and/or modified by runtime user extensions. |
|
496 | # created and/or modified by runtime user extensions. | |
497 | IP.runtime_rc = Struct() |
|
497 | IP.runtime_rc = Struct() | |
498 |
|
498 | |||
499 | # from this point on, all config should be handled through IP_rc, |
|
499 | # from this point on, all config should be handled through IP_rc, | |
500 | # opts* shouldn't be used anymore. |
|
500 | # opts* shouldn't be used anymore. | |
501 |
|
501 | |||
502 |
|
502 | |||
503 | # update IP_rc with some special things that need manual |
|
503 | # update IP_rc with some special things that need manual | |
504 | # tweaks. Basically options which affect other options. I guess this |
|
504 | # tweaks. Basically options which affect other options. I guess this | |
505 | # should just be written so that options are fully orthogonal and we |
|
505 | # should just be written so that options are fully orthogonal and we | |
506 | # wouldn't worry about this stuff! |
|
506 | # wouldn't worry about this stuff! | |
507 |
|
507 | |||
508 | if IP_rc.classic: |
|
508 | if IP_rc.classic: | |
509 | IP_rc.quick = 1 |
|
509 | IP_rc.quick = 1 | |
510 | IP_rc.cache_size = 0 |
|
510 | IP_rc.cache_size = 0 | |
511 | IP_rc.pprint = 0 |
|
511 | IP_rc.pprint = 0 | |
512 | IP_rc.prompt_in1 = '>>> ' |
|
512 | IP_rc.prompt_in1 = '>>> ' | |
513 | IP_rc.prompt_in2 = '... ' |
|
513 | IP_rc.prompt_in2 = '... ' | |
514 | IP_rc.prompt_out = '' |
|
514 | IP_rc.prompt_out = '' | |
515 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' |
|
515 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' | |
516 | IP_rc.colors = 'NoColor' |
|
516 | IP_rc.colors = 'NoColor' | |
517 | IP_rc.xmode = 'Plain' |
|
517 | IP_rc.xmode = 'Plain' | |
518 |
|
518 | |||
519 | IP.pre_config_initialization() |
|
519 | IP.pre_config_initialization() | |
520 | # configure readline |
|
520 | # configure readline | |
521 |
|
521 | |||
522 | # update exception handlers with rc file status |
|
522 | # update exception handlers with rc file status | |
523 | otrap.trap_out() # I don't want these messages ever. |
|
523 | otrap.trap_out() # I don't want these messages ever. | |
524 | IP.magic_xmode(IP_rc.xmode) |
|
524 | IP.magic_xmode(IP_rc.xmode) | |
525 | otrap.release_out() |
|
525 | otrap.release_out() | |
526 |
|
526 | |||
527 | # activate logging if requested and not reloading a log |
|
527 | # activate logging if requested and not reloading a log | |
528 | if IP_rc.logplay: |
|
528 | if IP_rc.logplay: | |
529 | IP.magic_logstart(IP_rc.logplay + ' append') |
|
529 | IP.magic_logstart(IP_rc.logplay + ' append') | |
530 | elif IP_rc.logfile: |
|
530 | elif IP_rc.logfile: | |
531 | IP.magic_logstart(IP_rc.logfile) |
|
531 | IP.magic_logstart(IP_rc.logfile) | |
532 | elif IP_rc.log: |
|
532 | elif IP_rc.log: | |
533 | IP.magic_logstart() |
|
533 | IP.magic_logstart() | |
534 |
|
534 | |||
535 | # find user editor so that it we don't have to look it up constantly |
|
535 | # find user editor so that it we don't have to look it up constantly | |
536 | if IP_rc.editor.strip()=='0': |
|
536 | if IP_rc.editor.strip()=='0': | |
537 | try: |
|
537 | try: | |
538 | ed = os.environ['EDITOR'] |
|
538 | ed = os.environ['EDITOR'] | |
539 | except KeyError: |
|
539 | except KeyError: | |
540 | if os.name == 'posix': |
|
540 | if os.name == 'posix': | |
541 | ed = 'vi' # the only one guaranteed to be there! |
|
541 | ed = 'vi' # the only one guaranteed to be there! | |
542 | else: |
|
542 | else: | |
543 | ed = 'notepad' # same in Windows! |
|
543 | ed = 'notepad' # same in Windows! | |
544 | IP_rc.editor = ed |
|
544 | IP_rc.editor = ed | |
545 |
|
545 | |||
546 | # Keep track of whether this is an embedded instance or not (useful for |
|
546 | # Keep track of whether this is an embedded instance or not (useful for | |
547 | # post-mortems). |
|
547 | # post-mortems). | |
548 | IP_rc.embedded = IP.embedded |
|
548 | IP_rc.embedded = IP.embedded | |
549 |
|
549 | |||
550 | # Recursive reload |
|
550 | # Recursive reload | |
551 | try: |
|
551 | try: | |
552 | from IPython.lib import deepreload |
|
552 | from IPython.lib import deepreload | |
553 | if IP_rc.deep_reload: |
|
553 | if IP_rc.deep_reload: | |
554 | __builtin__.reload = deepreload.reload |
|
554 | __builtin__.reload = deepreload.reload | |
555 | else: |
|
555 | else: | |
556 | __builtin__.dreload = deepreload.reload |
|
556 | __builtin__.dreload = deepreload.reload | |
557 | del deepreload |
|
557 | del deepreload | |
558 | except ImportError: |
|
558 | except ImportError: | |
559 | pass |
|
559 | pass | |
560 |
|
560 | |||
561 | # Save the current state of our namespace so that the interactive shell |
|
561 | # Save the current state of our namespace so that the interactive shell | |
562 | # can later know which variables have been created by us from config files |
|
562 | # can later know which variables have been created by us from config files | |
563 | # and loading. This way, loading a file (in any way) is treated just like |
|
563 | # and loading. This way, loading a file (in any way) is treated just like | |
564 | # defining things on the command line, and %who works as expected. |
|
564 | # defining things on the command line, and %who works as expected. | |
565 |
|
565 | |||
566 | # DON'T do anything that affects the namespace beyond this point! |
|
566 | # DON'T do anything that affects the namespace beyond this point! | |
567 | IP.internal_ns.update(__main__.__dict__) |
|
567 | IP.internal_ns.update(__main__.__dict__) | |
568 |
|
568 | |||
569 | #IP.internal_ns.update(locals()) # so our stuff doesn't show up in %who |
|
569 | #IP.internal_ns.update(locals()) # so our stuff doesn't show up in %who | |
570 |
|
570 | |||
571 | # Now run through the different sections of the users's config |
|
571 | # Now run through the different sections of the users's config | |
572 | if IP_rc.debug: |
|
572 | if IP_rc.debug: | |
573 | print 'Trying to execute the following configuration structure:' |
|
573 | print 'Trying to execute the following configuration structure:' | |
574 | print '(Things listed first are deeper in the inclusion tree and get' |
|
574 | print '(Things listed first are deeper in the inclusion tree and get' | |
575 | print 'loaded first).\n' |
|
575 | print 'loaded first).\n' | |
576 | pprint(IP_rc.__dict__) |
|
576 | pprint(IP_rc.__dict__) | |
577 |
|
577 | |||
578 | for mod in IP_rc.import_mod: |
|
578 | for mod in IP_rc.import_mod: | |
579 | try: |
|
579 | try: | |
580 | exec 'import '+mod in IP.user_ns |
|
580 | exec 'import '+mod in IP.user_ns | |
581 | except : |
|
581 | except : | |
582 | IP.InteractiveTB() |
|
582 | IP.InteractiveTB() | |
583 | import_fail_info(mod) |
|
583 | import_fail_info(mod) | |
584 |
|
584 | |||
585 | for mod_fn in IP_rc.import_some: |
|
585 | for mod_fn in IP_rc.import_some: | |
586 | if not mod_fn == []: |
|
586 | if not mod_fn == []: | |
587 | mod,fn = mod_fn[0],','.join(mod_fn[1:]) |
|
587 | mod,fn = mod_fn[0],','.join(mod_fn[1:]) | |
588 | try: |
|
588 | try: | |
589 | exec 'from '+mod+' import '+fn in IP.user_ns |
|
589 | exec 'from '+mod+' import '+fn in IP.user_ns | |
590 | except : |
|
590 | except : | |
591 | IP.InteractiveTB() |
|
591 | IP.InteractiveTB() | |
592 | import_fail_info(mod,fn) |
|
592 | import_fail_info(mod,fn) | |
593 |
|
593 | |||
594 | for mod in IP_rc.import_all: |
|
594 | for mod in IP_rc.import_all: | |
595 | try: |
|
595 | try: | |
596 | exec 'from '+mod+' import *' in IP.user_ns |
|
596 | exec 'from '+mod+' import *' in IP.user_ns | |
597 | except : |
|
597 | except : | |
598 | IP.InteractiveTB() |
|
598 | IP.InteractiveTB() | |
599 | import_fail_info(mod) |
|
599 | import_fail_info(mod) | |
600 |
|
600 | |||
601 | for code in IP_rc.execute: |
|
601 | for code in IP_rc.execute: | |
602 | try: |
|
602 | try: | |
603 | exec code in IP.user_ns |
|
603 | exec code in IP.user_ns | |
604 | except: |
|
604 | except: | |
605 | IP.InteractiveTB() |
|
605 | IP.InteractiveTB() | |
606 | warn('Failure executing code: ' + `code`) |
|
606 | warn('Failure executing code: ' + `code`) | |
607 |
|
607 | |||
608 | # Execute the files the user wants in ipythonrc |
|
608 | # Execute the files the user wants in ipythonrc | |
609 | for file in IP_rc.execfile: |
|
609 | for file in IP_rc.execfile: | |
610 | try: |
|
610 | try: | |
611 | file = filefind(file,sys.path+[IPython_dir]) |
|
611 | file = filefind(file,sys.path+[IPython_dir]) | |
612 | except IOError: |
|
612 | except IOError: | |
613 | warn(itpl('File $file not found. Skipping it.')) |
|
613 | warn(itpl('File $file not found. Skipping it.')) | |
614 | else: |
|
614 | else: | |
615 | IP.safe_execfile(os.path.expanduser(file),IP.user_ns) |
|
615 | IP.safe_execfile(os.path.expanduser(file),IP.user_ns) | |
616 |
|
616 | |||
617 | # finally, try importing ipy_*_conf for final configuration |
|
617 | # finally, try importing ipy_*_conf for final configuration | |
618 | try: |
|
618 | try: | |
619 | import ipy_system_conf |
|
619 | import ipy_system_conf | |
620 | except ImportError: |
|
620 | except ImportError: | |
621 | if opts_all.debug: IP.InteractiveTB() |
|
621 | if opts_all.debug: IP.InteractiveTB() | |
622 | warn("Could not import 'ipy_system_conf'") |
|
622 | warn("Could not import 'ipy_system_conf'") | |
623 | except: |
|
623 | except: | |
624 | IP.InteractiveTB() |
|
624 | IP.InteractiveTB() | |
625 | import_fail_info('ipy_system_conf') |
|
625 | import_fail_info('ipy_system_conf') | |
626 |
|
626 | |||
627 | # only import prof module if ipythonrc-PROF was not found |
|
627 | # only import prof module if ipythonrc-PROF was not found | |
628 | if opts_all.profile and not profile_handled_by_legacy: |
|
628 | if opts_all.profile and not profile_handled_by_legacy: | |
629 | profmodname = 'ipy_profile_' + opts_all.profile |
|
629 | profmodname = 'ipy_profile_' + opts_all.profile | |
630 | try: |
|
630 | try: | |
631 | force_import(profmodname) |
|
631 | force_import(profmodname) | |
632 | except: |
|
632 | except: | |
633 | IP.InteractiveTB() |
|
633 | IP.InteractiveTB() | |
634 | print "Error importing",profmodname,\ |
|
634 | print "Error importing",profmodname,\ | |
635 | "- perhaps you should run %upgrade?" |
|
635 | "- perhaps you should run %upgrade?" | |
636 | import_fail_info(profmodname) |
|
636 | import_fail_info(profmodname) | |
637 | else: |
|
637 | else: | |
638 | opts.profile = opts_all.profile |
|
638 | opts.profile = opts_all.profile | |
639 | else: |
|
639 | else: | |
640 | force_import('ipy_profile_none') |
|
640 | force_import('ipy_profile_none') | |
641 | # XXX - this is wrong: ipy_user_conf should not be loaded unconditionally, |
|
641 | # XXX - this is wrong: ipy_user_conf should not be loaded unconditionally, | |
642 | # since the user could have specified a config file path by hand. |
|
642 | # since the user could have specified a config file path by hand. | |
643 | try: |
|
643 | try: | |
644 | force_import('ipy_user_conf') |
|
644 | force_import('ipy_user_conf') | |
645 | except: |
|
645 | except: | |
646 | conf = opts_all.ipythondir + "/ipy_user_conf.py" |
|
646 | conf = opts_all.ipythondir + "/ipy_user_conf.py" | |
647 | IP.InteractiveTB() |
|
647 | IP.InteractiveTB() | |
648 | if not os.path.isfile(conf): |
|
648 | if not os.path.isfile(conf): | |
649 | warn(conf + ' does not exist, please run %upgrade!') |
|
649 | warn(conf + ' does not exist, please run %upgrade!') | |
650 |
|
650 | |||
651 | import_fail_info("ipy_user_conf") |
|
651 | import_fail_info("ipy_user_conf") | |
652 |
|
652 | |||
653 | # Define the history file for saving commands in between sessions |
|
653 | # Define the history file for saving commands in between sessions | |
654 | try: |
|
654 | try: | |
655 | histfname = 'history-%s' % opts.profile |
|
655 | histfname = 'history-%s' % opts.profile | |
656 | except AttributeError: |
|
656 | except AttributeError: | |
657 | histfname = 'history' |
|
657 | histfname = 'history' | |
658 | IP.histfile = os.path.join(opts_all.ipythondir,histfname) |
|
658 | IP.histfile = os.path.join(opts_all.ipythondir,histfname) | |
659 |
|
659 | |||
660 | # finally, push the argv to options again to ensure highest priority |
|
660 | # finally, push the argv to options again to ensure highest priority | |
661 | IP_rc.update(opts) |
|
661 | IP_rc.update(opts) | |
662 |
|
662 | |||
663 | # release stdout and stderr and save config log into a global summary |
|
663 | # release stdout and stderr and save config log into a global summary | |
664 | msg.config.release_all() |
|
664 | msg.config.release_all() | |
665 | if IP_rc.messages: |
|
665 | if IP_rc.messages: | |
666 | msg.summary += msg.config.summary_all() |
|
666 | msg.summary += msg.config.summary_all() | |
667 |
|
667 | |||
668 | #------------------------------------------------------------------------ |
|
668 | #------------------------------------------------------------------------ | |
669 | # Setup interactive session |
|
669 | # Setup interactive session | |
670 |
|
670 | |||
671 | # Now we should be fully configured. We can then execute files or load |
|
671 | # Now we should be fully configured. We can then execute files or load | |
672 | # things only needed for interactive use. Then we'll open the shell. |
|
672 | # things only needed for interactive use. Then we'll open the shell. | |
673 |
|
673 | |||
674 | # Take a snapshot of the user namespace before opening the shell. That way |
|
674 | # Take a snapshot of the user namespace before opening the shell. That way | |
675 | # we'll be able to identify which things were interactively defined and |
|
675 | # we'll be able to identify which things were interactively defined and | |
676 | # which were defined through config files. |
|
676 | # which were defined through config files. | |
677 | IP.user_config_ns.update(IP.user_ns) |
|
677 | IP.user_config_ns.update(IP.user_ns) | |
678 |
|
678 | |||
679 | # Force reading a file as if it were a session log. Slower but safer. |
|
679 | # Force reading a file as if it were a session log. Slower but safer. | |
680 | if load_logplay: |
|
680 | if load_logplay: | |
681 | print 'Replaying log...' |
|
681 | print 'Replaying log...' | |
682 | try: |
|
682 | try: | |
683 | if IP_rc.debug: |
|
683 | if IP_rc.debug: | |
684 | logplay_quiet = 0 |
|
684 | logplay_quiet = 0 | |
685 | else: |
|
685 | else: | |
686 | logplay_quiet = 1 |
|
686 | logplay_quiet = 1 | |
687 |
|
687 | |||
688 | msg.logplay.trap_all() |
|
688 | msg.logplay.trap_all() | |
689 | IP.safe_execfile(load_logplay,IP.user_ns, |
|
689 | IP.safe_execfile(load_logplay,IP.user_ns, | |
690 | islog = 1, quiet = logplay_quiet) |
|
690 | islog = 1, quiet = logplay_quiet) | |
691 | msg.logplay.release_all() |
|
691 | msg.logplay.release_all() | |
692 | if IP_rc.messages: |
|
692 | if IP_rc.messages: | |
693 | msg.summary += msg.logplay.summary_all() |
|
693 | msg.summary += msg.logplay.summary_all() | |
694 | except: |
|
694 | except: | |
695 | warn('Problems replaying logfile %s.' % load_logplay) |
|
695 | warn('Problems replaying logfile %s.' % load_logplay) | |
696 | IP.InteractiveTB() |
|
696 | IP.InteractiveTB() | |
697 |
|
697 | |||
698 | # Load remaining files in command line |
|
698 | # Load remaining files in command line | |
699 | msg.user_exec.trap_all() |
|
699 | msg.user_exec.trap_all() | |
700 |
|
700 | |||
701 | # Do NOT execute files named in the command line as scripts to be loaded |
|
701 | # Do NOT execute files named in the command line as scripts to be loaded | |
702 | # by embedded instances. Doing so has the potential for an infinite |
|
702 | # by embedded instances. Doing so has the potential for an infinite | |
703 | # recursion if there are exceptions thrown in the process. |
|
703 | # recursion if there are exceptions thrown in the process. | |
704 |
|
704 | |||
705 | # XXX FIXME: the execution of user files should be moved out to after |
|
705 | # XXX FIXME: the execution of user files should be moved out to after | |
706 | # ipython is fully initialized, just as if they were run via %run at the |
|
706 | # ipython is fully initialized, just as if they were run via %run at the | |
707 | # ipython prompt. This would also give them the benefit of ipython's |
|
707 | # ipython prompt. This would also give them the benefit of ipython's | |
708 | # nice tracebacks. |
|
708 | # nice tracebacks. | |
709 |
|
709 | |||
710 | if (not embedded and IP_rc.args and |
|
710 | if (not embedded and IP_rc.args and | |
711 | not IP_rc.args[0].lower().endswith('.ipy')): |
|
711 | not IP_rc.args[0].lower().endswith('.ipy')): | |
712 | name_save = IP.user_ns['__name__'] |
|
712 | name_save = IP.user_ns['__name__'] | |
713 | IP.user_ns['__name__'] = '__main__' |
|
713 | IP.user_ns['__name__'] = '__main__' | |
714 | # Set our own excepthook in case the user code tries to call it |
|
714 | # Set our own excepthook in case the user code tries to call it | |
715 | # directly. This prevents triggering the IPython crash handler. |
|
715 | # directly. This prevents triggering the IPython crash handler. | |
716 | old_excepthook,sys.excepthook = sys.excepthook, IP.excepthook |
|
716 | old_excepthook,sys.excepthook = sys.excepthook, IP.excepthook | |
717 |
|
717 | |||
718 | save_argv = sys.argv[1:] # save it for later restoring |
|
718 | save_argv = sys.argv[1:] # save it for later restoring | |
719 |
|
719 | |||
720 | sys.argv = args |
|
720 | sys.argv = args | |
721 |
|
721 | |||
722 | try: |
|
722 | try: | |
723 | IP.safe_execfile(args[0], IP.user_ns) |
|
723 | IP.safe_execfile(args[0], IP.user_ns) | |
724 | finally: |
|
724 | finally: | |
725 | # Reset our crash handler in place |
|
725 | # Reset our crash handler in place | |
726 | sys.excepthook = old_excepthook |
|
726 | sys.excepthook = old_excepthook | |
727 | sys.argv[:] = save_argv |
|
727 | sys.argv[:] = save_argv | |
728 | IP.user_ns['__name__'] = name_save |
|
728 | IP.user_ns['__name__'] = name_save | |
729 |
|
729 | |||
730 | msg.user_exec.release_all() |
|
730 | msg.user_exec.release_all() | |
731 |
|
731 | |||
732 | if IP_rc.messages: |
|
732 | if IP_rc.messages: | |
733 | msg.summary += msg.user_exec.summary_all() |
|
733 | msg.summary += msg.user_exec.summary_all() | |
734 |
|
734 | |||
735 | # since we can't specify a null string on the cmd line, 0 is the equivalent: |
|
735 | # since we can't specify a null string on the cmd line, 0 is the equivalent: | |
736 | if IP_rc.nosep: |
|
736 | if IP_rc.nosep: | |
737 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' |
|
737 | IP_rc.separate_in = IP_rc.separate_out = IP_rc.separate_out2 = '0' | |
738 | if IP_rc.separate_in == '0': IP_rc.separate_in = '' |
|
738 | if IP_rc.separate_in == '0': IP_rc.separate_in = '' | |
739 | if IP_rc.separate_out == '0': IP_rc.separate_out = '' |
|
739 | if IP_rc.separate_out == '0': IP_rc.separate_out = '' | |
740 | if IP_rc.separate_out2 == '0': IP_rc.separate_out2 = '' |
|
740 | if IP_rc.separate_out2 == '0': IP_rc.separate_out2 = '' | |
741 | IP_rc.separate_in = IP_rc.separate_in.replace('\\n','\n') |
|
741 | IP_rc.separate_in = IP_rc.separate_in.replace('\\n','\n') | |
742 | IP_rc.separate_out = IP_rc.separate_out.replace('\\n','\n') |
|
742 | IP_rc.separate_out = IP_rc.separate_out.replace('\\n','\n') | |
743 | IP_rc.separate_out2 = IP_rc.separate_out2.replace('\\n','\n') |
|
743 | IP_rc.separate_out2 = IP_rc.separate_out2.replace('\\n','\n') | |
744 |
|
744 | |||
745 | # Determine how many lines at the bottom of the screen are needed for |
|
745 | # Determine how many lines at the bottom of the screen are needed for | |
746 | # showing prompts, so we can know wheter long strings are to be printed or |
|
746 | # showing prompts, so we can know wheter long strings are to be printed or | |
747 | # paged: |
|
747 | # paged: | |
748 | num_lines_bot = IP_rc.separate_in.count('\n')+1 |
|
748 | num_lines_bot = IP_rc.separate_in.count('\n')+1 | |
749 | IP_rc.screen_length = IP_rc.screen_length - num_lines_bot |
|
749 | IP_rc.screen_length = IP_rc.screen_length - num_lines_bot | |
750 |
|
750 | |||
751 | # configure startup banner |
|
751 | # configure startup banner | |
752 | if IP_rc.c: # regular python doesn't print the banner with -c |
|
752 | if IP_rc.c: # regular python doesn't print the banner with -c | |
753 | IP_rc.banner = 0 |
|
753 | IP_rc.banner = 0 | |
754 | if IP_rc.banner: |
|
754 | if IP_rc.banner: | |
755 | BANN_P = IP.BANNER_PARTS |
|
755 | BANN_P = IP.BANNER_PARTS | |
756 | else: |
|
756 | else: | |
757 | BANN_P = [] |
|
757 | BANN_P = [] | |
758 |
|
758 | |||
759 | if IP_rc.profile: BANN_P.append('IPython profile: %s\n' % IP_rc.profile) |
|
759 | if IP_rc.profile: BANN_P.append('IPython profile: %s\n' % IP_rc.profile) | |
760 |
|
760 | |||
761 | # add message log (possibly empty) |
|
761 | # add message log (possibly empty) | |
762 | if msg.summary: BANN_P.append(msg.summary) |
|
762 | if msg.summary: BANN_P.append(msg.summary) | |
763 | # Final banner is a string |
|
763 | # Final banner is a string | |
764 | IP.BANNER = '\n'.join(BANN_P) |
|
764 | IP.BANNER = '\n'.join(BANN_P) | |
765 |
|
765 | |||
766 | # Finalize the IPython instance. This assumes the rc structure is fully |
|
766 | # Finalize the IPython instance. This assumes the rc structure is fully | |
767 | # in place. |
|
767 | # in place. | |
768 | IP.post_config_initialization() |
|
768 | IP.post_config_initialization() | |
769 |
|
769 | |||
770 | return IP |
|
770 | return IP | |
771 | #************************ end of file <ipmaker.py> ************************** |
|
771 | #************************ end of file <ipmaker.py> ************************** |
@@ -1,1247 +1,1247 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """IPython Shell classes. |
|
2 | """IPython Shell classes. | |
3 |
|
3 | |||
4 | All the matplotlib support code was co-developed with John Hunter, |
|
4 | All the matplotlib support code was co-developed with John Hunter, | |
5 | matplotlib's author. |
|
5 | matplotlib's author. | |
6 | """ |
|
6 | """ | |
7 |
|
7 | |||
8 | #***************************************************************************** |
|
8 | #***************************************************************************** | |
9 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> |
|
9 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> | |
10 | # |
|
10 | # | |
11 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | # Distributed under the terms of the BSD License. The full license is in | |
12 | # the file COPYING, distributed as part of this software. |
|
12 | # the file COPYING, distributed as part of this software. | |
13 | #***************************************************************************** |
|
13 | #***************************************************************************** | |
14 |
|
14 | |||
15 | # Code begins |
|
15 | # Code begins | |
16 | # Stdlib imports |
|
16 | # Stdlib imports | |
17 | import __builtin__ |
|
17 | import __builtin__ | |
18 | import __main__ |
|
18 | import __main__ | |
19 | import Queue |
|
19 | import Queue | |
20 | import inspect |
|
20 | import inspect | |
21 | import os |
|
21 | import os | |
22 | import sys |
|
22 | import sys | |
23 | import thread |
|
23 | import thread | |
24 | import threading |
|
24 | import threading | |
25 | import time |
|
25 | import time | |
26 |
|
26 | |||
27 | from signal import signal, SIGINT |
|
27 | from signal import signal, SIGINT | |
28 |
|
28 | |||
29 | try: |
|
29 | try: | |
30 | import ctypes |
|
30 | import ctypes | |
31 | HAS_CTYPES = True |
|
31 | HAS_CTYPES = True | |
32 | except ImportError: |
|
32 | except ImportError: | |
33 | HAS_CTYPES = False |
|
33 | HAS_CTYPES = False | |
34 |
|
34 | |||
35 | # IPython imports |
|
35 | # IPython imports | |
36 | import IPython |
|
36 | import IPython | |
37 |
from IPython import ultra |
|
37 | from IPython.core import ultratb | |
38 | from IPython.core import ipapi |
|
38 | from IPython.core import ipapi | |
39 | from IPython.core.magic import Magic |
|
39 | from IPython.core.magic import Magic | |
40 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no |
|
40 | from IPython.utils.genutils import Term,warn,error,flag_calls, ask_yes_no | |
41 | from IPython.core.iplib import InteractiveShell |
|
41 | from IPython.core.iplib import InteractiveShell | |
42 | from IPython.core.ipmaker import make_IPython |
|
42 | from IPython.core.ipmaker import make_IPython | |
43 | from IPython.utils.ipstruct import Struct |
|
43 | from IPython.utils.ipstruct import Struct | |
44 | from IPython.testing import decorators as testdec |
|
44 | from IPython.testing import decorators as testdec | |
45 |
|
45 | |||
46 | # Globals |
|
46 | # Globals | |
47 | # global flag to pass around information about Ctrl-C without exceptions |
|
47 | # global flag to pass around information about Ctrl-C without exceptions | |
48 | KBINT = False |
|
48 | KBINT = False | |
49 |
|
49 | |||
50 | # global flag to turn on/off Tk support. |
|
50 | # global flag to turn on/off Tk support. | |
51 | USE_TK = False |
|
51 | USE_TK = False | |
52 |
|
52 | |||
53 | # ID for the main thread, used for cross-thread exceptions |
|
53 | # ID for the main thread, used for cross-thread exceptions | |
54 | MAIN_THREAD_ID = thread.get_ident() |
|
54 | MAIN_THREAD_ID = thread.get_ident() | |
55 |
|
55 | |||
56 | # Tag when runcode() is active, for exception handling |
|
56 | # Tag when runcode() is active, for exception handling | |
57 | CODE_RUN = None |
|
57 | CODE_RUN = None | |
58 |
|
58 | |||
59 | # Default timeout for waiting for multithreaded shells (in seconds) |
|
59 | # Default timeout for waiting for multithreaded shells (in seconds) | |
60 | GUI_TIMEOUT = 10 |
|
60 | GUI_TIMEOUT = 10 | |
61 |
|
61 | |||
62 | #----------------------------------------------------------------------------- |
|
62 | #----------------------------------------------------------------------------- | |
63 | # This class is trivial now, but I want to have it in to publish a clean |
|
63 | # This class is trivial now, but I want to have it in to publish a clean | |
64 | # interface. Later when the internals are reorganized, code that uses this |
|
64 | # interface. Later when the internals are reorganized, code that uses this | |
65 | # shouldn't have to change. |
|
65 | # shouldn't have to change. | |
66 |
|
66 | |||
67 | class IPShell: |
|
67 | class IPShell: | |
68 | """Create an IPython instance.""" |
|
68 | """Create an IPython instance.""" | |
69 |
|
69 | |||
70 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
70 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
71 | debug=1,shell_class=InteractiveShell): |
|
71 | debug=1,shell_class=InteractiveShell): | |
72 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
72 | self.IP = make_IPython(argv,user_ns=user_ns, | |
73 | user_global_ns=user_global_ns, |
|
73 | user_global_ns=user_global_ns, | |
74 | debug=debug,shell_class=shell_class) |
|
74 | debug=debug,shell_class=shell_class) | |
75 |
|
75 | |||
76 | def mainloop(self,sys_exit=0,banner=None): |
|
76 | def mainloop(self,sys_exit=0,banner=None): | |
77 | self.IP.mainloop(banner) |
|
77 | self.IP.mainloop(banner) | |
78 | if sys_exit: |
|
78 | if sys_exit: | |
79 | sys.exit() |
|
79 | sys.exit() | |
80 |
|
80 | |||
81 | #----------------------------------------------------------------------------- |
|
81 | #----------------------------------------------------------------------------- | |
82 | def kill_embedded(self,parameter_s=''): |
|
82 | def kill_embedded(self,parameter_s=''): | |
83 | """%kill_embedded : deactivate for good the current embedded IPython. |
|
83 | """%kill_embedded : deactivate for good the current embedded IPython. | |
84 |
|
84 | |||
85 | This function (after asking for confirmation) sets an internal flag so that |
|
85 | This function (after asking for confirmation) sets an internal flag so that | |
86 | an embedded IPython will never activate again. This is useful to |
|
86 | an embedded IPython will never activate again. This is useful to | |
87 | permanently disable a shell that is being called inside a loop: once you've |
|
87 | permanently disable a shell that is being called inside a loop: once you've | |
88 | figured out what you needed from it, you may then kill it and the program |
|
88 | figured out what you needed from it, you may then kill it and the program | |
89 | will then continue to run without the interactive shell interfering again. |
|
89 | will then continue to run without the interactive shell interfering again. | |
90 | """ |
|
90 | """ | |
91 |
|
91 | |||
92 | kill = ask_yes_no("Are you sure you want to kill this embedded instance " |
|
92 | kill = ask_yes_no("Are you sure you want to kill this embedded instance " | |
93 | "(y/n)? [y/N] ",'n') |
|
93 | "(y/n)? [y/N] ",'n') | |
94 | if kill: |
|
94 | if kill: | |
95 | self.shell.embedded_active = False |
|
95 | self.shell.embedded_active = False | |
96 | print "This embedded IPython will not reactivate anymore once you exit." |
|
96 | print "This embedded IPython will not reactivate anymore once you exit." | |
97 |
|
97 | |||
98 | class IPShellEmbed: |
|
98 | class IPShellEmbed: | |
99 | """Allow embedding an IPython shell into a running program. |
|
99 | """Allow embedding an IPython shell into a running program. | |
100 |
|
100 | |||
101 | Instances of this class are callable, with the __call__ method being an |
|
101 | Instances of this class are callable, with the __call__ method being an | |
102 | alias to the embed() method of an InteractiveShell instance. |
|
102 | alias to the embed() method of an InteractiveShell instance. | |
103 |
|
103 | |||
104 | Usage (see also the example-embed.py file for a running example): |
|
104 | Usage (see also the example-embed.py file for a running example): | |
105 |
|
105 | |||
106 | ipshell = IPShellEmbed([argv,banner,exit_msg,rc_override]) |
|
106 | ipshell = IPShellEmbed([argv,banner,exit_msg,rc_override]) | |
107 |
|
107 | |||
108 | - argv: list containing valid command-line options for IPython, as they |
|
108 | - argv: list containing valid command-line options for IPython, as they | |
109 | would appear in sys.argv[1:]. |
|
109 | would appear in sys.argv[1:]. | |
110 |
|
110 | |||
111 | For example, the following command-line options: |
|
111 | For example, the following command-line options: | |
112 |
|
112 | |||
113 | $ ipython -prompt_in1 'Input <\\#>' -colors LightBG |
|
113 | $ ipython -prompt_in1 'Input <\\#>' -colors LightBG | |
114 |
|
114 | |||
115 | would be passed in the argv list as: |
|
115 | would be passed in the argv list as: | |
116 |
|
116 | |||
117 | ['-prompt_in1','Input <\\#>','-colors','LightBG'] |
|
117 | ['-prompt_in1','Input <\\#>','-colors','LightBG'] | |
118 |
|
118 | |||
119 | - banner: string which gets printed every time the interpreter starts. |
|
119 | - banner: string which gets printed every time the interpreter starts. | |
120 |
|
120 | |||
121 | - exit_msg: string which gets printed every time the interpreter exits. |
|
121 | - exit_msg: string which gets printed every time the interpreter exits. | |
122 |
|
122 | |||
123 | - rc_override: a dict or Struct of configuration options such as those |
|
123 | - rc_override: a dict or Struct of configuration options such as those | |
124 | used by IPython. These options are read from your ~/.ipython/ipythonrc |
|
124 | used by IPython. These options are read from your ~/.ipython/ipythonrc | |
125 | file when the Shell object is created. Passing an explicit rc_override |
|
125 | file when the Shell object is created. Passing an explicit rc_override | |
126 | dict with any options you want allows you to override those values at |
|
126 | dict with any options you want allows you to override those values at | |
127 | creation time without having to modify the file. This way you can create |
|
127 | creation time without having to modify the file. This way you can create | |
128 | embeddable instances configured in any way you want without editing any |
|
128 | embeddable instances configured in any way you want without editing any | |
129 | global files (thus keeping your interactive IPython configuration |
|
129 | global files (thus keeping your interactive IPython configuration | |
130 | unchanged). |
|
130 | unchanged). | |
131 |
|
131 | |||
132 | Then the ipshell instance can be called anywhere inside your code: |
|
132 | Then the ipshell instance can be called anywhere inside your code: | |
133 |
|
133 | |||
134 | ipshell(header='') -> Opens up an IPython shell. |
|
134 | ipshell(header='') -> Opens up an IPython shell. | |
135 |
|
135 | |||
136 | - header: string printed by the IPython shell upon startup. This can let |
|
136 | - header: string printed by the IPython shell upon startup. This can let | |
137 | you know where in your code you are when dropping into the shell. Note |
|
137 | you know where in your code you are when dropping into the shell. Note | |
138 | that 'banner' gets prepended to all calls, so header is used for |
|
138 | that 'banner' gets prepended to all calls, so header is used for | |
139 | location-specific information. |
|
139 | location-specific information. | |
140 |
|
140 | |||
141 | For more details, see the __call__ method below. |
|
141 | For more details, see the __call__ method below. | |
142 |
|
142 | |||
143 | When the IPython shell is exited with Ctrl-D, normal program execution |
|
143 | When the IPython shell is exited with Ctrl-D, normal program execution | |
144 | resumes. |
|
144 | resumes. | |
145 |
|
145 | |||
146 | This functionality was inspired by a posting on comp.lang.python by cmkl |
|
146 | This functionality was inspired by a posting on comp.lang.python by cmkl | |
147 | <cmkleffner@gmx.de> on Dec. 06/01 concerning similar uses of pyrepl, and |
|
147 | <cmkleffner@gmx.de> on Dec. 06/01 concerning similar uses of pyrepl, and | |
148 | by the IDL stop/continue commands.""" |
|
148 | by the IDL stop/continue commands.""" | |
149 |
|
149 | |||
150 | def __init__(self,argv=None,banner='',exit_msg=None,rc_override=None, |
|
150 | def __init__(self,argv=None,banner='',exit_msg=None,rc_override=None, | |
151 | user_ns=None): |
|
151 | user_ns=None): | |
152 | """Note that argv here is a string, NOT a list.""" |
|
152 | """Note that argv here is a string, NOT a list.""" | |
153 | self.set_banner(banner) |
|
153 | self.set_banner(banner) | |
154 | self.set_exit_msg(exit_msg) |
|
154 | self.set_exit_msg(exit_msg) | |
155 | self.set_dummy_mode(0) |
|
155 | self.set_dummy_mode(0) | |
156 |
|
156 | |||
157 | # sys.displayhook is a global, we need to save the user's original |
|
157 | # sys.displayhook is a global, we need to save the user's original | |
158 | # Don't rely on __displayhook__, as the user may have changed that. |
|
158 | # Don't rely on __displayhook__, as the user may have changed that. | |
159 | self.sys_displayhook_ori = sys.displayhook |
|
159 | self.sys_displayhook_ori = sys.displayhook | |
160 |
|
160 | |||
161 | # save readline completer status |
|
161 | # save readline completer status | |
162 | try: |
|
162 | try: | |
163 | #print 'Save completer',sys.ipcompleter # dbg |
|
163 | #print 'Save completer',sys.ipcompleter # dbg | |
164 | self.sys_ipcompleter_ori = sys.ipcompleter |
|
164 | self.sys_ipcompleter_ori = sys.ipcompleter | |
165 | except: |
|
165 | except: | |
166 | pass # not nested with IPython |
|
166 | pass # not nested with IPython | |
167 |
|
167 | |||
168 | self.IP = make_IPython(argv,rc_override=rc_override, |
|
168 | self.IP = make_IPython(argv,rc_override=rc_override, | |
169 | embedded=True, |
|
169 | embedded=True, | |
170 | user_ns=user_ns) |
|
170 | user_ns=user_ns) | |
171 |
|
171 | |||
172 | ip = ipapi.IPApi(self.IP) |
|
172 | ip = ipapi.IPApi(self.IP) | |
173 | ip.expose_magic("kill_embedded",kill_embedded) |
|
173 | ip.expose_magic("kill_embedded",kill_embedded) | |
174 |
|
174 | |||
175 | # copy our own displayhook also |
|
175 | # copy our own displayhook also | |
176 | self.sys_displayhook_embed = sys.displayhook |
|
176 | self.sys_displayhook_embed = sys.displayhook | |
177 | # and leave the system's display hook clean |
|
177 | # and leave the system's display hook clean | |
178 | sys.displayhook = self.sys_displayhook_ori |
|
178 | sys.displayhook = self.sys_displayhook_ori | |
179 | # don't use the ipython crash handler so that user exceptions aren't |
|
179 | # don't use the ipython crash handler so that user exceptions aren't | |
180 | # trapped |
|
180 | # trapped | |
181 |
sys.excepthook = ultra |
|
181 | sys.excepthook = ultratb.FormattedTB(color_scheme = self.IP.rc.colors, | |
182 | mode = self.IP.rc.xmode, |
|
182 | mode = self.IP.rc.xmode, | |
183 | call_pdb = self.IP.rc.pdb) |
|
183 | call_pdb = self.IP.rc.pdb) | |
184 | self.restore_system_completer() |
|
184 | self.restore_system_completer() | |
185 |
|
185 | |||
186 | def restore_system_completer(self): |
|
186 | def restore_system_completer(self): | |
187 | """Restores the readline completer which was in place. |
|
187 | """Restores the readline completer which was in place. | |
188 |
|
188 | |||
189 | This allows embedded IPython within IPython not to disrupt the |
|
189 | This allows embedded IPython within IPython not to disrupt the | |
190 | parent's completion. |
|
190 | parent's completion. | |
191 | """ |
|
191 | """ | |
192 |
|
192 | |||
193 | try: |
|
193 | try: | |
194 | self.IP.readline.set_completer(self.sys_ipcompleter_ori) |
|
194 | self.IP.readline.set_completer(self.sys_ipcompleter_ori) | |
195 | sys.ipcompleter = self.sys_ipcompleter_ori |
|
195 | sys.ipcompleter = self.sys_ipcompleter_ori | |
196 | except: |
|
196 | except: | |
197 | pass |
|
197 | pass | |
198 |
|
198 | |||
199 | def __call__(self,header='',local_ns=None,global_ns=None,dummy=None): |
|
199 | def __call__(self,header='',local_ns=None,global_ns=None,dummy=None): | |
200 | """Activate the interactive interpreter. |
|
200 | """Activate the interactive interpreter. | |
201 |
|
201 | |||
202 | __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start |
|
202 | __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start | |
203 | the interpreter shell with the given local and global namespaces, and |
|
203 | the interpreter shell with the given local and global namespaces, and | |
204 | optionally print a header string at startup. |
|
204 | optionally print a header string at startup. | |
205 |
|
205 | |||
206 | The shell can be globally activated/deactivated using the |
|
206 | The shell can be globally activated/deactivated using the | |
207 | set/get_dummy_mode methods. This allows you to turn off a shell used |
|
207 | set/get_dummy_mode methods. This allows you to turn off a shell used | |
208 | for debugging globally. |
|
208 | for debugging globally. | |
209 |
|
209 | |||
210 | However, *each* time you call the shell you can override the current |
|
210 | However, *each* time you call the shell you can override the current | |
211 | state of dummy_mode with the optional keyword parameter 'dummy'. For |
|
211 | state of dummy_mode with the optional keyword parameter 'dummy'. For | |
212 | example, if you set dummy mode on with IPShell.set_dummy_mode(1), you |
|
212 | example, if you set dummy mode on with IPShell.set_dummy_mode(1), you | |
213 | can still have a specific call work by making it as IPShell(dummy=0). |
|
213 | can still have a specific call work by making it as IPShell(dummy=0). | |
214 |
|
214 | |||
215 | The optional keyword parameter dummy controls whether the call |
|
215 | The optional keyword parameter dummy controls whether the call | |
216 | actually does anything. """ |
|
216 | actually does anything. """ | |
217 |
|
217 | |||
218 | # If the user has turned it off, go away |
|
218 | # If the user has turned it off, go away | |
219 | if not self.IP.embedded_active: |
|
219 | if not self.IP.embedded_active: | |
220 | return |
|
220 | return | |
221 |
|
221 | |||
222 | # Normal exits from interactive mode set this flag, so the shell can't |
|
222 | # Normal exits from interactive mode set this flag, so the shell can't | |
223 | # re-enter (it checks this variable at the start of interactive mode). |
|
223 | # re-enter (it checks this variable at the start of interactive mode). | |
224 | self.IP.exit_now = False |
|
224 | self.IP.exit_now = False | |
225 |
|
225 | |||
226 | # Allow the dummy parameter to override the global __dummy_mode |
|
226 | # Allow the dummy parameter to override the global __dummy_mode | |
227 | if dummy or (dummy != 0 and self.__dummy_mode): |
|
227 | if dummy or (dummy != 0 and self.__dummy_mode): | |
228 | return |
|
228 | return | |
229 |
|
229 | |||
230 | # Set global subsystems (display,completions) to our values |
|
230 | # Set global subsystems (display,completions) to our values | |
231 | sys.displayhook = self.sys_displayhook_embed |
|
231 | sys.displayhook = self.sys_displayhook_embed | |
232 | if self.IP.has_readline: |
|
232 | if self.IP.has_readline: | |
233 | self.IP.set_completer() |
|
233 | self.IP.set_completer() | |
234 |
|
234 | |||
235 | if self.banner and header: |
|
235 | if self.banner and header: | |
236 | format = '%s\n%s\n' |
|
236 | format = '%s\n%s\n' | |
237 | else: |
|
237 | else: | |
238 | format = '%s%s\n' |
|
238 | format = '%s%s\n' | |
239 | banner = format % (self.banner,header) |
|
239 | banner = format % (self.banner,header) | |
240 |
|
240 | |||
241 | # Call the embedding code with a stack depth of 1 so it can skip over |
|
241 | # Call the embedding code with a stack depth of 1 so it can skip over | |
242 | # our call and get the original caller's namespaces. |
|
242 | # our call and get the original caller's namespaces. | |
243 | self.IP.embed_mainloop(banner,local_ns,global_ns,stack_depth=1) |
|
243 | self.IP.embed_mainloop(banner,local_ns,global_ns,stack_depth=1) | |
244 |
|
244 | |||
245 | if self.exit_msg: |
|
245 | if self.exit_msg: | |
246 | print self.exit_msg |
|
246 | print self.exit_msg | |
247 |
|
247 | |||
248 | # Restore global systems (display, completion) |
|
248 | # Restore global systems (display, completion) | |
249 | sys.displayhook = self.sys_displayhook_ori |
|
249 | sys.displayhook = self.sys_displayhook_ori | |
250 | self.restore_system_completer() |
|
250 | self.restore_system_completer() | |
251 |
|
251 | |||
252 | def set_dummy_mode(self,dummy): |
|
252 | def set_dummy_mode(self,dummy): | |
253 | """Sets the embeddable shell's dummy mode parameter. |
|
253 | """Sets the embeddable shell's dummy mode parameter. | |
254 |
|
254 | |||
255 | set_dummy_mode(dummy): dummy = 0 or 1. |
|
255 | set_dummy_mode(dummy): dummy = 0 or 1. | |
256 |
|
256 | |||
257 | This parameter is persistent and makes calls to the embeddable shell |
|
257 | This parameter is persistent and makes calls to the embeddable shell | |
258 | silently return without performing any action. This allows you to |
|
258 | silently return without performing any action. This allows you to | |
259 | globally activate or deactivate a shell you're using with a single call. |
|
259 | globally activate or deactivate a shell you're using with a single call. | |
260 |
|
260 | |||
261 | If you need to manually""" |
|
261 | If you need to manually""" | |
262 |
|
262 | |||
263 | if dummy not in [0,1,False,True]: |
|
263 | if dummy not in [0,1,False,True]: | |
264 | raise ValueError,'dummy parameter must be boolean' |
|
264 | raise ValueError,'dummy parameter must be boolean' | |
265 | self.__dummy_mode = dummy |
|
265 | self.__dummy_mode = dummy | |
266 |
|
266 | |||
267 | def get_dummy_mode(self): |
|
267 | def get_dummy_mode(self): | |
268 | """Return the current value of the dummy mode parameter. |
|
268 | """Return the current value of the dummy mode parameter. | |
269 | """ |
|
269 | """ | |
270 | return self.__dummy_mode |
|
270 | return self.__dummy_mode | |
271 |
|
271 | |||
272 | def set_banner(self,banner): |
|
272 | def set_banner(self,banner): | |
273 | """Sets the global banner. |
|
273 | """Sets the global banner. | |
274 |
|
274 | |||
275 | This banner gets prepended to every header printed when the shell |
|
275 | This banner gets prepended to every header printed when the shell | |
276 | instance is called.""" |
|
276 | instance is called.""" | |
277 |
|
277 | |||
278 | self.banner = banner |
|
278 | self.banner = banner | |
279 |
|
279 | |||
280 | def set_exit_msg(self,exit_msg): |
|
280 | def set_exit_msg(self,exit_msg): | |
281 | """Sets the global exit_msg. |
|
281 | """Sets the global exit_msg. | |
282 |
|
282 | |||
283 | This exit message gets printed upon exiting every time the embedded |
|
283 | This exit message gets printed upon exiting every time the embedded | |
284 | shell is called. It is None by default. """ |
|
284 | shell is called. It is None by default. """ | |
285 |
|
285 | |||
286 | self.exit_msg = exit_msg |
|
286 | self.exit_msg = exit_msg | |
287 |
|
287 | |||
288 | #----------------------------------------------------------------------------- |
|
288 | #----------------------------------------------------------------------------- | |
289 | if HAS_CTYPES: |
|
289 | if HAS_CTYPES: | |
290 | # Add async exception support. Trick taken from: |
|
290 | # Add async exception support. Trick taken from: | |
291 | # http://sebulba.wikispaces.com/recipe+thread2 |
|
291 | # http://sebulba.wikispaces.com/recipe+thread2 | |
292 | def _async_raise(tid, exctype): |
|
292 | def _async_raise(tid, exctype): | |
293 | """raises the exception, performs cleanup if needed""" |
|
293 | """raises the exception, performs cleanup if needed""" | |
294 | if not inspect.isclass(exctype): |
|
294 | if not inspect.isclass(exctype): | |
295 | raise TypeError("Only types can be raised (not instances)") |
|
295 | raise TypeError("Only types can be raised (not instances)") | |
296 | # Explicit cast to c_long is necessary for 64-bit support: |
|
296 | # Explicit cast to c_long is necessary for 64-bit support: | |
297 | # See https://bugs.launchpad.net/ipython/+bug/237073 |
|
297 | # See https://bugs.launchpad.net/ipython/+bug/237073 | |
298 | res = ctypes.pythonapi.PyThreadState_SetAsyncExc(ctypes.c_long(tid), |
|
298 | res = ctypes.pythonapi.PyThreadState_SetAsyncExc(ctypes.c_long(tid), | |
299 | ctypes.py_object(exctype)) |
|
299 | ctypes.py_object(exctype)) | |
300 | if res == 0: |
|
300 | if res == 0: | |
301 | raise ValueError("invalid thread id") |
|
301 | raise ValueError("invalid thread id") | |
302 | elif res != 1: |
|
302 | elif res != 1: | |
303 | # If it returns a number greater than one, you're in trouble, |
|
303 | # If it returns a number greater than one, you're in trouble, | |
304 | # and you should call it again with exc=NULL to revert the effect |
|
304 | # and you should call it again with exc=NULL to revert the effect | |
305 | ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, 0) |
|
305 | ctypes.pythonapi.PyThreadState_SetAsyncExc(tid, 0) | |
306 | raise SystemError("PyThreadState_SetAsyncExc failed") |
|
306 | raise SystemError("PyThreadState_SetAsyncExc failed") | |
307 |
|
307 | |||
308 | def sigint_handler(signum,stack_frame): |
|
308 | def sigint_handler(signum,stack_frame): | |
309 | """Sigint handler for threaded apps. |
|
309 | """Sigint handler for threaded apps. | |
310 |
|
310 | |||
311 | This is a horrible hack to pass information about SIGINT _without_ |
|
311 | This is a horrible hack to pass information about SIGINT _without_ | |
312 | using exceptions, since I haven't been able to properly manage |
|
312 | using exceptions, since I haven't been able to properly manage | |
313 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be |
|
313 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be | |
314 | done (or at least that's my understanding from a c.l.py thread where |
|
314 | done (or at least that's my understanding from a c.l.py thread where | |
315 | this was discussed).""" |
|
315 | this was discussed).""" | |
316 |
|
316 | |||
317 | global KBINT |
|
317 | global KBINT | |
318 |
|
318 | |||
319 | if CODE_RUN: |
|
319 | if CODE_RUN: | |
320 | _async_raise(MAIN_THREAD_ID,KeyboardInterrupt) |
|
320 | _async_raise(MAIN_THREAD_ID,KeyboardInterrupt) | |
321 | else: |
|
321 | else: | |
322 | KBINT = True |
|
322 | KBINT = True | |
323 | print '\nKeyboardInterrupt - Press <Enter> to continue.', |
|
323 | print '\nKeyboardInterrupt - Press <Enter> to continue.', | |
324 | Term.cout.flush() |
|
324 | Term.cout.flush() | |
325 |
|
325 | |||
326 | else: |
|
326 | else: | |
327 | def sigint_handler(signum,stack_frame): |
|
327 | def sigint_handler(signum,stack_frame): | |
328 | """Sigint handler for threaded apps. |
|
328 | """Sigint handler for threaded apps. | |
329 |
|
329 | |||
330 | This is a horrible hack to pass information about SIGINT _without_ |
|
330 | This is a horrible hack to pass information about SIGINT _without_ | |
331 | using exceptions, since I haven't been able to properly manage |
|
331 | using exceptions, since I haven't been able to properly manage | |
332 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be |
|
332 | cross-thread exceptions in GTK/WX. In fact, I don't think it can be | |
333 | done (or at least that's my understanding from a c.l.py thread where |
|
333 | done (or at least that's my understanding from a c.l.py thread where | |
334 | this was discussed).""" |
|
334 | this was discussed).""" | |
335 |
|
335 | |||
336 | global KBINT |
|
336 | global KBINT | |
337 |
|
337 | |||
338 | print '\nKeyboardInterrupt - Press <Enter> to continue.', |
|
338 | print '\nKeyboardInterrupt - Press <Enter> to continue.', | |
339 | Term.cout.flush() |
|
339 | Term.cout.flush() | |
340 | # Set global flag so that runsource can know that Ctrl-C was hit |
|
340 | # Set global flag so that runsource can know that Ctrl-C was hit | |
341 | KBINT = True |
|
341 | KBINT = True | |
342 |
|
342 | |||
343 |
|
343 | |||
344 | class MTInteractiveShell(InteractiveShell): |
|
344 | class MTInteractiveShell(InteractiveShell): | |
345 | """Simple multi-threaded shell.""" |
|
345 | """Simple multi-threaded shell.""" | |
346 |
|
346 | |||
347 | # Threading strategy taken from: |
|
347 | # Threading strategy taken from: | |
348 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian |
|
348 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65109, by Brian | |
349 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, |
|
349 | # McErlean and John Finlay. Modified with corrections by Antoon Pardon, | |
350 | # from the pygtk mailing list, to avoid lockups with system calls. |
|
350 | # from the pygtk mailing list, to avoid lockups with system calls. | |
351 |
|
351 | |||
352 | # class attribute to indicate whether the class supports threads or not. |
|
352 | # class attribute to indicate whether the class supports threads or not. | |
353 | # Subclasses with thread support should override this as needed. |
|
353 | # Subclasses with thread support should override this as needed. | |
354 | isthreaded = True |
|
354 | isthreaded = True | |
355 |
|
355 | |||
356 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
356 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
357 | user_ns=None,user_global_ns=None,banner2='', |
|
357 | user_ns=None,user_global_ns=None,banner2='', | |
358 | gui_timeout=GUI_TIMEOUT,**kw): |
|
358 | gui_timeout=GUI_TIMEOUT,**kw): | |
359 | """Similar to the normal InteractiveShell, but with threading control""" |
|
359 | """Similar to the normal InteractiveShell, but with threading control""" | |
360 |
|
360 | |||
361 | InteractiveShell.__init__(self,name,usage,rc,user_ns, |
|
361 | InteractiveShell.__init__(self,name,usage,rc,user_ns, | |
362 | user_global_ns,banner2) |
|
362 | user_global_ns,banner2) | |
363 |
|
363 | |||
364 | # Timeout we wait for GUI thread |
|
364 | # Timeout we wait for GUI thread | |
365 | self.gui_timeout = gui_timeout |
|
365 | self.gui_timeout = gui_timeout | |
366 |
|
366 | |||
367 | # A queue to hold the code to be executed. |
|
367 | # A queue to hold the code to be executed. | |
368 | self.code_queue = Queue.Queue() |
|
368 | self.code_queue = Queue.Queue() | |
369 |
|
369 | |||
370 | # Stuff to do at closing time |
|
370 | # Stuff to do at closing time | |
371 | self._kill = None |
|
371 | self._kill = None | |
372 | on_kill = kw.get('on_kill', []) |
|
372 | on_kill = kw.get('on_kill', []) | |
373 | # Check that all things to kill are callable: |
|
373 | # Check that all things to kill are callable: | |
374 | for t in on_kill: |
|
374 | for t in on_kill: | |
375 | if not callable(t): |
|
375 | if not callable(t): | |
376 | raise TypeError,'on_kill must be a list of callables' |
|
376 | raise TypeError,'on_kill must be a list of callables' | |
377 | self.on_kill = on_kill |
|
377 | self.on_kill = on_kill | |
378 | # thread identity of the "worker thread" (that may execute code directly) |
|
378 | # thread identity of the "worker thread" (that may execute code directly) | |
379 | self.worker_ident = None |
|
379 | self.worker_ident = None | |
380 |
|
380 | |||
381 | def runsource(self, source, filename="<input>", symbol="single"): |
|
381 | def runsource(self, source, filename="<input>", symbol="single"): | |
382 | """Compile and run some source in the interpreter. |
|
382 | """Compile and run some source in the interpreter. | |
383 |
|
383 | |||
384 | Modified version of code.py's runsource(), to handle threading issues. |
|
384 | Modified version of code.py's runsource(), to handle threading issues. | |
385 | See the original for full docstring details.""" |
|
385 | See the original for full docstring details.""" | |
386 |
|
386 | |||
387 | global KBINT |
|
387 | global KBINT | |
388 |
|
388 | |||
389 | # If Ctrl-C was typed, we reset the flag and return right away |
|
389 | # If Ctrl-C was typed, we reset the flag and return right away | |
390 | if KBINT: |
|
390 | if KBINT: | |
391 | KBINT = False |
|
391 | KBINT = False | |
392 | return False |
|
392 | return False | |
393 |
|
393 | |||
394 | if self._kill: |
|
394 | if self._kill: | |
395 | # can't queue new code if we are being killed |
|
395 | # can't queue new code if we are being killed | |
396 | return True |
|
396 | return True | |
397 |
|
397 | |||
398 | try: |
|
398 | try: | |
399 | code = self.compile(source, filename, symbol) |
|
399 | code = self.compile(source, filename, symbol) | |
400 | except (OverflowError, SyntaxError, ValueError): |
|
400 | except (OverflowError, SyntaxError, ValueError): | |
401 | # Case 1 |
|
401 | # Case 1 | |
402 | self.showsyntaxerror(filename) |
|
402 | self.showsyntaxerror(filename) | |
403 | return False |
|
403 | return False | |
404 |
|
404 | |||
405 | if code is None: |
|
405 | if code is None: | |
406 | # Case 2 |
|
406 | # Case 2 | |
407 | return True |
|
407 | return True | |
408 |
|
408 | |||
409 | # shortcut - if we are in worker thread, or the worker thread is not |
|
409 | # shortcut - if we are in worker thread, or the worker thread is not | |
410 | # running, execute directly (to allow recursion and prevent deadlock if |
|
410 | # running, execute directly (to allow recursion and prevent deadlock if | |
411 | # code is run early in IPython construction) |
|
411 | # code is run early in IPython construction) | |
412 |
|
412 | |||
413 | if (self.worker_ident is None |
|
413 | if (self.worker_ident is None | |
414 | or self.worker_ident == thread.get_ident() ): |
|
414 | or self.worker_ident == thread.get_ident() ): | |
415 | InteractiveShell.runcode(self,code) |
|
415 | InteractiveShell.runcode(self,code) | |
416 | return False |
|
416 | return False | |
417 |
|
417 | |||
418 | # Case 3 |
|
418 | # Case 3 | |
419 | # Store code in queue, so the execution thread can handle it. |
|
419 | # Store code in queue, so the execution thread can handle it. | |
420 |
|
420 | |||
421 | completed_ev, received_ev = threading.Event(), threading.Event() |
|
421 | completed_ev, received_ev = threading.Event(), threading.Event() | |
422 |
|
422 | |||
423 | self.code_queue.put((code,completed_ev, received_ev)) |
|
423 | self.code_queue.put((code,completed_ev, received_ev)) | |
424 | # first make sure the message was received, with timeout |
|
424 | # first make sure the message was received, with timeout | |
425 | received_ev.wait(self.gui_timeout) |
|
425 | received_ev.wait(self.gui_timeout) | |
426 | if not received_ev.isSet(): |
|
426 | if not received_ev.isSet(): | |
427 | # the mainloop is dead, start executing code directly |
|
427 | # the mainloop is dead, start executing code directly | |
428 | print "Warning: Timeout for mainloop thread exceeded" |
|
428 | print "Warning: Timeout for mainloop thread exceeded" | |
429 | print "switching to nonthreaded mode (until mainloop wakes up again)" |
|
429 | print "switching to nonthreaded mode (until mainloop wakes up again)" | |
430 | self.worker_ident = None |
|
430 | self.worker_ident = None | |
431 | else: |
|
431 | else: | |
432 | completed_ev.wait() |
|
432 | completed_ev.wait() | |
433 | return False |
|
433 | return False | |
434 |
|
434 | |||
435 | def runcode(self): |
|
435 | def runcode(self): | |
436 | """Execute a code object. |
|
436 | """Execute a code object. | |
437 |
|
437 | |||
438 | Multithreaded wrapper around IPython's runcode().""" |
|
438 | Multithreaded wrapper around IPython's runcode().""" | |
439 |
|
439 | |||
440 | global CODE_RUN |
|
440 | global CODE_RUN | |
441 |
|
441 | |||
442 | # we are in worker thread, stash out the id for runsource() |
|
442 | # we are in worker thread, stash out the id for runsource() | |
443 | self.worker_ident = thread.get_ident() |
|
443 | self.worker_ident = thread.get_ident() | |
444 |
|
444 | |||
445 | if self._kill: |
|
445 | if self._kill: | |
446 | print >>Term.cout, 'Closing threads...', |
|
446 | print >>Term.cout, 'Closing threads...', | |
447 | Term.cout.flush() |
|
447 | Term.cout.flush() | |
448 | for tokill in self.on_kill: |
|
448 | for tokill in self.on_kill: | |
449 | tokill() |
|
449 | tokill() | |
450 | print >>Term.cout, 'Done.' |
|
450 | print >>Term.cout, 'Done.' | |
451 | # allow kill() to return |
|
451 | # allow kill() to return | |
452 | self._kill.set() |
|
452 | self._kill.set() | |
453 | return True |
|
453 | return True | |
454 |
|
454 | |||
455 | # Install sigint handler. We do it every time to ensure that if user |
|
455 | # Install sigint handler. We do it every time to ensure that if user | |
456 | # code modifies it, we restore our own handling. |
|
456 | # code modifies it, we restore our own handling. | |
457 | try: |
|
457 | try: | |
458 | signal(SIGINT,sigint_handler) |
|
458 | signal(SIGINT,sigint_handler) | |
459 | except SystemError: |
|
459 | except SystemError: | |
460 | # This happens under Windows, which seems to have all sorts |
|
460 | # This happens under Windows, which seems to have all sorts | |
461 | # of problems with signal handling. Oh well... |
|
461 | # of problems with signal handling. Oh well... | |
462 | pass |
|
462 | pass | |
463 |
|
463 | |||
464 | # Flush queue of pending code by calling the run methood of the parent |
|
464 | # Flush queue of pending code by calling the run methood of the parent | |
465 | # class with all items which may be in the queue. |
|
465 | # class with all items which may be in the queue. | |
466 | code_to_run = None |
|
466 | code_to_run = None | |
467 | while 1: |
|
467 | while 1: | |
468 | try: |
|
468 | try: | |
469 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() |
|
469 | code_to_run, completed_ev, received_ev = self.code_queue.get_nowait() | |
470 | except Queue.Empty: |
|
470 | except Queue.Empty: | |
471 | break |
|
471 | break | |
472 | received_ev.set() |
|
472 | received_ev.set() | |
473 |
|
473 | |||
474 | # Exceptions need to be raised differently depending on which |
|
474 | # Exceptions need to be raised differently depending on which | |
475 | # thread is active. This convoluted try/except is only there to |
|
475 | # thread is active. This convoluted try/except is only there to | |
476 | # protect against asynchronous exceptions, to ensure that a KBINT |
|
476 | # protect against asynchronous exceptions, to ensure that a KBINT | |
477 | # at the wrong time doesn't deadlock everything. The global |
|
477 | # at the wrong time doesn't deadlock everything. The global | |
478 | # CODE_TO_RUN is set to true/false as close as possible to the |
|
478 | # CODE_TO_RUN is set to true/false as close as possible to the | |
479 | # runcode() call, so that the KBINT handler is correctly informed. |
|
479 | # runcode() call, so that the KBINT handler is correctly informed. | |
480 | try: |
|
480 | try: | |
481 | try: |
|
481 | try: | |
482 | CODE_RUN = True |
|
482 | CODE_RUN = True | |
483 | InteractiveShell.runcode(self,code_to_run) |
|
483 | InteractiveShell.runcode(self,code_to_run) | |
484 | except KeyboardInterrupt: |
|
484 | except KeyboardInterrupt: | |
485 | print "Keyboard interrupted in mainloop" |
|
485 | print "Keyboard interrupted in mainloop" | |
486 | while not self.code_queue.empty(): |
|
486 | while not self.code_queue.empty(): | |
487 | code, ev1,ev2 = self.code_queue.get_nowait() |
|
487 | code, ev1,ev2 = self.code_queue.get_nowait() | |
488 | ev1.set() |
|
488 | ev1.set() | |
489 | ev2.set() |
|
489 | ev2.set() | |
490 | break |
|
490 | break | |
491 | finally: |
|
491 | finally: | |
492 | CODE_RUN = False |
|
492 | CODE_RUN = False | |
493 | # allow runsource() return from wait |
|
493 | # allow runsource() return from wait | |
494 | completed_ev.set() |
|
494 | completed_ev.set() | |
495 |
|
495 | |||
496 |
|
496 | |||
497 | # This MUST return true for gtk threading to work |
|
497 | # This MUST return true for gtk threading to work | |
498 | return True |
|
498 | return True | |
499 |
|
499 | |||
500 | def kill(self): |
|
500 | def kill(self): | |
501 | """Kill the thread, returning when it has been shut down.""" |
|
501 | """Kill the thread, returning when it has been shut down.""" | |
502 | self._kill = threading.Event() |
|
502 | self._kill = threading.Event() | |
503 | self._kill.wait() |
|
503 | self._kill.wait() | |
504 |
|
504 | |||
505 | class MatplotlibShellBase: |
|
505 | class MatplotlibShellBase: | |
506 | """Mixin class to provide the necessary modifications to regular IPython |
|
506 | """Mixin class to provide the necessary modifications to regular IPython | |
507 | shell classes for matplotlib support. |
|
507 | shell classes for matplotlib support. | |
508 |
|
508 | |||
509 | Given Python's MRO, this should be used as the FIRST class in the |
|
509 | Given Python's MRO, this should be used as the FIRST class in the | |
510 | inheritance hierarchy, so that it overrides the relevant methods.""" |
|
510 | inheritance hierarchy, so that it overrides the relevant methods.""" | |
511 |
|
511 | |||
512 | def _matplotlib_config(self,name,user_ns,user_global_ns=None): |
|
512 | def _matplotlib_config(self,name,user_ns,user_global_ns=None): | |
513 | """Return items needed to setup the user's shell with matplotlib""" |
|
513 | """Return items needed to setup the user's shell with matplotlib""" | |
514 |
|
514 | |||
515 | # Initialize matplotlib to interactive mode always |
|
515 | # Initialize matplotlib to interactive mode always | |
516 | import matplotlib |
|
516 | import matplotlib | |
517 | from matplotlib import backends |
|
517 | from matplotlib import backends | |
518 | matplotlib.interactive(True) |
|
518 | matplotlib.interactive(True) | |
519 |
|
519 | |||
520 | def use(arg): |
|
520 | def use(arg): | |
521 | """IPython wrapper for matplotlib's backend switcher. |
|
521 | """IPython wrapper for matplotlib's backend switcher. | |
522 |
|
522 | |||
523 | In interactive use, we can not allow switching to a different |
|
523 | In interactive use, we can not allow switching to a different | |
524 | interactive backend, since thread conflicts will most likely crash |
|
524 | interactive backend, since thread conflicts will most likely crash | |
525 | the python interpreter. This routine does a safety check first, |
|
525 | the python interpreter. This routine does a safety check first, | |
526 | and refuses to perform a dangerous switch. It still allows |
|
526 | and refuses to perform a dangerous switch. It still allows | |
527 | switching to non-interactive backends.""" |
|
527 | switching to non-interactive backends.""" | |
528 |
|
528 | |||
529 | if arg in backends.interactive_bk and arg != self.mpl_backend: |
|
529 | if arg in backends.interactive_bk and arg != self.mpl_backend: | |
530 | m=('invalid matplotlib backend switch.\n' |
|
530 | m=('invalid matplotlib backend switch.\n' | |
531 | 'This script attempted to switch to the interactive ' |
|
531 | 'This script attempted to switch to the interactive ' | |
532 | 'backend: `%s`\n' |
|
532 | 'backend: `%s`\n' | |
533 | 'Your current choice of interactive backend is: `%s`\n\n' |
|
533 | 'Your current choice of interactive backend is: `%s`\n\n' | |
534 | 'Switching interactive matplotlib backends at runtime\n' |
|
534 | 'Switching interactive matplotlib backends at runtime\n' | |
535 | 'would crash the python interpreter, ' |
|
535 | 'would crash the python interpreter, ' | |
536 | 'and IPython has blocked it.\n\n' |
|
536 | 'and IPython has blocked it.\n\n' | |
537 | 'You need to either change your choice of matplotlib backend\n' |
|
537 | 'You need to either change your choice of matplotlib backend\n' | |
538 | 'by editing your .matplotlibrc file, or run this script as a \n' |
|
538 | 'by editing your .matplotlibrc file, or run this script as a \n' | |
539 | 'standalone file from the command line, not using IPython.\n' % |
|
539 | 'standalone file from the command line, not using IPython.\n' % | |
540 | (arg,self.mpl_backend) ) |
|
540 | (arg,self.mpl_backend) ) | |
541 | raise RuntimeError, m |
|
541 | raise RuntimeError, m | |
542 | else: |
|
542 | else: | |
543 | self.mpl_use(arg) |
|
543 | self.mpl_use(arg) | |
544 | self.mpl_use._called = True |
|
544 | self.mpl_use._called = True | |
545 |
|
545 | |||
546 | self.matplotlib = matplotlib |
|
546 | self.matplotlib = matplotlib | |
547 | self.mpl_backend = matplotlib.rcParams['backend'] |
|
547 | self.mpl_backend = matplotlib.rcParams['backend'] | |
548 |
|
548 | |||
549 | # we also need to block switching of interactive backends by use() |
|
549 | # we also need to block switching of interactive backends by use() | |
550 | self.mpl_use = matplotlib.use |
|
550 | self.mpl_use = matplotlib.use | |
551 | self.mpl_use._called = False |
|
551 | self.mpl_use._called = False | |
552 | # overwrite the original matplotlib.use with our wrapper |
|
552 | # overwrite the original matplotlib.use with our wrapper | |
553 | matplotlib.use = use |
|
553 | matplotlib.use = use | |
554 |
|
554 | |||
555 | # This must be imported last in the matplotlib series, after |
|
555 | # This must be imported last in the matplotlib series, after | |
556 | # backend/interactivity choices have been made |
|
556 | # backend/interactivity choices have been made | |
557 | import matplotlib.pylab as pylab |
|
557 | import matplotlib.pylab as pylab | |
558 | self.pylab = pylab |
|
558 | self.pylab = pylab | |
559 |
|
559 | |||
560 | self.pylab.show._needmain = False |
|
560 | self.pylab.show._needmain = False | |
561 | # We need to detect at runtime whether show() is called by the user. |
|
561 | # We need to detect at runtime whether show() is called by the user. | |
562 | # For this, we wrap it into a decorator which adds a 'called' flag. |
|
562 | # For this, we wrap it into a decorator which adds a 'called' flag. | |
563 | self.pylab.draw_if_interactive = flag_calls(self.pylab.draw_if_interactive) |
|
563 | self.pylab.draw_if_interactive = flag_calls(self.pylab.draw_if_interactive) | |
564 |
|
564 | |||
565 | # Build a user namespace initialized with matplotlib/matlab features. |
|
565 | # Build a user namespace initialized with matplotlib/matlab features. | |
566 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, |
|
566 | user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns, | |
567 | user_global_ns) |
|
567 | user_global_ns) | |
568 |
|
568 | |||
569 | # Import numpy as np/pyplot as plt are conventions we're trying to |
|
569 | # Import numpy as np/pyplot as plt are conventions we're trying to | |
570 | # somewhat standardize on. Making them available to users by default |
|
570 | # somewhat standardize on. Making them available to users by default | |
571 | # will greatly help this. |
|
571 | # will greatly help this. | |
572 | exec ("import numpy\n" |
|
572 | exec ("import numpy\n" | |
573 | "import numpy as np\n" |
|
573 | "import numpy as np\n" | |
574 | "import matplotlib\n" |
|
574 | "import matplotlib\n" | |
575 | "import matplotlib.pylab as pylab\n" |
|
575 | "import matplotlib.pylab as pylab\n" | |
576 | "try:\n" |
|
576 | "try:\n" | |
577 | " import matplotlib.pyplot as plt\n" |
|
577 | " import matplotlib.pyplot as plt\n" | |
578 | "except ImportError:\n" |
|
578 | "except ImportError:\n" | |
579 | " pass\n" |
|
579 | " pass\n" | |
580 | ) in user_ns |
|
580 | ) in user_ns | |
581 |
|
581 | |||
582 | # Build matplotlib info banner |
|
582 | # Build matplotlib info banner | |
583 | b=""" |
|
583 | b=""" | |
584 | Welcome to pylab, a matplotlib-based Python environment. |
|
584 | Welcome to pylab, a matplotlib-based Python environment. | |
585 | For more information, type 'help(pylab)'. |
|
585 | For more information, type 'help(pylab)'. | |
586 | """ |
|
586 | """ | |
587 | return user_ns,user_global_ns,b |
|
587 | return user_ns,user_global_ns,b | |
588 |
|
588 | |||
589 | def mplot_exec(self,fname,*where,**kw): |
|
589 | def mplot_exec(self,fname,*where,**kw): | |
590 | """Execute a matplotlib script. |
|
590 | """Execute a matplotlib script. | |
591 |
|
591 | |||
592 | This is a call to execfile(), but wrapped in safeties to properly |
|
592 | This is a call to execfile(), but wrapped in safeties to properly | |
593 | handle interactive rendering and backend switching.""" |
|
593 | handle interactive rendering and backend switching.""" | |
594 |
|
594 | |||
595 | #print '*** Matplotlib runner ***' # dbg |
|
595 | #print '*** Matplotlib runner ***' # dbg | |
596 | # turn off rendering until end of script |
|
596 | # turn off rendering until end of script | |
597 | isInteractive = self.matplotlib.rcParams['interactive'] |
|
597 | isInteractive = self.matplotlib.rcParams['interactive'] | |
598 | self.matplotlib.interactive(False) |
|
598 | self.matplotlib.interactive(False) | |
599 | self.safe_execfile(fname,*where,**kw) |
|
599 | self.safe_execfile(fname,*where,**kw) | |
600 | self.matplotlib.interactive(isInteractive) |
|
600 | self.matplotlib.interactive(isInteractive) | |
601 | # make rendering call now, if the user tried to do it |
|
601 | # make rendering call now, if the user tried to do it | |
602 | if self.pylab.draw_if_interactive.called: |
|
602 | if self.pylab.draw_if_interactive.called: | |
603 | self.pylab.draw() |
|
603 | self.pylab.draw() | |
604 | self.pylab.draw_if_interactive.called = False |
|
604 | self.pylab.draw_if_interactive.called = False | |
605 |
|
605 | |||
606 | # if a backend switch was performed, reverse it now |
|
606 | # if a backend switch was performed, reverse it now | |
607 | if self.mpl_use._called: |
|
607 | if self.mpl_use._called: | |
608 | self.matplotlib.rcParams['backend'] = self.mpl_backend |
|
608 | self.matplotlib.rcParams['backend'] = self.mpl_backend | |
609 |
|
609 | |||
610 | @testdec.skip_doctest |
|
610 | @testdec.skip_doctest | |
611 | def magic_run(self,parameter_s=''): |
|
611 | def magic_run(self,parameter_s=''): | |
612 | Magic.magic_run(self,parameter_s,runner=self.mplot_exec) |
|
612 | Magic.magic_run(self,parameter_s,runner=self.mplot_exec) | |
613 |
|
613 | |||
614 | # Fix the docstring so users see the original as well |
|
614 | # Fix the docstring so users see the original as well | |
615 | magic_run.__doc__ = "%s\n%s" % (Magic.magic_run.__doc__, |
|
615 | magic_run.__doc__ = "%s\n%s" % (Magic.magic_run.__doc__, | |
616 | "\n *** Modified %run for Matplotlib," |
|
616 | "\n *** Modified %run for Matplotlib," | |
617 | " with proper interactive handling ***") |
|
617 | " with proper interactive handling ***") | |
618 |
|
618 | |||
619 | # Now we provide 2 versions of a matplotlib-aware IPython base shells, single |
|
619 | # Now we provide 2 versions of a matplotlib-aware IPython base shells, single | |
620 | # and multithreaded. Note that these are meant for internal use, the IPShell* |
|
620 | # and multithreaded. Note that these are meant for internal use, the IPShell* | |
621 | # classes below are the ones meant for public consumption. |
|
621 | # classes below are the ones meant for public consumption. | |
622 |
|
622 | |||
623 | class MatplotlibShell(MatplotlibShellBase,InteractiveShell): |
|
623 | class MatplotlibShell(MatplotlibShellBase,InteractiveShell): | |
624 | """Single-threaded shell with matplotlib support.""" |
|
624 | """Single-threaded shell with matplotlib support.""" | |
625 |
|
625 | |||
626 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
626 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
627 | user_ns=None,user_global_ns=None,**kw): |
|
627 | user_ns=None,user_global_ns=None,**kw): | |
628 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) |
|
628 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) | |
629 | InteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, |
|
629 | InteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, | |
630 | banner2=b2,**kw) |
|
630 | banner2=b2,**kw) | |
631 |
|
631 | |||
632 | class MatplotlibMTShell(MatplotlibShellBase,MTInteractiveShell): |
|
632 | class MatplotlibMTShell(MatplotlibShellBase,MTInteractiveShell): | |
633 | """Multi-threaded shell with matplotlib support.""" |
|
633 | """Multi-threaded shell with matplotlib support.""" | |
634 |
|
634 | |||
635 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), |
|
635 | def __init__(self,name,usage=None,rc=Struct(opts=None,args=None), | |
636 | user_ns=None,user_global_ns=None, **kw): |
|
636 | user_ns=None,user_global_ns=None, **kw): | |
637 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) |
|
637 | user_ns,user_global_ns,b2 = self._matplotlib_config(name,user_ns,user_global_ns) | |
638 | MTInteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, |
|
638 | MTInteractiveShell.__init__(self,name,usage,rc,user_ns,user_global_ns, | |
639 | banner2=b2,**kw) |
|
639 | banner2=b2,**kw) | |
640 |
|
640 | |||
641 | #----------------------------------------------------------------------------- |
|
641 | #----------------------------------------------------------------------------- | |
642 | # Utility functions for the different GUI enabled IPShell* classes. |
|
642 | # Utility functions for the different GUI enabled IPShell* classes. | |
643 |
|
643 | |||
644 | def get_tk(): |
|
644 | def get_tk(): | |
645 | """Tries to import Tkinter and returns a withdrawn Tkinter root |
|
645 | """Tries to import Tkinter and returns a withdrawn Tkinter root | |
646 | window. If Tkinter is already imported or not available, this |
|
646 | window. If Tkinter is already imported or not available, this | |
647 | returns None. This function calls `hijack_tk` underneath. |
|
647 | returns None. This function calls `hijack_tk` underneath. | |
648 | """ |
|
648 | """ | |
649 | if not USE_TK or sys.modules.has_key('Tkinter'): |
|
649 | if not USE_TK or sys.modules.has_key('Tkinter'): | |
650 | return None |
|
650 | return None | |
651 | else: |
|
651 | else: | |
652 | try: |
|
652 | try: | |
653 | import Tkinter |
|
653 | import Tkinter | |
654 | except ImportError: |
|
654 | except ImportError: | |
655 | return None |
|
655 | return None | |
656 | else: |
|
656 | else: | |
657 | hijack_tk() |
|
657 | hijack_tk() | |
658 | r = Tkinter.Tk() |
|
658 | r = Tkinter.Tk() | |
659 | r.withdraw() |
|
659 | r.withdraw() | |
660 | return r |
|
660 | return r | |
661 |
|
661 | |||
662 | def hijack_tk(): |
|
662 | def hijack_tk(): | |
663 | """Modifies Tkinter's mainloop with a dummy so when a module calls |
|
663 | """Modifies Tkinter's mainloop with a dummy so when a module calls | |
664 | mainloop, it does not block. |
|
664 | mainloop, it does not block. | |
665 |
|
665 | |||
666 | """ |
|
666 | """ | |
667 | def misc_mainloop(self, n=0): |
|
667 | def misc_mainloop(self, n=0): | |
668 | pass |
|
668 | pass | |
669 | def tkinter_mainloop(n=0): |
|
669 | def tkinter_mainloop(n=0): | |
670 | pass |
|
670 | pass | |
671 |
|
671 | |||
672 | import Tkinter |
|
672 | import Tkinter | |
673 | Tkinter.Misc.mainloop = misc_mainloop |
|
673 | Tkinter.Misc.mainloop = misc_mainloop | |
674 | Tkinter.mainloop = tkinter_mainloop |
|
674 | Tkinter.mainloop = tkinter_mainloop | |
675 |
|
675 | |||
676 | def update_tk(tk): |
|
676 | def update_tk(tk): | |
677 | """Updates the Tkinter event loop. This is typically called from |
|
677 | """Updates the Tkinter event loop. This is typically called from | |
678 | the respective WX or GTK mainloops. |
|
678 | the respective WX or GTK mainloops. | |
679 | """ |
|
679 | """ | |
680 | if tk: |
|
680 | if tk: | |
681 | tk.update() |
|
681 | tk.update() | |
682 |
|
682 | |||
683 | def hijack_wx(): |
|
683 | def hijack_wx(): | |
684 | """Modifies wxPython's MainLoop with a dummy so user code does not |
|
684 | """Modifies wxPython's MainLoop with a dummy so user code does not | |
685 | block IPython. The hijacked mainloop function is returned. |
|
685 | block IPython. The hijacked mainloop function is returned. | |
686 | """ |
|
686 | """ | |
687 | def dummy_mainloop(*args, **kw): |
|
687 | def dummy_mainloop(*args, **kw): | |
688 | pass |
|
688 | pass | |
689 |
|
689 | |||
690 | try: |
|
690 | try: | |
691 | import wx |
|
691 | import wx | |
692 | except ImportError: |
|
692 | except ImportError: | |
693 | # For very old versions of WX |
|
693 | # For very old versions of WX | |
694 | import wxPython as wx |
|
694 | import wxPython as wx | |
695 |
|
695 | |||
696 | ver = wx.__version__ |
|
696 | ver = wx.__version__ | |
697 | orig_mainloop = None |
|
697 | orig_mainloop = None | |
698 | if ver[:3] >= '2.5': |
|
698 | if ver[:3] >= '2.5': | |
699 | import wx |
|
699 | import wx | |
700 | if hasattr(wx, '_core_'): core = getattr(wx, '_core_') |
|
700 | if hasattr(wx, '_core_'): core = getattr(wx, '_core_') | |
701 | elif hasattr(wx, '_core'): core = getattr(wx, '_core') |
|
701 | elif hasattr(wx, '_core'): core = getattr(wx, '_core') | |
702 | else: raise AttributeError('Could not find wx core module') |
|
702 | else: raise AttributeError('Could not find wx core module') | |
703 | orig_mainloop = core.PyApp_MainLoop |
|
703 | orig_mainloop = core.PyApp_MainLoop | |
704 | core.PyApp_MainLoop = dummy_mainloop |
|
704 | core.PyApp_MainLoop = dummy_mainloop | |
705 | elif ver[:3] == '2.4': |
|
705 | elif ver[:3] == '2.4': | |
706 | orig_mainloop = wx.wxc.wxPyApp_MainLoop |
|
706 | orig_mainloop = wx.wxc.wxPyApp_MainLoop | |
707 | wx.wxc.wxPyApp_MainLoop = dummy_mainloop |
|
707 | wx.wxc.wxPyApp_MainLoop = dummy_mainloop | |
708 | else: |
|
708 | else: | |
709 | warn("Unable to find either wxPython version 2.4 or >= 2.5.") |
|
709 | warn("Unable to find either wxPython version 2.4 or >= 2.5.") | |
710 | return orig_mainloop |
|
710 | return orig_mainloop | |
711 |
|
711 | |||
712 | def hijack_gtk(): |
|
712 | def hijack_gtk(): | |
713 | """Modifies pyGTK's mainloop with a dummy so user code does not |
|
713 | """Modifies pyGTK's mainloop with a dummy so user code does not | |
714 | block IPython. This function returns the original `gtk.mainloop` |
|
714 | block IPython. This function returns the original `gtk.mainloop` | |
715 | function that has been hijacked. |
|
715 | function that has been hijacked. | |
716 | """ |
|
716 | """ | |
717 | def dummy_mainloop(*args, **kw): |
|
717 | def dummy_mainloop(*args, **kw): | |
718 | pass |
|
718 | pass | |
719 | import gtk |
|
719 | import gtk | |
720 | if gtk.pygtk_version >= (2,4,0): orig_mainloop = gtk.main |
|
720 | if gtk.pygtk_version >= (2,4,0): orig_mainloop = gtk.main | |
721 | else: orig_mainloop = gtk.mainloop |
|
721 | else: orig_mainloop = gtk.mainloop | |
722 | gtk.mainloop = dummy_mainloop |
|
722 | gtk.mainloop = dummy_mainloop | |
723 | gtk.main = dummy_mainloop |
|
723 | gtk.main = dummy_mainloop | |
724 | return orig_mainloop |
|
724 | return orig_mainloop | |
725 |
|
725 | |||
726 | def hijack_qt(): |
|
726 | def hijack_qt(): | |
727 | """Modifies PyQt's mainloop with a dummy so user code does not |
|
727 | """Modifies PyQt's mainloop with a dummy so user code does not | |
728 | block IPython. This function returns the original |
|
728 | block IPython. This function returns the original | |
729 | `qt.qApp.exec_loop` function that has been hijacked. |
|
729 | `qt.qApp.exec_loop` function that has been hijacked. | |
730 | """ |
|
730 | """ | |
731 | def dummy_mainloop(*args, **kw): |
|
731 | def dummy_mainloop(*args, **kw): | |
732 | pass |
|
732 | pass | |
733 | import qt |
|
733 | import qt | |
734 | orig_mainloop = qt.qApp.exec_loop |
|
734 | orig_mainloop = qt.qApp.exec_loop | |
735 | qt.qApp.exec_loop = dummy_mainloop |
|
735 | qt.qApp.exec_loop = dummy_mainloop | |
736 | qt.QApplication.exec_loop = dummy_mainloop |
|
736 | qt.QApplication.exec_loop = dummy_mainloop | |
737 | return orig_mainloop |
|
737 | return orig_mainloop | |
738 |
|
738 | |||
739 | def hijack_qt4(): |
|
739 | def hijack_qt4(): | |
740 | """Modifies PyQt4's mainloop with a dummy so user code does not |
|
740 | """Modifies PyQt4's mainloop with a dummy so user code does not | |
741 | block IPython. This function returns the original |
|
741 | block IPython. This function returns the original | |
742 | `QtGui.qApp.exec_` function that has been hijacked. |
|
742 | `QtGui.qApp.exec_` function that has been hijacked. | |
743 | """ |
|
743 | """ | |
744 | def dummy_mainloop(*args, **kw): |
|
744 | def dummy_mainloop(*args, **kw): | |
745 | pass |
|
745 | pass | |
746 | from PyQt4 import QtGui, QtCore |
|
746 | from PyQt4 import QtGui, QtCore | |
747 | orig_mainloop = QtGui.qApp.exec_ |
|
747 | orig_mainloop = QtGui.qApp.exec_ | |
748 | QtGui.qApp.exec_ = dummy_mainloop |
|
748 | QtGui.qApp.exec_ = dummy_mainloop | |
749 | QtGui.QApplication.exec_ = dummy_mainloop |
|
749 | QtGui.QApplication.exec_ = dummy_mainloop | |
750 | QtCore.QCoreApplication.exec_ = dummy_mainloop |
|
750 | QtCore.QCoreApplication.exec_ = dummy_mainloop | |
751 | return orig_mainloop |
|
751 | return orig_mainloop | |
752 |
|
752 | |||
753 | #----------------------------------------------------------------------------- |
|
753 | #----------------------------------------------------------------------------- | |
754 | # The IPShell* classes below are the ones meant to be run by external code as |
|
754 | # The IPShell* classes below are the ones meant to be run by external code as | |
755 | # IPython instances. Note that unless a specific threading strategy is |
|
755 | # IPython instances. Note that unless a specific threading strategy is | |
756 | # desired, the factory function start() below should be used instead (it |
|
756 | # desired, the factory function start() below should be used instead (it | |
757 | # selects the proper threaded class). |
|
757 | # selects the proper threaded class). | |
758 |
|
758 | |||
759 | class IPThread(threading.Thread): |
|
759 | class IPThread(threading.Thread): | |
760 | def run(self): |
|
760 | def run(self): | |
761 | self.IP.mainloop(self._banner) |
|
761 | self.IP.mainloop(self._banner) | |
762 | self.IP.kill() |
|
762 | self.IP.kill() | |
763 |
|
763 | |||
764 | class IPShellGTK(IPThread): |
|
764 | class IPShellGTK(IPThread): | |
765 | """Run a gtk mainloop() in a separate thread. |
|
765 | """Run a gtk mainloop() in a separate thread. | |
766 |
|
766 | |||
767 | Python commands can be passed to the thread where they will be executed. |
|
767 | Python commands can be passed to the thread where they will be executed. | |
768 | This is implemented by periodically checking for passed code using a |
|
768 | This is implemented by periodically checking for passed code using a | |
769 | GTK timeout callback.""" |
|
769 | GTK timeout callback.""" | |
770 |
|
770 | |||
771 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
771 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
772 |
|
772 | |||
773 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
773 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
774 | debug=1,shell_class=MTInteractiveShell): |
|
774 | debug=1,shell_class=MTInteractiveShell): | |
775 |
|
775 | |||
776 | import gtk |
|
776 | import gtk | |
777 | # Check for set_interactive, coming up in new pygtk. |
|
777 | # Check for set_interactive, coming up in new pygtk. | |
778 | # Disable it so that this code works, but notify |
|
778 | # Disable it so that this code works, but notify | |
779 | # the user that he has a better option as well. |
|
779 | # the user that he has a better option as well. | |
780 | # XXX TODO better support when set_interactive is released |
|
780 | # XXX TODO better support when set_interactive is released | |
781 | try: |
|
781 | try: | |
782 | gtk.set_interactive(False) |
|
782 | gtk.set_interactive(False) | |
783 | print "Your PyGtk has set_interactive(), so you can use the" |
|
783 | print "Your PyGtk has set_interactive(), so you can use the" | |
784 | print "more stable single-threaded Gtk mode." |
|
784 | print "more stable single-threaded Gtk mode." | |
785 | print "See https://bugs.launchpad.net/ipython/+bug/270856" |
|
785 | print "See https://bugs.launchpad.net/ipython/+bug/270856" | |
786 | except AttributeError: |
|
786 | except AttributeError: | |
787 | pass |
|
787 | pass | |
788 |
|
788 | |||
789 | self.gtk = gtk |
|
789 | self.gtk = gtk | |
790 | self.gtk_mainloop = hijack_gtk() |
|
790 | self.gtk_mainloop = hijack_gtk() | |
791 |
|
791 | |||
792 | # Allows us to use both Tk and GTK. |
|
792 | # Allows us to use both Tk and GTK. | |
793 | self.tk = get_tk() |
|
793 | self.tk = get_tk() | |
794 |
|
794 | |||
795 | if gtk.pygtk_version >= (2,4,0): mainquit = self.gtk.main_quit |
|
795 | if gtk.pygtk_version >= (2,4,0): mainquit = self.gtk.main_quit | |
796 | else: mainquit = self.gtk.mainquit |
|
796 | else: mainquit = self.gtk.mainquit | |
797 |
|
797 | |||
798 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
798 | self.IP = make_IPython(argv,user_ns=user_ns, | |
799 | user_global_ns=user_global_ns, |
|
799 | user_global_ns=user_global_ns, | |
800 | debug=debug, |
|
800 | debug=debug, | |
801 | shell_class=shell_class, |
|
801 | shell_class=shell_class, | |
802 | on_kill=[mainquit]) |
|
802 | on_kill=[mainquit]) | |
803 |
|
803 | |||
804 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
804 | # HACK: slot for banner in self; it will be passed to the mainloop | |
805 | # method only and .run() needs it. The actual value will be set by |
|
805 | # method only and .run() needs it. The actual value will be set by | |
806 | # .mainloop(). |
|
806 | # .mainloop(). | |
807 | self._banner = None |
|
807 | self._banner = None | |
808 |
|
808 | |||
809 | threading.Thread.__init__(self) |
|
809 | threading.Thread.__init__(self) | |
810 |
|
810 | |||
811 | def mainloop(self,sys_exit=0,banner=None): |
|
811 | def mainloop(self,sys_exit=0,banner=None): | |
812 |
|
812 | |||
813 | self._banner = banner |
|
813 | self._banner = banner | |
814 |
|
814 | |||
815 | if self.gtk.pygtk_version >= (2,4,0): |
|
815 | if self.gtk.pygtk_version >= (2,4,0): | |
816 | import gobject |
|
816 | import gobject | |
817 | gobject.idle_add(self.on_timer) |
|
817 | gobject.idle_add(self.on_timer) | |
818 | else: |
|
818 | else: | |
819 | self.gtk.idle_add(self.on_timer) |
|
819 | self.gtk.idle_add(self.on_timer) | |
820 |
|
820 | |||
821 | if sys.platform != 'win32': |
|
821 | if sys.platform != 'win32': | |
822 | try: |
|
822 | try: | |
823 | if self.gtk.gtk_version[0] >= 2: |
|
823 | if self.gtk.gtk_version[0] >= 2: | |
824 | self.gtk.gdk.threads_init() |
|
824 | self.gtk.gdk.threads_init() | |
825 | except AttributeError: |
|
825 | except AttributeError: | |
826 | pass |
|
826 | pass | |
827 | except RuntimeError: |
|
827 | except RuntimeError: | |
828 | error('Your pyGTK likely has not been compiled with ' |
|
828 | error('Your pyGTK likely has not been compiled with ' | |
829 | 'threading support.\n' |
|
829 | 'threading support.\n' | |
830 | 'The exception printout is below.\n' |
|
830 | 'The exception printout is below.\n' | |
831 | 'You can either rebuild pyGTK with threads, or ' |
|
831 | 'You can either rebuild pyGTK with threads, or ' | |
832 | 'try using \n' |
|
832 | 'try using \n' | |
833 | 'matplotlib with a different backend (like Tk or WX).\n' |
|
833 | 'matplotlib with a different backend (like Tk or WX).\n' | |
834 | 'Note that matplotlib will most likely not work in its ' |
|
834 | 'Note that matplotlib will most likely not work in its ' | |
835 | 'current state!') |
|
835 | 'current state!') | |
836 | self.IP.InteractiveTB() |
|
836 | self.IP.InteractiveTB() | |
837 |
|
837 | |||
838 | self.start() |
|
838 | self.start() | |
839 | self.gtk.gdk.threads_enter() |
|
839 | self.gtk.gdk.threads_enter() | |
840 | self.gtk_mainloop() |
|
840 | self.gtk_mainloop() | |
841 | self.gtk.gdk.threads_leave() |
|
841 | self.gtk.gdk.threads_leave() | |
842 | self.join() |
|
842 | self.join() | |
843 |
|
843 | |||
844 | def on_timer(self): |
|
844 | def on_timer(self): | |
845 | """Called when GTK is idle. |
|
845 | """Called when GTK is idle. | |
846 |
|
846 | |||
847 | Must return True always, otherwise GTK stops calling it""" |
|
847 | Must return True always, otherwise GTK stops calling it""" | |
848 |
|
848 | |||
849 | update_tk(self.tk) |
|
849 | update_tk(self.tk) | |
850 | self.IP.runcode() |
|
850 | self.IP.runcode() | |
851 | time.sleep(0.01) |
|
851 | time.sleep(0.01) | |
852 | return True |
|
852 | return True | |
853 |
|
853 | |||
854 |
|
854 | |||
855 | class IPShellWX(IPThread): |
|
855 | class IPShellWX(IPThread): | |
856 | """Run a wx mainloop() in a separate thread. |
|
856 | """Run a wx mainloop() in a separate thread. | |
857 |
|
857 | |||
858 | Python commands can be passed to the thread where they will be executed. |
|
858 | Python commands can be passed to the thread where they will be executed. | |
859 | This is implemented by periodically checking for passed code using a |
|
859 | This is implemented by periodically checking for passed code using a | |
860 | GTK timeout callback.""" |
|
860 | GTK timeout callback.""" | |
861 |
|
861 | |||
862 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
862 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
863 |
|
863 | |||
864 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, |
|
864 | def __init__(self,argv=None,user_ns=None,user_global_ns=None, | |
865 | debug=1,shell_class=MTInteractiveShell): |
|
865 | debug=1,shell_class=MTInteractiveShell): | |
866 |
|
866 | |||
867 | self.IP = make_IPython(argv,user_ns=user_ns, |
|
867 | self.IP = make_IPython(argv,user_ns=user_ns, | |
868 | user_global_ns=user_global_ns, |
|
868 | user_global_ns=user_global_ns, | |
869 | debug=debug, |
|
869 | debug=debug, | |
870 | shell_class=shell_class, |
|
870 | shell_class=shell_class, | |
871 | on_kill=[self.wxexit]) |
|
871 | on_kill=[self.wxexit]) | |
872 |
|
872 | |||
873 | wantedwxversion=self.IP.rc.wxversion |
|
873 | wantedwxversion=self.IP.rc.wxversion | |
874 | if wantedwxversion!="0": |
|
874 | if wantedwxversion!="0": | |
875 | try: |
|
875 | try: | |
876 | import wxversion |
|
876 | import wxversion | |
877 | except ImportError: |
|
877 | except ImportError: | |
878 | error('The wxversion module is needed for WX version selection') |
|
878 | error('The wxversion module is needed for WX version selection') | |
879 | else: |
|
879 | else: | |
880 | try: |
|
880 | try: | |
881 | wxversion.select(wantedwxversion) |
|
881 | wxversion.select(wantedwxversion) | |
882 | except: |
|
882 | except: | |
883 | self.IP.InteractiveTB() |
|
883 | self.IP.InteractiveTB() | |
884 | error('Requested wxPython version %s could not be loaded' % |
|
884 | error('Requested wxPython version %s could not be loaded' % | |
885 | wantedwxversion) |
|
885 | wantedwxversion) | |
886 |
|
886 | |||
887 | import wx |
|
887 | import wx | |
888 |
|
888 | |||
889 | threading.Thread.__init__(self) |
|
889 | threading.Thread.__init__(self) | |
890 | self.wx = wx |
|
890 | self.wx = wx | |
891 | self.wx_mainloop = hijack_wx() |
|
891 | self.wx_mainloop = hijack_wx() | |
892 |
|
892 | |||
893 | # Allows us to use both Tk and GTK. |
|
893 | # Allows us to use both Tk and GTK. | |
894 | self.tk = get_tk() |
|
894 | self.tk = get_tk() | |
895 |
|
895 | |||
896 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
896 | # HACK: slot for banner in self; it will be passed to the mainloop | |
897 | # method only and .run() needs it. The actual value will be set by |
|
897 | # method only and .run() needs it. The actual value will be set by | |
898 | # .mainloop(). |
|
898 | # .mainloop(). | |
899 | self._banner = None |
|
899 | self._banner = None | |
900 |
|
900 | |||
901 | self.app = None |
|
901 | self.app = None | |
902 |
|
902 | |||
903 | def wxexit(self, *args): |
|
903 | def wxexit(self, *args): | |
904 | if self.app is not None: |
|
904 | if self.app is not None: | |
905 | self.app.agent.timer.Stop() |
|
905 | self.app.agent.timer.Stop() | |
906 | self.app.ExitMainLoop() |
|
906 | self.app.ExitMainLoop() | |
907 |
|
907 | |||
908 | def mainloop(self,sys_exit=0,banner=None): |
|
908 | def mainloop(self,sys_exit=0,banner=None): | |
909 |
|
909 | |||
910 | self._banner = banner |
|
910 | self._banner = banner | |
911 |
|
911 | |||
912 | self.start() |
|
912 | self.start() | |
913 |
|
913 | |||
914 | class TimerAgent(self.wx.MiniFrame): |
|
914 | class TimerAgent(self.wx.MiniFrame): | |
915 | wx = self.wx |
|
915 | wx = self.wx | |
916 | IP = self.IP |
|
916 | IP = self.IP | |
917 | tk = self.tk |
|
917 | tk = self.tk | |
918 | def __init__(self, parent, interval): |
|
918 | def __init__(self, parent, interval): | |
919 | style = self.wx.DEFAULT_FRAME_STYLE | self.wx.TINY_CAPTION_HORIZ |
|
919 | style = self.wx.DEFAULT_FRAME_STYLE | self.wx.TINY_CAPTION_HORIZ | |
920 | self.wx.MiniFrame.__init__(self, parent, -1, ' ', pos=(200, 200), |
|
920 | self.wx.MiniFrame.__init__(self, parent, -1, ' ', pos=(200, 200), | |
921 | size=(100, 100),style=style) |
|
921 | size=(100, 100),style=style) | |
922 | self.Show(False) |
|
922 | self.Show(False) | |
923 | self.interval = interval |
|
923 | self.interval = interval | |
924 | self.timerId = self.wx.NewId() |
|
924 | self.timerId = self.wx.NewId() | |
925 |
|
925 | |||
926 | def StartWork(self): |
|
926 | def StartWork(self): | |
927 | self.timer = self.wx.Timer(self, self.timerId) |
|
927 | self.timer = self.wx.Timer(self, self.timerId) | |
928 | self.wx.EVT_TIMER(self, self.timerId, self.OnTimer) |
|
928 | self.wx.EVT_TIMER(self, self.timerId, self.OnTimer) | |
929 | self.timer.Start(self.interval) |
|
929 | self.timer.Start(self.interval) | |
930 |
|
930 | |||
931 | def OnTimer(self, event): |
|
931 | def OnTimer(self, event): | |
932 | update_tk(self.tk) |
|
932 | update_tk(self.tk) | |
933 | self.IP.runcode() |
|
933 | self.IP.runcode() | |
934 |
|
934 | |||
935 | class App(self.wx.App): |
|
935 | class App(self.wx.App): | |
936 | wx = self.wx |
|
936 | wx = self.wx | |
937 | TIMEOUT = self.TIMEOUT |
|
937 | TIMEOUT = self.TIMEOUT | |
938 | def OnInit(self): |
|
938 | def OnInit(self): | |
939 | 'Create the main window and insert the custom frame' |
|
939 | 'Create the main window and insert the custom frame' | |
940 | self.agent = TimerAgent(None, self.TIMEOUT) |
|
940 | self.agent = TimerAgent(None, self.TIMEOUT) | |
941 | self.agent.Show(False) |
|
941 | self.agent.Show(False) | |
942 | self.agent.StartWork() |
|
942 | self.agent.StartWork() | |
943 | return True |
|
943 | return True | |
944 |
|
944 | |||
945 | self.app = App(redirect=False) |
|
945 | self.app = App(redirect=False) | |
946 | self.wx_mainloop(self.app) |
|
946 | self.wx_mainloop(self.app) | |
947 | self.join() |
|
947 | self.join() | |
948 |
|
948 | |||
949 |
|
949 | |||
950 | class IPShellQt(IPThread): |
|
950 | class IPShellQt(IPThread): | |
951 | """Run a Qt event loop in a separate thread. |
|
951 | """Run a Qt event loop in a separate thread. | |
952 |
|
952 | |||
953 | Python commands can be passed to the thread where they will be executed. |
|
953 | Python commands can be passed to the thread where they will be executed. | |
954 | This is implemented by periodically checking for passed code using a |
|
954 | This is implemented by periodically checking for passed code using a | |
955 | Qt timer / slot.""" |
|
955 | Qt timer / slot.""" | |
956 |
|
956 | |||
957 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
957 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
958 |
|
958 | |||
959 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, |
|
959 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, | |
960 | debug=0, shell_class=MTInteractiveShell): |
|
960 | debug=0, shell_class=MTInteractiveShell): | |
961 |
|
961 | |||
962 | import qt |
|
962 | import qt | |
963 |
|
963 | |||
964 | self.exec_loop = hijack_qt() |
|
964 | self.exec_loop = hijack_qt() | |
965 |
|
965 | |||
966 | # Allows us to use both Tk and QT. |
|
966 | # Allows us to use both Tk and QT. | |
967 | self.tk = get_tk() |
|
967 | self.tk = get_tk() | |
968 |
|
968 | |||
969 | self.IP = make_IPython(argv, |
|
969 | self.IP = make_IPython(argv, | |
970 | user_ns=user_ns, |
|
970 | user_ns=user_ns, | |
971 | user_global_ns=user_global_ns, |
|
971 | user_global_ns=user_global_ns, | |
972 | debug=debug, |
|
972 | debug=debug, | |
973 | shell_class=shell_class, |
|
973 | shell_class=shell_class, | |
974 | on_kill=[qt.qApp.exit]) |
|
974 | on_kill=[qt.qApp.exit]) | |
975 |
|
975 | |||
976 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
976 | # HACK: slot for banner in self; it will be passed to the mainloop | |
977 | # method only and .run() needs it. The actual value will be set by |
|
977 | # method only and .run() needs it. The actual value will be set by | |
978 | # .mainloop(). |
|
978 | # .mainloop(). | |
979 | self._banner = None |
|
979 | self._banner = None | |
980 |
|
980 | |||
981 | threading.Thread.__init__(self) |
|
981 | threading.Thread.__init__(self) | |
982 |
|
982 | |||
983 | def mainloop(self, sys_exit=0, banner=None): |
|
983 | def mainloop(self, sys_exit=0, banner=None): | |
984 |
|
984 | |||
985 | import qt |
|
985 | import qt | |
986 |
|
986 | |||
987 | self._banner = banner |
|
987 | self._banner = banner | |
988 |
|
988 | |||
989 | if qt.QApplication.startingUp(): |
|
989 | if qt.QApplication.startingUp(): | |
990 | a = qt.QApplication(sys.argv) |
|
990 | a = qt.QApplication(sys.argv) | |
991 |
|
991 | |||
992 | self.timer = qt.QTimer() |
|
992 | self.timer = qt.QTimer() | |
993 | qt.QObject.connect(self.timer, |
|
993 | qt.QObject.connect(self.timer, | |
994 | qt.SIGNAL('timeout()'), |
|
994 | qt.SIGNAL('timeout()'), | |
995 | self.on_timer) |
|
995 | self.on_timer) | |
996 |
|
996 | |||
997 | self.start() |
|
997 | self.start() | |
998 | self.timer.start(self.TIMEOUT, True) |
|
998 | self.timer.start(self.TIMEOUT, True) | |
999 | while True: |
|
999 | while True: | |
1000 | if self.IP._kill: break |
|
1000 | if self.IP._kill: break | |
1001 | self.exec_loop() |
|
1001 | self.exec_loop() | |
1002 | self.join() |
|
1002 | self.join() | |
1003 |
|
1003 | |||
1004 | def on_timer(self): |
|
1004 | def on_timer(self): | |
1005 | update_tk(self.tk) |
|
1005 | update_tk(self.tk) | |
1006 | result = self.IP.runcode() |
|
1006 | result = self.IP.runcode() | |
1007 | self.timer.start(self.TIMEOUT, True) |
|
1007 | self.timer.start(self.TIMEOUT, True) | |
1008 | return result |
|
1008 | return result | |
1009 |
|
1009 | |||
1010 |
|
1010 | |||
1011 | class IPShellQt4(IPThread): |
|
1011 | class IPShellQt4(IPThread): | |
1012 | """Run a Qt event loop in a separate thread. |
|
1012 | """Run a Qt event loop in a separate thread. | |
1013 |
|
1013 | |||
1014 | Python commands can be passed to the thread where they will be executed. |
|
1014 | Python commands can be passed to the thread where they will be executed. | |
1015 | This is implemented by periodically checking for passed code using a |
|
1015 | This is implemented by periodically checking for passed code using a | |
1016 | Qt timer / slot.""" |
|
1016 | Qt timer / slot.""" | |
1017 |
|
1017 | |||
1018 | TIMEOUT = 100 # Millisecond interval between timeouts. |
|
1018 | TIMEOUT = 100 # Millisecond interval between timeouts. | |
1019 |
|
1019 | |||
1020 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, |
|
1020 | def __init__(self, argv=None, user_ns=None, user_global_ns=None, | |
1021 | debug=0, shell_class=MTInteractiveShell): |
|
1021 | debug=0, shell_class=MTInteractiveShell): | |
1022 |
|
1022 | |||
1023 | from PyQt4 import QtCore, QtGui |
|
1023 | from PyQt4 import QtCore, QtGui | |
1024 |
|
1024 | |||
1025 | try: |
|
1025 | try: | |
1026 | # present in PyQt4-4.2.1 or later |
|
1026 | # present in PyQt4-4.2.1 or later | |
1027 | QtCore.pyqtRemoveInputHook() |
|
1027 | QtCore.pyqtRemoveInputHook() | |
1028 | except AttributeError: |
|
1028 | except AttributeError: | |
1029 | pass |
|
1029 | pass | |
1030 |
|
1030 | |||
1031 | if QtCore.PYQT_VERSION_STR == '4.3': |
|
1031 | if QtCore.PYQT_VERSION_STR == '4.3': | |
1032 | warn('''PyQt4 version 4.3 detected. |
|
1032 | warn('''PyQt4 version 4.3 detected. | |
1033 | If you experience repeated threading warnings, please update PyQt4. |
|
1033 | If you experience repeated threading warnings, please update PyQt4. | |
1034 | ''') |
|
1034 | ''') | |
1035 |
|
1035 | |||
1036 | self.exec_ = hijack_qt4() |
|
1036 | self.exec_ = hijack_qt4() | |
1037 |
|
1037 | |||
1038 | # Allows us to use both Tk and QT. |
|
1038 | # Allows us to use both Tk and QT. | |
1039 | self.tk = get_tk() |
|
1039 | self.tk = get_tk() | |
1040 |
|
1040 | |||
1041 | self.IP = make_IPython(argv, |
|
1041 | self.IP = make_IPython(argv, | |
1042 | user_ns=user_ns, |
|
1042 | user_ns=user_ns, | |
1043 | user_global_ns=user_global_ns, |
|
1043 | user_global_ns=user_global_ns, | |
1044 | debug=debug, |
|
1044 | debug=debug, | |
1045 | shell_class=shell_class, |
|
1045 | shell_class=shell_class, | |
1046 | on_kill=[QtGui.qApp.exit]) |
|
1046 | on_kill=[QtGui.qApp.exit]) | |
1047 |
|
1047 | |||
1048 | # HACK: slot for banner in self; it will be passed to the mainloop |
|
1048 | # HACK: slot for banner in self; it will be passed to the mainloop | |
1049 | # method only and .run() needs it. The actual value will be set by |
|
1049 | # method only and .run() needs it. The actual value will be set by | |
1050 | # .mainloop(). |
|
1050 | # .mainloop(). | |
1051 | self._banner = None |
|
1051 | self._banner = None | |
1052 |
|
1052 | |||
1053 | threading.Thread.__init__(self) |
|
1053 | threading.Thread.__init__(self) | |
1054 |
|
1054 | |||
1055 | def mainloop(self, sys_exit=0, banner=None): |
|
1055 | def mainloop(self, sys_exit=0, banner=None): | |
1056 |
|
1056 | |||
1057 | from PyQt4 import QtCore, QtGui |
|
1057 | from PyQt4 import QtCore, QtGui | |
1058 |
|
1058 | |||
1059 | self._banner = banner |
|
1059 | self._banner = banner | |
1060 |
|
1060 | |||
1061 | if QtGui.QApplication.startingUp(): |
|
1061 | if QtGui.QApplication.startingUp(): | |
1062 | a = QtGui.QApplication(sys.argv) |
|
1062 | a = QtGui.QApplication(sys.argv) | |
1063 |
|
1063 | |||
1064 | self.timer = QtCore.QTimer() |
|
1064 | self.timer = QtCore.QTimer() | |
1065 | QtCore.QObject.connect(self.timer, |
|
1065 | QtCore.QObject.connect(self.timer, | |
1066 | QtCore.SIGNAL('timeout()'), |
|
1066 | QtCore.SIGNAL('timeout()'), | |
1067 | self.on_timer) |
|
1067 | self.on_timer) | |
1068 |
|
1068 | |||
1069 | self.start() |
|
1069 | self.start() | |
1070 | self.timer.start(self.TIMEOUT) |
|
1070 | self.timer.start(self.TIMEOUT) | |
1071 | while True: |
|
1071 | while True: | |
1072 | if self.IP._kill: break |
|
1072 | if self.IP._kill: break | |
1073 | self.exec_() |
|
1073 | self.exec_() | |
1074 | self.join() |
|
1074 | self.join() | |
1075 |
|
1075 | |||
1076 | def on_timer(self): |
|
1076 | def on_timer(self): | |
1077 | update_tk(self.tk) |
|
1077 | update_tk(self.tk) | |
1078 | result = self.IP.runcode() |
|
1078 | result = self.IP.runcode() | |
1079 | self.timer.start(self.TIMEOUT) |
|
1079 | self.timer.start(self.TIMEOUT) | |
1080 | return result |
|
1080 | return result | |
1081 |
|
1081 | |||
1082 |
|
1082 | |||
1083 | # A set of matplotlib public IPython shell classes, for single-threaded (Tk* |
|
1083 | # A set of matplotlib public IPython shell classes, for single-threaded (Tk* | |
1084 | # and FLTK*) and multithreaded (GTK*, WX* and Qt*) backends to use. |
|
1084 | # and FLTK*) and multithreaded (GTK*, WX* and Qt*) backends to use. | |
1085 | def _load_pylab(user_ns): |
|
1085 | def _load_pylab(user_ns): | |
1086 | """Allow users to disable pulling all of pylab into the top-level |
|
1086 | """Allow users to disable pulling all of pylab into the top-level | |
1087 | namespace. |
|
1087 | namespace. | |
1088 |
|
1088 | |||
1089 | This little utility must be called AFTER the actual ipython instance is |
|
1089 | This little utility must be called AFTER the actual ipython instance is | |
1090 | running, since only then will the options file have been fully parsed.""" |
|
1090 | running, since only then will the options file have been fully parsed.""" | |
1091 |
|
1091 | |||
1092 | ip = ipapi.get() |
|
1092 | ip = ipapi.get() | |
1093 | if ip.options.pylab_import_all: |
|
1093 | if ip.options.pylab_import_all: | |
1094 | ip.ex("from matplotlib.pylab import *") |
|
1094 | ip.ex("from matplotlib.pylab import *") | |
1095 | ip.IP.user_config_ns.update(ip.user_ns) |
|
1095 | ip.IP.user_config_ns.update(ip.user_ns) | |
1096 |
|
1096 | |||
1097 |
|
1097 | |||
1098 | class IPShellMatplotlib(IPShell): |
|
1098 | class IPShellMatplotlib(IPShell): | |
1099 | """Subclass IPShell with MatplotlibShell as the internal shell. |
|
1099 | """Subclass IPShell with MatplotlibShell as the internal shell. | |
1100 |
|
1100 | |||
1101 | Single-threaded class, meant for the Tk* and FLTK* backends. |
|
1101 | Single-threaded class, meant for the Tk* and FLTK* backends. | |
1102 |
|
1102 | |||
1103 | Having this on a separate class simplifies the external driver code.""" |
|
1103 | Having this on a separate class simplifies the external driver code.""" | |
1104 |
|
1104 | |||
1105 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1105 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1106 | IPShell.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1106 | IPShell.__init__(self,argv,user_ns,user_global_ns,debug, | |
1107 | shell_class=MatplotlibShell) |
|
1107 | shell_class=MatplotlibShell) | |
1108 | _load_pylab(self.IP.user_ns) |
|
1108 | _load_pylab(self.IP.user_ns) | |
1109 |
|
1109 | |||
1110 | class IPShellMatplotlibGTK(IPShellGTK): |
|
1110 | class IPShellMatplotlibGTK(IPShellGTK): | |
1111 | """Subclass IPShellGTK with MatplotlibMTShell as the internal shell. |
|
1111 | """Subclass IPShellGTK with MatplotlibMTShell as the internal shell. | |
1112 |
|
1112 | |||
1113 | Multi-threaded class, meant for the GTK* backends.""" |
|
1113 | Multi-threaded class, meant for the GTK* backends.""" | |
1114 |
|
1114 | |||
1115 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1115 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1116 | IPShellGTK.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1116 | IPShellGTK.__init__(self,argv,user_ns,user_global_ns,debug, | |
1117 | shell_class=MatplotlibMTShell) |
|
1117 | shell_class=MatplotlibMTShell) | |
1118 | _load_pylab(self.IP.user_ns) |
|
1118 | _load_pylab(self.IP.user_ns) | |
1119 |
|
1119 | |||
1120 | class IPShellMatplotlibWX(IPShellWX): |
|
1120 | class IPShellMatplotlibWX(IPShellWX): | |
1121 | """Subclass IPShellWX with MatplotlibMTShell as the internal shell. |
|
1121 | """Subclass IPShellWX with MatplotlibMTShell as the internal shell. | |
1122 |
|
1122 | |||
1123 | Multi-threaded class, meant for the WX* backends.""" |
|
1123 | Multi-threaded class, meant for the WX* backends.""" | |
1124 |
|
1124 | |||
1125 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1125 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1126 | IPShellWX.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1126 | IPShellWX.__init__(self,argv,user_ns,user_global_ns,debug, | |
1127 | shell_class=MatplotlibMTShell) |
|
1127 | shell_class=MatplotlibMTShell) | |
1128 | _load_pylab(self.IP.user_ns) |
|
1128 | _load_pylab(self.IP.user_ns) | |
1129 |
|
1129 | |||
1130 | class IPShellMatplotlibQt(IPShellQt): |
|
1130 | class IPShellMatplotlibQt(IPShellQt): | |
1131 | """Subclass IPShellQt with MatplotlibMTShell as the internal shell. |
|
1131 | """Subclass IPShellQt with MatplotlibMTShell as the internal shell. | |
1132 |
|
1132 | |||
1133 | Multi-threaded class, meant for the Qt* backends.""" |
|
1133 | Multi-threaded class, meant for the Qt* backends.""" | |
1134 |
|
1134 | |||
1135 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1135 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1136 | IPShellQt.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1136 | IPShellQt.__init__(self,argv,user_ns,user_global_ns,debug, | |
1137 | shell_class=MatplotlibMTShell) |
|
1137 | shell_class=MatplotlibMTShell) | |
1138 | _load_pylab(self.IP.user_ns) |
|
1138 | _load_pylab(self.IP.user_ns) | |
1139 |
|
1139 | |||
1140 | class IPShellMatplotlibQt4(IPShellQt4): |
|
1140 | class IPShellMatplotlibQt4(IPShellQt4): | |
1141 | """Subclass IPShellQt4 with MatplotlibMTShell as the internal shell. |
|
1141 | """Subclass IPShellQt4 with MatplotlibMTShell as the internal shell. | |
1142 |
|
1142 | |||
1143 | Multi-threaded class, meant for the Qt4* backends.""" |
|
1143 | Multi-threaded class, meant for the Qt4* backends.""" | |
1144 |
|
1144 | |||
1145 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): |
|
1145 | def __init__(self,argv=None,user_ns=None,user_global_ns=None,debug=1): | |
1146 | IPShellQt4.__init__(self,argv,user_ns,user_global_ns,debug, |
|
1146 | IPShellQt4.__init__(self,argv,user_ns,user_global_ns,debug, | |
1147 | shell_class=MatplotlibMTShell) |
|
1147 | shell_class=MatplotlibMTShell) | |
1148 | _load_pylab(self.IP.user_ns) |
|
1148 | _load_pylab(self.IP.user_ns) | |
1149 |
|
1149 | |||
1150 | #----------------------------------------------------------------------------- |
|
1150 | #----------------------------------------------------------------------------- | |
1151 | # Factory functions to actually start the proper thread-aware shell |
|
1151 | # Factory functions to actually start the proper thread-aware shell | |
1152 |
|
1152 | |||
1153 | def _select_shell(argv): |
|
1153 | def _select_shell(argv): | |
1154 | """Select a shell from the given argv vector. |
|
1154 | """Select a shell from the given argv vector. | |
1155 |
|
1155 | |||
1156 | This function implements the threading selection policy, allowing runtime |
|
1156 | This function implements the threading selection policy, allowing runtime | |
1157 | control of the threading mode, both for general users and for matplotlib. |
|
1157 | control of the threading mode, both for general users and for matplotlib. | |
1158 |
|
1158 | |||
1159 | Return: |
|
1159 | Return: | |
1160 | Shell class to be instantiated for runtime operation. |
|
1160 | Shell class to be instantiated for runtime operation. | |
1161 | """ |
|
1161 | """ | |
1162 |
|
1162 | |||
1163 | global USE_TK |
|
1163 | global USE_TK | |
1164 |
|
1164 | |||
1165 | mpl_shell = {'gthread' : IPShellMatplotlibGTK, |
|
1165 | mpl_shell = {'gthread' : IPShellMatplotlibGTK, | |
1166 | 'wthread' : IPShellMatplotlibWX, |
|
1166 | 'wthread' : IPShellMatplotlibWX, | |
1167 | 'qthread' : IPShellMatplotlibQt, |
|
1167 | 'qthread' : IPShellMatplotlibQt, | |
1168 | 'q4thread' : IPShellMatplotlibQt4, |
|
1168 | 'q4thread' : IPShellMatplotlibQt4, | |
1169 | 'tkthread' : IPShellMatplotlib, # Tk is built-in |
|
1169 | 'tkthread' : IPShellMatplotlib, # Tk is built-in | |
1170 | } |
|
1170 | } | |
1171 |
|
1171 | |||
1172 | th_shell = {'gthread' : IPShellGTK, |
|
1172 | th_shell = {'gthread' : IPShellGTK, | |
1173 | 'wthread' : IPShellWX, |
|
1173 | 'wthread' : IPShellWX, | |
1174 | 'qthread' : IPShellQt, |
|
1174 | 'qthread' : IPShellQt, | |
1175 | 'q4thread' : IPShellQt4, |
|
1175 | 'q4thread' : IPShellQt4, | |
1176 | 'tkthread' : IPShell, # Tk is built-in |
|
1176 | 'tkthread' : IPShell, # Tk is built-in | |
1177 | } |
|
1177 | } | |
1178 |
|
1178 | |||
1179 | backends = {'gthread' : 'GTKAgg', |
|
1179 | backends = {'gthread' : 'GTKAgg', | |
1180 | 'wthread' : 'WXAgg', |
|
1180 | 'wthread' : 'WXAgg', | |
1181 | 'qthread' : 'QtAgg', |
|
1181 | 'qthread' : 'QtAgg', | |
1182 | 'q4thread' :'Qt4Agg', |
|
1182 | 'q4thread' :'Qt4Agg', | |
1183 | 'tkthread' :'TkAgg', |
|
1183 | 'tkthread' :'TkAgg', | |
1184 | } |
|
1184 | } | |
1185 |
|
1185 | |||
1186 | all_opts = set(['tk','pylab','gthread','qthread','q4thread','wthread', |
|
1186 | all_opts = set(['tk','pylab','gthread','qthread','q4thread','wthread', | |
1187 | 'tkthread']) |
|
1187 | 'tkthread']) | |
1188 | user_opts = set([s.replace('-','') for s in argv[:3]]) |
|
1188 | user_opts = set([s.replace('-','') for s in argv[:3]]) | |
1189 | special_opts = user_opts & all_opts |
|
1189 | special_opts = user_opts & all_opts | |
1190 |
|
1190 | |||
1191 | if 'tk' in special_opts: |
|
1191 | if 'tk' in special_opts: | |
1192 | USE_TK = True |
|
1192 | USE_TK = True | |
1193 | special_opts.remove('tk') |
|
1193 | special_opts.remove('tk') | |
1194 |
|
1194 | |||
1195 | if 'pylab' in special_opts: |
|
1195 | if 'pylab' in special_opts: | |
1196 |
|
1196 | |||
1197 | try: |
|
1197 | try: | |
1198 | import matplotlib |
|
1198 | import matplotlib | |
1199 | except ImportError: |
|
1199 | except ImportError: | |
1200 | error('matplotlib could NOT be imported! Starting normal IPython.') |
|
1200 | error('matplotlib could NOT be imported! Starting normal IPython.') | |
1201 | return IPShell |
|
1201 | return IPShell | |
1202 |
|
1202 | |||
1203 | special_opts.remove('pylab') |
|
1203 | special_opts.remove('pylab') | |
1204 | # If there's any option left, it means the user wants to force the |
|
1204 | # If there's any option left, it means the user wants to force the | |
1205 | # threading backend, else it's auto-selected from the rc file |
|
1205 | # threading backend, else it's auto-selected from the rc file | |
1206 | if special_opts: |
|
1206 | if special_opts: | |
1207 | th_mode = special_opts.pop() |
|
1207 | th_mode = special_opts.pop() | |
1208 | matplotlib.rcParams['backend'] = backends[th_mode] |
|
1208 | matplotlib.rcParams['backend'] = backends[th_mode] | |
1209 | else: |
|
1209 | else: | |
1210 | backend = matplotlib.rcParams['backend'] |
|
1210 | backend = matplotlib.rcParams['backend'] | |
1211 | if backend.startswith('GTK'): |
|
1211 | if backend.startswith('GTK'): | |
1212 | th_mode = 'gthread' |
|
1212 | th_mode = 'gthread' | |
1213 | elif backend.startswith('WX'): |
|
1213 | elif backend.startswith('WX'): | |
1214 | th_mode = 'wthread' |
|
1214 | th_mode = 'wthread' | |
1215 | elif backend.startswith('Qt4'): |
|
1215 | elif backend.startswith('Qt4'): | |
1216 | th_mode = 'q4thread' |
|
1216 | th_mode = 'q4thread' | |
1217 | elif backend.startswith('Qt'): |
|
1217 | elif backend.startswith('Qt'): | |
1218 | th_mode = 'qthread' |
|
1218 | th_mode = 'qthread' | |
1219 | else: |
|
1219 | else: | |
1220 | # Any other backend, use plain Tk |
|
1220 | # Any other backend, use plain Tk | |
1221 | th_mode = 'tkthread' |
|
1221 | th_mode = 'tkthread' | |
1222 |
|
1222 | |||
1223 | return mpl_shell[th_mode] |
|
1223 | return mpl_shell[th_mode] | |
1224 | else: |
|
1224 | else: | |
1225 | # No pylab requested, just plain threads |
|
1225 | # No pylab requested, just plain threads | |
1226 | try: |
|
1226 | try: | |
1227 | th_mode = special_opts.pop() |
|
1227 | th_mode = special_opts.pop() | |
1228 | except KeyError: |
|
1228 | except KeyError: | |
1229 | th_mode = 'tkthread' |
|
1229 | th_mode = 'tkthread' | |
1230 | return th_shell[th_mode] |
|
1230 | return th_shell[th_mode] | |
1231 |
|
1231 | |||
1232 |
|
1232 | |||
1233 | # This is the one which should be called by external code. |
|
1233 | # This is the one which should be called by external code. | |
1234 | def start(user_ns = None): |
|
1234 | def start(user_ns = None): | |
1235 | """Return a running shell instance, dealing with threading options. |
|
1235 | """Return a running shell instance, dealing with threading options. | |
1236 |
|
1236 | |||
1237 | This is a factory function which will instantiate the proper IPython shell |
|
1237 | This is a factory function which will instantiate the proper IPython shell | |
1238 | based on the user's threading choice. Such a selector is needed because |
|
1238 | based on the user's threading choice. Such a selector is needed because | |
1239 | different GUI toolkits require different thread handling details.""" |
|
1239 | different GUI toolkits require different thread handling details.""" | |
1240 |
|
1240 | |||
1241 | shell = _select_shell(sys.argv) |
|
1241 | shell = _select_shell(sys.argv) | |
1242 | return shell(user_ns = user_ns) |
|
1242 | return shell(user_ns = user_ns) | |
1243 |
|
1243 | |||
1244 | # Some aliases for backwards compatibility |
|
1244 | # Some aliases for backwards compatibility | |
1245 | IPythonShell = IPShell |
|
1245 | IPythonShell = IPShell | |
1246 | IPythonShellEmbed = IPShellEmbed |
|
1246 | IPythonShellEmbed = IPShellEmbed | |
1247 | #************************ End of file <Shell.py> *************************** |
|
1247 | #************************ End of file <Shell.py> *************************** |
@@ -1,65 +1,68 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 |
|
3 | |||
4 | def test_import_completer(): |
|
4 | def test_import_completer(): | |
5 | from IPython.core import completer |
|
5 | from IPython.core import completer | |
6 |
|
6 | |||
7 | def test_import_crashhandler(): |
|
7 | def test_import_crashhandler(): | |
8 | from IPython.core import crashhandler |
|
8 | from IPython.core import crashhandler | |
9 |
|
9 | |||
10 | def test_import_debugger(): |
|
10 | def test_import_debugger(): | |
11 | from IPython.core import debugger |
|
11 | from IPython.core import debugger | |
12 |
|
12 | |||
13 | def test_import_fakemodule(): |
|
13 | def test_import_fakemodule(): | |
14 | from IPython.core import fakemodule |
|
14 | from IPython.core import fakemodule | |
15 |
|
15 | |||
16 | def test_import_excolors(): |
|
16 | def test_import_excolors(): | |
17 | from IPython.core import excolors |
|
17 | from IPython.core import excolors | |
18 |
|
18 | |||
19 | def test_import_history(): |
|
19 | def test_import_history(): | |
20 | from IPython.core import history |
|
20 | from IPython.core import history | |
21 |
|
21 | |||
22 | def test_import_hooks(): |
|
22 | def test_import_hooks(): | |
23 | from IPython.core import hooks |
|
23 | from IPython.core import hooks | |
24 |
|
24 | |||
25 | def test_import_ipapi(): |
|
25 | def test_import_ipapi(): | |
26 | from IPython.core import ipapi |
|
26 | from IPython.core import ipapi | |
27 |
|
27 | |||
28 | def test_import_iplib(): |
|
28 | def test_import_iplib(): | |
29 | from IPython.core import iplib |
|
29 | from IPython.core import iplib | |
30 |
|
30 | |||
31 | def test_import_ipmaker(): |
|
31 | def test_import_ipmaker(): | |
32 | from IPython.core import ipmaker |
|
32 | from IPython.core import ipmaker | |
33 |
|
33 | |||
34 | def test_import_logger(): |
|
34 | def test_import_logger(): | |
35 | from IPython.core import logger |
|
35 | from IPython.core import logger | |
36 |
|
36 | |||
37 | def test_import_macro(): |
|
37 | def test_import_macro(): | |
38 | from IPython.core import macro |
|
38 | from IPython.core import macro | |
39 |
|
39 | |||
40 | def test_import_magic(): |
|
40 | def test_import_magic(): | |
41 | from IPython.core import magic |
|
41 | from IPython.core import magic | |
42 |
|
42 | |||
43 | def test_import_oinspect(): |
|
43 | def test_import_oinspect(): | |
44 | from IPython.core import oinspect |
|
44 | from IPython.core import oinspect | |
45 |
|
45 | |||
46 | def test_import_outputtrap(): |
|
46 | def test_import_outputtrap(): | |
47 | from IPython.core import outputtrap |
|
47 | from IPython.core import outputtrap | |
48 |
|
48 | |||
49 | def test_import_prefilter(): |
|
49 | def test_import_prefilter(): | |
50 | from IPython.core import prefilter |
|
50 | from IPython.core import prefilter | |
51 |
|
51 | |||
52 | def test_import_prompts(): |
|
52 | def test_import_prompts(): | |
53 | from IPython.core import prompts |
|
53 | from IPython.core import prompts | |
54 |
|
54 | |||
55 | def test_import_release(): |
|
55 | def test_import_release(): | |
56 | from IPython.core import release |
|
56 | from IPython.core import release | |
57 |
|
57 | |||
58 | def test_import_shadowns(): |
|
58 | def test_import_shadowns(): | |
59 | from IPython.core import shadowns |
|
59 | from IPython.core import shadowns | |
60 |
|
60 | |||
61 | def test_import_shell(): |
|
61 | def test_import_shell(): | |
62 | from IPython.core import shell |
|
62 | from IPython.core import shell | |
63 |
|
63 | |||
64 | def test_import_shellglobals(): |
|
64 | def test_import_shellglobals(): | |
65 | from IPython.core import shellglobals |
|
65 | from IPython.core import shellglobals | |
|
66 | ||||
|
67 | def test_import_ultratb(): | |||
|
68 | from IPython.core import ultratb |
@@ -1,1057 +1,1057 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 |
ultra |
|
3 | ultratb.py -- Spice up your tracebacks! | |
4 |
|
4 | |||
5 | * ColorTB |
|
5 | * ColorTB | |
6 | I've always found it a bit hard to visually parse tracebacks in Python. The |
|
6 | I've always found it a bit hard to visually parse tracebacks in Python. The | |
7 | ColorTB class is a solution to that problem. It colors the different parts of a |
|
7 | ColorTB class is a solution to that problem. It colors the different parts of a | |
8 | traceback in a manner similar to what you would expect from a syntax-highlighting |
|
8 | traceback in a manner similar to what you would expect from a syntax-highlighting | |
9 | text editor. |
|
9 | text editor. | |
10 |
|
10 | |||
11 | Installation instructions for ColorTB: |
|
11 | Installation instructions for ColorTB: | |
12 |
import sys,ultra |
|
12 | import sys,ultratb | |
13 |
sys.excepthook = ultra |
|
13 | sys.excepthook = ultratb.ColorTB() | |
14 |
|
14 | |||
15 | * VerboseTB |
|
15 | * VerboseTB | |
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds |
|
16 | I've also included a port of Ka-Ping Yee's "cgitb.py" that produces all kinds | |
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML |
|
17 | of useful info when a traceback occurs. Ping originally had it spit out HTML | |
18 | and intended it for CGI programmers, but why should they have all the fun? I |
|
18 | and intended it for CGI programmers, but why should they have all the fun? I | |
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, |
|
19 | altered it to spit out colored text to the terminal. It's a bit overwhelming, | |
20 | but kind of neat, and maybe useful for long-running programs that you believe |
|
20 | but kind of neat, and maybe useful for long-running programs that you believe | |
21 | are bug-free. If a crash *does* occur in that type of program you want details. |
|
21 | are bug-free. If a crash *does* occur in that type of program you want details. | |
22 | Give it a shot--you'll love it or you'll hate it. |
|
22 | Give it a shot--you'll love it or you'll hate it. | |
23 |
|
23 | |||
24 | Note: |
|
24 | Note: | |
25 |
|
25 | |||
26 | The Verbose mode prints the variables currently visible where the exception |
|
26 | The Verbose mode prints the variables currently visible where the exception | |
27 | happened (shortening their strings if too long). This can potentially be |
|
27 | happened (shortening their strings if too long). This can potentially be | |
28 | very slow, if you happen to have a huge data structure whose string |
|
28 | very slow, if you happen to have a huge data structure whose string | |
29 | representation is complex to compute. Your computer may appear to freeze for |
|
29 | representation is complex to compute. Your computer may appear to freeze for | |
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback |
|
30 | a while with cpu usage at 100%. If this occurs, you can cancel the traceback | |
31 | with Ctrl-C (maybe hitting it more than once). |
|
31 | with Ctrl-C (maybe hitting it more than once). | |
32 |
|
32 | |||
33 | If you encounter this kind of situation often, you may want to use the |
|
33 | If you encounter this kind of situation often, you may want to use the | |
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting |
|
34 | Verbose_novars mode instead of the regular Verbose, which avoids formatting | |
35 | variables (but otherwise includes the information and context given by |
|
35 | variables (but otherwise includes the information and context given by | |
36 | Verbose). |
|
36 | Verbose). | |
37 |
|
37 | |||
38 |
|
38 | |||
39 | Installation instructions for ColorTB: |
|
39 | Installation instructions for ColorTB: | |
40 |
import sys,ultra |
|
40 | import sys,ultratb | |
41 |
sys.excepthook = ultra |
|
41 | sys.excepthook = ultratb.VerboseTB() | |
42 |
|
42 | |||
43 | Note: Much of the code in this module was lifted verbatim from the standard |
|
43 | Note: Much of the code in this module was lifted verbatim from the standard | |
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. |
|
44 | library module 'traceback.py' and Ka-Ping Yee's 'cgitb.py'. | |
45 |
|
45 | |||
46 | * Color schemes |
|
46 | * Color schemes | |
47 | The colors are defined in the class TBTools through the use of the |
|
47 | The colors are defined in the class TBTools through the use of the | |
48 | ColorSchemeTable class. Currently the following exist: |
|
48 | ColorSchemeTable class. Currently the following exist: | |
49 |
|
49 | |||
50 | - NoColor: allows all of this module to be used in any terminal (the color |
|
50 | - NoColor: allows all of this module to be used in any terminal (the color | |
51 | escapes are just dummy blank strings). |
|
51 | escapes are just dummy blank strings). | |
52 |
|
52 | |||
53 | - Linux: is meant to look good in a terminal like the Linux console (black |
|
53 | - Linux: is meant to look good in a terminal like the Linux console (black | |
54 | or very dark background). |
|
54 | or very dark background). | |
55 |
|
55 | |||
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable |
|
56 | - LightBG: similar to Linux but swaps dark/light colors to be more readable | |
57 | in light background terminals. |
|
57 | in light background terminals. | |
58 |
|
58 | |||
59 | You can implement other color schemes easily, the syntax is fairly |
|
59 | You can implement other color schemes easily, the syntax is fairly | |
60 | self-explanatory. Please send back new schemes you develop to the author for |
|
60 | self-explanatory. Please send back new schemes you develop to the author for | |
61 | possible inclusion in future releases. |
|
61 | possible inclusion in future releases. | |
62 | """ |
|
62 | """ | |
63 |
|
63 | |||
64 | #***************************************************************************** |
|
64 | #***************************************************************************** | |
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> |
|
65 | # Copyright (C) 2001 Nathaniel Gray <n8gray@caltech.edu> | |
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> |
|
66 | # Copyright (C) 2001-2004 Fernando Perez <fperez@colorado.edu> | |
67 | # |
|
67 | # | |
68 | # Distributed under the terms of the BSD License. The full license is in |
|
68 | # Distributed under the terms of the BSD License. The full license is in | |
69 | # the file COPYING, distributed as part of this software. |
|
69 | # the file COPYING, distributed as part of this software. | |
70 | #***************************************************************************** |
|
70 | #***************************************************************************** | |
71 |
|
71 | |||
72 | # Required modules |
|
72 | # Required modules | |
73 | import inspect |
|
73 | import inspect | |
74 | import keyword |
|
74 | import keyword | |
75 | import linecache |
|
75 | import linecache | |
76 | import os |
|
76 | import os | |
77 | import pydoc |
|
77 | import pydoc | |
78 | import re |
|
78 | import re | |
79 | import string |
|
79 | import string | |
80 | import sys |
|
80 | import sys | |
81 | import time |
|
81 | import time | |
82 | import tokenize |
|
82 | import tokenize | |
83 | import traceback |
|
83 | import traceback | |
84 | import types |
|
84 | import types | |
85 |
|
85 | |||
86 | # For purposes of monkeypatching inspect to fix a bug in it. |
|
86 | # For purposes of monkeypatching inspect to fix a bug in it. | |
87 | from inspect import getsourcefile, getfile, getmodule,\ |
|
87 | from inspect import getsourcefile, getfile, getmodule,\ | |
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
88 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode | |
89 |
|
89 | |||
90 |
|
90 | |||
91 | # IPython's own modules |
|
91 | # IPython's own modules | |
92 | # Modified pdb which doesn't damage IPython's readline handling |
|
92 | # Modified pdb which doesn't damage IPython's readline handling | |
93 | from IPython.utils import PyColorize |
|
93 | from IPython.utils import PyColorize | |
94 | from IPython.core import debugger |
|
94 | from IPython.core import debugger | |
95 | from IPython.utils.ipstruct import Struct |
|
95 | from IPython.utils.ipstruct import Struct | |
96 | from IPython.core.excolors import exception_colors |
|
96 | from IPython.core.excolors import exception_colors | |
97 | from IPython.utils.genutils import Term,uniq_stable,error,info |
|
97 | from IPython.utils.genutils import Term,uniq_stable,error,info | |
98 |
|
98 | |||
99 | # Globals |
|
99 | # Globals | |
100 | # amount of space to put line numbers before verbose tracebacks |
|
100 | # amount of space to put line numbers before verbose tracebacks | |
101 | INDENT_SIZE = 8 |
|
101 | INDENT_SIZE = 8 | |
102 |
|
102 | |||
103 | # Default color scheme. This is used, for example, by the traceback |
|
103 | # Default color scheme. This is used, for example, by the traceback | |
104 | # formatter. When running in an actual IPython instance, the user's rc.colors |
|
104 | # formatter. When running in an actual IPython instance, the user's rc.colors | |
105 | # value is used, but havinga module global makes this functionality available |
|
105 | # value is used, but havinga module global makes this functionality available | |
106 |
# to users of ultra |
|
106 | # to users of ultratb who are NOT running inside ipython. | |
107 | DEFAULT_SCHEME = 'NoColor' |
|
107 | DEFAULT_SCHEME = 'NoColor' | |
108 |
|
108 | |||
109 | #--------------------------------------------------------------------------- |
|
109 | #--------------------------------------------------------------------------- | |
110 | # Code begins |
|
110 | # Code begins | |
111 |
|
111 | |||
112 | # Utility functions |
|
112 | # Utility functions | |
113 | def inspect_error(): |
|
113 | def inspect_error(): | |
114 | """Print a message about internal inspect errors. |
|
114 | """Print a message about internal inspect errors. | |
115 |
|
115 | |||
116 | These are unfortunately quite common.""" |
|
116 | These are unfortunately quite common.""" | |
117 |
|
117 | |||
118 | error('Internal Python error in the inspect module.\n' |
|
118 | error('Internal Python error in the inspect module.\n' | |
119 | 'Below is the traceback from this internal error.\n') |
|
119 | 'Below is the traceback from this internal error.\n') | |
120 |
|
120 | |||
121 |
|
121 | |||
122 | def findsource(object): |
|
122 | def findsource(object): | |
123 | """Return the entire source file and starting line number for an object. |
|
123 | """Return the entire source file and starting line number for an object. | |
124 |
|
124 | |||
125 | The argument may be a module, class, method, function, traceback, frame, |
|
125 | The argument may be a module, class, method, function, traceback, frame, | |
126 | or code object. The source code is returned as a list of all the lines |
|
126 | or code object. The source code is returned as a list of all the lines | |
127 | in the file and the line number indexes a line in that list. An IOError |
|
127 | in the file and the line number indexes a line in that list. An IOError | |
128 | is raised if the source code cannot be retrieved. |
|
128 | is raised if the source code cannot be retrieved. | |
129 |
|
129 | |||
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" |
|
130 | FIXED version with which we monkeypatch the stdlib to work around a bug.""" | |
131 |
|
131 | |||
132 | file = getsourcefile(object) or getfile(object) |
|
132 | file = getsourcefile(object) or getfile(object) | |
133 | # If the object is a frame, then trying to get the globals dict from its |
|
133 | # If the object is a frame, then trying to get the globals dict from its | |
134 | # module won't work. Instead, the frame object itself has the globals |
|
134 | # module won't work. Instead, the frame object itself has the globals | |
135 | # dictionary. |
|
135 | # dictionary. | |
136 | globals_dict = None |
|
136 | globals_dict = None | |
137 | if inspect.isframe(object): |
|
137 | if inspect.isframe(object): | |
138 | # XXX: can this ever be false? |
|
138 | # XXX: can this ever be false? | |
139 | globals_dict = object.f_globals |
|
139 | globals_dict = object.f_globals | |
140 | else: |
|
140 | else: | |
141 | module = getmodule(object, file) |
|
141 | module = getmodule(object, file) | |
142 | if module: |
|
142 | if module: | |
143 | globals_dict = module.__dict__ |
|
143 | globals_dict = module.__dict__ | |
144 | lines = linecache.getlines(file, globals_dict) |
|
144 | lines = linecache.getlines(file, globals_dict) | |
145 | if not lines: |
|
145 | if not lines: | |
146 | raise IOError('could not get source code') |
|
146 | raise IOError('could not get source code') | |
147 |
|
147 | |||
148 | if ismodule(object): |
|
148 | if ismodule(object): | |
149 | return lines, 0 |
|
149 | return lines, 0 | |
150 |
|
150 | |||
151 | if isclass(object): |
|
151 | if isclass(object): | |
152 | name = object.__name__ |
|
152 | name = object.__name__ | |
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
|
153 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') | |
154 | # make some effort to find the best matching class definition: |
|
154 | # make some effort to find the best matching class definition: | |
155 | # use the one with the least indentation, which is the one |
|
155 | # use the one with the least indentation, which is the one | |
156 | # that's most probably not inside a function definition. |
|
156 | # that's most probably not inside a function definition. | |
157 | candidates = [] |
|
157 | candidates = [] | |
158 | for i in range(len(lines)): |
|
158 | for i in range(len(lines)): | |
159 | match = pat.match(lines[i]) |
|
159 | match = pat.match(lines[i]) | |
160 | if match: |
|
160 | if match: | |
161 | # if it's at toplevel, it's already the best one |
|
161 | # if it's at toplevel, it's already the best one | |
162 | if lines[i][0] == 'c': |
|
162 | if lines[i][0] == 'c': | |
163 | return lines, i |
|
163 | return lines, i | |
164 | # else add whitespace to candidate list |
|
164 | # else add whitespace to candidate list | |
165 | candidates.append((match.group(1), i)) |
|
165 | candidates.append((match.group(1), i)) | |
166 | if candidates: |
|
166 | if candidates: | |
167 | # this will sort by whitespace, and by line number, |
|
167 | # this will sort by whitespace, and by line number, | |
168 | # less whitespace first |
|
168 | # less whitespace first | |
169 | candidates.sort() |
|
169 | candidates.sort() | |
170 | return lines, candidates[0][1] |
|
170 | return lines, candidates[0][1] | |
171 | else: |
|
171 | else: | |
172 | raise IOError('could not find class definition') |
|
172 | raise IOError('could not find class definition') | |
173 |
|
173 | |||
174 | if ismethod(object): |
|
174 | if ismethod(object): | |
175 | object = object.im_func |
|
175 | object = object.im_func | |
176 | if isfunction(object): |
|
176 | if isfunction(object): | |
177 | object = object.func_code |
|
177 | object = object.func_code | |
178 | if istraceback(object): |
|
178 | if istraceback(object): | |
179 | object = object.tb_frame |
|
179 | object = object.tb_frame | |
180 | if isframe(object): |
|
180 | if isframe(object): | |
181 | object = object.f_code |
|
181 | object = object.f_code | |
182 | if iscode(object): |
|
182 | if iscode(object): | |
183 | if not hasattr(object, 'co_firstlineno'): |
|
183 | if not hasattr(object, 'co_firstlineno'): | |
184 | raise IOError('could not find function definition') |
|
184 | raise IOError('could not find function definition') | |
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
|
185 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') | |
186 | pmatch = pat.match |
|
186 | pmatch = pat.match | |
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than |
|
187 | # fperez - fix: sometimes, co_firstlineno can give a number larger than | |
188 | # the length of lines, which causes an error. Safeguard against that. |
|
188 | # the length of lines, which causes an error. Safeguard against that. | |
189 | lnum = min(object.co_firstlineno,len(lines))-1 |
|
189 | lnum = min(object.co_firstlineno,len(lines))-1 | |
190 | while lnum > 0: |
|
190 | while lnum > 0: | |
191 | if pmatch(lines[lnum]): break |
|
191 | if pmatch(lines[lnum]): break | |
192 | lnum -= 1 |
|
192 | lnum -= 1 | |
193 |
|
193 | |||
194 | return lines, lnum |
|
194 | return lines, lnum | |
195 | raise IOError('could not find code object') |
|
195 | raise IOError('could not find code object') | |
196 |
|
196 | |||
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 |
|
197 | # Monkeypatch inspect to apply our bugfix. This code only works with py25 | |
198 | if sys.version_info[:2] >= (2,5): |
|
198 | if sys.version_info[:2] >= (2,5): | |
199 | inspect.findsource = findsource |
|
199 | inspect.findsource = findsource | |
200 |
|
200 | |||
201 | def fix_frame_records_filenames(records): |
|
201 | def fix_frame_records_filenames(records): | |
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). |
|
202 | """Try to fix the filenames in each record from inspect.getinnerframes(). | |
203 |
|
203 | |||
204 | Particularly, modules loaded from within zip files have useless filenames |
|
204 | Particularly, modules loaded from within zip files have useless filenames | |
205 | attached to their code object, and inspect.getinnerframes() just uses it. |
|
205 | attached to their code object, and inspect.getinnerframes() just uses it. | |
206 | """ |
|
206 | """ | |
207 | fixed_records = [] |
|
207 | fixed_records = [] | |
208 | for frame, filename, line_no, func_name, lines, index in records: |
|
208 | for frame, filename, line_no, func_name, lines, index in records: | |
209 | # Look inside the frame's globals dictionary for __file__, which should |
|
209 | # Look inside the frame's globals dictionary for __file__, which should | |
210 | # be better. |
|
210 | # be better. | |
211 | better_fn = frame.f_globals.get('__file__', None) |
|
211 | better_fn = frame.f_globals.get('__file__', None) | |
212 | if isinstance(better_fn, str): |
|
212 | if isinstance(better_fn, str): | |
213 | # Check the type just in case someone did something weird with |
|
213 | # Check the type just in case someone did something weird with | |
214 | # __file__. It might also be None if the error occurred during |
|
214 | # __file__. It might also be None if the error occurred during | |
215 | # import. |
|
215 | # import. | |
216 | filename = better_fn |
|
216 | filename = better_fn | |
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) |
|
217 | fixed_records.append((frame, filename, line_no, func_name, lines, index)) | |
218 | return fixed_records |
|
218 | return fixed_records | |
219 |
|
219 | |||
220 |
|
220 | |||
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): |
|
221 | def _fixed_getinnerframes(etb, context=1,tb_offset=0): | |
222 | import linecache |
|
222 | import linecache | |
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 |
|
223 | LNUM_POS, LINES_POS, INDEX_POS = 2, 4, 5 | |
224 |
|
224 | |||
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) |
|
225 | records = fix_frame_records_filenames(inspect.getinnerframes(etb, context)) | |
226 |
|
226 | |||
227 | # If the error is at the console, don't build any context, since it would |
|
227 | # If the error is at the console, don't build any context, since it would | |
228 | # otherwise produce 5 blank lines printed out (there is no file at the |
|
228 | # otherwise produce 5 blank lines printed out (there is no file at the | |
229 | # console) |
|
229 | # console) | |
230 | rec_check = records[tb_offset:] |
|
230 | rec_check = records[tb_offset:] | |
231 | try: |
|
231 | try: | |
232 | rname = rec_check[0][1] |
|
232 | rname = rec_check[0][1] | |
233 | if rname == '<ipython console>' or rname.endswith('<string>'): |
|
233 | if rname == '<ipython console>' or rname.endswith('<string>'): | |
234 | return rec_check |
|
234 | return rec_check | |
235 | except IndexError: |
|
235 | except IndexError: | |
236 | pass |
|
236 | pass | |
237 |
|
237 | |||
238 | aux = traceback.extract_tb(etb) |
|
238 | aux = traceback.extract_tb(etb) | |
239 | assert len(records) == len(aux) |
|
239 | assert len(records) == len(aux) | |
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): |
|
240 | for i, (file, lnum, _, _) in zip(range(len(records)), aux): | |
241 | maybeStart = lnum-1 - context//2 |
|
241 | maybeStart = lnum-1 - context//2 | |
242 | start = max(maybeStart, 0) |
|
242 | start = max(maybeStart, 0) | |
243 | end = start + context |
|
243 | end = start + context | |
244 | lines = linecache.getlines(file)[start:end] |
|
244 | lines = linecache.getlines(file)[start:end] | |
245 | # pad with empty lines if necessary |
|
245 | # pad with empty lines if necessary | |
246 | if maybeStart < 0: |
|
246 | if maybeStart < 0: | |
247 | lines = (['\n'] * -maybeStart) + lines |
|
247 | lines = (['\n'] * -maybeStart) + lines | |
248 | if len(lines) < context: |
|
248 | if len(lines) < context: | |
249 | lines += ['\n'] * (context - len(lines)) |
|
249 | lines += ['\n'] * (context - len(lines)) | |
250 | buf = list(records[i]) |
|
250 | buf = list(records[i]) | |
251 | buf[LNUM_POS] = lnum |
|
251 | buf[LNUM_POS] = lnum | |
252 | buf[INDEX_POS] = lnum - 1 - start |
|
252 | buf[INDEX_POS] = lnum - 1 - start | |
253 | buf[LINES_POS] = lines |
|
253 | buf[LINES_POS] = lines | |
254 | records[i] = tuple(buf) |
|
254 | records[i] = tuple(buf) | |
255 | return records[tb_offset:] |
|
255 | return records[tb_offset:] | |
256 |
|
256 | |||
257 | # Helper function -- largely belongs to VerboseTB, but we need the same |
|
257 | # Helper function -- largely belongs to VerboseTB, but we need the same | |
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they |
|
258 | # functionality to produce a pseudo verbose TB for SyntaxErrors, so that they | |
259 | # can be recognized properly by ipython.el's py-traceback-line-re |
|
259 | # can be recognized properly by ipython.el's py-traceback-line-re | |
260 | # (SyntaxErrors have to be treated specially because they have no traceback) |
|
260 | # (SyntaxErrors have to be treated specially because they have no traceback) | |
261 |
|
261 | |||
262 | _parser = PyColorize.Parser() |
|
262 | _parser = PyColorize.Parser() | |
263 |
|
263 | |||
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): |
|
264 | def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None): | |
265 | numbers_width = INDENT_SIZE - 1 |
|
265 | numbers_width = INDENT_SIZE - 1 | |
266 | res = [] |
|
266 | res = [] | |
267 | i = lnum - index |
|
267 | i = lnum - index | |
268 |
|
268 | |||
269 | # This lets us get fully syntax-highlighted tracebacks. |
|
269 | # This lets us get fully syntax-highlighted tracebacks. | |
270 | if scheme is None: |
|
270 | if scheme is None: | |
271 | try: |
|
271 | try: | |
272 | scheme = __IPYTHON__.rc.colors |
|
272 | scheme = __IPYTHON__.rc.colors | |
273 | except: |
|
273 | except: | |
274 | scheme = DEFAULT_SCHEME |
|
274 | scheme = DEFAULT_SCHEME | |
275 | _line_format = _parser.format2 |
|
275 | _line_format = _parser.format2 | |
276 |
|
276 | |||
277 | for line in lines: |
|
277 | for line in lines: | |
278 | new_line, err = _line_format(line,'str',scheme) |
|
278 | new_line, err = _line_format(line,'str',scheme) | |
279 | if not err: line = new_line |
|
279 | if not err: line = new_line | |
280 |
|
280 | |||
281 | if i == lnum: |
|
281 | if i == lnum: | |
282 | # This is the line with the error |
|
282 | # This is the line with the error | |
283 | pad = numbers_width - len(str(i)) |
|
283 | pad = numbers_width - len(str(i)) | |
284 | if pad >= 3: |
|
284 | if pad >= 3: | |
285 | marker = '-'*(pad-3) + '-> ' |
|
285 | marker = '-'*(pad-3) + '-> ' | |
286 | elif pad == 2: |
|
286 | elif pad == 2: | |
287 | marker = '> ' |
|
287 | marker = '> ' | |
288 | elif pad == 1: |
|
288 | elif pad == 1: | |
289 | marker = '>' |
|
289 | marker = '>' | |
290 | else: |
|
290 | else: | |
291 | marker = '' |
|
291 | marker = '' | |
292 | num = marker + str(i) |
|
292 | num = marker + str(i) | |
293 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, |
|
293 | line = '%s%s%s %s%s' %(Colors.linenoEm, num, | |
294 | Colors.line, line, Colors.Normal) |
|
294 | Colors.line, line, Colors.Normal) | |
295 | else: |
|
295 | else: | |
296 | num = '%*s' % (numbers_width,i) |
|
296 | num = '%*s' % (numbers_width,i) | |
297 | line = '%s%s%s %s' %(Colors.lineno, num, |
|
297 | line = '%s%s%s %s' %(Colors.lineno, num, | |
298 | Colors.Normal, line) |
|
298 | Colors.Normal, line) | |
299 |
|
299 | |||
300 | res.append(line) |
|
300 | res.append(line) | |
301 | if lvals and i == lnum: |
|
301 | if lvals and i == lnum: | |
302 | res.append(lvals + '\n') |
|
302 | res.append(lvals + '\n') | |
303 | i = i + 1 |
|
303 | i = i + 1 | |
304 | return res |
|
304 | return res | |
305 |
|
305 | |||
306 |
|
306 | |||
307 | #--------------------------------------------------------------------------- |
|
307 | #--------------------------------------------------------------------------- | |
308 | # Module classes |
|
308 | # Module classes | |
309 | class TBTools: |
|
309 | class TBTools: | |
310 | """Basic tools used by all traceback printer classes.""" |
|
310 | """Basic tools used by all traceback printer classes.""" | |
311 |
|
311 | |||
312 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): |
|
312 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): | |
313 | # Whether to call the interactive pdb debugger after printing |
|
313 | # Whether to call the interactive pdb debugger after printing | |
314 | # tracebacks or not |
|
314 | # tracebacks or not | |
315 | self.call_pdb = call_pdb |
|
315 | self.call_pdb = call_pdb | |
316 |
|
316 | |||
317 | # Create color table |
|
317 | # Create color table | |
318 | self.color_scheme_table = exception_colors() |
|
318 | self.color_scheme_table = exception_colors() | |
319 |
|
319 | |||
320 | self.set_colors(color_scheme) |
|
320 | self.set_colors(color_scheme) | |
321 | self.old_scheme = color_scheme # save initial value for toggles |
|
321 | self.old_scheme = color_scheme # save initial value for toggles | |
322 |
|
322 | |||
323 | if call_pdb: |
|
323 | if call_pdb: | |
324 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) |
|
324 | self.pdb = debugger.Pdb(self.color_scheme_table.active_scheme_name) | |
325 | else: |
|
325 | else: | |
326 | self.pdb = None |
|
326 | self.pdb = None | |
327 |
|
327 | |||
328 | def set_colors(self,*args,**kw): |
|
328 | def set_colors(self,*args,**kw): | |
329 | """Shorthand access to the color table scheme selector method.""" |
|
329 | """Shorthand access to the color table scheme selector method.""" | |
330 |
|
330 | |||
331 | # Set own color table |
|
331 | # Set own color table | |
332 | self.color_scheme_table.set_active_scheme(*args,**kw) |
|
332 | self.color_scheme_table.set_active_scheme(*args,**kw) | |
333 | # for convenience, set Colors to the active scheme |
|
333 | # for convenience, set Colors to the active scheme | |
334 | self.Colors = self.color_scheme_table.active_colors |
|
334 | self.Colors = self.color_scheme_table.active_colors | |
335 | # Also set colors of debugger |
|
335 | # Also set colors of debugger | |
336 | if hasattr(self,'pdb') and self.pdb is not None: |
|
336 | if hasattr(self,'pdb') and self.pdb is not None: | |
337 | self.pdb.set_colors(*args,**kw) |
|
337 | self.pdb.set_colors(*args,**kw) | |
338 |
|
338 | |||
339 | def color_toggle(self): |
|
339 | def color_toggle(self): | |
340 | """Toggle between the currently active color scheme and NoColor.""" |
|
340 | """Toggle between the currently active color scheme and NoColor.""" | |
341 |
|
341 | |||
342 | if self.color_scheme_table.active_scheme_name == 'NoColor': |
|
342 | if self.color_scheme_table.active_scheme_name == 'NoColor': | |
343 | self.color_scheme_table.set_active_scheme(self.old_scheme) |
|
343 | self.color_scheme_table.set_active_scheme(self.old_scheme) | |
344 | self.Colors = self.color_scheme_table.active_colors |
|
344 | self.Colors = self.color_scheme_table.active_colors | |
345 | else: |
|
345 | else: | |
346 | self.old_scheme = self.color_scheme_table.active_scheme_name |
|
346 | self.old_scheme = self.color_scheme_table.active_scheme_name | |
347 | self.color_scheme_table.set_active_scheme('NoColor') |
|
347 | self.color_scheme_table.set_active_scheme('NoColor') | |
348 | self.Colors = self.color_scheme_table.active_colors |
|
348 | self.Colors = self.color_scheme_table.active_colors | |
349 |
|
349 | |||
350 | #--------------------------------------------------------------------------- |
|
350 | #--------------------------------------------------------------------------- | |
351 | class ListTB(TBTools): |
|
351 | class ListTB(TBTools): | |
352 | """Print traceback information from a traceback list, with optional color. |
|
352 | """Print traceback information from a traceback list, with optional color. | |
353 |
|
353 | |||
354 | Calling: requires 3 arguments: |
|
354 | Calling: requires 3 arguments: | |
355 | (etype, evalue, elist) |
|
355 | (etype, evalue, elist) | |
356 | as would be obtained by: |
|
356 | as would be obtained by: | |
357 | etype, evalue, tb = sys.exc_info() |
|
357 | etype, evalue, tb = sys.exc_info() | |
358 | if tb: |
|
358 | if tb: | |
359 | elist = traceback.extract_tb(tb) |
|
359 | elist = traceback.extract_tb(tb) | |
360 | else: |
|
360 | else: | |
361 | elist = None |
|
361 | elist = None | |
362 |
|
362 | |||
363 | It can thus be used by programs which need to process the traceback before |
|
363 | It can thus be used by programs which need to process the traceback before | |
364 | printing (such as console replacements based on the code module from the |
|
364 | printing (such as console replacements based on the code module from the | |
365 | standard library). |
|
365 | standard library). | |
366 |
|
366 | |||
367 | Because they are meant to be called without a full traceback (only a |
|
367 | Because they are meant to be called without a full traceback (only a | |
368 | list), instances of this class can't call the interactive pdb debugger.""" |
|
368 | list), instances of this class can't call the interactive pdb debugger.""" | |
369 |
|
369 | |||
370 | def __init__(self,color_scheme = 'NoColor'): |
|
370 | def __init__(self,color_scheme = 'NoColor'): | |
371 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) |
|
371 | TBTools.__init__(self,color_scheme = color_scheme,call_pdb=0) | |
372 |
|
372 | |||
373 | def __call__(self, etype, value, elist): |
|
373 | def __call__(self, etype, value, elist): | |
374 | Term.cout.flush() |
|
374 | Term.cout.flush() | |
375 | print >> Term.cerr, self.text(etype,value,elist) |
|
375 | print >> Term.cerr, self.text(etype,value,elist) | |
376 | Term.cerr.flush() |
|
376 | Term.cerr.flush() | |
377 |
|
377 | |||
378 | def text(self,etype, value, elist,context=5): |
|
378 | def text(self,etype, value, elist,context=5): | |
379 | """Return a color formatted string with the traceback info.""" |
|
379 | """Return a color formatted string with the traceback info.""" | |
380 |
|
380 | |||
381 | Colors = self.Colors |
|
381 | Colors = self.Colors | |
382 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] |
|
382 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] | |
383 | if elist: |
|
383 | if elist: | |
384 | out_string.append('Traceback %s(most recent call last)%s:' % \ |
|
384 | out_string.append('Traceback %s(most recent call last)%s:' % \ | |
385 | (Colors.normalEm, Colors.Normal) + '\n') |
|
385 | (Colors.normalEm, Colors.Normal) + '\n') | |
386 | out_string.extend(self._format_list(elist)) |
|
386 | out_string.extend(self._format_list(elist)) | |
387 | lines = self._format_exception_only(etype, value) |
|
387 | lines = self._format_exception_only(etype, value) | |
388 | for line in lines[:-1]: |
|
388 | for line in lines[:-1]: | |
389 | out_string.append(" "+line) |
|
389 | out_string.append(" "+line) | |
390 | out_string.append(lines[-1]) |
|
390 | out_string.append(lines[-1]) | |
391 | return ''.join(out_string) |
|
391 | return ''.join(out_string) | |
392 |
|
392 | |||
393 | def _format_list(self, extracted_list): |
|
393 | def _format_list(self, extracted_list): | |
394 | """Format a list of traceback entry tuples for printing. |
|
394 | """Format a list of traceback entry tuples for printing. | |
395 |
|
395 | |||
396 | Given a list of tuples as returned by extract_tb() or |
|
396 | Given a list of tuples as returned by extract_tb() or | |
397 | extract_stack(), return a list of strings ready for printing. |
|
397 | extract_stack(), return a list of strings ready for printing. | |
398 | Each string in the resulting list corresponds to the item with the |
|
398 | Each string in the resulting list corresponds to the item with the | |
399 | same index in the argument list. Each string ends in a newline; |
|
399 | same index in the argument list. Each string ends in a newline; | |
400 | the strings may contain internal newlines as well, for those items |
|
400 | the strings may contain internal newlines as well, for those items | |
401 | whose source text line is not None. |
|
401 | whose source text line is not None. | |
402 |
|
402 | |||
403 | Lifted almost verbatim from traceback.py |
|
403 | Lifted almost verbatim from traceback.py | |
404 | """ |
|
404 | """ | |
405 |
|
405 | |||
406 | Colors = self.Colors |
|
406 | Colors = self.Colors | |
407 | list = [] |
|
407 | list = [] | |
408 | for filename, lineno, name, line in extracted_list[:-1]: |
|
408 | for filename, lineno, name, line in extracted_list[:-1]: | |
409 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ |
|
409 | item = ' File %s"%s"%s, line %s%d%s, in %s%s%s\n' % \ | |
410 | (Colors.filename, filename, Colors.Normal, |
|
410 | (Colors.filename, filename, Colors.Normal, | |
411 | Colors.lineno, lineno, Colors.Normal, |
|
411 | Colors.lineno, lineno, Colors.Normal, | |
412 | Colors.name, name, Colors.Normal) |
|
412 | Colors.name, name, Colors.Normal) | |
413 | if line: |
|
413 | if line: | |
414 | item = item + ' %s\n' % line.strip() |
|
414 | item = item + ' %s\n' % line.strip() | |
415 | list.append(item) |
|
415 | list.append(item) | |
416 | # Emphasize the last entry |
|
416 | # Emphasize the last entry | |
417 | filename, lineno, name, line = extracted_list[-1] |
|
417 | filename, lineno, name, line = extracted_list[-1] | |
418 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ |
|
418 | item = '%s File %s"%s"%s, line %s%d%s, in %s%s%s%s\n' % \ | |
419 | (Colors.normalEm, |
|
419 | (Colors.normalEm, | |
420 | Colors.filenameEm, filename, Colors.normalEm, |
|
420 | Colors.filenameEm, filename, Colors.normalEm, | |
421 | Colors.linenoEm, lineno, Colors.normalEm, |
|
421 | Colors.linenoEm, lineno, Colors.normalEm, | |
422 | Colors.nameEm, name, Colors.normalEm, |
|
422 | Colors.nameEm, name, Colors.normalEm, | |
423 | Colors.Normal) |
|
423 | Colors.Normal) | |
424 | if line: |
|
424 | if line: | |
425 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), |
|
425 | item = item + '%s %s%s\n' % (Colors.line, line.strip(), | |
426 | Colors.Normal) |
|
426 | Colors.Normal) | |
427 | list.append(item) |
|
427 | list.append(item) | |
428 | return list |
|
428 | return list | |
429 |
|
429 | |||
430 | def _format_exception_only(self, etype, value): |
|
430 | def _format_exception_only(self, etype, value): | |
431 | """Format the exception part of a traceback. |
|
431 | """Format the exception part of a traceback. | |
432 |
|
432 | |||
433 | The arguments are the exception type and value such as given by |
|
433 | The arguments are the exception type and value such as given by | |
434 | sys.exc_info()[:2]. The return value is a list of strings, each ending |
|
434 | sys.exc_info()[:2]. The return value is a list of strings, each ending | |
435 | in a newline. Normally, the list contains a single string; however, |
|
435 | in a newline. Normally, the list contains a single string; however, | |
436 | for SyntaxError exceptions, it contains several lines that (when |
|
436 | for SyntaxError exceptions, it contains several lines that (when | |
437 | printed) display detailed information about where the syntax error |
|
437 | printed) display detailed information about where the syntax error | |
438 | occurred. The message indicating which exception occurred is the |
|
438 | occurred. The message indicating which exception occurred is the | |
439 | always last string in the list. |
|
439 | always last string in the list. | |
440 |
|
440 | |||
441 | Also lifted nearly verbatim from traceback.py |
|
441 | Also lifted nearly verbatim from traceback.py | |
442 | """ |
|
442 | """ | |
443 |
|
443 | |||
444 | have_filedata = False |
|
444 | have_filedata = False | |
445 | Colors = self.Colors |
|
445 | Colors = self.Colors | |
446 | list = [] |
|
446 | list = [] | |
447 | try: |
|
447 | try: | |
448 | stype = Colors.excName + etype.__name__ + Colors.Normal |
|
448 | stype = Colors.excName + etype.__name__ + Colors.Normal | |
449 | except AttributeError: |
|
449 | except AttributeError: | |
450 | stype = etype # String exceptions don't get special coloring |
|
450 | stype = etype # String exceptions don't get special coloring | |
451 | if value is None: |
|
451 | if value is None: | |
452 | list.append( str(stype) + '\n') |
|
452 | list.append( str(stype) + '\n') | |
453 | else: |
|
453 | else: | |
454 | if etype is SyntaxError: |
|
454 | if etype is SyntaxError: | |
455 | try: |
|
455 | try: | |
456 | msg, (filename, lineno, offset, line) = value |
|
456 | msg, (filename, lineno, offset, line) = value | |
457 | except: |
|
457 | except: | |
458 | have_filedata = False |
|
458 | have_filedata = False | |
459 | else: |
|
459 | else: | |
460 | have_filedata = True |
|
460 | have_filedata = True | |
461 | #print 'filename is',filename # dbg |
|
461 | #print 'filename is',filename # dbg | |
462 | if not filename: filename = "<string>" |
|
462 | if not filename: filename = "<string>" | |
463 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ |
|
463 | list.append('%s File %s"%s"%s, line %s%d%s\n' % \ | |
464 | (Colors.normalEm, |
|
464 | (Colors.normalEm, | |
465 | Colors.filenameEm, filename, Colors.normalEm, |
|
465 | Colors.filenameEm, filename, Colors.normalEm, | |
466 | Colors.linenoEm, lineno, Colors.Normal )) |
|
466 | Colors.linenoEm, lineno, Colors.Normal )) | |
467 | if line is not None: |
|
467 | if line is not None: | |
468 | i = 0 |
|
468 | i = 0 | |
469 | while i < len(line) and line[i].isspace(): |
|
469 | while i < len(line) and line[i].isspace(): | |
470 | i = i+1 |
|
470 | i = i+1 | |
471 | list.append('%s %s%s\n' % (Colors.line, |
|
471 | list.append('%s %s%s\n' % (Colors.line, | |
472 | line.strip(), |
|
472 | line.strip(), | |
473 | Colors.Normal)) |
|
473 | Colors.Normal)) | |
474 | if offset is not None: |
|
474 | if offset is not None: | |
475 | s = ' ' |
|
475 | s = ' ' | |
476 | for c in line[i:offset-1]: |
|
476 | for c in line[i:offset-1]: | |
477 | if c.isspace(): |
|
477 | if c.isspace(): | |
478 | s = s + c |
|
478 | s = s + c | |
479 | else: |
|
479 | else: | |
480 | s = s + ' ' |
|
480 | s = s + ' ' | |
481 | list.append('%s%s^%s\n' % (Colors.caret, s, |
|
481 | list.append('%s%s^%s\n' % (Colors.caret, s, | |
482 | Colors.Normal) ) |
|
482 | Colors.Normal) ) | |
483 | value = msg |
|
483 | value = msg | |
484 | s = self._some_str(value) |
|
484 | s = self._some_str(value) | |
485 | if s: |
|
485 | if s: | |
486 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, |
|
486 | list.append('%s%s:%s %s\n' % (str(stype), Colors.excName, | |
487 | Colors.Normal, s)) |
|
487 | Colors.Normal, s)) | |
488 | else: |
|
488 | else: | |
489 | list.append('%s\n' % str(stype)) |
|
489 | list.append('%s\n' % str(stype)) | |
490 |
|
490 | |||
491 | # vds:>> |
|
491 | # vds:>> | |
492 | if have_filedata: |
|
492 | if have_filedata: | |
493 | __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) |
|
493 | __IPYTHON__.hooks.synchronize_with_editor(filename, lineno, 0) | |
494 | # vds:<< |
|
494 | # vds:<< | |
495 |
|
495 | |||
496 | return list |
|
496 | return list | |
497 |
|
497 | |||
498 | def _some_str(self, value): |
|
498 | def _some_str(self, value): | |
499 | # Lifted from traceback.py |
|
499 | # Lifted from traceback.py | |
500 | try: |
|
500 | try: | |
501 | return str(value) |
|
501 | return str(value) | |
502 | except: |
|
502 | except: | |
503 | return '<unprintable %s object>' % type(value).__name__ |
|
503 | return '<unprintable %s object>' % type(value).__name__ | |
504 |
|
504 | |||
505 | #---------------------------------------------------------------------------- |
|
505 | #---------------------------------------------------------------------------- | |
506 | class VerboseTB(TBTools): |
|
506 | class VerboseTB(TBTools): | |
507 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead |
|
507 | """A port of Ka-Ping Yee's cgitb.py module that outputs color text instead | |
508 | of HTML. Requires inspect and pydoc. Crazy, man. |
|
508 | of HTML. Requires inspect and pydoc. Crazy, man. | |
509 |
|
509 | |||
510 | Modified version which optionally strips the topmost entries from the |
|
510 | Modified version which optionally strips the topmost entries from the | |
511 | traceback, to be used with alternate interpreters (because their own code |
|
511 | traceback, to be used with alternate interpreters (because their own code | |
512 | would appear in the traceback).""" |
|
512 | would appear in the traceback).""" | |
513 |
|
513 | |||
514 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, |
|
514 | def __init__(self,color_scheme = 'Linux',tb_offset=0,long_header=0, | |
515 | call_pdb = 0, include_vars=1): |
|
515 | call_pdb = 0, include_vars=1): | |
516 | """Specify traceback offset, headers and color scheme. |
|
516 | """Specify traceback offset, headers and color scheme. | |
517 |
|
517 | |||
518 | Define how many frames to drop from the tracebacks. Calling it with |
|
518 | Define how many frames to drop from the tracebacks. Calling it with | |
519 | tb_offset=1 allows use of this handler in interpreters which will have |
|
519 | tb_offset=1 allows use of this handler in interpreters which will have | |
520 | their own code at the top of the traceback (VerboseTB will first |
|
520 | their own code at the top of the traceback (VerboseTB will first | |
521 | remove that frame before printing the traceback info).""" |
|
521 | remove that frame before printing the traceback info).""" | |
522 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) |
|
522 | TBTools.__init__(self,color_scheme=color_scheme,call_pdb=call_pdb) | |
523 | self.tb_offset = tb_offset |
|
523 | self.tb_offset = tb_offset | |
524 | self.long_header = long_header |
|
524 | self.long_header = long_header | |
525 | self.include_vars = include_vars |
|
525 | self.include_vars = include_vars | |
526 |
|
526 | |||
527 | def text(self, etype, evalue, etb, context=5): |
|
527 | def text(self, etype, evalue, etb, context=5): | |
528 | """Return a nice text document describing the traceback.""" |
|
528 | """Return a nice text document describing the traceback.""" | |
529 |
|
529 | |||
530 | # some locals |
|
530 | # some locals | |
531 | try: |
|
531 | try: | |
532 | etype = etype.__name__ |
|
532 | etype = etype.__name__ | |
533 | except AttributeError: |
|
533 | except AttributeError: | |
534 | pass |
|
534 | pass | |
535 | Colors = self.Colors # just a shorthand + quicker name lookup |
|
535 | Colors = self.Colors # just a shorthand + quicker name lookup | |
536 | ColorsNormal = Colors.Normal # used a lot |
|
536 | ColorsNormal = Colors.Normal # used a lot | |
537 | col_scheme = self.color_scheme_table.active_scheme_name |
|
537 | col_scheme = self.color_scheme_table.active_scheme_name | |
538 | indent = ' '*INDENT_SIZE |
|
538 | indent = ' '*INDENT_SIZE | |
539 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) |
|
539 | em_normal = '%s\n%s%s' % (Colors.valEm, indent,ColorsNormal) | |
540 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) |
|
540 | undefined = '%sundefined%s' % (Colors.em, ColorsNormal) | |
541 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) |
|
541 | exc = '%s%s%s' % (Colors.excName,etype,ColorsNormal) | |
542 |
|
542 | |||
543 | # some internal-use functions |
|
543 | # some internal-use functions | |
544 | def text_repr(value): |
|
544 | def text_repr(value): | |
545 | """Hopefully pretty robust repr equivalent.""" |
|
545 | """Hopefully pretty robust repr equivalent.""" | |
546 | # this is pretty horrible but should always return *something* |
|
546 | # this is pretty horrible but should always return *something* | |
547 | try: |
|
547 | try: | |
548 | return pydoc.text.repr(value) |
|
548 | return pydoc.text.repr(value) | |
549 | except KeyboardInterrupt: |
|
549 | except KeyboardInterrupt: | |
550 | raise |
|
550 | raise | |
551 | except: |
|
551 | except: | |
552 | try: |
|
552 | try: | |
553 | return repr(value) |
|
553 | return repr(value) | |
554 | except KeyboardInterrupt: |
|
554 | except KeyboardInterrupt: | |
555 | raise |
|
555 | raise | |
556 | except: |
|
556 | except: | |
557 | try: |
|
557 | try: | |
558 | # all still in an except block so we catch |
|
558 | # all still in an except block so we catch | |
559 | # getattr raising |
|
559 | # getattr raising | |
560 | name = getattr(value, '__name__', None) |
|
560 | name = getattr(value, '__name__', None) | |
561 | if name: |
|
561 | if name: | |
562 | # ick, recursion |
|
562 | # ick, recursion | |
563 | return text_repr(name) |
|
563 | return text_repr(name) | |
564 | klass = getattr(value, '__class__', None) |
|
564 | klass = getattr(value, '__class__', None) | |
565 | if klass: |
|
565 | if klass: | |
566 | return '%s instance' % text_repr(klass) |
|
566 | return '%s instance' % text_repr(klass) | |
567 | except KeyboardInterrupt: |
|
567 | except KeyboardInterrupt: | |
568 | raise |
|
568 | raise | |
569 | except: |
|
569 | except: | |
570 | return 'UNRECOVERABLE REPR FAILURE' |
|
570 | return 'UNRECOVERABLE REPR FAILURE' | |
571 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) |
|
571 | def eqrepr(value, repr=text_repr): return '=%s' % repr(value) | |
572 | def nullrepr(value, repr=text_repr): return '' |
|
572 | def nullrepr(value, repr=text_repr): return '' | |
573 |
|
573 | |||
574 | # meat of the code begins |
|
574 | # meat of the code begins | |
575 | try: |
|
575 | try: | |
576 | etype = etype.__name__ |
|
576 | etype = etype.__name__ | |
577 | except AttributeError: |
|
577 | except AttributeError: | |
578 | pass |
|
578 | pass | |
579 |
|
579 | |||
580 | if self.long_header: |
|
580 | if self.long_header: | |
581 | # Header with the exception type, python version, and date |
|
581 | # Header with the exception type, python version, and date | |
582 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable |
|
582 | pyver = 'Python ' + string.split(sys.version)[0] + ': ' + sys.executable | |
583 | date = time.ctime(time.time()) |
|
583 | date = time.ctime(time.time()) | |
584 |
|
584 | |||
585 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, |
|
585 | head = '%s%s%s\n%s%s%s\n%s' % (Colors.topline, '-'*75, ColorsNormal, | |
586 | exc, ' '*(75-len(str(etype))-len(pyver)), |
|
586 | exc, ' '*(75-len(str(etype))-len(pyver)), | |
587 | pyver, string.rjust(date, 75) ) |
|
587 | pyver, string.rjust(date, 75) ) | |
588 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ |
|
588 | head += "\nA problem occured executing Python code. Here is the sequence of function"\ | |
589 | "\ncalls leading up to the error, with the most recent (innermost) call last." |
|
589 | "\ncalls leading up to the error, with the most recent (innermost) call last." | |
590 | else: |
|
590 | else: | |
591 | # Simplified header |
|
591 | # Simplified header | |
592 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, |
|
592 | head = '%s%s%s\n%s%s' % (Colors.topline, '-'*75, ColorsNormal,exc, | |
593 | string.rjust('Traceback (most recent call last)', |
|
593 | string.rjust('Traceback (most recent call last)', | |
594 | 75 - len(str(etype)) ) ) |
|
594 | 75 - len(str(etype)) ) ) | |
595 | frames = [] |
|
595 | frames = [] | |
596 | # Flush cache before calling inspect. This helps alleviate some of the |
|
596 | # Flush cache before calling inspect. This helps alleviate some of the | |
597 | # problems with python 2.3's inspect.py. |
|
597 | # problems with python 2.3's inspect.py. | |
598 | linecache.checkcache() |
|
598 | linecache.checkcache() | |
599 | # Drop topmost frames if requested |
|
599 | # Drop topmost frames if requested | |
600 | try: |
|
600 | try: | |
601 | # Try the default getinnerframes and Alex's: Alex's fixes some |
|
601 | # Try the default getinnerframes and Alex's: Alex's fixes some | |
602 | # problems, but it generates empty tracebacks for console errors |
|
602 | # problems, but it generates empty tracebacks for console errors | |
603 | # (5 blanks lines) where none should be returned. |
|
603 | # (5 blanks lines) where none should be returned. | |
604 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] |
|
604 | #records = inspect.getinnerframes(etb, context)[self.tb_offset:] | |
605 | #print 'python records:', records # dbg |
|
605 | #print 'python records:', records # dbg | |
606 | records = _fixed_getinnerframes(etb, context,self.tb_offset) |
|
606 | records = _fixed_getinnerframes(etb, context,self.tb_offset) | |
607 | #print 'alex records:', records # dbg |
|
607 | #print 'alex records:', records # dbg | |
608 | except: |
|
608 | except: | |
609 |
|
609 | |||
610 | # FIXME: I've been getting many crash reports from python 2.3 |
|
610 | # FIXME: I've been getting many crash reports from python 2.3 | |
611 | # users, traceable to inspect.py. If I can find a small test-case |
|
611 | # users, traceable to inspect.py. If I can find a small test-case | |
612 | # to reproduce this, I should either write a better workaround or |
|
612 | # to reproduce this, I should either write a better workaround or | |
613 | # file a bug report against inspect (if that's the real problem). |
|
613 | # file a bug report against inspect (if that's the real problem). | |
614 | # So far, I haven't been able to find an isolated example to |
|
614 | # So far, I haven't been able to find an isolated example to | |
615 | # reproduce the problem. |
|
615 | # reproduce the problem. | |
616 | inspect_error() |
|
616 | inspect_error() | |
617 | traceback.print_exc(file=Term.cerr) |
|
617 | traceback.print_exc(file=Term.cerr) | |
618 | info('\nUnfortunately, your original traceback can not be constructed.\n') |
|
618 | info('\nUnfortunately, your original traceback can not be constructed.\n') | |
619 | return '' |
|
619 | return '' | |
620 |
|
620 | |||
621 | # build some color string templates outside these nested loops |
|
621 | # build some color string templates outside these nested loops | |
622 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) |
|
622 | tpl_link = '%s%%s%s' % (Colors.filenameEm,ColorsNormal) | |
623 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, |
|
623 | tpl_call = 'in %s%%s%s%%s%s' % (Colors.vName, Colors.valEm, | |
624 | ColorsNormal) |
|
624 | ColorsNormal) | |
625 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ |
|
625 | tpl_call_fail = 'in %s%%s%s(***failed resolving arguments***)%s' % \ | |
626 | (Colors.vName, Colors.valEm, ColorsNormal) |
|
626 | (Colors.vName, Colors.valEm, ColorsNormal) | |
627 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) |
|
627 | tpl_local_var = '%s%%s%s' % (Colors.vName, ColorsNormal) | |
628 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, |
|
628 | tpl_global_var = '%sglobal%s %s%%s%s' % (Colors.em, ColorsNormal, | |
629 | Colors.vName, ColorsNormal) |
|
629 | Colors.vName, ColorsNormal) | |
630 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) |
|
630 | tpl_name_val = '%%s %s= %%s%s' % (Colors.valEm, ColorsNormal) | |
631 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) |
|
631 | tpl_line = '%s%%s%s %%s' % (Colors.lineno, ColorsNormal) | |
632 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, |
|
632 | tpl_line_em = '%s%%s%s %%s%s' % (Colors.linenoEm,Colors.line, | |
633 | ColorsNormal) |
|
633 | ColorsNormal) | |
634 |
|
634 | |||
635 | # now, loop over all records printing context and info |
|
635 | # now, loop over all records printing context and info | |
636 | abspath = os.path.abspath |
|
636 | abspath = os.path.abspath | |
637 | for frame, file, lnum, func, lines, index in records: |
|
637 | for frame, file, lnum, func, lines, index in records: | |
638 | #print '*** record:',file,lnum,func,lines,index # dbg |
|
638 | #print '*** record:',file,lnum,func,lines,index # dbg | |
639 | try: |
|
639 | try: | |
640 | file = file and abspath(file) or '?' |
|
640 | file = file and abspath(file) or '?' | |
641 | except OSError: |
|
641 | except OSError: | |
642 | # if file is '<console>' or something not in the filesystem, |
|
642 | # if file is '<console>' or something not in the filesystem, | |
643 | # the abspath call will throw an OSError. Just ignore it and |
|
643 | # the abspath call will throw an OSError. Just ignore it and | |
644 | # keep the original file string. |
|
644 | # keep the original file string. | |
645 | pass |
|
645 | pass | |
646 | link = tpl_link % file |
|
646 | link = tpl_link % file | |
647 | try: |
|
647 | try: | |
648 | args, varargs, varkw, locals = inspect.getargvalues(frame) |
|
648 | args, varargs, varkw, locals = inspect.getargvalues(frame) | |
649 | except: |
|
649 | except: | |
650 | # This can happen due to a bug in python2.3. We should be |
|
650 | # This can happen due to a bug in python2.3. We should be | |
651 | # able to remove this try/except when 2.4 becomes a |
|
651 | # able to remove this try/except when 2.4 becomes a | |
652 | # requirement. Bug details at http://python.org/sf/1005466 |
|
652 | # requirement. Bug details at http://python.org/sf/1005466 | |
653 | inspect_error() |
|
653 | inspect_error() | |
654 | traceback.print_exc(file=Term.cerr) |
|
654 | traceback.print_exc(file=Term.cerr) | |
655 | info("\nIPython's exception reporting continues...\n") |
|
655 | info("\nIPython's exception reporting continues...\n") | |
656 |
|
656 | |||
657 | if func == '?': |
|
657 | if func == '?': | |
658 | call = '' |
|
658 | call = '' | |
659 | else: |
|
659 | else: | |
660 | # Decide whether to include variable details or not |
|
660 | # Decide whether to include variable details or not | |
661 | var_repr = self.include_vars and eqrepr or nullrepr |
|
661 | var_repr = self.include_vars and eqrepr or nullrepr | |
662 | try: |
|
662 | try: | |
663 | call = tpl_call % (func,inspect.formatargvalues(args, |
|
663 | call = tpl_call % (func,inspect.formatargvalues(args, | |
664 | varargs, varkw, |
|
664 | varargs, varkw, | |
665 | locals,formatvalue=var_repr)) |
|
665 | locals,formatvalue=var_repr)) | |
666 | except KeyError: |
|
666 | except KeyError: | |
667 | # Very odd crash from inspect.formatargvalues(). The |
|
667 | # Very odd crash from inspect.formatargvalues(). The | |
668 | # scenario under which it appeared was a call to |
|
668 | # scenario under which it appeared was a call to | |
669 | # view(array,scale) in NumTut.view.view(), where scale had |
|
669 | # view(array,scale) in NumTut.view.view(), where scale had | |
670 | # been defined as a scalar (it should be a tuple). Somehow |
|
670 | # been defined as a scalar (it should be a tuple). Somehow | |
671 | # inspect messes up resolving the argument list of view() |
|
671 | # inspect messes up resolving the argument list of view() | |
672 | # and barfs out. At some point I should dig into this one |
|
672 | # and barfs out. At some point I should dig into this one | |
673 | # and file a bug report about it. |
|
673 | # and file a bug report about it. | |
674 | inspect_error() |
|
674 | inspect_error() | |
675 | traceback.print_exc(file=Term.cerr) |
|
675 | traceback.print_exc(file=Term.cerr) | |
676 | info("\nIPython's exception reporting continues...\n") |
|
676 | info("\nIPython's exception reporting continues...\n") | |
677 | call = tpl_call_fail % func |
|
677 | call = tpl_call_fail % func | |
678 |
|
678 | |||
679 | # Initialize a list of names on the current line, which the |
|
679 | # Initialize a list of names on the current line, which the | |
680 | # tokenizer below will populate. |
|
680 | # tokenizer below will populate. | |
681 | names = [] |
|
681 | names = [] | |
682 |
|
682 | |||
683 | def tokeneater(token_type, token, start, end, line): |
|
683 | def tokeneater(token_type, token, start, end, line): | |
684 | """Stateful tokeneater which builds dotted names. |
|
684 | """Stateful tokeneater which builds dotted names. | |
685 |
|
685 | |||
686 | The list of names it appends to (from the enclosing scope) can |
|
686 | The list of names it appends to (from the enclosing scope) can | |
687 | contain repeated composite names. This is unavoidable, since |
|
687 | contain repeated composite names. This is unavoidable, since | |
688 | there is no way to disambguate partial dotted structures until |
|
688 | there is no way to disambguate partial dotted structures until | |
689 | the full list is known. The caller is responsible for pruning |
|
689 | the full list is known. The caller is responsible for pruning | |
690 | the final list of duplicates before using it.""" |
|
690 | the final list of duplicates before using it.""" | |
691 |
|
691 | |||
692 | # build composite names |
|
692 | # build composite names | |
693 | if token == '.': |
|
693 | if token == '.': | |
694 | try: |
|
694 | try: | |
695 | names[-1] += '.' |
|
695 | names[-1] += '.' | |
696 | # store state so the next token is added for x.y.z names |
|
696 | # store state so the next token is added for x.y.z names | |
697 | tokeneater.name_cont = True |
|
697 | tokeneater.name_cont = True | |
698 | return |
|
698 | return | |
699 | except IndexError: |
|
699 | except IndexError: | |
700 | pass |
|
700 | pass | |
701 | if token_type == tokenize.NAME and token not in keyword.kwlist: |
|
701 | if token_type == tokenize.NAME and token not in keyword.kwlist: | |
702 | if tokeneater.name_cont: |
|
702 | if tokeneater.name_cont: | |
703 | # Dotted names |
|
703 | # Dotted names | |
704 | names[-1] += token |
|
704 | names[-1] += token | |
705 | tokeneater.name_cont = False |
|
705 | tokeneater.name_cont = False | |
706 | else: |
|
706 | else: | |
707 | # Regular new names. We append everything, the caller |
|
707 | # Regular new names. We append everything, the caller | |
708 | # will be responsible for pruning the list later. It's |
|
708 | # will be responsible for pruning the list later. It's | |
709 | # very tricky to try to prune as we go, b/c composite |
|
709 | # very tricky to try to prune as we go, b/c composite | |
710 | # names can fool us. The pruning at the end is easy |
|
710 | # names can fool us. The pruning at the end is easy | |
711 | # to do (or the caller can print a list with repeated |
|
711 | # to do (or the caller can print a list with repeated | |
712 | # names if so desired. |
|
712 | # names if so desired. | |
713 | names.append(token) |
|
713 | names.append(token) | |
714 | elif token_type == tokenize.NEWLINE: |
|
714 | elif token_type == tokenize.NEWLINE: | |
715 | raise IndexError |
|
715 | raise IndexError | |
716 | # we need to store a bit of state in the tokenizer to build |
|
716 | # we need to store a bit of state in the tokenizer to build | |
717 | # dotted names |
|
717 | # dotted names | |
718 | tokeneater.name_cont = False |
|
718 | tokeneater.name_cont = False | |
719 |
|
719 | |||
720 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): |
|
720 | def linereader(file=file, lnum=[lnum], getline=linecache.getline): | |
721 | line = getline(file, lnum[0]) |
|
721 | line = getline(file, lnum[0]) | |
722 | lnum[0] += 1 |
|
722 | lnum[0] += 1 | |
723 | return line |
|
723 | return line | |
724 |
|
724 | |||
725 | # Build the list of names on this line of code where the exception |
|
725 | # Build the list of names on this line of code where the exception | |
726 | # occurred. |
|
726 | # occurred. | |
727 | try: |
|
727 | try: | |
728 | # This builds the names list in-place by capturing it from the |
|
728 | # This builds the names list in-place by capturing it from the | |
729 | # enclosing scope. |
|
729 | # enclosing scope. | |
730 | tokenize.tokenize(linereader, tokeneater) |
|
730 | tokenize.tokenize(linereader, tokeneater) | |
731 | except IndexError: |
|
731 | except IndexError: | |
732 | # signals exit of tokenizer |
|
732 | # signals exit of tokenizer | |
733 | pass |
|
733 | pass | |
734 | except tokenize.TokenError,msg: |
|
734 | except tokenize.TokenError,msg: | |
735 | _m = ("An unexpected error occurred while tokenizing input\n" |
|
735 | _m = ("An unexpected error occurred while tokenizing input\n" | |
736 | "The following traceback may be corrupted or invalid\n" |
|
736 | "The following traceback may be corrupted or invalid\n" | |
737 | "The error message is: %s\n" % msg) |
|
737 | "The error message is: %s\n" % msg) | |
738 | error(_m) |
|
738 | error(_m) | |
739 |
|
739 | |||
740 | # prune names list of duplicates, but keep the right order |
|
740 | # prune names list of duplicates, but keep the right order | |
741 | unique_names = uniq_stable(names) |
|
741 | unique_names = uniq_stable(names) | |
742 |
|
742 | |||
743 | # Start loop over vars |
|
743 | # Start loop over vars | |
744 | lvals = [] |
|
744 | lvals = [] | |
745 | if self.include_vars: |
|
745 | if self.include_vars: | |
746 | for name_full in unique_names: |
|
746 | for name_full in unique_names: | |
747 | name_base = name_full.split('.',1)[0] |
|
747 | name_base = name_full.split('.',1)[0] | |
748 | if name_base in frame.f_code.co_varnames: |
|
748 | if name_base in frame.f_code.co_varnames: | |
749 | if locals.has_key(name_base): |
|
749 | if locals.has_key(name_base): | |
750 | try: |
|
750 | try: | |
751 | value = repr(eval(name_full,locals)) |
|
751 | value = repr(eval(name_full,locals)) | |
752 | except: |
|
752 | except: | |
753 | value = undefined |
|
753 | value = undefined | |
754 | else: |
|
754 | else: | |
755 | value = undefined |
|
755 | value = undefined | |
756 | name = tpl_local_var % name_full |
|
756 | name = tpl_local_var % name_full | |
757 | else: |
|
757 | else: | |
758 | if frame.f_globals.has_key(name_base): |
|
758 | if frame.f_globals.has_key(name_base): | |
759 | try: |
|
759 | try: | |
760 | value = repr(eval(name_full,frame.f_globals)) |
|
760 | value = repr(eval(name_full,frame.f_globals)) | |
761 | except: |
|
761 | except: | |
762 | value = undefined |
|
762 | value = undefined | |
763 | else: |
|
763 | else: | |
764 | value = undefined |
|
764 | value = undefined | |
765 | name = tpl_global_var % name_full |
|
765 | name = tpl_global_var % name_full | |
766 | lvals.append(tpl_name_val % (name,value)) |
|
766 | lvals.append(tpl_name_val % (name,value)) | |
767 | if lvals: |
|
767 | if lvals: | |
768 | lvals = '%s%s' % (indent,em_normal.join(lvals)) |
|
768 | lvals = '%s%s' % (indent,em_normal.join(lvals)) | |
769 | else: |
|
769 | else: | |
770 | lvals = '' |
|
770 | lvals = '' | |
771 |
|
771 | |||
772 | level = '%s %s\n' % (link,call) |
|
772 | level = '%s %s\n' % (link,call) | |
773 |
|
773 | |||
774 | if index is None: |
|
774 | if index is None: | |
775 | frames.append(level) |
|
775 | frames.append(level) | |
776 | else: |
|
776 | else: | |
777 | frames.append('%s%s' % (level,''.join( |
|
777 | frames.append('%s%s' % (level,''.join( | |
778 | _formatTracebackLines(lnum,index,lines,Colors,lvals, |
|
778 | _formatTracebackLines(lnum,index,lines,Colors,lvals, | |
779 | col_scheme)))) |
|
779 | col_scheme)))) | |
780 |
|
780 | |||
781 | # Get (safely) a string form of the exception info |
|
781 | # Get (safely) a string form of the exception info | |
782 | try: |
|
782 | try: | |
783 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
783 | etype_str,evalue_str = map(str,(etype,evalue)) | |
784 | except: |
|
784 | except: | |
785 | # User exception is improperly defined. |
|
785 | # User exception is improperly defined. | |
786 | etype,evalue = str,sys.exc_info()[:2] |
|
786 | etype,evalue = str,sys.exc_info()[:2] | |
787 | etype_str,evalue_str = map(str,(etype,evalue)) |
|
787 | etype_str,evalue_str = map(str,(etype,evalue)) | |
788 | # ... and format it |
|
788 | # ... and format it | |
789 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, |
|
789 | exception = ['%s%s%s: %s' % (Colors.excName, etype_str, | |
790 | ColorsNormal, evalue_str)] |
|
790 | ColorsNormal, evalue_str)] | |
791 | if type(evalue) is types.InstanceType: |
|
791 | if type(evalue) is types.InstanceType: | |
792 | try: |
|
792 | try: | |
793 | names = [w for w in dir(evalue) if isinstance(w, basestring)] |
|
793 | names = [w for w in dir(evalue) if isinstance(w, basestring)] | |
794 | except: |
|
794 | except: | |
795 | # Every now and then, an object with funny inernals blows up |
|
795 | # Every now and then, an object with funny inernals blows up | |
796 | # when dir() is called on it. We do the best we can to report |
|
796 | # when dir() is called on it. We do the best we can to report | |
797 | # the problem and continue |
|
797 | # the problem and continue | |
798 | _m = '%sException reporting error (object with broken dir())%s:' |
|
798 | _m = '%sException reporting error (object with broken dir())%s:' | |
799 | exception.append(_m % (Colors.excName,ColorsNormal)) |
|
799 | exception.append(_m % (Colors.excName,ColorsNormal)) | |
800 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) |
|
800 | etype_str,evalue_str = map(str,sys.exc_info()[:2]) | |
801 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, |
|
801 | exception.append('%s%s%s: %s' % (Colors.excName,etype_str, | |
802 | ColorsNormal, evalue_str)) |
|
802 | ColorsNormal, evalue_str)) | |
803 | names = [] |
|
803 | names = [] | |
804 | for name in names: |
|
804 | for name in names: | |
805 | value = text_repr(getattr(evalue, name)) |
|
805 | value = text_repr(getattr(evalue, name)) | |
806 | exception.append('\n%s%s = %s' % (indent, name, value)) |
|
806 | exception.append('\n%s%s = %s' % (indent, name, value)) | |
807 |
|
807 | |||
808 | # vds: >> |
|
808 | # vds: >> | |
809 | if records: |
|
809 | if records: | |
810 | filepath, lnum = records[-1][1:3] |
|
810 | filepath, lnum = records[-1][1:3] | |
811 | #print "file:", str(file), "linenb", str(lnum) # dbg |
|
811 | #print "file:", str(file), "linenb", str(lnum) # dbg | |
812 | filepath = os.path.abspath(filepath) |
|
812 | filepath = os.path.abspath(filepath) | |
813 | __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) |
|
813 | __IPYTHON__.hooks.synchronize_with_editor(filepath, lnum, 0) | |
814 | # vds: << |
|
814 | # vds: << | |
815 |
|
815 | |||
816 | # return all our info assembled as a single string |
|
816 | # return all our info assembled as a single string | |
817 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) |
|
817 | return '%s\n\n%s\n%s' % (head,'\n'.join(frames),''.join(exception[0]) ) | |
818 |
|
818 | |||
819 | def debugger(self,force=False): |
|
819 | def debugger(self,force=False): | |
820 | """Call up the pdb debugger if desired, always clean up the tb |
|
820 | """Call up the pdb debugger if desired, always clean up the tb | |
821 | reference. |
|
821 | reference. | |
822 |
|
822 | |||
823 | Keywords: |
|
823 | Keywords: | |
824 |
|
824 | |||
825 | - force(False): by default, this routine checks the instance call_pdb |
|
825 | - force(False): by default, this routine checks the instance call_pdb | |
826 | flag and does not actually invoke the debugger if the flag is false. |
|
826 | flag and does not actually invoke the debugger if the flag is false. | |
827 | The 'force' option forces the debugger to activate even if the flag |
|
827 | The 'force' option forces the debugger to activate even if the flag | |
828 | is false. |
|
828 | is false. | |
829 |
|
829 | |||
830 | If the call_pdb flag is set, the pdb interactive debugger is |
|
830 | If the call_pdb flag is set, the pdb interactive debugger is | |
831 | invoked. In all cases, the self.tb reference to the current traceback |
|
831 | invoked. In all cases, the self.tb reference to the current traceback | |
832 | is deleted to prevent lingering references which hamper memory |
|
832 | is deleted to prevent lingering references which hamper memory | |
833 | management. |
|
833 | management. | |
834 |
|
834 | |||
835 | Note that each call to pdb() does an 'import readline', so if your app |
|
835 | Note that each call to pdb() does an 'import readline', so if your app | |
836 | requires a special setup for the readline completers, you'll have to |
|
836 | requires a special setup for the readline completers, you'll have to | |
837 | fix that by hand after invoking the exception handler.""" |
|
837 | fix that by hand after invoking the exception handler.""" | |
838 |
|
838 | |||
839 | if force or self.call_pdb: |
|
839 | if force or self.call_pdb: | |
840 | if self.pdb is None: |
|
840 | if self.pdb is None: | |
841 | self.pdb = debugger.Pdb( |
|
841 | self.pdb = debugger.Pdb( | |
842 | self.color_scheme_table.active_scheme_name) |
|
842 | self.color_scheme_table.active_scheme_name) | |
843 | # the system displayhook may have changed, restore the original |
|
843 | # the system displayhook may have changed, restore the original | |
844 | # for pdb |
|
844 | # for pdb | |
845 | dhook = sys.displayhook |
|
845 | dhook = sys.displayhook | |
846 | sys.displayhook = sys.__displayhook__ |
|
846 | sys.displayhook = sys.__displayhook__ | |
847 | self.pdb.reset() |
|
847 | self.pdb.reset() | |
848 | # Find the right frame so we don't pop up inside ipython itself |
|
848 | # Find the right frame so we don't pop up inside ipython itself | |
849 | if hasattr(self,'tb'): |
|
849 | if hasattr(self,'tb'): | |
850 | etb = self.tb |
|
850 | etb = self.tb | |
851 | else: |
|
851 | else: | |
852 | etb = self.tb = sys.last_traceback |
|
852 | etb = self.tb = sys.last_traceback | |
853 | while self.tb.tb_next is not None: |
|
853 | while self.tb.tb_next is not None: | |
854 | self.tb = self.tb.tb_next |
|
854 | self.tb = self.tb.tb_next | |
855 | try: |
|
855 | try: | |
856 | if etb and etb.tb_next: |
|
856 | if etb and etb.tb_next: | |
857 | etb = etb.tb_next |
|
857 | etb = etb.tb_next | |
858 | self.pdb.botframe = etb.tb_frame |
|
858 | self.pdb.botframe = etb.tb_frame | |
859 | self.pdb.interaction(self.tb.tb_frame, self.tb) |
|
859 | self.pdb.interaction(self.tb.tb_frame, self.tb) | |
860 | finally: |
|
860 | finally: | |
861 | sys.displayhook = dhook |
|
861 | sys.displayhook = dhook | |
862 |
|
862 | |||
863 | if hasattr(self,'tb'): |
|
863 | if hasattr(self,'tb'): | |
864 | del self.tb |
|
864 | del self.tb | |
865 |
|
865 | |||
866 | def handler(self, info=None): |
|
866 | def handler(self, info=None): | |
867 | (etype, evalue, etb) = info or sys.exc_info() |
|
867 | (etype, evalue, etb) = info or sys.exc_info() | |
868 | self.tb = etb |
|
868 | self.tb = etb | |
869 | Term.cout.flush() |
|
869 | Term.cout.flush() | |
870 | print >> Term.cerr, self.text(etype, evalue, etb) |
|
870 | print >> Term.cerr, self.text(etype, evalue, etb) | |
871 | Term.cerr.flush() |
|
871 | Term.cerr.flush() | |
872 |
|
872 | |||
873 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
873 | # Changed so an instance can just be called as VerboseTB_inst() and print | |
874 | # out the right info on its own. |
|
874 | # out the right info on its own. | |
875 | def __call__(self, etype=None, evalue=None, etb=None): |
|
875 | def __call__(self, etype=None, evalue=None, etb=None): | |
876 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" |
|
876 | """This hook can replace sys.excepthook (for Python 2.1 or higher).""" | |
877 | if etb is None: |
|
877 | if etb is None: | |
878 | self.handler() |
|
878 | self.handler() | |
879 | else: |
|
879 | else: | |
880 | self.handler((etype, evalue, etb)) |
|
880 | self.handler((etype, evalue, etb)) | |
881 | try: |
|
881 | try: | |
882 | self.debugger() |
|
882 | self.debugger() | |
883 | except KeyboardInterrupt: |
|
883 | except KeyboardInterrupt: | |
884 | print "\nKeyboardInterrupt" |
|
884 | print "\nKeyboardInterrupt" | |
885 |
|
885 | |||
886 | #---------------------------------------------------------------------------- |
|
886 | #---------------------------------------------------------------------------- | |
887 | class FormattedTB(VerboseTB,ListTB): |
|
887 | class FormattedTB(VerboseTB,ListTB): | |
888 | """Subclass ListTB but allow calling with a traceback. |
|
888 | """Subclass ListTB but allow calling with a traceback. | |
889 |
|
889 | |||
890 | It can thus be used as a sys.excepthook for Python > 2.1. |
|
890 | It can thus be used as a sys.excepthook for Python > 2.1. | |
891 |
|
891 | |||
892 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. |
|
892 | Also adds 'Context' and 'Verbose' modes, not available in ListTB. | |
893 |
|
893 | |||
894 | Allows a tb_offset to be specified. This is useful for situations where |
|
894 | Allows a tb_offset to be specified. This is useful for situations where | |
895 | one needs to remove a number of topmost frames from the traceback (such as |
|
895 | one needs to remove a number of topmost frames from the traceback (such as | |
896 | occurs with python programs that themselves execute other python code, |
|
896 | occurs with python programs that themselves execute other python code, | |
897 | like Python shells). """ |
|
897 | like Python shells). """ | |
898 |
|
898 | |||
899 | def __init__(self, mode = 'Plain', color_scheme='Linux', |
|
899 | def __init__(self, mode = 'Plain', color_scheme='Linux', | |
900 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): |
|
900 | tb_offset = 0,long_header=0,call_pdb=0,include_vars=0): | |
901 |
|
901 | |||
902 | # NEVER change the order of this list. Put new modes at the end: |
|
902 | # NEVER change the order of this list. Put new modes at the end: | |
903 | self.valid_modes = ['Plain','Context','Verbose'] |
|
903 | self.valid_modes = ['Plain','Context','Verbose'] | |
904 | self.verbose_modes = self.valid_modes[1:3] |
|
904 | self.verbose_modes = self.valid_modes[1:3] | |
905 |
|
905 | |||
906 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, |
|
906 | VerboseTB.__init__(self,color_scheme,tb_offset,long_header, | |
907 | call_pdb=call_pdb,include_vars=include_vars) |
|
907 | call_pdb=call_pdb,include_vars=include_vars) | |
908 | self.set_mode(mode) |
|
908 | self.set_mode(mode) | |
909 |
|
909 | |||
910 | def _extract_tb(self,tb): |
|
910 | def _extract_tb(self,tb): | |
911 | if tb: |
|
911 | if tb: | |
912 | return traceback.extract_tb(tb) |
|
912 | return traceback.extract_tb(tb) | |
913 | else: |
|
913 | else: | |
914 | return None |
|
914 | return None | |
915 |
|
915 | |||
916 | def text(self, etype, value, tb,context=5,mode=None): |
|
916 | def text(self, etype, value, tb,context=5,mode=None): | |
917 | """Return formatted traceback. |
|
917 | """Return formatted traceback. | |
918 |
|
918 | |||
919 | If the optional mode parameter is given, it overrides the current |
|
919 | If the optional mode parameter is given, it overrides the current | |
920 | mode.""" |
|
920 | mode.""" | |
921 |
|
921 | |||
922 | if mode is None: |
|
922 | if mode is None: | |
923 | mode = self.mode |
|
923 | mode = self.mode | |
924 | if mode in self.verbose_modes: |
|
924 | if mode in self.verbose_modes: | |
925 | # verbose modes need a full traceback |
|
925 | # verbose modes need a full traceback | |
926 | return VerboseTB.text(self,etype, value, tb,context=5) |
|
926 | return VerboseTB.text(self,etype, value, tb,context=5) | |
927 | else: |
|
927 | else: | |
928 | # We must check the source cache because otherwise we can print |
|
928 | # We must check the source cache because otherwise we can print | |
929 | # out-of-date source code. |
|
929 | # out-of-date source code. | |
930 | linecache.checkcache() |
|
930 | linecache.checkcache() | |
931 | # Now we can extract and format the exception |
|
931 | # Now we can extract and format the exception | |
932 | elist = self._extract_tb(tb) |
|
932 | elist = self._extract_tb(tb) | |
933 | if len(elist) > self.tb_offset: |
|
933 | if len(elist) > self.tb_offset: | |
934 | del elist[:self.tb_offset] |
|
934 | del elist[:self.tb_offset] | |
935 | return ListTB.text(self,etype,value,elist) |
|
935 | return ListTB.text(self,etype,value,elist) | |
936 |
|
936 | |||
937 | def set_mode(self,mode=None): |
|
937 | def set_mode(self,mode=None): | |
938 | """Switch to the desired mode. |
|
938 | """Switch to the desired mode. | |
939 |
|
939 | |||
940 | If mode is not specified, cycles through the available modes.""" |
|
940 | If mode is not specified, cycles through the available modes.""" | |
941 |
|
941 | |||
942 | if not mode: |
|
942 | if not mode: | |
943 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ |
|
943 | new_idx = ( self.valid_modes.index(self.mode) + 1 ) % \ | |
944 | len(self.valid_modes) |
|
944 | len(self.valid_modes) | |
945 | self.mode = self.valid_modes[new_idx] |
|
945 | self.mode = self.valid_modes[new_idx] | |
946 | elif mode not in self.valid_modes: |
|
946 | elif mode not in self.valid_modes: | |
947 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ |
|
947 | raise ValueError, 'Unrecognized mode in FormattedTB: <'+mode+'>\n'\ | |
948 | 'Valid modes: '+str(self.valid_modes) |
|
948 | 'Valid modes: '+str(self.valid_modes) | |
949 | else: |
|
949 | else: | |
950 | self.mode = mode |
|
950 | self.mode = mode | |
951 | # include variable details only in 'Verbose' mode |
|
951 | # include variable details only in 'Verbose' mode | |
952 | self.include_vars = (self.mode == self.valid_modes[2]) |
|
952 | self.include_vars = (self.mode == self.valid_modes[2]) | |
953 |
|
953 | |||
954 | # some convenient shorcuts |
|
954 | # some convenient shorcuts | |
955 | def plain(self): |
|
955 | def plain(self): | |
956 | self.set_mode(self.valid_modes[0]) |
|
956 | self.set_mode(self.valid_modes[0]) | |
957 |
|
957 | |||
958 | def context(self): |
|
958 | def context(self): | |
959 | self.set_mode(self.valid_modes[1]) |
|
959 | self.set_mode(self.valid_modes[1]) | |
960 |
|
960 | |||
961 | def verbose(self): |
|
961 | def verbose(self): | |
962 | self.set_mode(self.valid_modes[2]) |
|
962 | self.set_mode(self.valid_modes[2]) | |
963 |
|
963 | |||
964 | #---------------------------------------------------------------------------- |
|
964 | #---------------------------------------------------------------------------- | |
965 | class AutoFormattedTB(FormattedTB): |
|
965 | class AutoFormattedTB(FormattedTB): | |
966 | """A traceback printer which can be called on the fly. |
|
966 | """A traceback printer which can be called on the fly. | |
967 |
|
967 | |||
968 | It will find out about exceptions by itself. |
|
968 | It will find out about exceptions by itself. | |
969 |
|
969 | |||
970 | A brief example: |
|
970 | A brief example: | |
971 |
|
971 | |||
972 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') |
|
972 | AutoTB = AutoFormattedTB(mode = 'Verbose',color_scheme='Linux') | |
973 | try: |
|
973 | try: | |
974 | ... |
|
974 | ... | |
975 | except: |
|
975 | except: | |
976 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
976 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object | |
977 | """ |
|
977 | """ | |
978 | def __call__(self,etype=None,evalue=None,etb=None, |
|
978 | def __call__(self,etype=None,evalue=None,etb=None, | |
979 | out=None,tb_offset=None): |
|
979 | out=None,tb_offset=None): | |
980 | """Print out a formatted exception traceback. |
|
980 | """Print out a formatted exception traceback. | |
981 |
|
981 | |||
982 | Optional arguments: |
|
982 | Optional arguments: | |
983 | - out: an open file-like object to direct output to. |
|
983 | - out: an open file-like object to direct output to. | |
984 |
|
984 | |||
985 | - tb_offset: the number of frames to skip over in the stack, on a |
|
985 | - tb_offset: the number of frames to skip over in the stack, on a | |
986 | per-call basis (this overrides temporarily the instance's tb_offset |
|
986 | per-call basis (this overrides temporarily the instance's tb_offset | |
987 | given at initialization time. """ |
|
987 | given at initialization time. """ | |
988 |
|
988 | |||
989 | if out is None: |
|
989 | if out is None: | |
990 | out = Term.cerr |
|
990 | out = Term.cerr | |
991 | Term.cout.flush() |
|
991 | Term.cout.flush() | |
992 | if tb_offset is not None: |
|
992 | if tb_offset is not None: | |
993 | tb_offset, self.tb_offset = self.tb_offset, tb_offset |
|
993 | tb_offset, self.tb_offset = self.tb_offset, tb_offset | |
994 | print >> out, self.text(etype, evalue, etb) |
|
994 | print >> out, self.text(etype, evalue, etb) | |
995 | self.tb_offset = tb_offset |
|
995 | self.tb_offset = tb_offset | |
996 | else: |
|
996 | else: | |
997 | print >> out, self.text(etype, evalue, etb) |
|
997 | print >> out, self.text(etype, evalue, etb) | |
998 | out.flush() |
|
998 | out.flush() | |
999 | try: |
|
999 | try: | |
1000 | self.debugger() |
|
1000 | self.debugger() | |
1001 | except KeyboardInterrupt: |
|
1001 | except KeyboardInterrupt: | |
1002 | print "\nKeyboardInterrupt" |
|
1002 | print "\nKeyboardInterrupt" | |
1003 |
|
1003 | |||
1004 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): |
|
1004 | def text(self,etype=None,value=None,tb=None,context=5,mode=None): | |
1005 | if etype is None: |
|
1005 | if etype is None: | |
1006 | etype,value,tb = sys.exc_info() |
|
1006 | etype,value,tb = sys.exc_info() | |
1007 | self.tb = tb |
|
1007 | self.tb = tb | |
1008 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) |
|
1008 | return FormattedTB.text(self,etype,value,tb,context=5,mode=mode) | |
1009 |
|
1009 | |||
1010 | #--------------------------------------------------------------------------- |
|
1010 | #--------------------------------------------------------------------------- | |
1011 | # A simple class to preserve Nathan's original functionality. |
|
1011 | # A simple class to preserve Nathan's original functionality. | |
1012 | class ColorTB(FormattedTB): |
|
1012 | class ColorTB(FormattedTB): | |
1013 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" |
|
1013 | """Shorthand to initialize a FormattedTB in Linux colors mode.""" | |
1014 | def __init__(self,color_scheme='Linux',call_pdb=0): |
|
1014 | def __init__(self,color_scheme='Linux',call_pdb=0): | |
1015 | FormattedTB.__init__(self,color_scheme=color_scheme, |
|
1015 | FormattedTB.__init__(self,color_scheme=color_scheme, | |
1016 | call_pdb=call_pdb) |
|
1016 | call_pdb=call_pdb) | |
1017 |
|
1017 | |||
1018 | #---------------------------------------------------------------------------- |
|
1018 | #---------------------------------------------------------------------------- | |
1019 | # module testing (minimal) |
|
1019 | # module testing (minimal) | |
1020 | if __name__ == "__main__": |
|
1020 | if __name__ == "__main__": | |
1021 | def spam(c, (d, e)): |
|
1021 | def spam(c, (d, e)): | |
1022 | x = c + d |
|
1022 | x = c + d | |
1023 | y = c * d |
|
1023 | y = c * d | |
1024 | foo(x, y) |
|
1024 | foo(x, y) | |
1025 |
|
1025 | |||
1026 | def foo(a, b, bar=1): |
|
1026 | def foo(a, b, bar=1): | |
1027 | eggs(a, b + bar) |
|
1027 | eggs(a, b + bar) | |
1028 |
|
1028 | |||
1029 | def eggs(f, g, z=globals()): |
|
1029 | def eggs(f, g, z=globals()): | |
1030 | h = f + g |
|
1030 | h = f + g | |
1031 | i = f - g |
|
1031 | i = f - g | |
1032 | return h / i |
|
1032 | return h / i | |
1033 |
|
1033 | |||
1034 | print '' |
|
1034 | print '' | |
1035 | print '*** Before ***' |
|
1035 | print '*** Before ***' | |
1036 | try: |
|
1036 | try: | |
1037 | print spam(1, (2, 3)) |
|
1037 | print spam(1, (2, 3)) | |
1038 | except: |
|
1038 | except: | |
1039 | traceback.print_exc() |
|
1039 | traceback.print_exc() | |
1040 | print '' |
|
1040 | print '' | |
1041 |
|
1041 | |||
1042 | handler = ColorTB() |
|
1042 | handler = ColorTB() | |
1043 | print '*** ColorTB ***' |
|
1043 | print '*** ColorTB ***' | |
1044 | try: |
|
1044 | try: | |
1045 | print spam(1, (2, 3)) |
|
1045 | print spam(1, (2, 3)) | |
1046 | except: |
|
1046 | except: | |
1047 | apply(handler, sys.exc_info() ) |
|
1047 | apply(handler, sys.exc_info() ) | |
1048 | print '' |
|
1048 | print '' | |
1049 |
|
1049 | |||
1050 | handler = VerboseTB() |
|
1050 | handler = VerboseTB() | |
1051 | print '*** VerboseTB ***' |
|
1051 | print '*** VerboseTB ***' | |
1052 | try: |
|
1052 | try: | |
1053 | print spam(1, (2, 3)) |
|
1053 | print spam(1, (2, 3)) | |
1054 | except: |
|
1054 | except: | |
1055 | apply(handler, sys.exc_info() ) |
|
1055 | apply(handler, sys.exc_info() ) | |
1056 | print '' |
|
1056 | print '' | |
1057 |
|
1057 |
@@ -1,490 +1,490 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Manage background (threaded) jobs conveniently from an interactive shell. |
|
2 | """Manage background (threaded) jobs conveniently from an interactive shell. | |
3 |
|
3 | |||
4 | This module provides a BackgroundJobManager class. This is the main class |
|
4 | This module provides a BackgroundJobManager class. This is the main class | |
5 | meant for public usage, it implements an object which can create and manage |
|
5 | meant for public usage, it implements an object which can create and manage | |
6 | new background jobs. |
|
6 | new background jobs. | |
7 |
|
7 | |||
8 | It also provides the actual job classes managed by these BackgroundJobManager |
|
8 | It also provides the actual job classes managed by these BackgroundJobManager | |
9 | objects, see their docstrings below. |
|
9 | objects, see their docstrings below. | |
10 |
|
10 | |||
11 |
|
11 | |||
12 | This system was inspired by discussions with B. Granger and the |
|
12 | This system was inspired by discussions with B. Granger and the | |
13 | BackgroundCommand class described in the book Python Scripting for |
|
13 | BackgroundCommand class described in the book Python Scripting for | |
14 | Computational Science, by H. P. Langtangen: |
|
14 | Computational Science, by H. P. Langtangen: | |
15 |
|
15 | |||
16 | http://folk.uio.no/hpl/scripting |
|
16 | http://folk.uio.no/hpl/scripting | |
17 |
|
17 | |||
18 | (although ultimately no code from this text was used, as IPython's system is a |
|
18 | (although ultimately no code from this text was used, as IPython's system is a | |
19 | separate implementation). |
|
19 | separate implementation). | |
20 | """ |
|
20 | """ | |
21 |
|
21 | |||
22 | #***************************************************************************** |
|
22 | #***************************************************************************** | |
23 | # Copyright (C) 2005-2006 Fernando Perez <fperez@colorado.edu> |
|
23 | # Copyright (C) 2005-2006 Fernando Perez <fperez@colorado.edu> | |
24 | # |
|
24 | # | |
25 | # Distributed under the terms of the BSD License. The full license is in |
|
25 | # Distributed under the terms of the BSD License. The full license is in | |
26 | # the file COPYING, distributed as part of this software. |
|
26 | # the file COPYING, distributed as part of this software. | |
27 | #***************************************************************************** |
|
27 | #***************************************************************************** | |
28 |
|
28 | |||
29 | # Code begins |
|
29 | # Code begins | |
30 | import sys |
|
30 | import sys | |
31 | import threading |
|
31 | import threading | |
32 |
|
32 | |||
33 |
from IPython. |
|
33 | from IPython.core.ultratb import AutoFormattedTB | |
34 | from IPython.utils.genutils import warn,error |
|
34 | from IPython.utils.genutils import warn,error | |
35 |
|
35 | |||
36 | class BackgroundJobManager: |
|
36 | class BackgroundJobManager: | |
37 | """Class to manage a pool of backgrounded threaded jobs. |
|
37 | """Class to manage a pool of backgrounded threaded jobs. | |
38 |
|
38 | |||
39 | Below, we assume that 'jobs' is a BackgroundJobManager instance. |
|
39 | Below, we assume that 'jobs' is a BackgroundJobManager instance. | |
40 |
|
40 | |||
41 | Usage summary (see the method docstrings for details): |
|
41 | Usage summary (see the method docstrings for details): | |
42 |
|
42 | |||
43 | jobs.new(...) -> start a new job |
|
43 | jobs.new(...) -> start a new job | |
44 |
|
44 | |||
45 | jobs() or jobs.status() -> print status summary of all jobs |
|
45 | jobs() or jobs.status() -> print status summary of all jobs | |
46 |
|
46 | |||
47 | jobs[N] -> returns job number N. |
|
47 | jobs[N] -> returns job number N. | |
48 |
|
48 | |||
49 | foo = jobs[N].result -> assign to variable foo the result of job N |
|
49 | foo = jobs[N].result -> assign to variable foo the result of job N | |
50 |
|
50 | |||
51 | jobs[N].traceback() -> print the traceback of dead job N |
|
51 | jobs[N].traceback() -> print the traceback of dead job N | |
52 |
|
52 | |||
53 | jobs.remove(N) -> remove (finished) job N |
|
53 | jobs.remove(N) -> remove (finished) job N | |
54 |
|
54 | |||
55 | jobs.flush_finished() -> remove all finished jobs |
|
55 | jobs.flush_finished() -> remove all finished jobs | |
56 |
|
56 | |||
57 | As a convenience feature, BackgroundJobManager instances provide the |
|
57 | As a convenience feature, BackgroundJobManager instances provide the | |
58 | utility result and traceback methods which retrieve the corresponding |
|
58 | utility result and traceback methods which retrieve the corresponding | |
59 | information from the jobs list: |
|
59 | information from the jobs list: | |
60 |
|
60 | |||
61 | jobs.result(N) <--> jobs[N].result |
|
61 | jobs.result(N) <--> jobs[N].result | |
62 | jobs.traceback(N) <--> jobs[N].traceback() |
|
62 | jobs.traceback(N) <--> jobs[N].traceback() | |
63 |
|
63 | |||
64 | While this appears minor, it allows you to use tab completion |
|
64 | While this appears minor, it allows you to use tab completion | |
65 | interactively on the job manager instance. |
|
65 | interactively on the job manager instance. | |
66 |
|
66 | |||
67 | In interactive mode, IPython provides the magic fuction %bg for quick |
|
67 | In interactive mode, IPython provides the magic fuction %bg for quick | |
68 | creation of backgrounded expression-based jobs. Type bg? for details.""" |
|
68 | creation of backgrounded expression-based jobs. Type bg? for details.""" | |
69 |
|
69 | |||
70 | def __init__(self): |
|
70 | def __init__(self): | |
71 | # Lists for job management |
|
71 | # Lists for job management | |
72 | self.jobs_run = [] |
|
72 | self.jobs_run = [] | |
73 | self.jobs_comp = [] |
|
73 | self.jobs_comp = [] | |
74 | self.jobs_dead = [] |
|
74 | self.jobs_dead = [] | |
75 | # A dict of all jobs, so users can easily access any of them |
|
75 | # A dict of all jobs, so users can easily access any of them | |
76 | self.jobs_all = {} |
|
76 | self.jobs_all = {} | |
77 | # For reporting |
|
77 | # For reporting | |
78 | self._comp_report = [] |
|
78 | self._comp_report = [] | |
79 | self._dead_report = [] |
|
79 | self._dead_report = [] | |
80 | # Store status codes locally for fast lookups |
|
80 | # Store status codes locally for fast lookups | |
81 | self._s_created = BackgroundJobBase.stat_created_c |
|
81 | self._s_created = BackgroundJobBase.stat_created_c | |
82 | self._s_running = BackgroundJobBase.stat_running_c |
|
82 | self._s_running = BackgroundJobBase.stat_running_c | |
83 | self._s_completed = BackgroundJobBase.stat_completed_c |
|
83 | self._s_completed = BackgroundJobBase.stat_completed_c | |
84 | self._s_dead = BackgroundJobBase.stat_dead_c |
|
84 | self._s_dead = BackgroundJobBase.stat_dead_c | |
85 |
|
85 | |||
86 | def new(self,func_or_exp,*args,**kwargs): |
|
86 | def new(self,func_or_exp,*args,**kwargs): | |
87 | """Add a new background job and start it in a separate thread. |
|
87 | """Add a new background job and start it in a separate thread. | |
88 |
|
88 | |||
89 | There are two types of jobs which can be created: |
|
89 | There are two types of jobs which can be created: | |
90 |
|
90 | |||
91 | 1. Jobs based on expressions which can be passed to an eval() call. |
|
91 | 1. Jobs based on expressions which can be passed to an eval() call. | |
92 | The expression must be given as a string. For example: |
|
92 | The expression must be given as a string. For example: | |
93 |
|
93 | |||
94 | job_manager.new('myfunc(x,y,z=1)'[,glob[,loc]]) |
|
94 | job_manager.new('myfunc(x,y,z=1)'[,glob[,loc]]) | |
95 |
|
95 | |||
96 | The given expression is passed to eval(), along with the optional |
|
96 | The given expression is passed to eval(), along with the optional | |
97 | global/local dicts provided. If no dicts are given, they are |
|
97 | global/local dicts provided. If no dicts are given, they are | |
98 | extracted automatically from the caller's frame. |
|
98 | extracted automatically from the caller's frame. | |
99 |
|
99 | |||
100 | A Python statement is NOT a valid eval() expression. Basically, you |
|
100 | A Python statement is NOT a valid eval() expression. Basically, you | |
101 | can only use as an eval() argument something which can go on the right |
|
101 | can only use as an eval() argument something which can go on the right | |
102 | of an '=' sign and be assigned to a variable. |
|
102 | of an '=' sign and be assigned to a variable. | |
103 |
|
103 | |||
104 | For example,"print 'hello'" is not valid, but '2+3' is. |
|
104 | For example,"print 'hello'" is not valid, but '2+3' is. | |
105 |
|
105 | |||
106 | 2. Jobs given a function object, optionally passing additional |
|
106 | 2. Jobs given a function object, optionally passing additional | |
107 | positional arguments: |
|
107 | positional arguments: | |
108 |
|
108 | |||
109 | job_manager.new(myfunc,x,y) |
|
109 | job_manager.new(myfunc,x,y) | |
110 |
|
110 | |||
111 | The function is called with the given arguments. |
|
111 | The function is called with the given arguments. | |
112 |
|
112 | |||
113 | If you need to pass keyword arguments to your function, you must |
|
113 | If you need to pass keyword arguments to your function, you must | |
114 | supply them as a dict named kw: |
|
114 | supply them as a dict named kw: | |
115 |
|
115 | |||
116 | job_manager.new(myfunc,x,y,kw=dict(z=1)) |
|
116 | job_manager.new(myfunc,x,y,kw=dict(z=1)) | |
117 |
|
117 | |||
118 | The reason for this assymmetry is that the new() method needs to |
|
118 | The reason for this assymmetry is that the new() method needs to | |
119 | maintain access to its own keywords, and this prevents name collisions |
|
119 | maintain access to its own keywords, and this prevents name collisions | |
120 | between arguments to new() and arguments to your own functions. |
|
120 | between arguments to new() and arguments to your own functions. | |
121 |
|
121 | |||
122 | In both cases, the result is stored in the job.result field of the |
|
122 | In both cases, the result is stored in the job.result field of the | |
123 | background job object. |
|
123 | background job object. | |
124 |
|
124 | |||
125 |
|
125 | |||
126 | Notes and caveats: |
|
126 | Notes and caveats: | |
127 |
|
127 | |||
128 | 1. All threads running share the same standard output. Thus, if your |
|
128 | 1. All threads running share the same standard output. Thus, if your | |
129 | background jobs generate output, it will come out on top of whatever |
|
129 | background jobs generate output, it will come out on top of whatever | |
130 | you are currently writing. For this reason, background jobs are best |
|
130 | you are currently writing. For this reason, background jobs are best | |
131 | used with silent functions which simply return their output. |
|
131 | used with silent functions which simply return their output. | |
132 |
|
132 | |||
133 | 2. Threads also all work within the same global namespace, and this |
|
133 | 2. Threads also all work within the same global namespace, and this | |
134 | system does not lock interactive variables. So if you send job to the |
|
134 | system does not lock interactive variables. So if you send job to the | |
135 | background which operates on a mutable object for a long time, and |
|
135 | background which operates on a mutable object for a long time, and | |
136 | start modifying that same mutable object interactively (or in another |
|
136 | start modifying that same mutable object interactively (or in another | |
137 | backgrounded job), all sorts of bizarre behaviour will occur. |
|
137 | backgrounded job), all sorts of bizarre behaviour will occur. | |
138 |
|
138 | |||
139 | 3. If a background job is spending a lot of time inside a C extension |
|
139 | 3. If a background job is spending a lot of time inside a C extension | |
140 | module which does not release the Python Global Interpreter Lock |
|
140 | module which does not release the Python Global Interpreter Lock | |
141 | (GIL), this will block the IPython prompt. This is simply because the |
|
141 | (GIL), this will block the IPython prompt. This is simply because the | |
142 | Python interpreter can only switch between threads at Python |
|
142 | Python interpreter can only switch between threads at Python | |
143 | bytecodes. While the execution is inside C code, the interpreter must |
|
143 | bytecodes. While the execution is inside C code, the interpreter must | |
144 | simply wait unless the extension module releases the GIL. |
|
144 | simply wait unless the extension module releases the GIL. | |
145 |
|
145 | |||
146 | 4. There is no way, due to limitations in the Python threads library, |
|
146 | 4. There is no way, due to limitations in the Python threads library, | |
147 | to kill a thread once it has started.""" |
|
147 | to kill a thread once it has started.""" | |
148 |
|
148 | |||
149 | if callable(func_or_exp): |
|
149 | if callable(func_or_exp): | |
150 | kw = kwargs.get('kw',{}) |
|
150 | kw = kwargs.get('kw',{}) | |
151 | job = BackgroundJobFunc(func_or_exp,*args,**kw) |
|
151 | job = BackgroundJobFunc(func_or_exp,*args,**kw) | |
152 | elif isinstance(func_or_exp,basestring): |
|
152 | elif isinstance(func_or_exp,basestring): | |
153 | if not args: |
|
153 | if not args: | |
154 | frame = sys._getframe(1) |
|
154 | frame = sys._getframe(1) | |
155 | glob, loc = frame.f_globals, frame.f_locals |
|
155 | glob, loc = frame.f_globals, frame.f_locals | |
156 | elif len(args)==1: |
|
156 | elif len(args)==1: | |
157 | glob = loc = args[0] |
|
157 | glob = loc = args[0] | |
158 | elif len(args)==2: |
|
158 | elif len(args)==2: | |
159 | glob,loc = args |
|
159 | glob,loc = args | |
160 | else: |
|
160 | else: | |
161 | raise ValueError,\ |
|
161 | raise ValueError,\ | |
162 | 'Expression jobs take at most 2 args (globals,locals)' |
|
162 | 'Expression jobs take at most 2 args (globals,locals)' | |
163 | job = BackgroundJobExpr(func_or_exp,glob,loc) |
|
163 | job = BackgroundJobExpr(func_or_exp,glob,loc) | |
164 | else: |
|
164 | else: | |
165 | raise |
|
165 | raise | |
166 | jkeys = self.jobs_all.keys() |
|
166 | jkeys = self.jobs_all.keys() | |
167 | if jkeys: |
|
167 | if jkeys: | |
168 | job.num = max(jkeys)+1 |
|
168 | job.num = max(jkeys)+1 | |
169 | else: |
|
169 | else: | |
170 | job.num = 0 |
|
170 | job.num = 0 | |
171 | self.jobs_run.append(job) |
|
171 | self.jobs_run.append(job) | |
172 | self.jobs_all[job.num] = job |
|
172 | self.jobs_all[job.num] = job | |
173 | print 'Starting job # %s in a separate thread.' % job.num |
|
173 | print 'Starting job # %s in a separate thread.' % job.num | |
174 | job.start() |
|
174 | job.start() | |
175 | return job |
|
175 | return job | |
176 |
|
176 | |||
177 | def __getitem__(self,key): |
|
177 | def __getitem__(self,key): | |
178 | return self.jobs_all[key] |
|
178 | return self.jobs_all[key] | |
179 |
|
179 | |||
180 | def __call__(self): |
|
180 | def __call__(self): | |
181 | """An alias to self.status(), |
|
181 | """An alias to self.status(), | |
182 |
|
182 | |||
183 | This allows you to simply call a job manager instance much like the |
|
183 | This allows you to simply call a job manager instance much like the | |
184 | Unix jobs shell command.""" |
|
184 | Unix jobs shell command.""" | |
185 |
|
185 | |||
186 | return self.status() |
|
186 | return self.status() | |
187 |
|
187 | |||
188 | def _update_status(self): |
|
188 | def _update_status(self): | |
189 | """Update the status of the job lists. |
|
189 | """Update the status of the job lists. | |
190 |
|
190 | |||
191 | This method moves finished jobs to one of two lists: |
|
191 | This method moves finished jobs to one of two lists: | |
192 | - self.jobs_comp: jobs which completed successfully |
|
192 | - self.jobs_comp: jobs which completed successfully | |
193 | - self.jobs_dead: jobs which finished but died. |
|
193 | - self.jobs_dead: jobs which finished but died. | |
194 |
|
194 | |||
195 | It also copies those jobs to corresponding _report lists. These lists |
|
195 | It also copies those jobs to corresponding _report lists. These lists | |
196 | are used to report jobs completed/dead since the last update, and are |
|
196 | are used to report jobs completed/dead since the last update, and are | |
197 | then cleared by the reporting function after each call.""" |
|
197 | then cleared by the reporting function after each call.""" | |
198 |
|
198 | |||
199 | run,comp,dead = self._s_running,self._s_completed,self._s_dead |
|
199 | run,comp,dead = self._s_running,self._s_completed,self._s_dead | |
200 | jobs_run = self.jobs_run |
|
200 | jobs_run = self.jobs_run | |
201 | for num in range(len(jobs_run)): |
|
201 | for num in range(len(jobs_run)): | |
202 | job = jobs_run[num] |
|
202 | job = jobs_run[num] | |
203 | stat = job.stat_code |
|
203 | stat = job.stat_code | |
204 | if stat == run: |
|
204 | if stat == run: | |
205 | continue |
|
205 | continue | |
206 | elif stat == comp: |
|
206 | elif stat == comp: | |
207 | self.jobs_comp.append(job) |
|
207 | self.jobs_comp.append(job) | |
208 | self._comp_report.append(job) |
|
208 | self._comp_report.append(job) | |
209 | jobs_run[num] = False |
|
209 | jobs_run[num] = False | |
210 | elif stat == dead: |
|
210 | elif stat == dead: | |
211 | self.jobs_dead.append(job) |
|
211 | self.jobs_dead.append(job) | |
212 | self._dead_report.append(job) |
|
212 | self._dead_report.append(job) | |
213 | jobs_run[num] = False |
|
213 | jobs_run[num] = False | |
214 | self.jobs_run = filter(None,self.jobs_run) |
|
214 | self.jobs_run = filter(None,self.jobs_run) | |
215 |
|
215 | |||
216 | def _group_report(self,group,name): |
|
216 | def _group_report(self,group,name): | |
217 | """Report summary for a given job group. |
|
217 | """Report summary for a given job group. | |
218 |
|
218 | |||
219 | Return True if the group had any elements.""" |
|
219 | Return True if the group had any elements.""" | |
220 |
|
220 | |||
221 | if group: |
|
221 | if group: | |
222 | print '%s jobs:' % name |
|
222 | print '%s jobs:' % name | |
223 | for job in group: |
|
223 | for job in group: | |
224 | print '%s : %s' % (job.num,job) |
|
224 | print '%s : %s' % (job.num,job) | |
225 |
|
225 | |||
226 | return True |
|
226 | return True | |
227 |
|
227 | |||
228 | def _group_flush(self,group,name): |
|
228 | def _group_flush(self,group,name): | |
229 | """Flush a given job group |
|
229 | """Flush a given job group | |
230 |
|
230 | |||
231 | Return True if the group had any elements.""" |
|
231 | Return True if the group had any elements.""" | |
232 |
|
232 | |||
233 | njobs = len(group) |
|
233 | njobs = len(group) | |
234 | if njobs: |
|
234 | if njobs: | |
235 | plural = {1:''}.setdefault(njobs,'s') |
|
235 | plural = {1:''}.setdefault(njobs,'s') | |
236 | print 'Flushing %s %s job%s.' % (njobs,name,plural) |
|
236 | print 'Flushing %s %s job%s.' % (njobs,name,plural) | |
237 | group[:] = [] |
|
237 | group[:] = [] | |
238 | return True |
|
238 | return True | |
239 |
|
239 | |||
240 | def _status_new(self): |
|
240 | def _status_new(self): | |
241 | """Print the status of newly finished jobs. |
|
241 | """Print the status of newly finished jobs. | |
242 |
|
242 | |||
243 | Return True if any new jobs are reported. |
|
243 | Return True if any new jobs are reported. | |
244 |
|
244 | |||
245 | This call resets its own state every time, so it only reports jobs |
|
245 | This call resets its own state every time, so it only reports jobs | |
246 | which have finished since the last time it was called.""" |
|
246 | which have finished since the last time it was called.""" | |
247 |
|
247 | |||
248 | self._update_status() |
|
248 | self._update_status() | |
249 | new_comp = self._group_report(self._comp_report,'Completed') |
|
249 | new_comp = self._group_report(self._comp_report,'Completed') | |
250 | new_dead = self._group_report(self._dead_report, |
|
250 | new_dead = self._group_report(self._dead_report, | |
251 | 'Dead, call jobs.traceback() for details') |
|
251 | 'Dead, call jobs.traceback() for details') | |
252 | self._comp_report[:] = [] |
|
252 | self._comp_report[:] = [] | |
253 | self._dead_report[:] = [] |
|
253 | self._dead_report[:] = [] | |
254 | return new_comp or new_dead |
|
254 | return new_comp or new_dead | |
255 |
|
255 | |||
256 | def status(self,verbose=0): |
|
256 | def status(self,verbose=0): | |
257 | """Print a status of all jobs currently being managed.""" |
|
257 | """Print a status of all jobs currently being managed.""" | |
258 |
|
258 | |||
259 | self._update_status() |
|
259 | self._update_status() | |
260 | self._group_report(self.jobs_run,'Running') |
|
260 | self._group_report(self.jobs_run,'Running') | |
261 | self._group_report(self.jobs_comp,'Completed') |
|
261 | self._group_report(self.jobs_comp,'Completed') | |
262 | self._group_report(self.jobs_dead,'Dead') |
|
262 | self._group_report(self.jobs_dead,'Dead') | |
263 | # Also flush the report queues |
|
263 | # Also flush the report queues | |
264 | self._comp_report[:] = [] |
|
264 | self._comp_report[:] = [] | |
265 | self._dead_report[:] = [] |
|
265 | self._dead_report[:] = [] | |
266 |
|
266 | |||
267 | def remove(self,num): |
|
267 | def remove(self,num): | |
268 | """Remove a finished (completed or dead) job.""" |
|
268 | """Remove a finished (completed or dead) job.""" | |
269 |
|
269 | |||
270 | try: |
|
270 | try: | |
271 | job = self.jobs_all[num] |
|
271 | job = self.jobs_all[num] | |
272 | except KeyError: |
|
272 | except KeyError: | |
273 | error('Job #%s not found' % num) |
|
273 | error('Job #%s not found' % num) | |
274 | else: |
|
274 | else: | |
275 | stat_code = job.stat_code |
|
275 | stat_code = job.stat_code | |
276 | if stat_code == self._s_running: |
|
276 | if stat_code == self._s_running: | |
277 | error('Job #%s is still running, it can not be removed.' % num) |
|
277 | error('Job #%s is still running, it can not be removed.' % num) | |
278 | return |
|
278 | return | |
279 | elif stat_code == self._s_completed: |
|
279 | elif stat_code == self._s_completed: | |
280 | self.jobs_comp.remove(job) |
|
280 | self.jobs_comp.remove(job) | |
281 | elif stat_code == self._s_dead: |
|
281 | elif stat_code == self._s_dead: | |
282 | self.jobs_dead.remove(job) |
|
282 | self.jobs_dead.remove(job) | |
283 |
|
283 | |||
284 | def flush_finished(self): |
|
284 | def flush_finished(self): | |
285 | """Flush all jobs finished (completed and dead) from lists. |
|
285 | """Flush all jobs finished (completed and dead) from lists. | |
286 |
|
286 | |||
287 | Running jobs are never flushed. |
|
287 | Running jobs are never flushed. | |
288 |
|
288 | |||
289 | It first calls _status_new(), to update info. If any jobs have |
|
289 | It first calls _status_new(), to update info. If any jobs have | |
290 | completed since the last _status_new() call, the flush operation |
|
290 | completed since the last _status_new() call, the flush operation | |
291 | aborts.""" |
|
291 | aborts.""" | |
292 |
|
292 | |||
293 | if self._status_new(): |
|
293 | if self._status_new(): | |
294 | error('New jobs completed since last '\ |
|
294 | error('New jobs completed since last '\ | |
295 | '_status_new(), aborting flush.') |
|
295 | '_status_new(), aborting flush.') | |
296 | return |
|
296 | return | |
297 |
|
297 | |||
298 | # Remove the finished jobs from the master dict |
|
298 | # Remove the finished jobs from the master dict | |
299 | jobs_all = self.jobs_all |
|
299 | jobs_all = self.jobs_all | |
300 | for job in self.jobs_comp+self.jobs_dead: |
|
300 | for job in self.jobs_comp+self.jobs_dead: | |
301 | del(jobs_all[job.num]) |
|
301 | del(jobs_all[job.num]) | |
302 |
|
302 | |||
303 | # Now flush these lists completely |
|
303 | # Now flush these lists completely | |
304 | fl_comp = self._group_flush(self.jobs_comp,'Completed') |
|
304 | fl_comp = self._group_flush(self.jobs_comp,'Completed') | |
305 | fl_dead = self._group_flush(self.jobs_dead,'Dead') |
|
305 | fl_dead = self._group_flush(self.jobs_dead,'Dead') | |
306 | if not (fl_comp or fl_dead): |
|
306 | if not (fl_comp or fl_dead): | |
307 | print 'No jobs to flush.' |
|
307 | print 'No jobs to flush.' | |
308 |
|
308 | |||
309 | def result(self,num): |
|
309 | def result(self,num): | |
310 | """result(N) -> return the result of job N.""" |
|
310 | """result(N) -> return the result of job N.""" | |
311 | try: |
|
311 | try: | |
312 | return self.jobs_all[num].result |
|
312 | return self.jobs_all[num].result | |
313 | except KeyError: |
|
313 | except KeyError: | |
314 | error('Job #%s not found' % num) |
|
314 | error('Job #%s not found' % num) | |
315 |
|
315 | |||
316 | def traceback(self,num): |
|
316 | def traceback(self,num): | |
317 | try: |
|
317 | try: | |
318 | self.jobs_all[num].traceback() |
|
318 | self.jobs_all[num].traceback() | |
319 | except KeyError: |
|
319 | except KeyError: | |
320 | error('Job #%s not found' % num) |
|
320 | error('Job #%s not found' % num) | |
321 |
|
321 | |||
322 |
|
322 | |||
323 | class BackgroundJobBase(threading.Thread): |
|
323 | class BackgroundJobBase(threading.Thread): | |
324 | """Base class to build BackgroundJob classes. |
|
324 | """Base class to build BackgroundJob classes. | |
325 |
|
325 | |||
326 | The derived classes must implement: |
|
326 | The derived classes must implement: | |
327 |
|
327 | |||
328 | - Their own __init__, since the one here raises NotImplementedError. The |
|
328 | - Their own __init__, since the one here raises NotImplementedError. The | |
329 | derived constructor must call self._init() at the end, to provide common |
|
329 | derived constructor must call self._init() at the end, to provide common | |
330 | initialization. |
|
330 | initialization. | |
331 |
|
331 | |||
332 | - A strform attribute used in calls to __str__. |
|
332 | - A strform attribute used in calls to __str__. | |
333 |
|
333 | |||
334 | - A call() method, which will make the actual execution call and must |
|
334 | - A call() method, which will make the actual execution call and must | |
335 | return a value to be held in the 'result' field of the job object.""" |
|
335 | return a value to be held in the 'result' field of the job object.""" | |
336 |
|
336 | |||
337 | # Class constants for status, in string and as numerical codes (when |
|
337 | # Class constants for status, in string and as numerical codes (when | |
338 | # updating jobs lists, we don't want to do string comparisons). This will |
|
338 | # updating jobs lists, we don't want to do string comparisons). This will | |
339 | # be done at every user prompt, so it has to be as fast as possible |
|
339 | # be done at every user prompt, so it has to be as fast as possible | |
340 | stat_created = 'Created'; stat_created_c = 0 |
|
340 | stat_created = 'Created'; stat_created_c = 0 | |
341 | stat_running = 'Running'; stat_running_c = 1 |
|
341 | stat_running = 'Running'; stat_running_c = 1 | |
342 | stat_completed = 'Completed'; stat_completed_c = 2 |
|
342 | stat_completed = 'Completed'; stat_completed_c = 2 | |
343 | stat_dead = 'Dead (Exception), call jobs.traceback() for details' |
|
343 | stat_dead = 'Dead (Exception), call jobs.traceback() for details' | |
344 | stat_dead_c = -1 |
|
344 | stat_dead_c = -1 | |
345 |
|
345 | |||
346 | def __init__(self): |
|
346 | def __init__(self): | |
347 | raise NotImplementedError, \ |
|
347 | raise NotImplementedError, \ | |
348 | "This class can not be instantiated directly." |
|
348 | "This class can not be instantiated directly." | |
349 |
|
349 | |||
350 | def _init(self): |
|
350 | def _init(self): | |
351 | """Common initialization for all BackgroundJob objects""" |
|
351 | """Common initialization for all BackgroundJob objects""" | |
352 |
|
352 | |||
353 | for attr in ['call','strform']: |
|
353 | for attr in ['call','strform']: | |
354 | assert hasattr(self,attr), "Missing attribute <%s>" % attr |
|
354 | assert hasattr(self,attr), "Missing attribute <%s>" % attr | |
355 |
|
355 | |||
356 | # The num tag can be set by an external job manager |
|
356 | # The num tag can be set by an external job manager | |
357 | self.num = None |
|
357 | self.num = None | |
358 |
|
358 | |||
359 | self.status = BackgroundJobBase.stat_created |
|
359 | self.status = BackgroundJobBase.stat_created | |
360 | self.stat_code = BackgroundJobBase.stat_created_c |
|
360 | self.stat_code = BackgroundJobBase.stat_created_c | |
361 | self.finished = False |
|
361 | self.finished = False | |
362 | self.result = '<BackgroundJob has not completed>' |
|
362 | self.result = '<BackgroundJob has not completed>' | |
363 | # reuse the ipython traceback handler if we can get to it, otherwise |
|
363 | # reuse the ipython traceback handler if we can get to it, otherwise | |
364 | # make a new one |
|
364 | # make a new one | |
365 | try: |
|
365 | try: | |
366 | self._make_tb = __IPYTHON__.InteractiveTB.text |
|
366 | self._make_tb = __IPYTHON__.InteractiveTB.text | |
367 | except: |
|
367 | except: | |
368 | self._make_tb = AutoFormattedTB(mode = 'Context', |
|
368 | self._make_tb = AutoFormattedTB(mode = 'Context', | |
369 | color_scheme='NoColor', |
|
369 | color_scheme='NoColor', | |
370 | tb_offset = 1).text |
|
370 | tb_offset = 1).text | |
371 | # Hold a formatted traceback if one is generated. |
|
371 | # Hold a formatted traceback if one is generated. | |
372 | self._tb = None |
|
372 | self._tb = None | |
373 |
|
373 | |||
374 | threading.Thread.__init__(self) |
|
374 | threading.Thread.__init__(self) | |
375 |
|
375 | |||
376 | def __str__(self): |
|
376 | def __str__(self): | |
377 | return self.strform |
|
377 | return self.strform | |
378 |
|
378 | |||
379 | def __repr__(self): |
|
379 | def __repr__(self): | |
380 | return '<BackgroundJob: %s>' % self.strform |
|
380 | return '<BackgroundJob: %s>' % self.strform | |
381 |
|
381 | |||
382 | def traceback(self): |
|
382 | def traceback(self): | |
383 | print self._tb |
|
383 | print self._tb | |
384 |
|
384 | |||
385 | def run(self): |
|
385 | def run(self): | |
386 | try: |
|
386 | try: | |
387 | self.status = BackgroundJobBase.stat_running |
|
387 | self.status = BackgroundJobBase.stat_running | |
388 | self.stat_code = BackgroundJobBase.stat_running_c |
|
388 | self.stat_code = BackgroundJobBase.stat_running_c | |
389 | self.result = self.call() |
|
389 | self.result = self.call() | |
390 | except: |
|
390 | except: | |
391 | self.status = BackgroundJobBase.stat_dead |
|
391 | self.status = BackgroundJobBase.stat_dead | |
392 | self.stat_code = BackgroundJobBase.stat_dead_c |
|
392 | self.stat_code = BackgroundJobBase.stat_dead_c | |
393 | self.finished = None |
|
393 | self.finished = None | |
394 | self.result = ('<BackgroundJob died, call jobs.traceback() for details>') |
|
394 | self.result = ('<BackgroundJob died, call jobs.traceback() for details>') | |
395 | self._tb = self._make_tb() |
|
395 | self._tb = self._make_tb() | |
396 | else: |
|
396 | else: | |
397 | self.status = BackgroundJobBase.stat_completed |
|
397 | self.status = BackgroundJobBase.stat_completed | |
398 | self.stat_code = BackgroundJobBase.stat_completed_c |
|
398 | self.stat_code = BackgroundJobBase.stat_completed_c | |
399 | self.finished = True |
|
399 | self.finished = True | |
400 |
|
400 | |||
401 | class BackgroundJobExpr(BackgroundJobBase): |
|
401 | class BackgroundJobExpr(BackgroundJobBase): | |
402 | """Evaluate an expression as a background job (uses a separate thread).""" |
|
402 | """Evaluate an expression as a background job (uses a separate thread).""" | |
403 |
|
403 | |||
404 | def __init__(self,expression,glob=None,loc=None): |
|
404 | def __init__(self,expression,glob=None,loc=None): | |
405 | """Create a new job from a string which can be fed to eval(). |
|
405 | """Create a new job from a string which can be fed to eval(). | |
406 |
|
406 | |||
407 | global/locals dicts can be provided, which will be passed to the eval |
|
407 | global/locals dicts can be provided, which will be passed to the eval | |
408 | call.""" |
|
408 | call.""" | |
409 |
|
409 | |||
410 | # fail immediately if the given expression can't be compiled |
|
410 | # fail immediately if the given expression can't be compiled | |
411 | self.code = compile(expression,'<BackgroundJob compilation>','eval') |
|
411 | self.code = compile(expression,'<BackgroundJob compilation>','eval') | |
412 |
|
412 | |||
413 | if glob is None: |
|
413 | if glob is None: | |
414 | glob = {} |
|
414 | glob = {} | |
415 | if loc is None: |
|
415 | if loc is None: | |
416 | loc = {} |
|
416 | loc = {} | |
417 |
|
417 | |||
418 | self.expression = self.strform = expression |
|
418 | self.expression = self.strform = expression | |
419 | self.glob = glob |
|
419 | self.glob = glob | |
420 | self.loc = loc |
|
420 | self.loc = loc | |
421 | self._init() |
|
421 | self._init() | |
422 |
|
422 | |||
423 | def call(self): |
|
423 | def call(self): | |
424 | return eval(self.code,self.glob,self.loc) |
|
424 | return eval(self.code,self.glob,self.loc) | |
425 |
|
425 | |||
426 | class BackgroundJobFunc(BackgroundJobBase): |
|
426 | class BackgroundJobFunc(BackgroundJobBase): | |
427 | """Run a function call as a background job (uses a separate thread).""" |
|
427 | """Run a function call as a background job (uses a separate thread).""" | |
428 |
|
428 | |||
429 | def __init__(self,func,*args,**kwargs): |
|
429 | def __init__(self,func,*args,**kwargs): | |
430 | """Create a new job from a callable object. |
|
430 | """Create a new job from a callable object. | |
431 |
|
431 | |||
432 | Any positional arguments and keyword args given to this constructor |
|
432 | Any positional arguments and keyword args given to this constructor | |
433 | after the initial callable are passed directly to it.""" |
|
433 | after the initial callable are passed directly to it.""" | |
434 |
|
434 | |||
435 | assert callable(func),'first argument must be callable' |
|
435 | assert callable(func),'first argument must be callable' | |
436 |
|
436 | |||
437 | if args is None: |
|
437 | if args is None: | |
438 | args = [] |
|
438 | args = [] | |
439 | if kwargs is None: |
|
439 | if kwargs is None: | |
440 | kwargs = {} |
|
440 | kwargs = {} | |
441 |
|
441 | |||
442 | self.func = func |
|
442 | self.func = func | |
443 | self.args = args |
|
443 | self.args = args | |
444 | self.kwargs = kwargs |
|
444 | self.kwargs = kwargs | |
445 | # The string form will only include the function passed, because |
|
445 | # The string form will only include the function passed, because | |
446 | # generating string representations of the arguments is a potentially |
|
446 | # generating string representations of the arguments is a potentially | |
447 | # _very_ expensive operation (e.g. with large arrays). |
|
447 | # _very_ expensive operation (e.g. with large arrays). | |
448 | self.strform = str(func) |
|
448 | self.strform = str(func) | |
449 | self._init() |
|
449 | self._init() | |
450 |
|
450 | |||
451 | def call(self): |
|
451 | def call(self): | |
452 | return self.func(*self.args,**self.kwargs) |
|
452 | return self.func(*self.args,**self.kwargs) | |
453 |
|
453 | |||
454 |
|
454 | |||
455 | if __name__=='__main__': |
|
455 | if __name__=='__main__': | |
456 |
|
456 | |||
457 | import time |
|
457 | import time | |
458 |
|
458 | |||
459 | def sleepfunc(interval=2,*a,**kw): |
|
459 | def sleepfunc(interval=2,*a,**kw): | |
460 | args = dict(interval=interval, |
|
460 | args = dict(interval=interval, | |
461 | args=a, |
|
461 | args=a, | |
462 | kwargs=kw) |
|
462 | kwargs=kw) | |
463 | time.sleep(interval) |
|
463 | time.sleep(interval) | |
464 | return args |
|
464 | return args | |
465 |
|
465 | |||
466 | def diefunc(interval=2,*a,**kw): |
|
466 | def diefunc(interval=2,*a,**kw): | |
467 | time.sleep(interval) |
|
467 | time.sleep(interval) | |
468 | die |
|
468 | die | |
469 |
|
469 | |||
470 | def printfunc(interval=1,reps=5): |
|
470 | def printfunc(interval=1,reps=5): | |
471 | for n in range(reps): |
|
471 | for n in range(reps): | |
472 | time.sleep(interval) |
|
472 | time.sleep(interval) | |
473 | print 'In the background...' |
|
473 | print 'In the background...' | |
474 |
|
474 | |||
475 | jobs = BackgroundJobManager() |
|
475 | jobs = BackgroundJobManager() | |
476 | # first job will have # 0 |
|
476 | # first job will have # 0 | |
477 | jobs.new(sleepfunc,4) |
|
477 | jobs.new(sleepfunc,4) | |
478 | jobs.new(sleepfunc,kw={'reps':2}) |
|
478 | jobs.new(sleepfunc,kw={'reps':2}) | |
479 | # This makes a job which will die |
|
479 | # This makes a job which will die | |
480 | jobs.new(diefunc,1) |
|
480 | jobs.new(diefunc,1) | |
481 | jobs.new('printfunc(1,3)') |
|
481 | jobs.new('printfunc(1,3)') | |
482 |
|
482 | |||
483 | # after a while, you can get the traceback of a dead job. Run the line |
|
483 | # after a while, you can get the traceback of a dead job. Run the line | |
484 | # below again interactively until it prints a traceback (check the status |
|
484 | # below again interactively until it prints a traceback (check the status | |
485 | # of the job): |
|
485 | # of the job): | |
486 | print jobs[1].status |
|
486 | print jobs[1].status | |
487 | jobs[1].traceback() |
|
487 | jobs[1].traceback() | |
488 |
|
488 | |||
489 | # Run this line again until the printed result changes |
|
489 | # Run this line again until the printed result changes | |
490 | print "The result of job #0 is:",jobs[0].result |
|
490 | print "The result of job #0 is:",jobs[0].result |
@@ -1,300 +1,300 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """IPython Test Suite Runner. |
|
2 | """IPython Test Suite Runner. | |
3 |
|
3 | |||
4 | This module provides a main entry point to a user script to test IPython |
|
4 | This module provides a main entry point to a user script to test IPython | |
5 | itself from the command line. There are two ways of running this script: |
|
5 | itself from the command line. There are two ways of running this script: | |
6 |
|
6 | |||
7 | 1. With the syntax `iptest all`. This runs our entire test suite by |
|
7 | 1. With the syntax `iptest all`. This runs our entire test suite by | |
8 | calling this script (with different arguments) or trial recursively. This |
|
8 | calling this script (with different arguments) or trial recursively. This | |
9 | causes modules and package to be tested in different processes, using nose |
|
9 | causes modules and package to be tested in different processes, using nose | |
10 | or trial where appropriate. |
|
10 | or trial where appropriate. | |
11 | 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form |
|
11 | 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form | |
12 | the script simply calls nose, but with special command line flags and |
|
12 | the script simply calls nose, but with special command line flags and | |
13 | plugins loaded. |
|
13 | plugins loaded. | |
14 |
|
14 | |||
15 | For now, this script requires that both nose and twisted are installed. This |
|
15 | For now, this script requires that both nose and twisted are installed. This | |
16 | will change in the future. |
|
16 | will change in the future. | |
17 | """ |
|
17 | """ | |
18 |
|
18 | |||
19 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
20 | # Module imports |
|
20 | # Module imports | |
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 |
|
22 | |||
23 | import os |
|
23 | import os | |
24 | import os.path as path |
|
24 | import os.path as path | |
25 | import sys |
|
25 | import sys | |
26 | import subprocess |
|
26 | import subprocess | |
27 | import time |
|
27 | import time | |
28 | import warnings |
|
28 | import warnings | |
29 |
|
29 | |||
30 | import nose.plugins.builtin |
|
30 | import nose.plugins.builtin | |
31 | from nose.core import TestProgram |
|
31 | from nose.core import TestProgram | |
32 |
|
32 | |||
33 | from IPython.utils.platutils import find_cmd |
|
33 | from IPython.utils.platutils import find_cmd | |
34 | from IPython.testing.plugin.ipdoctest import IPythonDoctest |
|
34 | from IPython.testing.plugin.ipdoctest import IPythonDoctest | |
35 |
|
35 | |||
36 | pjoin = path.join |
|
36 | pjoin = path.join | |
37 |
|
37 | |||
38 | #----------------------------------------------------------------------------- |
|
38 | #----------------------------------------------------------------------------- | |
39 | # Logic for skipping doctests |
|
39 | # Logic for skipping doctests | |
40 | #----------------------------------------------------------------------------- |
|
40 | #----------------------------------------------------------------------------- | |
41 |
|
41 | |||
42 | def test_for(mod): |
|
42 | def test_for(mod): | |
43 | """Test to see if mod is importable.""" |
|
43 | """Test to see if mod is importable.""" | |
44 | try: |
|
44 | try: | |
45 | __import__(mod) |
|
45 | __import__(mod) | |
46 | except ImportError: |
|
46 | except ImportError: | |
47 | return False |
|
47 | return False | |
48 | else: |
|
48 | else: | |
49 | return True |
|
49 | return True | |
50 |
|
50 | |||
51 | have_curses = test_for('_curses') |
|
51 | have_curses = test_for('_curses') | |
52 | have_wx = test_for('wx') |
|
52 | have_wx = test_for('wx') | |
53 | have_zi = test_for('zope.interface') |
|
53 | have_zi = test_for('zope.interface') | |
54 | have_twisted = test_for('twisted') |
|
54 | have_twisted = test_for('twisted') | |
55 | have_foolscap = test_for('foolscap') |
|
55 | have_foolscap = test_for('foolscap') | |
56 | have_objc = test_for('objc') |
|
56 | have_objc = test_for('objc') | |
57 | have_pexpect = test_for('pexpect') |
|
57 | have_pexpect = test_for('pexpect') | |
58 |
|
58 | |||
59 | # For the IPythonDoctest plugin, we need to exclude certain patterns that cause |
|
59 | # For the IPythonDoctest plugin, we need to exclude certain patterns that cause | |
60 | # testing problems. We should strive to minimize the number of skipped |
|
60 | # testing problems. We should strive to minimize the number of skipped | |
61 | # modules, since this means untested code. As the testing machinery |
|
61 | # modules, since this means untested code. As the testing machinery | |
62 | # solidifies, this list should eventually become empty. |
|
62 | # solidifies, this list should eventually become empty. | |
63 | EXCLUDE = [pjoin('IPython', 'external'), |
|
63 | EXCLUDE = [pjoin('IPython', 'external'), | |
64 | pjoin('IPython', 'frontend', 'process', 'winprocess.py'), |
|
64 | pjoin('IPython', 'frontend', 'process', 'winprocess.py'), | |
65 | pjoin('IPython_doctest_plugin'), |
|
65 | pjoin('IPython_doctest_plugin'), | |
66 | pjoin('IPython', 'Gnuplot'), |
|
66 | pjoin('IPython', 'Gnuplot'), | |
67 | pjoin('IPython', 'Extensions', 'ipy_'), |
|
67 | pjoin('IPython', 'Extensions', 'ipy_'), | |
68 | pjoin('IPython', 'Extensions', 'clearcmd'), |
|
68 | pjoin('IPython', 'Extensions', 'clearcmd'), | |
69 | pjoin('IPython', 'Extensions', 'PhysicalQInteractive'), |
|
69 | pjoin('IPython', 'Extensions', 'PhysicalQInteractive'), | |
70 | pjoin('IPython', 'Extensions', 'scitedirector'), |
|
70 | pjoin('IPython', 'Extensions', 'scitedirector'), | |
71 | pjoin('IPython', 'Extensions', 'numeric_formats'), |
|
71 | pjoin('IPython', 'Extensions', 'numeric_formats'), | |
72 | pjoin('IPython', 'testing', 'attic'), |
|
72 | pjoin('IPython', 'testing', 'attic'), | |
73 | pjoin('IPython', 'testing', 'tutils'), |
|
73 | pjoin('IPython', 'testing', 'tutils'), | |
74 | pjoin('IPython', 'testing', 'tools'), |
|
74 | pjoin('IPython', 'testing', 'tools'), | |
75 | pjoin('IPython', 'testing', 'mkdoctests') |
|
75 | pjoin('IPython', 'testing', 'mkdoctests') | |
76 | ] |
|
76 | ] | |
77 |
|
77 | |||
78 | if not have_wx: |
|
78 | if not have_wx: | |
79 | EXCLUDE.append(pjoin('IPython', 'Extensions', 'igrid')) |
|
79 | EXCLUDE.append(pjoin('IPython', 'Extensions', 'igrid')) | |
80 | EXCLUDE.append(pjoin('IPython', 'gui')) |
|
80 | EXCLUDE.append(pjoin('IPython', 'gui')) | |
81 | EXCLUDE.append(pjoin('IPython', 'frontend', 'wx')) |
|
81 | EXCLUDE.append(pjoin('IPython', 'frontend', 'wx')) | |
82 |
|
82 | |||
83 | if not have_objc: |
|
83 | if not have_objc: | |
84 | EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa')) |
|
84 | EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa')) | |
85 |
|
85 | |||
86 | if not have_curses: |
|
86 | if not have_curses: | |
87 | EXCLUDE.append(pjoin('IPython', 'Extensions', 'ibrowse')) |
|
87 | EXCLUDE.append(pjoin('IPython', 'Extensions', 'ibrowse')) | |
88 |
|
88 | |||
89 | if not sys.platform == 'win32': |
|
89 | if not sys.platform == 'win32': | |
90 | EXCLUDE.append(pjoin('IPython', 'platutils_win32')) |
|
90 | EXCLUDE.append(pjoin('IPython', 'platutils_win32')) | |
91 |
|
91 | |||
92 | # These have to be skipped on win32 because the use echo, rm, cd, etc. |
|
92 | # These have to be skipped on win32 because the use echo, rm, cd, etc. | |
93 | # See ticket https://bugs.launchpad.net/bugs/366982 |
|
93 | # See ticket https://bugs.launchpad.net/bugs/366982 | |
94 | if sys.platform == 'win32': |
|
94 | if sys.platform == 'win32': | |
95 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip')) |
|
95 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip')) | |
96 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample')) |
|
96 | EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample')) | |
97 |
|
97 | |||
98 | if not os.name == 'posix': |
|
98 | if not os.name == 'posix': | |
99 | EXCLUDE.append(pjoin('IPython', 'platutils_posix')) |
|
99 | EXCLUDE.append(pjoin('IPython', 'platutils_posix')) | |
100 |
|
100 | |||
101 | if not have_pexpect: |
|
101 | if not have_pexpect: | |
102 | EXCLUDE.append(pjoin('IPython', 'lib', 'irunner')) |
|
102 | EXCLUDE.append(pjoin('IPython', 'lib', 'irunner')) | |
103 |
|
103 | |||
104 | # This is needed for the reg-exp to match on win32 in the ipdoctest plugin. |
|
104 | # This is needed for the reg-exp to match on win32 in the ipdoctest plugin. | |
105 | if sys.platform == 'win32': |
|
105 | if sys.platform == 'win32': | |
106 | EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE] |
|
106 | EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE] | |
107 |
|
107 | |||
108 |
|
108 | |||
109 | #----------------------------------------------------------------------------- |
|
109 | #----------------------------------------------------------------------------- | |
110 | # Functions and classes |
|
110 | # Functions and classes | |
111 | #----------------------------------------------------------------------------- |
|
111 | #----------------------------------------------------------------------------- | |
112 |
|
112 | |||
113 | def run_iptest(): |
|
113 | def run_iptest(): | |
114 | """Run the IPython test suite using nose. |
|
114 | """Run the IPython test suite using nose. | |
115 |
|
115 | |||
116 | This function is called when this script is **not** called with the form |
|
116 | This function is called when this script is **not** called with the form | |
117 | `iptest all`. It simply calls nose with appropriate command line flags |
|
117 | `iptest all`. It simply calls nose with appropriate command line flags | |
118 | and accepts all of the standard nose arguments. |
|
118 | and accepts all of the standard nose arguments. | |
119 | """ |
|
119 | """ | |
120 |
|
120 | |||
121 | warnings.filterwarnings('ignore', |
|
121 | warnings.filterwarnings('ignore', | |
122 | 'This will be removed soon. Use IPython.testing.util instead') |
|
122 | 'This will be removed soon. Use IPython.testing.util instead') | |
123 |
|
123 | |||
124 | argv = sys.argv + [ |
|
124 | argv = sys.argv + [ | |
125 | # Loading ipdoctest causes problems with Twisted. |
|
125 | # Loading ipdoctest causes problems with Twisted. | |
126 | # I am removing this as a temporary fix to get the |
|
126 | # I am removing this as a temporary fix to get the | |
127 | # test suite back into working shape. Our nose |
|
127 | # test suite back into working shape. Our nose | |
128 | # plugin needs to be gone through with a fine |
|
128 | # plugin needs to be gone through with a fine | |
129 | # toothed comb to find what is causing the problem. |
|
129 | # toothed comb to find what is causing the problem. | |
130 | '--with-ipdoctest', |
|
130 | '--with-ipdoctest', | |
131 | '--ipdoctest-tests','--ipdoctest-extension=txt', |
|
131 | '--ipdoctest-tests','--ipdoctest-extension=txt', | |
132 | '--detailed-errors', |
|
132 | '--detailed-errors', | |
133 |
|
133 | |||
134 | # We add --exe because of setuptools' imbecility (it |
|
134 | # We add --exe because of setuptools' imbecility (it | |
135 | # blindly does chmod +x on ALL files). Nose does the |
|
135 | # blindly does chmod +x on ALL files). Nose does the | |
136 | # right thing and it tries to avoid executables, |
|
136 | # right thing and it tries to avoid executables, | |
137 | # setuptools unfortunately forces our hand here. This |
|
137 | # setuptools unfortunately forces our hand here. This | |
138 | # has been discussed on the distutils list and the |
|
138 | # has been discussed on the distutils list and the | |
139 | # setuptools devs refuse to fix this problem! |
|
139 | # setuptools devs refuse to fix this problem! | |
140 | '--exe', |
|
140 | '--exe', | |
141 | ] |
|
141 | ] | |
142 |
|
142 | |||
143 | # Detect if any tests were required by explicitly calling an IPython |
|
143 | # Detect if any tests were required by explicitly calling an IPython | |
144 | # submodule or giving a specific path |
|
144 | # submodule or giving a specific path | |
145 | has_tests = False |
|
145 | has_tests = False | |
146 | for arg in sys.argv: |
|
146 | for arg in sys.argv: | |
147 | if 'IPython' in arg or arg.endswith('.py') or \ |
|
147 | if 'IPython' in arg or arg.endswith('.py') or \ | |
148 | (':' in arg and '.py' in arg): |
|
148 | (':' in arg and '.py' in arg): | |
149 | has_tests = True |
|
149 | has_tests = True | |
150 | break |
|
150 | break | |
151 |
|
151 | |||
152 | # If nothing was specifically requested, test full IPython |
|
152 | # If nothing was specifically requested, test full IPython | |
153 | if not has_tests: |
|
153 | if not has_tests: | |
154 | argv.append('IPython') |
|
154 | argv.append('IPython') | |
155 |
|
155 | |||
156 | # Construct list of plugins, omitting the existing doctest plugin, which |
|
156 | # Construct list of plugins, omitting the existing doctest plugin, which | |
157 | # ours replaces (and extends). |
|
157 | # ours replaces (and extends). | |
158 | plugins = [IPythonDoctest(EXCLUDE)] |
|
158 | plugins = [IPythonDoctest(EXCLUDE)] | |
159 | for p in nose.plugins.builtin.plugins: |
|
159 | for p in nose.plugins.builtin.plugins: | |
160 | plug = p() |
|
160 | plug = p() | |
161 | if plug.name == 'doctest': |
|
161 | if plug.name == 'doctest': | |
162 | continue |
|
162 | continue | |
163 |
|
163 | |||
164 | #print '*** adding plugin:',plug.name # dbg |
|
164 | #print '*** adding plugin:',plug.name # dbg | |
165 | plugins.append(plug) |
|
165 | plugins.append(plug) | |
166 |
|
166 | |||
167 | TestProgram(argv=argv,plugins=plugins) |
|
167 | TestProgram(argv=argv,plugins=plugins) | |
168 |
|
168 | |||
169 |
|
169 | |||
170 | class IPTester(object): |
|
170 | class IPTester(object): | |
171 | """Call that calls iptest or trial in a subprocess. |
|
171 | """Call that calls iptest or trial in a subprocess. | |
172 | """ |
|
172 | """ | |
173 | def __init__(self,runner='iptest',params=None): |
|
173 | def __init__(self,runner='iptest',params=None): | |
174 | """ """ |
|
174 | """ """ | |
175 | if runner == 'iptest': |
|
175 | if runner == 'iptest': | |
176 | self.runner = ['iptest','-v'] |
|
176 | self.runner = ['iptest','-v'] | |
177 | else: |
|
177 | else: | |
178 | self.runner = [find_cmd('trial')] |
|
178 | self.runner = [find_cmd('trial')] | |
179 | if params is None: |
|
179 | if params is None: | |
180 | params = [] |
|
180 | params = [] | |
181 | if isinstance(params,str): |
|
181 | if isinstance(params,str): | |
182 | params = [params] |
|
182 | params = [params] | |
183 | self.params = params |
|
183 | self.params = params | |
184 |
|
184 | |||
185 | # Assemble call |
|
185 | # Assemble call | |
186 | self.call_args = self.runner+self.params |
|
186 | self.call_args = self.runner+self.params | |
187 |
|
187 | |||
188 | def run(self): |
|
188 | def run(self): | |
189 | """Run the stored commands""" |
|
189 | """Run the stored commands""" | |
190 | return subprocess.call(self.call_args) |
|
190 | return subprocess.call(self.call_args) | |
191 |
|
191 | |||
192 |
|
192 | |||
193 | def make_runners(): |
|
193 | def make_runners(): | |
194 | """Define the modules and packages that need to be tested. |
|
194 | """Define the modules and packages that need to be tested. | |
195 | """ |
|
195 | """ | |
196 |
|
196 | |||
197 | # This omits additional top-level modules that should not be doctested. |
|
197 | # This omits additional top-level modules that should not be doctested. | |
198 | # XXX: shell.py is also ommited because of a bug in the skip_doctest |
|
198 | # XXX: shell.py is also ommited because of a bug in the skip_doctest | |
199 | # decorator. See ticket https://bugs.launchpad.net/bugs/366209 |
|
199 | # decorator. See ticket https://bugs.launchpad.net/bugs/366209 | |
200 | top_mod = \ |
|
200 | top_mod = \ | |
201 | ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py', |
|
201 | ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py', | |
202 | 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py', |
|
202 | 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py', | |
203 | 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py', |
|
203 | 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py', | |
204 | 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py', |
|
204 | 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py', | |
205 | 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py', |
|
205 | 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py', | |
206 | 'logger.py', 'macro.py', 'magic.py', 'oinspect.py', |
|
206 | 'logger.py', 'macro.py', 'magic.py', 'oinspect.py', | |
207 | 'outputtrap.py', 'platutils.py', 'prefilter.py', 'prompts.py', |
|
207 | 'outputtrap.py', 'platutils.py', 'prefilter.py', 'prompts.py', | |
208 | 'PyColorize.py', 'release.py', 'rlineimpl.py', 'shadowns.py', |
|
208 | 'PyColorize.py', 'release.py', 'rlineimpl.py', 'shadowns.py', | |
209 | 'shellglobals.py', 'strdispatch.py', 'twshell.py', |
|
209 | 'shellglobals.py', 'strdispatch.py', 'twshell.py', | |
210 |
'ultra |
|
210 | 'ultratb.py', 'upgrade_dir.py', 'usage.py', 'wildcard.py', | |
211 | # See note above for why this is skipped |
|
211 | # See note above for why this is skipped | |
212 | # 'shell.py', |
|
212 | # 'shell.py', | |
213 | 'winconsole.py'] |
|
213 | 'winconsole.py'] | |
214 |
|
214 | |||
215 | if have_pexpect: |
|
215 | if have_pexpect: | |
216 | top_mod.append('irunner.py') |
|
216 | top_mod.append('irunner.py') | |
217 |
|
217 | |||
218 | if sys.platform == 'win32': |
|
218 | if sys.platform == 'win32': | |
219 | top_mod.append('platutils_win32.py') |
|
219 | top_mod.append('platutils_win32.py') | |
220 | elif os.name == 'posix': |
|
220 | elif os.name == 'posix': | |
221 | top_mod.append('platutils_posix.py') |
|
221 | top_mod.append('platutils_posix.py') | |
222 | else: |
|
222 | else: | |
223 | top_mod.append('platutils_dummy.py') |
|
223 | top_mod.append('platutils_dummy.py') | |
224 |
|
224 | |||
225 | # These are tested by nose, so skip IPython.kernel |
|
225 | # These are tested by nose, so skip IPython.kernel | |
226 | top_pack = ['config','Extensions','frontend', |
|
226 | top_pack = ['config','Extensions','frontend', | |
227 | 'testing','tests','tools','UserConfig'] |
|
227 | 'testing','tests','tools','UserConfig'] | |
228 |
|
228 | |||
229 | if have_wx: |
|
229 | if have_wx: | |
230 | top_pack.append('gui') |
|
230 | top_pack.append('gui') | |
231 |
|
231 | |||
232 | modules = ['IPython.%s' % m[:-3] for m in top_mod ] |
|
232 | modules = ['IPython.%s' % m[:-3] for m in top_mod ] | |
233 | packages = ['IPython.%s' % m for m in top_pack ] |
|
233 | packages = ['IPython.%s' % m for m in top_pack ] | |
234 |
|
234 | |||
235 | # Make runners |
|
235 | # Make runners | |
236 | runners = dict(zip(top_pack, [IPTester(params=v) for v in packages])) |
|
236 | runners = dict(zip(top_pack, [IPTester(params=v) for v in packages])) | |
237 |
|
237 | |||
238 | # Test IPython.kernel using trial if twisted is installed |
|
238 | # Test IPython.kernel using trial if twisted is installed | |
239 | if have_zi and have_twisted and have_foolscap: |
|
239 | if have_zi and have_twisted and have_foolscap: | |
240 | runners['trial'] = IPTester('trial',['IPython']) |
|
240 | runners['trial'] = IPTester('trial',['IPython']) | |
241 |
|
241 | |||
242 | runners['modules'] = IPTester(params=modules) |
|
242 | runners['modules'] = IPTester(params=modules) | |
243 |
|
243 | |||
244 | return runners |
|
244 | return runners | |
245 |
|
245 | |||
246 |
|
246 | |||
247 | def run_iptestall(): |
|
247 | def run_iptestall(): | |
248 | """Run the entire IPython test suite by calling nose and trial. |
|
248 | """Run the entire IPython test suite by calling nose and trial. | |
249 |
|
249 | |||
250 | This function constructs :class:`IPTester` instances for all IPython |
|
250 | This function constructs :class:`IPTester` instances for all IPython | |
251 | modules and package and then runs each of them. This causes the modules |
|
251 | modules and package and then runs each of them. This causes the modules | |
252 | and packages of IPython to be tested each in their own subprocess using |
|
252 | and packages of IPython to be tested each in their own subprocess using | |
253 | nose or twisted.trial appropriately. |
|
253 | nose or twisted.trial appropriately. | |
254 | """ |
|
254 | """ | |
255 | runners = make_runners() |
|
255 | runners = make_runners() | |
256 | # Run all test runners, tracking execution time |
|
256 | # Run all test runners, tracking execution time | |
257 | failed = {} |
|
257 | failed = {} | |
258 | t_start = time.time() |
|
258 | t_start = time.time() | |
259 | for name,runner in runners.iteritems(): |
|
259 | for name,runner in runners.iteritems(): | |
260 | print '*'*77 |
|
260 | print '*'*77 | |
261 | print 'IPython test set:',name |
|
261 | print 'IPython test set:',name | |
262 | res = runner.run() |
|
262 | res = runner.run() | |
263 | if res: |
|
263 | if res: | |
264 | failed[name] = res |
|
264 | failed[name] = res | |
265 | t_end = time.time() |
|
265 | t_end = time.time() | |
266 | t_tests = t_end - t_start |
|
266 | t_tests = t_end - t_start | |
267 | nrunners = len(runners) |
|
267 | nrunners = len(runners) | |
268 | nfail = len(failed) |
|
268 | nfail = len(failed) | |
269 | # summarize results |
|
269 | # summarize results | |
270 |
|
270 | |||
271 | print '*'*77 |
|
271 | print '*'*77 | |
272 | print 'Ran %s test sets in %.3fs' % (nrunners, t_tests) |
|
272 | print 'Ran %s test sets in %.3fs' % (nrunners, t_tests) | |
273 |
|
273 | |||
274 | if not failed: |
|
274 | if not failed: | |
275 | print 'OK' |
|
275 | print 'OK' | |
276 | else: |
|
276 | else: | |
277 | # If anything went wrong, point out what command to rerun manually to |
|
277 | # If anything went wrong, point out what command to rerun manually to | |
278 | # see the actual errors and individual summary |
|
278 | # see the actual errors and individual summary | |
279 | print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners) |
|
279 | print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners) | |
280 | for name in failed: |
|
280 | for name in failed: | |
281 | failed_runner = runners[name] |
|
281 | failed_runner = runners[name] | |
282 | print '-'*40 |
|
282 | print '-'*40 | |
283 | print 'Runner failed:',name |
|
283 | print 'Runner failed:',name | |
284 | print 'You may wish to rerun this one individually, with:' |
|
284 | print 'You may wish to rerun this one individually, with:' | |
285 | print ' '.join(failed_runner.call_args) |
|
285 | print ' '.join(failed_runner.call_args) | |
286 |
|
286 | |||
287 |
|
287 | |||
288 |
|
288 | |||
289 | def main(): |
|
289 | def main(): | |
290 | if len(sys.argv) == 1: |
|
290 | if len(sys.argv) == 1: | |
291 | run_iptestall() |
|
291 | run_iptestall() | |
292 | else: |
|
292 | else: | |
293 | if sys.argv[1] == 'all': |
|
293 | if sys.argv[1] == 'all': | |
294 | run_iptestall() |
|
294 | run_iptestall() | |
295 | else: |
|
295 | else: | |
296 | run_iptest() |
|
296 | run_iptest() | |
297 |
|
297 | |||
298 |
|
298 | |||
299 | if __name__ == '__main__': |
|
299 | if __name__ == '__main__': | |
300 | main() No newline at end of file |
|
300 | main() |
@@ -1,74 +1,74 b'' | |||||
1 | # Set this prefix to where you want to install the plugin |
|
1 | # Set this prefix to where you want to install the plugin | |
2 | PREFIX=/usr/local |
|
2 | PREFIX=/usr/local | |
3 |
|
3 | |||
4 | NOSE0=nosetests -vs --with-doctest --doctest-tests --detailed-errors |
|
4 | NOSE0=nosetests -vs --with-doctest --doctest-tests --detailed-errors | |
5 | NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt \ |
|
5 | NOSE=nosetests -vvs --with-ipdoctest --doctest-tests --doctest-extension=txt \ | |
6 | --detailed-errors |
|
6 | --detailed-errors | |
7 |
|
7 | |||
8 | SRC=ipdoctest.py setup.py ../decorators.py |
|
8 | SRC=ipdoctest.py setup.py ../decorators.py | |
9 |
|
9 | |||
10 | # Default target for clean 'make' |
|
10 | # Default target for clean 'make' | |
11 | default: iplib |
|
11 | default: iplib | |
12 |
|
12 | |||
13 | # The actual plugin installation |
|
13 | # The actual plugin installation | |
14 | plugin: IPython_doctest_plugin.egg-info |
|
14 | plugin: IPython_doctest_plugin.egg-info | |
15 |
|
15 | |||
16 | # Simple targets that test one thing |
|
16 | # Simple targets that test one thing | |
17 | simple: plugin simple.py |
|
17 | simple: plugin simple.py | |
18 | $(NOSE) simple.py |
|
18 | $(NOSE) simple.py | |
19 |
|
19 | |||
20 | dtest: plugin dtexample.py |
|
20 | dtest: plugin dtexample.py | |
21 | $(NOSE) dtexample.py |
|
21 | $(NOSE) dtexample.py | |
22 |
|
22 | |||
23 | rtest: plugin test_refs.py |
|
23 | rtest: plugin test_refs.py | |
24 | $(NOSE) test_refs.py |
|
24 | $(NOSE) test_refs.py | |
25 |
|
25 | |||
26 | test: plugin dtexample.py |
|
26 | test: plugin dtexample.py | |
27 | $(NOSE) dtexample.py test*.py test*.txt |
|
27 | $(NOSE) dtexample.py test*.py test*.txt | |
28 |
|
28 | |||
29 | deb: plugin dtexample.py |
|
29 | deb: plugin dtexample.py | |
30 | $(NOSE) test_combo.txt |
|
30 | $(NOSE) test_combo.txt | |
31 |
|
31 | |||
32 | # IPython tests |
|
32 | # IPython tests | |
33 | deco: |
|
33 | deco: | |
34 | $(NOSE0) IPython.testing.decorators |
|
34 | $(NOSE0) IPython.testing.decorators | |
35 |
|
35 | |||
36 | magic: plugin |
|
36 | magic: plugin | |
37 | $(NOSE) IPython.core.magic |
|
37 | $(NOSE) IPython.core.magic | |
38 |
|
38 | |||
39 | excolors: plugin |
|
39 | excolors: plugin | |
40 | $(NOSE) IPython.core.excolors |
|
40 | $(NOSE) IPython.core.excolors | |
41 |
|
41 | |||
42 | iplib: plugin |
|
42 | iplib: plugin | |
43 | $(NOSE) IPython.core.iplib |
|
43 | $(NOSE) IPython.core.iplib | |
44 |
|
44 | |||
45 | strd: plugin |
|
45 | strd: plugin | |
46 | $(NOSE) IPython.strdispatch |
|
46 | $(NOSE) IPython.core.strdispatch | |
47 |
|
47 | |||
48 | engine: plugin |
|
48 | engine: plugin | |
49 | $(NOSE) IPython.kernel |
|
49 | $(NOSE) IPython.kernel | |
50 |
|
50 | |||
51 | tf: plugin |
|
51 | tf: plugin | |
52 | $(NOSE) IPython.config.traitlets |
|
52 | $(NOSE) IPython.config.traitlets | |
53 |
|
53 | |||
54 | # All of ipython itself |
|
54 | # All of ipython itself | |
55 | ipython: plugin |
|
55 | ipython: plugin | |
56 | $(NOSE) IPython |
|
56 | $(NOSE) IPython | |
57 |
|
57 | |||
58 |
|
58 | |||
59 | # Combined targets |
|
59 | # Combined targets | |
60 | sr: rtest strd |
|
60 | sr: rtest strd | |
61 |
|
61 | |||
62 | base: dtest rtest test strd deco |
|
62 | base: dtest rtest test strd deco | |
63 |
|
63 | |||
64 | quick: base iplib ipipe |
|
64 | quick: base iplib ipipe | |
65 |
|
65 | |||
66 | all: base ipython |
|
66 | all: base ipython | |
67 |
|
67 | |||
68 | # Main plugin and cleanup |
|
68 | # Main plugin and cleanup | |
69 | IPython_doctest_plugin.egg-info: $(SRC) |
|
69 | IPython_doctest_plugin.egg-info: $(SRC) | |
70 | python setup.py install --prefix=$(PREFIX) |
|
70 | python setup.py install --prefix=$(PREFIX) | |
71 | touch $@ |
|
71 | touch $@ | |
72 |
|
72 | |||
73 | clean: |
|
73 | clean: | |
74 | rm -rf IPython_doctest_plugin.egg-info *~ *pyc build/ dist/ |
|
74 | rm -rf IPython_doctest_plugin.egg-info *~ *pyc build/ dist/ |
1 | NO CONTENT: file renamed from IPython/strdispatch.py to IPython/utils/strdispatch.py |
|
NO CONTENT: file renamed from IPython/strdispatch.py to IPython/utils/strdispatch.py |
@@ -1,26 +1,29 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 |
|
3 | |||
4 | def test_import_coloransi(): |
|
4 | def test_import_coloransi(): | |
5 | from IPython.utils import coloransi |
|
5 | from IPython.utils import coloransi | |
6 |
|
6 | |||
7 | def test_import_DPyGetOpt(): |
|
7 | def test_import_DPyGetOpt(): | |
8 | from IPython.utils import DPyGetOpt |
|
8 | from IPython.utils import DPyGetOpt | |
9 |
|
9 | |||
10 | def test_import_generics(): |
|
10 | def test_import_generics(): | |
11 | from IPython.utils import generics |
|
11 | from IPython.utils import generics | |
12 |
|
12 | |||
13 | def test_import_genutils(): |
|
13 | def test_import_genutils(): | |
14 | from IPython.utils import genutils |
|
14 | from IPython.utils import genutils | |
15 |
|
15 | |||
16 | def test_import_ipstruct(): |
|
16 | def test_import_ipstruct(): | |
17 | from IPython.utils import ipstruct |
|
17 | from IPython.utils import ipstruct | |
18 |
|
18 | |||
19 | def test_import_platutils(): |
|
19 | def test_import_platutils(): | |
20 | from IPython.utils import platutils |
|
20 | from IPython.utils import platutils | |
21 |
|
21 | |||
22 | def test_import_PyColorize(): |
|
22 | def test_import_PyColorize(): | |
23 | from IPython.utils import PyColorize |
|
23 | from IPython.utils import PyColorize | |
24 |
|
24 | |||
25 | def test_import_rlineimpl(): |
|
25 | def test_import_rlineimpl(): | |
26 | from IPython.utils import rlineimpl |
|
26 | from IPython.utils import rlineimpl | |
|
27 | ||||
|
28 | def test_import_strdispatch(): | |||
|
29 | from IPython.utils import strdispatch No newline at end of file |
@@ -1,255 +1,270 b'' | |||||
1 | ============================= |
|
1 | ============================= | |
2 | IPython module reorganization |
|
2 | IPython module reorganization | |
3 | ============================= |
|
3 | ============================= | |
4 |
|
4 | |||
5 | Currently, IPython has many top-level modules that serve many different purposes. |
|
5 | Currently, IPython has many top-level modules that serve many different purposes. | |
6 | The lack of organization make it very difficult for developers to work on IPython |
|
6 | The lack of organization make it very difficult for developers to work on IPython | |
7 | and understand its design. This document contains notes about how we will reorganize |
|
7 | and understand its design. This document contains notes about how we will reorganize | |
8 | the modules into sub-packages. |
|
8 | the modules into sub-packages. | |
9 |
|
9 | |||
10 | .. warning:: |
|
10 | .. warning:: | |
11 |
|
11 | |||
12 | This effort will possibly break third party packages that use IPython as |
|
12 | This effort will possibly break third party packages that use IPython as | |
13 | a library or hack on the IPython internals. |
|
13 | a library or hack on the IPython internals. | |
14 |
|
14 | |||
15 | .. warning:: |
|
15 | .. warning:: | |
16 |
|
16 | |||
17 | This effort will result in the removal from IPython of certain modules |
|
17 | This effort will result in the removal from IPython of certain modules | |
18 | that are not used anymore, don't currently work, are unmaintained, etc. |
|
18 | that are not used anymore, don't currently work, are unmaintained, etc. | |
19 |
|
19 | |||
20 |
|
20 | |||
21 | Current subpackges |
|
21 | Current subpackges | |
22 | ================== |
|
22 | ================== | |
23 |
|
23 | |||
24 | IPython currently has the following sub-packages: |
|
24 | IPython currently has the following sub-packages: | |
25 |
|
25 | |||
26 | * :mod:`IPython.config` |
|
26 | * :mod:`IPython.config` | |
27 |
|
27 | |||
28 | * :mod:`IPython.Extensions` |
|
28 | * :mod:`IPython.Extensions` | |
29 |
|
29 | |||
30 | * :mod:`IPython.external` |
|
30 | * :mod:`IPython.external` | |
31 |
|
31 | |||
32 | * :mod:`IPython.frontend` |
|
32 | * :mod:`IPython.frontend` | |
33 |
|
33 | |||
34 | * :mod:`IPython.gui` |
|
34 | * :mod:`IPython.gui` | |
35 |
|
35 | |||
36 | * :mod:`IPython.kernel` |
|
36 | * :mod:`IPython.kernel` | |
37 |
|
37 | |||
38 | * :mod:`IPython.testing` |
|
38 | * :mod:`IPython.testing` | |
39 |
|
39 | |||
40 | * :mod:`IPython.tests` |
|
40 | * :mod:`IPython.tests` | |
41 |
|
41 | |||
42 | * :mod:`IPython.tools` |
|
42 | * :mod:`IPython.tools` | |
43 |
|
43 | |||
44 | * :mod:`IPython.UserConfig` |
|
44 | * :mod:`IPython.UserConfig` | |
45 |
|
45 | |||
46 | New Subpackages to be created |
|
46 | New Subpackages to be created | |
47 | ============================= |
|
47 | ============================= | |
48 |
|
48 | |||
49 | We propose to create the following new sub-packages: |
|
49 | We propose to create the following new sub-packages: | |
50 |
|
50 | |||
51 | * :mod:`IPython.core`. This sub-package will contain the core of the IPython |
|
51 | * :mod:`IPython.core`. This sub-package will contain the core of the IPython | |
52 | interpreter, but none of its extended capabilities. |
|
52 | interpreter, but none of its extended capabilities. | |
53 |
|
53 | |||
54 | * :mod:`IPython.lib`. IPython has many extended capabilities that are not part |
|
54 | * :mod:`IPython.lib`. IPython has many extended capabilities that are not part | |
55 | of the IPython core. These things will go here. Any better names than |
|
55 | of the IPython core. These things will go here. Any better names than | |
56 | :mod:`IPython.lib`? |
|
56 | :mod:`IPython.lib`? | |
57 |
|
57 | |||
58 | * :mod:`IPython.utils`. This sub-package will contain anything that might |
|
58 | * :mod:`IPython.utils`. This sub-package will contain anything that might | |
59 | eventually be found in the Python standard library, like things in |
|
59 | eventually be found in the Python standard library, like things in | |
60 | :mod:`genutils`. Each sub-module in this sub-package should contain |
|
60 | :mod:`genutils`. Each sub-module in this sub-package should contain | |
61 | functions and classes that serve a single purpose. |
|
61 | functions and classes that serve a single purpose. | |
62 |
|
62 | |||
63 | * :mod:`IPython.deathrow`. This is for code that is untested and/or rotting |
|
63 | * :mod:`IPython.deathrow`. This is for code that is untested and/or rotting | |
64 | and needs to be removed from IPython. Eventually all this code will either |
|
64 | and needs to be removed from IPython. Eventually all this code will either | |
65 | i) be revived by someone willing to maintain it with tests and docs and |
|
65 | i) be revived by someone willing to maintain it with tests and docs and | |
66 | re-included into IPython or 2) be removed from IPython proper, but put into |
|
66 | re-included into IPython or 2) be removed from IPython proper, but put into | |
67 | a separate top-level (not IPython) package that we keep around. No new code |
|
67 | a separate top-level (not IPython) package that we keep around. No new code | |
68 | will be allowed here. |
|
68 | will be allowed here. | |
69 |
|
69 | |||
70 | * :mod:`IPython.quarantine`. This is for code that doesn't meet IPython's |
|
70 | * :mod:`IPython.quarantine`. This is for code that doesn't meet IPython's | |
71 | standards, but that we plan on keeping. To be moved out of this sub-package |
|
71 | standards, but that we plan on keeping. To be moved out of this sub-package | |
72 | a module needs to have a maintainer, tests and documentation. |
|
72 | a module needs to have a maintainer, tests and documentation. | |
73 |
|
73 | |||
74 | Prodecure |
|
74 | Prodecure | |
75 | ========= |
|
75 | ========= | |
76 |
|
76 | |||
77 | 1. Move the file to its new location with its new name. |
|
77 | 1. Move the file to its new location with its new name. | |
78 | 2. Rename all import statements to reflect the change. |
|
78 | 2. Rename all import statements to reflect the change. | |
79 | 3. Run PyFlakes on each changes module. |
|
79 | 3. Run PyFlakes on each changes module. | |
80 | 3. Add tests/test_imports.py to test it. |
|
80 | 3. Add tests/test_imports.py to test it. | |
81 |
|
81 | |||
82 | Need to modify iptests to properly skip modules that are no longer top |
|
82 | Need to modify iptests to properly skip modules that are no longer top | |
83 | level modules. |
|
83 | level modules. | |
84 |
|
84 | |||
85 | Need to update the top level IPython/__init__.py file. |
|
85 | Need to update the top level IPython/__init__.py file. | |
86 |
|
86 | |||
87 | Where things will be moved |
|
87 | Where things will be moved | |
88 | ========================== |
|
88 | ========================== | |
89 |
|
89 | |||
90 | * :file:`background_jobs.py`. Move to :file:`IPython/lib/backgroundjobs.py`. |
|
90 | * :file:`background_jobs.py`. Move to :file:`IPython/lib/backgroundjobs.py`. | |
91 |
|
91 | |||
92 | * :file:`ColorANSI.py`. Move to :file:`IPython/utils/coloransi.py`. |
|
92 | * :file:`ColorANSI.py`. Move to :file:`IPython/utils/coloransi.py`. | |
93 |
|
93 | |||
94 | * :file:`completer.py`. Move to :file:`IPython/core/completer.py`. |
|
94 | * :file:`completer.py`. Move to :file:`IPython/core/completer.py`. | |
95 |
|
95 | |||
96 | * :file:`ConfigLoader.py`. Move to :file:`IPython/config/configloader.py`. |
|
96 | * :file:`ConfigLoader.py`. Move to :file:`IPython/config/configloader.py`. | |
97 |
|
97 | |||
98 | * :file:`CrashHandler.py`. Move to :file:`IPython/core/crashhandler`. |
|
98 | * :file:`CrashHandler.py`. Move to :file:`IPython/core/crashhandler`. | |
99 |
|
99 | |||
100 | * :file:`Debugger.py`. Move to :file:`IPython/core/debugger.py`. |
|
100 | * :file:`Debugger.py`. Move to :file:`IPython/core/debugger.py`. | |
101 |
|
101 | |||
102 | * :file:`deep_reload.py`. Move to :file:`IPython/lib/deepreload.py`. |
|
102 | * :file:`deep_reload.py`. Move to :file:`IPython/lib/deepreload.py`. | |
103 |
|
103 | |||
104 | * :file:`demo.py`. Move to :file:`IPython/lib/demo.py`. |
|
104 | * :file:`demo.py`. Move to :file:`IPython/lib/demo.py`. | |
105 |
|
105 | |||
106 | * :file:`DPyGetOpt.py`. Move to :mod:`IPython.utils` and replace with newer options parser. |
|
106 | * :file:`DPyGetOpt.py`. Move to :mod:`IPython.utils` and replace with newer options parser. | |
107 |
|
107 | |||
108 | * :file:`dtutils.py`. Move to :file:`IPython.deathrow`. |
|
108 | * :file:`dtutils.py`. Move to :file:`IPython.deathrow`. | |
109 |
|
109 | |||
110 | * :file:`excolors.py`. Move to :file:`IPython.core` or :file:`IPython.config`. |
|
110 | * :file:`excolors.py`. Move to :file:`IPython.core` or :file:`IPython.config`. | |
111 | Maybe move to :mod:`IPython.lib` or :mod:`IPython.python`? |
|
111 | Maybe move to :mod:`IPython.lib` or :mod:`IPython.python`? | |
112 |
|
112 | |||
113 | * :file:`FakeModule.py`. Move to :file:`IPython/core/fakemodule.py`. |
|
113 | * :file:`FakeModule.py`. Move to :file:`IPython/core/fakemodule.py`. | |
114 |
|
114 | |||
115 | * :file:`generics.py`. Move to :file:`IPython.python`. |
|
115 | * :file:`generics.py`. Move to :file:`IPython.python`. | |
116 |
|
116 | |||
117 | * :file:`genutils.py`. Move to :file:`IPython.utils`. |
|
117 | * :file:`genutils.py`. Move to :file:`IPython.utils`. | |
118 |
|
118 | |||
119 | * :file:`Gnuplot2.py`. Move to :file:`IPython.sandbox`. |
|
119 | * :file:`Gnuplot2.py`. Move to :file:`IPython.sandbox`. | |
120 |
|
120 | |||
121 | * :file:`GnuplotInteractive.py`. Move to :file:`IPython.sandbox`. |
|
121 | * :file:`GnuplotInteractive.py`. Move to :file:`IPython.sandbox`. | |
122 |
|
122 | |||
123 | * :file:`GnuplotRuntime.py`. Move to :file:`IPython.sandbox`. |
|
123 | * :file:`GnuplotRuntime.py`. Move to :file:`IPython.sandbox`. | |
124 |
|
124 | |||
125 | * :file:`numutils.py`. Move to :file:`IPython.sandbox`. |
|
125 | * :file:`numutils.py`. Move to :file:`IPython.sandbox`. | |
126 |
|
126 | |||
127 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. |
|
127 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. | |
128 |
|
128 | |||
129 | * :file:`Extensions`. This needs to be gone through separately. Minimally, |
|
129 | * :file:`Extensions`. This needs to be gone through separately. Minimally, | |
130 | the package should be renamed to :file:`extensions`. |
|
130 | the package should be renamed to :file:`extensions`. | |
131 |
|
131 | |||
132 | * :file:`history.py`. Move to :file:`IPython.core`. |
|
132 | * :file:`history.py`. Move to :file:`IPython.core`. | |
133 |
|
133 | |||
134 | * :file:`hooks.py`. Move to :file:`IPython.core`. |
|
134 | * :file:`hooks.py`. Move to :file:`IPython.core`. | |
135 |
|
135 | |||
136 | * :file:`ipapi.py`. Move to :file:`IPython.core`. |
|
136 | * :file:`ipapi.py`. Move to :file:`IPython.core`. | |
137 |
|
137 | |||
|
138 | * :file:`iplib.py`. Move to :file:`IPython.core`. | |||
|
139 | ||||
|
140 | * :file:`ipmaker.py`: Move to :file:`IPython.core`. | |||
138 |
|
141 | |||
|
142 | * :file:`ipstruct.py`. Move to :file:`IPython.python`. | |||
139 |
|
143 | |||
140 |
* :file:` |
|
144 | * :file:`irunner.py`. Move to :file:`IPython.scripts`. ??? | |
|
145 | ||||
|
146 | * :file:`Itpl.py`. Move to :file:`deathrow/Itpl.py`. Copy already in | |||
|
147 | :file:`IPython.external`. | |||
141 |
|
148 | |||
142 | * :file:`Logger.py`. Move to :file:`IPython/core/logger.py`. |
|
149 | * :file:`Logger.py`. Move to :file:`IPython/core/logger.py`. | |
143 |
|
150 | |||
|
151 | * :file:`macro.py`. Move to :file:`IPython.core`. | |||
|
152 | ||||
144 | * :file:`Magic.py`. Move to :file:`IPython/core/magic.py`. |
|
153 | * :file:`Magic.py`. Move to :file:`IPython/core/magic.py`. | |
145 |
|
154 | |||
146 | * :file:`OInspect.py`. Move to :file:`IPython/core/oinspect.py`. |
|
155 | * :file:`OInspect.py`. Move to :file:`IPython/core/oinspect.py`. | |
147 |
|
156 | |||
148 | * :file:`OutputTrap.py`. Move to :file:`IPython/core/outputtrap.py`. |
|
157 | * :file:`OutputTrap.py`. Move to :file:`IPython/core/outputtrap.py`. | |
149 |
|
158 | |||
|
159 | * :file:`platutils.py`. Move to :file:`IPython.python`. | |||
|
160 | ||||
|
161 | * :file:`platutils_dummy.py`. Move to :file:`IPython.python`. | |||
|
162 | ||||
|
163 | * :file:`platutils_posix.py`. Move to :file:`IPython.python`. | |||
|
164 | ||||
|
165 | * :file:`platutils_win32.py`. Move to :file:`IPython.python`. | |||
|
166 | ||||
|
167 | * :file:`prefilter.py`: Move to :file:`IPython.core`. | |||
|
168 | ||||
150 | * :file:`Prompts.py`. Move to :file:`IPython/core/prompts.py` or |
|
169 | * :file:`Prompts.py`. Move to :file:`IPython/core/prompts.py` or | |
151 | :file:`IPython/frontend/prompts.py`. |
|
170 | :file:`IPython/frontend/prompts.py`. | |
152 |
|
171 | |||
153 | * :file:`PyColorize.py`. Replace with pygments? If not, move to |
|
172 | * :file:`PyColorize.py`. Replace with pygments? If not, move to | |
154 | :file:`IPython/core/pycolorize.py`. Maybe move to :mod:`IPython.lib` or |
|
173 | :file:`IPython/core/pycolorize.py`. Maybe move to :mod:`IPython.lib` or | |
155 | :mod:`IPython.python`? |
|
174 | :mod:`IPython.python`? | |
156 |
|
175 | |||
157 | * :file:`Release.py`. Move to ??? or remove? |
|
176 | * :file:`Release.py`. Move to ??? or remove? | |
158 |
|
177 | |||
|
178 | * :file:`rlineimpl.py`. Move to :file:`IPython.core`. | |||
|
179 | ||||
|
180 | * :file:`shadowns.py`. Move to :file:`IPython.core`. | |||
|
181 | ||||
159 | * :file:`Shell.py`. Move to :file:`IPython.core.shell.py` or |
|
182 | * :file:`Shell.py`. Move to :file:`IPython.core.shell.py` or | |
160 | :file:`IPython/frontend/shell.py`. |
|
183 | :file:`IPython/frontend/shell.py`. | |
161 |
|
184 | |||
|
185 | * :file:`shellglobals.py`. Move to :file:`IPython.core`. | |||
|
186 | ||||
|
187 | * :file:`strdispatch.py`. Move to :file:`IPython.python`. | |||
|
188 | ||||
|
189 | * :file:`testing`. Good where it is. | |||
|
190 | ||||
|
191 | * :file:`tests`. Good where it is. | |||
|
192 | ||||
|
193 | * :file:`tools`. Things in here need to be looked at and moved elsewhere like | |||
|
194 | :file:`IPython.python`. | |||
|
195 | ||||
162 | * :file:`UserConfig`. Move to a subdirectory of :file:`IPython.config`. |
|
196 | * :file:`UserConfig`. Move to a subdirectory of :file:`IPython.config`. | |
163 |
|
197 | |||
164 |
|
198 | |||
165 |
|
199 | |||
166 |
|
200 | |||
167 | * :file:`config`. Good where it is! |
|
201 | * :file:`config`. Good where it is! | |
168 |
|
202 | |||
169 | * :file:`external`. Good where it is! |
|
203 | * :file:`external`. Good where it is! | |
170 |
|
204 | |||
171 | * :file:`frontend`. Good where it is! |
|
205 | * :file:`frontend`. Good where it is! | |
172 |
|
206 | |||
173 |
|
207 | |||
174 |
|
208 | |||
175 | * :file:`gui`. Eventually this should be moved to a subdir of |
|
209 | * :file:`gui`. Eventually this should be moved to a subdir of | |
176 | :file:`IPython.frontend`. |
|
210 | :file:`IPython.frontend`. | |
177 |
|
211 | |||
178 |
|
212 | |||
179 |
|
213 | |||
180 |
|
214 | |||
181 |
|
215 | |||
182 |
|
216 | |||
183 |
|
217 | |||
184 | * :file:`iplib.py`. Move to :file:`IPython.core`. |
|
|||
185 |
|
218 | |||
186 | * :file:`ipmaker.py`: Move to :file:`IPython.core`. |
|
|||
187 |
|
219 | |||
188 | * :file:`ipstruct.py`. Move to :file:`IPython.python`. |
|
|||
189 |
|
220 | |||
190 | * :file:`irunner.py`. Move to :file:`IPython.scripts`. |
|
|||
191 |
|
221 | |||
192 | * :file:`kernel`. Good where it is. |
|
222 | * :file:`kernel`. Good where it is. | |
193 |
|
223 | |||
194 | * :file:`macro.py`. Move to :file:`IPython.core`. |
|
|||
195 |
|
224 | |||
196 |
|
225 | |||
197 |
|
226 | |||
198 | * :file:`platutils.py`. Move to :file:`IPython.python`. |
|
|||
199 |
|
227 | |||
200 | * :file:`platutils_dummy.py`. Move to :file:`IPython.python`. |
|
|||
201 |
|
228 | |||
202 | * :file:`platutils_posix.py`. Move to :file:`IPython.python`. |
|
|||
203 |
|
||||
204 | * :file:`platutils_win32.py`. Move to :file:`IPython.python`. |
|
|||
205 |
|
229 | |||
206 | * :file:`prefilter.py`: Move to :file:`IPython.core`. |
|
|||
207 |
|
230 | |||
208 | * :file:`rlineimpl.py`. Move to :file:`IPython.core`. |
|
|||
209 |
|
231 | |||
210 | * :file:`shadowns.py`. Move to :file:`IPython.core`. |
|
|||
211 |
|
232 | |||
212 | * :file:`shellglobals.py`. Move to :file:`IPython.core`. |
|
|||
213 |
|
233 | |||
214 | * :file:`strdispatch.py`. Move to :file:`IPython.python`. |
|
|||
215 |
|
234 | |||
216 | * :file:`testing`. Good where it is. |
|
|||
217 |
|
235 | |||
218 | * :file:`tests`. Good where it is. |
|
|||
219 |
|
236 | |||
220 | * :file:`tools`. Things in here need to be looked at and moved elsewhere like |
|
|||
221 | :file:`IPython.python`. |
|
|||
222 |
|
237 | |||
223 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. |
|
238 | * :file:`twshell.py`. Move to :file:`IPython.sandbox`. | |
224 |
|
239 | |||
225 | * :file:`ultraTB.py`. Move to :file:`IPython/core/ultratb.py`. |
|
240 | * :file:`ultraTB.py`. Move to :file:`IPython/core/ultratb.py`. | |
226 |
|
241 | |||
227 | * :file:`upgrade_dir.py`. Move to :file:`IPython/python/upgradedir.py`. |
|
242 | * :file:`upgrade_dir.py`. Move to :file:`IPython/python/upgradedir.py`. | |
228 |
|
243 | |||
229 | * :file:`usage.py`. Move to :file:`IPython.core`. |
|
244 | * :file:`usage.py`. Move to :file:`IPython.core`. | |
230 |
|
245 | |||
231 | * :file:`wildcard.py`. Move to :file:`IPython.python` or :file:`IPython.core`. |
|
246 | * :file:`wildcard.py`. Move to :file:`IPython.python` or :file:`IPython.core`. | |
232 |
|
247 | |||
233 | * :file:`winconsole.py`. Move to :file:`IPython.lib`. |
|
248 | * :file:`winconsole.py`. Move to :file:`IPython.lib`. | |
234 |
|
249 | |||
235 | Other things |
|
250 | Other things | |
236 | ============ |
|
251 | ============ | |
237 |
|
252 | |||
238 | When these files are moved around, a number of other things will happen at the same time: |
|
253 | When these files are moved around, a number of other things will happen at the same time: | |
239 |
|
254 | |||
240 | 1. Test files will be created for each module in IPython. Minimally, all |
|
255 | 1. Test files will be created for each module in IPython. Minimally, all | |
241 | modules will be imported as a part of the test. This will serve as a |
|
256 | modules will be imported as a part of the test. This will serve as a | |
242 | test of the module reorganization. These tests will be put into new |
|
257 | test of the module reorganization. These tests will be put into new | |
243 | :file:`tests` subdirectories that each package will have. |
|
258 | :file:`tests` subdirectories that each package will have. | |
244 |
|
259 | |||
245 | 2. PyFlakes and other code checkers will be run to look for problems. |
|
260 | 2. PyFlakes and other code checkers will be run to look for problems. | |
246 |
|
261 | |||
247 | 3. Modules will be renamed to comply with PEP 8 naming conventions: all |
|
262 | 3. Modules will be renamed to comply with PEP 8 naming conventions: all | |
248 | lowercase and no special characters like ``-`` or ``_``. |
|
263 | lowercase and no special characters like ``-`` or ``_``. | |
249 |
|
264 | |||
250 | 4. Existing tests will be moved to the appropriate :file:`tests` |
|
265 | 4. Existing tests will be moved to the appropriate :file:`tests` | |
251 | subdirectories. |
|
266 | subdirectories. | |
252 |
|
267 | |||
253 |
|
268 | |||
254 |
|
269 | |||
255 |
|
270 |
General Comments 0
You need to be logged in to leave comments.
Login now