Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,62 +1,62 b'' | |||||
1 | """ Set default options for IPython. |
|
1 | """ Set default options for IPython. | |
2 |
|
2 | |||
3 | Just import this module to get reasonable defaults for everything. |
|
3 | Just import this module to get reasonable defaults for everything. | |
4 |
|
4 | |||
5 | These configurations used to be performed in ipythonrc (or ipythonrc.ini). |
|
5 | These configurations used to be performed in ipythonrc (or ipythonrc.ini). | |
6 | Therefore importing this in your config files makes ipython basically |
|
6 | Therefore importing this in your config files makes ipython basically | |
7 | ignore your ipythonrc. This is *not* imported by default, you need to import |
|
7 | ignore your ipythonrc. This is *not* imported by default, you need to import | |
8 | this manually in one of your config files. |
|
8 | this manually in one of your config files. | |
9 |
|
9 | |||
10 | You can further override these defaults in e.g. your ipy_user_config.py, |
|
10 | You can further override these defaults in e.g. your ipy_user_config.py, | |
11 | ipy_profile_PROFILENAME etc. |
|
11 | ipy_profile_PROFILENAME etc. | |
12 |
|
12 | |||
13 | """ |
|
13 | """ | |
14 |
|
14 | |||
15 | import IPython.rlineimpl as readline |
|
15 | import IPython.utils.rlineimpl as readline | |
16 | from IPython.core import ipapi |
|
16 | from IPython.core import ipapi | |
17 | ip = ipapi.get() |
|
17 | ip = ipapi.get() | |
18 |
|
18 | |||
19 | o = ip.options |
|
19 | o = ip.options | |
20 |
|
20 | |||
21 | o.colors = "Linux" |
|
21 | o.colors = "Linux" | |
22 | o.color_info=1 |
|
22 | o.color_info=1 | |
23 | o.confirm_exit=1 |
|
23 | o.confirm_exit=1 | |
24 | o.pprint=1 |
|
24 | o.pprint=1 | |
25 | o.multi_line_specials=1 |
|
25 | o.multi_line_specials=1 | |
26 | o.xmode="Context" |
|
26 | o.xmode="Context" | |
27 |
|
27 | |||
28 |
|
28 | |||
29 | o.prompt_in1='In [\#]: ' |
|
29 | o.prompt_in1='In [\#]: ' | |
30 | o.prompt_in2 =' .\D.: ' |
|
30 | o.prompt_in2 =' .\D.: ' | |
31 | o.prompt_out = 'Out[\#]: ' |
|
31 | o.prompt_out = 'Out[\#]: ' | |
32 | o.prompts_pad_left=1 |
|
32 | o.prompts_pad_left=1 | |
33 |
|
33 | |||
34 | o.autoindent = 1 |
|
34 | o.autoindent = 1 | |
35 |
|
35 | |||
36 | o.readline_remove_delims="-/~" |
|
36 | o.readline_remove_delims="-/~" | |
37 | o.readline_merge_completions=1 |
|
37 | o.readline_merge_completions=1 | |
38 |
|
38 | |||
39 | o.readline = 1 |
|
39 | o.readline = 1 | |
40 |
|
40 | |||
41 | rlopts = """\ |
|
41 | rlopts = """\ | |
42 | tab: complete |
|
42 | tab: complete | |
43 | "\C-l": possible-completions |
|
43 | "\C-l": possible-completions | |
44 | set show-all-if-ambiguous on |
|
44 | set show-all-if-ambiguous on | |
45 | "\C-o": tab-insert |
|
45 | "\C-o": tab-insert | |
46 | "\M-i": " " |
|
46 | "\M-i": " " | |
47 | "\M-o": "\d\d\d\d" |
|
47 | "\M-o": "\d\d\d\d" | |
48 | "\M-I": "\d\d\d\d" |
|
48 | "\M-I": "\d\d\d\d" | |
49 | "\C-r": reverse-search-history |
|
49 | "\C-r": reverse-search-history | |
50 | "\C-s": forward-search-history |
|
50 | "\C-s": forward-search-history | |
51 | "\C-p": history-search-backward |
|
51 | "\C-p": history-search-backward | |
52 | "\C-n": history-search-forward |
|
52 | "\C-n": history-search-forward | |
53 | "\e[A": history-search-backward |
|
53 | "\e[A": history-search-backward | |
54 | "\e[B": history-search-forward |
|
54 | "\e[B": history-search-forward | |
55 | "\C-k": kill-line |
|
55 | "\C-k": kill-line | |
56 | "\C-u": unix-line-discard""" |
|
56 | "\C-u": unix-line-discard""" | |
57 |
|
57 | |||
58 | if readline.have_readline: |
|
58 | if readline.have_readline: | |
59 | for cmd in rlopts.split('\n'): |
|
59 | for cmd in rlopts.split('\n'): | |
60 | readline.parse_and_bind(cmd) |
|
60 | readline.parse_and_bind(cmd) | |
61 |
|
61 | |||
62 |
|
62 |
@@ -1,76 +1,76 b'' | |||||
1 | """ Greedy completer extension for IPython |
|
1 | """ Greedy completer extension for IPython | |
2 |
|
2 | |||
3 | Normal tab completer refuses to evaluate nonsafe stuff. This will evaluate |
|
3 | Normal tab completer refuses to evaluate nonsafe stuff. This will evaluate | |
4 | everything, so you need to consider the consequences of pressing tab |
|
4 | everything, so you need to consider the consequences of pressing tab | |
5 | yourself! |
|
5 | yourself! | |
6 |
|
6 | |||
7 | Note that this extension simplifies readline interaction by setting |
|
7 | Note that this extension simplifies readline interaction by setting | |
8 | only whitespace as completer delimiter. If this works well, we will |
|
8 | only whitespace as completer delimiter. If this works well, we will | |
9 | do the same in default completer. |
|
9 | do the same in default completer. | |
10 |
|
10 | |||
11 | """ |
|
11 | """ | |
12 | from IPython.core import ipapi |
|
12 | from IPython.core import ipapi | |
13 | from IPython.utils import generics |
|
13 | from IPython.utils import generics | |
14 | from IPython.utils.genutils import dir2 |
|
14 | from IPython.utils.genutils import dir2 | |
15 |
|
15 | |||
16 | def attr_matches(self, text): |
|
16 | def attr_matches(self, text): | |
17 | """Compute matches when text contains a dot. |
|
17 | """Compute matches when text contains a dot. | |
18 |
|
18 | |||
19 | MONKEYPATCHED VERSION (ipy_greedycompleter.py) |
|
19 | MONKEYPATCHED VERSION (ipy_greedycompleter.py) | |
20 |
|
20 | |||
21 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
21 | Assuming the text is of the form NAME.NAME....[NAME], and is | |
22 | evaluatable in self.namespace or self.global_namespace, it will be |
|
22 | evaluatable in self.namespace or self.global_namespace, it will be | |
23 | evaluated and its attributes (as revealed by dir()) are used as |
|
23 | evaluated and its attributes (as revealed by dir()) are used as | |
24 | possible completions. (For class instances, class members are are |
|
24 | possible completions. (For class instances, class members are are | |
25 | also considered.) |
|
25 | also considered.) | |
26 |
|
26 | |||
27 | WARNING: this can still invoke arbitrary C code, if an object |
|
27 | WARNING: this can still invoke arbitrary C code, if an object | |
28 | with a __getattr__ hook is evaluated. |
|
28 | with a __getattr__ hook is evaluated. | |
29 |
|
29 | |||
30 | """ |
|
30 | """ | |
31 | import re |
|
31 | import re | |
32 |
|
32 | |||
33 | force_complete = 1 |
|
33 | force_complete = 1 | |
34 | # Another option, seems to work great. Catches things like ''.<tab> |
|
34 | # Another option, seems to work great. Catches things like ''.<tab> | |
35 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
35 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) | |
36 |
|
36 | |||
37 | if m: |
|
37 | if m: | |
38 | expr, attr = m.group(1, 3) |
|
38 | expr, attr = m.group(1, 3) | |
39 | else: |
|
39 | else: | |
40 | # force match - eval anything that ends with colon |
|
40 | # force match - eval anything that ends with colon | |
41 | if not force_complete: |
|
41 | if not force_complete: | |
42 | return [] |
|
42 | return [] | |
43 |
|
43 | |||
44 | m2 = re.match(r"(.+)\.(\w*)$", self.lbuf) |
|
44 | m2 = re.match(r"(.+)\.(\w*)$", self.lbuf) | |
45 | if not m2: |
|
45 | if not m2: | |
46 | return [] |
|
46 | return [] | |
47 | expr, attr = m2.group(1,2) |
|
47 | expr, attr = m2.group(1,2) | |
48 |
|
48 | |||
49 |
|
49 | |||
50 | try: |
|
50 | try: | |
51 | obj = eval(expr, self.namespace) |
|
51 | obj = eval(expr, self.namespace) | |
52 | except: |
|
52 | except: | |
53 | try: |
|
53 | try: | |
54 | obj = eval(expr, self.global_namespace) |
|
54 | obj = eval(expr, self.global_namespace) | |
55 | except: |
|
55 | except: | |
56 | return [] |
|
56 | return [] | |
57 |
|
57 | |||
58 | words = dir2(obj) |
|
58 | words = dir2(obj) | |
59 |
|
59 | |||
60 | try: |
|
60 | try: | |
61 | words = generics.complete_object(obj, words) |
|
61 | words = generics.complete_object(obj, words) | |
62 | except ipapi.TryNext: |
|
62 | except ipapi.TryNext: | |
63 | pass |
|
63 | pass | |
64 | # Build match list to return |
|
64 | # Build match list to return | |
65 | n = len(attr) |
|
65 | n = len(attr) | |
66 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
66 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] | |
67 | return res |
|
67 | return res | |
68 |
|
68 | |||
69 | def main(): |
|
69 | def main(): | |
70 | import IPython.rlineimpl as readline |
|
70 | import IPython.utils.rlineimpl as readline | |
71 | readline.set_completer_delims(" \n\t") |
|
71 | readline.set_completer_delims(" \n\t") | |
72 | # monkeypatch - the code will be folded to normal completer later on |
|
72 | # monkeypatch - the code will be folded to normal completer later on | |
73 | import IPython.core.completer |
|
73 | import IPython.core.completer | |
74 | IPython.core.completer.Completer.attr_matches = attr_matches |
|
74 | IPython.core.completer.Completer.attr_matches = attr_matches | |
75 |
|
75 | |||
76 | main() No newline at end of file |
|
76 | main() |
@@ -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.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.ultraTB import AutoFormattedTB; # dbg |
|
635 | #from IPython.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,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 ultraTB |
|
48 | from IPython 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.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 | import IPython.shadowns |
|
64 | import IPython.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(ultraTB.ListTB): |
|
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 | ultraTB.ListTB.__init__(self,color_scheme) |
|
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 | ultraTB.ListTB.__call__(self,etype,value,elist) |
|
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 = ultraTB.AutoFormattedTB(mode = 'Plain', |
|
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 = ultraTB.FormattedTB() |
|
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'] = IPython.shadowns |
|
951 | self.user_ns['_sh'] = IPython.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.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 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,2172 +1,2172 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """General purpose utilities. |
|
2 | """General purpose utilities. | |
3 |
|
3 | |||
4 | This is a grab-bag of stuff I find useful in most programs I write. Some of |
|
4 | This is a grab-bag of stuff I find useful in most programs I write. Some of | |
5 | these things are also convenient when working at the command line. |
|
5 | these things are also convenient when working at the command line. | |
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 | #**************************************************************************** |
|
15 | #**************************************************************************** | |
16 | # required modules from the Python standard library |
|
16 | # required modules from the Python standard library | |
17 | import __main__ |
|
17 | import __main__ | |
18 | import commands |
|
18 | import commands | |
19 | try: |
|
19 | try: | |
20 | import doctest |
|
20 | import doctest | |
21 | except ImportError: |
|
21 | except ImportError: | |
22 | pass |
|
22 | pass | |
23 | import os |
|
23 | import os | |
24 | import platform |
|
24 | import platform | |
25 | import re |
|
25 | import re | |
26 | import shlex |
|
26 | import shlex | |
27 | import shutil |
|
27 | import shutil | |
28 | import subprocess |
|
28 | import subprocess | |
29 | import sys |
|
29 | import sys | |
30 | import tempfile |
|
30 | import tempfile | |
31 | import time |
|
31 | import time | |
32 | import types |
|
32 | import types | |
33 | import warnings |
|
33 | import warnings | |
34 |
|
34 | |||
35 | # Curses and termios are Unix-only modules |
|
35 | # Curses and termios are Unix-only modules | |
36 | try: |
|
36 | try: | |
37 | import curses |
|
37 | import curses | |
38 | # We need termios as well, so if its import happens to raise, we bail on |
|
38 | # We need termios as well, so if its import happens to raise, we bail on | |
39 | # using curses altogether. |
|
39 | # using curses altogether. | |
40 | import termios |
|
40 | import termios | |
41 | except ImportError: |
|
41 | except ImportError: | |
42 | USE_CURSES = False |
|
42 | USE_CURSES = False | |
43 | else: |
|
43 | else: | |
44 | # Curses on Solaris may not be complete, so we can't use it there |
|
44 | # Curses on Solaris may not be complete, so we can't use it there | |
45 | USE_CURSES = hasattr(curses,'initscr') |
|
45 | USE_CURSES = hasattr(curses,'initscr') | |
46 |
|
46 | |||
47 | # Other IPython utilities |
|
47 | # Other IPython utilities | |
48 | import IPython |
|
48 | import IPython | |
49 | from IPython.external.Itpl import Itpl,itpl,printpl |
|
49 | from IPython.external.Itpl import Itpl,itpl,printpl | |
50 | from IPython.utils import platutils |
|
50 | from IPython.utils import platutils | |
51 | from IPython.utils import DPyGetOpt |
|
51 | from IPython.utils import DPyGetOpt | |
52 | from IPython.utils.generics import result_display |
|
52 | from IPython.utils.generics import result_display | |
53 | from IPython.core import ipapi |
|
53 | from IPython.core import ipapi | |
54 | from IPython.external.path import path |
|
54 | from IPython.external.path import path | |
55 | if os.name == "nt": |
|
55 | if os.name == "nt": | |
56 | from IPython.winconsole import get_console_size |
|
56 | from IPython.winconsole import get_console_size | |
57 |
|
57 | |||
58 | try: |
|
58 | try: | |
59 | set |
|
59 | set | |
60 | except: |
|
60 | except: | |
61 | from sets import Set as set |
|
61 | from sets import Set as set | |
62 |
|
62 | |||
63 |
|
63 | |||
64 | #**************************************************************************** |
|
64 | #**************************************************************************** | |
65 | # Exceptions |
|
65 | # Exceptions | |
66 | class Error(Exception): |
|
66 | class Error(Exception): | |
67 | """Base class for exceptions in this module.""" |
|
67 | """Base class for exceptions in this module.""" | |
68 | pass |
|
68 | pass | |
69 |
|
69 | |||
70 | #---------------------------------------------------------------------------- |
|
70 | #---------------------------------------------------------------------------- | |
71 | class IOStream: |
|
71 | class IOStream: | |
72 | def __init__(self,stream,fallback): |
|
72 | def __init__(self,stream,fallback): | |
73 | if not hasattr(stream,'write') or not hasattr(stream,'flush'): |
|
73 | if not hasattr(stream,'write') or not hasattr(stream,'flush'): | |
74 | stream = fallback |
|
74 | stream = fallback | |
75 | self.stream = stream |
|
75 | self.stream = stream | |
76 | self._swrite = stream.write |
|
76 | self._swrite = stream.write | |
77 | self.flush = stream.flush |
|
77 | self.flush = stream.flush | |
78 |
|
78 | |||
79 | def write(self,data): |
|
79 | def write(self,data): | |
80 | try: |
|
80 | try: | |
81 | self._swrite(data) |
|
81 | self._swrite(data) | |
82 | except: |
|
82 | except: | |
83 | try: |
|
83 | try: | |
84 | # print handles some unicode issues which may trip a plain |
|
84 | # print handles some unicode issues which may trip a plain | |
85 | # write() call. Attempt to emulate write() by using a |
|
85 | # write() call. Attempt to emulate write() by using a | |
86 | # trailing comma |
|
86 | # trailing comma | |
87 | print >> self.stream, data, |
|
87 | print >> self.stream, data, | |
88 | except: |
|
88 | except: | |
89 | # if we get here, something is seriously broken. |
|
89 | # if we get here, something is seriously broken. | |
90 | print >> sys.stderr, \ |
|
90 | print >> sys.stderr, \ | |
91 | 'ERROR - failed to write data to stream:', self.stream |
|
91 | 'ERROR - failed to write data to stream:', self.stream | |
92 |
|
92 | |||
93 | def close(self): |
|
93 | def close(self): | |
94 | pass |
|
94 | pass | |
95 |
|
95 | |||
96 |
|
96 | |||
97 | class IOTerm: |
|
97 | class IOTerm: | |
98 | """ Term holds the file or file-like objects for handling I/O operations. |
|
98 | """ Term holds the file or file-like objects for handling I/O operations. | |
99 |
|
99 | |||
100 | These are normally just sys.stdin, sys.stdout and sys.stderr but for |
|
100 | These are normally just sys.stdin, sys.stdout and sys.stderr but for | |
101 | Windows they can can replaced to allow editing the strings before they are |
|
101 | Windows they can can replaced to allow editing the strings before they are | |
102 | displayed.""" |
|
102 | displayed.""" | |
103 |
|
103 | |||
104 | # In the future, having IPython channel all its I/O operations through |
|
104 | # In the future, having IPython channel all its I/O operations through | |
105 | # this class will make it easier to embed it into other environments which |
|
105 | # this class will make it easier to embed it into other environments which | |
106 | # are not a normal terminal (such as a GUI-based shell) |
|
106 | # are not a normal terminal (such as a GUI-based shell) | |
107 | def __init__(self,cin=None,cout=None,cerr=None): |
|
107 | def __init__(self,cin=None,cout=None,cerr=None): | |
108 | self.cin = IOStream(cin,sys.stdin) |
|
108 | self.cin = IOStream(cin,sys.stdin) | |
109 | self.cout = IOStream(cout,sys.stdout) |
|
109 | self.cout = IOStream(cout,sys.stdout) | |
110 | self.cerr = IOStream(cerr,sys.stderr) |
|
110 | self.cerr = IOStream(cerr,sys.stderr) | |
111 |
|
111 | |||
112 | # Global variable to be used for all I/O |
|
112 | # Global variable to be used for all I/O | |
113 | Term = IOTerm() |
|
113 | Term = IOTerm() | |
114 |
|
114 | |||
115 | import IPython.rlineimpl as readline |
|
115 | import IPython.utils.rlineimpl as readline | |
116 | # Remake Term to use the readline i/o facilities |
|
116 | # Remake Term to use the readline i/o facilities | |
117 | if sys.platform == 'win32' and readline.have_readline: |
|
117 | if sys.platform == 'win32' and readline.have_readline: | |
118 |
|
118 | |||
119 | Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile) |
|
119 | Term = IOTerm(cout=readline._outputfile,cerr=readline._outputfile) | |
120 |
|
120 | |||
121 |
|
121 | |||
122 | #**************************************************************************** |
|
122 | #**************************************************************************** | |
123 | # Generic warning/error printer, used by everything else |
|
123 | # Generic warning/error printer, used by everything else | |
124 | def warn(msg,level=2,exit_val=1): |
|
124 | def warn(msg,level=2,exit_val=1): | |
125 | """Standard warning printer. Gives formatting consistency. |
|
125 | """Standard warning printer. Gives formatting consistency. | |
126 |
|
126 | |||
127 | Output is sent to Term.cerr (sys.stderr by default). |
|
127 | Output is sent to Term.cerr (sys.stderr by default). | |
128 |
|
128 | |||
129 | Options: |
|
129 | Options: | |
130 |
|
130 | |||
131 | -level(2): allows finer control: |
|
131 | -level(2): allows finer control: | |
132 | 0 -> Do nothing, dummy function. |
|
132 | 0 -> Do nothing, dummy function. | |
133 | 1 -> Print message. |
|
133 | 1 -> Print message. | |
134 | 2 -> Print 'WARNING:' + message. (Default level). |
|
134 | 2 -> Print 'WARNING:' + message. (Default level). | |
135 | 3 -> Print 'ERROR:' + message. |
|
135 | 3 -> Print 'ERROR:' + message. | |
136 | 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val). |
|
136 | 4 -> Print 'FATAL ERROR:' + message and trigger a sys.exit(exit_val). | |
137 |
|
137 | |||
138 | -exit_val (1): exit value returned by sys.exit() for a level 4 |
|
138 | -exit_val (1): exit value returned by sys.exit() for a level 4 | |
139 | warning. Ignored for all other levels.""" |
|
139 | warning. Ignored for all other levels.""" | |
140 |
|
140 | |||
141 | if level>0: |
|
141 | if level>0: | |
142 | header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] |
|
142 | header = ['','','WARNING: ','ERROR: ','FATAL ERROR: '] | |
143 | print >> Term.cerr, '%s%s' % (header[level],msg) |
|
143 | print >> Term.cerr, '%s%s' % (header[level],msg) | |
144 | if level == 4: |
|
144 | if level == 4: | |
145 | print >> Term.cerr,'Exiting.\n' |
|
145 | print >> Term.cerr,'Exiting.\n' | |
146 | sys.exit(exit_val) |
|
146 | sys.exit(exit_val) | |
147 |
|
147 | |||
148 | def info(msg): |
|
148 | def info(msg): | |
149 | """Equivalent to warn(msg,level=1).""" |
|
149 | """Equivalent to warn(msg,level=1).""" | |
150 |
|
150 | |||
151 | warn(msg,level=1) |
|
151 | warn(msg,level=1) | |
152 |
|
152 | |||
153 | def error(msg): |
|
153 | def error(msg): | |
154 | """Equivalent to warn(msg,level=3).""" |
|
154 | """Equivalent to warn(msg,level=3).""" | |
155 |
|
155 | |||
156 | warn(msg,level=3) |
|
156 | warn(msg,level=3) | |
157 |
|
157 | |||
158 | def fatal(msg,exit_val=1): |
|
158 | def fatal(msg,exit_val=1): | |
159 | """Equivalent to warn(msg,exit_val=exit_val,level=4).""" |
|
159 | """Equivalent to warn(msg,exit_val=exit_val,level=4).""" | |
160 |
|
160 | |||
161 | warn(msg,exit_val=exit_val,level=4) |
|
161 | warn(msg,exit_val=exit_val,level=4) | |
162 |
|
162 | |||
163 | #--------------------------------------------------------------------------- |
|
163 | #--------------------------------------------------------------------------- | |
164 | # Debugging routines |
|
164 | # Debugging routines | |
165 | # |
|
165 | # | |
166 | def debugx(expr,pre_msg=''): |
|
166 | def debugx(expr,pre_msg=''): | |
167 | """Print the value of an expression from the caller's frame. |
|
167 | """Print the value of an expression from the caller's frame. | |
168 |
|
168 | |||
169 | Takes an expression, evaluates it in the caller's frame and prints both |
|
169 | Takes an expression, evaluates it in the caller's frame and prints both | |
170 | the given expression and the resulting value (as well as a debug mark |
|
170 | the given expression and the resulting value (as well as a debug mark | |
171 | indicating the name of the calling function. The input must be of a form |
|
171 | indicating the name of the calling function. The input must be of a form | |
172 | suitable for eval(). |
|
172 | suitable for eval(). | |
173 |
|
173 | |||
174 | An optional message can be passed, which will be prepended to the printed |
|
174 | An optional message can be passed, which will be prepended to the printed | |
175 | expr->value pair.""" |
|
175 | expr->value pair.""" | |
176 |
|
176 | |||
177 | cf = sys._getframe(1) |
|
177 | cf = sys._getframe(1) | |
178 | print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, |
|
178 | print '[DBG:%s] %s%s -> %r' % (cf.f_code.co_name,pre_msg,expr, | |
179 | eval(expr,cf.f_globals,cf.f_locals)) |
|
179 | eval(expr,cf.f_globals,cf.f_locals)) | |
180 |
|
180 | |||
181 | # deactivate it by uncommenting the following line, which makes it a no-op |
|
181 | # deactivate it by uncommenting the following line, which makes it a no-op | |
182 | #def debugx(expr,pre_msg=''): pass |
|
182 | #def debugx(expr,pre_msg=''): pass | |
183 |
|
183 | |||
184 | #---------------------------------------------------------------------------- |
|
184 | #---------------------------------------------------------------------------- | |
185 | StringTypes = types.StringTypes |
|
185 | StringTypes = types.StringTypes | |
186 |
|
186 | |||
187 | # Basic timing functionality |
|
187 | # Basic timing functionality | |
188 |
|
188 | |||
189 | # If possible (Unix), use the resource module instead of time.clock() |
|
189 | # If possible (Unix), use the resource module instead of time.clock() | |
190 | try: |
|
190 | try: | |
191 | import resource |
|
191 | import resource | |
192 | def clocku(): |
|
192 | def clocku(): | |
193 | """clocku() -> floating point number |
|
193 | """clocku() -> floating point number | |
194 |
|
194 | |||
195 | Return the *USER* CPU time in seconds since the start of the process. |
|
195 | Return the *USER* CPU time in seconds since the start of the process. | |
196 | This is done via a call to resource.getrusage, so it avoids the |
|
196 | This is done via a call to resource.getrusage, so it avoids the | |
197 | wraparound problems in time.clock().""" |
|
197 | wraparound problems in time.clock().""" | |
198 |
|
198 | |||
199 | return resource.getrusage(resource.RUSAGE_SELF)[0] |
|
199 | return resource.getrusage(resource.RUSAGE_SELF)[0] | |
200 |
|
200 | |||
201 | def clocks(): |
|
201 | def clocks(): | |
202 | """clocks() -> floating point number |
|
202 | """clocks() -> floating point number | |
203 |
|
203 | |||
204 | Return the *SYSTEM* CPU time in seconds since the start of the process. |
|
204 | Return the *SYSTEM* CPU time in seconds since the start of the process. | |
205 | This is done via a call to resource.getrusage, so it avoids the |
|
205 | This is done via a call to resource.getrusage, so it avoids the | |
206 | wraparound problems in time.clock().""" |
|
206 | wraparound problems in time.clock().""" | |
207 |
|
207 | |||
208 | return resource.getrusage(resource.RUSAGE_SELF)[1] |
|
208 | return resource.getrusage(resource.RUSAGE_SELF)[1] | |
209 |
|
209 | |||
210 | def clock(): |
|
210 | def clock(): | |
211 | """clock() -> floating point number |
|
211 | """clock() -> floating point number | |
212 |
|
212 | |||
213 | Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of |
|
213 | Return the *TOTAL USER+SYSTEM* CPU time in seconds since the start of | |
214 | the process. This is done via a call to resource.getrusage, so it |
|
214 | the process. This is done via a call to resource.getrusage, so it | |
215 | avoids the wraparound problems in time.clock().""" |
|
215 | avoids the wraparound problems in time.clock().""" | |
216 |
|
216 | |||
217 | u,s = resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
217 | u,s = resource.getrusage(resource.RUSAGE_SELF)[:2] | |
218 | return u+s |
|
218 | return u+s | |
219 |
|
219 | |||
220 | def clock2(): |
|
220 | def clock2(): | |
221 | """clock2() -> (t_user,t_system) |
|
221 | """clock2() -> (t_user,t_system) | |
222 |
|
222 | |||
223 | Similar to clock(), but return a tuple of user/system times.""" |
|
223 | Similar to clock(), but return a tuple of user/system times.""" | |
224 | return resource.getrusage(resource.RUSAGE_SELF)[:2] |
|
224 | return resource.getrusage(resource.RUSAGE_SELF)[:2] | |
225 |
|
225 | |||
226 | except ImportError: |
|
226 | except ImportError: | |
227 | # There is no distinction of user/system time under windows, so we just use |
|
227 | # There is no distinction of user/system time under windows, so we just use | |
228 | # time.clock() for everything... |
|
228 | # time.clock() for everything... | |
229 | clocku = clocks = clock = time.clock |
|
229 | clocku = clocks = clock = time.clock | |
230 | def clock2(): |
|
230 | def clock2(): | |
231 | """Under windows, system CPU time can't be measured. |
|
231 | """Under windows, system CPU time can't be measured. | |
232 |
|
232 | |||
233 | This just returns clock() and zero.""" |
|
233 | This just returns clock() and zero.""" | |
234 | return time.clock(),0.0 |
|
234 | return time.clock(),0.0 | |
235 |
|
235 | |||
236 | def timings_out(reps,func,*args,**kw): |
|
236 | def timings_out(reps,func,*args,**kw): | |
237 | """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output) |
|
237 | """timings_out(reps,func,*args,**kw) -> (t_total,t_per_call,output) | |
238 |
|
238 | |||
239 | Execute a function reps times, return a tuple with the elapsed total |
|
239 | Execute a function reps times, return a tuple with the elapsed total | |
240 | CPU time in seconds, the time per call and the function's output. |
|
240 | CPU time in seconds, the time per call and the function's output. | |
241 |
|
241 | |||
242 | Under Unix, the return value is the sum of user+system time consumed by |
|
242 | Under Unix, the return value is the sum of user+system time consumed by | |
243 | the process, computed via the resource module. This prevents problems |
|
243 | the process, computed via the resource module. This prevents problems | |
244 | related to the wraparound effect which the time.clock() function has. |
|
244 | related to the wraparound effect which the time.clock() function has. | |
245 |
|
245 | |||
246 | Under Windows the return value is in wall clock seconds. See the |
|
246 | Under Windows the return value is in wall clock seconds. See the | |
247 | documentation for the time module for more details.""" |
|
247 | documentation for the time module for more details.""" | |
248 |
|
248 | |||
249 | reps = int(reps) |
|
249 | reps = int(reps) | |
250 | assert reps >=1, 'reps must be >= 1' |
|
250 | assert reps >=1, 'reps must be >= 1' | |
251 | if reps==1: |
|
251 | if reps==1: | |
252 | start = clock() |
|
252 | start = clock() | |
253 | out = func(*args,**kw) |
|
253 | out = func(*args,**kw) | |
254 | tot_time = clock()-start |
|
254 | tot_time = clock()-start | |
255 | else: |
|
255 | else: | |
256 | rng = xrange(reps-1) # the last time is executed separately to store output |
|
256 | rng = xrange(reps-1) # the last time is executed separately to store output | |
257 | start = clock() |
|
257 | start = clock() | |
258 | for dummy in rng: func(*args,**kw) |
|
258 | for dummy in rng: func(*args,**kw) | |
259 | out = func(*args,**kw) # one last time |
|
259 | out = func(*args,**kw) # one last time | |
260 | tot_time = clock()-start |
|
260 | tot_time = clock()-start | |
261 | av_time = tot_time / reps |
|
261 | av_time = tot_time / reps | |
262 | return tot_time,av_time,out |
|
262 | return tot_time,av_time,out | |
263 |
|
263 | |||
264 | def timings(reps,func,*args,**kw): |
|
264 | def timings(reps,func,*args,**kw): | |
265 | """timings(reps,func,*args,**kw) -> (t_total,t_per_call) |
|
265 | """timings(reps,func,*args,**kw) -> (t_total,t_per_call) | |
266 |
|
266 | |||
267 | Execute a function reps times, return a tuple with the elapsed total CPU |
|
267 | Execute a function reps times, return a tuple with the elapsed total CPU | |
268 | time in seconds and the time per call. These are just the first two values |
|
268 | time in seconds and the time per call. These are just the first two values | |
269 | in timings_out().""" |
|
269 | in timings_out().""" | |
270 |
|
270 | |||
271 | return timings_out(reps,func,*args,**kw)[0:2] |
|
271 | return timings_out(reps,func,*args,**kw)[0:2] | |
272 |
|
272 | |||
273 | def timing(func,*args,**kw): |
|
273 | def timing(func,*args,**kw): | |
274 | """timing(func,*args,**kw) -> t_total |
|
274 | """timing(func,*args,**kw) -> t_total | |
275 |
|
275 | |||
276 | Execute a function once, return the elapsed total CPU time in |
|
276 | Execute a function once, return the elapsed total CPU time in | |
277 | seconds. This is just the first value in timings_out().""" |
|
277 | seconds. This is just the first value in timings_out().""" | |
278 |
|
278 | |||
279 | return timings_out(1,func,*args,**kw)[0] |
|
279 | return timings_out(1,func,*args,**kw)[0] | |
280 |
|
280 | |||
281 | #**************************************************************************** |
|
281 | #**************************************************************************** | |
282 | # file and system |
|
282 | # file and system | |
283 |
|
283 | |||
284 | def arg_split(s,posix=False): |
|
284 | def arg_split(s,posix=False): | |
285 | """Split a command line's arguments in a shell-like manner. |
|
285 | """Split a command line's arguments in a shell-like manner. | |
286 |
|
286 | |||
287 | This is a modified version of the standard library's shlex.split() |
|
287 | This is a modified version of the standard library's shlex.split() | |
288 | function, but with a default of posix=False for splitting, so that quotes |
|
288 | function, but with a default of posix=False for splitting, so that quotes | |
289 | in inputs are respected.""" |
|
289 | in inputs are respected.""" | |
290 |
|
290 | |||
291 | # XXX - there may be unicode-related problems here!!! I'm not sure that |
|
291 | # XXX - there may be unicode-related problems here!!! I'm not sure that | |
292 | # shlex is truly unicode-safe, so it might be necessary to do |
|
292 | # shlex is truly unicode-safe, so it might be necessary to do | |
293 | # |
|
293 | # | |
294 | # s = s.encode(sys.stdin.encoding) |
|
294 | # s = s.encode(sys.stdin.encoding) | |
295 | # |
|
295 | # | |
296 | # first, to ensure that shlex gets a normal string. Input from anyone who |
|
296 | # first, to ensure that shlex gets a normal string. Input from anyone who | |
297 | # knows more about unicode and shlex than I would be good to have here... |
|
297 | # knows more about unicode and shlex than I would be good to have here... | |
298 | lex = shlex.shlex(s, posix=posix) |
|
298 | lex = shlex.shlex(s, posix=posix) | |
299 | lex.whitespace_split = True |
|
299 | lex.whitespace_split = True | |
300 | return list(lex) |
|
300 | return list(lex) | |
301 |
|
301 | |||
302 | def system(cmd,verbose=0,debug=0,header=''): |
|
302 | def system(cmd,verbose=0,debug=0,header=''): | |
303 | """Execute a system command, return its exit status. |
|
303 | """Execute a system command, return its exit status. | |
304 |
|
304 | |||
305 | Options: |
|
305 | Options: | |
306 |
|
306 | |||
307 | - verbose (0): print the command to be executed. |
|
307 | - verbose (0): print the command to be executed. | |
308 |
|
308 | |||
309 | - debug (0): only print, do not actually execute. |
|
309 | - debug (0): only print, do not actually execute. | |
310 |
|
310 | |||
311 | - header (''): Header to print on screen prior to the executed command (it |
|
311 | - header (''): Header to print on screen prior to the executed command (it | |
312 | is only prepended to the command, no newlines are added). |
|
312 | is only prepended to the command, no newlines are added). | |
313 |
|
313 | |||
314 | Note: a stateful version of this function is available through the |
|
314 | Note: a stateful version of this function is available through the | |
315 | SystemExec class.""" |
|
315 | SystemExec class.""" | |
316 |
|
316 | |||
317 | stat = 0 |
|
317 | stat = 0 | |
318 | if verbose or debug: print header+cmd |
|
318 | if verbose or debug: print header+cmd | |
319 | sys.stdout.flush() |
|
319 | sys.stdout.flush() | |
320 | if not debug: stat = os.system(cmd) |
|
320 | if not debug: stat = os.system(cmd) | |
321 | return stat |
|
321 | return stat | |
322 |
|
322 | |||
323 | def abbrev_cwd(): |
|
323 | def abbrev_cwd(): | |
324 | """ Return abbreviated version of cwd, e.g. d:mydir """ |
|
324 | """ Return abbreviated version of cwd, e.g. d:mydir """ | |
325 | cwd = os.getcwd().replace('\\','/') |
|
325 | cwd = os.getcwd().replace('\\','/') | |
326 | drivepart = '' |
|
326 | drivepart = '' | |
327 | tail = cwd |
|
327 | tail = cwd | |
328 | if sys.platform == 'win32': |
|
328 | if sys.platform == 'win32': | |
329 | if len(cwd) < 4: |
|
329 | if len(cwd) < 4: | |
330 | return cwd |
|
330 | return cwd | |
331 | drivepart,tail = os.path.splitdrive(cwd) |
|
331 | drivepart,tail = os.path.splitdrive(cwd) | |
332 |
|
332 | |||
333 |
|
333 | |||
334 | parts = tail.split('/') |
|
334 | parts = tail.split('/') | |
335 | if len(parts) > 2: |
|
335 | if len(parts) > 2: | |
336 | tail = '/'.join(parts[-2:]) |
|
336 | tail = '/'.join(parts[-2:]) | |
337 |
|
337 | |||
338 | return (drivepart + ( |
|
338 | return (drivepart + ( | |
339 | cwd == '/' and '/' or tail)) |
|
339 | cwd == '/' and '/' or tail)) | |
340 |
|
340 | |||
341 |
|
341 | |||
342 | # This function is used by ipython in a lot of places to make system calls. |
|
342 | # This function is used by ipython in a lot of places to make system calls. | |
343 | # We need it to be slightly different under win32, due to the vagaries of |
|
343 | # We need it to be slightly different under win32, due to the vagaries of | |
344 | # 'network shares'. A win32 override is below. |
|
344 | # 'network shares'. A win32 override is below. | |
345 |
|
345 | |||
346 | def shell(cmd,verbose=0,debug=0,header=''): |
|
346 | def shell(cmd,verbose=0,debug=0,header=''): | |
347 | """Execute a command in the system shell, always return None. |
|
347 | """Execute a command in the system shell, always return None. | |
348 |
|
348 | |||
349 | Options: |
|
349 | Options: | |
350 |
|
350 | |||
351 | - verbose (0): print the command to be executed. |
|
351 | - verbose (0): print the command to be executed. | |
352 |
|
352 | |||
353 | - debug (0): only print, do not actually execute. |
|
353 | - debug (0): only print, do not actually execute. | |
354 |
|
354 | |||
355 | - header (''): Header to print on screen prior to the executed command (it |
|
355 | - header (''): Header to print on screen prior to the executed command (it | |
356 | is only prepended to the command, no newlines are added). |
|
356 | is only prepended to the command, no newlines are added). | |
357 |
|
357 | |||
358 | Note: this is similar to genutils.system(), but it returns None so it can |
|
358 | Note: this is similar to genutils.system(), but it returns None so it can | |
359 | be conveniently used in interactive loops without getting the return value |
|
359 | be conveniently used in interactive loops without getting the return value | |
360 | (typically 0) printed many times.""" |
|
360 | (typically 0) printed many times.""" | |
361 |
|
361 | |||
362 | stat = 0 |
|
362 | stat = 0 | |
363 | if verbose or debug: print header+cmd |
|
363 | if verbose or debug: print header+cmd | |
364 | # flush stdout so we don't mangle python's buffering |
|
364 | # flush stdout so we don't mangle python's buffering | |
365 | sys.stdout.flush() |
|
365 | sys.stdout.flush() | |
366 |
|
366 | |||
367 | if not debug: |
|
367 | if not debug: | |
368 | platutils.set_term_title("IPy " + cmd) |
|
368 | platutils.set_term_title("IPy " + cmd) | |
369 | os.system(cmd) |
|
369 | os.system(cmd) | |
370 | platutils.set_term_title("IPy " + abbrev_cwd()) |
|
370 | platutils.set_term_title("IPy " + abbrev_cwd()) | |
371 |
|
371 | |||
372 | # override shell() for win32 to deal with network shares |
|
372 | # override shell() for win32 to deal with network shares | |
373 | if os.name in ('nt','dos'): |
|
373 | if os.name in ('nt','dos'): | |
374 |
|
374 | |||
375 | shell_ori = shell |
|
375 | shell_ori = shell | |
376 |
|
376 | |||
377 | def shell(cmd,verbose=0,debug=0,header=''): |
|
377 | def shell(cmd,verbose=0,debug=0,header=''): | |
378 | if os.getcwd().startswith(r"\\"): |
|
378 | if os.getcwd().startswith(r"\\"): | |
379 | path = os.getcwd() |
|
379 | path = os.getcwd() | |
380 | # change to c drive (cannot be on UNC-share when issuing os.system, |
|
380 | # change to c drive (cannot be on UNC-share when issuing os.system, | |
381 | # as cmd.exe cannot handle UNC addresses) |
|
381 | # as cmd.exe cannot handle UNC addresses) | |
382 | os.chdir("c:") |
|
382 | os.chdir("c:") | |
383 | # issue pushd to the UNC-share and then run the command |
|
383 | # issue pushd to the UNC-share and then run the command | |
384 | try: |
|
384 | try: | |
385 | shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) |
|
385 | shell_ori('"pushd %s&&"'%path+cmd,verbose,debug,header) | |
386 | finally: |
|
386 | finally: | |
387 | os.chdir(path) |
|
387 | os.chdir(path) | |
388 | else: |
|
388 | else: | |
389 | shell_ori(cmd,verbose,debug,header) |
|
389 | shell_ori(cmd,verbose,debug,header) | |
390 |
|
390 | |||
391 | shell.__doc__ = shell_ori.__doc__ |
|
391 | shell.__doc__ = shell_ori.__doc__ | |
392 |
|
392 | |||
393 | def getoutput(cmd,verbose=0,debug=0,header='',split=0): |
|
393 | def getoutput(cmd,verbose=0,debug=0,header='',split=0): | |
394 | """Dummy substitute for perl's backquotes. |
|
394 | """Dummy substitute for perl's backquotes. | |
395 |
|
395 | |||
396 | Executes a command and returns the output. |
|
396 | Executes a command and returns the output. | |
397 |
|
397 | |||
398 | Accepts the same arguments as system(), plus: |
|
398 | Accepts the same arguments as system(), plus: | |
399 |
|
399 | |||
400 | - split(0): if true, the output is returned as a list split on newlines. |
|
400 | - split(0): if true, the output is returned as a list split on newlines. | |
401 |
|
401 | |||
402 | Note: a stateful version of this function is available through the |
|
402 | Note: a stateful version of this function is available through the | |
403 | SystemExec class. |
|
403 | SystemExec class. | |
404 |
|
404 | |||
405 | This is pretty much deprecated and rarely used, |
|
405 | This is pretty much deprecated and rarely used, | |
406 | genutils.getoutputerror may be what you need. |
|
406 | genutils.getoutputerror may be what you need. | |
407 |
|
407 | |||
408 | """ |
|
408 | """ | |
409 |
|
409 | |||
410 | if verbose or debug: print header+cmd |
|
410 | if verbose or debug: print header+cmd | |
411 | if not debug: |
|
411 | if not debug: | |
412 | output = os.popen(cmd).read() |
|
412 | output = os.popen(cmd).read() | |
413 | # stipping last \n is here for backwards compat. |
|
413 | # stipping last \n is here for backwards compat. | |
414 | if output.endswith('\n'): |
|
414 | if output.endswith('\n'): | |
415 | output = output[:-1] |
|
415 | output = output[:-1] | |
416 | if split: |
|
416 | if split: | |
417 | return output.split('\n') |
|
417 | return output.split('\n') | |
418 | else: |
|
418 | else: | |
419 | return output |
|
419 | return output | |
420 |
|
420 | |||
421 | def getoutputerror(cmd,verbose=0,debug=0,header='',split=0): |
|
421 | def getoutputerror(cmd,verbose=0,debug=0,header='',split=0): | |
422 | """Return (standard output,standard error) of executing cmd in a shell. |
|
422 | """Return (standard output,standard error) of executing cmd in a shell. | |
423 |
|
423 | |||
424 | Accepts the same arguments as system(), plus: |
|
424 | Accepts the same arguments as system(), plus: | |
425 |
|
425 | |||
426 | - split(0): if true, each of stdout/err is returned as a list split on |
|
426 | - split(0): if true, each of stdout/err is returned as a list split on | |
427 | newlines. |
|
427 | newlines. | |
428 |
|
428 | |||
429 | Note: a stateful version of this function is available through the |
|
429 | Note: a stateful version of this function is available through the | |
430 | SystemExec class.""" |
|
430 | SystemExec class.""" | |
431 |
|
431 | |||
432 | if verbose or debug: print header+cmd |
|
432 | if verbose or debug: print header+cmd | |
433 | if not cmd: |
|
433 | if not cmd: | |
434 | if split: |
|
434 | if split: | |
435 | return [],[] |
|
435 | return [],[] | |
436 | else: |
|
436 | else: | |
437 | return '','' |
|
437 | return '','' | |
438 | if not debug: |
|
438 | if not debug: | |
439 | pin,pout,perr = os.popen3(cmd) |
|
439 | pin,pout,perr = os.popen3(cmd) | |
440 | tout = pout.read().rstrip() |
|
440 | tout = pout.read().rstrip() | |
441 | terr = perr.read().rstrip() |
|
441 | terr = perr.read().rstrip() | |
442 | pin.close() |
|
442 | pin.close() | |
443 | pout.close() |
|
443 | pout.close() | |
444 | perr.close() |
|
444 | perr.close() | |
445 | if split: |
|
445 | if split: | |
446 | return tout.split('\n'),terr.split('\n') |
|
446 | return tout.split('\n'),terr.split('\n') | |
447 | else: |
|
447 | else: | |
448 | return tout,terr |
|
448 | return tout,terr | |
449 |
|
449 | |||
450 | # for compatibility with older naming conventions |
|
450 | # for compatibility with older naming conventions | |
451 | xsys = system |
|
451 | xsys = system | |
452 | bq = getoutput |
|
452 | bq = getoutput | |
453 |
|
453 | |||
454 | class SystemExec: |
|
454 | class SystemExec: | |
455 | """Access the system and getoutput functions through a stateful interface. |
|
455 | """Access the system and getoutput functions through a stateful interface. | |
456 |
|
456 | |||
457 | Note: here we refer to the system and getoutput functions from this |
|
457 | Note: here we refer to the system and getoutput functions from this | |
458 | library, not the ones from the standard python library. |
|
458 | library, not the ones from the standard python library. | |
459 |
|
459 | |||
460 | This class offers the system and getoutput functions as methods, but the |
|
460 | This class offers the system and getoutput functions as methods, but the | |
461 | verbose, debug and header parameters can be set for the instance (at |
|
461 | verbose, debug and header parameters can be set for the instance (at | |
462 | creation time or later) so that they don't need to be specified on each |
|
462 | creation time or later) so that they don't need to be specified on each | |
463 | call. |
|
463 | call. | |
464 |
|
464 | |||
465 | For efficiency reasons, there's no way to override the parameters on a |
|
465 | For efficiency reasons, there's no way to override the parameters on a | |
466 | per-call basis other than by setting instance attributes. If you need |
|
466 | per-call basis other than by setting instance attributes. If you need | |
467 | local overrides, it's best to directly call system() or getoutput(). |
|
467 | local overrides, it's best to directly call system() or getoutput(). | |
468 |
|
468 | |||
469 | The following names are provided as alternate options: |
|
469 | The following names are provided as alternate options: | |
470 | - xsys: alias to system |
|
470 | - xsys: alias to system | |
471 | - bq: alias to getoutput |
|
471 | - bq: alias to getoutput | |
472 |
|
472 | |||
473 | An instance can then be created as: |
|
473 | An instance can then be created as: | |
474 | >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ') |
|
474 | >>> sysexec = SystemExec(verbose=1,debug=0,header='Calling: ') | |
475 | """ |
|
475 | """ | |
476 |
|
476 | |||
477 | def __init__(self,verbose=0,debug=0,header='',split=0): |
|
477 | def __init__(self,verbose=0,debug=0,header='',split=0): | |
478 | """Specify the instance's values for verbose, debug and header.""" |
|
478 | """Specify the instance's values for verbose, debug and header.""" | |
479 | setattr_list(self,'verbose debug header split') |
|
479 | setattr_list(self,'verbose debug header split') | |
480 |
|
480 | |||
481 | def system(self,cmd): |
|
481 | def system(self,cmd): | |
482 | """Stateful interface to system(), with the same keyword parameters.""" |
|
482 | """Stateful interface to system(), with the same keyword parameters.""" | |
483 |
|
483 | |||
484 | system(cmd,self.verbose,self.debug,self.header) |
|
484 | system(cmd,self.verbose,self.debug,self.header) | |
485 |
|
485 | |||
486 | def shell(self,cmd): |
|
486 | def shell(self,cmd): | |
487 | """Stateful interface to shell(), with the same keyword parameters.""" |
|
487 | """Stateful interface to shell(), with the same keyword parameters.""" | |
488 |
|
488 | |||
489 | shell(cmd,self.verbose,self.debug,self.header) |
|
489 | shell(cmd,self.verbose,self.debug,self.header) | |
490 |
|
490 | |||
491 | xsys = system # alias |
|
491 | xsys = system # alias | |
492 |
|
492 | |||
493 | def getoutput(self,cmd): |
|
493 | def getoutput(self,cmd): | |
494 | """Stateful interface to getoutput().""" |
|
494 | """Stateful interface to getoutput().""" | |
495 |
|
495 | |||
496 | return getoutput(cmd,self.verbose,self.debug,self.header,self.split) |
|
496 | return getoutput(cmd,self.verbose,self.debug,self.header,self.split) | |
497 |
|
497 | |||
498 | def getoutputerror(self,cmd): |
|
498 | def getoutputerror(self,cmd): | |
499 | """Stateful interface to getoutputerror().""" |
|
499 | """Stateful interface to getoutputerror().""" | |
500 |
|
500 | |||
501 | return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split) |
|
501 | return getoutputerror(cmd,self.verbose,self.debug,self.header,self.split) | |
502 |
|
502 | |||
503 | bq = getoutput # alias |
|
503 | bq = getoutput # alias | |
504 |
|
504 | |||
505 | #----------------------------------------------------------------------------- |
|
505 | #----------------------------------------------------------------------------- | |
506 | def mutex_opts(dict,ex_op): |
|
506 | def mutex_opts(dict,ex_op): | |
507 | """Check for presence of mutually exclusive keys in a dict. |
|
507 | """Check for presence of mutually exclusive keys in a dict. | |
508 |
|
508 | |||
509 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" |
|
509 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" | |
510 | for op1,op2 in ex_op: |
|
510 | for op1,op2 in ex_op: | |
511 | if op1 in dict and op2 in dict: |
|
511 | if op1 in dict and op2 in dict: | |
512 | raise ValueError,'\n*** ERROR in Arguments *** '\ |
|
512 | raise ValueError,'\n*** ERROR in Arguments *** '\ | |
513 | 'Options '+op1+' and '+op2+' are mutually exclusive.' |
|
513 | 'Options '+op1+' and '+op2+' are mutually exclusive.' | |
514 |
|
514 | |||
515 | #----------------------------------------------------------------------------- |
|
515 | #----------------------------------------------------------------------------- | |
516 | def get_py_filename(name): |
|
516 | def get_py_filename(name): | |
517 | """Return a valid python filename in the current directory. |
|
517 | """Return a valid python filename in the current directory. | |
518 |
|
518 | |||
519 | If the given name is not a file, it adds '.py' and searches again. |
|
519 | If the given name is not a file, it adds '.py' and searches again. | |
520 | Raises IOError with an informative message if the file isn't found.""" |
|
520 | Raises IOError with an informative message if the file isn't found.""" | |
521 |
|
521 | |||
522 | name = os.path.expanduser(name) |
|
522 | name = os.path.expanduser(name) | |
523 | if not os.path.isfile(name) and not name.endswith('.py'): |
|
523 | if not os.path.isfile(name) and not name.endswith('.py'): | |
524 | name += '.py' |
|
524 | name += '.py' | |
525 | if os.path.isfile(name): |
|
525 | if os.path.isfile(name): | |
526 | return name |
|
526 | return name | |
527 | else: |
|
527 | else: | |
528 | raise IOError,'File `%s` not found.' % name |
|
528 | raise IOError,'File `%s` not found.' % name | |
529 |
|
529 | |||
530 | #----------------------------------------------------------------------------- |
|
530 | #----------------------------------------------------------------------------- | |
531 | def filefind(fname,alt_dirs = None): |
|
531 | def filefind(fname,alt_dirs = None): | |
532 | """Return the given filename either in the current directory, if it |
|
532 | """Return the given filename either in the current directory, if it | |
533 | exists, or in a specified list of directories. |
|
533 | exists, or in a specified list of directories. | |
534 |
|
534 | |||
535 | ~ expansion is done on all file and directory names. |
|
535 | ~ expansion is done on all file and directory names. | |
536 |
|
536 | |||
537 | Upon an unsuccessful search, raise an IOError exception.""" |
|
537 | Upon an unsuccessful search, raise an IOError exception.""" | |
538 |
|
538 | |||
539 | if alt_dirs is None: |
|
539 | if alt_dirs is None: | |
540 | try: |
|
540 | try: | |
541 | alt_dirs = get_home_dir() |
|
541 | alt_dirs = get_home_dir() | |
542 | except HomeDirError: |
|
542 | except HomeDirError: | |
543 | alt_dirs = os.getcwd() |
|
543 | alt_dirs = os.getcwd() | |
544 | search = [fname] + list_strings(alt_dirs) |
|
544 | search = [fname] + list_strings(alt_dirs) | |
545 | search = map(os.path.expanduser,search) |
|
545 | search = map(os.path.expanduser,search) | |
546 | #print 'search list for',fname,'list:',search # dbg |
|
546 | #print 'search list for',fname,'list:',search # dbg | |
547 | fname = search[0] |
|
547 | fname = search[0] | |
548 | if os.path.isfile(fname): |
|
548 | if os.path.isfile(fname): | |
549 | return fname |
|
549 | return fname | |
550 | for direc in search[1:]: |
|
550 | for direc in search[1:]: | |
551 | testname = os.path.join(direc,fname) |
|
551 | testname = os.path.join(direc,fname) | |
552 | #print 'testname',testname # dbg |
|
552 | #print 'testname',testname # dbg | |
553 | if os.path.isfile(testname): |
|
553 | if os.path.isfile(testname): | |
554 | return testname |
|
554 | return testname | |
555 | raise IOError,'File' + `fname` + \ |
|
555 | raise IOError,'File' + `fname` + \ | |
556 | ' not found in current or supplied directories:' + `alt_dirs` |
|
556 | ' not found in current or supplied directories:' + `alt_dirs` | |
557 |
|
557 | |||
558 | #---------------------------------------------------------------------------- |
|
558 | #---------------------------------------------------------------------------- | |
559 | def file_read(filename): |
|
559 | def file_read(filename): | |
560 | """Read a file and close it. Returns the file source.""" |
|
560 | """Read a file and close it. Returns the file source.""" | |
561 | fobj = open(filename,'r'); |
|
561 | fobj = open(filename,'r'); | |
562 | source = fobj.read(); |
|
562 | source = fobj.read(); | |
563 | fobj.close() |
|
563 | fobj.close() | |
564 | return source |
|
564 | return source | |
565 |
|
565 | |||
566 | def file_readlines(filename): |
|
566 | def file_readlines(filename): | |
567 | """Read a file and close it. Returns the file source using readlines().""" |
|
567 | """Read a file and close it. Returns the file source using readlines().""" | |
568 | fobj = open(filename,'r'); |
|
568 | fobj = open(filename,'r'); | |
569 | lines = fobj.readlines(); |
|
569 | lines = fobj.readlines(); | |
570 | fobj.close() |
|
570 | fobj.close() | |
571 | return lines |
|
571 | return lines | |
572 |
|
572 | |||
573 | #---------------------------------------------------------------------------- |
|
573 | #---------------------------------------------------------------------------- | |
574 | def target_outdated(target,deps): |
|
574 | def target_outdated(target,deps): | |
575 | """Determine whether a target is out of date. |
|
575 | """Determine whether a target is out of date. | |
576 |
|
576 | |||
577 | target_outdated(target,deps) -> 1/0 |
|
577 | target_outdated(target,deps) -> 1/0 | |
578 |
|
578 | |||
579 | deps: list of filenames which MUST exist. |
|
579 | deps: list of filenames which MUST exist. | |
580 | target: single filename which may or may not exist. |
|
580 | target: single filename which may or may not exist. | |
581 |
|
581 | |||
582 | If target doesn't exist or is older than any file listed in deps, return |
|
582 | If target doesn't exist or is older than any file listed in deps, return | |
583 | true, otherwise return false. |
|
583 | true, otherwise return false. | |
584 | """ |
|
584 | """ | |
585 | try: |
|
585 | try: | |
586 | target_time = os.path.getmtime(target) |
|
586 | target_time = os.path.getmtime(target) | |
587 | except os.error: |
|
587 | except os.error: | |
588 | return 1 |
|
588 | return 1 | |
589 | for dep in deps: |
|
589 | for dep in deps: | |
590 | dep_time = os.path.getmtime(dep) |
|
590 | dep_time = os.path.getmtime(dep) | |
591 | if dep_time > target_time: |
|
591 | if dep_time > target_time: | |
592 | #print "For target",target,"Dep failed:",dep # dbg |
|
592 | #print "For target",target,"Dep failed:",dep # dbg | |
593 | #print "times (dep,tar):",dep_time,target_time # dbg |
|
593 | #print "times (dep,tar):",dep_time,target_time # dbg | |
594 | return 1 |
|
594 | return 1 | |
595 | return 0 |
|
595 | return 0 | |
596 |
|
596 | |||
597 | #----------------------------------------------------------------------------- |
|
597 | #----------------------------------------------------------------------------- | |
598 | def target_update(target,deps,cmd): |
|
598 | def target_update(target,deps,cmd): | |
599 | """Update a target with a given command given a list of dependencies. |
|
599 | """Update a target with a given command given a list of dependencies. | |
600 |
|
600 | |||
601 | target_update(target,deps,cmd) -> runs cmd if target is outdated. |
|
601 | target_update(target,deps,cmd) -> runs cmd if target is outdated. | |
602 |
|
602 | |||
603 | This is just a wrapper around target_outdated() which calls the given |
|
603 | This is just a wrapper around target_outdated() which calls the given | |
604 | command if target is outdated.""" |
|
604 | command if target is outdated.""" | |
605 |
|
605 | |||
606 | if target_outdated(target,deps): |
|
606 | if target_outdated(target,deps): | |
607 | xsys(cmd) |
|
607 | xsys(cmd) | |
608 |
|
608 | |||
609 | #---------------------------------------------------------------------------- |
|
609 | #---------------------------------------------------------------------------- | |
610 | def unquote_ends(istr): |
|
610 | def unquote_ends(istr): | |
611 | """Remove a single pair of quotes from the endpoints of a string.""" |
|
611 | """Remove a single pair of quotes from the endpoints of a string.""" | |
612 |
|
612 | |||
613 | if not istr: |
|
613 | if not istr: | |
614 | return istr |
|
614 | return istr | |
615 | if (istr[0]=="'" and istr[-1]=="'") or \ |
|
615 | if (istr[0]=="'" and istr[-1]=="'") or \ | |
616 | (istr[0]=='"' and istr[-1]=='"'): |
|
616 | (istr[0]=='"' and istr[-1]=='"'): | |
617 | return istr[1:-1] |
|
617 | return istr[1:-1] | |
618 | else: |
|
618 | else: | |
619 | return istr |
|
619 | return istr | |
620 |
|
620 | |||
621 | #---------------------------------------------------------------------------- |
|
621 | #---------------------------------------------------------------------------- | |
622 | def process_cmdline(argv,names=[],defaults={},usage=''): |
|
622 | def process_cmdline(argv,names=[],defaults={},usage=''): | |
623 | """ Process command-line options and arguments. |
|
623 | """ Process command-line options and arguments. | |
624 |
|
624 | |||
625 | Arguments: |
|
625 | Arguments: | |
626 |
|
626 | |||
627 | - argv: list of arguments, typically sys.argv. |
|
627 | - argv: list of arguments, typically sys.argv. | |
628 |
|
628 | |||
629 | - names: list of option names. See DPyGetOpt docs for details on options |
|
629 | - names: list of option names. See DPyGetOpt docs for details on options | |
630 | syntax. |
|
630 | syntax. | |
631 |
|
631 | |||
632 | - defaults: dict of default values. |
|
632 | - defaults: dict of default values. | |
633 |
|
633 | |||
634 | - usage: optional usage notice to print if a wrong argument is passed. |
|
634 | - usage: optional usage notice to print if a wrong argument is passed. | |
635 |
|
635 | |||
636 | Return a dict of options and a list of free arguments.""" |
|
636 | Return a dict of options and a list of free arguments.""" | |
637 |
|
637 | |||
638 | getopt = DPyGetOpt.DPyGetOpt() |
|
638 | getopt = DPyGetOpt.DPyGetOpt() | |
639 | getopt.setIgnoreCase(0) |
|
639 | getopt.setIgnoreCase(0) | |
640 | getopt.parseConfiguration(names) |
|
640 | getopt.parseConfiguration(names) | |
641 |
|
641 | |||
642 | try: |
|
642 | try: | |
643 | getopt.processArguments(argv) |
|
643 | getopt.processArguments(argv) | |
644 | except DPyGetOpt.ArgumentError, exc: |
|
644 | except DPyGetOpt.ArgumentError, exc: | |
645 | print usage |
|
645 | print usage | |
646 | warn('"%s"' % exc,level=4) |
|
646 | warn('"%s"' % exc,level=4) | |
647 |
|
647 | |||
648 | defaults.update(getopt.optionValues) |
|
648 | defaults.update(getopt.optionValues) | |
649 | args = getopt.freeValues |
|
649 | args = getopt.freeValues | |
650 |
|
650 | |||
651 | return defaults,args |
|
651 | return defaults,args | |
652 |
|
652 | |||
653 | #---------------------------------------------------------------------------- |
|
653 | #---------------------------------------------------------------------------- | |
654 | def optstr2types(ostr): |
|
654 | def optstr2types(ostr): | |
655 | """Convert a string of option names to a dict of type mappings. |
|
655 | """Convert a string of option names to a dict of type mappings. | |
656 |
|
656 | |||
657 | optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'} |
|
657 | optstr2types(str) -> {None:'string_opts',int:'int_opts',float:'float_opts'} | |
658 |
|
658 | |||
659 | This is used to get the types of all the options in a string formatted |
|
659 | This is used to get the types of all the options in a string formatted | |
660 | with the conventions of DPyGetOpt. The 'type' None is used for options |
|
660 | with the conventions of DPyGetOpt. The 'type' None is used for options | |
661 | which are strings (they need no further conversion). This function's main |
|
661 | which are strings (they need no further conversion). This function's main | |
662 | use is to get a typemap for use with read_dict(). |
|
662 | use is to get a typemap for use with read_dict(). | |
663 | """ |
|
663 | """ | |
664 |
|
664 | |||
665 | typeconv = {None:'',int:'',float:''} |
|
665 | typeconv = {None:'',int:'',float:''} | |
666 | typemap = {'s':None,'i':int,'f':float} |
|
666 | typemap = {'s':None,'i':int,'f':float} | |
667 | opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)') |
|
667 | opt_re = re.compile(r'([\w]*)([^:=]*:?=?)([sif]?)') | |
668 |
|
668 | |||
669 | for w in ostr.split(): |
|
669 | for w in ostr.split(): | |
670 | oname,alias,otype = opt_re.match(w).groups() |
|
670 | oname,alias,otype = opt_re.match(w).groups() | |
671 | if otype == '' or alias == '!': # simple switches are integers too |
|
671 | if otype == '' or alias == '!': # simple switches are integers too | |
672 | otype = 'i' |
|
672 | otype = 'i' | |
673 | typeconv[typemap[otype]] += oname + ' ' |
|
673 | typeconv[typemap[otype]] += oname + ' ' | |
674 | return typeconv |
|
674 | return typeconv | |
675 |
|
675 | |||
676 | #---------------------------------------------------------------------------- |
|
676 | #---------------------------------------------------------------------------- | |
677 | def read_dict(filename,type_conv=None,**opt): |
|
677 | def read_dict(filename,type_conv=None,**opt): | |
678 | r"""Read a dictionary of key=value pairs from an input file, optionally |
|
678 | r"""Read a dictionary of key=value pairs from an input file, optionally | |
679 | performing conversions on the resulting values. |
|
679 | performing conversions on the resulting values. | |
680 |
|
680 | |||
681 | read_dict(filename,type_conv,**opt) -> dict |
|
681 | read_dict(filename,type_conv,**opt) -> dict | |
682 |
|
682 | |||
683 | Only one value per line is accepted, the format should be |
|
683 | Only one value per line is accepted, the format should be | |
684 | # optional comments are ignored |
|
684 | # optional comments are ignored | |
685 | key value\n |
|
685 | key value\n | |
686 |
|
686 | |||
687 | Args: |
|
687 | Args: | |
688 |
|
688 | |||
689 | - type_conv: A dictionary specifying which keys need to be converted to |
|
689 | - type_conv: A dictionary specifying which keys need to be converted to | |
690 | which types. By default all keys are read as strings. This dictionary |
|
690 | which types. By default all keys are read as strings. This dictionary | |
691 | should have as its keys valid conversion functions for strings |
|
691 | should have as its keys valid conversion functions for strings | |
692 | (int,long,float,complex, or your own). The value for each key |
|
692 | (int,long,float,complex, or your own). The value for each key | |
693 | (converter) should be a whitespace separated string containing the names |
|
693 | (converter) should be a whitespace separated string containing the names | |
694 | of all the entries in the file to be converted using that function. For |
|
694 | of all the entries in the file to be converted using that function. For | |
695 | keys to be left alone, use None as the conversion function (only needed |
|
695 | keys to be left alone, use None as the conversion function (only needed | |
696 | with purge=1, see below). |
|
696 | with purge=1, see below). | |
697 |
|
697 | |||
698 | - opt: dictionary with extra options as below (default in parens) |
|
698 | - opt: dictionary with extra options as below (default in parens) | |
699 |
|
699 | |||
700 | purge(0): if set to 1, all keys *not* listed in type_conv are purged out |
|
700 | purge(0): if set to 1, all keys *not* listed in type_conv are purged out | |
701 | of the dictionary to be returned. If purge is going to be used, the |
|
701 | of the dictionary to be returned. If purge is going to be used, the | |
702 | set of keys to be left as strings also has to be explicitly specified |
|
702 | set of keys to be left as strings also has to be explicitly specified | |
703 | using the (non-existent) conversion function None. |
|
703 | using the (non-existent) conversion function None. | |
704 |
|
704 | |||
705 | fs(None): field separator. This is the key/value separator to be used |
|
705 | fs(None): field separator. This is the key/value separator to be used | |
706 | when parsing the file. The None default means any whitespace [behavior |
|
706 | when parsing the file. The None default means any whitespace [behavior | |
707 | of string.split()]. |
|
707 | of string.split()]. | |
708 |
|
708 | |||
709 | strip(0): if 1, strip string values of leading/trailinig whitespace. |
|
709 | strip(0): if 1, strip string values of leading/trailinig whitespace. | |
710 |
|
710 | |||
711 | warn(1): warning level if requested keys are not found in file. |
|
711 | warn(1): warning level if requested keys are not found in file. | |
712 | - 0: silently ignore. |
|
712 | - 0: silently ignore. | |
713 | - 1: inform but proceed. |
|
713 | - 1: inform but proceed. | |
714 | - 2: raise KeyError exception. |
|
714 | - 2: raise KeyError exception. | |
715 |
|
715 | |||
716 | no_empty(0): if 1, remove keys with whitespace strings as a value. |
|
716 | no_empty(0): if 1, remove keys with whitespace strings as a value. | |
717 |
|
717 | |||
718 | unique([]): list of keys (or space separated string) which can't be |
|
718 | unique([]): list of keys (or space separated string) which can't be | |
719 | repeated. If one such key is found in the file, each new instance |
|
719 | repeated. If one such key is found in the file, each new instance | |
720 | overwrites the previous one. For keys not listed here, the behavior is |
|
720 | overwrites the previous one. For keys not listed here, the behavior is | |
721 | to make a list of all appearances. |
|
721 | to make a list of all appearances. | |
722 |
|
722 | |||
723 | Example: |
|
723 | Example: | |
724 |
|
724 | |||
725 | If the input file test.ini contains (we put it in a string to keep the test |
|
725 | If the input file test.ini contains (we put it in a string to keep the test | |
726 | self-contained): |
|
726 | self-contained): | |
727 |
|
727 | |||
728 | >>> test_ini = '''\ |
|
728 | >>> test_ini = '''\ | |
729 | ... i 3 |
|
729 | ... i 3 | |
730 | ... x 4.5 |
|
730 | ... x 4.5 | |
731 | ... y 5.5 |
|
731 | ... y 5.5 | |
732 | ... s hi ho''' |
|
732 | ... s hi ho''' | |
733 |
|
733 | |||
734 | Then we can use it as follows: |
|
734 | Then we can use it as follows: | |
735 | >>> type_conv={int:'i',float:'x',None:'s'} |
|
735 | >>> type_conv={int:'i',float:'x',None:'s'} | |
736 |
|
736 | |||
737 | >>> d = read_dict(test_ini) |
|
737 | >>> d = read_dict(test_ini) | |
738 |
|
738 | |||
739 | >>> sorted(d.items()) |
|
739 | >>> sorted(d.items()) | |
740 | [('i', '3'), ('s', 'hi ho'), ('x', '4.5'), ('y', '5.5')] |
|
740 | [('i', '3'), ('s', 'hi ho'), ('x', '4.5'), ('y', '5.5')] | |
741 |
|
741 | |||
742 | >>> d = read_dict(test_ini,type_conv) |
|
742 | >>> d = read_dict(test_ini,type_conv) | |
743 |
|
743 | |||
744 | >>> sorted(d.items()) |
|
744 | >>> sorted(d.items()) | |
745 | [('i', 3), ('s', 'hi ho'), ('x', 4.5), ('y', '5.5')] |
|
745 | [('i', 3), ('s', 'hi ho'), ('x', 4.5), ('y', '5.5')] | |
746 |
|
746 | |||
747 | >>> d = read_dict(test_ini,type_conv,purge=True) |
|
747 | >>> d = read_dict(test_ini,type_conv,purge=True) | |
748 |
|
748 | |||
749 | >>> sorted(d.items()) |
|
749 | >>> sorted(d.items()) | |
750 | [('i', 3), ('s', 'hi ho'), ('x', 4.5)] |
|
750 | [('i', 3), ('s', 'hi ho'), ('x', 4.5)] | |
751 | """ |
|
751 | """ | |
752 |
|
752 | |||
753 | # starting config |
|
753 | # starting config | |
754 | opt.setdefault('purge',0) |
|
754 | opt.setdefault('purge',0) | |
755 | opt.setdefault('fs',None) # field sep defaults to any whitespace |
|
755 | opt.setdefault('fs',None) # field sep defaults to any whitespace | |
756 | opt.setdefault('strip',0) |
|
756 | opt.setdefault('strip',0) | |
757 | opt.setdefault('warn',1) |
|
757 | opt.setdefault('warn',1) | |
758 | opt.setdefault('no_empty',0) |
|
758 | opt.setdefault('no_empty',0) | |
759 | opt.setdefault('unique','') |
|
759 | opt.setdefault('unique','') | |
760 | if type(opt['unique']) in StringTypes: |
|
760 | if type(opt['unique']) in StringTypes: | |
761 | unique_keys = qw(opt['unique']) |
|
761 | unique_keys = qw(opt['unique']) | |
762 | elif type(opt['unique']) in (types.TupleType,types.ListType): |
|
762 | elif type(opt['unique']) in (types.TupleType,types.ListType): | |
763 | unique_keys = opt['unique'] |
|
763 | unique_keys = opt['unique'] | |
764 | else: |
|
764 | else: | |
765 | raise ValueError, 'Unique keys must be given as a string, List or Tuple' |
|
765 | raise ValueError, 'Unique keys must be given as a string, List or Tuple' | |
766 |
|
766 | |||
767 | dict = {} |
|
767 | dict = {} | |
768 |
|
768 | |||
769 | # first read in table of values as strings |
|
769 | # first read in table of values as strings | |
770 | if '\n' in filename: |
|
770 | if '\n' in filename: | |
771 | lines = filename.splitlines() |
|
771 | lines = filename.splitlines() | |
772 | file = None |
|
772 | file = None | |
773 | else: |
|
773 | else: | |
774 | file = open(filename,'r') |
|
774 | file = open(filename,'r') | |
775 | lines = file.readlines() |
|
775 | lines = file.readlines() | |
776 | for line in lines: |
|
776 | for line in lines: | |
777 | line = line.strip() |
|
777 | line = line.strip() | |
778 | if len(line) and line[0]=='#': continue |
|
778 | if len(line) and line[0]=='#': continue | |
779 | if len(line)>0: |
|
779 | if len(line)>0: | |
780 | lsplit = line.split(opt['fs'],1) |
|
780 | lsplit = line.split(opt['fs'],1) | |
781 | try: |
|
781 | try: | |
782 | key,val = lsplit |
|
782 | key,val = lsplit | |
783 | except ValueError: |
|
783 | except ValueError: | |
784 | key,val = lsplit[0],'' |
|
784 | key,val = lsplit[0],'' | |
785 | key = key.strip() |
|
785 | key = key.strip() | |
786 | if opt['strip']: val = val.strip() |
|
786 | if opt['strip']: val = val.strip() | |
787 | if val == "''" or val == '""': val = '' |
|
787 | if val == "''" or val == '""': val = '' | |
788 | if opt['no_empty'] and (val=='' or val.isspace()): |
|
788 | if opt['no_empty'] and (val=='' or val.isspace()): | |
789 | continue |
|
789 | continue | |
790 | # if a key is found more than once in the file, build a list |
|
790 | # if a key is found more than once in the file, build a list | |
791 | # unless it's in the 'unique' list. In that case, last found in file |
|
791 | # unless it's in the 'unique' list. In that case, last found in file | |
792 | # takes precedence. User beware. |
|
792 | # takes precedence. User beware. | |
793 | try: |
|
793 | try: | |
794 | if dict[key] and key in unique_keys: |
|
794 | if dict[key] and key in unique_keys: | |
795 | dict[key] = val |
|
795 | dict[key] = val | |
796 | elif type(dict[key]) is types.ListType: |
|
796 | elif type(dict[key]) is types.ListType: | |
797 | dict[key].append(val) |
|
797 | dict[key].append(val) | |
798 | else: |
|
798 | else: | |
799 | dict[key] = [dict[key],val] |
|
799 | dict[key] = [dict[key],val] | |
800 | except KeyError: |
|
800 | except KeyError: | |
801 | dict[key] = val |
|
801 | dict[key] = val | |
802 | # purge if requested |
|
802 | # purge if requested | |
803 | if opt['purge']: |
|
803 | if opt['purge']: | |
804 | accepted_keys = qwflat(type_conv.values()) |
|
804 | accepted_keys = qwflat(type_conv.values()) | |
805 | for key in dict.keys(): |
|
805 | for key in dict.keys(): | |
806 | if key in accepted_keys: continue |
|
806 | if key in accepted_keys: continue | |
807 | del(dict[key]) |
|
807 | del(dict[key]) | |
808 | # now convert if requested |
|
808 | # now convert if requested | |
809 | if type_conv==None: return dict |
|
809 | if type_conv==None: return dict | |
810 | conversions = type_conv.keys() |
|
810 | conversions = type_conv.keys() | |
811 | try: conversions.remove(None) |
|
811 | try: conversions.remove(None) | |
812 | except: pass |
|
812 | except: pass | |
813 | for convert in conversions: |
|
813 | for convert in conversions: | |
814 | for val in qw(type_conv[convert]): |
|
814 | for val in qw(type_conv[convert]): | |
815 | try: |
|
815 | try: | |
816 | dict[val] = convert(dict[val]) |
|
816 | dict[val] = convert(dict[val]) | |
817 | except KeyError,e: |
|
817 | except KeyError,e: | |
818 | if opt['warn'] == 0: |
|
818 | if opt['warn'] == 0: | |
819 | pass |
|
819 | pass | |
820 | elif opt['warn'] == 1: |
|
820 | elif opt['warn'] == 1: | |
821 | print >>sys.stderr, 'Warning: key',val,\ |
|
821 | print >>sys.stderr, 'Warning: key',val,\ | |
822 | 'not found in file',filename |
|
822 | 'not found in file',filename | |
823 | elif opt['warn'] == 2: |
|
823 | elif opt['warn'] == 2: | |
824 | raise KeyError,e |
|
824 | raise KeyError,e | |
825 | else: |
|
825 | else: | |
826 | raise ValueError,'Warning level must be 0,1 or 2' |
|
826 | raise ValueError,'Warning level must be 0,1 or 2' | |
827 |
|
827 | |||
828 | return dict |
|
828 | return dict | |
829 |
|
829 | |||
830 | #---------------------------------------------------------------------------- |
|
830 | #---------------------------------------------------------------------------- | |
831 | def flag_calls(func): |
|
831 | def flag_calls(func): | |
832 | """Wrap a function to detect and flag when it gets called. |
|
832 | """Wrap a function to detect and flag when it gets called. | |
833 |
|
833 | |||
834 | This is a decorator which takes a function and wraps it in a function with |
|
834 | This is a decorator which takes a function and wraps it in a function with | |
835 | a 'called' attribute. wrapper.called is initialized to False. |
|
835 | a 'called' attribute. wrapper.called is initialized to False. | |
836 |
|
836 | |||
837 | The wrapper.called attribute is set to False right before each call to the |
|
837 | The wrapper.called attribute is set to False right before each call to the | |
838 | wrapped function, so if the call fails it remains False. After the call |
|
838 | wrapped function, so if the call fails it remains False. After the call | |
839 | completes, wrapper.called is set to True and the output is returned. |
|
839 | completes, wrapper.called is set to True and the output is returned. | |
840 |
|
840 | |||
841 | Testing for truth in wrapper.called allows you to determine if a call to |
|
841 | Testing for truth in wrapper.called allows you to determine if a call to | |
842 | func() was attempted and succeeded.""" |
|
842 | func() was attempted and succeeded.""" | |
843 |
|
843 | |||
844 | def wrapper(*args,**kw): |
|
844 | def wrapper(*args,**kw): | |
845 | wrapper.called = False |
|
845 | wrapper.called = False | |
846 | out = func(*args,**kw) |
|
846 | out = func(*args,**kw) | |
847 | wrapper.called = True |
|
847 | wrapper.called = True | |
848 | return out |
|
848 | return out | |
849 |
|
849 | |||
850 | wrapper.called = False |
|
850 | wrapper.called = False | |
851 | wrapper.__doc__ = func.__doc__ |
|
851 | wrapper.__doc__ = func.__doc__ | |
852 | return wrapper |
|
852 | return wrapper | |
853 |
|
853 | |||
854 | #---------------------------------------------------------------------------- |
|
854 | #---------------------------------------------------------------------------- | |
855 | def dhook_wrap(func,*a,**k): |
|
855 | def dhook_wrap(func,*a,**k): | |
856 | """Wrap a function call in a sys.displayhook controller. |
|
856 | """Wrap a function call in a sys.displayhook controller. | |
857 |
|
857 | |||
858 | Returns a wrapper around func which calls func, with all its arguments and |
|
858 | Returns a wrapper around func which calls func, with all its arguments and | |
859 | keywords unmodified, using the default sys.displayhook. Since IPython |
|
859 | keywords unmodified, using the default sys.displayhook. Since IPython | |
860 | modifies sys.displayhook, it breaks the behavior of certain systems that |
|
860 | modifies sys.displayhook, it breaks the behavior of certain systems that | |
861 | rely on the default behavior, notably doctest. |
|
861 | rely on the default behavior, notably doctest. | |
862 | """ |
|
862 | """ | |
863 |
|
863 | |||
864 | def f(*a,**k): |
|
864 | def f(*a,**k): | |
865 |
|
865 | |||
866 | dhook_s = sys.displayhook |
|
866 | dhook_s = sys.displayhook | |
867 | sys.displayhook = sys.__displayhook__ |
|
867 | sys.displayhook = sys.__displayhook__ | |
868 | try: |
|
868 | try: | |
869 | out = func(*a,**k) |
|
869 | out = func(*a,**k) | |
870 | finally: |
|
870 | finally: | |
871 | sys.displayhook = dhook_s |
|
871 | sys.displayhook = dhook_s | |
872 |
|
872 | |||
873 | return out |
|
873 | return out | |
874 |
|
874 | |||
875 | f.__doc__ = func.__doc__ |
|
875 | f.__doc__ = func.__doc__ | |
876 | return f |
|
876 | return f | |
877 |
|
877 | |||
878 | #---------------------------------------------------------------------------- |
|
878 | #---------------------------------------------------------------------------- | |
879 | def doctest_reload(): |
|
879 | def doctest_reload(): | |
880 | """Properly reload doctest to reuse it interactively. |
|
880 | """Properly reload doctest to reuse it interactively. | |
881 |
|
881 | |||
882 | This routine: |
|
882 | This routine: | |
883 |
|
883 | |||
884 | - reloads doctest |
|
884 | - reloads doctest | |
885 |
|
885 | |||
886 | - resets its global 'master' attribute to None, so that multiple uses of |
|
886 | - resets its global 'master' attribute to None, so that multiple uses of | |
887 | the module interactively don't produce cumulative reports. |
|
887 | the module interactively don't produce cumulative reports. | |
888 |
|
888 | |||
889 | - Monkeypatches its core test runner method to protect it from IPython's |
|
889 | - Monkeypatches its core test runner method to protect it from IPython's | |
890 | modified displayhook. Doctest expects the default displayhook behavior |
|
890 | modified displayhook. Doctest expects the default displayhook behavior | |
891 | deep down, so our modification breaks it completely. For this reason, a |
|
891 | deep down, so our modification breaks it completely. For this reason, a | |
892 | hard monkeypatch seems like a reasonable solution rather than asking |
|
892 | hard monkeypatch seems like a reasonable solution rather than asking | |
893 | users to manually use a different doctest runner when under IPython.""" |
|
893 | users to manually use a different doctest runner when under IPython.""" | |
894 |
|
894 | |||
895 | import doctest |
|
895 | import doctest | |
896 | reload(doctest) |
|
896 | reload(doctest) | |
897 | doctest.master=None |
|
897 | doctest.master=None | |
898 |
|
898 | |||
899 | try: |
|
899 | try: | |
900 | doctest.DocTestRunner |
|
900 | doctest.DocTestRunner | |
901 | except AttributeError: |
|
901 | except AttributeError: | |
902 | # This is only for python 2.3 compatibility, remove once we move to |
|
902 | # This is only for python 2.3 compatibility, remove once we move to | |
903 | # 2.4 only. |
|
903 | # 2.4 only. | |
904 | pass |
|
904 | pass | |
905 | else: |
|
905 | else: | |
906 | doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run) |
|
906 | doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run) | |
907 |
|
907 | |||
908 | #---------------------------------------------------------------------------- |
|
908 | #---------------------------------------------------------------------------- | |
909 | class HomeDirError(Error): |
|
909 | class HomeDirError(Error): | |
910 | pass |
|
910 | pass | |
911 |
|
911 | |||
912 | def get_home_dir(): |
|
912 | def get_home_dir(): | |
913 | """Return the closest possible equivalent to a 'home' directory. |
|
913 | """Return the closest possible equivalent to a 'home' directory. | |
914 |
|
914 | |||
915 | We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH. |
|
915 | We first try $HOME. Absent that, on NT it's $HOMEDRIVE\$HOMEPATH. | |
916 |
|
916 | |||
917 | Currently only Posix and NT are implemented, a HomeDirError exception is |
|
917 | Currently only Posix and NT are implemented, a HomeDirError exception is | |
918 | raised for all other OSes. """ |
|
918 | raised for all other OSes. """ | |
919 |
|
919 | |||
920 | isdir = os.path.isdir |
|
920 | isdir = os.path.isdir | |
921 | env = os.environ |
|
921 | env = os.environ | |
922 |
|
922 | |||
923 | # first, check py2exe distribution root directory for _ipython. |
|
923 | # first, check py2exe distribution root directory for _ipython. | |
924 | # This overrides all. Normally does not exist. |
|
924 | # This overrides all. Normally does not exist. | |
925 |
|
925 | |||
926 | if hasattr(sys, "frozen"): #Is frozen by py2exe |
|
926 | if hasattr(sys, "frozen"): #Is frozen by py2exe | |
927 | if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file |
|
927 | if '\\library.zip\\' in IPython.__file__.lower():#libraries compressed to zip-file | |
928 | root, rest = IPython.__file__.lower().split('library.zip') |
|
928 | root, rest = IPython.__file__.lower().split('library.zip') | |
929 | else: |
|
929 | else: | |
930 | root=os.path.join(os.path.split(IPython.__file__)[0],"../../") |
|
930 | root=os.path.join(os.path.split(IPython.__file__)[0],"../../") | |
931 | root=os.path.abspath(root).rstrip('\\') |
|
931 | root=os.path.abspath(root).rstrip('\\') | |
932 | if isdir(os.path.join(root, '_ipython')): |
|
932 | if isdir(os.path.join(root, '_ipython')): | |
933 | os.environ["IPYKITROOT"] = root |
|
933 | os.environ["IPYKITROOT"] = root | |
934 | return root |
|
934 | return root | |
935 | try: |
|
935 | try: | |
936 | homedir = env['HOME'] |
|
936 | homedir = env['HOME'] | |
937 | if not isdir(homedir): |
|
937 | if not isdir(homedir): | |
938 | # in case a user stuck some string which does NOT resolve to a |
|
938 | # in case a user stuck some string which does NOT resolve to a | |
939 | # valid path, it's as good as if we hadn't foud it |
|
939 | # valid path, it's as good as if we hadn't foud it | |
940 | raise KeyError |
|
940 | raise KeyError | |
941 | return homedir |
|
941 | return homedir | |
942 | except KeyError: |
|
942 | except KeyError: | |
943 | if os.name == 'posix': |
|
943 | if os.name == 'posix': | |
944 | raise HomeDirError,'undefined $HOME, IPython can not proceed.' |
|
944 | raise HomeDirError,'undefined $HOME, IPython can not proceed.' | |
945 | elif os.name == 'nt': |
|
945 | elif os.name == 'nt': | |
946 | # For some strange reason, win9x returns 'nt' for os.name. |
|
946 | # For some strange reason, win9x returns 'nt' for os.name. | |
947 | try: |
|
947 | try: | |
948 | homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH']) |
|
948 | homedir = os.path.join(env['HOMEDRIVE'],env['HOMEPATH']) | |
949 | if not isdir(homedir): |
|
949 | if not isdir(homedir): | |
950 | homedir = os.path.join(env['USERPROFILE']) |
|
950 | homedir = os.path.join(env['USERPROFILE']) | |
951 | if not isdir(homedir): |
|
951 | if not isdir(homedir): | |
952 | raise HomeDirError |
|
952 | raise HomeDirError | |
953 | return homedir |
|
953 | return homedir | |
954 | except KeyError: |
|
954 | except KeyError: | |
955 | try: |
|
955 | try: | |
956 | # Use the registry to get the 'My Documents' folder. |
|
956 | # Use the registry to get the 'My Documents' folder. | |
957 | import _winreg as wreg |
|
957 | import _winreg as wreg | |
958 | key = wreg.OpenKey(wreg.HKEY_CURRENT_USER, |
|
958 | key = wreg.OpenKey(wreg.HKEY_CURRENT_USER, | |
959 | "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") |
|
959 | "Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") | |
960 | homedir = wreg.QueryValueEx(key,'Personal')[0] |
|
960 | homedir = wreg.QueryValueEx(key,'Personal')[0] | |
961 | key.Close() |
|
961 | key.Close() | |
962 | if not isdir(homedir): |
|
962 | if not isdir(homedir): | |
963 | e = ('Invalid "Personal" folder registry key ' |
|
963 | e = ('Invalid "Personal" folder registry key ' | |
964 | 'typically "My Documents".\n' |
|
964 | 'typically "My Documents".\n' | |
965 | 'Value: %s\n' |
|
965 | 'Value: %s\n' | |
966 | 'This is not a valid directory on your system.' % |
|
966 | 'This is not a valid directory on your system.' % | |
967 | homedir) |
|
967 | homedir) | |
968 | raise HomeDirError(e) |
|
968 | raise HomeDirError(e) | |
969 | return homedir |
|
969 | return homedir | |
970 | except HomeDirError: |
|
970 | except HomeDirError: | |
971 | raise |
|
971 | raise | |
972 | except: |
|
972 | except: | |
973 | return 'C:\\' |
|
973 | return 'C:\\' | |
974 | elif os.name == 'dos': |
|
974 | elif os.name == 'dos': | |
975 | # Desperate, may do absurd things in classic MacOS. May work under DOS. |
|
975 | # Desperate, may do absurd things in classic MacOS. May work under DOS. | |
976 | return 'C:\\' |
|
976 | return 'C:\\' | |
977 | else: |
|
977 | else: | |
978 | raise HomeDirError,'support for your operating system not implemented.' |
|
978 | raise HomeDirError,'support for your operating system not implemented.' | |
979 |
|
979 | |||
980 |
|
980 | |||
981 | def get_ipython_dir(): |
|
981 | def get_ipython_dir(): | |
982 | """Get the IPython directory for this platform and user. |
|
982 | """Get the IPython directory for this platform and user. | |
983 |
|
983 | |||
984 | This uses the logic in `get_home_dir` to find the home directory |
|
984 | This uses the logic in `get_home_dir` to find the home directory | |
985 | and the adds either .ipython or _ipython to the end of the path. |
|
985 | and the adds either .ipython or _ipython to the end of the path. | |
986 | """ |
|
986 | """ | |
987 | if os.name == 'posix': |
|
987 | if os.name == 'posix': | |
988 | ipdir_def = '.ipython' |
|
988 | ipdir_def = '.ipython' | |
989 | else: |
|
989 | else: | |
990 | ipdir_def = '_ipython' |
|
990 | ipdir_def = '_ipython' | |
991 | home_dir = get_home_dir() |
|
991 | home_dir = get_home_dir() | |
992 | ipdir = os.path.abspath(os.environ.get('IPYTHONDIR', |
|
992 | ipdir = os.path.abspath(os.environ.get('IPYTHONDIR', | |
993 | os.path.join(home_dir, ipdir_def))) |
|
993 | os.path.join(home_dir, ipdir_def))) | |
994 | return ipdir.decode(sys.getfilesystemencoding()) |
|
994 | return ipdir.decode(sys.getfilesystemencoding()) | |
995 |
|
995 | |||
996 | def get_security_dir(): |
|
996 | def get_security_dir(): | |
997 | """Get the IPython security directory. |
|
997 | """Get the IPython security directory. | |
998 |
|
998 | |||
999 | This directory is the default location for all security related files, |
|
999 | This directory is the default location for all security related files, | |
1000 | including SSL/TLS certificates and FURL files. |
|
1000 | including SSL/TLS certificates and FURL files. | |
1001 |
|
1001 | |||
1002 | If the directory does not exist, it is created with 0700 permissions. |
|
1002 | If the directory does not exist, it is created with 0700 permissions. | |
1003 | If it exists, permissions are set to 0700. |
|
1003 | If it exists, permissions are set to 0700. | |
1004 | """ |
|
1004 | """ | |
1005 | security_dir = os.path.join(get_ipython_dir(), 'security') |
|
1005 | security_dir = os.path.join(get_ipython_dir(), 'security') | |
1006 | if not os.path.isdir(security_dir): |
|
1006 | if not os.path.isdir(security_dir): | |
1007 | os.mkdir(security_dir, 0700) |
|
1007 | os.mkdir(security_dir, 0700) | |
1008 | else: |
|
1008 | else: | |
1009 | os.chmod(security_dir, 0700) |
|
1009 | os.chmod(security_dir, 0700) | |
1010 | return security_dir |
|
1010 | return security_dir | |
1011 |
|
1011 | |||
1012 | def get_log_dir(): |
|
1012 | def get_log_dir(): | |
1013 | """Get the IPython log directory. |
|
1013 | """Get the IPython log directory. | |
1014 |
|
1014 | |||
1015 | If the log directory does not exist, it is created. |
|
1015 | If the log directory does not exist, it is created. | |
1016 | """ |
|
1016 | """ | |
1017 | log_dir = os.path.join(get_ipython_dir(), 'log') |
|
1017 | log_dir = os.path.join(get_ipython_dir(), 'log') | |
1018 | if not os.path.isdir(log_dir): |
|
1018 | if not os.path.isdir(log_dir): | |
1019 | os.mkdir(log_dir, 0777) |
|
1019 | os.mkdir(log_dir, 0777) | |
1020 | return log_dir |
|
1020 | return log_dir | |
1021 |
|
1021 | |||
1022 | #**************************************************************************** |
|
1022 | #**************************************************************************** | |
1023 | # strings and text |
|
1023 | # strings and text | |
1024 |
|
1024 | |||
1025 | class LSString(str): |
|
1025 | class LSString(str): | |
1026 | """String derivative with a special access attributes. |
|
1026 | """String derivative with a special access attributes. | |
1027 |
|
1027 | |||
1028 | These are normal strings, but with the special attributes: |
|
1028 | These are normal strings, but with the special attributes: | |
1029 |
|
1029 | |||
1030 | .l (or .list) : value as list (split on newlines). |
|
1030 | .l (or .list) : value as list (split on newlines). | |
1031 | .n (or .nlstr): original value (the string itself). |
|
1031 | .n (or .nlstr): original value (the string itself). | |
1032 | .s (or .spstr): value as whitespace-separated string. |
|
1032 | .s (or .spstr): value as whitespace-separated string. | |
1033 | .p (or .paths): list of path objects |
|
1033 | .p (or .paths): list of path objects | |
1034 |
|
1034 | |||
1035 | Any values which require transformations are computed only once and |
|
1035 | Any values which require transformations are computed only once and | |
1036 | cached. |
|
1036 | cached. | |
1037 |
|
1037 | |||
1038 | Such strings are very useful to efficiently interact with the shell, which |
|
1038 | Such strings are very useful to efficiently interact with the shell, which | |
1039 | typically only understands whitespace-separated options for commands.""" |
|
1039 | typically only understands whitespace-separated options for commands.""" | |
1040 |
|
1040 | |||
1041 | def get_list(self): |
|
1041 | def get_list(self): | |
1042 | try: |
|
1042 | try: | |
1043 | return self.__list |
|
1043 | return self.__list | |
1044 | except AttributeError: |
|
1044 | except AttributeError: | |
1045 | self.__list = self.split('\n') |
|
1045 | self.__list = self.split('\n') | |
1046 | return self.__list |
|
1046 | return self.__list | |
1047 |
|
1047 | |||
1048 | l = list = property(get_list) |
|
1048 | l = list = property(get_list) | |
1049 |
|
1049 | |||
1050 | def get_spstr(self): |
|
1050 | def get_spstr(self): | |
1051 | try: |
|
1051 | try: | |
1052 | return self.__spstr |
|
1052 | return self.__spstr | |
1053 | except AttributeError: |
|
1053 | except AttributeError: | |
1054 | self.__spstr = self.replace('\n',' ') |
|
1054 | self.__spstr = self.replace('\n',' ') | |
1055 | return self.__spstr |
|
1055 | return self.__spstr | |
1056 |
|
1056 | |||
1057 | s = spstr = property(get_spstr) |
|
1057 | s = spstr = property(get_spstr) | |
1058 |
|
1058 | |||
1059 | def get_nlstr(self): |
|
1059 | def get_nlstr(self): | |
1060 | return self |
|
1060 | return self | |
1061 |
|
1061 | |||
1062 | n = nlstr = property(get_nlstr) |
|
1062 | n = nlstr = property(get_nlstr) | |
1063 |
|
1063 | |||
1064 | def get_paths(self): |
|
1064 | def get_paths(self): | |
1065 | try: |
|
1065 | try: | |
1066 | return self.__paths |
|
1066 | return self.__paths | |
1067 | except AttributeError: |
|
1067 | except AttributeError: | |
1068 | self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)] |
|
1068 | self.__paths = [path(p) for p in self.split('\n') if os.path.exists(p)] | |
1069 | return self.__paths |
|
1069 | return self.__paths | |
1070 |
|
1070 | |||
1071 | p = paths = property(get_paths) |
|
1071 | p = paths = property(get_paths) | |
1072 |
|
1072 | |||
1073 | def print_lsstring(arg): |
|
1073 | def print_lsstring(arg): | |
1074 | """ Prettier (non-repr-like) and more informative printer for LSString """ |
|
1074 | """ Prettier (non-repr-like) and more informative printer for LSString """ | |
1075 | print "LSString (.p, .n, .l, .s available). Value:" |
|
1075 | print "LSString (.p, .n, .l, .s available). Value:" | |
1076 | print arg |
|
1076 | print arg | |
1077 |
|
1077 | |||
1078 | print_lsstring = result_display.when_type(LSString)(print_lsstring) |
|
1078 | print_lsstring = result_display.when_type(LSString)(print_lsstring) | |
1079 |
|
1079 | |||
1080 | #---------------------------------------------------------------------------- |
|
1080 | #---------------------------------------------------------------------------- | |
1081 | class SList(list): |
|
1081 | class SList(list): | |
1082 | """List derivative with a special access attributes. |
|
1082 | """List derivative with a special access attributes. | |
1083 |
|
1083 | |||
1084 | These are normal lists, but with the special attributes: |
|
1084 | These are normal lists, but with the special attributes: | |
1085 |
|
1085 | |||
1086 | .l (or .list) : value as list (the list itself). |
|
1086 | .l (or .list) : value as list (the list itself). | |
1087 | .n (or .nlstr): value as a string, joined on newlines. |
|
1087 | .n (or .nlstr): value as a string, joined on newlines. | |
1088 | .s (or .spstr): value as a string, joined on spaces. |
|
1088 | .s (or .spstr): value as a string, joined on spaces. | |
1089 | .p (or .paths): list of path objects |
|
1089 | .p (or .paths): list of path objects | |
1090 |
|
1090 | |||
1091 | Any values which require transformations are computed only once and |
|
1091 | Any values which require transformations are computed only once and | |
1092 | cached.""" |
|
1092 | cached.""" | |
1093 |
|
1093 | |||
1094 | def get_list(self): |
|
1094 | def get_list(self): | |
1095 | return self |
|
1095 | return self | |
1096 |
|
1096 | |||
1097 | l = list = property(get_list) |
|
1097 | l = list = property(get_list) | |
1098 |
|
1098 | |||
1099 | def get_spstr(self): |
|
1099 | def get_spstr(self): | |
1100 | try: |
|
1100 | try: | |
1101 | return self.__spstr |
|
1101 | return self.__spstr | |
1102 | except AttributeError: |
|
1102 | except AttributeError: | |
1103 | self.__spstr = ' '.join(self) |
|
1103 | self.__spstr = ' '.join(self) | |
1104 | return self.__spstr |
|
1104 | return self.__spstr | |
1105 |
|
1105 | |||
1106 | s = spstr = property(get_spstr) |
|
1106 | s = spstr = property(get_spstr) | |
1107 |
|
1107 | |||
1108 | def get_nlstr(self): |
|
1108 | def get_nlstr(self): | |
1109 | try: |
|
1109 | try: | |
1110 | return self.__nlstr |
|
1110 | return self.__nlstr | |
1111 | except AttributeError: |
|
1111 | except AttributeError: | |
1112 | self.__nlstr = '\n'.join(self) |
|
1112 | self.__nlstr = '\n'.join(self) | |
1113 | return self.__nlstr |
|
1113 | return self.__nlstr | |
1114 |
|
1114 | |||
1115 | n = nlstr = property(get_nlstr) |
|
1115 | n = nlstr = property(get_nlstr) | |
1116 |
|
1116 | |||
1117 | def get_paths(self): |
|
1117 | def get_paths(self): | |
1118 | try: |
|
1118 | try: | |
1119 | return self.__paths |
|
1119 | return self.__paths | |
1120 | except AttributeError: |
|
1120 | except AttributeError: | |
1121 | self.__paths = [path(p) for p in self if os.path.exists(p)] |
|
1121 | self.__paths = [path(p) for p in self if os.path.exists(p)] | |
1122 | return self.__paths |
|
1122 | return self.__paths | |
1123 |
|
1123 | |||
1124 | p = paths = property(get_paths) |
|
1124 | p = paths = property(get_paths) | |
1125 |
|
1125 | |||
1126 | def grep(self, pattern, prune = False, field = None): |
|
1126 | def grep(self, pattern, prune = False, field = None): | |
1127 | """ Return all strings matching 'pattern' (a regex or callable) |
|
1127 | """ Return all strings matching 'pattern' (a regex or callable) | |
1128 |
|
1128 | |||
1129 | This is case-insensitive. If prune is true, return all items |
|
1129 | This is case-insensitive. If prune is true, return all items | |
1130 | NOT matching the pattern. |
|
1130 | NOT matching the pattern. | |
1131 |
|
1131 | |||
1132 | If field is specified, the match must occur in the specified |
|
1132 | If field is specified, the match must occur in the specified | |
1133 | whitespace-separated field. |
|
1133 | whitespace-separated field. | |
1134 |
|
1134 | |||
1135 | Examples:: |
|
1135 | Examples:: | |
1136 |
|
1136 | |||
1137 | a.grep( lambda x: x.startswith('C') ) |
|
1137 | a.grep( lambda x: x.startswith('C') ) | |
1138 | a.grep('Cha.*log', prune=1) |
|
1138 | a.grep('Cha.*log', prune=1) | |
1139 | a.grep('chm', field=-1) |
|
1139 | a.grep('chm', field=-1) | |
1140 | """ |
|
1140 | """ | |
1141 |
|
1141 | |||
1142 | def match_target(s): |
|
1142 | def match_target(s): | |
1143 | if field is None: |
|
1143 | if field is None: | |
1144 | return s |
|
1144 | return s | |
1145 | parts = s.split() |
|
1145 | parts = s.split() | |
1146 | try: |
|
1146 | try: | |
1147 | tgt = parts[field] |
|
1147 | tgt = parts[field] | |
1148 | return tgt |
|
1148 | return tgt | |
1149 | except IndexError: |
|
1149 | except IndexError: | |
1150 | return "" |
|
1150 | return "" | |
1151 |
|
1151 | |||
1152 | if isinstance(pattern, basestring): |
|
1152 | if isinstance(pattern, basestring): | |
1153 | pred = lambda x : re.search(pattern, x, re.IGNORECASE) |
|
1153 | pred = lambda x : re.search(pattern, x, re.IGNORECASE) | |
1154 | else: |
|
1154 | else: | |
1155 | pred = pattern |
|
1155 | pred = pattern | |
1156 | if not prune: |
|
1156 | if not prune: | |
1157 | return SList([el for el in self if pred(match_target(el))]) |
|
1157 | return SList([el for el in self if pred(match_target(el))]) | |
1158 | else: |
|
1158 | else: | |
1159 | return SList([el for el in self if not pred(match_target(el))]) |
|
1159 | return SList([el for el in self if not pred(match_target(el))]) | |
1160 | def fields(self, *fields): |
|
1160 | def fields(self, *fields): | |
1161 | """ Collect whitespace-separated fields from string list |
|
1161 | """ Collect whitespace-separated fields from string list | |
1162 |
|
1162 | |||
1163 | Allows quick awk-like usage of string lists. |
|
1163 | Allows quick awk-like usage of string lists. | |
1164 |
|
1164 | |||
1165 | Example data (in var a, created by 'a = !ls -l'):: |
|
1165 | Example data (in var a, created by 'a = !ls -l'):: | |
1166 | -rwxrwxrwx 1 ville None 18 Dec 14 2006 ChangeLog |
|
1166 | -rwxrwxrwx 1 ville None 18 Dec 14 2006 ChangeLog | |
1167 | drwxrwxrwx+ 6 ville None 0 Oct 24 18:05 IPython |
|
1167 | drwxrwxrwx+ 6 ville None 0 Oct 24 18:05 IPython | |
1168 |
|
1168 | |||
1169 | a.fields(0) is ['-rwxrwxrwx', 'drwxrwxrwx+'] |
|
1169 | a.fields(0) is ['-rwxrwxrwx', 'drwxrwxrwx+'] | |
1170 | a.fields(1,0) is ['1 -rwxrwxrwx', '6 drwxrwxrwx+'] |
|
1170 | a.fields(1,0) is ['1 -rwxrwxrwx', '6 drwxrwxrwx+'] | |
1171 | (note the joining by space). |
|
1171 | (note the joining by space). | |
1172 | a.fields(-1) is ['ChangeLog', 'IPython'] |
|
1172 | a.fields(-1) is ['ChangeLog', 'IPython'] | |
1173 |
|
1173 | |||
1174 | IndexErrors are ignored. |
|
1174 | IndexErrors are ignored. | |
1175 |
|
1175 | |||
1176 | Without args, fields() just split()'s the strings. |
|
1176 | Without args, fields() just split()'s the strings. | |
1177 | """ |
|
1177 | """ | |
1178 | if len(fields) == 0: |
|
1178 | if len(fields) == 0: | |
1179 | return [el.split() for el in self] |
|
1179 | return [el.split() for el in self] | |
1180 |
|
1180 | |||
1181 | res = SList() |
|
1181 | res = SList() | |
1182 | for el in [f.split() for f in self]: |
|
1182 | for el in [f.split() for f in self]: | |
1183 | lineparts = [] |
|
1183 | lineparts = [] | |
1184 |
|
1184 | |||
1185 | for fd in fields: |
|
1185 | for fd in fields: | |
1186 | try: |
|
1186 | try: | |
1187 | lineparts.append(el[fd]) |
|
1187 | lineparts.append(el[fd]) | |
1188 | except IndexError: |
|
1188 | except IndexError: | |
1189 | pass |
|
1189 | pass | |
1190 | if lineparts: |
|
1190 | if lineparts: | |
1191 | res.append(" ".join(lineparts)) |
|
1191 | res.append(" ".join(lineparts)) | |
1192 |
|
1192 | |||
1193 | return res |
|
1193 | return res | |
1194 | def sort(self,field= None, nums = False): |
|
1194 | def sort(self,field= None, nums = False): | |
1195 | """ sort by specified fields (see fields()) |
|
1195 | """ sort by specified fields (see fields()) | |
1196 |
|
1196 | |||
1197 | Example:: |
|
1197 | Example:: | |
1198 | a.sort(1, nums = True) |
|
1198 | a.sort(1, nums = True) | |
1199 |
|
1199 | |||
1200 | Sorts a by second field, in numerical order (so that 21 > 3) |
|
1200 | Sorts a by second field, in numerical order (so that 21 > 3) | |
1201 |
|
1201 | |||
1202 | """ |
|
1202 | """ | |
1203 |
|
1203 | |||
1204 | #decorate, sort, undecorate |
|
1204 | #decorate, sort, undecorate | |
1205 | if field is not None: |
|
1205 | if field is not None: | |
1206 | dsu = [[SList([line]).fields(field), line] for line in self] |
|
1206 | dsu = [[SList([line]).fields(field), line] for line in self] | |
1207 | else: |
|
1207 | else: | |
1208 | dsu = [[line, line] for line in self] |
|
1208 | dsu = [[line, line] for line in self] | |
1209 | if nums: |
|
1209 | if nums: | |
1210 | for i in range(len(dsu)): |
|
1210 | for i in range(len(dsu)): | |
1211 | numstr = "".join([ch for ch in dsu[i][0] if ch.isdigit()]) |
|
1211 | numstr = "".join([ch for ch in dsu[i][0] if ch.isdigit()]) | |
1212 | try: |
|
1212 | try: | |
1213 | n = int(numstr) |
|
1213 | n = int(numstr) | |
1214 | except ValueError: |
|
1214 | except ValueError: | |
1215 | n = 0; |
|
1215 | n = 0; | |
1216 | dsu[i][0] = n |
|
1216 | dsu[i][0] = n | |
1217 |
|
1217 | |||
1218 |
|
1218 | |||
1219 | dsu.sort() |
|
1219 | dsu.sort() | |
1220 | return SList([t[1] for t in dsu]) |
|
1220 | return SList([t[1] for t in dsu]) | |
1221 |
|
1221 | |||
1222 | def print_slist(arg): |
|
1222 | def print_slist(arg): | |
1223 | """ Prettier (non-repr-like) and more informative printer for SList """ |
|
1223 | """ Prettier (non-repr-like) and more informative printer for SList """ | |
1224 | print "SList (.p, .n, .l, .s, .grep(), .fields(), sort() available):" |
|
1224 | print "SList (.p, .n, .l, .s, .grep(), .fields(), sort() available):" | |
1225 | if hasattr(arg, 'hideonce') and arg.hideonce: |
|
1225 | if hasattr(arg, 'hideonce') and arg.hideonce: | |
1226 | arg.hideonce = False |
|
1226 | arg.hideonce = False | |
1227 | return |
|
1227 | return | |
1228 |
|
1228 | |||
1229 | nlprint(arg) |
|
1229 | nlprint(arg) | |
1230 |
|
1230 | |||
1231 | print_slist = result_display.when_type(SList)(print_slist) |
|
1231 | print_slist = result_display.when_type(SList)(print_slist) | |
1232 |
|
1232 | |||
1233 |
|
1233 | |||
1234 |
|
1234 | |||
1235 | #---------------------------------------------------------------------------- |
|
1235 | #---------------------------------------------------------------------------- | |
1236 | def esc_quotes(strng): |
|
1236 | def esc_quotes(strng): | |
1237 | """Return the input string with single and double quotes escaped out""" |
|
1237 | """Return the input string with single and double quotes escaped out""" | |
1238 |
|
1238 | |||
1239 | return strng.replace('"','\\"').replace("'","\\'") |
|
1239 | return strng.replace('"','\\"').replace("'","\\'") | |
1240 |
|
1240 | |||
1241 | #---------------------------------------------------------------------------- |
|
1241 | #---------------------------------------------------------------------------- | |
1242 | def make_quoted_expr(s): |
|
1242 | def make_quoted_expr(s): | |
1243 | """Return string s in appropriate quotes, using raw string if possible. |
|
1243 | """Return string s in appropriate quotes, using raw string if possible. | |
1244 |
|
1244 | |||
1245 | XXX - example removed because it caused encoding errors in documentation |
|
1245 | XXX - example removed because it caused encoding errors in documentation | |
1246 | generation. We need a new example that doesn't contain invalid chars. |
|
1246 | generation. We need a new example that doesn't contain invalid chars. | |
1247 |
|
1247 | |||
1248 | Note the use of raw string and padding at the end to allow trailing |
|
1248 | Note the use of raw string and padding at the end to allow trailing | |
1249 | backslash. |
|
1249 | backslash. | |
1250 | """ |
|
1250 | """ | |
1251 |
|
1251 | |||
1252 | tail = '' |
|
1252 | tail = '' | |
1253 | tailpadding = '' |
|
1253 | tailpadding = '' | |
1254 | raw = '' |
|
1254 | raw = '' | |
1255 | if "\\" in s: |
|
1255 | if "\\" in s: | |
1256 | raw = 'r' |
|
1256 | raw = 'r' | |
1257 | if s.endswith('\\'): |
|
1257 | if s.endswith('\\'): | |
1258 | tail = '[:-1]' |
|
1258 | tail = '[:-1]' | |
1259 | tailpadding = '_' |
|
1259 | tailpadding = '_' | |
1260 | if '"' not in s: |
|
1260 | if '"' not in s: | |
1261 | quote = '"' |
|
1261 | quote = '"' | |
1262 | elif "'" not in s: |
|
1262 | elif "'" not in s: | |
1263 | quote = "'" |
|
1263 | quote = "'" | |
1264 | elif '"""' not in s and not s.endswith('"'): |
|
1264 | elif '"""' not in s and not s.endswith('"'): | |
1265 | quote = '"""' |
|
1265 | quote = '"""' | |
1266 | elif "'''" not in s and not s.endswith("'"): |
|
1266 | elif "'''" not in s and not s.endswith("'"): | |
1267 | quote = "'''" |
|
1267 | quote = "'''" | |
1268 | else: |
|
1268 | else: | |
1269 | # give up, backslash-escaped string will do |
|
1269 | # give up, backslash-escaped string will do | |
1270 | return '"%s"' % esc_quotes(s) |
|
1270 | return '"%s"' % esc_quotes(s) | |
1271 | res = raw + quote + s + tailpadding + quote + tail |
|
1271 | res = raw + quote + s + tailpadding + quote + tail | |
1272 | return res |
|
1272 | return res | |
1273 |
|
1273 | |||
1274 |
|
1274 | |||
1275 | #---------------------------------------------------------------------------- |
|
1275 | #---------------------------------------------------------------------------- | |
1276 | def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'): |
|
1276 | def raw_input_multi(header='', ps1='==> ', ps2='..> ',terminate_str = '.'): | |
1277 | """Take multiple lines of input. |
|
1277 | """Take multiple lines of input. | |
1278 |
|
1278 | |||
1279 | A list with each line of input as a separate element is returned when a |
|
1279 | A list with each line of input as a separate element is returned when a | |
1280 | termination string is entered (defaults to a single '.'). Input can also |
|
1280 | termination string is entered (defaults to a single '.'). Input can also | |
1281 | terminate via EOF (^D in Unix, ^Z-RET in Windows). |
|
1281 | terminate via EOF (^D in Unix, ^Z-RET in Windows). | |
1282 |
|
1282 | |||
1283 | Lines of input which end in \\ are joined into single entries (and a |
|
1283 | Lines of input which end in \\ are joined into single entries (and a | |
1284 | secondary continuation prompt is issued as long as the user terminates |
|
1284 | secondary continuation prompt is issued as long as the user terminates | |
1285 | lines with \\). This allows entering very long strings which are still |
|
1285 | lines with \\). This allows entering very long strings which are still | |
1286 | meant to be treated as single entities. |
|
1286 | meant to be treated as single entities. | |
1287 | """ |
|
1287 | """ | |
1288 |
|
1288 | |||
1289 | try: |
|
1289 | try: | |
1290 | if header: |
|
1290 | if header: | |
1291 | header += '\n' |
|
1291 | header += '\n' | |
1292 | lines = [raw_input(header + ps1)] |
|
1292 | lines = [raw_input(header + ps1)] | |
1293 | except EOFError: |
|
1293 | except EOFError: | |
1294 | return [] |
|
1294 | return [] | |
1295 | terminate = [terminate_str] |
|
1295 | terminate = [terminate_str] | |
1296 | try: |
|
1296 | try: | |
1297 | while lines[-1:] != terminate: |
|
1297 | while lines[-1:] != terminate: | |
1298 | new_line = raw_input(ps1) |
|
1298 | new_line = raw_input(ps1) | |
1299 | while new_line.endswith('\\'): |
|
1299 | while new_line.endswith('\\'): | |
1300 | new_line = new_line[:-1] + raw_input(ps2) |
|
1300 | new_line = new_line[:-1] + raw_input(ps2) | |
1301 | lines.append(new_line) |
|
1301 | lines.append(new_line) | |
1302 |
|
1302 | |||
1303 | return lines[:-1] # don't return the termination command |
|
1303 | return lines[:-1] # don't return the termination command | |
1304 | except EOFError: |
|
1304 | except EOFError: | |
1305 |
|
1305 | |||
1306 | return lines |
|
1306 | return lines | |
1307 |
|
1307 | |||
1308 | #---------------------------------------------------------------------------- |
|
1308 | #---------------------------------------------------------------------------- | |
1309 | def raw_input_ext(prompt='', ps2='... '): |
|
1309 | def raw_input_ext(prompt='', ps2='... '): | |
1310 | """Similar to raw_input(), but accepts extended lines if input ends with \\.""" |
|
1310 | """Similar to raw_input(), but accepts extended lines if input ends with \\.""" | |
1311 |
|
1311 | |||
1312 | line = raw_input(prompt) |
|
1312 | line = raw_input(prompt) | |
1313 | while line.endswith('\\'): |
|
1313 | while line.endswith('\\'): | |
1314 | line = line[:-1] + raw_input(ps2) |
|
1314 | line = line[:-1] + raw_input(ps2) | |
1315 | return line |
|
1315 | return line | |
1316 |
|
1316 | |||
1317 | #---------------------------------------------------------------------------- |
|
1317 | #---------------------------------------------------------------------------- | |
1318 | def ask_yes_no(prompt,default=None): |
|
1318 | def ask_yes_no(prompt,default=None): | |
1319 | """Asks a question and returns a boolean (y/n) answer. |
|
1319 | """Asks a question and returns a boolean (y/n) answer. | |
1320 |
|
1320 | |||
1321 | If default is given (one of 'y','n'), it is used if the user input is |
|
1321 | If default is given (one of 'y','n'), it is used if the user input is | |
1322 | empty. Otherwise the question is repeated until an answer is given. |
|
1322 | empty. Otherwise the question is repeated until an answer is given. | |
1323 |
|
1323 | |||
1324 | An EOF is treated as the default answer. If there is no default, an |
|
1324 | An EOF is treated as the default answer. If there is no default, an | |
1325 | exception is raised to prevent infinite loops. |
|
1325 | exception is raised to prevent infinite loops. | |
1326 |
|
1326 | |||
1327 | Valid answers are: y/yes/n/no (match is not case sensitive).""" |
|
1327 | Valid answers are: y/yes/n/no (match is not case sensitive).""" | |
1328 |
|
1328 | |||
1329 | answers = {'y':True,'n':False,'yes':True,'no':False} |
|
1329 | answers = {'y':True,'n':False,'yes':True,'no':False} | |
1330 | ans = None |
|
1330 | ans = None | |
1331 | while ans not in answers.keys(): |
|
1331 | while ans not in answers.keys(): | |
1332 | try: |
|
1332 | try: | |
1333 | ans = raw_input(prompt+' ').lower() |
|
1333 | ans = raw_input(prompt+' ').lower() | |
1334 | if not ans: # response was an empty string |
|
1334 | if not ans: # response was an empty string | |
1335 | ans = default |
|
1335 | ans = default | |
1336 | except KeyboardInterrupt: |
|
1336 | except KeyboardInterrupt: | |
1337 | pass |
|
1337 | pass | |
1338 | except EOFError: |
|
1338 | except EOFError: | |
1339 | if default in answers.keys(): |
|
1339 | if default in answers.keys(): | |
1340 | ans = default |
|
1340 | ans = default | |
1341 |
|
1341 | |||
1342 | else: |
|
1342 | else: | |
1343 | raise |
|
1343 | raise | |
1344 |
|
1344 | |||
1345 | return answers[ans] |
|
1345 | return answers[ans] | |
1346 |
|
1346 | |||
1347 | #---------------------------------------------------------------------------- |
|
1347 | #---------------------------------------------------------------------------- | |
1348 | def marquee(txt='',width=78,mark='*'): |
|
1348 | def marquee(txt='',width=78,mark='*'): | |
1349 | """Return the input string centered in a 'marquee'.""" |
|
1349 | """Return the input string centered in a 'marquee'.""" | |
1350 | if not txt: |
|
1350 | if not txt: | |
1351 | return (mark*width)[:width] |
|
1351 | return (mark*width)[:width] | |
1352 | nmark = (width-len(txt)-2)/len(mark)/2 |
|
1352 | nmark = (width-len(txt)-2)/len(mark)/2 | |
1353 | if nmark < 0: nmark =0 |
|
1353 | if nmark < 0: nmark =0 | |
1354 | marks = mark*nmark |
|
1354 | marks = mark*nmark | |
1355 | return '%s %s %s' % (marks,txt,marks) |
|
1355 | return '%s %s %s' % (marks,txt,marks) | |
1356 |
|
1356 | |||
1357 | #---------------------------------------------------------------------------- |
|
1357 | #---------------------------------------------------------------------------- | |
1358 | class EvalDict: |
|
1358 | class EvalDict: | |
1359 | """ |
|
1359 | """ | |
1360 | Emulate a dict which evaluates its contents in the caller's frame. |
|
1360 | Emulate a dict which evaluates its contents in the caller's frame. | |
1361 |
|
1361 | |||
1362 | Usage: |
|
1362 | Usage: | |
1363 | >>> number = 19 |
|
1363 | >>> number = 19 | |
1364 |
|
1364 | |||
1365 | >>> text = "python" |
|
1365 | >>> text = "python" | |
1366 |
|
1366 | |||
1367 | >>> print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() |
|
1367 | >>> print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() | |
1368 | Python 2.1 rules! |
|
1368 | Python 2.1 rules! | |
1369 | """ |
|
1369 | """ | |
1370 |
|
1370 | |||
1371 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a |
|
1371 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a | |
1372 | # modified (shorter) version of: |
|
1372 | # modified (shorter) version of: | |
1373 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by |
|
1373 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by | |
1374 | # Skip Montanaro (skip@pobox.com). |
|
1374 | # Skip Montanaro (skip@pobox.com). | |
1375 |
|
1375 | |||
1376 | def __getitem__(self, name): |
|
1376 | def __getitem__(self, name): | |
1377 | frame = sys._getframe(1) |
|
1377 | frame = sys._getframe(1) | |
1378 | return eval(name, frame.f_globals, frame.f_locals) |
|
1378 | return eval(name, frame.f_globals, frame.f_locals) | |
1379 |
|
1379 | |||
1380 | EvalString = EvalDict # for backwards compatibility |
|
1380 | EvalString = EvalDict # for backwards compatibility | |
1381 | #---------------------------------------------------------------------------- |
|
1381 | #---------------------------------------------------------------------------- | |
1382 | def qw(words,flat=0,sep=None,maxsplit=-1): |
|
1382 | def qw(words,flat=0,sep=None,maxsplit=-1): | |
1383 | """Similar to Perl's qw() operator, but with some more options. |
|
1383 | """Similar to Perl's qw() operator, but with some more options. | |
1384 |
|
1384 | |||
1385 | qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit) |
|
1385 | qw(words,flat=0,sep=' ',maxsplit=-1) -> words.split(sep,maxsplit) | |
1386 |
|
1386 | |||
1387 | words can also be a list itself, and with flat=1, the output will be |
|
1387 | words can also be a list itself, and with flat=1, the output will be | |
1388 | recursively flattened. |
|
1388 | recursively flattened. | |
1389 |
|
1389 | |||
1390 | Examples: |
|
1390 | Examples: | |
1391 |
|
1391 | |||
1392 | >>> qw('1 2') |
|
1392 | >>> qw('1 2') | |
1393 | ['1', '2'] |
|
1393 | ['1', '2'] | |
1394 |
|
1394 | |||
1395 | >>> qw(['a b','1 2',['m n','p q']]) |
|
1395 | >>> qw(['a b','1 2',['m n','p q']]) | |
1396 | [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]] |
|
1396 | [['a', 'b'], ['1', '2'], [['m', 'n'], ['p', 'q']]] | |
1397 |
|
1397 | |||
1398 | >>> qw(['a b','1 2',['m n','p q']],flat=1) |
|
1398 | >>> qw(['a b','1 2',['m n','p q']],flat=1) | |
1399 | ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] |
|
1399 | ['a', 'b', '1', '2', 'm', 'n', 'p', 'q'] | |
1400 | """ |
|
1400 | """ | |
1401 |
|
1401 | |||
1402 | if type(words) in StringTypes: |
|
1402 | if type(words) in StringTypes: | |
1403 | return [word.strip() for word in words.split(sep,maxsplit) |
|
1403 | return [word.strip() for word in words.split(sep,maxsplit) | |
1404 | if word and not word.isspace() ] |
|
1404 | if word and not word.isspace() ] | |
1405 | if flat: |
|
1405 | if flat: | |
1406 | return flatten(map(qw,words,[1]*len(words))) |
|
1406 | return flatten(map(qw,words,[1]*len(words))) | |
1407 | return map(qw,words) |
|
1407 | return map(qw,words) | |
1408 |
|
1408 | |||
1409 | #---------------------------------------------------------------------------- |
|
1409 | #---------------------------------------------------------------------------- | |
1410 | def qwflat(words,sep=None,maxsplit=-1): |
|
1410 | def qwflat(words,sep=None,maxsplit=-1): | |
1411 | """Calls qw(words) in flat mode. It's just a convenient shorthand.""" |
|
1411 | """Calls qw(words) in flat mode. It's just a convenient shorthand.""" | |
1412 | return qw(words,1,sep,maxsplit) |
|
1412 | return qw(words,1,sep,maxsplit) | |
1413 |
|
1413 | |||
1414 | #---------------------------------------------------------------------------- |
|
1414 | #---------------------------------------------------------------------------- | |
1415 | def qw_lol(indata): |
|
1415 | def qw_lol(indata): | |
1416 | """qw_lol('a b') -> [['a','b']], |
|
1416 | """qw_lol('a b') -> [['a','b']], | |
1417 | otherwise it's just a call to qw(). |
|
1417 | otherwise it's just a call to qw(). | |
1418 |
|
1418 | |||
1419 | We need this to make sure the modules_some keys *always* end up as a |
|
1419 | We need this to make sure the modules_some keys *always* end up as a | |
1420 | list of lists.""" |
|
1420 | list of lists.""" | |
1421 |
|
1421 | |||
1422 | if type(indata) in StringTypes: |
|
1422 | if type(indata) in StringTypes: | |
1423 | return [qw(indata)] |
|
1423 | return [qw(indata)] | |
1424 | else: |
|
1424 | else: | |
1425 | return qw(indata) |
|
1425 | return qw(indata) | |
1426 |
|
1426 | |||
1427 | #----------------------------------------------------------------------------- |
|
1427 | #----------------------------------------------------------------------------- | |
1428 | def list_strings(arg): |
|
1428 | def list_strings(arg): | |
1429 | """Always return a list of strings, given a string or list of strings |
|
1429 | """Always return a list of strings, given a string or list of strings | |
1430 | as input.""" |
|
1430 | as input.""" | |
1431 |
|
1431 | |||
1432 | if type(arg) in StringTypes: return [arg] |
|
1432 | if type(arg) in StringTypes: return [arg] | |
1433 | else: return arg |
|
1433 | else: return arg | |
1434 |
|
1434 | |||
1435 | #---------------------------------------------------------------------------- |
|
1435 | #---------------------------------------------------------------------------- | |
1436 | def grep(pat,list,case=1): |
|
1436 | def grep(pat,list,case=1): | |
1437 | """Simple minded grep-like function. |
|
1437 | """Simple minded grep-like function. | |
1438 | grep(pat,list) returns occurrences of pat in list, None on failure. |
|
1438 | grep(pat,list) returns occurrences of pat in list, None on failure. | |
1439 |
|
1439 | |||
1440 | It only does simple string matching, with no support for regexps. Use the |
|
1440 | It only does simple string matching, with no support for regexps. Use the | |
1441 | option case=0 for case-insensitive matching.""" |
|
1441 | option case=0 for case-insensitive matching.""" | |
1442 |
|
1442 | |||
1443 | # This is pretty crude. At least it should implement copying only references |
|
1443 | # This is pretty crude. At least it should implement copying only references | |
1444 | # to the original data in case it's big. Now it copies the data for output. |
|
1444 | # to the original data in case it's big. Now it copies the data for output. | |
1445 | out=[] |
|
1445 | out=[] | |
1446 | if case: |
|
1446 | if case: | |
1447 | for term in list: |
|
1447 | for term in list: | |
1448 | if term.find(pat)>-1: out.append(term) |
|
1448 | if term.find(pat)>-1: out.append(term) | |
1449 | else: |
|
1449 | else: | |
1450 | lpat=pat.lower() |
|
1450 | lpat=pat.lower() | |
1451 | for term in list: |
|
1451 | for term in list: | |
1452 | if term.lower().find(lpat)>-1: out.append(term) |
|
1452 | if term.lower().find(lpat)>-1: out.append(term) | |
1453 |
|
1453 | |||
1454 | if len(out): return out |
|
1454 | if len(out): return out | |
1455 | else: return None |
|
1455 | else: return None | |
1456 |
|
1456 | |||
1457 | #---------------------------------------------------------------------------- |
|
1457 | #---------------------------------------------------------------------------- | |
1458 | def dgrep(pat,*opts): |
|
1458 | def dgrep(pat,*opts): | |
1459 | """Return grep() on dir()+dir(__builtins__). |
|
1459 | """Return grep() on dir()+dir(__builtins__). | |
1460 |
|
1460 | |||
1461 | A very common use of grep() when working interactively.""" |
|
1461 | A very common use of grep() when working interactively.""" | |
1462 |
|
1462 | |||
1463 | return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts) |
|
1463 | return grep(pat,dir(__main__)+dir(__main__.__builtins__),*opts) | |
1464 |
|
1464 | |||
1465 | #---------------------------------------------------------------------------- |
|
1465 | #---------------------------------------------------------------------------- | |
1466 | def idgrep(pat): |
|
1466 | def idgrep(pat): | |
1467 | """Case-insensitive dgrep()""" |
|
1467 | """Case-insensitive dgrep()""" | |
1468 |
|
1468 | |||
1469 | return dgrep(pat,0) |
|
1469 | return dgrep(pat,0) | |
1470 |
|
1470 | |||
1471 | #---------------------------------------------------------------------------- |
|
1471 | #---------------------------------------------------------------------------- | |
1472 | def igrep(pat,list): |
|
1472 | def igrep(pat,list): | |
1473 | """Synonym for case-insensitive grep.""" |
|
1473 | """Synonym for case-insensitive grep.""" | |
1474 |
|
1474 | |||
1475 | return grep(pat,list,case=0) |
|
1475 | return grep(pat,list,case=0) | |
1476 |
|
1476 | |||
1477 | #---------------------------------------------------------------------------- |
|
1477 | #---------------------------------------------------------------------------- | |
1478 | def indent(str,nspaces=4,ntabs=0): |
|
1478 | def indent(str,nspaces=4,ntabs=0): | |
1479 | """Indent a string a given number of spaces or tabstops. |
|
1479 | """Indent a string a given number of spaces or tabstops. | |
1480 |
|
1480 | |||
1481 | indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. |
|
1481 | indent(str,nspaces=4,ntabs=0) -> indent str by ntabs+nspaces. | |
1482 | """ |
|
1482 | """ | |
1483 | if str is None: |
|
1483 | if str is None: | |
1484 | return |
|
1484 | return | |
1485 | ind = '\t'*ntabs+' '*nspaces |
|
1485 | ind = '\t'*ntabs+' '*nspaces | |
1486 | outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind)) |
|
1486 | outstr = '%s%s' % (ind,str.replace(os.linesep,os.linesep+ind)) | |
1487 | if outstr.endswith(os.linesep+ind): |
|
1487 | if outstr.endswith(os.linesep+ind): | |
1488 | return outstr[:-len(ind)] |
|
1488 | return outstr[:-len(ind)] | |
1489 | else: |
|
1489 | else: | |
1490 | return outstr |
|
1490 | return outstr | |
1491 |
|
1491 | |||
1492 | #----------------------------------------------------------------------------- |
|
1492 | #----------------------------------------------------------------------------- | |
1493 | def native_line_ends(filename,backup=1): |
|
1493 | def native_line_ends(filename,backup=1): | |
1494 | """Convert (in-place) a file to line-ends native to the current OS. |
|
1494 | """Convert (in-place) a file to line-ends native to the current OS. | |
1495 |
|
1495 | |||
1496 | If the optional backup argument is given as false, no backup of the |
|
1496 | If the optional backup argument is given as false, no backup of the | |
1497 | original file is left. """ |
|
1497 | original file is left. """ | |
1498 |
|
1498 | |||
1499 | backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'} |
|
1499 | backup_suffixes = {'posix':'~','dos':'.bak','nt':'.bak','mac':'.bak'} | |
1500 |
|
1500 | |||
1501 | bak_filename = filename + backup_suffixes[os.name] |
|
1501 | bak_filename = filename + backup_suffixes[os.name] | |
1502 |
|
1502 | |||
1503 | original = open(filename).read() |
|
1503 | original = open(filename).read() | |
1504 | shutil.copy2(filename,bak_filename) |
|
1504 | shutil.copy2(filename,bak_filename) | |
1505 | try: |
|
1505 | try: | |
1506 | new = open(filename,'wb') |
|
1506 | new = open(filename,'wb') | |
1507 | new.write(os.linesep.join(original.splitlines())) |
|
1507 | new.write(os.linesep.join(original.splitlines())) | |
1508 | new.write(os.linesep) # ALWAYS put an eol at the end of the file |
|
1508 | new.write(os.linesep) # ALWAYS put an eol at the end of the file | |
1509 | new.close() |
|
1509 | new.close() | |
1510 | except: |
|
1510 | except: | |
1511 | os.rename(bak_filename,filename) |
|
1511 | os.rename(bak_filename,filename) | |
1512 | if not backup: |
|
1512 | if not backup: | |
1513 | try: |
|
1513 | try: | |
1514 | os.remove(bak_filename) |
|
1514 | os.remove(bak_filename) | |
1515 | except: |
|
1515 | except: | |
1516 | pass |
|
1516 | pass | |
1517 |
|
1517 | |||
1518 | #---------------------------------------------------------------------------- |
|
1518 | #---------------------------------------------------------------------------- | |
1519 | def get_pager_cmd(pager_cmd = None): |
|
1519 | def get_pager_cmd(pager_cmd = None): | |
1520 | """Return a pager command. |
|
1520 | """Return a pager command. | |
1521 |
|
1521 | |||
1522 | Makes some attempts at finding an OS-correct one.""" |
|
1522 | Makes some attempts at finding an OS-correct one.""" | |
1523 |
|
1523 | |||
1524 | if os.name == 'posix': |
|
1524 | if os.name == 'posix': | |
1525 | default_pager_cmd = 'less -r' # -r for color control sequences |
|
1525 | default_pager_cmd = 'less -r' # -r for color control sequences | |
1526 | elif os.name in ['nt','dos']: |
|
1526 | elif os.name in ['nt','dos']: | |
1527 | default_pager_cmd = 'type' |
|
1527 | default_pager_cmd = 'type' | |
1528 |
|
1528 | |||
1529 | if pager_cmd is None: |
|
1529 | if pager_cmd is None: | |
1530 | try: |
|
1530 | try: | |
1531 | pager_cmd = os.environ['PAGER'] |
|
1531 | pager_cmd = os.environ['PAGER'] | |
1532 | except: |
|
1532 | except: | |
1533 | pager_cmd = default_pager_cmd |
|
1533 | pager_cmd = default_pager_cmd | |
1534 | return pager_cmd |
|
1534 | return pager_cmd | |
1535 |
|
1535 | |||
1536 | #----------------------------------------------------------------------------- |
|
1536 | #----------------------------------------------------------------------------- | |
1537 | def get_pager_start(pager,start): |
|
1537 | def get_pager_start(pager,start): | |
1538 | """Return the string for paging files with an offset. |
|
1538 | """Return the string for paging files with an offset. | |
1539 |
|
1539 | |||
1540 | This is the '+N' argument which less and more (under Unix) accept. |
|
1540 | This is the '+N' argument which less and more (under Unix) accept. | |
1541 | """ |
|
1541 | """ | |
1542 |
|
1542 | |||
1543 | if pager in ['less','more']: |
|
1543 | if pager in ['less','more']: | |
1544 | if start: |
|
1544 | if start: | |
1545 | start_string = '+' + str(start) |
|
1545 | start_string = '+' + str(start) | |
1546 | else: |
|
1546 | else: | |
1547 | start_string = '' |
|
1547 | start_string = '' | |
1548 | else: |
|
1548 | else: | |
1549 | start_string = '' |
|
1549 | start_string = '' | |
1550 | return start_string |
|
1550 | return start_string | |
1551 |
|
1551 | |||
1552 | #---------------------------------------------------------------------------- |
|
1552 | #---------------------------------------------------------------------------- | |
1553 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() |
|
1553 | # (X)emacs on W32 doesn't like to be bypassed with msvcrt.getch() | |
1554 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': |
|
1554 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': | |
1555 | import msvcrt |
|
1555 | import msvcrt | |
1556 | def page_more(): |
|
1556 | def page_more(): | |
1557 | """ Smart pausing between pages |
|
1557 | """ Smart pausing between pages | |
1558 |
|
1558 | |||
1559 | @return: True if need print more lines, False if quit |
|
1559 | @return: True if need print more lines, False if quit | |
1560 | """ |
|
1560 | """ | |
1561 | Term.cout.write('---Return to continue, q to quit--- ') |
|
1561 | Term.cout.write('---Return to continue, q to quit--- ') | |
1562 | ans = msvcrt.getch() |
|
1562 | ans = msvcrt.getch() | |
1563 | if ans in ("q", "Q"): |
|
1563 | if ans in ("q", "Q"): | |
1564 | result = False |
|
1564 | result = False | |
1565 | else: |
|
1565 | else: | |
1566 | result = True |
|
1566 | result = True | |
1567 | Term.cout.write("\b"*37 + " "*37 + "\b"*37) |
|
1567 | Term.cout.write("\b"*37 + " "*37 + "\b"*37) | |
1568 | return result |
|
1568 | return result | |
1569 | else: |
|
1569 | else: | |
1570 | def page_more(): |
|
1570 | def page_more(): | |
1571 | ans = raw_input('---Return to continue, q to quit--- ') |
|
1571 | ans = raw_input('---Return to continue, q to quit--- ') | |
1572 | if ans.lower().startswith('q'): |
|
1572 | if ans.lower().startswith('q'): | |
1573 | return False |
|
1573 | return False | |
1574 | else: |
|
1574 | else: | |
1575 | return True |
|
1575 | return True | |
1576 |
|
1576 | |||
1577 | esc_re = re.compile(r"(\x1b[^m]+m)") |
|
1577 | esc_re = re.compile(r"(\x1b[^m]+m)") | |
1578 |
|
1578 | |||
1579 | def page_dumb(strng,start=0,screen_lines=25): |
|
1579 | def page_dumb(strng,start=0,screen_lines=25): | |
1580 | """Very dumb 'pager' in Python, for when nothing else works. |
|
1580 | """Very dumb 'pager' in Python, for when nothing else works. | |
1581 |
|
1581 | |||
1582 | Only moves forward, same interface as page(), except for pager_cmd and |
|
1582 | Only moves forward, same interface as page(), except for pager_cmd and | |
1583 | mode.""" |
|
1583 | mode.""" | |
1584 |
|
1584 | |||
1585 | out_ln = strng.splitlines()[start:] |
|
1585 | out_ln = strng.splitlines()[start:] | |
1586 | screens = chop(out_ln,screen_lines-1) |
|
1586 | screens = chop(out_ln,screen_lines-1) | |
1587 | if len(screens) == 1: |
|
1587 | if len(screens) == 1: | |
1588 | print >>Term.cout, os.linesep.join(screens[0]) |
|
1588 | print >>Term.cout, os.linesep.join(screens[0]) | |
1589 | else: |
|
1589 | else: | |
1590 | last_escape = "" |
|
1590 | last_escape = "" | |
1591 | for scr in screens[0:-1]: |
|
1591 | for scr in screens[0:-1]: | |
1592 | hunk = os.linesep.join(scr) |
|
1592 | hunk = os.linesep.join(scr) | |
1593 | print >>Term.cout, last_escape + hunk |
|
1593 | print >>Term.cout, last_escape + hunk | |
1594 | if not page_more(): |
|
1594 | if not page_more(): | |
1595 | return |
|
1595 | return | |
1596 | esc_list = esc_re.findall(hunk) |
|
1596 | esc_list = esc_re.findall(hunk) | |
1597 | if len(esc_list) > 0: |
|
1597 | if len(esc_list) > 0: | |
1598 | last_escape = esc_list[-1] |
|
1598 | last_escape = esc_list[-1] | |
1599 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) |
|
1599 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) | |
1600 |
|
1600 | |||
1601 | #---------------------------------------------------------------------------- |
|
1601 | #---------------------------------------------------------------------------- | |
1602 | def page(strng,start=0,screen_lines=0,pager_cmd = None): |
|
1602 | def page(strng,start=0,screen_lines=0,pager_cmd = None): | |
1603 | """Print a string, piping through a pager after a certain length. |
|
1603 | """Print a string, piping through a pager after a certain length. | |
1604 |
|
1604 | |||
1605 | The screen_lines parameter specifies the number of *usable* lines of your |
|
1605 | The screen_lines parameter specifies the number of *usable* lines of your | |
1606 | terminal screen (total lines minus lines you need to reserve to show other |
|
1606 | terminal screen (total lines minus lines you need to reserve to show other | |
1607 | information). |
|
1607 | information). | |
1608 |
|
1608 | |||
1609 | If you set screen_lines to a number <=0, page() will try to auto-determine |
|
1609 | If you set screen_lines to a number <=0, page() will try to auto-determine | |
1610 | your screen size and will only use up to (screen_size+screen_lines) for |
|
1610 | your screen size and will only use up to (screen_size+screen_lines) for | |
1611 | printing, paging after that. That is, if you want auto-detection but need |
|
1611 | printing, paging after that. That is, if you want auto-detection but need | |
1612 | to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for |
|
1612 | to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for | |
1613 | auto-detection without any lines reserved simply use screen_lines = 0. |
|
1613 | auto-detection without any lines reserved simply use screen_lines = 0. | |
1614 |
|
1614 | |||
1615 | If a string won't fit in the allowed lines, it is sent through the |
|
1615 | If a string won't fit in the allowed lines, it is sent through the | |
1616 | specified pager command. If none given, look for PAGER in the environment, |
|
1616 | specified pager command. If none given, look for PAGER in the environment, | |
1617 | and ultimately default to less. |
|
1617 | and ultimately default to less. | |
1618 |
|
1618 | |||
1619 | If no system pager works, the string is sent through a 'dumb pager' |
|
1619 | If no system pager works, the string is sent through a 'dumb pager' | |
1620 | written in python, very simplistic. |
|
1620 | written in python, very simplistic. | |
1621 | """ |
|
1621 | """ | |
1622 |
|
1622 | |||
1623 | # Some routines may auto-compute start offsets incorrectly and pass a |
|
1623 | # Some routines may auto-compute start offsets incorrectly and pass a | |
1624 | # negative value. Offset to 0 for robustness. |
|
1624 | # negative value. Offset to 0 for robustness. | |
1625 | start = max(0,start) |
|
1625 | start = max(0,start) | |
1626 |
|
1626 | |||
1627 | # first, try the hook |
|
1627 | # first, try the hook | |
1628 | ip = ipapi.get() |
|
1628 | ip = ipapi.get() | |
1629 | if ip: |
|
1629 | if ip: | |
1630 | try: |
|
1630 | try: | |
1631 | ip.IP.hooks.show_in_pager(strng) |
|
1631 | ip.IP.hooks.show_in_pager(strng) | |
1632 | return |
|
1632 | return | |
1633 | except ipapi.TryNext: |
|
1633 | except ipapi.TryNext: | |
1634 | pass |
|
1634 | pass | |
1635 |
|
1635 | |||
1636 | # Ugly kludge, but calling curses.initscr() flat out crashes in emacs |
|
1636 | # Ugly kludge, but calling curses.initscr() flat out crashes in emacs | |
1637 | TERM = os.environ.get('TERM','dumb') |
|
1637 | TERM = os.environ.get('TERM','dumb') | |
1638 | if TERM in ['dumb','emacs'] and os.name != 'nt': |
|
1638 | if TERM in ['dumb','emacs'] and os.name != 'nt': | |
1639 | print strng |
|
1639 | print strng | |
1640 | return |
|
1640 | return | |
1641 | # chop off the topmost part of the string we don't want to see |
|
1641 | # chop off the topmost part of the string we don't want to see | |
1642 | str_lines = strng.split(os.linesep)[start:] |
|
1642 | str_lines = strng.split(os.linesep)[start:] | |
1643 | str_toprint = os.linesep.join(str_lines) |
|
1643 | str_toprint = os.linesep.join(str_lines) | |
1644 | num_newlines = len(str_lines) |
|
1644 | num_newlines = len(str_lines) | |
1645 | len_str = len(str_toprint) |
|
1645 | len_str = len(str_toprint) | |
1646 |
|
1646 | |||
1647 | # Dumb heuristics to guesstimate number of on-screen lines the string |
|
1647 | # Dumb heuristics to guesstimate number of on-screen lines the string | |
1648 | # takes. Very basic, but good enough for docstrings in reasonable |
|
1648 | # takes. Very basic, but good enough for docstrings in reasonable | |
1649 | # terminals. If someone later feels like refining it, it's not hard. |
|
1649 | # terminals. If someone later feels like refining it, it's not hard. | |
1650 | numlines = max(num_newlines,int(len_str/80)+1) |
|
1650 | numlines = max(num_newlines,int(len_str/80)+1) | |
1651 |
|
1651 | |||
1652 | if os.name == "nt": |
|
1652 | if os.name == "nt": | |
1653 | screen_lines_def = get_console_size(defaulty=25)[1] |
|
1653 | screen_lines_def = get_console_size(defaulty=25)[1] | |
1654 | else: |
|
1654 | else: | |
1655 | screen_lines_def = 25 # default value if we can't auto-determine |
|
1655 | screen_lines_def = 25 # default value if we can't auto-determine | |
1656 |
|
1656 | |||
1657 | # auto-determine screen size |
|
1657 | # auto-determine screen size | |
1658 | if screen_lines <= 0: |
|
1658 | if screen_lines <= 0: | |
1659 | if TERM=='xterm': |
|
1659 | if TERM=='xterm': | |
1660 | use_curses = USE_CURSES |
|
1660 | use_curses = USE_CURSES | |
1661 | else: |
|
1661 | else: | |
1662 | # curses causes problems on many terminals other than xterm. |
|
1662 | # curses causes problems on many terminals other than xterm. | |
1663 | use_curses = False |
|
1663 | use_curses = False | |
1664 | if use_curses: |
|
1664 | if use_curses: | |
1665 | # There is a bug in curses, where *sometimes* it fails to properly |
|
1665 | # There is a bug in curses, where *sometimes* it fails to properly | |
1666 | # initialize, and then after the endwin() call is made, the |
|
1666 | # initialize, and then after the endwin() call is made, the | |
1667 | # terminal is left in an unusable state. Rather than trying to |
|
1667 | # terminal is left in an unusable state. Rather than trying to | |
1668 | # check everytime for this (by requesting and comparing termios |
|
1668 | # check everytime for this (by requesting and comparing termios | |
1669 | # flags each time), we just save the initial terminal state and |
|
1669 | # flags each time), we just save the initial terminal state and | |
1670 | # unconditionally reset it every time. It's cheaper than making |
|
1670 | # unconditionally reset it every time. It's cheaper than making | |
1671 | # the checks. |
|
1671 | # the checks. | |
1672 | term_flags = termios.tcgetattr(sys.stdout) |
|
1672 | term_flags = termios.tcgetattr(sys.stdout) | |
1673 | scr = curses.initscr() |
|
1673 | scr = curses.initscr() | |
1674 | screen_lines_real,screen_cols = scr.getmaxyx() |
|
1674 | screen_lines_real,screen_cols = scr.getmaxyx() | |
1675 | curses.endwin() |
|
1675 | curses.endwin() | |
1676 | # Restore terminal state in case endwin() didn't. |
|
1676 | # Restore terminal state in case endwin() didn't. | |
1677 | termios.tcsetattr(sys.stdout,termios.TCSANOW,term_flags) |
|
1677 | termios.tcsetattr(sys.stdout,termios.TCSANOW,term_flags) | |
1678 | # Now we have what we needed: the screen size in rows/columns |
|
1678 | # Now we have what we needed: the screen size in rows/columns | |
1679 | screen_lines += screen_lines_real |
|
1679 | screen_lines += screen_lines_real | |
1680 | #print '***Screen size:',screen_lines_real,'lines x',\ |
|
1680 | #print '***Screen size:',screen_lines_real,'lines x',\ | |
1681 | #screen_cols,'columns.' # dbg |
|
1681 | #screen_cols,'columns.' # dbg | |
1682 | else: |
|
1682 | else: | |
1683 | screen_lines += screen_lines_def |
|
1683 | screen_lines += screen_lines_def | |
1684 |
|
1684 | |||
1685 | #print 'numlines',numlines,'screenlines',screen_lines # dbg |
|
1685 | #print 'numlines',numlines,'screenlines',screen_lines # dbg | |
1686 | if numlines <= screen_lines : |
|
1686 | if numlines <= screen_lines : | |
1687 | #print '*** normal print' # dbg |
|
1687 | #print '*** normal print' # dbg | |
1688 | print >>Term.cout, str_toprint |
|
1688 | print >>Term.cout, str_toprint | |
1689 | else: |
|
1689 | else: | |
1690 | # Try to open pager and default to internal one if that fails. |
|
1690 | # Try to open pager and default to internal one if that fails. | |
1691 | # All failure modes are tagged as 'retval=1', to match the return |
|
1691 | # All failure modes are tagged as 'retval=1', to match the return | |
1692 | # value of a failed system command. If any intermediate attempt |
|
1692 | # value of a failed system command. If any intermediate attempt | |
1693 | # sets retval to 1, at the end we resort to our own page_dumb() pager. |
|
1693 | # sets retval to 1, at the end we resort to our own page_dumb() pager. | |
1694 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1694 | pager_cmd = get_pager_cmd(pager_cmd) | |
1695 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1695 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) | |
1696 | if os.name == 'nt': |
|
1696 | if os.name == 'nt': | |
1697 | if pager_cmd.startswith('type'): |
|
1697 | if pager_cmd.startswith('type'): | |
1698 | # The default WinXP 'type' command is failing on complex strings. |
|
1698 | # The default WinXP 'type' command is failing on complex strings. | |
1699 | retval = 1 |
|
1699 | retval = 1 | |
1700 | else: |
|
1700 | else: | |
1701 | tmpname = tempfile.mktemp('.txt') |
|
1701 | tmpname = tempfile.mktemp('.txt') | |
1702 | tmpfile = file(tmpname,'wt') |
|
1702 | tmpfile = file(tmpname,'wt') | |
1703 | tmpfile.write(strng) |
|
1703 | tmpfile.write(strng) | |
1704 | tmpfile.close() |
|
1704 | tmpfile.close() | |
1705 | cmd = "%s < %s" % (pager_cmd,tmpname) |
|
1705 | cmd = "%s < %s" % (pager_cmd,tmpname) | |
1706 | if os.system(cmd): |
|
1706 | if os.system(cmd): | |
1707 | retval = 1 |
|
1707 | retval = 1 | |
1708 | else: |
|
1708 | else: | |
1709 | retval = None |
|
1709 | retval = None | |
1710 | os.remove(tmpname) |
|
1710 | os.remove(tmpname) | |
1711 | else: |
|
1711 | else: | |
1712 | try: |
|
1712 | try: | |
1713 | retval = None |
|
1713 | retval = None | |
1714 | # if I use popen4, things hang. No idea why. |
|
1714 | # if I use popen4, things hang. No idea why. | |
1715 | #pager,shell_out = os.popen4(pager_cmd) |
|
1715 | #pager,shell_out = os.popen4(pager_cmd) | |
1716 | pager = os.popen(pager_cmd,'w') |
|
1716 | pager = os.popen(pager_cmd,'w') | |
1717 | pager.write(strng) |
|
1717 | pager.write(strng) | |
1718 | pager.close() |
|
1718 | pager.close() | |
1719 | retval = pager.close() # success returns None |
|
1719 | retval = pager.close() # success returns None | |
1720 | except IOError,msg: # broken pipe when user quits |
|
1720 | except IOError,msg: # broken pipe when user quits | |
1721 | if msg.args == (32,'Broken pipe'): |
|
1721 | if msg.args == (32,'Broken pipe'): | |
1722 | retval = None |
|
1722 | retval = None | |
1723 | else: |
|
1723 | else: | |
1724 | retval = 1 |
|
1724 | retval = 1 | |
1725 | except OSError: |
|
1725 | except OSError: | |
1726 | # Other strange problems, sometimes seen in Win2k/cygwin |
|
1726 | # Other strange problems, sometimes seen in Win2k/cygwin | |
1727 | retval = 1 |
|
1727 | retval = 1 | |
1728 | if retval is not None: |
|
1728 | if retval is not None: | |
1729 | page_dumb(strng,screen_lines=screen_lines) |
|
1729 | page_dumb(strng,screen_lines=screen_lines) | |
1730 |
|
1730 | |||
1731 | #---------------------------------------------------------------------------- |
|
1731 | #---------------------------------------------------------------------------- | |
1732 | def page_file(fname,start = 0, pager_cmd = None): |
|
1732 | def page_file(fname,start = 0, pager_cmd = None): | |
1733 | """Page a file, using an optional pager command and starting line. |
|
1733 | """Page a file, using an optional pager command and starting line. | |
1734 | """ |
|
1734 | """ | |
1735 |
|
1735 | |||
1736 | pager_cmd = get_pager_cmd(pager_cmd) |
|
1736 | pager_cmd = get_pager_cmd(pager_cmd) | |
1737 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) |
|
1737 | pager_cmd += ' ' + get_pager_start(pager_cmd,start) | |
1738 |
|
1738 | |||
1739 | try: |
|
1739 | try: | |
1740 | if os.environ['TERM'] in ['emacs','dumb']: |
|
1740 | if os.environ['TERM'] in ['emacs','dumb']: | |
1741 | raise EnvironmentError |
|
1741 | raise EnvironmentError | |
1742 | xsys(pager_cmd + ' ' + fname) |
|
1742 | xsys(pager_cmd + ' ' + fname) | |
1743 | except: |
|
1743 | except: | |
1744 | try: |
|
1744 | try: | |
1745 | if start > 0: |
|
1745 | if start > 0: | |
1746 | start -= 1 |
|
1746 | start -= 1 | |
1747 | page(open(fname).read(),start) |
|
1747 | page(open(fname).read(),start) | |
1748 | except: |
|
1748 | except: | |
1749 | print 'Unable to show file',`fname` |
|
1749 | print 'Unable to show file',`fname` | |
1750 |
|
1750 | |||
1751 |
|
1751 | |||
1752 | #---------------------------------------------------------------------------- |
|
1752 | #---------------------------------------------------------------------------- | |
1753 | def snip_print(str,width = 75,print_full = 0,header = ''): |
|
1753 | def snip_print(str,width = 75,print_full = 0,header = ''): | |
1754 | """Print a string snipping the midsection to fit in width. |
|
1754 | """Print a string snipping the midsection to fit in width. | |
1755 |
|
1755 | |||
1756 | print_full: mode control: |
|
1756 | print_full: mode control: | |
1757 | - 0: only snip long strings |
|
1757 | - 0: only snip long strings | |
1758 | - 1: send to page() directly. |
|
1758 | - 1: send to page() directly. | |
1759 | - 2: snip long strings and ask for full length viewing with page() |
|
1759 | - 2: snip long strings and ask for full length viewing with page() | |
1760 | Return 1 if snipping was necessary, 0 otherwise.""" |
|
1760 | Return 1 if snipping was necessary, 0 otherwise.""" | |
1761 |
|
1761 | |||
1762 | if print_full == 1: |
|
1762 | if print_full == 1: | |
1763 | page(header+str) |
|
1763 | page(header+str) | |
1764 | return 0 |
|
1764 | return 0 | |
1765 |
|
1765 | |||
1766 | print header, |
|
1766 | print header, | |
1767 | if len(str) < width: |
|
1767 | if len(str) < width: | |
1768 | print str |
|
1768 | print str | |
1769 | snip = 0 |
|
1769 | snip = 0 | |
1770 | else: |
|
1770 | else: | |
1771 | whalf = int((width -5)/2) |
|
1771 | whalf = int((width -5)/2) | |
1772 | print str[:whalf] + ' <...> ' + str[-whalf:] |
|
1772 | print str[:whalf] + ' <...> ' + str[-whalf:] | |
1773 | snip = 1 |
|
1773 | snip = 1 | |
1774 | if snip and print_full == 2: |
|
1774 | if snip and print_full == 2: | |
1775 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': |
|
1775 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': | |
1776 | page(str) |
|
1776 | page(str) | |
1777 | return snip |
|
1777 | return snip | |
1778 |
|
1778 | |||
1779 | #**************************************************************************** |
|
1779 | #**************************************************************************** | |
1780 | # lists, dicts and structures |
|
1780 | # lists, dicts and structures | |
1781 |
|
1781 | |||
1782 | def belong(candidates,checklist): |
|
1782 | def belong(candidates,checklist): | |
1783 | """Check whether a list of items appear in a given list of options. |
|
1783 | """Check whether a list of items appear in a given list of options. | |
1784 |
|
1784 | |||
1785 | Returns a list of 1 and 0, one for each candidate given.""" |
|
1785 | Returns a list of 1 and 0, one for each candidate given.""" | |
1786 |
|
1786 | |||
1787 | return [x in checklist for x in candidates] |
|
1787 | return [x in checklist for x in candidates] | |
1788 |
|
1788 | |||
1789 | #---------------------------------------------------------------------------- |
|
1789 | #---------------------------------------------------------------------------- | |
1790 | def uniq_stable(elems): |
|
1790 | def uniq_stable(elems): | |
1791 | """uniq_stable(elems) -> list |
|
1791 | """uniq_stable(elems) -> list | |
1792 |
|
1792 | |||
1793 | Return from an iterable, a list of all the unique elements in the input, |
|
1793 | Return from an iterable, a list of all the unique elements in the input, | |
1794 | but maintaining the order in which they first appear. |
|
1794 | but maintaining the order in which they first appear. | |
1795 |
|
1795 | |||
1796 | A naive solution to this problem which just makes a dictionary with the |
|
1796 | A naive solution to this problem which just makes a dictionary with the | |
1797 | elements as keys fails to respect the stability condition, since |
|
1797 | elements as keys fails to respect the stability condition, since | |
1798 | dictionaries are unsorted by nature. |
|
1798 | dictionaries are unsorted by nature. | |
1799 |
|
1799 | |||
1800 | Note: All elements in the input must be valid dictionary keys for this |
|
1800 | Note: All elements in the input must be valid dictionary keys for this | |
1801 | routine to work, as it internally uses a dictionary for efficiency |
|
1801 | routine to work, as it internally uses a dictionary for efficiency | |
1802 | reasons.""" |
|
1802 | reasons.""" | |
1803 |
|
1803 | |||
1804 | unique = [] |
|
1804 | unique = [] | |
1805 | unique_dict = {} |
|
1805 | unique_dict = {} | |
1806 | for nn in elems: |
|
1806 | for nn in elems: | |
1807 | if nn not in unique_dict: |
|
1807 | if nn not in unique_dict: | |
1808 | unique.append(nn) |
|
1808 | unique.append(nn) | |
1809 | unique_dict[nn] = None |
|
1809 | unique_dict[nn] = None | |
1810 | return unique |
|
1810 | return unique | |
1811 |
|
1811 | |||
1812 | #---------------------------------------------------------------------------- |
|
1812 | #---------------------------------------------------------------------------- | |
1813 | class NLprinter: |
|
1813 | class NLprinter: | |
1814 | """Print an arbitrarily nested list, indicating index numbers. |
|
1814 | """Print an arbitrarily nested list, indicating index numbers. | |
1815 |
|
1815 | |||
1816 | An instance of this class called nlprint is available and callable as a |
|
1816 | An instance of this class called nlprint is available and callable as a | |
1817 | function. |
|
1817 | function. | |
1818 |
|
1818 | |||
1819 | nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent' |
|
1819 | nlprint(list,indent=' ',sep=': ') -> prints indenting each level by 'indent' | |
1820 | and using 'sep' to separate the index from the value. """ |
|
1820 | and using 'sep' to separate the index from the value. """ | |
1821 |
|
1821 | |||
1822 | def __init__(self): |
|
1822 | def __init__(self): | |
1823 | self.depth = 0 |
|
1823 | self.depth = 0 | |
1824 |
|
1824 | |||
1825 | def __call__(self,lst,pos='',**kw): |
|
1825 | def __call__(self,lst,pos='',**kw): | |
1826 | """Prints the nested list numbering levels.""" |
|
1826 | """Prints the nested list numbering levels.""" | |
1827 | kw.setdefault('indent',' ') |
|
1827 | kw.setdefault('indent',' ') | |
1828 | kw.setdefault('sep',': ') |
|
1828 | kw.setdefault('sep',': ') | |
1829 | kw.setdefault('start',0) |
|
1829 | kw.setdefault('start',0) | |
1830 | kw.setdefault('stop',len(lst)) |
|
1830 | kw.setdefault('stop',len(lst)) | |
1831 | # we need to remove start and stop from kw so they don't propagate |
|
1831 | # we need to remove start and stop from kw so they don't propagate | |
1832 | # into a recursive call for a nested list. |
|
1832 | # into a recursive call for a nested list. | |
1833 | start = kw['start']; del kw['start'] |
|
1833 | start = kw['start']; del kw['start'] | |
1834 | stop = kw['stop']; del kw['stop'] |
|
1834 | stop = kw['stop']; del kw['stop'] | |
1835 | if self.depth == 0 and 'header' in kw.keys(): |
|
1835 | if self.depth == 0 and 'header' in kw.keys(): | |
1836 | print kw['header'] |
|
1836 | print kw['header'] | |
1837 |
|
1837 | |||
1838 | for idx in range(start,stop): |
|
1838 | for idx in range(start,stop): | |
1839 | elem = lst[idx] |
|
1839 | elem = lst[idx] | |
1840 | if type(elem)==type([]): |
|
1840 | if type(elem)==type([]): | |
1841 | self.depth += 1 |
|
1841 | self.depth += 1 | |
1842 | self.__call__(elem,itpl('$pos$idx,'),**kw) |
|
1842 | self.__call__(elem,itpl('$pos$idx,'),**kw) | |
1843 | self.depth -= 1 |
|
1843 | self.depth -= 1 | |
1844 | else: |
|
1844 | else: | |
1845 | printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem') |
|
1845 | printpl(kw['indent']*self.depth+'$pos$idx$kw["sep"]$elem') | |
1846 |
|
1846 | |||
1847 | nlprint = NLprinter() |
|
1847 | nlprint = NLprinter() | |
1848 | #---------------------------------------------------------------------------- |
|
1848 | #---------------------------------------------------------------------------- | |
1849 | def all_belong(candidates,checklist): |
|
1849 | def all_belong(candidates,checklist): | |
1850 | """Check whether a list of items ALL appear in a given list of options. |
|
1850 | """Check whether a list of items ALL appear in a given list of options. | |
1851 |
|
1851 | |||
1852 | Returns a single 1 or 0 value.""" |
|
1852 | Returns a single 1 or 0 value.""" | |
1853 |
|
1853 | |||
1854 | return 1-(0 in [x in checklist for x in candidates]) |
|
1854 | return 1-(0 in [x in checklist for x in candidates]) | |
1855 |
|
1855 | |||
1856 | #---------------------------------------------------------------------------- |
|
1856 | #---------------------------------------------------------------------------- | |
1857 | def sort_compare(lst1,lst2,inplace = 1): |
|
1857 | def sort_compare(lst1,lst2,inplace = 1): | |
1858 | """Sort and compare two lists. |
|
1858 | """Sort and compare two lists. | |
1859 |
|
1859 | |||
1860 | By default it does it in place, thus modifying the lists. Use inplace = 0 |
|
1860 | By default it does it in place, thus modifying the lists. Use inplace = 0 | |
1861 | to avoid that (at the cost of temporary copy creation).""" |
|
1861 | to avoid that (at the cost of temporary copy creation).""" | |
1862 | if not inplace: |
|
1862 | if not inplace: | |
1863 | lst1 = lst1[:] |
|
1863 | lst1 = lst1[:] | |
1864 | lst2 = lst2[:] |
|
1864 | lst2 = lst2[:] | |
1865 | lst1.sort(); lst2.sort() |
|
1865 | lst1.sort(); lst2.sort() | |
1866 | return lst1 == lst2 |
|
1866 | return lst1 == lst2 | |
1867 |
|
1867 | |||
1868 | #---------------------------------------------------------------------------- |
|
1868 | #---------------------------------------------------------------------------- | |
1869 | def list2dict(lst): |
|
1869 | def list2dict(lst): | |
1870 | """Takes a list of (key,value) pairs and turns it into a dict.""" |
|
1870 | """Takes a list of (key,value) pairs and turns it into a dict.""" | |
1871 |
|
1871 | |||
1872 | dic = {} |
|
1872 | dic = {} | |
1873 | for k,v in lst: dic[k] = v |
|
1873 | for k,v in lst: dic[k] = v | |
1874 | return dic |
|
1874 | return dic | |
1875 |
|
1875 | |||
1876 | #---------------------------------------------------------------------------- |
|
1876 | #---------------------------------------------------------------------------- | |
1877 | def list2dict2(lst,default=''): |
|
1877 | def list2dict2(lst,default=''): | |
1878 | """Takes a list and turns it into a dict. |
|
1878 | """Takes a list and turns it into a dict. | |
1879 | Much slower than list2dict, but more versatile. This version can take |
|
1879 | Much slower than list2dict, but more versatile. This version can take | |
1880 | lists with sublists of arbitrary length (including sclars).""" |
|
1880 | lists with sublists of arbitrary length (including sclars).""" | |
1881 |
|
1881 | |||
1882 | dic = {} |
|
1882 | dic = {} | |
1883 | for elem in lst: |
|
1883 | for elem in lst: | |
1884 | if type(elem) in (types.ListType,types.TupleType): |
|
1884 | if type(elem) in (types.ListType,types.TupleType): | |
1885 | size = len(elem) |
|
1885 | size = len(elem) | |
1886 | if size == 0: |
|
1886 | if size == 0: | |
1887 | pass |
|
1887 | pass | |
1888 | elif size == 1: |
|
1888 | elif size == 1: | |
1889 | dic[elem] = default |
|
1889 | dic[elem] = default | |
1890 | else: |
|
1890 | else: | |
1891 | k,v = elem[0], elem[1:] |
|
1891 | k,v = elem[0], elem[1:] | |
1892 | if len(v) == 1: v = v[0] |
|
1892 | if len(v) == 1: v = v[0] | |
1893 | dic[k] = v |
|
1893 | dic[k] = v | |
1894 | else: |
|
1894 | else: | |
1895 | dic[elem] = default |
|
1895 | dic[elem] = default | |
1896 | return dic |
|
1896 | return dic | |
1897 |
|
1897 | |||
1898 | #---------------------------------------------------------------------------- |
|
1898 | #---------------------------------------------------------------------------- | |
1899 | def flatten(seq): |
|
1899 | def flatten(seq): | |
1900 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" |
|
1900 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" | |
1901 |
|
1901 | |||
1902 | return [x for subseq in seq for x in subseq] |
|
1902 | return [x for subseq in seq for x in subseq] | |
1903 |
|
1903 | |||
1904 | #---------------------------------------------------------------------------- |
|
1904 | #---------------------------------------------------------------------------- | |
1905 | def get_slice(seq,start=0,stop=None,step=1): |
|
1905 | def get_slice(seq,start=0,stop=None,step=1): | |
1906 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" |
|
1906 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" | |
1907 | if stop == None: |
|
1907 | if stop == None: | |
1908 | stop = len(seq) |
|
1908 | stop = len(seq) | |
1909 | item = lambda i: seq[i] |
|
1909 | item = lambda i: seq[i] | |
1910 | return map(item,xrange(start,stop,step)) |
|
1910 | return map(item,xrange(start,stop,step)) | |
1911 |
|
1911 | |||
1912 | #---------------------------------------------------------------------------- |
|
1912 | #---------------------------------------------------------------------------- | |
1913 | def chop(seq,size): |
|
1913 | def chop(seq,size): | |
1914 | """Chop a sequence into chunks of the given size.""" |
|
1914 | """Chop a sequence into chunks of the given size.""" | |
1915 | chunk = lambda i: seq[i:i+size] |
|
1915 | chunk = lambda i: seq[i:i+size] | |
1916 | return map(chunk,xrange(0,len(seq),size)) |
|
1916 | return map(chunk,xrange(0,len(seq),size)) | |
1917 |
|
1917 | |||
1918 | #---------------------------------------------------------------------------- |
|
1918 | #---------------------------------------------------------------------------- | |
1919 | # with is a keyword as of python 2.5, so this function is renamed to withobj |
|
1919 | # with is a keyword as of python 2.5, so this function is renamed to withobj | |
1920 | # from its old 'with' name. |
|
1920 | # from its old 'with' name. | |
1921 | def with_obj(object, **args): |
|
1921 | def with_obj(object, **args): | |
1922 | """Set multiple attributes for an object, similar to Pascal's with. |
|
1922 | """Set multiple attributes for an object, similar to Pascal's with. | |
1923 |
|
1923 | |||
1924 | Example: |
|
1924 | Example: | |
1925 | with_obj(jim, |
|
1925 | with_obj(jim, | |
1926 | born = 1960, |
|
1926 | born = 1960, | |
1927 | haircolour = 'Brown', |
|
1927 | haircolour = 'Brown', | |
1928 | eyecolour = 'Green') |
|
1928 | eyecolour = 'Green') | |
1929 |
|
1929 | |||
1930 | Credit: Greg Ewing, in |
|
1930 | Credit: Greg Ewing, in | |
1931 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. |
|
1931 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. | |
1932 |
|
1932 | |||
1933 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' |
|
1933 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' | |
1934 | has become a keyword for Python 2.5, so we had to rename it.""" |
|
1934 | has become a keyword for Python 2.5, so we had to rename it.""" | |
1935 |
|
1935 | |||
1936 | object.__dict__.update(args) |
|
1936 | object.__dict__.update(args) | |
1937 |
|
1937 | |||
1938 | #---------------------------------------------------------------------------- |
|
1938 | #---------------------------------------------------------------------------- | |
1939 | def setattr_list(obj,alist,nspace = None): |
|
1939 | def setattr_list(obj,alist,nspace = None): | |
1940 | """Set a list of attributes for an object taken from a namespace. |
|
1940 | """Set a list of attributes for an object taken from a namespace. | |
1941 |
|
1941 | |||
1942 | setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in |
|
1942 | setattr_list(obj,alist,nspace) -> sets in obj all the attributes listed in | |
1943 | alist with their values taken from nspace, which must be a dict (something |
|
1943 | alist with their values taken from nspace, which must be a dict (something | |
1944 | like locals() will often do) If nspace isn't given, locals() of the |
|
1944 | like locals() will often do) If nspace isn't given, locals() of the | |
1945 | *caller* is used, so in most cases you can omit it. |
|
1945 | *caller* is used, so in most cases you can omit it. | |
1946 |
|
1946 | |||
1947 | Note that alist can be given as a string, which will be automatically |
|
1947 | Note that alist can be given as a string, which will be automatically | |
1948 | split into a list on whitespace. If given as a list, it must be a list of |
|
1948 | split into a list on whitespace. If given as a list, it must be a list of | |
1949 | *strings* (the variable names themselves), not of variables.""" |
|
1949 | *strings* (the variable names themselves), not of variables.""" | |
1950 |
|
1950 | |||
1951 | # this grabs the local variables from the *previous* call frame -- that is |
|
1951 | # this grabs the local variables from the *previous* call frame -- that is | |
1952 | # the locals from the function that called setattr_list(). |
|
1952 | # the locals from the function that called setattr_list(). | |
1953 | # - snipped from weave.inline() |
|
1953 | # - snipped from weave.inline() | |
1954 | if nspace is None: |
|
1954 | if nspace is None: | |
1955 | call_frame = sys._getframe().f_back |
|
1955 | call_frame = sys._getframe().f_back | |
1956 | nspace = call_frame.f_locals |
|
1956 | nspace = call_frame.f_locals | |
1957 |
|
1957 | |||
1958 | if type(alist) in StringTypes: |
|
1958 | if type(alist) in StringTypes: | |
1959 | alist = alist.split() |
|
1959 | alist = alist.split() | |
1960 | for attr in alist: |
|
1960 | for attr in alist: | |
1961 | val = eval(attr,nspace) |
|
1961 | val = eval(attr,nspace) | |
1962 | setattr(obj,attr,val) |
|
1962 | setattr(obj,attr,val) | |
1963 |
|
1963 | |||
1964 | #---------------------------------------------------------------------------- |
|
1964 | #---------------------------------------------------------------------------- | |
1965 | def getattr_list(obj,alist,*args): |
|
1965 | def getattr_list(obj,alist,*args): | |
1966 | """getattr_list(obj,alist[, default]) -> attribute list. |
|
1966 | """getattr_list(obj,alist[, default]) -> attribute list. | |
1967 |
|
1967 | |||
1968 | Get a list of named attributes for an object. When a default argument is |
|
1968 | Get a list of named attributes for an object. When a default argument is | |
1969 | given, it is returned when the attribute doesn't exist; without it, an |
|
1969 | given, it is returned when the attribute doesn't exist; without it, an | |
1970 | exception is raised in that case. |
|
1970 | exception is raised in that case. | |
1971 |
|
1971 | |||
1972 | Note that alist can be given as a string, which will be automatically |
|
1972 | Note that alist can be given as a string, which will be automatically | |
1973 | split into a list on whitespace. If given as a list, it must be a list of |
|
1973 | split into a list on whitespace. If given as a list, it must be a list of | |
1974 | *strings* (the variable names themselves), not of variables.""" |
|
1974 | *strings* (the variable names themselves), not of variables.""" | |
1975 |
|
1975 | |||
1976 | if type(alist) in StringTypes: |
|
1976 | if type(alist) in StringTypes: | |
1977 | alist = alist.split() |
|
1977 | alist = alist.split() | |
1978 | if args: |
|
1978 | if args: | |
1979 | if len(args)==1: |
|
1979 | if len(args)==1: | |
1980 | default = args[0] |
|
1980 | default = args[0] | |
1981 | return map(lambda attr: getattr(obj,attr,default),alist) |
|
1981 | return map(lambda attr: getattr(obj,attr,default),alist) | |
1982 | else: |
|
1982 | else: | |
1983 | raise ValueError,'getattr_list() takes only one optional argument' |
|
1983 | raise ValueError,'getattr_list() takes only one optional argument' | |
1984 | else: |
|
1984 | else: | |
1985 | return map(lambda attr: getattr(obj,attr),alist) |
|
1985 | return map(lambda attr: getattr(obj,attr),alist) | |
1986 |
|
1986 | |||
1987 | #---------------------------------------------------------------------------- |
|
1987 | #---------------------------------------------------------------------------- | |
1988 | def map_method(method,object_list,*argseq,**kw): |
|
1988 | def map_method(method,object_list,*argseq,**kw): | |
1989 | """map_method(method,object_list,*args,**kw) -> list |
|
1989 | """map_method(method,object_list,*args,**kw) -> list | |
1990 |
|
1990 | |||
1991 | Return a list of the results of applying the methods to the items of the |
|
1991 | Return a list of the results of applying the methods to the items of the | |
1992 | argument sequence(s). If more than one sequence is given, the method is |
|
1992 | argument sequence(s). If more than one sequence is given, the method is | |
1993 | called with an argument list consisting of the corresponding item of each |
|
1993 | called with an argument list consisting of the corresponding item of each | |
1994 | sequence. All sequences must be of the same length. |
|
1994 | sequence. All sequences must be of the same length. | |
1995 |
|
1995 | |||
1996 | Keyword arguments are passed verbatim to all objects called. |
|
1996 | Keyword arguments are passed verbatim to all objects called. | |
1997 |
|
1997 | |||
1998 | This is Python code, so it's not nearly as fast as the builtin map().""" |
|
1998 | This is Python code, so it's not nearly as fast as the builtin map().""" | |
1999 |
|
1999 | |||
2000 | out_list = [] |
|
2000 | out_list = [] | |
2001 | idx = 0 |
|
2001 | idx = 0 | |
2002 | for object in object_list: |
|
2002 | for object in object_list: | |
2003 | try: |
|
2003 | try: | |
2004 | handler = getattr(object, method) |
|
2004 | handler = getattr(object, method) | |
2005 | except AttributeError: |
|
2005 | except AttributeError: | |
2006 | out_list.append(None) |
|
2006 | out_list.append(None) | |
2007 | else: |
|
2007 | else: | |
2008 | if argseq: |
|
2008 | if argseq: | |
2009 | args = map(lambda lst:lst[idx],argseq) |
|
2009 | args = map(lambda lst:lst[idx],argseq) | |
2010 | #print 'ob',object,'hand',handler,'ar',args # dbg |
|
2010 | #print 'ob',object,'hand',handler,'ar',args # dbg | |
2011 | out_list.append(handler(args,**kw)) |
|
2011 | out_list.append(handler(args,**kw)) | |
2012 | else: |
|
2012 | else: | |
2013 | out_list.append(handler(**kw)) |
|
2013 | out_list.append(handler(**kw)) | |
2014 | idx += 1 |
|
2014 | idx += 1 | |
2015 | return out_list |
|
2015 | return out_list | |
2016 |
|
2016 | |||
2017 | #---------------------------------------------------------------------------- |
|
2017 | #---------------------------------------------------------------------------- | |
2018 | def get_class_members(cls): |
|
2018 | def get_class_members(cls): | |
2019 | ret = dir(cls) |
|
2019 | ret = dir(cls) | |
2020 | if hasattr(cls,'__bases__'): |
|
2020 | if hasattr(cls,'__bases__'): | |
2021 | for base in cls.__bases__: |
|
2021 | for base in cls.__bases__: | |
2022 | ret.extend(get_class_members(base)) |
|
2022 | ret.extend(get_class_members(base)) | |
2023 | return ret |
|
2023 | return ret | |
2024 |
|
2024 | |||
2025 | #---------------------------------------------------------------------------- |
|
2025 | #---------------------------------------------------------------------------- | |
2026 | def dir2(obj): |
|
2026 | def dir2(obj): | |
2027 | """dir2(obj) -> list of strings |
|
2027 | """dir2(obj) -> list of strings | |
2028 |
|
2028 | |||
2029 | Extended version of the Python builtin dir(), which does a few extra |
|
2029 | Extended version of the Python builtin dir(), which does a few extra | |
2030 | checks, and supports common objects with unusual internals that confuse |
|
2030 | checks, and supports common objects with unusual internals that confuse | |
2031 | dir(), such as Traits and PyCrust. |
|
2031 | dir(), such as Traits and PyCrust. | |
2032 |
|
2032 | |||
2033 | This version is guaranteed to return only a list of true strings, whereas |
|
2033 | This version is guaranteed to return only a list of true strings, whereas | |
2034 | dir() returns anything that objects inject into themselves, even if they |
|
2034 | dir() returns anything that objects inject into themselves, even if they | |
2035 | are later not really valid for attribute access (many extension libraries |
|
2035 | are later not really valid for attribute access (many extension libraries | |
2036 | have such bugs). |
|
2036 | have such bugs). | |
2037 | """ |
|
2037 | """ | |
2038 |
|
2038 | |||
2039 | # Start building the attribute list via dir(), and then complete it |
|
2039 | # Start building the attribute list via dir(), and then complete it | |
2040 | # with a few extra special-purpose calls. |
|
2040 | # with a few extra special-purpose calls. | |
2041 | words = dir(obj) |
|
2041 | words = dir(obj) | |
2042 |
|
2042 | |||
2043 | if hasattr(obj,'__class__'): |
|
2043 | if hasattr(obj,'__class__'): | |
2044 | words.append('__class__') |
|
2044 | words.append('__class__') | |
2045 | words.extend(get_class_members(obj.__class__)) |
|
2045 | words.extend(get_class_members(obj.__class__)) | |
2046 | #if '__base__' in words: 1/0 |
|
2046 | #if '__base__' in words: 1/0 | |
2047 |
|
2047 | |||
2048 | # Some libraries (such as traits) may introduce duplicates, we want to |
|
2048 | # Some libraries (such as traits) may introduce duplicates, we want to | |
2049 | # track and clean this up if it happens |
|
2049 | # track and clean this up if it happens | |
2050 | may_have_dupes = False |
|
2050 | may_have_dupes = False | |
2051 |
|
2051 | |||
2052 | # this is the 'dir' function for objects with Enthought's traits |
|
2052 | # this is the 'dir' function for objects with Enthought's traits | |
2053 | if hasattr(obj, 'trait_names'): |
|
2053 | if hasattr(obj, 'trait_names'): | |
2054 | try: |
|
2054 | try: | |
2055 | words.extend(obj.trait_names()) |
|
2055 | words.extend(obj.trait_names()) | |
2056 | may_have_dupes = True |
|
2056 | may_have_dupes = True | |
2057 | except TypeError: |
|
2057 | except TypeError: | |
2058 | # This will happen if `obj` is a class and not an instance. |
|
2058 | # This will happen if `obj` is a class and not an instance. | |
2059 | pass |
|
2059 | pass | |
2060 |
|
2060 | |||
2061 | # Support for PyCrust-style _getAttributeNames magic method. |
|
2061 | # Support for PyCrust-style _getAttributeNames magic method. | |
2062 | if hasattr(obj, '_getAttributeNames'): |
|
2062 | if hasattr(obj, '_getAttributeNames'): | |
2063 | try: |
|
2063 | try: | |
2064 | words.extend(obj._getAttributeNames()) |
|
2064 | words.extend(obj._getAttributeNames()) | |
2065 | may_have_dupes = True |
|
2065 | may_have_dupes = True | |
2066 | except TypeError: |
|
2066 | except TypeError: | |
2067 | # `obj` is a class and not an instance. Ignore |
|
2067 | # `obj` is a class and not an instance. Ignore | |
2068 | # this error. |
|
2068 | # this error. | |
2069 | pass |
|
2069 | pass | |
2070 |
|
2070 | |||
2071 | if may_have_dupes: |
|
2071 | if may_have_dupes: | |
2072 | # eliminate possible duplicates, as some traits may also |
|
2072 | # eliminate possible duplicates, as some traits may also | |
2073 | # appear as normal attributes in the dir() call. |
|
2073 | # appear as normal attributes in the dir() call. | |
2074 | words = list(set(words)) |
|
2074 | words = list(set(words)) | |
2075 | words.sort() |
|
2075 | words.sort() | |
2076 |
|
2076 | |||
2077 | # filter out non-string attributes which may be stuffed by dir() calls |
|
2077 | # filter out non-string attributes which may be stuffed by dir() calls | |
2078 | # and poor coding in third-party modules |
|
2078 | # and poor coding in third-party modules | |
2079 | return [w for w in words if isinstance(w, basestring)] |
|
2079 | return [w for w in words if isinstance(w, basestring)] | |
2080 |
|
2080 | |||
2081 | #---------------------------------------------------------------------------- |
|
2081 | #---------------------------------------------------------------------------- | |
2082 | def import_fail_info(mod_name,fns=None): |
|
2082 | def import_fail_info(mod_name,fns=None): | |
2083 | """Inform load failure for a module.""" |
|
2083 | """Inform load failure for a module.""" | |
2084 |
|
2084 | |||
2085 | if fns == None: |
|
2085 | if fns == None: | |
2086 | warn("Loading of %s failed.\n" % (mod_name,)) |
|
2086 | warn("Loading of %s failed.\n" % (mod_name,)) | |
2087 | else: |
|
2087 | else: | |
2088 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) |
|
2088 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) | |
2089 |
|
2089 | |||
2090 | #---------------------------------------------------------------------------- |
|
2090 | #---------------------------------------------------------------------------- | |
2091 | # Proposed popitem() extension, written as a method |
|
2091 | # Proposed popitem() extension, written as a method | |
2092 |
|
2092 | |||
2093 |
|
2093 | |||
2094 | class NotGiven: pass |
|
2094 | class NotGiven: pass | |
2095 |
|
2095 | |||
2096 | def popkey(dct,key,default=NotGiven): |
|
2096 | def popkey(dct,key,default=NotGiven): | |
2097 | """Return dct[key] and delete dct[key]. |
|
2097 | """Return dct[key] and delete dct[key]. | |
2098 |
|
2098 | |||
2099 | If default is given, return it if dct[key] doesn't exist, otherwise raise |
|
2099 | If default is given, return it if dct[key] doesn't exist, otherwise raise | |
2100 | KeyError. """ |
|
2100 | KeyError. """ | |
2101 |
|
2101 | |||
2102 | try: |
|
2102 | try: | |
2103 | val = dct[key] |
|
2103 | val = dct[key] | |
2104 | except KeyError: |
|
2104 | except KeyError: | |
2105 | if default is NotGiven: |
|
2105 | if default is NotGiven: | |
2106 | raise |
|
2106 | raise | |
2107 | else: |
|
2107 | else: | |
2108 | return default |
|
2108 | return default | |
2109 | else: |
|
2109 | else: | |
2110 | del dct[key] |
|
2110 | del dct[key] | |
2111 | return val |
|
2111 | return val | |
2112 |
|
2112 | |||
2113 | def wrap_deprecated(func, suggest = '<nothing>'): |
|
2113 | def wrap_deprecated(func, suggest = '<nothing>'): | |
2114 | def newFunc(*args, **kwargs): |
|
2114 | def newFunc(*args, **kwargs): | |
2115 | warnings.warn("Call to deprecated function %s, use %s instead" % |
|
2115 | warnings.warn("Call to deprecated function %s, use %s instead" % | |
2116 | ( func.__name__, suggest), |
|
2116 | ( func.__name__, suggest), | |
2117 | category=DeprecationWarning, |
|
2117 | category=DeprecationWarning, | |
2118 | stacklevel = 2) |
|
2118 | stacklevel = 2) | |
2119 | return func(*args, **kwargs) |
|
2119 | return func(*args, **kwargs) | |
2120 | return newFunc |
|
2120 | return newFunc | |
2121 |
|
2121 | |||
2122 |
|
2122 | |||
2123 | def _num_cpus_unix(): |
|
2123 | def _num_cpus_unix(): | |
2124 | """Return the number of active CPUs on a Unix system.""" |
|
2124 | """Return the number of active CPUs on a Unix system.""" | |
2125 | return os.sysconf("SC_NPROCESSORS_ONLN") |
|
2125 | return os.sysconf("SC_NPROCESSORS_ONLN") | |
2126 |
|
2126 | |||
2127 |
|
2127 | |||
2128 | def _num_cpus_darwin(): |
|
2128 | def _num_cpus_darwin(): | |
2129 | """Return the number of active CPUs on a Darwin system.""" |
|
2129 | """Return the number of active CPUs on a Darwin system.""" | |
2130 | p = subprocess.Popen(['sysctl','-n','hw.ncpu'],stdout=subprocess.PIPE) |
|
2130 | p = subprocess.Popen(['sysctl','-n','hw.ncpu'],stdout=subprocess.PIPE) | |
2131 | return p.stdout.read() |
|
2131 | return p.stdout.read() | |
2132 |
|
2132 | |||
2133 |
|
2133 | |||
2134 | def _num_cpus_windows(): |
|
2134 | def _num_cpus_windows(): | |
2135 | """Return the number of active CPUs on a Windows system.""" |
|
2135 | """Return the number of active CPUs on a Windows system.""" | |
2136 | return os.environ.get("NUMBER_OF_PROCESSORS") |
|
2136 | return os.environ.get("NUMBER_OF_PROCESSORS") | |
2137 |
|
2137 | |||
2138 |
|
2138 | |||
2139 | def num_cpus(): |
|
2139 | def num_cpus(): | |
2140 | """Return the effective number of CPUs in the system as an integer. |
|
2140 | """Return the effective number of CPUs in the system as an integer. | |
2141 |
|
2141 | |||
2142 | This cross-platform function makes an attempt at finding the total number of |
|
2142 | This cross-platform function makes an attempt at finding the total number of | |
2143 | available CPUs in the system, as returned by various underlying system and |
|
2143 | available CPUs in the system, as returned by various underlying system and | |
2144 | python calls. |
|
2144 | python calls. | |
2145 |
|
2145 | |||
2146 | If it can't find a sensible answer, it returns 1 (though an error *may* make |
|
2146 | If it can't find a sensible answer, it returns 1 (though an error *may* make | |
2147 | it return a large positive number that's actually incorrect). |
|
2147 | it return a large positive number that's actually incorrect). | |
2148 | """ |
|
2148 | """ | |
2149 |
|
2149 | |||
2150 | # Many thanks to the Parallel Python project (http://www.parallelpython.com) |
|
2150 | # Many thanks to the Parallel Python project (http://www.parallelpython.com) | |
2151 | # for the names of the keys we needed to look up for this function. This |
|
2151 | # for the names of the keys we needed to look up for this function. This | |
2152 | # code was inspired by their equivalent function. |
|
2152 | # code was inspired by their equivalent function. | |
2153 |
|
2153 | |||
2154 | ncpufuncs = {'Linux':_num_cpus_unix, |
|
2154 | ncpufuncs = {'Linux':_num_cpus_unix, | |
2155 | 'Darwin':_num_cpus_darwin, |
|
2155 | 'Darwin':_num_cpus_darwin, | |
2156 | 'Windows':_num_cpus_windows, |
|
2156 | 'Windows':_num_cpus_windows, | |
2157 | # On Vista, python < 2.5.2 has a bug and returns 'Microsoft' |
|
2157 | # On Vista, python < 2.5.2 has a bug and returns 'Microsoft' | |
2158 | # See http://bugs.python.org/issue1082 for details. |
|
2158 | # See http://bugs.python.org/issue1082 for details. | |
2159 | 'Microsoft':_num_cpus_windows, |
|
2159 | 'Microsoft':_num_cpus_windows, | |
2160 | } |
|
2160 | } | |
2161 |
|
2161 | |||
2162 | ncpufunc = ncpufuncs.get(platform.system(), |
|
2162 | ncpufunc = ncpufuncs.get(platform.system(), | |
2163 | # default to unix version (Solaris, AIX, etc) |
|
2163 | # default to unix version (Solaris, AIX, etc) | |
2164 | _num_cpus_unix) |
|
2164 | _num_cpus_unix) | |
2165 |
|
2165 | |||
2166 | try: |
|
2166 | try: | |
2167 | ncpus = max(1,int(ncpufunc())) |
|
2167 | ncpus = max(1,int(ncpufunc())) | |
2168 | except: |
|
2168 | except: | |
2169 | ncpus = 1 |
|
2169 | ncpus = 1 | |
2170 | return ncpus |
|
2170 | return ncpus | |
2171 |
|
2171 | |||
2172 | #*************************** end of file <genutils.py> ********************** |
|
2172 | #*************************** end of file <genutils.py> ********************** |
@@ -1,55 +1,55 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ Imports and provides the 'correct' version of readline for the platform. |
|
2 | """ Imports and provides the 'correct' version of readline for the platform. | |
3 |
|
3 | |||
4 | Readline is used throughout IPython as 'import IPython.rlineimpl as readline'. |
|
4 | Readline is used throughout IPython as 'import IPython.utils.rlineimpl as readline'. | |
5 |
|
5 | |||
6 | In addition to normal readline stuff, this module provides have_readline |
|
6 | In addition to normal readline stuff, this module provides have_readline | |
7 | boolean and _outputfile variable used in genutils. |
|
7 | boolean and _outputfile variable used in genutils. | |
8 | """ |
|
8 | """ | |
9 |
|
9 | |||
10 | import sys |
|
10 | import sys | |
11 |
|
11 | |||
12 | try: |
|
12 | try: | |
13 | from readline import * |
|
13 | from readline import * | |
14 | import readline as _rl |
|
14 | import readline as _rl | |
15 | have_readline = True |
|
15 | have_readline = True | |
16 | except ImportError: |
|
16 | except ImportError: | |
17 | try: |
|
17 | try: | |
18 | from pyreadline import * |
|
18 | from pyreadline import * | |
19 | import pyreadline as _rl |
|
19 | import pyreadline as _rl | |
20 | have_readline = True |
|
20 | have_readline = True | |
21 | except ImportError: |
|
21 | except ImportError: | |
22 | have_readline = False |
|
22 | have_readline = False | |
23 |
|
23 | |||
24 | if sys.platform == 'win32' and have_readline: |
|
24 | if sys.platform == 'win32' and have_readline: | |
25 | try: |
|
25 | try: | |
26 | _outputfile=_rl.GetOutputFile() |
|
26 | _outputfile=_rl.GetOutputFile() | |
27 | except AttributeError: |
|
27 | except AttributeError: | |
28 | print "Failed GetOutputFile" |
|
28 | print "Failed GetOutputFile" | |
29 | have_readline = False |
|
29 | have_readline = False | |
30 |
|
30 | |||
31 | # Test to see if libedit is being used instead of GNU readline. |
|
31 | # Test to see if libedit is being used instead of GNU readline. | |
32 | # Thanks to Boyd Waters for this patch. |
|
32 | # Thanks to Boyd Waters for this patch. | |
33 | uses_libedit = False |
|
33 | uses_libedit = False | |
34 | if sys.platform == 'darwin' and have_readline: |
|
34 | if sys.platform == 'darwin' and have_readline: | |
35 | import commands |
|
35 | import commands | |
36 | (status, result) = commands.getstatusoutput( "otool -L %s | grep libedit" % _rl.__file__ ) |
|
36 | (status, result) = commands.getstatusoutput( "otool -L %s | grep libedit" % _rl.__file__ ) | |
37 | if status == 0 and len(result) > 0: |
|
37 | if status == 0 and len(result) > 0: | |
38 | # we are bound to libedit - new in Leopard |
|
38 | # we are bound to libedit - new in Leopard | |
39 | _rl.parse_and_bind("bind ^I rl_complete") |
|
39 | _rl.parse_and_bind("bind ^I rl_complete") | |
40 | print "Leopard libedit detected." |
|
40 | print "Leopard libedit detected." | |
41 | uses_libedit = True |
|
41 | uses_libedit = True | |
42 |
|
42 | |||
43 |
|
43 | |||
44 | # the clear_history() function was only introduced in Python 2.4 and is |
|
44 | # the clear_history() function was only introduced in Python 2.4 and is | |
45 | # actually optional in the readline API, so we must explicitly check for its |
|
45 | # actually optional in the readline API, so we must explicitly check for its | |
46 | # existence. Some known platforms actually don't have it. This thread: |
|
46 | # existence. Some known platforms actually don't have it. This thread: | |
47 | # http://mail.python.org/pipermail/python-dev/2003-August/037845.html |
|
47 | # http://mail.python.org/pipermail/python-dev/2003-August/037845.html | |
48 | # has the original discussion. |
|
48 | # has the original discussion. | |
49 |
|
49 | |||
50 | if have_readline: |
|
50 | if have_readline: | |
51 | try: |
|
51 | try: | |
52 | _rl.clear_history |
|
52 | _rl.clear_history | |
53 | except AttributeError: |
|
53 | except AttributeError: | |
54 | def clear_history(): pass |
|
54 | def clear_history(): pass | |
55 | _rl.clear_history = clear_history |
|
55 | _rl.clear_history = clear_history |
@@ -1,23 +1,26 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 | ||||
|
25 | def test_import_rlineimpl(): | |||
|
26 | from IPython.utils import rlineimpl No newline at end of file |
General Comments 0
You need to be logged in to leave comments.
Login now