Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,166 +1,166 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | # encoding: utf-8 |
|
3 | 3 | """ |
|
4 | 4 | Tests for IPython.config.configurable |
|
5 | 5 | |
|
6 | 6 | Authors: |
|
7 | 7 | |
|
8 | 8 | * Brian Granger |
|
9 | 9 | * Fernando Perez (design help) |
|
10 | 10 | """ |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Copyright (C) 2008-2010 The IPython Development Team |
|
14 | 14 | # |
|
15 | 15 | # Distributed under the terms of the BSD License. The full license is in |
|
16 | 16 | # the file COPYING, distributed as part of this software. |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | # Imports |
|
21 | 21 | #----------------------------------------------------------------------------- |
|
22 | 22 | |
|
23 | 23 | from unittest import TestCase |
|
24 | 24 | |
|
25 | 25 | from IPython.config.configurable import ( |
|
26 | 26 | Configurable, |
|
27 | 27 | SingletonConfigurable |
|
28 | 28 | ) |
|
29 | 29 | |
|
30 | 30 | from IPython.utils.traitlets import ( |
|
31 |
Int, Float, |
|
|
31 | Int, Float, Unicode | |
|
32 | 32 | ) |
|
33 | 33 | |
|
34 | 34 | from IPython.config.loader import Config |
|
35 | 35 | |
|
36 | 36 | |
|
37 | 37 | #----------------------------------------------------------------------------- |
|
38 | 38 | # Test cases |
|
39 | 39 | #----------------------------------------------------------------------------- |
|
40 | 40 | |
|
41 | 41 | |
|
42 | 42 | class MyConfigurable(Configurable): |
|
43 | 43 | a = Int(1, config=True, help="The integer a.") |
|
44 | 44 | b = Float(1.0, config=True, help="The integer b.") |
|
45 |
c = |
|
|
45 | c = Unicode('no config') | |
|
46 | 46 | |
|
47 | 47 | |
|
48 | 48 | mc_help=u"""MyConfigurable options |
|
49 | 49 | ---------------------- |
|
50 | 50 | MyConfigurable.a : Int |
|
51 | 51 | Default: 1 |
|
52 | 52 | The integer a. |
|
53 | 53 | MyConfigurable.b : Float |
|
54 | 54 | Default: 1.0 |
|
55 | 55 | The integer b.""" |
|
56 | 56 | |
|
57 | 57 | class Foo(Configurable): |
|
58 | 58 | a = Int(0, config=True, help="The integer a.") |
|
59 |
b = |
|
|
59 | b = Unicode('nope', config=True) | |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | class Bar(Foo): |
|
63 |
b = |
|
|
63 | b = Unicode('gotit', config=False, help="The string b.") | |
|
64 | 64 | c = Float(config=True, help="The string c.") |
|
65 | 65 | |
|
66 | 66 | |
|
67 | 67 | class TestConfigurable(TestCase): |
|
68 | 68 | |
|
69 | 69 | def test_default(self): |
|
70 | 70 | c1 = Configurable() |
|
71 | 71 | c2 = Configurable(config=c1.config) |
|
72 | 72 | c3 = Configurable(config=c2.config) |
|
73 | 73 | self.assertEquals(c1.config, c2.config) |
|
74 | 74 | self.assertEquals(c2.config, c3.config) |
|
75 | 75 | |
|
76 | 76 | def test_custom(self): |
|
77 | 77 | config = Config() |
|
78 | 78 | config.foo = 'foo' |
|
79 | 79 | config.bar = 'bar' |
|
80 | 80 | c1 = Configurable(config=config) |
|
81 | 81 | c2 = Configurable(config=c1.config) |
|
82 | 82 | c3 = Configurable(config=c2.config) |
|
83 | 83 | self.assertEquals(c1.config, config) |
|
84 | 84 | self.assertEquals(c2.config, config) |
|
85 | 85 | self.assertEquals(c3.config, config) |
|
86 | 86 | # Test that copies are not made |
|
87 | 87 | self.assert_(c1.config is config) |
|
88 | 88 | self.assert_(c2.config is config) |
|
89 | 89 | self.assert_(c3.config is config) |
|
90 | 90 | self.assert_(c1.config is c2.config) |
|
91 | 91 | self.assert_(c2.config is c3.config) |
|
92 | 92 | |
|
93 | 93 | def test_inheritance(self): |
|
94 | 94 | config = Config() |
|
95 | 95 | config.MyConfigurable.a = 2 |
|
96 | 96 | config.MyConfigurable.b = 2.0 |
|
97 | 97 | c1 = MyConfigurable(config=config) |
|
98 | 98 | c2 = MyConfigurable(config=c1.config) |
|
99 | 99 | self.assertEquals(c1.a, config.MyConfigurable.a) |
|
100 | 100 | self.assertEquals(c1.b, config.MyConfigurable.b) |
|
101 | 101 | self.assertEquals(c2.a, config.MyConfigurable.a) |
|
102 | 102 | self.assertEquals(c2.b, config.MyConfigurable.b) |
|
103 | 103 | |
|
104 | 104 | def test_parent(self): |
|
105 | 105 | config = Config() |
|
106 | 106 | config.Foo.a = 10 |
|
107 | 107 | config.Foo.b = "wow" |
|
108 | 108 | config.Bar.b = 'later' |
|
109 | 109 | config.Bar.c = 100.0 |
|
110 | 110 | f = Foo(config=config) |
|
111 | 111 | b = Bar(config=f.config) |
|
112 | 112 | self.assertEquals(f.a, 10) |
|
113 | 113 | self.assertEquals(f.b, 'wow') |
|
114 | 114 | self.assertEquals(b.b, 'gotit') |
|
115 | 115 | self.assertEquals(b.c, 100.0) |
|
116 | 116 | |
|
117 | 117 | def test_override1(self): |
|
118 | 118 | config = Config() |
|
119 | 119 | config.MyConfigurable.a = 2 |
|
120 | 120 | config.MyConfigurable.b = 2.0 |
|
121 | 121 | c = MyConfigurable(a=3, config=config) |
|
122 | 122 | self.assertEquals(c.a, 3) |
|
123 | 123 | self.assertEquals(c.b, config.MyConfigurable.b) |
|
124 | 124 | self.assertEquals(c.c, 'no config') |
|
125 | 125 | |
|
126 | 126 | def test_override2(self): |
|
127 | 127 | config = Config() |
|
128 | 128 | config.Foo.a = 1 |
|
129 | 129 | config.Bar.b = 'or' # Up above b is config=False, so this won't do it. |
|
130 | 130 | config.Bar.c = 10.0 |
|
131 | 131 | c = Bar(config=config) |
|
132 | 132 | self.assertEquals(c.a, config.Foo.a) |
|
133 | 133 | self.assertEquals(c.b, 'gotit') |
|
134 | 134 | self.assertEquals(c.c, config.Bar.c) |
|
135 | 135 | c = Bar(a=2, b='and', c=20.0, config=config) |
|
136 | 136 | self.assertEquals(c.a, 2) |
|
137 | 137 | self.assertEquals(c.b, 'and') |
|
138 | 138 | self.assertEquals(c.c, 20.0) |
|
139 | 139 | |
|
140 | 140 | def test_help(self): |
|
141 | 141 | self.assertEquals(MyConfigurable.class_get_help(), mc_help) |
|
142 | 142 | |
|
143 | 143 | |
|
144 | 144 | class TestSingletonConfigurable(TestCase): |
|
145 | 145 | |
|
146 | 146 | def test_instance(self): |
|
147 | 147 | from IPython.config.configurable import SingletonConfigurable |
|
148 | 148 | class Foo(SingletonConfigurable): pass |
|
149 | 149 | self.assertEquals(Foo.initialized(), False) |
|
150 | 150 | foo = Foo.instance() |
|
151 | 151 | self.assertEquals(Foo.initialized(), True) |
|
152 | 152 | self.assertEquals(foo, Foo.instance()) |
|
153 | 153 | self.assertEquals(SingletonConfigurable._instance, None) |
|
154 | 154 | |
|
155 | 155 | def test_inheritance(self): |
|
156 | 156 | class Bar(SingletonConfigurable): pass |
|
157 | 157 | class Bam(Bar): pass |
|
158 | 158 | self.assertEquals(Bar.initialized(), False) |
|
159 | 159 | self.assertEquals(Bam.initialized(), False) |
|
160 | 160 | bam = Bam.instance() |
|
161 | 161 | bam == Bar.instance() |
|
162 | 162 | self.assertEquals(Bar.initialized(), True) |
|
163 | 163 | self.assertEquals(Bam.initialized(), True) |
|
164 | 164 | self.assertEquals(bam, Bam._instance) |
|
165 | 165 | self.assertEquals(bam, Bar._instance) |
|
166 | 166 | self.assertEquals(SingletonConfigurable._instance, None) |
@@ -1,593 +1,593 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Display formatters. |
|
3 | 3 | |
|
4 | 4 | |
|
5 | 5 | Authors: |
|
6 | 6 | |
|
7 | 7 | * Robert Kern |
|
8 | 8 | * Brian Granger |
|
9 | 9 | """ |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | # Copyright (c) 2010, IPython Development Team. |
|
12 | 12 | # |
|
13 | 13 | # Distributed under the terms of the Modified BSD License. |
|
14 | 14 | # |
|
15 | 15 | # The full license is in the file COPYING.txt, distributed with this software. |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | 19 | # Imports |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | # Stdlib imports |
|
23 | 23 | import abc |
|
24 | 24 | import sys |
|
25 | 25 | # We must use StringIO, as cStringIO doesn't handle unicode properly. |
|
26 | 26 | from StringIO import StringIO |
|
27 | 27 | |
|
28 | 28 | # Our own imports |
|
29 | 29 | from IPython.config.configurable import Configurable |
|
30 | 30 | from IPython.lib import pretty |
|
31 |
from IPython.utils.traitlets import Bool, Dict, Int, |
|
|
31 | from IPython.utils.traitlets import Bool, Dict, Int, Unicode, CUnicode, ObjectName | |
|
32 | 32 | |
|
33 | 33 | |
|
34 | 34 | #----------------------------------------------------------------------------- |
|
35 | 35 | # The main DisplayFormatter class |
|
36 | 36 | #----------------------------------------------------------------------------- |
|
37 | 37 | |
|
38 | 38 | |
|
39 | 39 | class DisplayFormatter(Configurable): |
|
40 | 40 | |
|
41 | 41 | # When set to true only the default plain text formatter will be used. |
|
42 | 42 | plain_text_only = Bool(False, config=True) |
|
43 | 43 | |
|
44 | 44 | # A dict of formatter whose keys are format types (MIME types) and whose |
|
45 | 45 | # values are subclasses of BaseFormatter. |
|
46 | 46 | formatters = Dict(config=True) |
|
47 | 47 | def _formatters_default(self): |
|
48 | 48 | """Activate the default formatters.""" |
|
49 | 49 | formatter_classes = [ |
|
50 | 50 | PlainTextFormatter, |
|
51 | 51 | HTMLFormatter, |
|
52 | 52 | SVGFormatter, |
|
53 | 53 | PNGFormatter, |
|
54 | 54 | LatexFormatter, |
|
55 | 55 | JSONFormatter, |
|
56 | 56 | JavascriptFormatter |
|
57 | 57 | ] |
|
58 | 58 | d = {} |
|
59 | 59 | for cls in formatter_classes: |
|
60 | 60 | f = cls(config=self.config) |
|
61 | 61 | d[f.format_type] = f |
|
62 | 62 | return d |
|
63 | 63 | |
|
64 | 64 | def format(self, obj, include=None, exclude=None): |
|
65 | 65 | """Return a format data dict for an object. |
|
66 | 66 | |
|
67 | 67 | By default all format types will be computed. |
|
68 | 68 | |
|
69 | 69 | The following MIME types are currently implemented: |
|
70 | 70 | |
|
71 | 71 | * text/plain |
|
72 | 72 | * text/html |
|
73 | 73 | * text/latex |
|
74 | 74 | * application/json |
|
75 | 75 | * image/png |
|
76 | 76 | * immage/svg+xml |
|
77 | 77 | |
|
78 | 78 | Parameters |
|
79 | 79 | ---------- |
|
80 | 80 | obj : object |
|
81 | 81 | The Python object whose format data will be computed. |
|
82 | 82 | include : list or tuple, optional |
|
83 | 83 | A list of format type strings (MIME types) to include in the |
|
84 | 84 | format data dict. If this is set *only* the format types included |
|
85 | 85 | in this list will be computed. |
|
86 | 86 | exclude : list or tuple, optional |
|
87 | 87 | A list of format type string (MIME types) to exclue in the format |
|
88 | 88 | data dict. If this is set all format types will be computed, |
|
89 | 89 | except for those included in this argument. |
|
90 | 90 | |
|
91 | 91 | Returns |
|
92 | 92 | ------- |
|
93 | 93 | format_dict : dict |
|
94 | 94 | A dictionary of key/value pairs, one or each format that was |
|
95 | 95 | generated for the object. The keys are the format types, which |
|
96 | 96 | will usually be MIME type strings and the values and JSON'able |
|
97 | 97 | data structure containing the raw data for the representation in |
|
98 | 98 | that format. |
|
99 | 99 | """ |
|
100 | 100 | format_dict = {} |
|
101 | 101 | |
|
102 | 102 | # If plain text only is active |
|
103 | 103 | if self.plain_text_only: |
|
104 | 104 | formatter = self.formatters['text/plain'] |
|
105 | 105 | try: |
|
106 | 106 | data = formatter(obj) |
|
107 | 107 | except: |
|
108 | 108 | # FIXME: log the exception |
|
109 | 109 | raise |
|
110 | 110 | if data is not None: |
|
111 | 111 | format_dict['text/plain'] = data |
|
112 | 112 | return format_dict |
|
113 | 113 | |
|
114 | 114 | for format_type, formatter in self.formatters.items(): |
|
115 | 115 | if include is not None: |
|
116 | 116 | if format_type not in include: |
|
117 | 117 | continue |
|
118 | 118 | if exclude is not None: |
|
119 | 119 | if format_type in exclude: |
|
120 | 120 | continue |
|
121 | 121 | try: |
|
122 | 122 | data = formatter(obj) |
|
123 | 123 | except: |
|
124 | 124 | # FIXME: log the exception |
|
125 | 125 | raise |
|
126 | 126 | if data is not None: |
|
127 | 127 | format_dict[format_type] = data |
|
128 | 128 | return format_dict |
|
129 | 129 | |
|
130 | 130 | @property |
|
131 | 131 | def format_types(self): |
|
132 | 132 | """Return the format types (MIME types) of the active formatters.""" |
|
133 | 133 | return self.formatters.keys() |
|
134 | 134 | |
|
135 | 135 | |
|
136 | 136 | #----------------------------------------------------------------------------- |
|
137 | 137 | # Formatters for specific format types (text, html, svg, etc.) |
|
138 | 138 | #----------------------------------------------------------------------------- |
|
139 | 139 | |
|
140 | 140 | |
|
141 | 141 | class FormatterABC(object): |
|
142 | 142 | """ Abstract base class for Formatters. |
|
143 | 143 | |
|
144 | 144 | A formatter is a callable class that is responsible for computing the |
|
145 | 145 | raw format data for a particular format type (MIME type). For example, |
|
146 | 146 | an HTML formatter would have a format type of `text/html` and would return |
|
147 | 147 | the HTML representation of the object when called. |
|
148 | 148 | """ |
|
149 | 149 | __metaclass__ = abc.ABCMeta |
|
150 | 150 | |
|
151 | 151 | # The format type of the data returned, usually a MIME type. |
|
152 | 152 | format_type = 'text/plain' |
|
153 | 153 | |
|
154 | 154 | # Is the formatter enabled... |
|
155 | 155 | enabled = True |
|
156 | 156 | |
|
157 | 157 | @abc.abstractmethod |
|
158 | 158 | def __call__(self, obj): |
|
159 | 159 | """Return a JSON'able representation of the object. |
|
160 | 160 | |
|
161 | 161 | If the object cannot be formatted by this formatter, then return None |
|
162 | 162 | """ |
|
163 | 163 | try: |
|
164 | 164 | return repr(obj) |
|
165 | 165 | except TypeError: |
|
166 | 166 | return None |
|
167 | 167 | |
|
168 | 168 | |
|
169 | 169 | class BaseFormatter(Configurable): |
|
170 | 170 | """A base formatter class that is configurable. |
|
171 | 171 | |
|
172 | 172 | This formatter should usually be used as the base class of all formatters. |
|
173 | 173 | It is a traited :class:`Configurable` class and includes an extensible |
|
174 | 174 | API for users to determine how their objects are formatted. The following |
|
175 | 175 | logic is used to find a function to format an given object. |
|
176 | 176 | |
|
177 | 177 | 1. The object is introspected to see if it has a method with the name |
|
178 | 178 | :attr:`print_method`. If is does, that object is passed to that method |
|
179 | 179 | for formatting. |
|
180 | 180 | 2. If no print method is found, three internal dictionaries are consulted |
|
181 | 181 | to find print method: :attr:`singleton_printers`, :attr:`type_printers` |
|
182 | 182 | and :attr:`deferred_printers`. |
|
183 | 183 | |
|
184 | 184 | Users should use these dictionaries to register functions that will be |
|
185 | 185 | used to compute the format data for their objects (if those objects don't |
|
186 | 186 | have the special print methods). The easiest way of using these |
|
187 | 187 | dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name` |
|
188 | 188 | methods. |
|
189 | 189 | |
|
190 | 190 | If no function/callable is found to compute the format data, ``None`` is |
|
191 | 191 | returned and this format type is not used. |
|
192 | 192 | """ |
|
193 | 193 | |
|
194 |
format_type = |
|
|
194 | format_type = Unicode('text/plain') | |
|
195 | 195 | |
|
196 | 196 | enabled = Bool(True, config=True) |
|
197 | 197 | |
|
198 |
print_method = |
|
|
198 | print_method = ObjectName('__repr__') | |
|
199 | 199 | |
|
200 | 200 | # The singleton printers. |
|
201 | 201 | # Maps the IDs of the builtin singleton objects to the format functions. |
|
202 | 202 | singleton_printers = Dict(config=True) |
|
203 | 203 | def _singleton_printers_default(self): |
|
204 | 204 | return {} |
|
205 | 205 | |
|
206 | 206 | # The type-specific printers. |
|
207 | 207 | # Map type objects to the format functions. |
|
208 | 208 | type_printers = Dict(config=True) |
|
209 | 209 | def _type_printers_default(self): |
|
210 | 210 | return {} |
|
211 | 211 | |
|
212 | 212 | # The deferred-import type-specific printers. |
|
213 | 213 | # Map (modulename, classname) pairs to the format functions. |
|
214 | 214 | deferred_printers = Dict(config=True) |
|
215 | 215 | def _deferred_printers_default(self): |
|
216 | 216 | return {} |
|
217 | 217 | |
|
218 | 218 | def __call__(self, obj): |
|
219 | 219 | """Compute the format for an object.""" |
|
220 | 220 | if self.enabled: |
|
221 | 221 | obj_id = id(obj) |
|
222 | 222 | try: |
|
223 | 223 | obj_class = getattr(obj, '__class__', None) or type(obj) |
|
224 | 224 | # First try to find registered singleton printers for the type. |
|
225 | 225 | try: |
|
226 | 226 | printer = self.singleton_printers[obj_id] |
|
227 | 227 | except (TypeError, KeyError): |
|
228 | 228 | pass |
|
229 | 229 | else: |
|
230 | 230 | return printer(obj) |
|
231 | 231 | # Next look for type_printers. |
|
232 | 232 | for cls in pretty._get_mro(obj_class): |
|
233 | 233 | if cls in self.type_printers: |
|
234 | 234 | return self.type_printers[cls](obj) |
|
235 | 235 | else: |
|
236 | 236 | printer = self._in_deferred_types(cls) |
|
237 | 237 | if printer is not None: |
|
238 | 238 | return printer(obj) |
|
239 | 239 | # Finally look for special method names. |
|
240 | 240 | if hasattr(obj_class, self.print_method): |
|
241 | 241 | printer = getattr(obj_class, self.print_method) |
|
242 | 242 | return printer(obj) |
|
243 | 243 | return None |
|
244 | 244 | except Exception: |
|
245 | 245 | pass |
|
246 | 246 | else: |
|
247 | 247 | return None |
|
248 | 248 | |
|
249 | 249 | def for_type(self, typ, func): |
|
250 | 250 | """Add a format function for a given type. |
|
251 | 251 | |
|
252 | 252 | Parameters |
|
253 | 253 | ----------- |
|
254 | 254 | typ : class |
|
255 | 255 | The class of the object that will be formatted using `func`. |
|
256 | 256 | func : callable |
|
257 | 257 | The callable that will be called to compute the format data. The |
|
258 | 258 | call signature of this function is simple, it must take the |
|
259 | 259 | object to be formatted and return the raw data for the given |
|
260 | 260 | format. Subclasses may use a different call signature for the |
|
261 | 261 | `func` argument. |
|
262 | 262 | """ |
|
263 | 263 | oldfunc = self.type_printers.get(typ, None) |
|
264 | 264 | if func is not None: |
|
265 | 265 | # To support easy restoration of old printers, we need to ignore |
|
266 | 266 | # Nones. |
|
267 | 267 | self.type_printers[typ] = func |
|
268 | 268 | return oldfunc |
|
269 | 269 | |
|
270 | 270 | def for_type_by_name(self, type_module, type_name, func): |
|
271 | 271 | """Add a format function for a type specified by the full dotted |
|
272 | 272 | module and name of the type, rather than the type of the object. |
|
273 | 273 | |
|
274 | 274 | Parameters |
|
275 | 275 | ---------- |
|
276 | 276 | type_module : str |
|
277 | 277 | The full dotted name of the module the type is defined in, like |
|
278 | 278 | ``numpy``. |
|
279 | 279 | type_name : str |
|
280 | 280 | The name of the type (the class name), like ``dtype`` |
|
281 | 281 | func : callable |
|
282 | 282 | The callable that will be called to compute the format data. The |
|
283 | 283 | call signature of this function is simple, it must take the |
|
284 | 284 | object to be formatted and return the raw data for the given |
|
285 | 285 | format. Subclasses may use a different call signature for the |
|
286 | 286 | `func` argument. |
|
287 | 287 | """ |
|
288 | 288 | key = (type_module, type_name) |
|
289 | 289 | oldfunc = self.deferred_printers.get(key, None) |
|
290 | 290 | if func is not None: |
|
291 | 291 | # To support easy restoration of old printers, we need to ignore |
|
292 | 292 | # Nones. |
|
293 | 293 | self.deferred_printers[key] = func |
|
294 | 294 | return oldfunc |
|
295 | 295 | |
|
296 | 296 | def _in_deferred_types(self, cls): |
|
297 | 297 | """ |
|
298 | 298 | Check if the given class is specified in the deferred type registry. |
|
299 | 299 | |
|
300 | 300 | Returns the printer from the registry if it exists, and None if the |
|
301 | 301 | class is not in the registry. Successful matches will be moved to the |
|
302 | 302 | regular type registry for future use. |
|
303 | 303 | """ |
|
304 | 304 | mod = getattr(cls, '__module__', None) |
|
305 | 305 | name = getattr(cls, '__name__', None) |
|
306 | 306 | key = (mod, name) |
|
307 | 307 | printer = None |
|
308 | 308 | if key in self.deferred_printers: |
|
309 | 309 | # Move the printer over to the regular registry. |
|
310 | 310 | printer = self.deferred_printers.pop(key) |
|
311 | 311 | self.type_printers[cls] = printer |
|
312 | 312 | return printer |
|
313 | 313 | |
|
314 | 314 | |
|
315 | 315 | class PlainTextFormatter(BaseFormatter): |
|
316 | 316 | """The default pretty-printer. |
|
317 | 317 | |
|
318 | 318 | This uses :mod:`IPython.external.pretty` to compute the format data of |
|
319 | 319 | the object. If the object cannot be pretty printed, :func:`repr` is used. |
|
320 | 320 | See the documentation of :mod:`IPython.external.pretty` for details on |
|
321 | 321 | how to write pretty printers. Here is a simple example:: |
|
322 | 322 | |
|
323 | 323 | def dtype_pprinter(obj, p, cycle): |
|
324 | 324 | if cycle: |
|
325 | 325 | return p.text('dtype(...)') |
|
326 | 326 | if hasattr(obj, 'fields'): |
|
327 | 327 | if obj.fields is None: |
|
328 | 328 | p.text(repr(obj)) |
|
329 | 329 | else: |
|
330 | 330 | p.begin_group(7, 'dtype([') |
|
331 | 331 | for i, field in enumerate(obj.descr): |
|
332 | 332 | if i > 0: |
|
333 | 333 | p.text(',') |
|
334 | 334 | p.breakable() |
|
335 | 335 | p.pretty(field) |
|
336 | 336 | p.end_group(7, '])') |
|
337 | 337 | """ |
|
338 | 338 | |
|
339 | 339 | # The format type of data returned. |
|
340 |
format_type = |
|
|
340 | format_type = Unicode('text/plain') | |
|
341 | 341 | |
|
342 | 342 | # This subclass ignores this attribute as it always need to return |
|
343 | 343 | # something. |
|
344 | 344 | enabled = Bool(True, config=False) |
|
345 | 345 | |
|
346 | 346 | # Look for a _repr_pretty_ methods to use for pretty printing. |
|
347 |
print_method = |
|
|
347 | print_method = ObjectName('_repr_pretty_') | |
|
348 | 348 | |
|
349 | 349 | # Whether to pretty-print or not. |
|
350 | 350 | pprint = Bool(True, config=True) |
|
351 | 351 | |
|
352 | 352 | # Whether to be verbose or not. |
|
353 | 353 | verbose = Bool(False, config=True) |
|
354 | 354 | |
|
355 | 355 | # The maximum width. |
|
356 | 356 | max_width = Int(79, config=True) |
|
357 | 357 | |
|
358 | 358 | # The newline character. |
|
359 |
newline = |
|
|
359 | newline = Unicode('\n', config=True) | |
|
360 | 360 | |
|
361 | 361 | # format-string for pprinting floats |
|
362 |
float_format = |
|
|
362 | float_format = Unicode('%r') | |
|
363 | 363 | # setter for float precision, either int or direct format-string |
|
364 |
float_precision = C |
|
|
364 | float_precision = CUnicode('', config=True) | |
|
365 | 365 | |
|
366 | 366 | def _float_precision_changed(self, name, old, new): |
|
367 | 367 | """float_precision changed, set float_format accordingly. |
|
368 | 368 | |
|
369 | 369 | float_precision can be set by int or str. |
|
370 | 370 | This will set float_format, after interpreting input. |
|
371 | 371 | If numpy has been imported, numpy print precision will also be set. |
|
372 | 372 | |
|
373 | 373 | integer `n` sets format to '%.nf', otherwise, format set directly. |
|
374 | 374 | |
|
375 | 375 | An empty string returns to defaults (repr for float, 8 for numpy). |
|
376 | 376 | |
|
377 | 377 | This parameter can be set via the '%precision' magic. |
|
378 | 378 | """ |
|
379 | 379 | |
|
380 | 380 | if '%' in new: |
|
381 | 381 | # got explicit format string |
|
382 | 382 | fmt = new |
|
383 | 383 | try: |
|
384 | 384 | fmt%3.14159 |
|
385 | 385 | except Exception: |
|
386 | 386 | raise ValueError("Precision must be int or format string, not %r"%new) |
|
387 | 387 | elif new: |
|
388 | 388 | # otherwise, should be an int |
|
389 | 389 | try: |
|
390 | 390 | i = int(new) |
|
391 | 391 | assert i >= 0 |
|
392 | 392 | except ValueError: |
|
393 | 393 | raise ValueError("Precision must be int or format string, not %r"%new) |
|
394 | 394 | except AssertionError: |
|
395 | 395 | raise ValueError("int precision must be non-negative, not %r"%i) |
|
396 | 396 | |
|
397 | 397 | fmt = '%%.%if'%i |
|
398 | 398 | if 'numpy' in sys.modules: |
|
399 | 399 | # set numpy precision if it has been imported |
|
400 | 400 | import numpy |
|
401 | 401 | numpy.set_printoptions(precision=i) |
|
402 | 402 | else: |
|
403 | 403 | # default back to repr |
|
404 | 404 | fmt = '%r' |
|
405 | 405 | if 'numpy' in sys.modules: |
|
406 | 406 | import numpy |
|
407 | 407 | # numpy default is 8 |
|
408 | 408 | numpy.set_printoptions(precision=8) |
|
409 | 409 | self.float_format = fmt |
|
410 | 410 | |
|
411 | 411 | # Use the default pretty printers from IPython.external.pretty. |
|
412 | 412 | def _singleton_printers_default(self): |
|
413 | 413 | return pretty._singleton_pprinters.copy() |
|
414 | 414 | |
|
415 | 415 | def _type_printers_default(self): |
|
416 | 416 | d = pretty._type_pprinters.copy() |
|
417 | 417 | d[float] = lambda obj,p,cycle: p.text(self.float_format%obj) |
|
418 | 418 | return d |
|
419 | 419 | |
|
420 | 420 | def _deferred_printers_default(self): |
|
421 | 421 | return pretty._deferred_type_pprinters.copy() |
|
422 | 422 | |
|
423 | 423 | #### FormatterABC interface #### |
|
424 | 424 | |
|
425 | 425 | def __call__(self, obj): |
|
426 | 426 | """Compute the pretty representation of the object.""" |
|
427 | 427 | if not self.pprint: |
|
428 | 428 | try: |
|
429 | 429 | return repr(obj) |
|
430 | 430 | except TypeError: |
|
431 | 431 | return '' |
|
432 | 432 | else: |
|
433 | 433 | # This uses use StringIO, as cStringIO doesn't handle unicode. |
|
434 | 434 | stream = StringIO() |
|
435 | 435 | printer = pretty.RepresentationPrinter(stream, self.verbose, |
|
436 | 436 | self.max_width, self.newline, |
|
437 | 437 | singleton_pprinters=self.singleton_printers, |
|
438 | 438 | type_pprinters=self.type_printers, |
|
439 | 439 | deferred_pprinters=self.deferred_printers) |
|
440 | 440 | printer.pretty(obj) |
|
441 | 441 | printer.flush() |
|
442 | 442 | return stream.getvalue() |
|
443 | 443 | |
|
444 | 444 | |
|
445 | 445 | class HTMLFormatter(BaseFormatter): |
|
446 | 446 | """An HTML formatter. |
|
447 | 447 | |
|
448 | 448 | To define the callables that compute the HTML representation of your |
|
449 | 449 | objects, define a :meth:`_repr_html_` method or use the :meth:`for_type` |
|
450 | 450 | or :meth:`for_type_by_name` methods to register functions that handle |
|
451 | 451 | this. |
|
452 | 452 | |
|
453 | 453 | The return value of this formatter should be a valid HTML snippet that |
|
454 | 454 | could be injected into an existing DOM. It should *not* include the |
|
455 | 455 | ```<html>`` or ```<body>`` tags. |
|
456 | 456 | """ |
|
457 |
format_type = |
|
|
457 | format_type = Unicode('text/html') | |
|
458 | 458 | |
|
459 |
print_method = |
|
|
459 | print_method = ObjectName('_repr_html_') | |
|
460 | 460 | |
|
461 | 461 | |
|
462 | 462 | class SVGFormatter(BaseFormatter): |
|
463 | 463 | """An SVG formatter. |
|
464 | 464 | |
|
465 | 465 | To define the callables that compute the SVG representation of your |
|
466 | 466 | objects, define a :meth:`_repr_svg_` method or use the :meth:`for_type` |
|
467 | 467 | or :meth:`for_type_by_name` methods to register functions that handle |
|
468 | 468 | this. |
|
469 | 469 | |
|
470 | 470 | The return value of this formatter should be valid SVG enclosed in |
|
471 | 471 | ```<svg>``` tags, that could be injected into an existing DOM. It should |
|
472 | 472 | *not* include the ```<html>`` or ```<body>`` tags. |
|
473 | 473 | """ |
|
474 |
format_type = |
|
|
474 | format_type = Unicode('image/svg+xml') | |
|
475 | 475 | |
|
476 |
print_method = |
|
|
476 | print_method = ObjectName('_repr_svg_') | |
|
477 | 477 | |
|
478 | 478 | |
|
479 | 479 | class PNGFormatter(BaseFormatter): |
|
480 | 480 | """A PNG formatter. |
|
481 | 481 | |
|
482 | 482 | To define the callables that compute the PNG representation of your |
|
483 | 483 | objects, define a :meth:`_repr_png_` method or use the :meth:`for_type` |
|
484 | 484 | or :meth:`for_type_by_name` methods to register functions that handle |
|
485 | 485 | this. |
|
486 | 486 | |
|
487 | 487 | The return value of this formatter should be raw PNG data, *not* |
|
488 | 488 | base64 encoded. |
|
489 | 489 | """ |
|
490 |
format_type = |
|
|
490 | format_type = Unicode('image/png') | |
|
491 | 491 | |
|
492 |
print_method = |
|
|
492 | print_method = ObjectName('_repr_png_') | |
|
493 | 493 | |
|
494 | 494 | |
|
495 | 495 | class LatexFormatter(BaseFormatter): |
|
496 | 496 | """A LaTeX formatter. |
|
497 | 497 | |
|
498 | 498 | To define the callables that compute the LaTeX representation of your |
|
499 | 499 | objects, define a :meth:`_repr_latex_` method or use the :meth:`for_type` |
|
500 | 500 | or :meth:`for_type_by_name` methods to register functions that handle |
|
501 | 501 | this. |
|
502 | 502 | |
|
503 | 503 | The return value of this formatter should be a valid LaTeX equation, |
|
504 | 504 | enclosed in either ```$``` or ```$$```. |
|
505 | 505 | """ |
|
506 |
format_type = |
|
|
506 | format_type = Unicode('text/latex') | |
|
507 | 507 | |
|
508 |
print_method = |
|
|
508 | print_method = ObjectName('_repr_latex_') | |
|
509 | 509 | |
|
510 | 510 | |
|
511 | 511 | class JSONFormatter(BaseFormatter): |
|
512 | 512 | """A JSON string formatter. |
|
513 | 513 | |
|
514 | 514 | To define the callables that compute the JSON string representation of |
|
515 | 515 | your objects, define a :meth:`_repr_json_` method or use the :meth:`for_type` |
|
516 | 516 | or :meth:`for_type_by_name` methods to register functions that handle |
|
517 | 517 | this. |
|
518 | 518 | |
|
519 | 519 | The return value of this formatter should be a valid JSON string. |
|
520 | 520 | """ |
|
521 |
format_type = |
|
|
521 | format_type = Unicode('application/json') | |
|
522 | 522 | |
|
523 |
print_method = |
|
|
523 | print_method = ObjectName('_repr_json_') | |
|
524 | 524 | |
|
525 | 525 | |
|
526 | 526 | class JavascriptFormatter(BaseFormatter): |
|
527 | 527 | """A Javascript formatter. |
|
528 | 528 | |
|
529 | 529 | To define the callables that compute the Javascript representation of |
|
530 | 530 | your objects, define a :meth:`_repr_javascript_` method or use the |
|
531 | 531 | :meth:`for_type` or :meth:`for_type_by_name` methods to register functions |
|
532 | 532 | that handle this. |
|
533 | 533 | |
|
534 | 534 | The return value of this formatter should be valid Javascript code and |
|
535 | 535 | should *not* be enclosed in ```<script>``` tags. |
|
536 | 536 | """ |
|
537 |
format_type = |
|
|
537 | format_type = Unicode('application/javascript') | |
|
538 | 538 | |
|
539 |
print_method = |
|
|
539 | print_method = ObjectName('_repr_javascript_') | |
|
540 | 540 | |
|
541 | 541 | FormatterABC.register(BaseFormatter) |
|
542 | 542 | FormatterABC.register(PlainTextFormatter) |
|
543 | 543 | FormatterABC.register(HTMLFormatter) |
|
544 | 544 | FormatterABC.register(SVGFormatter) |
|
545 | 545 | FormatterABC.register(PNGFormatter) |
|
546 | 546 | FormatterABC.register(LatexFormatter) |
|
547 | 547 | FormatterABC.register(JSONFormatter) |
|
548 | 548 | FormatterABC.register(JavascriptFormatter) |
|
549 | 549 | |
|
550 | 550 | |
|
551 | 551 | def format_display_data(obj, include=None, exclude=None): |
|
552 | 552 | """Return a format data dict for an object. |
|
553 | 553 | |
|
554 | 554 | By default all format types will be computed. |
|
555 | 555 | |
|
556 | 556 | The following MIME types are currently implemented: |
|
557 | 557 | |
|
558 | 558 | * text/plain |
|
559 | 559 | * text/html |
|
560 | 560 | * text/latex |
|
561 | 561 | * application/json |
|
562 | 562 | * image/png |
|
563 | 563 | * immage/svg+xml |
|
564 | 564 | |
|
565 | 565 | Parameters |
|
566 | 566 | ---------- |
|
567 | 567 | obj : object |
|
568 | 568 | The Python object whose format data will be computed. |
|
569 | 569 | |
|
570 | 570 | Returns |
|
571 | 571 | ------- |
|
572 | 572 | format_dict : dict |
|
573 | 573 | A dictionary of key/value pairs, one or each format that was |
|
574 | 574 | generated for the object. The keys are the format types, which |
|
575 | 575 | will usually be MIME type strings and the values and JSON'able |
|
576 | 576 | data structure containing the raw data for the representation in |
|
577 | 577 | that format. |
|
578 | 578 | include : list or tuple, optional |
|
579 | 579 | A list of format type strings (MIME types) to include in the |
|
580 | 580 | format data dict. If this is set *only* the format types included |
|
581 | 581 | in this list will be computed. |
|
582 | 582 | exclude : list or tuple, optional |
|
583 | 583 | A list of format type string (MIME types) to exclue in the format |
|
584 | 584 | data dict. If this is set all format types will be computed, |
|
585 | 585 | except for those included in this argument. |
|
586 | 586 | """ |
|
587 | 587 | from IPython.core.interactiveshell import InteractiveShell |
|
588 | 588 | |
|
589 | 589 | InteractiveShell.instance().display_formatter.format( |
|
590 | 590 | obj, |
|
591 | 591 | include, |
|
592 | 592 | exclude |
|
593 | 593 | ) |
@@ -1,2553 +1,2554 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Main IPython class.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | from __future__ import with_statement |
|
18 | 18 | from __future__ import absolute_import |
|
19 | 19 | |
|
20 | 20 | import __builtin__ |
|
21 | 21 | import __future__ |
|
22 | 22 | import abc |
|
23 | 23 | import ast |
|
24 | 24 | import atexit |
|
25 | 25 | import codeop |
|
26 | 26 | import inspect |
|
27 | 27 | import os |
|
28 | 28 | import re |
|
29 | 29 | import sys |
|
30 | 30 | import tempfile |
|
31 | 31 | import types |
|
32 | 32 | from contextlib import nested |
|
33 | 33 | |
|
34 | 34 | from IPython.config.configurable import SingletonConfigurable |
|
35 | 35 | from IPython.core import debugger, oinspect |
|
36 | 36 | from IPython.core import history as ipcorehist |
|
37 | 37 | from IPython.core import page |
|
38 | 38 | from IPython.core import prefilter |
|
39 | 39 | from IPython.core import shadowns |
|
40 | 40 | from IPython.core import ultratb |
|
41 | 41 | from IPython.core.alias import AliasManager, AliasError |
|
42 | 42 | from IPython.core.autocall import ExitAutocall |
|
43 | 43 | from IPython.core.builtin_trap import BuiltinTrap |
|
44 | 44 | from IPython.core.compilerop import CachingCompiler |
|
45 | 45 | from IPython.core.display_trap import DisplayTrap |
|
46 | 46 | from IPython.core.displayhook import DisplayHook |
|
47 | 47 | from IPython.core.displaypub import DisplayPublisher |
|
48 | 48 | from IPython.core.error import TryNext, UsageError |
|
49 | 49 | from IPython.core.extensions import ExtensionManager |
|
50 | 50 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
51 | 51 | from IPython.core.formatters import DisplayFormatter |
|
52 | 52 | from IPython.core.history import HistoryManager |
|
53 | 53 | from IPython.core.inputsplitter import IPythonInputSplitter |
|
54 | 54 | from IPython.core.logger import Logger |
|
55 | 55 | from IPython.core.macro import Macro |
|
56 | 56 | from IPython.core.magic import Magic |
|
57 | 57 | from IPython.core.payload import PayloadManager |
|
58 | 58 | from IPython.core.plugin import PluginManager |
|
59 | 59 | from IPython.core.prefilter import PrefilterManager, ESC_MAGIC |
|
60 | 60 | from IPython.core.profiledir import ProfileDir |
|
61 | 61 | from IPython.external.Itpl import ItplNS |
|
62 | 62 | from IPython.utils import PyColorize |
|
63 | 63 | from IPython.utils import io |
|
64 | 64 | from IPython.utils.doctestreload import doctest_reload |
|
65 | 65 | from IPython.utils.io import ask_yes_no, rprint |
|
66 | 66 | from IPython.utils.ipstruct import Struct |
|
67 | 67 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError |
|
68 | 68 | from IPython.utils.pickleshare import PickleShareDB |
|
69 | 69 | from IPython.utils.process import system, getoutput |
|
70 | 70 | from IPython.utils.strdispatch import StrDispatch |
|
71 | 71 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
72 | 72 | from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList |
|
73 |
from IPython.utils.traitlets import (Int, |
|
|
73 | from IPython.utils.traitlets import (Int, CBool, CaselessStrEnum, Enum, | |
|
74 | 74 | List, Unicode, Instance, Type) |
|
75 | 75 | from IPython.utils.warn import warn, error, fatal |
|
76 | 76 | import IPython.core.hooks |
|
77 | 77 | |
|
78 | 78 | #----------------------------------------------------------------------------- |
|
79 | 79 | # Globals |
|
80 | 80 | #----------------------------------------------------------------------------- |
|
81 | 81 | |
|
82 | 82 | # compiled regexps for autoindent management |
|
83 | 83 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
84 | 84 | |
|
85 | 85 | #----------------------------------------------------------------------------- |
|
86 | 86 | # Utilities |
|
87 | 87 | #----------------------------------------------------------------------------- |
|
88 | 88 | |
|
89 | 89 | # store the builtin raw_input globally, and use this always, in case user code |
|
90 | 90 | # overwrites it (like wx.py.PyShell does) |
|
91 | 91 | raw_input_original = raw_input |
|
92 | 92 | |
|
93 | 93 | def softspace(file, newvalue): |
|
94 | 94 | """Copied from code.py, to remove the dependency""" |
|
95 | 95 | |
|
96 | 96 | oldvalue = 0 |
|
97 | 97 | try: |
|
98 | 98 | oldvalue = file.softspace |
|
99 | 99 | except AttributeError: |
|
100 | 100 | pass |
|
101 | 101 | try: |
|
102 | 102 | file.softspace = newvalue |
|
103 | 103 | except (AttributeError, TypeError): |
|
104 | 104 | # "attribute-less object" or "read-only attributes" |
|
105 | 105 | pass |
|
106 | 106 | return oldvalue |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | def no_op(*a, **kw): pass |
|
110 | 110 | |
|
111 | 111 | class SpaceInInput(Exception): pass |
|
112 | 112 | |
|
113 | 113 | class Bunch: pass |
|
114 | 114 | |
|
115 | 115 | |
|
116 | 116 | def get_default_colors(): |
|
117 | 117 | if sys.platform=='darwin': |
|
118 | 118 | return "LightBG" |
|
119 | 119 | elif os.name=='nt': |
|
120 | 120 | return 'Linux' |
|
121 | 121 | else: |
|
122 | 122 | return 'Linux' |
|
123 | 123 | |
|
124 | 124 | |
|
125 |
class Separate |
|
|
126 |
"""A |
|
|
125 | class SeparateUnicode(Unicode): | |
|
126 | """A Unicode subclass to validate separate_in, separate_out, etc. | |
|
127 | 127 | |
|
128 |
This is a |
|
|
128 | This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'. | |
|
129 | 129 | """ |
|
130 | 130 | |
|
131 | 131 | def validate(self, obj, value): |
|
132 | 132 | if value == '0': value = '' |
|
133 | 133 | value = value.replace('\\n','\n') |
|
134 |
return super(Separate |
|
|
134 | return super(SeparateUnicode, self).validate(obj, value) | |
|
135 | 135 | |
|
136 | 136 | |
|
137 | 137 | class ReadlineNoRecord(object): |
|
138 | 138 | """Context manager to execute some code, then reload readline history |
|
139 | 139 | so that interactive input to the code doesn't appear when pressing up.""" |
|
140 | 140 | def __init__(self, shell): |
|
141 | 141 | self.shell = shell |
|
142 | 142 | self._nested_level = 0 |
|
143 | 143 | |
|
144 | 144 | def __enter__(self): |
|
145 | 145 | if self._nested_level == 0: |
|
146 | 146 | try: |
|
147 | 147 | self.orig_length = self.current_length() |
|
148 | 148 | self.readline_tail = self.get_readline_tail() |
|
149 | 149 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
150 | 150 | self.orig_length, self.readline_tail = 999999, [] |
|
151 | 151 | self._nested_level += 1 |
|
152 | 152 | |
|
153 | 153 | def __exit__(self, type, value, traceback): |
|
154 | 154 | self._nested_level -= 1 |
|
155 | 155 | if self._nested_level == 0: |
|
156 | 156 | # Try clipping the end if it's got longer |
|
157 | 157 | try: |
|
158 | 158 | e = self.current_length() - self.orig_length |
|
159 | 159 | if e > 0: |
|
160 | 160 | for _ in range(e): |
|
161 | 161 | self.shell.readline.remove_history_item(self.orig_length) |
|
162 | 162 | |
|
163 | 163 | # If it still doesn't match, just reload readline history. |
|
164 | 164 | if self.current_length() != self.orig_length \ |
|
165 | 165 | or self.get_readline_tail() != self.readline_tail: |
|
166 | 166 | self.shell.refill_readline_hist() |
|
167 | 167 | except (AttributeError, IndexError): |
|
168 | 168 | pass |
|
169 | 169 | # Returning False will cause exceptions to propagate |
|
170 | 170 | return False |
|
171 | 171 | |
|
172 | 172 | def current_length(self): |
|
173 | 173 | return self.shell.readline.get_current_history_length() |
|
174 | 174 | |
|
175 | 175 | def get_readline_tail(self, n=10): |
|
176 | 176 | """Get the last n items in readline history.""" |
|
177 | 177 | end = self.shell.readline.get_current_history_length() + 1 |
|
178 | 178 | start = max(end-n, 1) |
|
179 | 179 | ghi = self.shell.readline.get_history_item |
|
180 | 180 | return [ghi(x) for x in range(start, end)] |
|
181 | 181 | |
|
182 | 182 | |
|
183 | 183 | _autocall_help = """ |
|
184 | 184 | Make IPython automatically call any callable object even if |
|
185 | 185 | you didn't type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
186 | 186 | automatically. The value can be '0' to disable the feature, '1' for 'smart' |
|
187 | 187 | autocall, where it is not applied if there are no more arguments on the line, |
|
188 | 188 | and '2' for 'full' autocall, where all callable objects are automatically |
|
189 | 189 | called (even if no arguments are present). The default is '1'. |
|
190 | 190 | """ |
|
191 | 191 | |
|
192 | 192 | #----------------------------------------------------------------------------- |
|
193 | 193 | # Main IPython class |
|
194 | 194 | #----------------------------------------------------------------------------- |
|
195 | 195 | |
|
196 | 196 | class InteractiveShell(SingletonConfigurable, Magic): |
|
197 | 197 | """An enhanced, interactive shell for Python.""" |
|
198 | 198 | |
|
199 | 199 | _instance = None |
|
200 | 200 | |
|
201 | 201 | autocall = Enum((0,1,2), default_value=1, config=True, help= |
|
202 | 202 | """ |
|
203 | 203 | Make IPython automatically call any callable object even if you didn't |
|
204 | 204 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
205 | 205 | automatically. The value can be '0' to disable the feature, '1' for |
|
206 | 206 | 'smart' autocall, where it is not applied if there are no more |
|
207 | 207 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
208 | 208 | objects are automatically called (even if no arguments are present). |
|
209 | 209 | The default is '1'. |
|
210 | 210 | """ |
|
211 | 211 | ) |
|
212 | 212 | # TODO: remove all autoindent logic and put into frontends. |
|
213 | 213 | # We can't do this yet because even runlines uses the autoindent. |
|
214 | 214 | autoindent = CBool(True, config=True, help= |
|
215 | 215 | """ |
|
216 | 216 | Autoindent IPython code entered interactively. |
|
217 | 217 | """ |
|
218 | 218 | ) |
|
219 | 219 | automagic = CBool(True, config=True, help= |
|
220 | 220 | """ |
|
221 | 221 | Enable magic commands to be called without the leading %. |
|
222 | 222 | """ |
|
223 | 223 | ) |
|
224 | 224 | cache_size = Int(1000, config=True, help= |
|
225 | 225 | """ |
|
226 | 226 | Set the size of the output cache. The default is 1000, you can |
|
227 | 227 | change it permanently in your config file. Setting it to 0 completely |
|
228 | 228 | disables the caching system, and the minimum value accepted is 20 (if |
|
229 | 229 | you provide a value less than 20, it is reset to 0 and a warning is |
|
230 | 230 | issued). This limit is defined because otherwise you'll spend more |
|
231 | 231 | time re-flushing a too small cache than working |
|
232 | 232 | """ |
|
233 | 233 | ) |
|
234 | 234 | color_info = CBool(True, config=True, help= |
|
235 | 235 | """ |
|
236 | 236 | Use colors for displaying information about objects. Because this |
|
237 | 237 | information is passed through a pager (like 'less'), and some pagers |
|
238 | 238 | get confused with color codes, this capability can be turned off. |
|
239 | 239 | """ |
|
240 | 240 | ) |
|
241 | 241 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
242 | 242 | default_value=get_default_colors(), config=True, |
|
243 | 243 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
244 | 244 | ) |
|
245 | 245 | debug = CBool(False, config=True) |
|
246 | 246 | deep_reload = CBool(False, config=True, help= |
|
247 | 247 | """ |
|
248 | 248 | Enable deep (recursive) reloading by default. IPython can use the |
|
249 | 249 | deep_reload module which reloads changes in modules recursively (it |
|
250 | 250 | replaces the reload() function, so you don't need to change anything to |
|
251 | 251 | use it). deep_reload() forces a full reload of modules whose code may |
|
252 | 252 | have changed, which the default reload() function does not. When |
|
253 | 253 | deep_reload is off, IPython will use the normal reload(), but |
|
254 | 254 | deep_reload will still be available as dreload(). |
|
255 | 255 | """ |
|
256 | 256 | ) |
|
257 | 257 | display_formatter = Instance(DisplayFormatter) |
|
258 | 258 | displayhook_class = Type(DisplayHook) |
|
259 | 259 | display_pub_class = Type(DisplayPublisher) |
|
260 | 260 | |
|
261 | 261 | exit_now = CBool(False) |
|
262 | 262 | exiter = Instance(ExitAutocall) |
|
263 | 263 | def _exiter_default(self): |
|
264 | 264 | return ExitAutocall(self) |
|
265 | 265 | # Monotonically increasing execution counter |
|
266 | 266 | execution_count = Int(1) |
|
267 | 267 | filename = Unicode("<ipython console>") |
|
268 | 268 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
269 | 269 | |
|
270 | 270 | # Input splitter, to split entire cells of input into either individual |
|
271 | 271 | # interactive statements or whole blocks. |
|
272 | 272 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
273 | 273 | (), {}) |
|
274 | 274 | logstart = CBool(False, config=True, help= |
|
275 | 275 | """ |
|
276 | 276 | Start logging to the default log file. |
|
277 | 277 | """ |
|
278 | 278 | ) |
|
279 | 279 | logfile = Unicode('', config=True, help= |
|
280 | 280 | """ |
|
281 | 281 | The name of the logfile to use. |
|
282 | 282 | """ |
|
283 | 283 | ) |
|
284 | 284 | logappend = Unicode('', config=True, help= |
|
285 | 285 | """ |
|
286 | 286 | Start logging to the given file in append mode. |
|
287 | 287 | """ |
|
288 | 288 | ) |
|
289 | 289 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
290 | 290 | config=True) |
|
291 | 291 | pdb = CBool(False, config=True, help= |
|
292 | 292 | """ |
|
293 | 293 | Automatically call the pdb debugger after every exception. |
|
294 | 294 | """ |
|
295 | 295 | ) |
|
296 | 296 | |
|
297 |
prompt_in1 = |
|
|
298 |
prompt_in2 = |
|
|
299 |
prompt_out = |
|
|
297 | prompt_in1 = Unicode('In [\\#]: ', config=True) | |
|
298 | prompt_in2 = Unicode(' .\\D.: ', config=True) | |
|
299 | prompt_out = Unicode('Out[\\#]: ', config=True) | |
|
300 | 300 | prompts_pad_left = CBool(True, config=True) |
|
301 | 301 | quiet = CBool(False, config=True) |
|
302 | 302 | |
|
303 | 303 | history_length = Int(10000, config=True) |
|
304 | 304 | |
|
305 | 305 | # The readline stuff will eventually be moved to the terminal subclass |
|
306 | 306 | # but for now, we can't do that as readline is welded in everywhere. |
|
307 | 307 | readline_use = CBool(True, config=True) |
|
308 | 308 | readline_merge_completions = CBool(True, config=True) |
|
309 | 309 | readline_omit__names = Enum((0,1,2), default_value=2, config=True) |
|
310 |
readline_remove_delims = |
|
|
310 | readline_remove_delims = Unicode('-/~', config=True) | |
|
311 | 311 | # don't use \M- bindings by default, because they |
|
312 | 312 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
313 | 313 | readline_parse_and_bind = List([ |
|
314 | 314 | 'tab: complete', |
|
315 | 315 | '"\C-l": clear-screen', |
|
316 | 316 | 'set show-all-if-ambiguous on', |
|
317 | 317 | '"\C-o": tab-insert', |
|
318 | 318 | '"\C-r": reverse-search-history', |
|
319 | 319 | '"\C-s": forward-search-history', |
|
320 | 320 | '"\C-p": history-search-backward', |
|
321 | 321 | '"\C-n": history-search-forward', |
|
322 | 322 | '"\e[A": history-search-backward', |
|
323 | 323 | '"\e[B": history-search-forward', |
|
324 | 324 | '"\C-k": kill-line', |
|
325 | 325 | '"\C-u": unix-line-discard', |
|
326 | 326 | ], allow_none=False, config=True) |
|
327 | 327 | |
|
328 | 328 | # TODO: this part of prompt management should be moved to the frontends. |
|
329 | 329 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
330 |
separate_in = Separate |
|
|
331 |
separate_out = Separate |
|
|
332 |
separate_out2 = Separate |
|
|
330 | separate_in = SeparateUnicode('\n', config=True) | |
|
331 | separate_out = SeparateUnicode('', config=True) | |
|
332 | separate_out2 = SeparateUnicode('', config=True) | |
|
333 | 333 | wildcards_case_sensitive = CBool(True, config=True) |
|
334 | 334 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
335 | 335 | default_value='Context', config=True) |
|
336 | 336 | |
|
337 | 337 | # Subcomponents of InteractiveShell |
|
338 | 338 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
339 | 339 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
340 | 340 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
341 | 341 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
342 | 342 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
343 | 343 | plugin_manager = Instance('IPython.core.plugin.PluginManager') |
|
344 | 344 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
345 | 345 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
346 | 346 | |
|
347 | 347 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
348 | 348 | @property |
|
349 | 349 | def profile(self): |
|
350 | 350 | if self.profile_dir is not None: |
|
351 | 351 | name = os.path.basename(self.profile_dir.location) |
|
352 | 352 | return name.replace('profile_','') |
|
353 | 353 | |
|
354 | 354 | |
|
355 | 355 | # Private interface |
|
356 | 356 | _post_execute = Instance(dict) |
|
357 | 357 | |
|
358 | 358 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, |
|
359 | 359 | user_ns=None, user_global_ns=None, |
|
360 | 360 | custom_exceptions=((), None)): |
|
361 | 361 | |
|
362 | 362 | # This is where traits with a config_key argument are updated |
|
363 | 363 | # from the values on config. |
|
364 | 364 | super(InteractiveShell, self).__init__(config=config) |
|
365 | 365 | |
|
366 | 366 | # These are relatively independent and stateless |
|
367 | 367 | self.init_ipython_dir(ipython_dir) |
|
368 | 368 | self.init_profile_dir(profile_dir) |
|
369 | 369 | self.init_instance_attrs() |
|
370 | 370 | self.init_environment() |
|
371 | 371 | |
|
372 | 372 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
373 | 373 | self.init_create_namespaces(user_ns, user_global_ns) |
|
374 | 374 | # This has to be done after init_create_namespaces because it uses |
|
375 | 375 | # something in self.user_ns, but before init_sys_modules, which |
|
376 | 376 | # is the first thing to modify sys. |
|
377 | 377 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
378 | 378 | # is created, we are saving the overridden ones here. Not sure if this |
|
379 | 379 | # is what we want to do. |
|
380 | 380 | self.save_sys_module_state() |
|
381 | 381 | self.init_sys_modules() |
|
382 | 382 | |
|
383 | 383 | # While we're trying to have each part of the code directly access what |
|
384 | 384 | # it needs without keeping redundant references to objects, we have too |
|
385 | 385 | # much legacy code that expects ip.db to exist. |
|
386 | 386 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
387 | 387 | |
|
388 | 388 | self.init_history() |
|
389 | 389 | self.init_encoding() |
|
390 | 390 | self.init_prefilter() |
|
391 | 391 | |
|
392 | 392 | Magic.__init__(self, self) |
|
393 | 393 | |
|
394 | 394 | self.init_syntax_highlighting() |
|
395 | 395 | self.init_hooks() |
|
396 | 396 | self.init_pushd_popd_magic() |
|
397 | 397 | # self.init_traceback_handlers use to be here, but we moved it below |
|
398 | 398 | # because it and init_io have to come after init_readline. |
|
399 | 399 | self.init_user_ns() |
|
400 | 400 | self.init_logger() |
|
401 | 401 | self.init_alias() |
|
402 | 402 | self.init_builtins() |
|
403 | 403 | |
|
404 | 404 | # pre_config_initialization |
|
405 | 405 | |
|
406 | 406 | # The next section should contain everything that was in ipmaker. |
|
407 | 407 | self.init_logstart() |
|
408 | 408 | |
|
409 | 409 | # The following was in post_config_initialization |
|
410 | 410 | self.init_inspector() |
|
411 | 411 | # init_readline() must come before init_io(), because init_io uses |
|
412 | 412 | # readline related things. |
|
413 | 413 | self.init_readline() |
|
414 | 414 | # init_completer must come after init_readline, because it needs to |
|
415 | 415 | # know whether readline is present or not system-wide to configure the |
|
416 | 416 | # completers, since the completion machinery can now operate |
|
417 | 417 | # independently of readline (e.g. over the network) |
|
418 | 418 | self.init_completer() |
|
419 | 419 | # TODO: init_io() needs to happen before init_traceback handlers |
|
420 | 420 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
421 | 421 | # This logic in in debugger.Pdb and should eventually be changed. |
|
422 | 422 | self.init_io() |
|
423 | 423 | self.init_traceback_handlers(custom_exceptions) |
|
424 | 424 | self.init_prompts() |
|
425 | 425 | self.init_display_formatter() |
|
426 | 426 | self.init_display_pub() |
|
427 | 427 | self.init_displayhook() |
|
428 | 428 | self.init_reload_doctest() |
|
429 | 429 | self.init_magics() |
|
430 | 430 | self.init_pdb() |
|
431 | 431 | self.init_extension_manager() |
|
432 | 432 | self.init_plugin_manager() |
|
433 | 433 | self.init_payload() |
|
434 | 434 | self.hooks.late_startup_hook() |
|
435 | 435 | atexit.register(self.atexit_operations) |
|
436 | 436 | |
|
437 | 437 | def get_ipython(self): |
|
438 | 438 | """Return the currently running IPython instance.""" |
|
439 | 439 | return self |
|
440 | 440 | |
|
441 | 441 | #------------------------------------------------------------------------- |
|
442 | 442 | # Trait changed handlers |
|
443 | 443 | #------------------------------------------------------------------------- |
|
444 | 444 | |
|
445 | 445 | def _ipython_dir_changed(self, name, new): |
|
446 | 446 | if not os.path.isdir(new): |
|
447 | 447 | os.makedirs(new, mode = 0777) |
|
448 | 448 | |
|
449 | 449 | def set_autoindent(self,value=None): |
|
450 | 450 | """Set the autoindent flag, checking for readline support. |
|
451 | 451 | |
|
452 | 452 | If called with no arguments, it acts as a toggle.""" |
|
453 | 453 | |
|
454 | 454 | if not self.has_readline: |
|
455 | 455 | if os.name == 'posix': |
|
456 | 456 | warn("The auto-indent feature requires the readline library") |
|
457 | 457 | self.autoindent = 0 |
|
458 | 458 | return |
|
459 | 459 | if value is None: |
|
460 | 460 | self.autoindent = not self.autoindent |
|
461 | 461 | else: |
|
462 | 462 | self.autoindent = value |
|
463 | 463 | |
|
464 | 464 | #------------------------------------------------------------------------- |
|
465 | 465 | # init_* methods called by __init__ |
|
466 | 466 | #------------------------------------------------------------------------- |
|
467 | 467 | |
|
468 | 468 | def init_ipython_dir(self, ipython_dir): |
|
469 | 469 | if ipython_dir is not None: |
|
470 | 470 | self.ipython_dir = ipython_dir |
|
471 | 471 | return |
|
472 | 472 | |
|
473 | 473 | self.ipython_dir = get_ipython_dir() |
|
474 | 474 | |
|
475 | 475 | def init_profile_dir(self, profile_dir): |
|
476 | 476 | if profile_dir is not None: |
|
477 | 477 | self.profile_dir = profile_dir |
|
478 | 478 | return |
|
479 | 479 | self.profile_dir =\ |
|
480 | 480 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
481 | 481 | |
|
482 | 482 | def init_instance_attrs(self): |
|
483 | 483 | self.more = False |
|
484 | 484 | |
|
485 | 485 | # command compiler |
|
486 | 486 | self.compile = CachingCompiler() |
|
487 | 487 | |
|
488 | 488 | # Make an empty namespace, which extension writers can rely on both |
|
489 | 489 | # existing and NEVER being used by ipython itself. This gives them a |
|
490 | 490 | # convenient location for storing additional information and state |
|
491 | 491 | # their extensions may require, without fear of collisions with other |
|
492 | 492 | # ipython names that may develop later. |
|
493 | 493 | self.meta = Struct() |
|
494 | 494 | |
|
495 | 495 | # Temporary files used for various purposes. Deleted at exit. |
|
496 | 496 | self.tempfiles = [] |
|
497 | 497 | |
|
498 | 498 | # Keep track of readline usage (later set by init_readline) |
|
499 | 499 | self.has_readline = False |
|
500 | 500 | |
|
501 | 501 | # keep track of where we started running (mainly for crash post-mortem) |
|
502 | 502 | # This is not being used anywhere currently. |
|
503 | 503 | self.starting_dir = os.getcwd() |
|
504 | 504 | |
|
505 | 505 | # Indentation management |
|
506 | 506 | self.indent_current_nsp = 0 |
|
507 | 507 | |
|
508 | 508 | # Dict to track post-execution functions that have been registered |
|
509 | 509 | self._post_execute = {} |
|
510 | 510 | |
|
511 | 511 | def init_environment(self): |
|
512 | 512 | """Any changes we need to make to the user's environment.""" |
|
513 | 513 | pass |
|
514 | 514 | |
|
515 | 515 | def init_encoding(self): |
|
516 | 516 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
517 | 517 | # under Win32 have it set to None, and we need to have a known valid |
|
518 | 518 | # encoding to use in the raw_input() method |
|
519 | 519 | try: |
|
520 | 520 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
521 | 521 | except AttributeError: |
|
522 | 522 | self.stdin_encoding = 'ascii' |
|
523 | 523 | |
|
524 | 524 | def init_syntax_highlighting(self): |
|
525 | 525 | # Python source parser/formatter for syntax highlighting |
|
526 | 526 | pyformat = PyColorize.Parser().format |
|
527 | 527 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
528 | 528 | |
|
529 | 529 | def init_pushd_popd_magic(self): |
|
530 | 530 | # for pushd/popd management |
|
531 | 531 | try: |
|
532 | 532 | self.home_dir = get_home_dir() |
|
533 | 533 | except HomeDirError, msg: |
|
534 | 534 | fatal(msg) |
|
535 | 535 | |
|
536 | 536 | self.dir_stack = [] |
|
537 | 537 | |
|
538 | 538 | def init_logger(self): |
|
539 | 539 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
540 | 540 | logmode='rotate') |
|
541 | 541 | |
|
542 | 542 | def init_logstart(self): |
|
543 | 543 | """Initialize logging in case it was requested at the command line. |
|
544 | 544 | """ |
|
545 | 545 | if self.logappend: |
|
546 | 546 | self.magic_logstart(self.logappend + ' append') |
|
547 | 547 | elif self.logfile: |
|
548 | 548 | self.magic_logstart(self.logfile) |
|
549 | 549 | elif self.logstart: |
|
550 | 550 | self.magic_logstart() |
|
551 | 551 | |
|
552 | 552 | def init_builtins(self): |
|
553 | 553 | self.builtin_trap = BuiltinTrap(shell=self) |
|
554 | 554 | |
|
555 | 555 | def init_inspector(self): |
|
556 | 556 | # Object inspector |
|
557 | 557 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
558 | 558 | PyColorize.ANSICodeColors, |
|
559 | 559 | 'NoColor', |
|
560 | 560 | self.object_info_string_level) |
|
561 | 561 | |
|
562 | 562 | def init_io(self): |
|
563 | 563 | # This will just use sys.stdout and sys.stderr. If you want to |
|
564 | 564 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
565 | 565 | # *before* instantiating this class, because io holds onto |
|
566 | 566 | # references to the underlying streams. |
|
567 | 567 | if sys.platform == 'win32' and self.has_readline: |
|
568 | 568 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
569 | 569 | else: |
|
570 | 570 | io.stdout = io.IOStream(sys.stdout) |
|
571 | 571 | io.stderr = io.IOStream(sys.stderr) |
|
572 | 572 | |
|
573 | 573 | def init_prompts(self): |
|
574 | 574 | # TODO: This is a pass for now because the prompts are managed inside |
|
575 | 575 | # the DisplayHook. Once there is a separate prompt manager, this |
|
576 | 576 | # will initialize that object and all prompt related information. |
|
577 | 577 | pass |
|
578 | 578 | |
|
579 | 579 | def init_display_formatter(self): |
|
580 | 580 | self.display_formatter = DisplayFormatter(config=self.config) |
|
581 | 581 | |
|
582 | 582 | def init_display_pub(self): |
|
583 | 583 | self.display_pub = self.display_pub_class(config=self.config) |
|
584 | 584 | |
|
585 | 585 | def init_displayhook(self): |
|
586 | 586 | # Initialize displayhook, set in/out prompts and printing system |
|
587 | 587 | self.displayhook = self.displayhook_class( |
|
588 | 588 | config=self.config, |
|
589 | 589 | shell=self, |
|
590 | 590 | cache_size=self.cache_size, |
|
591 | 591 | input_sep = self.separate_in, |
|
592 | 592 | output_sep = self.separate_out, |
|
593 | 593 | output_sep2 = self.separate_out2, |
|
594 | 594 | ps1 = self.prompt_in1, |
|
595 | 595 | ps2 = self.prompt_in2, |
|
596 | 596 | ps_out = self.prompt_out, |
|
597 | 597 | pad_left = self.prompts_pad_left |
|
598 | 598 | ) |
|
599 | 599 | # This is a context manager that installs/revmoes the displayhook at |
|
600 | 600 | # the appropriate time. |
|
601 | 601 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
602 | 602 | |
|
603 | 603 | def init_reload_doctest(self): |
|
604 | 604 | # Do a proper resetting of doctest, including the necessary displayhook |
|
605 | 605 | # monkeypatching |
|
606 | 606 | try: |
|
607 | 607 | doctest_reload() |
|
608 | 608 | except ImportError: |
|
609 | 609 | warn("doctest module does not exist.") |
|
610 | 610 | |
|
611 | 611 | #------------------------------------------------------------------------- |
|
612 | 612 | # Things related to injections into the sys module |
|
613 | 613 | #------------------------------------------------------------------------- |
|
614 | 614 | |
|
615 | 615 | def save_sys_module_state(self): |
|
616 | 616 | """Save the state of hooks in the sys module. |
|
617 | 617 | |
|
618 | 618 | This has to be called after self.user_ns is created. |
|
619 | 619 | """ |
|
620 | 620 | self._orig_sys_module_state = {} |
|
621 | 621 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
622 | 622 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
623 | 623 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
624 | 624 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
625 | 625 | try: |
|
626 | 626 | self._orig_sys_modules_main_name = self.user_ns['__name__'] |
|
627 | 627 | except KeyError: |
|
628 | 628 | pass |
|
629 | 629 | |
|
630 | 630 | def restore_sys_module_state(self): |
|
631 | 631 | """Restore the state of the sys module.""" |
|
632 | 632 | try: |
|
633 | 633 | for k, v in self._orig_sys_module_state.iteritems(): |
|
634 | 634 | setattr(sys, k, v) |
|
635 | 635 | except AttributeError: |
|
636 | 636 | pass |
|
637 | 637 | # Reset what what done in self.init_sys_modules |
|
638 | 638 | try: |
|
639 | 639 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name |
|
640 | 640 | except (AttributeError, KeyError): |
|
641 | 641 | pass |
|
642 | 642 | |
|
643 | 643 | #------------------------------------------------------------------------- |
|
644 | 644 | # Things related to hooks |
|
645 | 645 | #------------------------------------------------------------------------- |
|
646 | 646 | |
|
647 | 647 | def init_hooks(self): |
|
648 | 648 | # hooks holds pointers used for user-side customizations |
|
649 | 649 | self.hooks = Struct() |
|
650 | 650 | |
|
651 | 651 | self.strdispatchers = {} |
|
652 | 652 | |
|
653 | 653 | # Set all default hooks, defined in the IPython.hooks module. |
|
654 | 654 | hooks = IPython.core.hooks |
|
655 | 655 | for hook_name in hooks.__all__: |
|
656 | 656 | # default hooks have priority 100, i.e. low; user hooks should have |
|
657 | 657 | # 0-100 priority |
|
658 | 658 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
659 | 659 | |
|
660 | 660 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
661 | 661 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
662 | 662 | |
|
663 | 663 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
664 | 664 | adding your function to one of these hooks, you can modify IPython's |
|
665 | 665 | behavior to call at runtime your own routines.""" |
|
666 | 666 | |
|
667 | 667 | # At some point in the future, this should validate the hook before it |
|
668 | 668 | # accepts it. Probably at least check that the hook takes the number |
|
669 | 669 | # of args it's supposed to. |
|
670 | 670 | |
|
671 | 671 | f = types.MethodType(hook,self) |
|
672 | 672 | |
|
673 | 673 | # check if the hook is for strdispatcher first |
|
674 | 674 | if str_key is not None: |
|
675 | 675 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
676 | 676 | sdp.add_s(str_key, f, priority ) |
|
677 | 677 | self.strdispatchers[name] = sdp |
|
678 | 678 | return |
|
679 | 679 | if re_key is not None: |
|
680 | 680 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
681 | 681 | sdp.add_re(re.compile(re_key), f, priority ) |
|
682 | 682 | self.strdispatchers[name] = sdp |
|
683 | 683 | return |
|
684 | 684 | |
|
685 | 685 | dp = getattr(self.hooks, name, None) |
|
686 | 686 | if name not in IPython.core.hooks.__all__: |
|
687 | 687 | print "Warning! Hook '%s' is not one of %s" % \ |
|
688 | 688 | (name, IPython.core.hooks.__all__ ) |
|
689 | 689 | if not dp: |
|
690 | 690 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
691 | 691 | |
|
692 | 692 | try: |
|
693 | 693 | dp.add(f,priority) |
|
694 | 694 | except AttributeError: |
|
695 | 695 | # it was not commandchain, plain old func - replace |
|
696 | 696 | dp = f |
|
697 | 697 | |
|
698 | 698 | setattr(self.hooks,name, dp) |
|
699 | 699 | |
|
700 | 700 | def register_post_execute(self, func): |
|
701 | 701 | """Register a function for calling after code execution. |
|
702 | 702 | """ |
|
703 | 703 | if not callable(func): |
|
704 | 704 | raise ValueError('argument %s must be callable' % func) |
|
705 | 705 | self._post_execute[func] = True |
|
706 | 706 | |
|
707 | 707 | #------------------------------------------------------------------------- |
|
708 | 708 | # Things related to the "main" module |
|
709 | 709 | #------------------------------------------------------------------------- |
|
710 | 710 | |
|
711 | 711 | def new_main_mod(self,ns=None): |
|
712 | 712 | """Return a new 'main' module object for user code execution. |
|
713 | 713 | """ |
|
714 | 714 | main_mod = self._user_main_module |
|
715 | 715 | init_fakemod_dict(main_mod,ns) |
|
716 | 716 | return main_mod |
|
717 | 717 | |
|
718 | 718 | def cache_main_mod(self,ns,fname): |
|
719 | 719 | """Cache a main module's namespace. |
|
720 | 720 | |
|
721 | 721 | When scripts are executed via %run, we must keep a reference to the |
|
722 | 722 | namespace of their __main__ module (a FakeModule instance) around so |
|
723 | 723 | that Python doesn't clear it, rendering objects defined therein |
|
724 | 724 | useless. |
|
725 | 725 | |
|
726 | 726 | This method keeps said reference in a private dict, keyed by the |
|
727 | 727 | absolute path of the module object (which corresponds to the script |
|
728 | 728 | path). This way, for multiple executions of the same script we only |
|
729 | 729 | keep one copy of the namespace (the last one), thus preventing memory |
|
730 | 730 | leaks from old references while allowing the objects from the last |
|
731 | 731 | execution to be accessible. |
|
732 | 732 | |
|
733 | 733 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
734 | 734 | because of how Python tears down modules (it hard-sets all their |
|
735 | 735 | references to None without regard for reference counts). This method |
|
736 | 736 | must therefore make a *copy* of the given namespace, to allow the |
|
737 | 737 | original module's __dict__ to be cleared and reused. |
|
738 | 738 | |
|
739 | 739 | |
|
740 | 740 | Parameters |
|
741 | 741 | ---------- |
|
742 | 742 | ns : a namespace (a dict, typically) |
|
743 | 743 | |
|
744 | 744 | fname : str |
|
745 | 745 | Filename associated with the namespace. |
|
746 | 746 | |
|
747 | 747 | Examples |
|
748 | 748 | -------- |
|
749 | 749 | |
|
750 | 750 | In [10]: import IPython |
|
751 | 751 | |
|
752 | 752 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
753 | 753 | |
|
754 | 754 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
755 | 755 | Out[12]: True |
|
756 | 756 | """ |
|
757 | 757 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
758 | 758 | |
|
759 | 759 | def clear_main_mod_cache(self): |
|
760 | 760 | """Clear the cache of main modules. |
|
761 | 761 | |
|
762 | 762 | Mainly for use by utilities like %reset. |
|
763 | 763 | |
|
764 | 764 | Examples |
|
765 | 765 | -------- |
|
766 | 766 | |
|
767 | 767 | In [15]: import IPython |
|
768 | 768 | |
|
769 | 769 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
770 | 770 | |
|
771 | 771 | In [17]: len(_ip._main_ns_cache) > 0 |
|
772 | 772 | Out[17]: True |
|
773 | 773 | |
|
774 | 774 | In [18]: _ip.clear_main_mod_cache() |
|
775 | 775 | |
|
776 | 776 | In [19]: len(_ip._main_ns_cache) == 0 |
|
777 | 777 | Out[19]: True |
|
778 | 778 | """ |
|
779 | 779 | self._main_ns_cache.clear() |
|
780 | 780 | |
|
781 | 781 | #------------------------------------------------------------------------- |
|
782 | 782 | # Things related to debugging |
|
783 | 783 | #------------------------------------------------------------------------- |
|
784 | 784 | |
|
785 | 785 | def init_pdb(self): |
|
786 | 786 | # Set calling of pdb on exceptions |
|
787 | 787 | # self.call_pdb is a property |
|
788 | 788 | self.call_pdb = self.pdb |
|
789 | 789 | |
|
790 | 790 | def _get_call_pdb(self): |
|
791 | 791 | return self._call_pdb |
|
792 | 792 | |
|
793 | 793 | def _set_call_pdb(self,val): |
|
794 | 794 | |
|
795 | 795 | if val not in (0,1,False,True): |
|
796 | 796 | raise ValueError,'new call_pdb value must be boolean' |
|
797 | 797 | |
|
798 | 798 | # store value in instance |
|
799 | 799 | self._call_pdb = val |
|
800 | 800 | |
|
801 | 801 | # notify the actual exception handlers |
|
802 | 802 | self.InteractiveTB.call_pdb = val |
|
803 | 803 | |
|
804 | 804 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
805 | 805 | 'Control auto-activation of pdb at exceptions') |
|
806 | 806 | |
|
807 | 807 | def debugger(self,force=False): |
|
808 | 808 | """Call the pydb/pdb debugger. |
|
809 | 809 | |
|
810 | 810 | Keywords: |
|
811 | 811 | |
|
812 | 812 | - force(False): by default, this routine checks the instance call_pdb |
|
813 | 813 | flag and does not actually invoke the debugger if the flag is false. |
|
814 | 814 | The 'force' option forces the debugger to activate even if the flag |
|
815 | 815 | is false. |
|
816 | 816 | """ |
|
817 | 817 | |
|
818 | 818 | if not (force or self.call_pdb): |
|
819 | 819 | return |
|
820 | 820 | |
|
821 | 821 | if not hasattr(sys,'last_traceback'): |
|
822 | 822 | error('No traceback has been produced, nothing to debug.') |
|
823 | 823 | return |
|
824 | 824 | |
|
825 | 825 | # use pydb if available |
|
826 | 826 | if debugger.has_pydb: |
|
827 | 827 | from pydb import pm |
|
828 | 828 | else: |
|
829 | 829 | # fallback to our internal debugger |
|
830 | 830 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
831 | 831 | |
|
832 | 832 | with self.readline_no_record: |
|
833 | 833 | pm() |
|
834 | 834 | |
|
835 | 835 | #------------------------------------------------------------------------- |
|
836 | 836 | # Things related to IPython's various namespaces |
|
837 | 837 | #------------------------------------------------------------------------- |
|
838 | 838 | |
|
839 | 839 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): |
|
840 | 840 | # Create the namespace where the user will operate. user_ns is |
|
841 | 841 | # normally the only one used, and it is passed to the exec calls as |
|
842 | 842 | # the locals argument. But we do carry a user_global_ns namespace |
|
843 | 843 | # given as the exec 'globals' argument, This is useful in embedding |
|
844 | 844 | # situations where the ipython shell opens in a context where the |
|
845 | 845 | # distinction between locals and globals is meaningful. For |
|
846 | 846 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
847 | 847 | |
|
848 | 848 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
849 | 849 | # level as a dict instead of a module. This is a manual fix, but I |
|
850 | 850 | # should really track down where the problem is coming from. Alex |
|
851 | 851 | # Schmolck reported this problem first. |
|
852 | 852 | |
|
853 | 853 | # A useful post by Alex Martelli on this topic: |
|
854 | 854 | # Re: inconsistent value from __builtins__ |
|
855 | 855 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
856 | 856 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
857 | 857 | # Gruppen: comp.lang.python |
|
858 | 858 | |
|
859 | 859 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
860 | 860 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
861 | 861 | # > <type 'dict'> |
|
862 | 862 | # > >>> print type(__builtins__) |
|
863 | 863 | # > <type 'module'> |
|
864 | 864 | # > Is this difference in return value intentional? |
|
865 | 865 | |
|
866 | 866 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
867 | 867 | # or a module, and it's been that way for a long time. Whether it's |
|
868 | 868 | # intentional (or sensible), I don't know. In any case, the idea is |
|
869 | 869 | # that if you need to access the built-in namespace directly, you |
|
870 | 870 | # should start with "import __builtin__" (note, no 's') which will |
|
871 | 871 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
872 | 872 | |
|
873 | 873 | # These routines return properly built dicts as needed by the rest of |
|
874 | 874 | # the code, and can also be used by extension writers to generate |
|
875 | 875 | # properly initialized namespaces. |
|
876 | 876 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, |
|
877 | 877 | user_global_ns) |
|
878 | 878 | |
|
879 | 879 | # Assign namespaces |
|
880 | 880 | # This is the namespace where all normal user variables live |
|
881 | 881 | self.user_ns = user_ns |
|
882 | 882 | self.user_global_ns = user_global_ns |
|
883 | 883 | |
|
884 | 884 | # An auxiliary namespace that checks what parts of the user_ns were |
|
885 | 885 | # loaded at startup, so we can list later only variables defined in |
|
886 | 886 | # actual interactive use. Since it is always a subset of user_ns, it |
|
887 | 887 | # doesn't need to be separately tracked in the ns_table. |
|
888 | 888 | self.user_ns_hidden = {} |
|
889 | 889 | |
|
890 | 890 | # A namespace to keep track of internal data structures to prevent |
|
891 | 891 | # them from cluttering user-visible stuff. Will be updated later |
|
892 | 892 | self.internal_ns = {} |
|
893 | 893 | |
|
894 | 894 | # Now that FakeModule produces a real module, we've run into a nasty |
|
895 | 895 | # problem: after script execution (via %run), the module where the user |
|
896 | 896 | # code ran is deleted. Now that this object is a true module (needed |
|
897 | 897 | # so docetst and other tools work correctly), the Python module |
|
898 | 898 | # teardown mechanism runs over it, and sets to None every variable |
|
899 | 899 | # present in that module. Top-level references to objects from the |
|
900 | 900 | # script survive, because the user_ns is updated with them. However, |
|
901 | 901 | # calling functions defined in the script that use other things from |
|
902 | 902 | # the script will fail, because the function's closure had references |
|
903 | 903 | # to the original objects, which are now all None. So we must protect |
|
904 | 904 | # these modules from deletion by keeping a cache. |
|
905 | 905 | # |
|
906 | 906 | # To avoid keeping stale modules around (we only need the one from the |
|
907 | 907 | # last run), we use a dict keyed with the full path to the script, so |
|
908 | 908 | # only the last version of the module is held in the cache. Note, |
|
909 | 909 | # however, that we must cache the module *namespace contents* (their |
|
910 | 910 | # __dict__). Because if we try to cache the actual modules, old ones |
|
911 | 911 | # (uncached) could be destroyed while still holding references (such as |
|
912 | 912 | # those held by GUI objects that tend to be long-lived)> |
|
913 | 913 | # |
|
914 | 914 | # The %reset command will flush this cache. See the cache_main_mod() |
|
915 | 915 | # and clear_main_mod_cache() methods for details on use. |
|
916 | 916 | |
|
917 | 917 | # This is the cache used for 'main' namespaces |
|
918 | 918 | self._main_ns_cache = {} |
|
919 | 919 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
920 | 920 | # copying and clearing for reuse on each %run |
|
921 | 921 | self._user_main_module = FakeModule() |
|
922 | 922 | |
|
923 | 923 | # A table holding all the namespaces IPython deals with, so that |
|
924 | 924 | # introspection facilities can search easily. |
|
925 | 925 | self.ns_table = {'user':user_ns, |
|
926 | 926 | 'user_global':user_global_ns, |
|
927 | 927 | 'internal':self.internal_ns, |
|
928 | 928 | 'builtin':__builtin__.__dict__ |
|
929 | 929 | } |
|
930 | 930 | |
|
931 | 931 | # Similarly, track all namespaces where references can be held and that |
|
932 | 932 | # we can safely clear (so it can NOT include builtin). This one can be |
|
933 | 933 | # a simple list. Note that the main execution namespaces, user_ns and |
|
934 | 934 | # user_global_ns, can NOT be listed here, as clearing them blindly |
|
935 | 935 | # causes errors in object __del__ methods. Instead, the reset() method |
|
936 | 936 | # clears them manually and carefully. |
|
937 | 937 | self.ns_refs_table = [ self.user_ns_hidden, |
|
938 | 938 | self.internal_ns, self._main_ns_cache ] |
|
939 | 939 | |
|
940 | 940 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
941 | 941 | """Return a valid local and global user interactive namespaces. |
|
942 | 942 | |
|
943 | 943 | This builds a dict with the minimal information needed to operate as a |
|
944 | 944 | valid IPython user namespace, which you can pass to the various |
|
945 | 945 | embedding classes in ipython. The default implementation returns the |
|
946 | 946 | same dict for both the locals and the globals to allow functions to |
|
947 | 947 | refer to variables in the namespace. Customized implementations can |
|
948 | 948 | return different dicts. The locals dictionary can actually be anything |
|
949 | 949 | following the basic mapping protocol of a dict, but the globals dict |
|
950 | 950 | must be a true dict, not even a subclass. It is recommended that any |
|
951 | 951 | custom object for the locals namespace synchronize with the globals |
|
952 | 952 | dict somehow. |
|
953 | 953 | |
|
954 | 954 | Raises TypeError if the provided globals namespace is not a true dict. |
|
955 | 955 | |
|
956 | 956 | Parameters |
|
957 | 957 | ---------- |
|
958 | 958 | user_ns : dict-like, optional |
|
959 | 959 | The current user namespace. The items in this namespace should |
|
960 | 960 | be included in the output. If None, an appropriate blank |
|
961 | 961 | namespace should be created. |
|
962 | 962 | user_global_ns : dict, optional |
|
963 | 963 | The current user global namespace. The items in this namespace |
|
964 | 964 | should be included in the output. If None, an appropriate |
|
965 | 965 | blank namespace should be created. |
|
966 | 966 | |
|
967 | 967 | Returns |
|
968 | 968 | ------- |
|
969 | 969 | A pair of dictionary-like object to be used as the local namespace |
|
970 | 970 | of the interpreter and a dict to be used as the global namespace. |
|
971 | 971 | """ |
|
972 | 972 | |
|
973 | 973 | |
|
974 | 974 | # We must ensure that __builtin__ (without the final 's') is always |
|
975 | 975 | # available and pointing to the __builtin__ *module*. For more details: |
|
976 | 976 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
977 | 977 | |
|
978 | 978 | if user_ns is None: |
|
979 | 979 | # Set __name__ to __main__ to better match the behavior of the |
|
980 | 980 | # normal interpreter. |
|
981 | 981 | user_ns = {'__name__' :'__main__', |
|
982 | 982 | '__builtin__' : __builtin__, |
|
983 | 983 | '__builtins__' : __builtin__, |
|
984 | 984 | } |
|
985 | 985 | else: |
|
986 | 986 | user_ns.setdefault('__name__','__main__') |
|
987 | 987 | user_ns.setdefault('__builtin__',__builtin__) |
|
988 | 988 | user_ns.setdefault('__builtins__',__builtin__) |
|
989 | 989 | |
|
990 | 990 | if user_global_ns is None: |
|
991 | 991 | user_global_ns = user_ns |
|
992 | 992 | if type(user_global_ns) is not dict: |
|
993 | 993 | raise TypeError("user_global_ns must be a true dict; got %r" |
|
994 | 994 | % type(user_global_ns)) |
|
995 | 995 | |
|
996 | 996 | return user_ns, user_global_ns |
|
997 | 997 | |
|
998 | 998 | def init_sys_modules(self): |
|
999 | 999 | # We need to insert into sys.modules something that looks like a |
|
1000 | 1000 | # module but which accesses the IPython namespace, for shelve and |
|
1001 | 1001 | # pickle to work interactively. Normally they rely on getting |
|
1002 | 1002 | # everything out of __main__, but for embedding purposes each IPython |
|
1003 | 1003 | # instance has its own private namespace, so we can't go shoving |
|
1004 | 1004 | # everything into __main__. |
|
1005 | 1005 | |
|
1006 | 1006 | # note, however, that we should only do this for non-embedded |
|
1007 | 1007 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1008 | 1008 | # namespace. Embedded instances, on the other hand, should not do |
|
1009 | 1009 | # this because they need to manage the user local/global namespaces |
|
1010 | 1010 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1011 | 1011 | # shouldn't overtake the execution environment of the script they're |
|
1012 | 1012 | # embedded in). |
|
1013 | 1013 | |
|
1014 | 1014 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1015 | 1015 | |
|
1016 | 1016 | try: |
|
1017 | 1017 | main_name = self.user_ns['__name__'] |
|
1018 | 1018 | except KeyError: |
|
1019 | 1019 | raise KeyError('user_ns dictionary MUST have a "__name__" key') |
|
1020 | 1020 | else: |
|
1021 | 1021 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
1022 | 1022 | |
|
1023 | 1023 | def init_user_ns(self): |
|
1024 | 1024 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1025 | 1025 | |
|
1026 | 1026 | Certain history lists are also initialized here, as they effectively |
|
1027 | 1027 | act as user namespaces. |
|
1028 | 1028 | |
|
1029 | 1029 | Notes |
|
1030 | 1030 | ----- |
|
1031 | 1031 | All data structures here are only filled in, they are NOT reset by this |
|
1032 | 1032 | method. If they were not empty before, data will simply be added to |
|
1033 | 1033 | therm. |
|
1034 | 1034 | """ |
|
1035 | 1035 | # This function works in two parts: first we put a few things in |
|
1036 | 1036 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1037 | 1037 | # initial variables aren't shown by %who. After the sync, we add the |
|
1038 | 1038 | # rest of what we *do* want the user to see with %who even on a new |
|
1039 | 1039 | # session (probably nothing, so theye really only see their own stuff) |
|
1040 | 1040 | |
|
1041 | 1041 | # The user dict must *always* have a __builtin__ reference to the |
|
1042 | 1042 | # Python standard __builtin__ namespace, which must be imported. |
|
1043 | 1043 | # This is so that certain operations in prompt evaluation can be |
|
1044 | 1044 | # reliably executed with builtins. Note that we can NOT use |
|
1045 | 1045 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1046 | 1046 | # module, and can even mutate at runtime, depending on the context |
|
1047 | 1047 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1048 | 1048 | # always a module object, though it must be explicitly imported. |
|
1049 | 1049 | |
|
1050 | 1050 | # For more details: |
|
1051 | 1051 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1052 | 1052 | ns = dict(__builtin__ = __builtin__) |
|
1053 | 1053 | |
|
1054 | 1054 | # Put 'help' in the user namespace |
|
1055 | 1055 | try: |
|
1056 | 1056 | from site import _Helper |
|
1057 | 1057 | ns['help'] = _Helper() |
|
1058 | 1058 | except ImportError: |
|
1059 | 1059 | warn('help() not available - check site.py') |
|
1060 | 1060 | |
|
1061 | 1061 | # make global variables for user access to the histories |
|
1062 | 1062 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1063 | 1063 | ns['_oh'] = self.history_manager.output_hist |
|
1064 | 1064 | ns['_dh'] = self.history_manager.dir_hist |
|
1065 | 1065 | |
|
1066 | 1066 | ns['_sh'] = shadowns |
|
1067 | 1067 | |
|
1068 | 1068 | # user aliases to input and output histories. These shouldn't show up |
|
1069 | 1069 | # in %who, as they can have very large reprs. |
|
1070 | 1070 | ns['In'] = self.history_manager.input_hist_parsed |
|
1071 | 1071 | ns['Out'] = self.history_manager.output_hist |
|
1072 | 1072 | |
|
1073 | 1073 | # Store myself as the public api!!! |
|
1074 | 1074 | ns['get_ipython'] = self.get_ipython |
|
1075 | 1075 | |
|
1076 | 1076 | ns['exit'] = self.exiter |
|
1077 | 1077 | ns['quit'] = self.exiter |
|
1078 | 1078 | |
|
1079 | 1079 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1080 | 1080 | # by %who |
|
1081 | 1081 | self.user_ns_hidden.update(ns) |
|
1082 | 1082 | |
|
1083 | 1083 | # Anything put into ns now would show up in %who. Think twice before |
|
1084 | 1084 | # putting anything here, as we really want %who to show the user their |
|
1085 | 1085 | # stuff, not our variables. |
|
1086 | 1086 | |
|
1087 | 1087 | # Finally, update the real user's namespace |
|
1088 | 1088 | self.user_ns.update(ns) |
|
1089 | 1089 | |
|
1090 | 1090 | def reset(self, new_session=True): |
|
1091 | 1091 | """Clear all internal namespaces, and attempt to release references to |
|
1092 | 1092 | user objects. |
|
1093 | 1093 | |
|
1094 | 1094 | If new_session is True, a new history session will be opened. |
|
1095 | 1095 | """ |
|
1096 | 1096 | # Clear histories |
|
1097 | 1097 | self.history_manager.reset(new_session) |
|
1098 | 1098 | # Reset counter used to index all histories |
|
1099 | 1099 | if new_session: |
|
1100 | 1100 | self.execution_count = 1 |
|
1101 | 1101 | |
|
1102 | 1102 | # Flush cached output items |
|
1103 | 1103 | if self.displayhook.do_full_cache: |
|
1104 | 1104 | self.displayhook.flush() |
|
1105 | 1105 | |
|
1106 | 1106 | # Restore the user namespaces to minimal usability |
|
1107 | 1107 | for ns in self.ns_refs_table: |
|
1108 | 1108 | ns.clear() |
|
1109 | 1109 | |
|
1110 | 1110 | # The main execution namespaces must be cleared very carefully, |
|
1111 | 1111 | # skipping the deletion of the builtin-related keys, because doing so |
|
1112 | 1112 | # would cause errors in many object's __del__ methods. |
|
1113 | 1113 | for ns in [self.user_ns, self.user_global_ns]: |
|
1114 | 1114 | drop_keys = set(ns.keys()) |
|
1115 | 1115 | drop_keys.discard('__builtin__') |
|
1116 | 1116 | drop_keys.discard('__builtins__') |
|
1117 | 1117 | for k in drop_keys: |
|
1118 | 1118 | del ns[k] |
|
1119 | 1119 | |
|
1120 | 1120 | # Restore the user namespaces to minimal usability |
|
1121 | 1121 | self.init_user_ns() |
|
1122 | 1122 | |
|
1123 | 1123 | # Restore the default and user aliases |
|
1124 | 1124 | self.alias_manager.clear_aliases() |
|
1125 | 1125 | self.alias_manager.init_aliases() |
|
1126 | 1126 | |
|
1127 | 1127 | # Flush the private list of module references kept for script |
|
1128 | 1128 | # execution protection |
|
1129 | 1129 | self.clear_main_mod_cache() |
|
1130 | 1130 | |
|
1131 | 1131 | # Clear out the namespace from the last %run |
|
1132 | 1132 | self.new_main_mod() |
|
1133 | 1133 | |
|
1134 | 1134 | def del_var(self, varname, by_name=False): |
|
1135 | 1135 | """Delete a variable from the various namespaces, so that, as |
|
1136 | 1136 | far as possible, we're not keeping any hidden references to it. |
|
1137 | 1137 | |
|
1138 | 1138 | Parameters |
|
1139 | 1139 | ---------- |
|
1140 | 1140 | varname : str |
|
1141 | 1141 | The name of the variable to delete. |
|
1142 | 1142 | by_name : bool |
|
1143 | 1143 | If True, delete variables with the given name in each |
|
1144 | 1144 | namespace. If False (default), find the variable in the user |
|
1145 | 1145 | namespace, and delete references to it. |
|
1146 | 1146 | """ |
|
1147 | 1147 | if varname in ('__builtin__', '__builtins__'): |
|
1148 | 1148 | raise ValueError("Refusing to delete %s" % varname) |
|
1149 | 1149 | ns_refs = self.ns_refs_table + [self.user_ns, |
|
1150 | 1150 | self.user_global_ns, self._user_main_module.__dict__] +\ |
|
1151 | 1151 | self._main_ns_cache.values() |
|
1152 | 1152 | |
|
1153 | 1153 | if by_name: # Delete by name |
|
1154 | 1154 | for ns in ns_refs: |
|
1155 | 1155 | try: |
|
1156 | 1156 | del ns[varname] |
|
1157 | 1157 | except KeyError: |
|
1158 | 1158 | pass |
|
1159 | 1159 | else: # Delete by object |
|
1160 | 1160 | try: |
|
1161 | 1161 | obj = self.user_ns[varname] |
|
1162 | 1162 | except KeyError: |
|
1163 | 1163 | raise NameError("name '%s' is not defined" % varname) |
|
1164 | 1164 | # Also check in output history |
|
1165 | 1165 | ns_refs.append(self.history_manager.output_hist) |
|
1166 | 1166 | for ns in ns_refs: |
|
1167 | 1167 | to_delete = [n for n, o in ns.iteritems() if o is obj] |
|
1168 | 1168 | for name in to_delete: |
|
1169 | 1169 | del ns[name] |
|
1170 | 1170 | |
|
1171 | 1171 | # displayhook keeps extra references, but not in a dictionary |
|
1172 | 1172 | for name in ('_', '__', '___'): |
|
1173 | 1173 | if getattr(self.displayhook, name) is obj: |
|
1174 | 1174 | setattr(self.displayhook, name, None) |
|
1175 | 1175 | |
|
1176 | 1176 | def reset_selective(self, regex=None): |
|
1177 | 1177 | """Clear selective variables from internal namespaces based on a |
|
1178 | 1178 | specified regular expression. |
|
1179 | 1179 | |
|
1180 | 1180 | Parameters |
|
1181 | 1181 | ---------- |
|
1182 | 1182 | regex : string or compiled pattern, optional |
|
1183 | 1183 | A regular expression pattern that will be used in searching |
|
1184 | 1184 | variable names in the users namespaces. |
|
1185 | 1185 | """ |
|
1186 | 1186 | if regex is not None: |
|
1187 | 1187 | try: |
|
1188 | 1188 | m = re.compile(regex) |
|
1189 | 1189 | except TypeError: |
|
1190 | 1190 | raise TypeError('regex must be a string or compiled pattern') |
|
1191 | 1191 | # Search for keys in each namespace that match the given regex |
|
1192 | 1192 | # If a match is found, delete the key/value pair. |
|
1193 | 1193 | for ns in self.ns_refs_table: |
|
1194 | 1194 | for var in ns: |
|
1195 | 1195 | if m.search(var): |
|
1196 | 1196 | del ns[var] |
|
1197 | 1197 | |
|
1198 | 1198 | def push(self, variables, interactive=True): |
|
1199 | 1199 | """Inject a group of variables into the IPython user namespace. |
|
1200 | 1200 | |
|
1201 | 1201 | Parameters |
|
1202 | 1202 | ---------- |
|
1203 | 1203 | variables : dict, str or list/tuple of str |
|
1204 | 1204 | The variables to inject into the user's namespace. If a dict, a |
|
1205 | 1205 | simple update is done. If a str, the string is assumed to have |
|
1206 | 1206 | variable names separated by spaces. A list/tuple of str can also |
|
1207 | 1207 | be used to give the variable names. If just the variable names are |
|
1208 | 1208 | give (list/tuple/str) then the variable values looked up in the |
|
1209 | 1209 | callers frame. |
|
1210 | 1210 | interactive : bool |
|
1211 | 1211 | If True (default), the variables will be listed with the ``who`` |
|
1212 | 1212 | magic. |
|
1213 | 1213 | """ |
|
1214 | 1214 | vdict = None |
|
1215 | 1215 | |
|
1216 | 1216 | # We need a dict of name/value pairs to do namespace updates. |
|
1217 | 1217 | if isinstance(variables, dict): |
|
1218 | 1218 | vdict = variables |
|
1219 | 1219 | elif isinstance(variables, (basestring, list, tuple)): |
|
1220 | 1220 | if isinstance(variables, basestring): |
|
1221 | 1221 | vlist = variables.split() |
|
1222 | 1222 | else: |
|
1223 | 1223 | vlist = variables |
|
1224 | 1224 | vdict = {} |
|
1225 | 1225 | cf = sys._getframe(1) |
|
1226 | 1226 | for name in vlist: |
|
1227 | 1227 | try: |
|
1228 | 1228 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1229 | 1229 | except: |
|
1230 | 1230 | print ('Could not get variable %s from %s' % |
|
1231 | 1231 | (name,cf.f_code.co_name)) |
|
1232 | 1232 | else: |
|
1233 | 1233 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1234 | 1234 | |
|
1235 | 1235 | # Propagate variables to user namespace |
|
1236 | 1236 | self.user_ns.update(vdict) |
|
1237 | 1237 | |
|
1238 | 1238 | # And configure interactive visibility |
|
1239 | 1239 | config_ns = self.user_ns_hidden |
|
1240 | 1240 | if interactive: |
|
1241 | 1241 | for name, val in vdict.iteritems(): |
|
1242 | 1242 | config_ns.pop(name, None) |
|
1243 | 1243 | else: |
|
1244 | 1244 | for name,val in vdict.iteritems(): |
|
1245 | 1245 | config_ns[name] = val |
|
1246 | 1246 | |
|
1247 | 1247 | #------------------------------------------------------------------------- |
|
1248 | 1248 | # Things related to object introspection |
|
1249 | 1249 | #------------------------------------------------------------------------- |
|
1250 | 1250 | |
|
1251 | 1251 | def _ofind(self, oname, namespaces=None): |
|
1252 | 1252 | """Find an object in the available namespaces. |
|
1253 | 1253 | |
|
1254 | 1254 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1255 | 1255 | |
|
1256 | 1256 | Has special code to detect magic functions. |
|
1257 | 1257 | """ |
|
1258 | 1258 | #oname = oname.strip() |
|
1259 | 1259 | #print '1- oname: <%r>' % oname # dbg |
|
1260 | 1260 | try: |
|
1261 | 1261 | oname = oname.strip().encode('ascii') |
|
1262 | 1262 | #print '2- oname: <%r>' % oname # dbg |
|
1263 | 1263 | except UnicodeEncodeError: |
|
1264 | 1264 | print 'Python identifiers can only contain ascii characters.' |
|
1265 | 1265 | return dict(found=False) |
|
1266 | 1266 | |
|
1267 | 1267 | alias_ns = None |
|
1268 | 1268 | if namespaces is None: |
|
1269 | 1269 | # Namespaces to search in: |
|
1270 | 1270 | # Put them in a list. The order is important so that we |
|
1271 | 1271 | # find things in the same order that Python finds them. |
|
1272 | 1272 | namespaces = [ ('Interactive', self.user_ns), |
|
1273 | 1273 | ('IPython internal', self.internal_ns), |
|
1274 | 1274 | ('Python builtin', __builtin__.__dict__), |
|
1275 | 1275 | ('Alias', self.alias_manager.alias_table), |
|
1276 | 1276 | ] |
|
1277 | 1277 | alias_ns = self.alias_manager.alias_table |
|
1278 | 1278 | |
|
1279 | 1279 | # initialize results to 'null' |
|
1280 | 1280 | found = False; obj = None; ospace = None; ds = None; |
|
1281 | 1281 | ismagic = False; isalias = False; parent = None |
|
1282 | 1282 | |
|
1283 | 1283 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1284 | 1284 | # function but should only be treated as one if print_function was |
|
1285 | 1285 | # loaded with a future import. In this case, just bail. |
|
1286 | 1286 | if (oname == 'print' and not (self.compile.compiler_flags & |
|
1287 | 1287 | __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1288 | 1288 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1289 | 1289 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1290 | 1290 | |
|
1291 | 1291 | # Look for the given name by splitting it in parts. If the head is |
|
1292 | 1292 | # found, then we look for all the remaining parts as members, and only |
|
1293 | 1293 | # declare success if we can find them all. |
|
1294 | 1294 | oname_parts = oname.split('.') |
|
1295 | 1295 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1296 | 1296 | for nsname,ns in namespaces: |
|
1297 | 1297 | try: |
|
1298 | 1298 | obj = ns[oname_head] |
|
1299 | 1299 | except KeyError: |
|
1300 | 1300 | continue |
|
1301 | 1301 | else: |
|
1302 | 1302 | #print 'oname_rest:', oname_rest # dbg |
|
1303 | 1303 | for part in oname_rest: |
|
1304 | 1304 | try: |
|
1305 | 1305 | parent = obj |
|
1306 | 1306 | obj = getattr(obj,part) |
|
1307 | 1307 | except: |
|
1308 | 1308 | # Blanket except b/c some badly implemented objects |
|
1309 | 1309 | # allow __getattr__ to raise exceptions other than |
|
1310 | 1310 | # AttributeError, which then crashes IPython. |
|
1311 | 1311 | break |
|
1312 | 1312 | else: |
|
1313 | 1313 | # If we finish the for loop (no break), we got all members |
|
1314 | 1314 | found = True |
|
1315 | 1315 | ospace = nsname |
|
1316 | 1316 | if ns == alias_ns: |
|
1317 | 1317 | isalias = True |
|
1318 | 1318 | break # namespace loop |
|
1319 | 1319 | |
|
1320 | 1320 | # Try to see if it's magic |
|
1321 | 1321 | if not found: |
|
1322 | 1322 | if oname.startswith(ESC_MAGIC): |
|
1323 | 1323 | oname = oname[1:] |
|
1324 | 1324 | obj = getattr(self,'magic_'+oname,None) |
|
1325 | 1325 | if obj is not None: |
|
1326 | 1326 | found = True |
|
1327 | 1327 | ospace = 'IPython internal' |
|
1328 | 1328 | ismagic = True |
|
1329 | 1329 | |
|
1330 | 1330 | # Last try: special-case some literals like '', [], {}, etc: |
|
1331 | 1331 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1332 | 1332 | obj = eval(oname_head) |
|
1333 | 1333 | found = True |
|
1334 | 1334 | ospace = 'Interactive' |
|
1335 | 1335 | |
|
1336 | 1336 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1337 | 1337 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1338 | 1338 | |
|
1339 | 1339 | def _ofind_property(self, oname, info): |
|
1340 | 1340 | """Second part of object finding, to look for property details.""" |
|
1341 | 1341 | if info.found: |
|
1342 | 1342 | # Get the docstring of the class property if it exists. |
|
1343 | 1343 | path = oname.split('.') |
|
1344 | 1344 | root = '.'.join(path[:-1]) |
|
1345 | 1345 | if info.parent is not None: |
|
1346 | 1346 | try: |
|
1347 | 1347 | target = getattr(info.parent, '__class__') |
|
1348 | 1348 | # The object belongs to a class instance. |
|
1349 | 1349 | try: |
|
1350 | 1350 | target = getattr(target, path[-1]) |
|
1351 | 1351 | # The class defines the object. |
|
1352 | 1352 | if isinstance(target, property): |
|
1353 | 1353 | oname = root + '.__class__.' + path[-1] |
|
1354 | 1354 | info = Struct(self._ofind(oname)) |
|
1355 | 1355 | except AttributeError: pass |
|
1356 | 1356 | except AttributeError: pass |
|
1357 | 1357 | |
|
1358 | 1358 | # We return either the new info or the unmodified input if the object |
|
1359 | 1359 | # hadn't been found |
|
1360 | 1360 | return info |
|
1361 | 1361 | |
|
1362 | 1362 | def _object_find(self, oname, namespaces=None): |
|
1363 | 1363 | """Find an object and return a struct with info about it.""" |
|
1364 | 1364 | inf = Struct(self._ofind(oname, namespaces)) |
|
1365 | 1365 | return Struct(self._ofind_property(oname, inf)) |
|
1366 | 1366 | |
|
1367 | 1367 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1368 | 1368 | """Generic interface to the inspector system. |
|
1369 | 1369 | |
|
1370 | 1370 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1371 | 1371 | info = self._object_find(oname) |
|
1372 | 1372 | if info.found: |
|
1373 | 1373 | pmethod = getattr(self.inspector, meth) |
|
1374 | 1374 | formatter = format_screen if info.ismagic else None |
|
1375 | 1375 | if meth == 'pdoc': |
|
1376 | 1376 | pmethod(info.obj, oname, formatter) |
|
1377 | 1377 | elif meth == 'pinfo': |
|
1378 | 1378 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1379 | 1379 | else: |
|
1380 | 1380 | pmethod(info.obj, oname) |
|
1381 | 1381 | else: |
|
1382 | 1382 | print 'Object `%s` not found.' % oname |
|
1383 | 1383 | return 'not found' # so callers can take other action |
|
1384 | 1384 | |
|
1385 | 1385 | def object_inspect(self, oname): |
|
1386 | 1386 | with self.builtin_trap: |
|
1387 | 1387 | info = self._object_find(oname) |
|
1388 | 1388 | if info.found: |
|
1389 | 1389 | return self.inspector.info(info.obj, oname, info=info) |
|
1390 | 1390 | else: |
|
1391 | 1391 | return oinspect.object_info(name=oname, found=False) |
|
1392 | 1392 | |
|
1393 | 1393 | #------------------------------------------------------------------------- |
|
1394 | 1394 | # Things related to history management |
|
1395 | 1395 | #------------------------------------------------------------------------- |
|
1396 | 1396 | |
|
1397 | 1397 | def init_history(self): |
|
1398 | 1398 | """Sets up the command history, and starts regular autosaves.""" |
|
1399 | 1399 | self.history_manager = HistoryManager(shell=self, config=self.config) |
|
1400 | 1400 | |
|
1401 | 1401 | #------------------------------------------------------------------------- |
|
1402 | 1402 | # Things related to exception handling and tracebacks (not debugging) |
|
1403 | 1403 | #------------------------------------------------------------------------- |
|
1404 | 1404 | |
|
1405 | 1405 | def init_traceback_handlers(self, custom_exceptions): |
|
1406 | 1406 | # Syntax error handler. |
|
1407 | 1407 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1408 | 1408 | |
|
1409 | 1409 | # The interactive one is initialized with an offset, meaning we always |
|
1410 | 1410 | # want to remove the topmost item in the traceback, which is our own |
|
1411 | 1411 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1412 | 1412 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1413 | 1413 | color_scheme='NoColor', |
|
1414 | 1414 | tb_offset = 1, |
|
1415 | 1415 | check_cache=self.compile.check_cache) |
|
1416 | 1416 | |
|
1417 | 1417 | # The instance will store a pointer to the system-wide exception hook, |
|
1418 | 1418 | # so that runtime code (such as magics) can access it. This is because |
|
1419 | 1419 | # during the read-eval loop, it may get temporarily overwritten. |
|
1420 | 1420 | self.sys_excepthook = sys.excepthook |
|
1421 | 1421 | |
|
1422 | 1422 | # and add any custom exception handlers the user may have specified |
|
1423 | 1423 | self.set_custom_exc(*custom_exceptions) |
|
1424 | 1424 | |
|
1425 | 1425 | # Set the exception mode |
|
1426 | 1426 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1427 | 1427 | |
|
1428 | 1428 | def set_custom_exc(self, exc_tuple, handler): |
|
1429 | 1429 | """set_custom_exc(exc_tuple,handler) |
|
1430 | 1430 | |
|
1431 | 1431 | Set a custom exception handler, which will be called if any of the |
|
1432 | 1432 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1433 | 1433 | run_code() method. |
|
1434 | 1434 | |
|
1435 | 1435 | Inputs: |
|
1436 | 1436 | |
|
1437 | 1437 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1438 | 1438 | handler for. It is very important that you use a tuple, and NOT A |
|
1439 | 1439 | LIST here, because of the way Python's except statement works. If |
|
1440 | 1440 | you only want to trap a single exception, use a singleton tuple: |
|
1441 | 1441 | |
|
1442 | 1442 | exc_tuple == (MyCustomException,) |
|
1443 | 1443 | |
|
1444 | 1444 | - handler: this must be defined as a function with the following |
|
1445 | 1445 | basic interface:: |
|
1446 | 1446 | |
|
1447 | 1447 | def my_handler(self, etype, value, tb, tb_offset=None) |
|
1448 | 1448 | ... |
|
1449 | 1449 | # The return value must be |
|
1450 | 1450 | return structured_traceback |
|
1451 | 1451 | |
|
1452 | 1452 | This will be made into an instance method (via types.MethodType) |
|
1453 | 1453 | of IPython itself, and it will be called if any of the exceptions |
|
1454 | 1454 | listed in the exc_tuple are caught. If the handler is None, an |
|
1455 | 1455 | internal basic one is used, which just prints basic info. |
|
1456 | 1456 | |
|
1457 | 1457 | WARNING: by putting in your own exception handler into IPython's main |
|
1458 | 1458 | execution loop, you run a very good chance of nasty crashes. This |
|
1459 | 1459 | facility should only be used if you really know what you are doing.""" |
|
1460 | 1460 | |
|
1461 | 1461 | assert type(exc_tuple)==type(()) , \ |
|
1462 | 1462 | "The custom exceptions must be given AS A TUPLE." |
|
1463 | 1463 | |
|
1464 | 1464 | def dummy_handler(self,etype,value,tb): |
|
1465 | 1465 | print '*** Simple custom exception handler ***' |
|
1466 | 1466 | print 'Exception type :',etype |
|
1467 | 1467 | print 'Exception value:',value |
|
1468 | 1468 | print 'Traceback :',tb |
|
1469 | 1469 | #print 'Source code :','\n'.join(self.buffer) |
|
1470 | 1470 | |
|
1471 | 1471 | if handler is None: handler = dummy_handler |
|
1472 | 1472 | |
|
1473 | 1473 | self.CustomTB = types.MethodType(handler,self) |
|
1474 | 1474 | self.custom_exceptions = exc_tuple |
|
1475 | 1475 | |
|
1476 | 1476 | def excepthook(self, etype, value, tb): |
|
1477 | 1477 | """One more defense for GUI apps that call sys.excepthook. |
|
1478 | 1478 | |
|
1479 | 1479 | GUI frameworks like wxPython trap exceptions and call |
|
1480 | 1480 | sys.excepthook themselves. I guess this is a feature that |
|
1481 | 1481 | enables them to keep running after exceptions that would |
|
1482 | 1482 | otherwise kill their mainloop. This is a bother for IPython |
|
1483 | 1483 | which excepts to catch all of the program exceptions with a try: |
|
1484 | 1484 | except: statement. |
|
1485 | 1485 | |
|
1486 | 1486 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1487 | 1487 | any app directly invokes sys.excepthook, it will look to the user like |
|
1488 | 1488 | IPython crashed. In order to work around this, we can disable the |
|
1489 | 1489 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1490 | 1490 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1491 | 1491 | call sys.excepthook will generate a regular-looking exception from |
|
1492 | 1492 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1493 | 1493 | crashes. |
|
1494 | 1494 | |
|
1495 | 1495 | This hook should be used sparingly, only in places which are not likely |
|
1496 | 1496 | to be true IPython errors. |
|
1497 | 1497 | """ |
|
1498 | 1498 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1499 | 1499 | |
|
1500 | 1500 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, |
|
1501 | 1501 | exception_only=False): |
|
1502 | 1502 | """Display the exception that just occurred. |
|
1503 | 1503 | |
|
1504 | 1504 | If nothing is known about the exception, this is the method which |
|
1505 | 1505 | should be used throughout the code for presenting user tracebacks, |
|
1506 | 1506 | rather than directly invoking the InteractiveTB object. |
|
1507 | 1507 | |
|
1508 | 1508 | A specific showsyntaxerror() also exists, but this method can take |
|
1509 | 1509 | care of calling it if needed, so unless you are explicitly catching a |
|
1510 | 1510 | SyntaxError exception, don't try to analyze the stack manually and |
|
1511 | 1511 | simply call this method.""" |
|
1512 | 1512 | |
|
1513 | 1513 | try: |
|
1514 | 1514 | if exc_tuple is None: |
|
1515 | 1515 | etype, value, tb = sys.exc_info() |
|
1516 | 1516 | else: |
|
1517 | 1517 | etype, value, tb = exc_tuple |
|
1518 | 1518 | |
|
1519 | 1519 | if etype is None: |
|
1520 | 1520 | if hasattr(sys, 'last_type'): |
|
1521 | 1521 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1522 | 1522 | sys.last_traceback |
|
1523 | 1523 | else: |
|
1524 | 1524 | self.write_err('No traceback available to show.\n') |
|
1525 | 1525 | return |
|
1526 | 1526 | |
|
1527 | 1527 | if etype is SyntaxError: |
|
1528 | 1528 | # Though this won't be called by syntax errors in the input |
|
1529 | 1529 | # line, there may be SyntaxError cases whith imported code. |
|
1530 | 1530 | self.showsyntaxerror(filename) |
|
1531 | 1531 | elif etype is UsageError: |
|
1532 | 1532 | print "UsageError:", value |
|
1533 | 1533 | else: |
|
1534 | 1534 | # WARNING: these variables are somewhat deprecated and not |
|
1535 | 1535 | # necessarily safe to use in a threaded environment, but tools |
|
1536 | 1536 | # like pdb depend on their existence, so let's set them. If we |
|
1537 | 1537 | # find problems in the field, we'll need to revisit their use. |
|
1538 | 1538 | sys.last_type = etype |
|
1539 | 1539 | sys.last_value = value |
|
1540 | 1540 | sys.last_traceback = tb |
|
1541 | 1541 | if etype in self.custom_exceptions: |
|
1542 | 1542 | # FIXME: Old custom traceback objects may just return a |
|
1543 | 1543 | # string, in that case we just put it into a list |
|
1544 | 1544 | stb = self.CustomTB(etype, value, tb, tb_offset) |
|
1545 | 1545 | if isinstance(ctb, basestring): |
|
1546 | 1546 | stb = [stb] |
|
1547 | 1547 | else: |
|
1548 | 1548 | if exception_only: |
|
1549 | 1549 | stb = ['An exception has occurred, use %tb to see ' |
|
1550 | 1550 | 'the full traceback.\n'] |
|
1551 | 1551 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1552 | 1552 | value)) |
|
1553 | 1553 | else: |
|
1554 | 1554 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1555 | 1555 | value, tb, tb_offset=tb_offset) |
|
1556 | 1556 | |
|
1557 | 1557 | if self.call_pdb: |
|
1558 | 1558 | # drop into debugger |
|
1559 | 1559 | self.debugger(force=True) |
|
1560 | 1560 | |
|
1561 | 1561 | # Actually show the traceback |
|
1562 | 1562 | self._showtraceback(etype, value, stb) |
|
1563 | 1563 | |
|
1564 | 1564 | except KeyboardInterrupt: |
|
1565 | 1565 | self.write_err("\nKeyboardInterrupt\n") |
|
1566 | 1566 | |
|
1567 | 1567 | def _showtraceback(self, etype, evalue, stb): |
|
1568 | 1568 | """Actually show a traceback. |
|
1569 | 1569 | |
|
1570 | 1570 | Subclasses may override this method to put the traceback on a different |
|
1571 | 1571 | place, like a side channel. |
|
1572 | 1572 | """ |
|
1573 | 1573 | print >> io.stdout, self.InteractiveTB.stb2text(stb) |
|
1574 | 1574 | |
|
1575 | 1575 | def showsyntaxerror(self, filename=None): |
|
1576 | 1576 | """Display the syntax error that just occurred. |
|
1577 | 1577 | |
|
1578 | 1578 | This doesn't display a stack trace because there isn't one. |
|
1579 | 1579 | |
|
1580 | 1580 | If a filename is given, it is stuffed in the exception instead |
|
1581 | 1581 | of what was there before (because Python's parser always uses |
|
1582 | 1582 | "<string>" when reading from a string). |
|
1583 | 1583 | """ |
|
1584 | 1584 | etype, value, last_traceback = sys.exc_info() |
|
1585 | 1585 | |
|
1586 | 1586 | # See note about these variables in showtraceback() above |
|
1587 | 1587 | sys.last_type = etype |
|
1588 | 1588 | sys.last_value = value |
|
1589 | 1589 | sys.last_traceback = last_traceback |
|
1590 | 1590 | |
|
1591 | 1591 | if filename and etype is SyntaxError: |
|
1592 | 1592 | # Work hard to stuff the correct filename in the exception |
|
1593 | 1593 | try: |
|
1594 | 1594 | msg, (dummy_filename, lineno, offset, line) = value |
|
1595 | 1595 | except: |
|
1596 | 1596 | # Not the format we expect; leave it alone |
|
1597 | 1597 | pass |
|
1598 | 1598 | else: |
|
1599 | 1599 | # Stuff in the right filename |
|
1600 | 1600 | try: |
|
1601 | 1601 | # Assume SyntaxError is a class exception |
|
1602 | 1602 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1603 | 1603 | except: |
|
1604 | 1604 | # If that failed, assume SyntaxError is a string |
|
1605 | 1605 | value = msg, (filename, lineno, offset, line) |
|
1606 | 1606 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1607 | 1607 | self._showtraceback(etype, value, stb) |
|
1608 | 1608 | |
|
1609 | 1609 | #------------------------------------------------------------------------- |
|
1610 | 1610 | # Things related to readline |
|
1611 | 1611 | #------------------------------------------------------------------------- |
|
1612 | 1612 | |
|
1613 | 1613 | def init_readline(self): |
|
1614 | 1614 | """Command history completion/saving/reloading.""" |
|
1615 | 1615 | |
|
1616 | 1616 | if self.readline_use: |
|
1617 | 1617 | import IPython.utils.rlineimpl as readline |
|
1618 | 1618 | |
|
1619 | 1619 | self.rl_next_input = None |
|
1620 | 1620 | self.rl_do_indent = False |
|
1621 | 1621 | |
|
1622 | 1622 | if not self.readline_use or not readline.have_readline: |
|
1623 | 1623 | self.has_readline = False |
|
1624 | 1624 | self.readline = None |
|
1625 | 1625 | # Set a number of methods that depend on readline to be no-op |
|
1626 | 1626 | self.set_readline_completer = no_op |
|
1627 | 1627 | self.set_custom_completer = no_op |
|
1628 | 1628 | self.set_completer_frame = no_op |
|
1629 | 1629 | warn('Readline services not available or not loaded.') |
|
1630 | 1630 | else: |
|
1631 | 1631 | self.has_readline = True |
|
1632 | 1632 | self.readline = readline |
|
1633 | 1633 | sys.modules['readline'] = readline |
|
1634 | 1634 | |
|
1635 | 1635 | # Platform-specific configuration |
|
1636 | 1636 | if os.name == 'nt': |
|
1637 | 1637 | # FIXME - check with Frederick to see if we can harmonize |
|
1638 | 1638 | # naming conventions with pyreadline to avoid this |
|
1639 | 1639 | # platform-dependent check |
|
1640 | 1640 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1641 | 1641 | else: |
|
1642 | 1642 | self.readline_startup_hook = readline.set_startup_hook |
|
1643 | 1643 | |
|
1644 | 1644 | # Load user's initrc file (readline config) |
|
1645 | 1645 | # Or if libedit is used, load editrc. |
|
1646 | 1646 | inputrc_name = os.environ.get('INPUTRC') |
|
1647 | 1647 | if inputrc_name is None: |
|
1648 | 1648 | home_dir = get_home_dir() |
|
1649 | 1649 | if home_dir is not None: |
|
1650 | 1650 | inputrc_name = '.inputrc' |
|
1651 | 1651 | if readline.uses_libedit: |
|
1652 | 1652 | inputrc_name = '.editrc' |
|
1653 | 1653 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1654 | 1654 | if os.path.isfile(inputrc_name): |
|
1655 | 1655 | try: |
|
1656 | 1656 | readline.read_init_file(inputrc_name) |
|
1657 | 1657 | except: |
|
1658 | 1658 | warn('Problems reading readline initialization file <%s>' |
|
1659 | 1659 | % inputrc_name) |
|
1660 | 1660 | |
|
1661 | 1661 | # Configure readline according to user's prefs |
|
1662 | 1662 | # This is only done if GNU readline is being used. If libedit |
|
1663 | 1663 | # is being used (as on Leopard) the readline config is |
|
1664 | 1664 | # not run as the syntax for libedit is different. |
|
1665 | 1665 | if not readline.uses_libedit: |
|
1666 | 1666 | for rlcommand in self.readline_parse_and_bind: |
|
1667 | 1667 | #print "loading rl:",rlcommand # dbg |
|
1668 | 1668 | readline.parse_and_bind(rlcommand) |
|
1669 | 1669 | |
|
1670 | 1670 | # Remove some chars from the delimiters list. If we encounter |
|
1671 | 1671 | # unicode chars, discard them. |
|
1672 | 1672 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1673 |
|
|
|
1673 | for d in self.readline_remove_delims: | |
|
1674 | delims = delims.replace(d, "") | |
|
1674 | 1675 | delims = delims.replace(ESC_MAGIC, '') |
|
1675 | 1676 | readline.set_completer_delims(delims) |
|
1676 | 1677 | # otherwise we end up with a monster history after a while: |
|
1677 | 1678 | readline.set_history_length(self.history_length) |
|
1678 | 1679 | |
|
1679 | 1680 | self.refill_readline_hist() |
|
1680 | 1681 | self.readline_no_record = ReadlineNoRecord(self) |
|
1681 | 1682 | |
|
1682 | 1683 | # Configure auto-indent for all platforms |
|
1683 | 1684 | self.set_autoindent(self.autoindent) |
|
1684 | 1685 | |
|
1685 | 1686 | def refill_readline_hist(self): |
|
1686 | 1687 | # Load the last 1000 lines from history |
|
1687 | 1688 | self.readline.clear_history() |
|
1688 | 1689 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1689 | 1690 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1690 | 1691 | include_latest=True): |
|
1691 | 1692 | if cell.strip(): # Ignore blank lines |
|
1692 | 1693 | for line in cell.splitlines(): |
|
1693 | 1694 | self.readline.add_history(line.encode(stdin_encoding, 'replace')) |
|
1694 | 1695 | |
|
1695 | 1696 | def set_next_input(self, s): |
|
1696 | 1697 | """ Sets the 'default' input string for the next command line. |
|
1697 | 1698 | |
|
1698 | 1699 | Requires readline. |
|
1699 | 1700 | |
|
1700 | 1701 | Example: |
|
1701 | 1702 | |
|
1702 | 1703 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1703 | 1704 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1704 | 1705 | """ |
|
1705 | 1706 | |
|
1706 | 1707 | self.rl_next_input = s |
|
1707 | 1708 | |
|
1708 | 1709 | # Maybe move this to the terminal subclass? |
|
1709 | 1710 | def pre_readline(self): |
|
1710 | 1711 | """readline hook to be used at the start of each line. |
|
1711 | 1712 | |
|
1712 | 1713 | Currently it handles auto-indent only.""" |
|
1713 | 1714 | |
|
1714 | 1715 | if self.rl_do_indent: |
|
1715 | 1716 | self.readline.insert_text(self._indent_current_str()) |
|
1716 | 1717 | if self.rl_next_input is not None: |
|
1717 | 1718 | self.readline.insert_text(self.rl_next_input) |
|
1718 | 1719 | self.rl_next_input = None |
|
1719 | 1720 | |
|
1720 | 1721 | def _indent_current_str(self): |
|
1721 | 1722 | """return the current level of indentation as a string""" |
|
1722 | 1723 | return self.input_splitter.indent_spaces * ' ' |
|
1723 | 1724 | |
|
1724 | 1725 | #------------------------------------------------------------------------- |
|
1725 | 1726 | # Things related to text completion |
|
1726 | 1727 | #------------------------------------------------------------------------- |
|
1727 | 1728 | |
|
1728 | 1729 | def init_completer(self): |
|
1729 | 1730 | """Initialize the completion machinery. |
|
1730 | 1731 | |
|
1731 | 1732 | This creates completion machinery that can be used by client code, |
|
1732 | 1733 | either interactively in-process (typically triggered by the readline |
|
1733 | 1734 | library), programatically (such as in test suites) or out-of-prcess |
|
1734 | 1735 | (typically over the network by remote frontends). |
|
1735 | 1736 | """ |
|
1736 | 1737 | from IPython.core.completer import IPCompleter |
|
1737 | 1738 | from IPython.core.completerlib import (module_completer, |
|
1738 | 1739 | magic_run_completer, cd_completer) |
|
1739 | 1740 | |
|
1740 | 1741 | self.Completer = IPCompleter(self, |
|
1741 | 1742 | self.user_ns, |
|
1742 | 1743 | self.user_global_ns, |
|
1743 | 1744 | self.readline_omit__names, |
|
1744 | 1745 | self.alias_manager.alias_table, |
|
1745 | 1746 | self.has_readline) |
|
1746 | 1747 | |
|
1747 | 1748 | # Add custom completers to the basic ones built into IPCompleter |
|
1748 | 1749 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1749 | 1750 | self.strdispatchers['complete_command'] = sdisp |
|
1750 | 1751 | self.Completer.custom_completers = sdisp |
|
1751 | 1752 | |
|
1752 | 1753 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1753 | 1754 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1754 | 1755 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1755 | 1756 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1756 | 1757 | |
|
1757 | 1758 | # Only configure readline if we truly are using readline. IPython can |
|
1758 | 1759 | # do tab-completion over the network, in GUIs, etc, where readline |
|
1759 | 1760 | # itself may be absent |
|
1760 | 1761 | if self.has_readline: |
|
1761 | 1762 | self.set_readline_completer() |
|
1762 | 1763 | |
|
1763 | 1764 | def complete(self, text, line=None, cursor_pos=None): |
|
1764 | 1765 | """Return the completed text and a list of completions. |
|
1765 | 1766 | |
|
1766 | 1767 | Parameters |
|
1767 | 1768 | ---------- |
|
1768 | 1769 | |
|
1769 | 1770 | text : string |
|
1770 | 1771 | A string of text to be completed on. It can be given as empty and |
|
1771 | 1772 | instead a line/position pair are given. In this case, the |
|
1772 | 1773 | completer itself will split the line like readline does. |
|
1773 | 1774 | |
|
1774 | 1775 | line : string, optional |
|
1775 | 1776 | The complete line that text is part of. |
|
1776 | 1777 | |
|
1777 | 1778 | cursor_pos : int, optional |
|
1778 | 1779 | The position of the cursor on the input line. |
|
1779 | 1780 | |
|
1780 | 1781 | Returns |
|
1781 | 1782 | ------- |
|
1782 | 1783 | text : string |
|
1783 | 1784 | The actual text that was completed. |
|
1784 | 1785 | |
|
1785 | 1786 | matches : list |
|
1786 | 1787 | A sorted list with all possible completions. |
|
1787 | 1788 | |
|
1788 | 1789 | The optional arguments allow the completion to take more context into |
|
1789 | 1790 | account, and are part of the low-level completion API. |
|
1790 | 1791 | |
|
1791 | 1792 | This is a wrapper around the completion mechanism, similar to what |
|
1792 | 1793 | readline does at the command line when the TAB key is hit. By |
|
1793 | 1794 | exposing it as a method, it can be used by other non-readline |
|
1794 | 1795 | environments (such as GUIs) for text completion. |
|
1795 | 1796 | |
|
1796 | 1797 | Simple usage example: |
|
1797 | 1798 | |
|
1798 | 1799 | In [1]: x = 'hello' |
|
1799 | 1800 | |
|
1800 | 1801 | In [2]: _ip.complete('x.l') |
|
1801 | 1802 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1802 | 1803 | """ |
|
1803 | 1804 | |
|
1804 | 1805 | # Inject names into __builtin__ so we can complete on the added names. |
|
1805 | 1806 | with self.builtin_trap: |
|
1806 | 1807 | return self.Completer.complete(text, line, cursor_pos) |
|
1807 | 1808 | |
|
1808 | 1809 | def set_custom_completer(self, completer, pos=0): |
|
1809 | 1810 | """Adds a new custom completer function. |
|
1810 | 1811 | |
|
1811 | 1812 | The position argument (defaults to 0) is the index in the completers |
|
1812 | 1813 | list where you want the completer to be inserted.""" |
|
1813 | 1814 | |
|
1814 | 1815 | newcomp = types.MethodType(completer,self.Completer) |
|
1815 | 1816 | self.Completer.matchers.insert(pos,newcomp) |
|
1816 | 1817 | |
|
1817 | 1818 | def set_readline_completer(self): |
|
1818 | 1819 | """Reset readline's completer to be our own.""" |
|
1819 | 1820 | self.readline.set_completer(self.Completer.rlcomplete) |
|
1820 | 1821 | |
|
1821 | 1822 | def set_completer_frame(self, frame=None): |
|
1822 | 1823 | """Set the frame of the completer.""" |
|
1823 | 1824 | if frame: |
|
1824 | 1825 | self.Completer.namespace = frame.f_locals |
|
1825 | 1826 | self.Completer.global_namespace = frame.f_globals |
|
1826 | 1827 | else: |
|
1827 | 1828 | self.Completer.namespace = self.user_ns |
|
1828 | 1829 | self.Completer.global_namespace = self.user_global_ns |
|
1829 | 1830 | |
|
1830 | 1831 | #------------------------------------------------------------------------- |
|
1831 | 1832 | # Things related to magics |
|
1832 | 1833 | #------------------------------------------------------------------------- |
|
1833 | 1834 | |
|
1834 | 1835 | def init_magics(self): |
|
1835 | 1836 | # FIXME: Move the color initialization to the DisplayHook, which |
|
1836 | 1837 | # should be split into a prompt manager and displayhook. We probably |
|
1837 | 1838 | # even need a centralize colors management object. |
|
1838 | 1839 | self.magic_colors(self.colors) |
|
1839 | 1840 | # History was moved to a separate module |
|
1840 | 1841 | from . import history |
|
1841 | 1842 | history.init_ipython(self) |
|
1842 | 1843 | |
|
1843 | 1844 | def magic(self,arg_s): |
|
1844 | 1845 | """Call a magic function by name. |
|
1845 | 1846 | |
|
1846 | 1847 | Input: a string containing the name of the magic function to call and |
|
1847 | 1848 | any additional arguments to be passed to the magic. |
|
1848 | 1849 | |
|
1849 | 1850 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1850 | 1851 | prompt: |
|
1851 | 1852 | |
|
1852 | 1853 | In[1]: %name -opt foo bar |
|
1853 | 1854 | |
|
1854 | 1855 | To call a magic without arguments, simply use magic('name'). |
|
1855 | 1856 | |
|
1856 | 1857 | This provides a proper Python function to call IPython's magics in any |
|
1857 | 1858 | valid Python code you can type at the interpreter, including loops and |
|
1858 | 1859 | compound statements. |
|
1859 | 1860 | """ |
|
1860 | 1861 | args = arg_s.split(' ',1) |
|
1861 | 1862 | magic_name = args[0] |
|
1862 | 1863 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1863 | 1864 | |
|
1864 | 1865 | try: |
|
1865 | 1866 | magic_args = args[1] |
|
1866 | 1867 | except IndexError: |
|
1867 | 1868 | magic_args = '' |
|
1868 | 1869 | fn = getattr(self,'magic_'+magic_name,None) |
|
1869 | 1870 | if fn is None: |
|
1870 | 1871 | error("Magic function `%s` not found." % magic_name) |
|
1871 | 1872 | else: |
|
1872 | 1873 | magic_args = self.var_expand(magic_args,1) |
|
1873 | 1874 | # Grab local namespace if we need it: |
|
1874 | 1875 | if getattr(fn, "needs_local_scope", False): |
|
1875 | 1876 | self._magic_locals = sys._getframe(1).f_locals |
|
1876 | 1877 | with self.builtin_trap: |
|
1877 | 1878 | result = fn(magic_args) |
|
1878 | 1879 | # Ensure we're not keeping object references around: |
|
1879 | 1880 | self._magic_locals = {} |
|
1880 | 1881 | return result |
|
1881 | 1882 | |
|
1882 | 1883 | def define_magic(self, magicname, func): |
|
1883 | 1884 | """Expose own function as magic function for ipython |
|
1884 | 1885 | |
|
1885 | 1886 | def foo_impl(self,parameter_s=''): |
|
1886 | 1887 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
1887 | 1888 | print 'Magic function. Passed parameter is between < >:' |
|
1888 | 1889 | print '<%s>' % parameter_s |
|
1889 | 1890 | print 'The self object is:',self |
|
1890 | 1891 | |
|
1891 | 1892 | self.define_magic('foo',foo_impl) |
|
1892 | 1893 | """ |
|
1893 | 1894 | |
|
1894 | 1895 | import new |
|
1895 | 1896 | im = types.MethodType(func,self) |
|
1896 | 1897 | old = getattr(self, "magic_" + magicname, None) |
|
1897 | 1898 | setattr(self, "magic_" + magicname, im) |
|
1898 | 1899 | return old |
|
1899 | 1900 | |
|
1900 | 1901 | #------------------------------------------------------------------------- |
|
1901 | 1902 | # Things related to macros |
|
1902 | 1903 | #------------------------------------------------------------------------- |
|
1903 | 1904 | |
|
1904 | 1905 | def define_macro(self, name, themacro): |
|
1905 | 1906 | """Define a new macro |
|
1906 | 1907 | |
|
1907 | 1908 | Parameters |
|
1908 | 1909 | ---------- |
|
1909 | 1910 | name : str |
|
1910 | 1911 | The name of the macro. |
|
1911 | 1912 | themacro : str or Macro |
|
1912 | 1913 | The action to do upon invoking the macro. If a string, a new |
|
1913 | 1914 | Macro object is created by passing the string to it. |
|
1914 | 1915 | """ |
|
1915 | 1916 | |
|
1916 | 1917 | from IPython.core import macro |
|
1917 | 1918 | |
|
1918 | 1919 | if isinstance(themacro, basestring): |
|
1919 | 1920 | themacro = macro.Macro(themacro) |
|
1920 | 1921 | if not isinstance(themacro, macro.Macro): |
|
1921 | 1922 | raise ValueError('A macro must be a string or a Macro instance.') |
|
1922 | 1923 | self.user_ns[name] = themacro |
|
1923 | 1924 | |
|
1924 | 1925 | #------------------------------------------------------------------------- |
|
1925 | 1926 | # Things related to the running of system commands |
|
1926 | 1927 | #------------------------------------------------------------------------- |
|
1927 | 1928 | |
|
1928 | 1929 | def system_piped(self, cmd): |
|
1929 | 1930 | """Call the given cmd in a subprocess, piping stdout/err |
|
1930 | 1931 | |
|
1931 | 1932 | Parameters |
|
1932 | 1933 | ---------- |
|
1933 | 1934 | cmd : str |
|
1934 | 1935 | Command to execute (can not end in '&', as background processes are |
|
1935 | 1936 | not supported. Should not be a command that expects input |
|
1936 | 1937 | other than simple text. |
|
1937 | 1938 | """ |
|
1938 | 1939 | if cmd.rstrip().endswith('&'): |
|
1939 | 1940 | # this is *far* from a rigorous test |
|
1940 | 1941 | # We do not support backgrounding processes because we either use |
|
1941 | 1942 | # pexpect or pipes to read from. Users can always just call |
|
1942 | 1943 | # os.system() or use ip.system=ip.system_raw |
|
1943 | 1944 | # if they really want a background process. |
|
1944 | 1945 | raise OSError("Background processes not supported.") |
|
1945 | 1946 | |
|
1946 | 1947 | # we explicitly do NOT return the subprocess status code, because |
|
1947 | 1948 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
1948 | 1949 | # Instead, we store the exit_code in user_ns. |
|
1949 | 1950 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2)) |
|
1950 | 1951 | |
|
1951 | 1952 | def system_raw(self, cmd): |
|
1952 | 1953 | """Call the given cmd in a subprocess using os.system |
|
1953 | 1954 | |
|
1954 | 1955 | Parameters |
|
1955 | 1956 | ---------- |
|
1956 | 1957 | cmd : str |
|
1957 | 1958 | Command to execute. |
|
1958 | 1959 | """ |
|
1959 | 1960 | # We explicitly do NOT return the subprocess status code, because |
|
1960 | 1961 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
1961 | 1962 | # Instead, we store the exit_code in user_ns. |
|
1962 | 1963 | self.user_ns['_exit_code'] = os.system(self.var_expand(cmd, depth=2)) |
|
1963 | 1964 | |
|
1964 | 1965 | # use piped system by default, because it is better behaved |
|
1965 | 1966 | system = system_piped |
|
1966 | 1967 | |
|
1967 | 1968 | def getoutput(self, cmd, split=True): |
|
1968 | 1969 | """Get output (possibly including stderr) from a subprocess. |
|
1969 | 1970 | |
|
1970 | 1971 | Parameters |
|
1971 | 1972 | ---------- |
|
1972 | 1973 | cmd : str |
|
1973 | 1974 | Command to execute (can not end in '&', as background processes are |
|
1974 | 1975 | not supported. |
|
1975 | 1976 | split : bool, optional |
|
1976 | 1977 | |
|
1977 | 1978 | If True, split the output into an IPython SList. Otherwise, an |
|
1978 | 1979 | IPython LSString is returned. These are objects similar to normal |
|
1979 | 1980 | lists and strings, with a few convenience attributes for easier |
|
1980 | 1981 | manipulation of line-based output. You can use '?' on them for |
|
1981 | 1982 | details. |
|
1982 | 1983 | """ |
|
1983 | 1984 | if cmd.rstrip().endswith('&'): |
|
1984 | 1985 | # this is *far* from a rigorous test |
|
1985 | 1986 | raise OSError("Background processes not supported.") |
|
1986 | 1987 | out = getoutput(self.var_expand(cmd, depth=2)) |
|
1987 | 1988 | if split: |
|
1988 | 1989 | out = SList(out.splitlines()) |
|
1989 | 1990 | else: |
|
1990 | 1991 | out = LSString(out) |
|
1991 | 1992 | return out |
|
1992 | 1993 | |
|
1993 | 1994 | #------------------------------------------------------------------------- |
|
1994 | 1995 | # Things related to aliases |
|
1995 | 1996 | #------------------------------------------------------------------------- |
|
1996 | 1997 | |
|
1997 | 1998 | def init_alias(self): |
|
1998 | 1999 | self.alias_manager = AliasManager(shell=self, config=self.config) |
|
1999 | 2000 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
2000 | 2001 | |
|
2001 | 2002 | #------------------------------------------------------------------------- |
|
2002 | 2003 | # Things related to extensions and plugins |
|
2003 | 2004 | #------------------------------------------------------------------------- |
|
2004 | 2005 | |
|
2005 | 2006 | def init_extension_manager(self): |
|
2006 | 2007 | self.extension_manager = ExtensionManager(shell=self, config=self.config) |
|
2007 | 2008 | |
|
2008 | 2009 | def init_plugin_manager(self): |
|
2009 | 2010 | self.plugin_manager = PluginManager(config=self.config) |
|
2010 | 2011 | |
|
2011 | 2012 | #------------------------------------------------------------------------- |
|
2012 | 2013 | # Things related to payloads |
|
2013 | 2014 | #------------------------------------------------------------------------- |
|
2014 | 2015 | |
|
2015 | 2016 | def init_payload(self): |
|
2016 | 2017 | self.payload_manager = PayloadManager(config=self.config) |
|
2017 | 2018 | |
|
2018 | 2019 | #------------------------------------------------------------------------- |
|
2019 | 2020 | # Things related to the prefilter |
|
2020 | 2021 | #------------------------------------------------------------------------- |
|
2021 | 2022 | |
|
2022 | 2023 | def init_prefilter(self): |
|
2023 | 2024 | self.prefilter_manager = PrefilterManager(shell=self, config=self.config) |
|
2024 | 2025 | # Ultimately this will be refactored in the new interpreter code, but |
|
2025 | 2026 | # for now, we should expose the main prefilter method (there's legacy |
|
2026 | 2027 | # code out there that may rely on this). |
|
2027 | 2028 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2028 | 2029 | |
|
2029 | 2030 | def auto_rewrite_input(self, cmd): |
|
2030 | 2031 | """Print to the screen the rewritten form of the user's command. |
|
2031 | 2032 | |
|
2032 | 2033 | This shows visual feedback by rewriting input lines that cause |
|
2033 | 2034 | automatic calling to kick in, like:: |
|
2034 | 2035 | |
|
2035 | 2036 | /f x |
|
2036 | 2037 | |
|
2037 | 2038 | into:: |
|
2038 | 2039 | |
|
2039 | 2040 | ------> f(x) |
|
2040 | 2041 | |
|
2041 | 2042 | after the user's input prompt. This helps the user understand that the |
|
2042 | 2043 | input line was transformed automatically by IPython. |
|
2043 | 2044 | """ |
|
2044 | 2045 | rw = self.displayhook.prompt1.auto_rewrite() + cmd |
|
2045 | 2046 | |
|
2046 | 2047 | try: |
|
2047 | 2048 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2048 | 2049 | # we use it and only print uncolored rewrite if we have unicode |
|
2049 | 2050 | rw = str(rw) |
|
2050 | 2051 | print >> io.stdout, rw |
|
2051 | 2052 | except UnicodeEncodeError: |
|
2052 | 2053 | print "------> " + cmd |
|
2053 | 2054 | |
|
2054 | 2055 | #------------------------------------------------------------------------- |
|
2055 | 2056 | # Things related to extracting values/expressions from kernel and user_ns |
|
2056 | 2057 | #------------------------------------------------------------------------- |
|
2057 | 2058 | |
|
2058 | 2059 | def _simple_error(self): |
|
2059 | 2060 | etype, value = sys.exc_info()[:2] |
|
2060 | 2061 | return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value) |
|
2061 | 2062 | |
|
2062 | 2063 | def user_variables(self, names): |
|
2063 | 2064 | """Get a list of variable names from the user's namespace. |
|
2064 | 2065 | |
|
2065 | 2066 | Parameters |
|
2066 | 2067 | ---------- |
|
2067 | 2068 | names : list of strings |
|
2068 | 2069 | A list of names of variables to be read from the user namespace. |
|
2069 | 2070 | |
|
2070 | 2071 | Returns |
|
2071 | 2072 | ------- |
|
2072 | 2073 | A dict, keyed by the input names and with the repr() of each value. |
|
2073 | 2074 | """ |
|
2074 | 2075 | out = {} |
|
2075 | 2076 | user_ns = self.user_ns |
|
2076 | 2077 | for varname in names: |
|
2077 | 2078 | try: |
|
2078 | 2079 | value = repr(user_ns[varname]) |
|
2079 | 2080 | except: |
|
2080 | 2081 | value = self._simple_error() |
|
2081 | 2082 | out[varname] = value |
|
2082 | 2083 | return out |
|
2083 | 2084 | |
|
2084 | 2085 | def user_expressions(self, expressions): |
|
2085 | 2086 | """Evaluate a dict of expressions in the user's namespace. |
|
2086 | 2087 | |
|
2087 | 2088 | Parameters |
|
2088 | 2089 | ---------- |
|
2089 | 2090 | expressions : dict |
|
2090 | 2091 | A dict with string keys and string values. The expression values |
|
2091 | 2092 | should be valid Python expressions, each of which will be evaluated |
|
2092 | 2093 | in the user namespace. |
|
2093 | 2094 | |
|
2094 | 2095 | Returns |
|
2095 | 2096 | ------- |
|
2096 | 2097 | A dict, keyed like the input expressions dict, with the repr() of each |
|
2097 | 2098 | value. |
|
2098 | 2099 | """ |
|
2099 | 2100 | out = {} |
|
2100 | 2101 | user_ns = self.user_ns |
|
2101 | 2102 | global_ns = self.user_global_ns |
|
2102 | 2103 | for key, expr in expressions.iteritems(): |
|
2103 | 2104 | try: |
|
2104 | 2105 | value = repr(eval(expr, global_ns, user_ns)) |
|
2105 | 2106 | except: |
|
2106 | 2107 | value = self._simple_error() |
|
2107 | 2108 | out[key] = value |
|
2108 | 2109 | return out |
|
2109 | 2110 | |
|
2110 | 2111 | #------------------------------------------------------------------------- |
|
2111 | 2112 | # Things related to the running of code |
|
2112 | 2113 | #------------------------------------------------------------------------- |
|
2113 | 2114 | |
|
2114 | 2115 | def ex(self, cmd): |
|
2115 | 2116 | """Execute a normal python statement in user namespace.""" |
|
2116 | 2117 | with self.builtin_trap: |
|
2117 | 2118 | exec cmd in self.user_global_ns, self.user_ns |
|
2118 | 2119 | |
|
2119 | 2120 | def ev(self, expr): |
|
2120 | 2121 | """Evaluate python expression expr in user namespace. |
|
2121 | 2122 | |
|
2122 | 2123 | Returns the result of evaluation |
|
2123 | 2124 | """ |
|
2124 | 2125 | with self.builtin_trap: |
|
2125 | 2126 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2126 | 2127 | |
|
2127 | 2128 | def safe_execfile(self, fname, *where, **kw): |
|
2128 | 2129 | """A safe version of the builtin execfile(). |
|
2129 | 2130 | |
|
2130 | 2131 | This version will never throw an exception, but instead print |
|
2131 | 2132 | helpful error messages to the screen. This only works on pure |
|
2132 | 2133 | Python files with the .py extension. |
|
2133 | 2134 | |
|
2134 | 2135 | Parameters |
|
2135 | 2136 | ---------- |
|
2136 | 2137 | fname : string |
|
2137 | 2138 | The name of the file to be executed. |
|
2138 | 2139 | where : tuple |
|
2139 | 2140 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2140 | 2141 | If only one is given, it is passed as both. |
|
2141 | 2142 | exit_ignore : bool (False) |
|
2142 | 2143 | If True, then silence SystemExit for non-zero status (it is always |
|
2143 | 2144 | silenced for zero status, as it is so common). |
|
2144 | 2145 | """ |
|
2145 | 2146 | kw.setdefault('exit_ignore', False) |
|
2146 | 2147 | |
|
2147 | 2148 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2148 | 2149 | # Make sure we have a .py file |
|
2149 | 2150 | if not fname.endswith('.py'): |
|
2150 | 2151 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2151 | 2152 | |
|
2152 | 2153 | # Make sure we can open the file |
|
2153 | 2154 | try: |
|
2154 | 2155 | with open(fname) as thefile: |
|
2155 | 2156 | pass |
|
2156 | 2157 | except: |
|
2157 | 2158 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2158 | 2159 | return |
|
2159 | 2160 | |
|
2160 | 2161 | # Find things also in current directory. This is needed to mimic the |
|
2161 | 2162 | # behavior of running a script from the system command line, where |
|
2162 | 2163 | # Python inserts the script's directory into sys.path |
|
2163 | 2164 | dname = os.path.dirname(fname) |
|
2164 | 2165 | |
|
2165 | 2166 | if isinstance(fname, unicode): |
|
2166 | 2167 | # execfile uses default encoding instead of filesystem encoding |
|
2167 | 2168 | # so unicode filenames will fail |
|
2168 | 2169 | fname = fname.encode(sys.getfilesystemencoding() or sys.getdefaultencoding()) |
|
2169 | 2170 | |
|
2170 | 2171 | with prepended_to_syspath(dname): |
|
2171 | 2172 | try: |
|
2172 | 2173 | execfile(fname,*where) |
|
2173 | 2174 | except SystemExit, status: |
|
2174 | 2175 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2175 | 2176 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2176 | 2177 | # these are considered normal by the OS: |
|
2177 | 2178 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2178 | 2179 | # 0 |
|
2179 | 2180 | # > python -c'import sys;sys.exit()'; echo $? |
|
2180 | 2181 | # 0 |
|
2181 | 2182 | # For other exit status, we show the exception unless |
|
2182 | 2183 | # explicitly silenced, but only in short form. |
|
2183 | 2184 | if status.code not in (0, None) and not kw['exit_ignore']: |
|
2184 | 2185 | self.showtraceback(exception_only=True) |
|
2185 | 2186 | except: |
|
2186 | 2187 | self.showtraceback() |
|
2187 | 2188 | |
|
2188 | 2189 | def safe_execfile_ipy(self, fname): |
|
2189 | 2190 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
2190 | 2191 | |
|
2191 | 2192 | Parameters |
|
2192 | 2193 | ---------- |
|
2193 | 2194 | fname : str |
|
2194 | 2195 | The name of the file to execute. The filename must have a |
|
2195 | 2196 | .ipy extension. |
|
2196 | 2197 | """ |
|
2197 | 2198 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2198 | 2199 | |
|
2199 | 2200 | # Make sure we have a .py file |
|
2200 | 2201 | if not fname.endswith('.ipy'): |
|
2201 | 2202 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
2202 | 2203 | |
|
2203 | 2204 | # Make sure we can open the file |
|
2204 | 2205 | try: |
|
2205 | 2206 | with open(fname) as thefile: |
|
2206 | 2207 | pass |
|
2207 | 2208 | except: |
|
2208 | 2209 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2209 | 2210 | return |
|
2210 | 2211 | |
|
2211 | 2212 | # Find things also in current directory. This is needed to mimic the |
|
2212 | 2213 | # behavior of running a script from the system command line, where |
|
2213 | 2214 | # Python inserts the script's directory into sys.path |
|
2214 | 2215 | dname = os.path.dirname(fname) |
|
2215 | 2216 | |
|
2216 | 2217 | with prepended_to_syspath(dname): |
|
2217 | 2218 | try: |
|
2218 | 2219 | with open(fname) as thefile: |
|
2219 | 2220 | # self.run_cell currently captures all exceptions |
|
2220 | 2221 | # raised in user code. It would be nice if there were |
|
2221 | 2222 | # versions of runlines, execfile that did raise, so |
|
2222 | 2223 | # we could catch the errors. |
|
2223 | 2224 | self.run_cell(thefile.read(), store_history=False) |
|
2224 | 2225 | except: |
|
2225 | 2226 | self.showtraceback() |
|
2226 | 2227 | warn('Unknown failure executing file: <%s>' % fname) |
|
2227 | 2228 | |
|
2228 | 2229 | def run_cell(self, raw_cell, store_history=True): |
|
2229 | 2230 | """Run a complete IPython cell. |
|
2230 | 2231 | |
|
2231 | 2232 | Parameters |
|
2232 | 2233 | ---------- |
|
2233 | 2234 | raw_cell : str |
|
2234 | 2235 | The code (including IPython code such as %magic functions) to run. |
|
2235 | 2236 | store_history : bool |
|
2236 | 2237 | If True, the raw and translated cell will be stored in IPython's |
|
2237 | 2238 | history. For user code calling back into IPython's machinery, this |
|
2238 | 2239 | should be set to False. |
|
2239 | 2240 | """ |
|
2240 | 2241 | if (not raw_cell) or raw_cell.isspace(): |
|
2241 | 2242 | return |
|
2242 | 2243 | |
|
2243 | 2244 | for line in raw_cell.splitlines(): |
|
2244 | 2245 | self.input_splitter.push(line) |
|
2245 | 2246 | cell = self.input_splitter.source_reset() |
|
2246 | 2247 | |
|
2247 | 2248 | with self.builtin_trap: |
|
2248 | 2249 | prefilter_failed = False |
|
2249 | 2250 | if len(cell.splitlines()) == 1: |
|
2250 | 2251 | try: |
|
2251 | 2252 | # use prefilter_lines to handle trailing newlines |
|
2252 | 2253 | # restore trailing newline for ast.parse |
|
2253 | 2254 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2254 | 2255 | except AliasError as e: |
|
2255 | 2256 | error(e) |
|
2256 | 2257 | prefilter_failed=True |
|
2257 | 2258 | except Exception: |
|
2258 | 2259 | # don't allow prefilter errors to crash IPython |
|
2259 | 2260 | self.showtraceback() |
|
2260 | 2261 | prefilter_failed = True |
|
2261 | 2262 | |
|
2262 | 2263 | # Store raw and processed history |
|
2263 | 2264 | if store_history: |
|
2264 | 2265 | self.history_manager.store_inputs(self.execution_count, |
|
2265 | 2266 | cell, raw_cell) |
|
2266 | 2267 | |
|
2267 | 2268 | self.logger.log(cell, raw_cell) |
|
2268 | 2269 | |
|
2269 | 2270 | if not prefilter_failed: |
|
2270 | 2271 | # don't run if prefilter failed |
|
2271 | 2272 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2272 | 2273 | |
|
2273 | 2274 | with self.display_trap: |
|
2274 | 2275 | try: |
|
2275 | 2276 | code_ast = ast.parse(cell, filename=cell_name) |
|
2276 | 2277 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2277 | 2278 | MemoryError): |
|
2278 | 2279 | self.showsyntaxerror() |
|
2279 | 2280 | self.execution_count += 1 |
|
2280 | 2281 | return None |
|
2281 | 2282 | |
|
2282 | 2283 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2283 | 2284 | interactivity="last_expr") |
|
2284 | 2285 | |
|
2285 | 2286 | # Execute any registered post-execution functions. |
|
2286 | 2287 | for func, status in self._post_execute.iteritems(): |
|
2287 | 2288 | if not status: |
|
2288 | 2289 | continue |
|
2289 | 2290 | try: |
|
2290 | 2291 | func() |
|
2291 | 2292 | except: |
|
2292 | 2293 | self.showtraceback() |
|
2293 | 2294 | # Deactivate failing function |
|
2294 | 2295 | self._post_execute[func] = False |
|
2295 | 2296 | |
|
2296 | 2297 | if store_history: |
|
2297 | 2298 | # Write output to the database. Does nothing unless |
|
2298 | 2299 | # history output logging is enabled. |
|
2299 | 2300 | self.history_manager.store_output(self.execution_count) |
|
2300 | 2301 | # Each cell is a *single* input, regardless of how many lines it has |
|
2301 | 2302 | self.execution_count += 1 |
|
2302 | 2303 | |
|
2303 | 2304 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'): |
|
2304 | 2305 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2305 | 2306 | interactivity parameter. |
|
2306 | 2307 | |
|
2307 | 2308 | Parameters |
|
2308 | 2309 | ---------- |
|
2309 | 2310 | nodelist : list |
|
2310 | 2311 | A sequence of AST nodes to run. |
|
2311 | 2312 | cell_name : str |
|
2312 | 2313 | Will be passed to the compiler as the filename of the cell. Typically |
|
2313 | 2314 | the value returned by ip.compile.cache(cell). |
|
2314 | 2315 | interactivity : str |
|
2315 | 2316 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2316 | 2317 | run interactively (displaying output from expressions). 'last_expr' |
|
2317 | 2318 | will run the last node interactively only if it is an expression (i.e. |
|
2318 | 2319 | expressions in loops or other blocks are not displayed. Other values |
|
2319 | 2320 | for this parameter will raise a ValueError. |
|
2320 | 2321 | """ |
|
2321 | 2322 | if not nodelist: |
|
2322 | 2323 | return |
|
2323 | 2324 | |
|
2324 | 2325 | if interactivity == 'last_expr': |
|
2325 | 2326 | if isinstance(nodelist[-1], ast.Expr): |
|
2326 | 2327 | interactivity = "last" |
|
2327 | 2328 | else: |
|
2328 | 2329 | interactivity = "none" |
|
2329 | 2330 | |
|
2330 | 2331 | if interactivity == 'none': |
|
2331 | 2332 | to_run_exec, to_run_interactive = nodelist, [] |
|
2332 | 2333 | elif interactivity == 'last': |
|
2333 | 2334 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2334 | 2335 | elif interactivity == 'all': |
|
2335 | 2336 | to_run_exec, to_run_interactive = [], nodelist |
|
2336 | 2337 | else: |
|
2337 | 2338 | raise ValueError("Interactivity was %r" % interactivity) |
|
2338 | 2339 | |
|
2339 | 2340 | exec_count = self.execution_count |
|
2340 | 2341 | |
|
2341 | 2342 | for i, node in enumerate(to_run_exec): |
|
2342 | 2343 | mod = ast.Module([node]) |
|
2343 | 2344 | code = self.compile(mod, cell_name, "exec") |
|
2344 | 2345 | if self.run_code(code): |
|
2345 | 2346 | return True |
|
2346 | 2347 | |
|
2347 | 2348 | for i, node in enumerate(to_run_interactive): |
|
2348 | 2349 | mod = ast.Interactive([node]) |
|
2349 | 2350 | code = self.compile(mod, cell_name, "single") |
|
2350 | 2351 | if self.run_code(code): |
|
2351 | 2352 | return True |
|
2352 | 2353 | |
|
2353 | 2354 | return False |
|
2354 | 2355 | |
|
2355 | 2356 | def run_code(self, code_obj): |
|
2356 | 2357 | """Execute a code object. |
|
2357 | 2358 | |
|
2358 | 2359 | When an exception occurs, self.showtraceback() is called to display a |
|
2359 | 2360 | traceback. |
|
2360 | 2361 | |
|
2361 | 2362 | Parameters |
|
2362 | 2363 | ---------- |
|
2363 | 2364 | code_obj : code object |
|
2364 | 2365 | A compiled code object, to be executed |
|
2365 | 2366 | post_execute : bool [default: True] |
|
2366 | 2367 | whether to call post_execute hooks after this particular execution. |
|
2367 | 2368 | |
|
2368 | 2369 | Returns |
|
2369 | 2370 | ------- |
|
2370 | 2371 | False : successful execution. |
|
2371 | 2372 | True : an error occurred. |
|
2372 | 2373 | """ |
|
2373 | 2374 | |
|
2374 | 2375 | # Set our own excepthook in case the user code tries to call it |
|
2375 | 2376 | # directly, so that the IPython crash handler doesn't get triggered |
|
2376 | 2377 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2377 | 2378 | |
|
2378 | 2379 | # we save the original sys.excepthook in the instance, in case config |
|
2379 | 2380 | # code (such as magics) needs access to it. |
|
2380 | 2381 | self.sys_excepthook = old_excepthook |
|
2381 | 2382 | outflag = 1 # happens in more places, so it's easier as default |
|
2382 | 2383 | try: |
|
2383 | 2384 | try: |
|
2384 | 2385 | self.hooks.pre_run_code_hook() |
|
2385 | 2386 | #rprint('Running code', repr(code_obj)) # dbg |
|
2386 | 2387 | exec code_obj in self.user_global_ns, self.user_ns |
|
2387 | 2388 | finally: |
|
2388 | 2389 | # Reset our crash handler in place |
|
2389 | 2390 | sys.excepthook = old_excepthook |
|
2390 | 2391 | except SystemExit: |
|
2391 | 2392 | self.showtraceback(exception_only=True) |
|
2392 | 2393 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2393 | 2394 | except self.custom_exceptions: |
|
2394 | 2395 | etype,value,tb = sys.exc_info() |
|
2395 | 2396 | self.CustomTB(etype,value,tb) |
|
2396 | 2397 | except: |
|
2397 | 2398 | self.showtraceback() |
|
2398 | 2399 | else: |
|
2399 | 2400 | outflag = 0 |
|
2400 | 2401 | if softspace(sys.stdout, 0): |
|
2401 | 2402 | |
|
2402 | 2403 | |
|
2403 | 2404 | return outflag |
|
2404 | 2405 | |
|
2405 | 2406 | # For backwards compatibility |
|
2406 | 2407 | runcode = run_code |
|
2407 | 2408 | |
|
2408 | 2409 | #------------------------------------------------------------------------- |
|
2409 | 2410 | # Things related to GUI support and pylab |
|
2410 | 2411 | #------------------------------------------------------------------------- |
|
2411 | 2412 | |
|
2412 | 2413 | def enable_pylab(self, gui=None): |
|
2413 | 2414 | raise NotImplementedError('Implement enable_pylab in a subclass') |
|
2414 | 2415 | |
|
2415 | 2416 | #------------------------------------------------------------------------- |
|
2416 | 2417 | # Utilities |
|
2417 | 2418 | #------------------------------------------------------------------------- |
|
2418 | 2419 | |
|
2419 | 2420 | def var_expand(self,cmd,depth=0): |
|
2420 | 2421 | """Expand python variables in a string. |
|
2421 | 2422 | |
|
2422 | 2423 | The depth argument indicates how many frames above the caller should |
|
2423 | 2424 | be walked to look for the local namespace where to expand variables. |
|
2424 | 2425 | |
|
2425 | 2426 | The global namespace for expansion is always the user's interactive |
|
2426 | 2427 | namespace. |
|
2427 | 2428 | """ |
|
2428 | 2429 | res = ItplNS(cmd, self.user_ns, # globals |
|
2429 | 2430 | # Skip our own frame in searching for locals: |
|
2430 | 2431 | sys._getframe(depth+1).f_locals # locals |
|
2431 | 2432 | ) |
|
2432 | 2433 | return str(res).decode(res.codec) |
|
2433 | 2434 | |
|
2434 | 2435 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
2435 | 2436 | """Make a new tempfile and return its filename. |
|
2436 | 2437 | |
|
2437 | 2438 | This makes a call to tempfile.mktemp, but it registers the created |
|
2438 | 2439 | filename internally so ipython cleans it up at exit time. |
|
2439 | 2440 | |
|
2440 | 2441 | Optional inputs: |
|
2441 | 2442 | |
|
2442 | 2443 | - data(None): if data is given, it gets written out to the temp file |
|
2443 | 2444 | immediately, and the file is closed again.""" |
|
2444 | 2445 | |
|
2445 | 2446 | filename = tempfile.mktemp('.py', prefix) |
|
2446 | 2447 | self.tempfiles.append(filename) |
|
2447 | 2448 | |
|
2448 | 2449 | if data: |
|
2449 | 2450 | tmp_file = open(filename,'w') |
|
2450 | 2451 | tmp_file.write(data) |
|
2451 | 2452 | tmp_file.close() |
|
2452 | 2453 | return filename |
|
2453 | 2454 | |
|
2454 | 2455 | # TODO: This should be removed when Term is refactored. |
|
2455 | 2456 | def write(self,data): |
|
2456 | 2457 | """Write a string to the default output""" |
|
2457 | 2458 | io.stdout.write(data) |
|
2458 | 2459 | |
|
2459 | 2460 | # TODO: This should be removed when Term is refactored. |
|
2460 | 2461 | def write_err(self,data): |
|
2461 | 2462 | """Write a string to the default error output""" |
|
2462 | 2463 | io.stderr.write(data) |
|
2463 | 2464 | |
|
2464 | 2465 | def ask_yes_no(self,prompt,default=True): |
|
2465 | 2466 | if self.quiet: |
|
2466 | 2467 | return True |
|
2467 | 2468 | return ask_yes_no(prompt,default) |
|
2468 | 2469 | |
|
2469 | 2470 | def show_usage(self): |
|
2470 | 2471 | """Show a usage message""" |
|
2471 | 2472 | page.page(IPython.core.usage.interactive_usage) |
|
2472 | 2473 | |
|
2473 | 2474 | def find_user_code(self, target, raw=True): |
|
2474 | 2475 | """Get a code string from history, file, or a string or macro. |
|
2475 | 2476 | |
|
2476 | 2477 | This is mainly used by magic functions. |
|
2477 | 2478 | |
|
2478 | 2479 | Parameters |
|
2479 | 2480 | ---------- |
|
2480 | 2481 | target : str |
|
2481 | 2482 | A string specifying code to retrieve. This will be tried respectively |
|
2482 | 2483 | as: ranges of input history (see %history for syntax), a filename, or |
|
2483 | 2484 | an expression evaluating to a string or Macro in the user namespace. |
|
2484 | 2485 | raw : bool |
|
2485 | 2486 | If true (default), retrieve raw history. Has no effect on the other |
|
2486 | 2487 | retrieval mechanisms. |
|
2487 | 2488 | |
|
2488 | 2489 | Returns |
|
2489 | 2490 | ------- |
|
2490 | 2491 | A string of code. |
|
2491 | 2492 | |
|
2492 | 2493 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
2493 | 2494 | to an object of another type. In each case, .args[0] is a printable |
|
2494 | 2495 | message. |
|
2495 | 2496 | """ |
|
2496 | 2497 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
2497 | 2498 | if code: |
|
2498 | 2499 | return code |
|
2499 | 2500 | if os.path.isfile(target): # Read file |
|
2500 | 2501 | return open(target, "r").read() |
|
2501 | 2502 | |
|
2502 | 2503 | try: # User namespace |
|
2503 | 2504 | codeobj = eval(target, self.user_ns) |
|
2504 | 2505 | except Exception: |
|
2505 | 2506 | raise ValueError(("'%s' was not found in history, as a file, nor in" |
|
2506 | 2507 | " the user namespace.") % target) |
|
2507 | 2508 | if isinstance(codeobj, basestring): |
|
2508 | 2509 | return codeobj |
|
2509 | 2510 | elif isinstance(codeobj, Macro): |
|
2510 | 2511 | return codeobj.value |
|
2511 | 2512 | |
|
2512 | 2513 | raise TypeError("%s is neither a string nor a macro." % target, |
|
2513 | 2514 | codeobj) |
|
2514 | 2515 | |
|
2515 | 2516 | #------------------------------------------------------------------------- |
|
2516 | 2517 | # Things related to IPython exiting |
|
2517 | 2518 | #------------------------------------------------------------------------- |
|
2518 | 2519 | def atexit_operations(self): |
|
2519 | 2520 | """This will be executed at the time of exit. |
|
2520 | 2521 | |
|
2521 | 2522 | Cleanup operations and saving of persistent data that is done |
|
2522 | 2523 | unconditionally by IPython should be performed here. |
|
2523 | 2524 | |
|
2524 | 2525 | For things that may depend on startup flags or platform specifics (such |
|
2525 | 2526 | as having readline or not), register a separate atexit function in the |
|
2526 | 2527 | code that has the appropriate information, rather than trying to |
|
2527 | 2528 | clutter |
|
2528 | 2529 | """ |
|
2529 | 2530 | # Cleanup all tempfiles left around |
|
2530 | 2531 | for tfile in self.tempfiles: |
|
2531 | 2532 | try: |
|
2532 | 2533 | os.unlink(tfile) |
|
2533 | 2534 | except OSError: |
|
2534 | 2535 | pass |
|
2535 | 2536 | |
|
2536 | 2537 | # Close the history session (this stores the end time and line count) |
|
2537 | 2538 | self.history_manager.end_session() |
|
2538 | 2539 | |
|
2539 | 2540 | # Clear all user namespaces to release all references cleanly. |
|
2540 | 2541 | self.reset(new_session=False) |
|
2541 | 2542 | |
|
2542 | 2543 | # Run user hooks |
|
2543 | 2544 | self.hooks.shutdown_hook() |
|
2544 | 2545 | |
|
2545 | 2546 | def cleanup(self): |
|
2546 | 2547 | self.restore_sys_module_state() |
|
2547 | 2548 | |
|
2548 | 2549 | |
|
2549 | 2550 | class InteractiveShellABC(object): |
|
2550 | 2551 | """An abstract base class for InteractiveShell.""" |
|
2551 | 2552 | __metaclass__ = abc.ABCMeta |
|
2552 | 2553 | |
|
2553 | 2554 | InteractiveShellABC.register(InteractiveShell) |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,1013 +1,1013 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | # encoding: utf-8 |
|
3 | 3 | """ |
|
4 | 4 | Prefiltering components. |
|
5 | 5 | |
|
6 | 6 | Prefilters transform user input before it is exec'd by Python. These |
|
7 | 7 | transforms are used to implement additional syntax such as !ls and %magic. |
|
8 | 8 | |
|
9 | 9 | Authors: |
|
10 | 10 | |
|
11 | 11 | * Brian Granger |
|
12 | 12 | * Fernando Perez |
|
13 | 13 | * Dan Milstein |
|
14 | 14 | * Ville Vainio |
|
15 | 15 | """ |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Copyright (C) 2008-2009 The IPython Development Team |
|
19 | 19 | # |
|
20 | 20 | # Distributed under the terms of the BSD License. The full license is in |
|
21 | 21 | # the file COPYING, distributed as part of this software. |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | |
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | # Imports |
|
26 | 26 | #----------------------------------------------------------------------------- |
|
27 | 27 | |
|
28 | 28 | import __builtin__ |
|
29 | 29 | import codeop |
|
30 | 30 | import re |
|
31 | 31 | |
|
32 | 32 | from IPython.core.alias import AliasManager |
|
33 | 33 | from IPython.core.autocall import IPyAutocall |
|
34 | 34 | from IPython.config.configurable import Configurable |
|
35 | 35 | from IPython.core.macro import Macro |
|
36 | 36 | from IPython.core.splitinput import split_user_input |
|
37 | 37 | from IPython.core import page |
|
38 | 38 | |
|
39 |
from IPython.utils.traitlets import List, Int, Any, |
|
|
39 | from IPython.utils.traitlets import List, Int, Any, Unicode, CBool, Bool, Instance | |
|
40 | 40 | from IPython.utils.text import make_quoted_expr |
|
41 | 41 | from IPython.utils.autoattr import auto_attr |
|
42 | 42 | |
|
43 | 43 | #----------------------------------------------------------------------------- |
|
44 | 44 | # Global utilities, errors and constants |
|
45 | 45 | #----------------------------------------------------------------------------- |
|
46 | 46 | |
|
47 | 47 | # Warning, these cannot be changed unless various regular expressions |
|
48 | 48 | # are updated in a number of places. Not great, but at least we told you. |
|
49 | 49 | ESC_SHELL = '!' |
|
50 | 50 | ESC_SH_CAP = '!!' |
|
51 | 51 | ESC_HELP = '?' |
|
52 | 52 | ESC_MAGIC = '%' |
|
53 | 53 | ESC_QUOTE = ',' |
|
54 | 54 | ESC_QUOTE2 = ';' |
|
55 | 55 | ESC_PAREN = '/' |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | class PrefilterError(Exception): |
|
59 | 59 | pass |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | # RegExp to identify potential function names |
|
63 | 63 | re_fun_name = re.compile(r'[a-zA-Z_]([a-zA-Z0-9_.]*) *$') |
|
64 | 64 | |
|
65 | 65 | # RegExp to exclude strings with this start from autocalling. In |
|
66 | 66 | # particular, all binary operators should be excluded, so that if foo is |
|
67 | 67 | # callable, foo OP bar doesn't become foo(OP bar), which is invalid. The |
|
68 | 68 | # characters '!=()' don't need to be checked for, as the checkPythonChars |
|
69 | 69 | # routine explicitely does so, to catch direct calls and rebindings of |
|
70 | 70 | # existing names. |
|
71 | 71 | |
|
72 | 72 | # Warning: the '-' HAS TO BE AT THE END of the first group, otherwise |
|
73 | 73 | # it affects the rest of the group in square brackets. |
|
74 | 74 | re_exclude_auto = re.compile(r'^[,&^\|\*/\+-]' |
|
75 | 75 | r'|^is |^not |^in |^and |^or ') |
|
76 | 76 | |
|
77 | 77 | # try to catch also methods for stuff in lists/tuples/dicts: off |
|
78 | 78 | # (experimental). For this to work, the line_split regexp would need |
|
79 | 79 | # to be modified so it wouldn't break things at '['. That line is |
|
80 | 80 | # nasty enough that I shouldn't change it until I can test it _well_. |
|
81 | 81 | #self.re_fun_name = re.compile (r'[a-zA-Z_]([a-zA-Z0-9_.\[\]]*) ?$') |
|
82 | 82 | |
|
83 | 83 | |
|
84 | 84 | # Handler Check Utilities |
|
85 | 85 | def is_shadowed(identifier, ip): |
|
86 | 86 | """Is the given identifier defined in one of the namespaces which shadow |
|
87 | 87 | the alias and magic namespaces? Note that an identifier is different |
|
88 | 88 | than ifun, because it can not contain a '.' character.""" |
|
89 | 89 | # This is much safer than calling ofind, which can change state |
|
90 | 90 | return (identifier in ip.user_ns \ |
|
91 | 91 | or identifier in ip.internal_ns \ |
|
92 | 92 | or identifier in ip.ns_table['builtin']) |
|
93 | 93 | |
|
94 | 94 | |
|
95 | 95 | #----------------------------------------------------------------------------- |
|
96 | 96 | # The LineInfo class used throughout |
|
97 | 97 | #----------------------------------------------------------------------------- |
|
98 | 98 | |
|
99 | 99 | |
|
100 | 100 | class LineInfo(object): |
|
101 | 101 | """A single line of input and associated info. |
|
102 | 102 | |
|
103 | 103 | Includes the following as properties: |
|
104 | 104 | |
|
105 | 105 | line |
|
106 | 106 | The original, raw line |
|
107 | 107 | |
|
108 | 108 | continue_prompt |
|
109 | 109 | Is this line a continuation in a sequence of multiline input? |
|
110 | 110 | |
|
111 | 111 | pre |
|
112 | 112 | The initial esc character or whitespace. |
|
113 | 113 | |
|
114 | 114 | pre_char |
|
115 | 115 | The escape character(s) in pre or the empty string if there isn't one. |
|
116 | 116 | Note that '!!' is a possible value for pre_char. Otherwise it will |
|
117 | 117 | always be a single character. |
|
118 | 118 | |
|
119 | 119 | pre_whitespace |
|
120 | 120 | The leading whitespace from pre if it exists. If there is a pre_char, |
|
121 | 121 | this is just ''. |
|
122 | 122 | |
|
123 | 123 | ifun |
|
124 | 124 | The 'function part', which is basically the maximal initial sequence |
|
125 | 125 | of valid python identifiers and the '.' character. This is what is |
|
126 | 126 | checked for alias and magic transformations, used for auto-calling, |
|
127 | 127 | etc. |
|
128 | 128 | |
|
129 | 129 | the_rest |
|
130 | 130 | Everything else on the line. |
|
131 | 131 | """ |
|
132 | 132 | def __init__(self, line, continue_prompt): |
|
133 | 133 | self.line = line |
|
134 | 134 | self.continue_prompt = continue_prompt |
|
135 | 135 | self.pre, self.ifun, self.the_rest = split_user_input(line) |
|
136 | 136 | |
|
137 | 137 | self.pre_char = self.pre.strip() |
|
138 | 138 | if self.pre_char: |
|
139 | 139 | self.pre_whitespace = '' # No whitespace allowd before esc chars |
|
140 | 140 | else: |
|
141 | 141 | self.pre_whitespace = self.pre |
|
142 | 142 | |
|
143 | 143 | self._oinfo = None |
|
144 | 144 | |
|
145 | 145 | def ofind(self, ip): |
|
146 | 146 | """Do a full, attribute-walking lookup of the ifun in the various |
|
147 | 147 | namespaces for the given IPython InteractiveShell instance. |
|
148 | 148 | |
|
149 | 149 | Return a dict with keys: found,obj,ospace,ismagic |
|
150 | 150 | |
|
151 | 151 | Note: can cause state changes because of calling getattr, but should |
|
152 | 152 | only be run if autocall is on and if the line hasn't matched any |
|
153 | 153 | other, less dangerous handlers. |
|
154 | 154 | |
|
155 | 155 | Does cache the results of the call, so can be called multiple times |
|
156 | 156 | without worrying about *further* damaging state. |
|
157 | 157 | """ |
|
158 | 158 | if not self._oinfo: |
|
159 | 159 | # ip.shell._ofind is actually on the Magic class! |
|
160 | 160 | self._oinfo = ip.shell._ofind(self.ifun) |
|
161 | 161 | return self._oinfo |
|
162 | 162 | |
|
163 | 163 | def __str__(self): |
|
164 | 164 | return "Lineinfo [%s|%s|%s]" %(self.pre, self.ifun, self.the_rest) |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | #----------------------------------------------------------------------------- |
|
168 | 168 | # Main Prefilter manager |
|
169 | 169 | #----------------------------------------------------------------------------- |
|
170 | 170 | |
|
171 | 171 | |
|
172 | 172 | class PrefilterManager(Configurable): |
|
173 | 173 | """Main prefilter component. |
|
174 | 174 | |
|
175 | 175 | The IPython prefilter is run on all user input before it is run. The |
|
176 | 176 | prefilter consumes lines of input and produces transformed lines of |
|
177 | 177 | input. |
|
178 | 178 | |
|
179 | 179 | The iplementation consists of two phases: |
|
180 | 180 | |
|
181 | 181 | 1. Transformers |
|
182 | 182 | 2. Checkers and handlers |
|
183 | 183 | |
|
184 | 184 | Over time, we plan on deprecating the checkers and handlers and doing |
|
185 | 185 | everything in the transformers. |
|
186 | 186 | |
|
187 | 187 | The transformers are instances of :class:`PrefilterTransformer` and have |
|
188 | 188 | a single method :meth:`transform` that takes a line and returns a |
|
189 | 189 | transformed line. The transformation can be accomplished using any |
|
190 | 190 | tool, but our current ones use regular expressions for speed. We also |
|
191 | 191 | ship :mod:`pyparsing` in :mod:`IPython.external` for use in transformers. |
|
192 | 192 | |
|
193 | 193 | After all the transformers have been run, the line is fed to the checkers, |
|
194 | 194 | which are instances of :class:`PrefilterChecker`. The line is passed to |
|
195 | 195 | the :meth:`check` method, which either returns `None` or a |
|
196 | 196 | :class:`PrefilterHandler` instance. If `None` is returned, the other |
|
197 | 197 | checkers are tried. If an :class:`PrefilterHandler` instance is returned, |
|
198 | 198 | the line is passed to the :meth:`handle` method of the returned |
|
199 | 199 | handler and no further checkers are tried. |
|
200 | 200 | |
|
201 | 201 | Both transformers and checkers have a `priority` attribute, that determines |
|
202 | 202 | the order in which they are called. Smaller priorities are tried first. |
|
203 | 203 | |
|
204 | 204 | Both transformers and checkers also have `enabled` attribute, which is |
|
205 | 205 | a boolean that determines if the instance is used. |
|
206 | 206 | |
|
207 | 207 | Users or developers can change the priority or enabled attribute of |
|
208 | 208 | transformers or checkers, but they must call the :meth:`sort_checkers` |
|
209 | 209 | or :meth:`sort_transformers` method after changing the priority. |
|
210 | 210 | """ |
|
211 | 211 | |
|
212 | 212 | multi_line_specials = CBool(True, config=True) |
|
213 | 213 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
214 | 214 | |
|
215 | 215 | def __init__(self, shell=None, config=None): |
|
216 | 216 | super(PrefilterManager, self).__init__(shell=shell, config=config) |
|
217 | 217 | self.shell = shell |
|
218 | 218 | self.init_transformers() |
|
219 | 219 | self.init_handlers() |
|
220 | 220 | self.init_checkers() |
|
221 | 221 | |
|
222 | 222 | #------------------------------------------------------------------------- |
|
223 | 223 | # API for managing transformers |
|
224 | 224 | #------------------------------------------------------------------------- |
|
225 | 225 | |
|
226 | 226 | def init_transformers(self): |
|
227 | 227 | """Create the default transformers.""" |
|
228 | 228 | self._transformers = [] |
|
229 | 229 | for transformer_cls in _default_transformers: |
|
230 | 230 | transformer_cls( |
|
231 | 231 | shell=self.shell, prefilter_manager=self, config=self.config |
|
232 | 232 | ) |
|
233 | 233 | |
|
234 | 234 | def sort_transformers(self): |
|
235 | 235 | """Sort the transformers by priority. |
|
236 | 236 | |
|
237 | 237 | This must be called after the priority of a transformer is changed. |
|
238 | 238 | The :meth:`register_transformer` method calls this automatically. |
|
239 | 239 | """ |
|
240 | 240 | self._transformers.sort(key=lambda x: x.priority) |
|
241 | 241 | |
|
242 | 242 | @property |
|
243 | 243 | def transformers(self): |
|
244 | 244 | """Return a list of checkers, sorted by priority.""" |
|
245 | 245 | return self._transformers |
|
246 | 246 | |
|
247 | 247 | def register_transformer(self, transformer): |
|
248 | 248 | """Register a transformer instance.""" |
|
249 | 249 | if transformer not in self._transformers: |
|
250 | 250 | self._transformers.append(transformer) |
|
251 | 251 | self.sort_transformers() |
|
252 | 252 | |
|
253 | 253 | def unregister_transformer(self, transformer): |
|
254 | 254 | """Unregister a transformer instance.""" |
|
255 | 255 | if transformer in self._transformers: |
|
256 | 256 | self._transformers.remove(transformer) |
|
257 | 257 | |
|
258 | 258 | #------------------------------------------------------------------------- |
|
259 | 259 | # API for managing checkers |
|
260 | 260 | #------------------------------------------------------------------------- |
|
261 | 261 | |
|
262 | 262 | def init_checkers(self): |
|
263 | 263 | """Create the default checkers.""" |
|
264 | 264 | self._checkers = [] |
|
265 | 265 | for checker in _default_checkers: |
|
266 | 266 | checker( |
|
267 | 267 | shell=self.shell, prefilter_manager=self, config=self.config |
|
268 | 268 | ) |
|
269 | 269 | |
|
270 | 270 | def sort_checkers(self): |
|
271 | 271 | """Sort the checkers by priority. |
|
272 | 272 | |
|
273 | 273 | This must be called after the priority of a checker is changed. |
|
274 | 274 | The :meth:`register_checker` method calls this automatically. |
|
275 | 275 | """ |
|
276 | 276 | self._checkers.sort(key=lambda x: x.priority) |
|
277 | 277 | |
|
278 | 278 | @property |
|
279 | 279 | def checkers(self): |
|
280 | 280 | """Return a list of checkers, sorted by priority.""" |
|
281 | 281 | return self._checkers |
|
282 | 282 | |
|
283 | 283 | def register_checker(self, checker): |
|
284 | 284 | """Register a checker instance.""" |
|
285 | 285 | if checker not in self._checkers: |
|
286 | 286 | self._checkers.append(checker) |
|
287 | 287 | self.sort_checkers() |
|
288 | 288 | |
|
289 | 289 | def unregister_checker(self, checker): |
|
290 | 290 | """Unregister a checker instance.""" |
|
291 | 291 | if checker in self._checkers: |
|
292 | 292 | self._checkers.remove(checker) |
|
293 | 293 | |
|
294 | 294 | #------------------------------------------------------------------------- |
|
295 | 295 | # API for managing checkers |
|
296 | 296 | #------------------------------------------------------------------------- |
|
297 | 297 | |
|
298 | 298 | def init_handlers(self): |
|
299 | 299 | """Create the default handlers.""" |
|
300 | 300 | self._handlers = {} |
|
301 | 301 | self._esc_handlers = {} |
|
302 | 302 | for handler in _default_handlers: |
|
303 | 303 | handler( |
|
304 | 304 | shell=self.shell, prefilter_manager=self, config=self.config |
|
305 | 305 | ) |
|
306 | 306 | |
|
307 | 307 | @property |
|
308 | 308 | def handlers(self): |
|
309 | 309 | """Return a dict of all the handlers.""" |
|
310 | 310 | return self._handlers |
|
311 | 311 | |
|
312 | 312 | def register_handler(self, name, handler, esc_strings): |
|
313 | 313 | """Register a handler instance by name with esc_strings.""" |
|
314 | 314 | self._handlers[name] = handler |
|
315 | 315 | for esc_str in esc_strings: |
|
316 | 316 | self._esc_handlers[esc_str] = handler |
|
317 | 317 | |
|
318 | 318 | def unregister_handler(self, name, handler, esc_strings): |
|
319 | 319 | """Unregister a handler instance by name with esc_strings.""" |
|
320 | 320 | try: |
|
321 | 321 | del self._handlers[name] |
|
322 | 322 | except KeyError: |
|
323 | 323 | pass |
|
324 | 324 | for esc_str in esc_strings: |
|
325 | 325 | h = self._esc_handlers.get(esc_str) |
|
326 | 326 | if h is handler: |
|
327 | 327 | del self._esc_handlers[esc_str] |
|
328 | 328 | |
|
329 | 329 | def get_handler_by_name(self, name): |
|
330 | 330 | """Get a handler by its name.""" |
|
331 | 331 | return self._handlers.get(name) |
|
332 | 332 | |
|
333 | 333 | def get_handler_by_esc(self, esc_str): |
|
334 | 334 | """Get a handler by its escape string.""" |
|
335 | 335 | return self._esc_handlers.get(esc_str) |
|
336 | 336 | |
|
337 | 337 | #------------------------------------------------------------------------- |
|
338 | 338 | # Main prefiltering API |
|
339 | 339 | #------------------------------------------------------------------------- |
|
340 | 340 | |
|
341 | 341 | def prefilter_line_info(self, line_info): |
|
342 | 342 | """Prefilter a line that has been converted to a LineInfo object. |
|
343 | 343 | |
|
344 | 344 | This implements the checker/handler part of the prefilter pipe. |
|
345 | 345 | """ |
|
346 | 346 | # print "prefilter_line_info: ", line_info |
|
347 | 347 | handler = self.find_handler(line_info) |
|
348 | 348 | return handler.handle(line_info) |
|
349 | 349 | |
|
350 | 350 | def find_handler(self, line_info): |
|
351 | 351 | """Find a handler for the line_info by trying checkers.""" |
|
352 | 352 | for checker in self.checkers: |
|
353 | 353 | if checker.enabled: |
|
354 | 354 | handler = checker.check(line_info) |
|
355 | 355 | if handler: |
|
356 | 356 | return handler |
|
357 | 357 | return self.get_handler_by_name('normal') |
|
358 | 358 | |
|
359 | 359 | def transform_line(self, line, continue_prompt): |
|
360 | 360 | """Calls the enabled transformers in order of increasing priority.""" |
|
361 | 361 | for transformer in self.transformers: |
|
362 | 362 | if transformer.enabled: |
|
363 | 363 | line = transformer.transform(line, continue_prompt) |
|
364 | 364 | return line |
|
365 | 365 | |
|
366 | 366 | def prefilter_line(self, line, continue_prompt=False): |
|
367 | 367 | """Prefilter a single input line as text. |
|
368 | 368 | |
|
369 | 369 | This method prefilters a single line of text by calling the |
|
370 | 370 | transformers and then the checkers/handlers. |
|
371 | 371 | """ |
|
372 | 372 | |
|
373 | 373 | # print "prefilter_line: ", line, continue_prompt |
|
374 | 374 | # All handlers *must* return a value, even if it's blank (''). |
|
375 | 375 | |
|
376 | 376 | # save the line away in case we crash, so the post-mortem handler can |
|
377 | 377 | # record it |
|
378 | 378 | self.shell._last_input_line = line |
|
379 | 379 | |
|
380 | 380 | if not line: |
|
381 | 381 | # Return immediately on purely empty lines, so that if the user |
|
382 | 382 | # previously typed some whitespace that started a continuation |
|
383 | 383 | # prompt, he can break out of that loop with just an empty line. |
|
384 | 384 | # This is how the default python prompt works. |
|
385 | 385 | return '' |
|
386 | 386 | |
|
387 | 387 | # At this point, we invoke our transformers. |
|
388 | 388 | if not continue_prompt or (continue_prompt and self.multi_line_specials): |
|
389 | 389 | line = self.transform_line(line, continue_prompt) |
|
390 | 390 | |
|
391 | 391 | # Now we compute line_info for the checkers and handlers |
|
392 | 392 | line_info = LineInfo(line, continue_prompt) |
|
393 | 393 | |
|
394 | 394 | # the input history needs to track even empty lines |
|
395 | 395 | stripped = line.strip() |
|
396 | 396 | |
|
397 | 397 | normal_handler = self.get_handler_by_name('normal') |
|
398 | 398 | if not stripped: |
|
399 | 399 | if not continue_prompt: |
|
400 | 400 | self.shell.displayhook.prompt_count -= 1 |
|
401 | 401 | |
|
402 | 402 | return normal_handler.handle(line_info) |
|
403 | 403 | |
|
404 | 404 | # special handlers are only allowed for single line statements |
|
405 | 405 | if continue_prompt and not self.multi_line_specials: |
|
406 | 406 | return normal_handler.handle(line_info) |
|
407 | 407 | |
|
408 | 408 | prefiltered = self.prefilter_line_info(line_info) |
|
409 | 409 | # print "prefiltered line: %r" % prefiltered |
|
410 | 410 | return prefiltered |
|
411 | 411 | |
|
412 | 412 | def prefilter_lines(self, lines, continue_prompt=False): |
|
413 | 413 | """Prefilter multiple input lines of text. |
|
414 | 414 | |
|
415 | 415 | This is the main entry point for prefiltering multiple lines of |
|
416 | 416 | input. This simply calls :meth:`prefilter_line` for each line of |
|
417 | 417 | input. |
|
418 | 418 | |
|
419 | 419 | This covers cases where there are multiple lines in the user entry, |
|
420 | 420 | which is the case when the user goes back to a multiline history |
|
421 | 421 | entry and presses enter. |
|
422 | 422 | """ |
|
423 | 423 | llines = lines.rstrip('\n').split('\n') |
|
424 | 424 | # We can get multiple lines in one shot, where multiline input 'blends' |
|
425 | 425 | # into one line, in cases like recalling from the readline history |
|
426 | 426 | # buffer. We need to make sure that in such cases, we correctly |
|
427 | 427 | # communicate downstream which line is first and which are continuation |
|
428 | 428 | # ones. |
|
429 | 429 | if len(llines) > 1: |
|
430 | 430 | out = '\n'.join([self.prefilter_line(line, lnum>0) |
|
431 | 431 | for lnum, line in enumerate(llines) ]) |
|
432 | 432 | else: |
|
433 | 433 | out = self.prefilter_line(llines[0], continue_prompt) |
|
434 | 434 | |
|
435 | 435 | return out |
|
436 | 436 | |
|
437 | 437 | #----------------------------------------------------------------------------- |
|
438 | 438 | # Prefilter transformers |
|
439 | 439 | #----------------------------------------------------------------------------- |
|
440 | 440 | |
|
441 | 441 | |
|
442 | 442 | class PrefilterTransformer(Configurable): |
|
443 | 443 | """Transform a line of user input.""" |
|
444 | 444 | |
|
445 | 445 | priority = Int(100, config=True) |
|
446 | 446 | # Transformers don't currently use shell or prefilter_manager, but as we |
|
447 | 447 | # move away from checkers and handlers, they will need them. |
|
448 | 448 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
449 | 449 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
450 | 450 | enabled = Bool(True, config=True) |
|
451 | 451 | |
|
452 | 452 | def __init__(self, shell=None, prefilter_manager=None, config=None): |
|
453 | 453 | super(PrefilterTransformer, self).__init__( |
|
454 | 454 | shell=shell, prefilter_manager=prefilter_manager, config=config |
|
455 | 455 | ) |
|
456 | 456 | self.prefilter_manager.register_transformer(self) |
|
457 | 457 | |
|
458 | 458 | def transform(self, line, continue_prompt): |
|
459 | 459 | """Transform a line, returning the new one.""" |
|
460 | 460 | return None |
|
461 | 461 | |
|
462 | 462 | def __repr__(self): |
|
463 | 463 | return "<%s(priority=%r, enabled=%r)>" % ( |
|
464 | 464 | self.__class__.__name__, self.priority, self.enabled) |
|
465 | 465 | |
|
466 | 466 | |
|
467 | 467 | _assign_system_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))' |
|
468 | 468 | r'\s*=\s*!(?P<cmd>.*)') |
|
469 | 469 | |
|
470 | 470 | |
|
471 | 471 | class AssignSystemTransformer(PrefilterTransformer): |
|
472 | 472 | """Handle the `files = !ls` syntax.""" |
|
473 | 473 | |
|
474 | 474 | priority = Int(100, config=True) |
|
475 | 475 | |
|
476 | 476 | def transform(self, line, continue_prompt): |
|
477 | 477 | m = _assign_system_re.match(line) |
|
478 | 478 | if m is not None: |
|
479 | 479 | cmd = m.group('cmd') |
|
480 | 480 | lhs = m.group('lhs') |
|
481 | 481 | expr = make_quoted_expr("sc =%s" % cmd) |
|
482 | 482 | new_line = '%s = get_ipython().magic(%s)' % (lhs, expr) |
|
483 | 483 | return new_line |
|
484 | 484 | return line |
|
485 | 485 | |
|
486 | 486 | |
|
487 | 487 | _assign_magic_re = re.compile(r'(?P<lhs>(\s*)([\w\.]+)((\s*,\s*[\w\.]+)*))' |
|
488 | 488 | r'\s*=\s*%(?P<cmd>.*)') |
|
489 | 489 | |
|
490 | 490 | class AssignMagicTransformer(PrefilterTransformer): |
|
491 | 491 | """Handle the `a = %who` syntax.""" |
|
492 | 492 | |
|
493 | 493 | priority = Int(200, config=True) |
|
494 | 494 | |
|
495 | 495 | def transform(self, line, continue_prompt): |
|
496 | 496 | m = _assign_magic_re.match(line) |
|
497 | 497 | if m is not None: |
|
498 | 498 | cmd = m.group('cmd') |
|
499 | 499 | lhs = m.group('lhs') |
|
500 | 500 | expr = make_quoted_expr(cmd) |
|
501 | 501 | new_line = '%s = get_ipython().magic(%s)' % (lhs, expr) |
|
502 | 502 | return new_line |
|
503 | 503 | return line |
|
504 | 504 | |
|
505 | 505 | |
|
506 | 506 | _classic_prompt_re = re.compile(r'(^[ \t]*>>> |^[ \t]*\.\.\. )') |
|
507 | 507 | |
|
508 | 508 | class PyPromptTransformer(PrefilterTransformer): |
|
509 | 509 | """Handle inputs that start with '>>> ' syntax.""" |
|
510 | 510 | |
|
511 | 511 | priority = Int(50, config=True) |
|
512 | 512 | |
|
513 | 513 | def transform(self, line, continue_prompt): |
|
514 | 514 | |
|
515 | 515 | if not line or line.isspace() or line.strip() == '...': |
|
516 | 516 | # This allows us to recognize multiple input prompts separated by |
|
517 | 517 | # blank lines and pasted in a single chunk, very common when |
|
518 | 518 | # pasting doctests or long tutorial passages. |
|
519 | 519 | return '' |
|
520 | 520 | m = _classic_prompt_re.match(line) |
|
521 | 521 | if m: |
|
522 | 522 | return line[len(m.group(0)):] |
|
523 | 523 | else: |
|
524 | 524 | return line |
|
525 | 525 | |
|
526 | 526 | |
|
527 | 527 | _ipy_prompt_re = re.compile(r'(^[ \t]*In \[\d+\]: |^[ \t]*\ \ \ \.\.\.+: )') |
|
528 | 528 | |
|
529 | 529 | class IPyPromptTransformer(PrefilterTransformer): |
|
530 | 530 | """Handle inputs that start classic IPython prompt syntax.""" |
|
531 | 531 | |
|
532 | 532 | priority = Int(50, config=True) |
|
533 | 533 | |
|
534 | 534 | def transform(self, line, continue_prompt): |
|
535 | 535 | |
|
536 | 536 | if not line or line.isspace() or line.strip() == '...': |
|
537 | 537 | # This allows us to recognize multiple input prompts separated by |
|
538 | 538 | # blank lines and pasted in a single chunk, very common when |
|
539 | 539 | # pasting doctests or long tutorial passages. |
|
540 | 540 | return '' |
|
541 | 541 | m = _ipy_prompt_re.match(line) |
|
542 | 542 | if m: |
|
543 | 543 | return line[len(m.group(0)):] |
|
544 | 544 | else: |
|
545 | 545 | return line |
|
546 | 546 | |
|
547 | 547 | #----------------------------------------------------------------------------- |
|
548 | 548 | # Prefilter checkers |
|
549 | 549 | #----------------------------------------------------------------------------- |
|
550 | 550 | |
|
551 | 551 | |
|
552 | 552 | class PrefilterChecker(Configurable): |
|
553 | 553 | """Inspect an input line and return a handler for that line.""" |
|
554 | 554 | |
|
555 | 555 | priority = Int(100, config=True) |
|
556 | 556 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
557 | 557 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
558 | 558 | enabled = Bool(True, config=True) |
|
559 | 559 | |
|
560 | 560 | def __init__(self, shell=None, prefilter_manager=None, config=None): |
|
561 | 561 | super(PrefilterChecker, self).__init__( |
|
562 | 562 | shell=shell, prefilter_manager=prefilter_manager, config=config |
|
563 | 563 | ) |
|
564 | 564 | self.prefilter_manager.register_checker(self) |
|
565 | 565 | |
|
566 | 566 | def check(self, line_info): |
|
567 | 567 | """Inspect line_info and return a handler instance or None.""" |
|
568 | 568 | return None |
|
569 | 569 | |
|
570 | 570 | def __repr__(self): |
|
571 | 571 | return "<%s(priority=%r, enabled=%r)>" % ( |
|
572 | 572 | self.__class__.__name__, self.priority, self.enabled) |
|
573 | 573 | |
|
574 | 574 | |
|
575 | 575 | class EmacsChecker(PrefilterChecker): |
|
576 | 576 | |
|
577 | 577 | priority = Int(100, config=True) |
|
578 | 578 | enabled = Bool(False, config=True) |
|
579 | 579 | |
|
580 | 580 | def check(self, line_info): |
|
581 | 581 | "Emacs ipython-mode tags certain input lines." |
|
582 | 582 | if line_info.line.endswith('# PYTHON-MODE'): |
|
583 | 583 | return self.prefilter_manager.get_handler_by_name('emacs') |
|
584 | 584 | else: |
|
585 | 585 | return None |
|
586 | 586 | |
|
587 | 587 | |
|
588 | 588 | class ShellEscapeChecker(PrefilterChecker): |
|
589 | 589 | |
|
590 | 590 | priority = Int(200, config=True) |
|
591 | 591 | |
|
592 | 592 | def check(self, line_info): |
|
593 | 593 | if line_info.line.lstrip().startswith(ESC_SHELL): |
|
594 | 594 | return self.prefilter_manager.get_handler_by_name('shell') |
|
595 | 595 | |
|
596 | 596 | |
|
597 | 597 | class MacroChecker(PrefilterChecker): |
|
598 | 598 | |
|
599 | 599 | priority = Int(250, config=True) |
|
600 | 600 | |
|
601 | 601 | def check(self, line_info): |
|
602 | 602 | obj = self.shell.user_ns.get(line_info.ifun) |
|
603 | 603 | if isinstance(obj, Macro): |
|
604 | 604 | return self.prefilter_manager.get_handler_by_name('macro') |
|
605 | 605 | else: |
|
606 | 606 | return None |
|
607 | 607 | |
|
608 | 608 | |
|
609 | 609 | class IPyAutocallChecker(PrefilterChecker): |
|
610 | 610 | |
|
611 | 611 | priority = Int(300, config=True) |
|
612 | 612 | |
|
613 | 613 | def check(self, line_info): |
|
614 | 614 | "Instances of IPyAutocall in user_ns get autocalled immediately" |
|
615 | 615 | obj = self.shell.user_ns.get(line_info.ifun, None) |
|
616 | 616 | if isinstance(obj, IPyAutocall): |
|
617 | 617 | obj.set_ip(self.shell) |
|
618 | 618 | return self.prefilter_manager.get_handler_by_name('auto') |
|
619 | 619 | else: |
|
620 | 620 | return None |
|
621 | 621 | |
|
622 | 622 | |
|
623 | 623 | class MultiLineMagicChecker(PrefilterChecker): |
|
624 | 624 | |
|
625 | 625 | priority = Int(400, config=True) |
|
626 | 626 | |
|
627 | 627 | def check(self, line_info): |
|
628 | 628 | "Allow ! and !! in multi-line statements if multi_line_specials is on" |
|
629 | 629 | # Note that this one of the only places we check the first character of |
|
630 | 630 | # ifun and *not* the pre_char. Also note that the below test matches |
|
631 | 631 | # both ! and !!. |
|
632 | 632 | if line_info.continue_prompt \ |
|
633 | 633 | and self.prefilter_manager.multi_line_specials: |
|
634 | 634 | if line_info.ifun.startswith(ESC_MAGIC): |
|
635 | 635 | return self.prefilter_manager.get_handler_by_name('magic') |
|
636 | 636 | else: |
|
637 | 637 | return None |
|
638 | 638 | |
|
639 | 639 | |
|
640 | 640 | class EscCharsChecker(PrefilterChecker): |
|
641 | 641 | |
|
642 | 642 | priority = Int(500, config=True) |
|
643 | 643 | |
|
644 | 644 | def check(self, line_info): |
|
645 | 645 | """Check for escape character and return either a handler to handle it, |
|
646 | 646 | or None if there is no escape char.""" |
|
647 | 647 | if line_info.line[-1] == ESC_HELP \ |
|
648 | 648 | and line_info.pre_char != ESC_SHELL \ |
|
649 | 649 | and line_info.pre_char != ESC_SH_CAP: |
|
650 | 650 | # the ? can be at the end, but *not* for either kind of shell escape, |
|
651 | 651 | # because a ? can be a vaild final char in a shell cmd |
|
652 | 652 | return self.prefilter_manager.get_handler_by_name('help') |
|
653 | 653 | else: |
|
654 | 654 | # This returns None like it should if no handler exists |
|
655 | 655 | return self.prefilter_manager.get_handler_by_esc(line_info.pre_char) |
|
656 | 656 | |
|
657 | 657 | |
|
658 | 658 | class AssignmentChecker(PrefilterChecker): |
|
659 | 659 | |
|
660 | 660 | priority = Int(600, config=True) |
|
661 | 661 | |
|
662 | 662 | def check(self, line_info): |
|
663 | 663 | """Check to see if user is assigning to a var for the first time, in |
|
664 | 664 | which case we want to avoid any sort of automagic / autocall games. |
|
665 | 665 | |
|
666 | 666 | This allows users to assign to either alias or magic names true python |
|
667 | 667 | variables (the magic/alias systems always take second seat to true |
|
668 | 668 | python code). E.g. ls='hi', or ls,that=1,2""" |
|
669 | 669 | if line_info.the_rest: |
|
670 | 670 | if line_info.the_rest[0] in '=,': |
|
671 | 671 | return self.prefilter_manager.get_handler_by_name('normal') |
|
672 | 672 | else: |
|
673 | 673 | return None |
|
674 | 674 | |
|
675 | 675 | |
|
676 | 676 | class AutoMagicChecker(PrefilterChecker): |
|
677 | 677 | |
|
678 | 678 | priority = Int(700, config=True) |
|
679 | 679 | |
|
680 | 680 | def check(self, line_info): |
|
681 | 681 | """If the ifun is magic, and automagic is on, run it. Note: normal, |
|
682 | 682 | non-auto magic would already have been triggered via '%' in |
|
683 | 683 | check_esc_chars. This just checks for automagic. Also, before |
|
684 | 684 | triggering the magic handler, make sure that there is nothing in the |
|
685 | 685 | user namespace which could shadow it.""" |
|
686 | 686 | if not self.shell.automagic or not hasattr(self.shell,'magic_'+line_info.ifun): |
|
687 | 687 | return None |
|
688 | 688 | |
|
689 | 689 | # We have a likely magic method. Make sure we should actually call it. |
|
690 | 690 | if line_info.continue_prompt and not self.prefilter_manager.multi_line_specials: |
|
691 | 691 | return None |
|
692 | 692 | |
|
693 | 693 | head = line_info.ifun.split('.',1)[0] |
|
694 | 694 | if is_shadowed(head, self.shell): |
|
695 | 695 | return None |
|
696 | 696 | |
|
697 | 697 | return self.prefilter_manager.get_handler_by_name('magic') |
|
698 | 698 | |
|
699 | 699 | |
|
700 | 700 | class AliasChecker(PrefilterChecker): |
|
701 | 701 | |
|
702 | 702 | priority = Int(800, config=True) |
|
703 | 703 | |
|
704 | 704 | def check(self, line_info): |
|
705 | 705 | "Check if the initital identifier on the line is an alias." |
|
706 | 706 | # Note: aliases can not contain '.' |
|
707 | 707 | head = line_info.ifun.split('.',1)[0] |
|
708 | 708 | if line_info.ifun not in self.shell.alias_manager \ |
|
709 | 709 | or head not in self.shell.alias_manager \ |
|
710 | 710 | or is_shadowed(head, self.shell): |
|
711 | 711 | return None |
|
712 | 712 | |
|
713 | 713 | return self.prefilter_manager.get_handler_by_name('alias') |
|
714 | 714 | |
|
715 | 715 | |
|
716 | 716 | class PythonOpsChecker(PrefilterChecker): |
|
717 | 717 | |
|
718 | 718 | priority = Int(900, config=True) |
|
719 | 719 | |
|
720 | 720 | def check(self, line_info): |
|
721 | 721 | """If the 'rest' of the line begins with a function call or pretty much |
|
722 | 722 | any python operator, we should simply execute the line (regardless of |
|
723 | 723 | whether or not there's a possible autocall expansion). This avoids |
|
724 | 724 | spurious (and very confusing) geattr() accesses.""" |
|
725 | 725 | if line_info.the_rest and line_info.the_rest[0] in '!=()<>,+*/%^&|': |
|
726 | 726 | return self.prefilter_manager.get_handler_by_name('normal') |
|
727 | 727 | else: |
|
728 | 728 | return None |
|
729 | 729 | |
|
730 | 730 | |
|
731 | 731 | class AutocallChecker(PrefilterChecker): |
|
732 | 732 | |
|
733 | 733 | priority = Int(1000, config=True) |
|
734 | 734 | |
|
735 | 735 | def check(self, line_info): |
|
736 | 736 | "Check if the initial word/function is callable and autocall is on." |
|
737 | 737 | if not self.shell.autocall: |
|
738 | 738 | return None |
|
739 | 739 | |
|
740 | 740 | oinfo = line_info.ofind(self.shell) # This can mutate state via getattr |
|
741 | 741 | if not oinfo['found']: |
|
742 | 742 | return None |
|
743 | 743 | |
|
744 | 744 | if callable(oinfo['obj']) \ |
|
745 | 745 | and (not re_exclude_auto.match(line_info.the_rest)) \ |
|
746 | 746 | and re_fun_name.match(line_info.ifun): |
|
747 | 747 | return self.prefilter_manager.get_handler_by_name('auto') |
|
748 | 748 | else: |
|
749 | 749 | return None |
|
750 | 750 | |
|
751 | 751 | |
|
752 | 752 | #----------------------------------------------------------------------------- |
|
753 | 753 | # Prefilter handlers |
|
754 | 754 | #----------------------------------------------------------------------------- |
|
755 | 755 | |
|
756 | 756 | |
|
757 | 757 | class PrefilterHandler(Configurable): |
|
758 | 758 | |
|
759 |
handler_name = |
|
|
759 | handler_name = Unicode('normal') | |
|
760 | 760 | esc_strings = List([]) |
|
761 | 761 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') |
|
762 | 762 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
763 | 763 | |
|
764 | 764 | def __init__(self, shell=None, prefilter_manager=None, config=None): |
|
765 | 765 | super(PrefilterHandler, self).__init__( |
|
766 | 766 | shell=shell, prefilter_manager=prefilter_manager, config=config |
|
767 | 767 | ) |
|
768 | 768 | self.prefilter_manager.register_handler( |
|
769 | 769 | self.handler_name, |
|
770 | 770 | self, |
|
771 | 771 | self.esc_strings |
|
772 | 772 | ) |
|
773 | 773 | |
|
774 | 774 | def handle(self, line_info): |
|
775 | 775 | # print "normal: ", line_info |
|
776 | 776 | """Handle normal input lines. Use as a template for handlers.""" |
|
777 | 777 | |
|
778 | 778 | # With autoindent on, we need some way to exit the input loop, and I |
|
779 | 779 | # don't want to force the user to have to backspace all the way to |
|
780 | 780 | # clear the line. The rule will be in this case, that either two |
|
781 | 781 | # lines of pure whitespace in a row, or a line of pure whitespace but |
|
782 | 782 | # of a size different to the indent level, will exit the input loop. |
|
783 | 783 | line = line_info.line |
|
784 | 784 | continue_prompt = line_info.continue_prompt |
|
785 | 785 | |
|
786 | 786 | if (continue_prompt and |
|
787 | 787 | self.shell.autoindent and |
|
788 | 788 | line.isspace() and |
|
789 | 789 | 0 < abs(len(line) - self.shell.indent_current_nsp) <= 2): |
|
790 | 790 | line = '' |
|
791 | 791 | |
|
792 | 792 | return line |
|
793 | 793 | |
|
794 | 794 | def __str__(self): |
|
795 | 795 | return "<%s(name=%s)>" % (self.__class__.__name__, self.handler_name) |
|
796 | 796 | |
|
797 | 797 | |
|
798 | 798 | class AliasHandler(PrefilterHandler): |
|
799 | 799 | |
|
800 |
handler_name = |
|
|
800 | handler_name = Unicode('alias') | |
|
801 | 801 | |
|
802 | 802 | def handle(self, line_info): |
|
803 | 803 | """Handle alias input lines. """ |
|
804 | 804 | transformed = self.shell.alias_manager.expand_aliases(line_info.ifun,line_info.the_rest) |
|
805 | 805 | # pre is needed, because it carries the leading whitespace. Otherwise |
|
806 | 806 | # aliases won't work in indented sections. |
|
807 | 807 | line_out = '%sget_ipython().system(%s)' % (line_info.pre_whitespace, |
|
808 | 808 | make_quoted_expr(transformed)) |
|
809 | 809 | |
|
810 | 810 | return line_out |
|
811 | 811 | |
|
812 | 812 | |
|
813 | 813 | class ShellEscapeHandler(PrefilterHandler): |
|
814 | 814 | |
|
815 |
handler_name = |
|
|
815 | handler_name = Unicode('shell') | |
|
816 | 816 | esc_strings = List([ESC_SHELL, ESC_SH_CAP]) |
|
817 | 817 | |
|
818 | 818 | def handle(self, line_info): |
|
819 | 819 | """Execute the line in a shell, empty return value""" |
|
820 | 820 | magic_handler = self.prefilter_manager.get_handler_by_name('magic') |
|
821 | 821 | |
|
822 | 822 | line = line_info.line |
|
823 | 823 | if line.lstrip().startswith(ESC_SH_CAP): |
|
824 | 824 | # rewrite LineInfo's line, ifun and the_rest to properly hold the |
|
825 | 825 | # call to %sx and the actual command to be executed, so |
|
826 | 826 | # handle_magic can work correctly. Note that this works even if |
|
827 | 827 | # the line is indented, so it handles multi_line_specials |
|
828 | 828 | # properly. |
|
829 | 829 | new_rest = line.lstrip()[2:] |
|
830 | 830 | line_info.line = '%ssx %s' % (ESC_MAGIC, new_rest) |
|
831 | 831 | line_info.ifun = 'sx' |
|
832 | 832 | line_info.the_rest = new_rest |
|
833 | 833 | return magic_handler.handle(line_info) |
|
834 | 834 | else: |
|
835 | 835 | cmd = line.lstrip().lstrip(ESC_SHELL) |
|
836 | 836 | line_out = '%sget_ipython().system(%s)' % (line_info.pre_whitespace, |
|
837 | 837 | make_quoted_expr(cmd)) |
|
838 | 838 | return line_out |
|
839 | 839 | |
|
840 | 840 | |
|
841 | 841 | class MacroHandler(PrefilterHandler): |
|
842 |
handler_name = |
|
|
842 | handler_name = Unicode("macro") | |
|
843 | 843 | |
|
844 | 844 | def handle(self, line_info): |
|
845 | 845 | obj = self.shell.user_ns.get(line_info.ifun) |
|
846 | 846 | pre_space = line_info.pre_whitespace |
|
847 | 847 | line_sep = "\n" + pre_space |
|
848 | 848 | return pre_space + line_sep.join(obj.value.splitlines()) |
|
849 | 849 | |
|
850 | 850 | |
|
851 | 851 | class MagicHandler(PrefilterHandler): |
|
852 | 852 | |
|
853 |
handler_name = |
|
|
853 | handler_name = Unicode('magic') | |
|
854 | 854 | esc_strings = List([ESC_MAGIC]) |
|
855 | 855 | |
|
856 | 856 | def handle(self, line_info): |
|
857 | 857 | """Execute magic functions.""" |
|
858 | 858 | ifun = line_info.ifun |
|
859 | 859 | the_rest = line_info.the_rest |
|
860 | 860 | cmd = '%sget_ipython().magic(%s)' % (line_info.pre_whitespace, |
|
861 | 861 | make_quoted_expr(ifun + " " + the_rest)) |
|
862 | 862 | return cmd |
|
863 | 863 | |
|
864 | 864 | |
|
865 | 865 | class AutoHandler(PrefilterHandler): |
|
866 | 866 | |
|
867 |
handler_name = |
|
|
867 | handler_name = Unicode('auto') | |
|
868 | 868 | esc_strings = List([ESC_PAREN, ESC_QUOTE, ESC_QUOTE2]) |
|
869 | 869 | |
|
870 | 870 | def handle(self, line_info): |
|
871 | 871 | """Handle lines which can be auto-executed, quoting if requested.""" |
|
872 | 872 | line = line_info.line |
|
873 | 873 | ifun = line_info.ifun |
|
874 | 874 | the_rest = line_info.the_rest |
|
875 | 875 | pre = line_info.pre |
|
876 | 876 | continue_prompt = line_info.continue_prompt |
|
877 | 877 | obj = line_info.ofind(self)['obj'] |
|
878 | 878 | #print 'pre <%s> ifun <%s> rest <%s>' % (pre,ifun,the_rest) # dbg |
|
879 | 879 | |
|
880 | 880 | # This should only be active for single-line input! |
|
881 | 881 | if continue_prompt: |
|
882 | 882 | return line |
|
883 | 883 | |
|
884 | 884 | force_auto = isinstance(obj, IPyAutocall) |
|
885 | 885 | auto_rewrite = getattr(obj, 'rewrite', True) |
|
886 | 886 | |
|
887 | 887 | if pre == ESC_QUOTE: |
|
888 | 888 | # Auto-quote splitting on whitespace |
|
889 | 889 | newcmd = '%s("%s")' % (ifun,'", "'.join(the_rest.split()) ) |
|
890 | 890 | elif pre == ESC_QUOTE2: |
|
891 | 891 | # Auto-quote whole string |
|
892 | 892 | newcmd = '%s("%s")' % (ifun,the_rest) |
|
893 | 893 | elif pre == ESC_PAREN: |
|
894 | 894 | newcmd = '%s(%s)' % (ifun,",".join(the_rest.split())) |
|
895 | 895 | else: |
|
896 | 896 | # Auto-paren. |
|
897 | 897 | # We only apply it to argument-less calls if the autocall |
|
898 | 898 | # parameter is set to 2. We only need to check that autocall is < |
|
899 | 899 | # 2, since this function isn't called unless it's at least 1. |
|
900 | 900 | if not the_rest and (self.shell.autocall < 2) and not force_auto: |
|
901 | 901 | newcmd = '%s %s' % (ifun,the_rest) |
|
902 | 902 | auto_rewrite = False |
|
903 | 903 | else: |
|
904 | 904 | if not force_auto and the_rest.startswith('['): |
|
905 | 905 | if hasattr(obj,'__getitem__'): |
|
906 | 906 | # Don't autocall in this case: item access for an object |
|
907 | 907 | # which is BOTH callable and implements __getitem__. |
|
908 | 908 | newcmd = '%s %s' % (ifun,the_rest) |
|
909 | 909 | auto_rewrite = False |
|
910 | 910 | else: |
|
911 | 911 | # if the object doesn't support [] access, go ahead and |
|
912 | 912 | # autocall |
|
913 | 913 | newcmd = '%s(%s)' % (ifun.rstrip(),the_rest) |
|
914 | 914 | elif the_rest.endswith(';'): |
|
915 | 915 | newcmd = '%s(%s);' % (ifun.rstrip(),the_rest[:-1]) |
|
916 | 916 | else: |
|
917 | 917 | newcmd = '%s(%s)' % (ifun.rstrip(), the_rest) |
|
918 | 918 | |
|
919 | 919 | if auto_rewrite: |
|
920 | 920 | self.shell.auto_rewrite_input(newcmd) |
|
921 | 921 | |
|
922 | 922 | return newcmd |
|
923 | 923 | |
|
924 | 924 | |
|
925 | 925 | class HelpHandler(PrefilterHandler): |
|
926 | 926 | |
|
927 |
handler_name = |
|
|
927 | handler_name = Unicode('help') | |
|
928 | 928 | esc_strings = List([ESC_HELP]) |
|
929 | 929 | |
|
930 | 930 | def handle(self, line_info): |
|
931 | 931 | """Try to get some help for the object. |
|
932 | 932 | |
|
933 | 933 | obj? or ?obj -> basic information. |
|
934 | 934 | obj?? or ??obj -> more details. |
|
935 | 935 | """ |
|
936 | 936 | normal_handler = self.prefilter_manager.get_handler_by_name('normal') |
|
937 | 937 | line = line_info.line |
|
938 | 938 | # We need to make sure that we don't process lines which would be |
|
939 | 939 | # otherwise valid python, such as "x=1 # what?" |
|
940 | 940 | try: |
|
941 | 941 | codeop.compile_command(line) |
|
942 | 942 | except SyntaxError: |
|
943 | 943 | # We should only handle as help stuff which is NOT valid syntax |
|
944 | 944 | if line[0]==ESC_HELP: |
|
945 | 945 | line = line[1:] |
|
946 | 946 | elif line[-1]==ESC_HELP: |
|
947 | 947 | line = line[:-1] |
|
948 | 948 | if line: |
|
949 | 949 | #print 'line:<%r>' % line # dbg |
|
950 | 950 | self.shell.magic_pinfo(line) |
|
951 | 951 | else: |
|
952 | 952 | self.shell.show_usage() |
|
953 | 953 | return '' # Empty string is needed here! |
|
954 | 954 | except: |
|
955 | 955 | raise |
|
956 | 956 | # Pass any other exceptions through to the normal handler |
|
957 | 957 | return normal_handler.handle(line_info) |
|
958 | 958 | else: |
|
959 | 959 | # If the code compiles ok, we should handle it normally |
|
960 | 960 | return normal_handler.handle(line_info) |
|
961 | 961 | |
|
962 | 962 | |
|
963 | 963 | class EmacsHandler(PrefilterHandler): |
|
964 | 964 | |
|
965 |
handler_name = |
|
|
965 | handler_name = Unicode('emacs') | |
|
966 | 966 | esc_strings = List([]) |
|
967 | 967 | |
|
968 | 968 | def handle(self, line_info): |
|
969 | 969 | """Handle input lines marked by python-mode.""" |
|
970 | 970 | |
|
971 | 971 | # Currently, nothing is done. Later more functionality can be added |
|
972 | 972 | # here if needed. |
|
973 | 973 | |
|
974 | 974 | # The input cache shouldn't be updated |
|
975 | 975 | return line_info.line |
|
976 | 976 | |
|
977 | 977 | |
|
978 | 978 | #----------------------------------------------------------------------------- |
|
979 | 979 | # Defaults |
|
980 | 980 | #----------------------------------------------------------------------------- |
|
981 | 981 | |
|
982 | 982 | |
|
983 | 983 | _default_transformers = [ |
|
984 | 984 | AssignSystemTransformer, |
|
985 | 985 | AssignMagicTransformer, |
|
986 | 986 | PyPromptTransformer, |
|
987 | 987 | IPyPromptTransformer, |
|
988 | 988 | ] |
|
989 | 989 | |
|
990 | 990 | _default_checkers = [ |
|
991 | 991 | EmacsChecker, |
|
992 | 992 | ShellEscapeChecker, |
|
993 | 993 | MacroChecker, |
|
994 | 994 | IPyAutocallChecker, |
|
995 | 995 | MultiLineMagicChecker, |
|
996 | 996 | EscCharsChecker, |
|
997 | 997 | AssignmentChecker, |
|
998 | 998 | AutoMagicChecker, |
|
999 | 999 | AliasChecker, |
|
1000 | 1000 | PythonOpsChecker, |
|
1001 | 1001 | AutocallChecker |
|
1002 | 1002 | ] |
|
1003 | 1003 | |
|
1004 | 1004 | _default_handlers = [ |
|
1005 | 1005 | PrefilterHandler, |
|
1006 | 1006 | AliasHandler, |
|
1007 | 1007 | ShellEscapeHandler, |
|
1008 | 1008 | MacroHandler, |
|
1009 | 1009 | MagicHandler, |
|
1010 | 1010 | AutoHandler, |
|
1011 | 1011 | HelpHandler, |
|
1012 | 1012 | EmacsHandler |
|
1013 | 1013 | ] |
@@ -1,462 +1,462 b'' | |||
|
1 | 1 | """Tests for various magic functions. |
|
2 | 2 | |
|
3 | 3 | Needs to be run by nose (to make ipython session available). |
|
4 | 4 | """ |
|
5 | 5 | from __future__ import absolute_import |
|
6 | 6 | |
|
7 | 7 | #----------------------------------------------------------------------------- |
|
8 | 8 | # Imports |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | import os |
|
12 | 12 | import sys |
|
13 | 13 | import tempfile |
|
14 | 14 | import types |
|
15 | 15 | from cStringIO import StringIO |
|
16 | 16 | |
|
17 | 17 | import nose.tools as nt |
|
18 | 18 | |
|
19 | 19 | from IPython.utils.path import get_long_path_name |
|
20 | 20 | from IPython.testing import decorators as dec |
|
21 | 21 | from IPython.testing import tools as tt |
|
22 | 22 | |
|
23 | 23 | #----------------------------------------------------------------------------- |
|
24 | 24 | # Test functions begin |
|
25 | 25 | #----------------------------------------------------------------------------- |
|
26 | 26 | def test_rehashx(): |
|
27 | 27 | # clear up everything |
|
28 | 28 | _ip = get_ipython() |
|
29 | 29 | _ip.alias_manager.alias_table.clear() |
|
30 | 30 | del _ip.db['syscmdlist'] |
|
31 | 31 | |
|
32 | 32 | _ip.magic('rehashx') |
|
33 | 33 | # Practically ALL ipython development systems will have more than 10 aliases |
|
34 | 34 | |
|
35 | 35 | yield (nt.assert_true, len(_ip.alias_manager.alias_table) > 10) |
|
36 | 36 | for key, val in _ip.alias_manager.alias_table.iteritems(): |
|
37 | 37 | # we must strip dots from alias names |
|
38 | 38 | nt.assert_true('.' not in key) |
|
39 | 39 | |
|
40 | 40 | # rehashx must fill up syscmdlist |
|
41 | 41 | scoms = _ip.db['syscmdlist'] |
|
42 | 42 | yield (nt.assert_true, len(scoms) > 10) |
|
43 | 43 | |
|
44 | 44 | |
|
45 | 45 | def test_magic_parse_options(): |
|
46 | 46 | """Test that we don't mangle paths when parsing magic options.""" |
|
47 | 47 | ip = get_ipython() |
|
48 | 48 | path = 'c:\\x' |
|
49 | 49 | opts = ip.parse_options('-f %s' % path,'f:')[0] |
|
50 | 50 | # argv splitting is os-dependent |
|
51 | 51 | if os.name == 'posix': |
|
52 | 52 | expected = 'c:x' |
|
53 | 53 | else: |
|
54 | 54 | expected = path |
|
55 | 55 | nt.assert_equals(opts['f'], expected) |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | def doctest_hist_f(): |
|
59 | 59 | """Test %hist -f with temporary filename. |
|
60 | 60 | |
|
61 | 61 | In [9]: import tempfile |
|
62 | 62 | |
|
63 | 63 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
64 | 64 | |
|
65 | 65 | In [11]: %hist -nl -f $tfile 3 |
|
66 | 66 | |
|
67 | 67 | In [13]: import os; os.unlink(tfile) |
|
68 | 68 | """ |
|
69 | 69 | |
|
70 | 70 | |
|
71 | 71 | def doctest_hist_r(): |
|
72 | 72 | """Test %hist -r |
|
73 | 73 | |
|
74 | 74 | XXX - This test is not recording the output correctly. For some reason, in |
|
75 | 75 | testing mode the raw history isn't getting populated. No idea why. |
|
76 | 76 | Disabling the output checking for now, though at least we do run it. |
|
77 | 77 | |
|
78 | 78 | In [1]: 'hist' in _ip.lsmagic() |
|
79 | 79 | Out[1]: True |
|
80 | 80 | |
|
81 | 81 | In [2]: x=1 |
|
82 | 82 | |
|
83 | 83 | In [3]: %hist -rl 2 |
|
84 | 84 | x=1 # random |
|
85 | 85 | %hist -r 2 |
|
86 | 86 | """ |
|
87 | 87 | |
|
88 | 88 | def doctest_hist_op(): |
|
89 | 89 | """Test %hist -op |
|
90 | 90 | |
|
91 | 91 | In [1]: class b: |
|
92 | 92 | ...: pass |
|
93 | 93 | ...: |
|
94 | 94 | |
|
95 | 95 | In [2]: class s(b): |
|
96 | 96 | ...: def __str__(self): |
|
97 | 97 | ...: return 's' |
|
98 | 98 | ...: |
|
99 | 99 | |
|
100 | 100 | In [3]: |
|
101 | 101 | |
|
102 | 102 | In [4]: class r(b): |
|
103 | 103 | ...: def __repr__(self): |
|
104 | 104 | ...: return 'r' |
|
105 | 105 | ...: |
|
106 | 106 | |
|
107 | 107 | In [5]: class sr(s,r): pass |
|
108 | 108 | ...: |
|
109 | 109 | |
|
110 | 110 | In [6]: |
|
111 | 111 | |
|
112 | 112 | In [7]: bb=b() |
|
113 | 113 | |
|
114 | 114 | In [8]: ss=s() |
|
115 | 115 | |
|
116 | 116 | In [9]: rr=r() |
|
117 | 117 | |
|
118 | 118 | In [10]: ssrr=sr() |
|
119 | 119 | |
|
120 | 120 | In [11]: bb |
|
121 | 121 | Out[11]: <...b instance at ...> |
|
122 | 122 | |
|
123 | 123 | In [12]: ss |
|
124 | 124 | Out[12]: <...s instance at ...> |
|
125 | 125 | |
|
126 | 126 | In [13]: |
|
127 | 127 | |
|
128 | 128 | In [14]: %hist -op |
|
129 | 129 | >>> class b: |
|
130 | 130 | ... pass |
|
131 | 131 | ... |
|
132 | 132 | >>> class s(b): |
|
133 | 133 | ... def __str__(self): |
|
134 | 134 | ... return 's' |
|
135 | 135 | ... |
|
136 | 136 | >>> |
|
137 | 137 | >>> class r(b): |
|
138 | 138 | ... def __repr__(self): |
|
139 | 139 | ... return 'r' |
|
140 | 140 | ... |
|
141 | 141 | >>> class sr(s,r): pass |
|
142 | 142 | >>> |
|
143 | 143 | >>> bb=b() |
|
144 | 144 | >>> ss=s() |
|
145 | 145 | >>> rr=r() |
|
146 | 146 | >>> ssrr=sr() |
|
147 | 147 | >>> bb |
|
148 | 148 | <...b instance at ...> |
|
149 | 149 | >>> ss |
|
150 | 150 | <...s instance at ...> |
|
151 | 151 | >>> |
|
152 | 152 | """ |
|
153 | 153 | |
|
154 | 154 | def test_macro(): |
|
155 | 155 | ip = get_ipython() |
|
156 | 156 | ip.history_manager.reset() # Clear any existing history. |
|
157 | 157 | cmds = ["a=1", "def b():\n return a**2", "print(a,b())"] |
|
158 | 158 | for i, cmd in enumerate(cmds, start=1): |
|
159 | 159 | ip.history_manager.store_inputs(i, cmd) |
|
160 | 160 | ip.magic("macro test 1-3") |
|
161 | 161 | nt.assert_equal(ip.user_ns["test"].value, "\n".join(cmds)+"\n") |
|
162 | 162 | |
|
163 | 163 | # List macros. |
|
164 | 164 | assert "test" in ip.magic("macro") |
|
165 | 165 | |
|
166 | 166 | def test_macro_run(): |
|
167 | 167 | """Test that we can run a multi-line macro successfully.""" |
|
168 | 168 | ip = get_ipython() |
|
169 | 169 | ip.history_manager.reset() |
|
170 | 170 | cmds = ["a=10", "a+=1", "print a", "%macro test 2-3"] |
|
171 | 171 | for cmd in cmds: |
|
172 | 172 | ip.run_cell(cmd) |
|
173 | 173 | nt.assert_equal(ip.user_ns["test"].value, "a+=1\nprint a\n") |
|
174 | 174 | original_stdout = sys.stdout |
|
175 | 175 | new_stdout = StringIO() |
|
176 | 176 | sys.stdout = new_stdout |
|
177 | 177 | try: |
|
178 | 178 | ip.run_cell("test") |
|
179 | 179 | nt.assert_true("12" in new_stdout.getvalue()) |
|
180 | 180 | ip.run_cell("test") |
|
181 | 181 | nt.assert_true("13" in new_stdout.getvalue()) |
|
182 | 182 | finally: |
|
183 | 183 | sys.stdout = original_stdout |
|
184 | 184 | new_stdout.close() |
|
185 | 185 | |
|
186 | 186 | |
|
187 | 187 | # XXX failing for now, until we get clearcmd out of quarantine. But we should |
|
188 | 188 | # fix this and revert the skip to happen only if numpy is not around. |
|
189 | 189 | #@dec.skipif_not_numpy |
|
190 | 190 | @dec.skip_known_failure |
|
191 | 191 | def test_numpy_clear_array_undec(): |
|
192 | 192 | from IPython.extensions import clearcmd |
|
193 | 193 | |
|
194 | 194 | _ip.ex('import numpy as np') |
|
195 | 195 | _ip.ex('a = np.empty(2)') |
|
196 | 196 | yield (nt.assert_true, 'a' in _ip.user_ns) |
|
197 | 197 | _ip.magic('clear array') |
|
198 | 198 | yield (nt.assert_false, 'a' in _ip.user_ns) |
|
199 | 199 | |
|
200 | 200 | |
|
201 | 201 | # Multiple tests for clipboard pasting |
|
202 | 202 | @dec.parametric |
|
203 | 203 | def test_paste(): |
|
204 | 204 | _ip = get_ipython() |
|
205 | 205 | def paste(txt, flags='-q'): |
|
206 | 206 | """Paste input text, by default in quiet mode""" |
|
207 | 207 | hooks.clipboard_get = lambda : txt |
|
208 | 208 | _ip.magic('paste '+flags) |
|
209 | 209 | |
|
210 | 210 | # Inject fake clipboard hook but save original so we can restore it later |
|
211 | 211 | hooks = _ip.hooks |
|
212 | 212 | user_ns = _ip.user_ns |
|
213 | 213 | original_clip = hooks.clipboard_get |
|
214 | 214 | |
|
215 | 215 | try: |
|
216 | 216 | # This try/except with an emtpy except clause is here only because |
|
217 | 217 | # try/yield/finally is invalid syntax in Python 2.4. This will be |
|
218 | 218 | # removed when we drop 2.4-compatibility, and the emtpy except below |
|
219 | 219 | # will be changed to a finally. |
|
220 | 220 | |
|
221 | 221 | # Run tests with fake clipboard function |
|
222 | 222 | user_ns.pop('x', None) |
|
223 | 223 | paste('x=1') |
|
224 | 224 | yield nt.assert_equal(user_ns['x'], 1) |
|
225 | 225 | |
|
226 | 226 | user_ns.pop('x', None) |
|
227 | 227 | paste('>>> x=2') |
|
228 | 228 | yield nt.assert_equal(user_ns['x'], 2) |
|
229 | 229 | |
|
230 | 230 | paste(""" |
|
231 | 231 | >>> x = [1,2,3] |
|
232 | 232 | >>> y = [] |
|
233 | 233 | >>> for i in x: |
|
234 | 234 | ... y.append(i**2) |
|
235 | 235 | ... |
|
236 | 236 | """) |
|
237 | 237 | yield nt.assert_equal(user_ns['x'], [1,2,3]) |
|
238 | 238 | yield nt.assert_equal(user_ns['y'], [1,4,9]) |
|
239 | 239 | |
|
240 | 240 | # Now, test that paste -r works |
|
241 | 241 | user_ns.pop('x', None) |
|
242 | 242 | yield nt.assert_false('x' in user_ns) |
|
243 | 243 | _ip.magic('paste -r') |
|
244 | 244 | yield nt.assert_equal(user_ns['x'], [1,2,3]) |
|
245 | 245 | |
|
246 | 246 | # Also test paste echoing, by temporarily faking the writer |
|
247 | 247 | w = StringIO() |
|
248 | 248 | writer = _ip.write |
|
249 | 249 | _ip.write = w.write |
|
250 | 250 | code = """ |
|
251 | 251 | a = 100 |
|
252 | 252 | b = 200""" |
|
253 | 253 | try: |
|
254 | 254 | paste(code,'') |
|
255 | 255 | out = w.getvalue() |
|
256 | 256 | finally: |
|
257 | 257 | _ip.write = writer |
|
258 | 258 | yield nt.assert_equal(user_ns['a'], 100) |
|
259 | 259 | yield nt.assert_equal(user_ns['b'], 200) |
|
260 | 260 | yield nt.assert_equal(out, code+"\n## -- End pasted text --\n") |
|
261 | 261 | |
|
262 | 262 | finally: |
|
263 | 263 | # This should be in a finally clause, instead of the bare except above. |
|
264 | 264 | # Restore original hook |
|
265 | 265 | hooks.clipboard_get = original_clip |
|
266 | 266 | |
|
267 | 267 | |
|
268 | 268 | def test_time(): |
|
269 | 269 | _ip.magic('time None') |
|
270 | 270 | |
|
271 | 271 | |
|
272 | 272 | def doctest_time(): |
|
273 | 273 | """ |
|
274 | 274 | In [10]: %time None |
|
275 | 275 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
276 | 276 | Wall time: 0.00 s |
|
277 | 277 | |
|
278 | 278 | In [11]: def f(kmjy): |
|
279 | 279 | ....: %time print 2*kmjy |
|
280 | 280 | |
|
281 | 281 | In [12]: f(3) |
|
282 | 282 | 6 |
|
283 | 283 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
284 | 284 | Wall time: 0.00 s |
|
285 | 285 | """ |
|
286 | 286 | |
|
287 | 287 | |
|
288 | 288 | def test_doctest_mode(): |
|
289 | 289 | "Toggle doctest_mode twice, it should be a no-op and run without error" |
|
290 | 290 | _ip.magic('doctest_mode') |
|
291 | 291 | _ip.magic('doctest_mode') |
|
292 | 292 | |
|
293 | 293 | |
|
294 | 294 | def test_parse_options(): |
|
295 | 295 | """Tests for basic options parsing in magics.""" |
|
296 | 296 | # These are only the most minimal of tests, more should be added later. At |
|
297 | 297 | # the very least we check that basic text/unicode calls work OK. |
|
298 | 298 | nt.assert_equal(_ip.parse_options('foo', '')[1], 'foo') |
|
299 | 299 | nt.assert_equal(_ip.parse_options(u'foo', '')[1], u'foo') |
|
300 | 300 | |
|
301 | 301 | |
|
302 | 302 | def test_dirops(): |
|
303 | 303 | """Test various directory handling operations.""" |
|
304 | 304 | curpath = lambda :os.path.splitdrive(os.getcwdu())[1].replace('\\','/') |
|
305 | 305 | |
|
306 | 306 | startdir = os.getcwdu() |
|
307 | 307 | ipdir = _ip.ipython_dir |
|
308 | 308 | try: |
|
309 | 309 | _ip.magic('cd "%s"' % ipdir) |
|
310 | 310 | nt.assert_equal(curpath(), ipdir) |
|
311 | 311 | _ip.magic('cd -') |
|
312 | 312 | nt.assert_equal(curpath(), startdir) |
|
313 | 313 | _ip.magic('pushd "%s"' % ipdir) |
|
314 | 314 | nt.assert_equal(curpath(), ipdir) |
|
315 | 315 | _ip.magic('popd') |
|
316 | 316 | nt.assert_equal(curpath(), startdir) |
|
317 | 317 | finally: |
|
318 | 318 | os.chdir(startdir) |
|
319 | 319 | |
|
320 | 320 | |
|
321 | 321 | def check_cpaste(code, should_fail=False): |
|
322 | 322 | """Execute code via 'cpaste' and ensure it was executed, unless |
|
323 | 323 | should_fail is set. |
|
324 | 324 | """ |
|
325 | 325 | _ip.user_ns['code_ran'] = False |
|
326 | 326 | |
|
327 | 327 | src = StringIO() |
|
328 | 328 | src.write('\n') |
|
329 | 329 | src.write(code) |
|
330 | 330 | src.write('\n--\n') |
|
331 | 331 | src.seek(0) |
|
332 | 332 | |
|
333 | 333 | stdin_save = sys.stdin |
|
334 | 334 | sys.stdin = src |
|
335 | 335 | |
|
336 | 336 | try: |
|
337 | 337 | _ip.magic('cpaste') |
|
338 | 338 | except: |
|
339 | 339 | if not should_fail: |
|
340 | 340 | raise AssertionError("Failure not expected : '%s'" % |
|
341 | 341 | code) |
|
342 | 342 | else: |
|
343 | 343 | assert _ip.user_ns['code_ran'] |
|
344 | 344 | if should_fail: |
|
345 | 345 | raise AssertionError("Failure expected : '%s'" % code) |
|
346 | 346 | finally: |
|
347 | 347 | sys.stdin = stdin_save |
|
348 | 348 | |
|
349 | 349 | |
|
350 | 350 | def test_cpaste(): |
|
351 | 351 | """Test cpaste magic""" |
|
352 | 352 | |
|
353 | 353 | def run(): |
|
354 | 354 | """Marker function: sets a flag when executed. |
|
355 | 355 | """ |
|
356 | 356 | _ip.user_ns['code_ran'] = True |
|
357 | 357 | return 'run' # return string so '+ run()' doesn't result in success |
|
358 | 358 | |
|
359 | 359 | tests = {'pass': ["> > > run()", |
|
360 | 360 | ">>> > run()", |
|
361 | 361 | "+++ run()", |
|
362 | 362 | "++ run()", |
|
363 | 363 | " >>> run()"], |
|
364 | 364 | |
|
365 | 365 | 'fail': ["+ + run()", |
|
366 | 366 | " ++ run()"]} |
|
367 | 367 | |
|
368 | 368 | _ip.user_ns['run'] = run |
|
369 | 369 | |
|
370 | 370 | for code in tests['pass']: |
|
371 | 371 | check_cpaste(code) |
|
372 | 372 | |
|
373 | 373 | for code in tests['fail']: |
|
374 | 374 | check_cpaste(code, should_fail=True) |
|
375 | 375 | |
|
376 | 376 | def test_xmode(): |
|
377 | 377 | # Calling xmode three times should be a no-op |
|
378 | 378 | xmode = _ip.InteractiveTB.mode |
|
379 | 379 | for i in range(3): |
|
380 | 380 | _ip.magic("xmode") |
|
381 | 381 | nt.assert_equal(_ip.InteractiveTB.mode, xmode) |
|
382 | 382 | |
|
383 | 383 | def test_reset_hard(): |
|
384 | 384 | monitor = [] |
|
385 | 385 | class A(object): |
|
386 | 386 | def __del__(self): |
|
387 | 387 | monitor.append(1) |
|
388 | 388 | def __repr__(self): |
|
389 | 389 | return "<A instance>" |
|
390 | 390 | |
|
391 | 391 | _ip.user_ns["a"] = A() |
|
392 | 392 | _ip.run_cell("a") |
|
393 | 393 | |
|
394 | 394 | nt.assert_equal(monitor, []) |
|
395 | 395 | _ip.magic_reset("-f") |
|
396 | 396 | nt.assert_equal(monitor, [1]) |
|
397 | 397 | |
|
398 | 398 | class TestXdel(tt.TempFileMixin): |
|
399 | 399 | def test_xdel(self): |
|
400 | 400 | """Test that references from %run are cleared by xdel.""" |
|
401 | 401 | src = ("class A(object):\n" |
|
402 | 402 | " monitor = []\n" |
|
403 | 403 | " def __del__(self):\n" |
|
404 | 404 | " self.monitor.append(1)\n" |
|
405 | 405 | "a = A()\n") |
|
406 | 406 | self.mktmp(src) |
|
407 | 407 | # %run creates some hidden references... |
|
408 | 408 | _ip.magic("run %s" % self.fname) |
|
409 | 409 | # ... as does the displayhook. |
|
410 | 410 | _ip.run_cell("a") |
|
411 | 411 | |
|
412 | 412 | monitor = _ip.user_ns["A"].monitor |
|
413 | 413 | nt.assert_equal(monitor, []) |
|
414 | 414 | |
|
415 | 415 | _ip.magic("xdel a") |
|
416 | 416 | |
|
417 | 417 | # Check that a's __del__ method has been called. |
|
418 | 418 | nt.assert_equal(monitor, [1]) |
|
419 | 419 | |
|
420 | 420 | def doctest_who(): |
|
421 | 421 | """doctest for %who |
|
422 | 422 | |
|
423 | 423 | In [1]: %reset -f |
|
424 | 424 | |
|
425 | 425 | In [2]: alpha = 123 |
|
426 | 426 | |
|
427 | 427 | In [3]: beta = 'beta' |
|
428 | 428 | |
|
429 | 429 | In [4]: %who int |
|
430 | 430 | alpha |
|
431 | 431 | |
|
432 | 432 | In [5]: %who str |
|
433 | 433 | beta |
|
434 | 434 | |
|
435 | 435 | In [6]: %whos |
|
436 | 436 | Variable Type Data/Info |
|
437 | 437 | ---------------------------- |
|
438 | 438 | alpha int 123 |
|
439 | 439 | beta str beta |
|
440 | 440 | |
|
441 | 441 | In [7]: %who_ls |
|
442 | 442 | Out[7]: ['alpha', 'beta'] |
|
443 | 443 | """ |
|
444 | 444 | |
|
445 | 445 | def doctest_precision(): |
|
446 | 446 | """doctest for %precision |
|
447 | 447 | |
|
448 | 448 | In [1]: f = get_ipython().shell.display_formatter.formatters['text/plain'] |
|
449 | 449 | |
|
450 | 450 | In [2]: %precision 5 |
|
451 | Out[2]: '%.5f' | |
|
451 | Out[2]: u'%.5f' | |
|
452 | 452 | |
|
453 | 453 | In [3]: f.float_format |
|
454 | Out[3]: '%.5f' | |
|
454 | Out[3]: u'%.5f' | |
|
455 | 455 | |
|
456 | 456 | In [4]: %precision %e |
|
457 | Out[4]: '%e' | |
|
457 | Out[4]: u'%e' | |
|
458 | 458 | |
|
459 | 459 | In [5]: f(3.1415927) |
|
460 | Out[5]: '3.141593e+00' | |
|
460 | Out[5]: u'3.141593e+00' | |
|
461 | 461 | """ |
|
462 | 462 |
@@ -1,511 +1,510 b'' | |||
|
1 | 1 | """ A FrontendWidget that emulates the interface of the console IPython and |
|
2 | 2 | supports the additional functionality provided by the IPython kernel. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | # Imports |
|
7 | 7 | #----------------------------------------------------------------------------- |
|
8 | 8 | |
|
9 | 9 | # Standard library imports |
|
10 | 10 | from collections import namedtuple |
|
11 | 11 | import os.path |
|
12 | 12 | import re |
|
13 | 13 | from subprocess import Popen |
|
14 | 14 | import sys |
|
15 | 15 | from textwrap import dedent |
|
16 | 16 | |
|
17 | 17 | # System library imports |
|
18 | 18 | from IPython.external.qt import QtCore, QtGui |
|
19 | 19 | |
|
20 | 20 | # Local imports |
|
21 | 21 | from IPython.core.inputsplitter import IPythonInputSplitter, \ |
|
22 | 22 | transform_ipy_prompt |
|
23 | 23 | from IPython.core.usage import default_gui_banner |
|
24 |
from IPython.utils.traitlets import Bool, |
|
|
24 | from IPython.utils.traitlets import Bool, Unicode | |
|
25 | 25 | from frontend_widget import FrontendWidget |
|
26 | 26 | import styles |
|
27 | 27 | |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | # Constants |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | |
|
32 | 32 | # Default strings to build and display input and output prompts (and separators |
|
33 | 33 | # in between) |
|
34 | 34 | default_in_prompt = 'In [<span class="in-prompt-number">%i</span>]: ' |
|
35 | 35 | default_out_prompt = 'Out[<span class="out-prompt-number">%i</span>]: ' |
|
36 | 36 | default_input_sep = '\n' |
|
37 | 37 | default_output_sep = '' |
|
38 | 38 | default_output_sep2 = '' |
|
39 | 39 | |
|
40 | 40 | # Base path for most payload sources. |
|
41 | 41 | zmq_shell_source = 'IPython.zmq.zmqshell.ZMQInteractiveShell' |
|
42 | 42 | |
|
43 | 43 | if sys.platform.startswith('win'): |
|
44 | 44 | default_editor = 'notepad' |
|
45 | 45 | else: |
|
46 | 46 | default_editor = '' |
|
47 | 47 | |
|
48 | 48 | #----------------------------------------------------------------------------- |
|
49 | 49 | # IPythonWidget class |
|
50 | 50 | #----------------------------------------------------------------------------- |
|
51 | 51 | |
|
52 | 52 | class IPythonWidget(FrontendWidget): |
|
53 | 53 | """ A FrontendWidget for an IPython kernel. |
|
54 | 54 | """ |
|
55 | 55 | |
|
56 | 56 | # If set, the 'custom_edit_requested(str, int)' signal will be emitted when |
|
57 | 57 | # an editor is needed for a file. This overrides 'editor' and 'editor_line' |
|
58 | 58 | # settings. |
|
59 | 59 | custom_edit = Bool(False) |
|
60 | 60 | custom_edit_requested = QtCore.Signal(object, object) |
|
61 | 61 | |
|
62 | 62 | editor = Unicode(default_editor, config=True, |
|
63 | 63 | help=""" |
|
64 | 64 | A command for invoking a system text editor. If the string contains a |
|
65 | 65 | {filename} format specifier, it will be used. Otherwise, the filename |
|
66 | 66 | will be appended to the end the command. |
|
67 | 67 | """) |
|
68 | 68 | |
|
69 | 69 | editor_line = Unicode(config=True, |
|
70 | 70 | help=""" |
|
71 | 71 | The editor command to use when a specific line number is requested. The |
|
72 | 72 | string should contain two format specifiers: {line} and {filename}. If |
|
73 | 73 | this parameter is not specified, the line number option to the %edit |
|
74 | 74 | magic will be ignored. |
|
75 | 75 | """) |
|
76 | 76 | |
|
77 | 77 | style_sheet = Unicode(config=True, |
|
78 | 78 | help=""" |
|
79 | 79 | A CSS stylesheet. The stylesheet can contain classes for: |
|
80 | 80 | 1. Qt: QPlainTextEdit, QFrame, QWidget, etc |
|
81 | 81 | 2. Pygments: .c, .k, .o, etc. (see PygmentsHighlighter) |
|
82 | 82 | 3. IPython: .error, .in-prompt, .out-prompt, etc |
|
83 | 83 | """) |
|
84 | 84 | |
|
85 | ||
|
86 | syntax_style = Str(config=True, | |
|
85 | syntax_style = Unicode(config=True, | |
|
87 | 86 | help=""" |
|
88 | 87 | If not empty, use this Pygments style for syntax highlighting. |
|
89 | 88 | Otherwise, the style sheet is queried for Pygments style |
|
90 | 89 | information. |
|
91 | 90 | """) |
|
92 | 91 | |
|
93 | 92 | # Prompts. |
|
94 |
in_prompt = |
|
|
95 |
out_prompt = |
|
|
96 |
input_sep = |
|
|
97 |
output_sep = |
|
|
98 |
output_sep2 = |
|
|
93 | in_prompt = Unicode(default_in_prompt, config=True) | |
|
94 | out_prompt = Unicode(default_out_prompt, config=True) | |
|
95 | input_sep = Unicode(default_input_sep, config=True) | |
|
96 | output_sep = Unicode(default_output_sep, config=True) | |
|
97 | output_sep2 = Unicode(default_output_sep2, config=True) | |
|
99 | 98 | |
|
100 | 99 | # FrontendWidget protected class variables. |
|
101 | 100 | _input_splitter_class = IPythonInputSplitter |
|
102 | 101 | |
|
103 | 102 | # IPythonWidget protected class variables. |
|
104 | 103 | _PromptBlock = namedtuple('_PromptBlock', ['block', 'length', 'number']) |
|
105 | 104 | _payload_source_edit = zmq_shell_source + '.edit_magic' |
|
106 | 105 | _payload_source_exit = zmq_shell_source + '.ask_exit' |
|
107 | 106 | _payload_source_next_input = zmq_shell_source + '.set_next_input' |
|
108 | 107 | _payload_source_page = 'IPython.zmq.page.page' |
|
109 | 108 | |
|
110 | 109 | #--------------------------------------------------------------------------- |
|
111 | 110 | # 'object' interface |
|
112 | 111 | #--------------------------------------------------------------------------- |
|
113 | 112 | |
|
114 | 113 | def __init__(self, *args, **kw): |
|
115 | 114 | super(IPythonWidget, self).__init__(*args, **kw) |
|
116 | 115 | |
|
117 | 116 | # IPythonWidget protected variables. |
|
118 | 117 | self._payload_handlers = { |
|
119 | 118 | self._payload_source_edit : self._handle_payload_edit, |
|
120 | 119 | self._payload_source_exit : self._handle_payload_exit, |
|
121 | 120 | self._payload_source_page : self._handle_payload_page, |
|
122 | 121 | self._payload_source_next_input : self._handle_payload_next_input } |
|
123 | 122 | self._previous_prompt_obj = None |
|
124 | 123 | self._keep_kernel_on_exit = None |
|
125 | 124 | |
|
126 | 125 | # Initialize widget styling. |
|
127 | 126 | if self.style_sheet: |
|
128 | 127 | self._style_sheet_changed() |
|
129 | 128 | self._syntax_style_changed() |
|
130 | 129 | else: |
|
131 | 130 | self.set_default_style() |
|
132 | 131 | |
|
133 | 132 | #--------------------------------------------------------------------------- |
|
134 | 133 | # 'BaseFrontendMixin' abstract interface |
|
135 | 134 | #--------------------------------------------------------------------------- |
|
136 | 135 | |
|
137 | 136 | def _handle_complete_reply(self, rep): |
|
138 | 137 | """ Reimplemented to support IPython's improved completion machinery. |
|
139 | 138 | """ |
|
140 | 139 | cursor = self._get_cursor() |
|
141 | 140 | info = self._request_info.get('complete') |
|
142 | 141 | if info and info.id == rep['parent_header']['msg_id'] and \ |
|
143 | 142 | info.pos == cursor.position(): |
|
144 | 143 | matches = rep['content']['matches'] |
|
145 | 144 | text = rep['content']['matched_text'] |
|
146 | 145 | offset = len(text) |
|
147 | 146 | |
|
148 | 147 | # Clean up matches with period and path separators if the matched |
|
149 | 148 | # text has not been transformed. This is done by truncating all |
|
150 | 149 | # but the last component and then suitably decreasing the offset |
|
151 | 150 | # between the current cursor position and the start of completion. |
|
152 | 151 | if len(matches) > 1 and matches[0][:offset] == text: |
|
153 | 152 | parts = re.split(r'[./\\]', text) |
|
154 | 153 | sep_count = len(parts) - 1 |
|
155 | 154 | if sep_count: |
|
156 | 155 | chop_length = sum(map(len, parts[:sep_count])) + sep_count |
|
157 | 156 | matches = [ match[chop_length:] for match in matches ] |
|
158 | 157 | offset -= chop_length |
|
159 | 158 | |
|
160 | 159 | # Move the cursor to the start of the match and complete. |
|
161 | 160 | cursor.movePosition(QtGui.QTextCursor.Left, n=offset) |
|
162 | 161 | self._complete_with_items(cursor, matches) |
|
163 | 162 | |
|
164 | 163 | def _handle_execute_reply(self, msg): |
|
165 | 164 | """ Reimplemented to support prompt requests. |
|
166 | 165 | """ |
|
167 | 166 | info = self._request_info.get('execute') |
|
168 | 167 | if info and info.id == msg['parent_header']['msg_id']: |
|
169 | 168 | if info.kind == 'prompt': |
|
170 | 169 | number = msg['content']['execution_count'] + 1 |
|
171 | 170 | self._show_interpreter_prompt(number) |
|
172 | 171 | else: |
|
173 | 172 | super(IPythonWidget, self)._handle_execute_reply(msg) |
|
174 | 173 | |
|
175 | 174 | def _handle_history_reply(self, msg): |
|
176 | 175 | """ Implemented to handle history tail replies, which are only supported |
|
177 | 176 | by the IPython kernel. |
|
178 | 177 | """ |
|
179 | 178 | history_items = msg['content']['history'] |
|
180 | 179 | items = [ line.rstrip() for _, _, line in history_items ] |
|
181 | 180 | self._set_history(items) |
|
182 | 181 | |
|
183 | 182 | def _handle_pyout(self, msg): |
|
184 | 183 | """ Reimplemented for IPython-style "display hook". |
|
185 | 184 | """ |
|
186 | 185 | if not self._hidden and self._is_from_this_session(msg): |
|
187 | 186 | content = msg['content'] |
|
188 | 187 | prompt_number = content['execution_count'] |
|
189 | 188 | data = content['data'] |
|
190 | 189 | if data.has_key('text/html'): |
|
191 | 190 | self._append_plain_text(self.output_sep, True) |
|
192 | 191 | self._append_html(self._make_out_prompt(prompt_number), True) |
|
193 | 192 | html = data['text/html'] |
|
194 | 193 | self._append_plain_text('\n', True) |
|
195 | 194 | self._append_html(html + self.output_sep2, True) |
|
196 | 195 | elif data.has_key('text/plain'): |
|
197 | 196 | self._append_plain_text(self.output_sep, True) |
|
198 | 197 | self._append_html(self._make_out_prompt(prompt_number), True) |
|
199 | 198 | text = data['text/plain'] |
|
200 | 199 | # If the repr is multiline, make sure we start on a new line, |
|
201 | 200 | # so that its lines are aligned. |
|
202 | 201 | if "\n" in text and not self.output_sep.endswith("\n"): |
|
203 | 202 | self._append_plain_text('\n', True) |
|
204 | 203 | self._append_plain_text(text + self.output_sep2, True) |
|
205 | 204 | |
|
206 | 205 | def _handle_display_data(self, msg): |
|
207 | 206 | """ The base handler for the ``display_data`` message. |
|
208 | 207 | """ |
|
209 | 208 | # For now, we don't display data from other frontends, but we |
|
210 | 209 | # eventually will as this allows all frontends to monitor the display |
|
211 | 210 | # data. But we need to figure out how to handle this in the GUI. |
|
212 | 211 | if not self._hidden and self._is_from_this_session(msg): |
|
213 | 212 | source = msg['content']['source'] |
|
214 | 213 | data = msg['content']['data'] |
|
215 | 214 | metadata = msg['content']['metadata'] |
|
216 | 215 | # In the regular IPythonWidget, we simply print the plain text |
|
217 | 216 | # representation. |
|
218 | 217 | if data.has_key('text/html'): |
|
219 | 218 | html = data['text/html'] |
|
220 | 219 | self._append_html(html, True) |
|
221 | 220 | elif data.has_key('text/plain'): |
|
222 | 221 | text = data['text/plain'] |
|
223 | 222 | self._append_plain_text(text, True) |
|
224 | 223 | # This newline seems to be needed for text and html output. |
|
225 | 224 | self._append_plain_text(u'\n', True) |
|
226 | 225 | |
|
227 | 226 | def _started_channels(self): |
|
228 | 227 | """ Reimplemented to make a history request. |
|
229 | 228 | """ |
|
230 | 229 | super(IPythonWidget, self)._started_channels() |
|
231 | 230 | self.kernel_manager.shell_channel.history(hist_access_type='tail', |
|
232 | 231 | n=1000) |
|
233 | 232 | #--------------------------------------------------------------------------- |
|
234 | 233 | # 'ConsoleWidget' public interface |
|
235 | 234 | #--------------------------------------------------------------------------- |
|
236 | 235 | |
|
237 | 236 | def copy(self): |
|
238 | 237 | """ Copy the currently selected text to the clipboard, removing prompts |
|
239 | 238 | if possible. |
|
240 | 239 | """ |
|
241 | 240 | text = self._control.textCursor().selection().toPlainText() |
|
242 | 241 | if text: |
|
243 | 242 | lines = map(transform_ipy_prompt, text.splitlines()) |
|
244 | 243 | text = '\n'.join(lines) |
|
245 | 244 | QtGui.QApplication.clipboard().setText(text) |
|
246 | 245 | |
|
247 | 246 | #--------------------------------------------------------------------------- |
|
248 | 247 | # 'FrontendWidget' public interface |
|
249 | 248 | #--------------------------------------------------------------------------- |
|
250 | 249 | |
|
251 | 250 | def execute_file(self, path, hidden=False): |
|
252 | 251 | """ Reimplemented to use the 'run' magic. |
|
253 | 252 | """ |
|
254 | 253 | # Use forward slashes on Windows to avoid escaping each separator. |
|
255 | 254 | if sys.platform == 'win32': |
|
256 | 255 | path = os.path.normpath(path).replace('\\', '/') |
|
257 | 256 | |
|
258 | 257 | self.execute('%%run %s' % path, hidden=hidden) |
|
259 | 258 | |
|
260 | 259 | #--------------------------------------------------------------------------- |
|
261 | 260 | # 'FrontendWidget' protected interface |
|
262 | 261 | #--------------------------------------------------------------------------- |
|
263 | 262 | |
|
264 | 263 | def _complete(self): |
|
265 | 264 | """ Reimplemented to support IPython's improved completion machinery. |
|
266 | 265 | """ |
|
267 | 266 | # We let the kernel split the input line, so we *always* send an empty |
|
268 | 267 | # text field. Readline-based frontends do get a real text field which |
|
269 | 268 | # they can use. |
|
270 | 269 | text = '' |
|
271 | 270 | |
|
272 | 271 | # Send the completion request to the kernel |
|
273 | 272 | msg_id = self.kernel_manager.shell_channel.complete( |
|
274 | 273 | text, # text |
|
275 | 274 | self._get_input_buffer_cursor_line(), # line |
|
276 | 275 | self._get_input_buffer_cursor_column(), # cursor_pos |
|
277 | 276 | self.input_buffer) # block |
|
278 | 277 | pos = self._get_cursor().position() |
|
279 | 278 | info = self._CompletionRequest(msg_id, pos) |
|
280 | 279 | self._request_info['complete'] = info |
|
281 | 280 | |
|
282 | 281 | def _get_banner(self): |
|
283 | 282 | """ Reimplemented to return IPython's default banner. |
|
284 | 283 | """ |
|
285 | 284 | return default_gui_banner |
|
286 | 285 | |
|
287 | 286 | def _process_execute_error(self, msg): |
|
288 | 287 | """ Reimplemented for IPython-style traceback formatting. |
|
289 | 288 | """ |
|
290 | 289 | content = msg['content'] |
|
291 | 290 | traceback = '\n'.join(content['traceback']) + '\n' |
|
292 | 291 | if False: |
|
293 | 292 | # FIXME: For now, tracebacks come as plain text, so we can't use |
|
294 | 293 | # the html renderer yet. Once we refactor ultratb to produce |
|
295 | 294 | # properly styled tracebacks, this branch should be the default |
|
296 | 295 | traceback = traceback.replace(' ', ' ') |
|
297 | 296 | traceback = traceback.replace('\n', '<br/>') |
|
298 | 297 | |
|
299 | 298 | ename = content['ename'] |
|
300 | 299 | ename_styled = '<span class="error">%s</span>' % ename |
|
301 | 300 | traceback = traceback.replace(ename, ename_styled) |
|
302 | 301 | |
|
303 | 302 | self._append_html(traceback) |
|
304 | 303 | else: |
|
305 | 304 | # This is the fallback for now, using plain text with ansi escapes |
|
306 | 305 | self._append_plain_text(traceback) |
|
307 | 306 | |
|
308 | 307 | def _process_execute_payload(self, item): |
|
309 | 308 | """ Reimplemented to dispatch payloads to handler methods. |
|
310 | 309 | """ |
|
311 | 310 | handler = self._payload_handlers.get(item['source']) |
|
312 | 311 | if handler is None: |
|
313 | 312 | # We have no handler for this type of payload, simply ignore it |
|
314 | 313 | return False |
|
315 | 314 | else: |
|
316 | 315 | handler(item) |
|
317 | 316 | return True |
|
318 | 317 | |
|
319 | 318 | def _show_interpreter_prompt(self, number=None): |
|
320 | 319 | """ Reimplemented for IPython-style prompts. |
|
321 | 320 | """ |
|
322 | 321 | # If a number was not specified, make a prompt number request. |
|
323 | 322 | if number is None: |
|
324 | 323 | msg_id = self.kernel_manager.shell_channel.execute('', silent=True) |
|
325 | 324 | info = self._ExecutionRequest(msg_id, 'prompt') |
|
326 | 325 | self._request_info['execute'] = info |
|
327 | 326 | return |
|
328 | 327 | |
|
329 | 328 | # Show a new prompt and save information about it so that it can be |
|
330 | 329 | # updated later if the prompt number turns out to be wrong. |
|
331 | 330 | self._prompt_sep = self.input_sep |
|
332 | 331 | self._show_prompt(self._make_in_prompt(number), html=True) |
|
333 | 332 | block = self._control.document().lastBlock() |
|
334 | 333 | length = len(self._prompt) |
|
335 | 334 | self._previous_prompt_obj = self._PromptBlock(block, length, number) |
|
336 | 335 | |
|
337 | 336 | # Update continuation prompt to reflect (possibly) new prompt length. |
|
338 | 337 | self._set_continuation_prompt( |
|
339 | 338 | self._make_continuation_prompt(self._prompt), html=True) |
|
340 | 339 | |
|
341 | 340 | def _show_interpreter_prompt_for_reply(self, msg): |
|
342 | 341 | """ Reimplemented for IPython-style prompts. |
|
343 | 342 | """ |
|
344 | 343 | # Update the old prompt number if necessary. |
|
345 | 344 | content = msg['content'] |
|
346 | 345 | previous_prompt_number = content['execution_count'] |
|
347 | 346 | if self._previous_prompt_obj and \ |
|
348 | 347 | self._previous_prompt_obj.number != previous_prompt_number: |
|
349 | 348 | block = self._previous_prompt_obj.block |
|
350 | 349 | |
|
351 | 350 | # Make sure the prompt block has not been erased. |
|
352 | 351 | if block.isValid() and block.text(): |
|
353 | 352 | |
|
354 | 353 | # Remove the old prompt and insert a new prompt. |
|
355 | 354 | cursor = QtGui.QTextCursor(block) |
|
356 | 355 | cursor.movePosition(QtGui.QTextCursor.Right, |
|
357 | 356 | QtGui.QTextCursor.KeepAnchor, |
|
358 | 357 | self._previous_prompt_obj.length) |
|
359 | 358 | prompt = self._make_in_prompt(previous_prompt_number) |
|
360 | 359 | self._prompt = self._insert_html_fetching_plain_text( |
|
361 | 360 | cursor, prompt) |
|
362 | 361 | |
|
363 | 362 | # When the HTML is inserted, Qt blows away the syntax |
|
364 | 363 | # highlighting for the line, so we need to rehighlight it. |
|
365 | 364 | self._highlighter.rehighlightBlock(cursor.block()) |
|
366 | 365 | |
|
367 | 366 | self._previous_prompt_obj = None |
|
368 | 367 | |
|
369 | 368 | # Show a new prompt with the kernel's estimated prompt number. |
|
370 | 369 | self._show_interpreter_prompt(previous_prompt_number + 1) |
|
371 | 370 | |
|
372 | 371 | #--------------------------------------------------------------------------- |
|
373 | 372 | # 'IPythonWidget' interface |
|
374 | 373 | #--------------------------------------------------------------------------- |
|
375 | 374 | |
|
376 | 375 | def set_default_style(self, colors='lightbg'): |
|
377 | 376 | """ Sets the widget style to the class defaults. |
|
378 | 377 | |
|
379 | 378 | Parameters: |
|
380 | 379 | ----------- |
|
381 | 380 | colors : str, optional (default lightbg) |
|
382 | 381 | Whether to use the default IPython light background or dark |
|
383 | 382 | background or B&W style. |
|
384 | 383 | """ |
|
385 | 384 | colors = colors.lower() |
|
386 | 385 | if colors=='lightbg': |
|
387 | 386 | self.style_sheet = styles.default_light_style_sheet |
|
388 | 387 | self.syntax_style = styles.default_light_syntax_style |
|
389 | 388 | elif colors=='linux': |
|
390 | 389 | self.style_sheet = styles.default_dark_style_sheet |
|
391 | 390 | self.syntax_style = styles.default_dark_syntax_style |
|
392 | 391 | elif colors=='nocolor': |
|
393 | 392 | self.style_sheet = styles.default_bw_style_sheet |
|
394 | 393 | self.syntax_style = styles.default_bw_syntax_style |
|
395 | 394 | else: |
|
396 | 395 | raise KeyError("No such color scheme: %s"%colors) |
|
397 | 396 | |
|
398 | 397 | #--------------------------------------------------------------------------- |
|
399 | 398 | # 'IPythonWidget' protected interface |
|
400 | 399 | #--------------------------------------------------------------------------- |
|
401 | 400 | |
|
402 | 401 | def _edit(self, filename, line=None): |
|
403 | 402 | """ Opens a Python script for editing. |
|
404 | 403 | |
|
405 | 404 | Parameters: |
|
406 | 405 | ----------- |
|
407 | 406 | filename : str |
|
408 | 407 | A path to a local system file. |
|
409 | 408 | |
|
410 | 409 | line : int, optional |
|
411 | 410 | A line of interest in the file. |
|
412 | 411 | """ |
|
413 | 412 | if self.custom_edit: |
|
414 | 413 | self.custom_edit_requested.emit(filename, line) |
|
415 | 414 | elif not self.editor: |
|
416 | 415 | self._append_plain_text('No default editor available.\n' |
|
417 | 416 | 'Specify a GUI text editor in the `IPythonWidget.editor` ' |
|
418 | 417 | 'configurable to enable the %edit magic') |
|
419 | 418 | else: |
|
420 | 419 | try: |
|
421 | 420 | filename = '"%s"' % filename |
|
422 | 421 | if line and self.editor_line: |
|
423 | 422 | command = self.editor_line.format(filename=filename, |
|
424 | 423 | line=line) |
|
425 | 424 | else: |
|
426 | 425 | try: |
|
427 | 426 | command = self.editor.format() |
|
428 | 427 | except KeyError: |
|
429 | 428 | command = self.editor.format(filename=filename) |
|
430 | 429 | else: |
|
431 | 430 | command += ' ' + filename |
|
432 | 431 | except KeyError: |
|
433 | 432 | self._append_plain_text('Invalid editor command.\n') |
|
434 | 433 | else: |
|
435 | 434 | try: |
|
436 | 435 | Popen(command, shell=True) |
|
437 | 436 | except OSError: |
|
438 | 437 | msg = 'Opening editor with command "%s" failed.\n' |
|
439 | 438 | self._append_plain_text(msg % command) |
|
440 | 439 | |
|
441 | 440 | def _make_in_prompt(self, number): |
|
442 | 441 | """ Given a prompt number, returns an HTML In prompt. |
|
443 | 442 | """ |
|
444 | 443 | body = self.in_prompt % number |
|
445 | 444 | return '<span class="in-prompt">%s</span>' % body |
|
446 | 445 | |
|
447 | 446 | def _make_continuation_prompt(self, prompt): |
|
448 | 447 | """ Given a plain text version of an In prompt, returns an HTML |
|
449 | 448 | continuation prompt. |
|
450 | 449 | """ |
|
451 | 450 | end_chars = '...: ' |
|
452 | 451 | space_count = len(prompt.lstrip('\n')) - len(end_chars) |
|
453 | 452 | body = ' ' * space_count + end_chars |
|
454 | 453 | return '<span class="in-prompt">%s</span>' % body |
|
455 | 454 | |
|
456 | 455 | def _make_out_prompt(self, number): |
|
457 | 456 | """ Given a prompt number, returns an HTML Out prompt. |
|
458 | 457 | """ |
|
459 | 458 | body = self.out_prompt % number |
|
460 | 459 | return '<span class="out-prompt">%s</span>' % body |
|
461 | 460 | |
|
462 | 461 | #------ Payload handlers -------------------------------------------------- |
|
463 | 462 | |
|
464 | 463 | # Payload handlers with a generic interface: each takes the opaque payload |
|
465 | 464 | # dict, unpacks it and calls the underlying functions with the necessary |
|
466 | 465 | # arguments. |
|
467 | 466 | |
|
468 | 467 | def _handle_payload_edit(self, item): |
|
469 | 468 | self._edit(item['filename'], item['line_number']) |
|
470 | 469 | |
|
471 | 470 | def _handle_payload_exit(self, item): |
|
472 | 471 | self._keep_kernel_on_exit = item['keepkernel'] |
|
473 | 472 | self.exit_requested.emit() |
|
474 | 473 | |
|
475 | 474 | def _handle_payload_next_input(self, item): |
|
476 | 475 | self.input_buffer = dedent(item['text'].rstrip()) |
|
477 | 476 | |
|
478 | 477 | def _handle_payload_page(self, item): |
|
479 | 478 | # Since the plain text widget supports only a very small subset of HTML |
|
480 | 479 | # and we have no control over the HTML source, we only page HTML |
|
481 | 480 | # payloads in the rich text widget. |
|
482 | 481 | if item['html'] and self.kind == 'rich': |
|
483 | 482 | self._page(item['html'], html=True) |
|
484 | 483 | else: |
|
485 | 484 | self._page(item['text'], html=False) |
|
486 | 485 | |
|
487 | 486 | #------ Trait change handlers -------------------------------------------- |
|
488 | 487 | |
|
489 | 488 | def _style_sheet_changed(self): |
|
490 | 489 | """ Set the style sheets of the underlying widgets. |
|
491 | 490 | """ |
|
492 | 491 | self.setStyleSheet(self.style_sheet) |
|
493 | 492 | self._control.document().setDefaultStyleSheet(self.style_sheet) |
|
494 | 493 | if self._page_control: |
|
495 | 494 | self._page_control.document().setDefaultStyleSheet(self.style_sheet) |
|
496 | 495 | |
|
497 | 496 | bg_color = self._control.palette().window().color() |
|
498 | 497 | self._ansi_processor.set_background_color(bg_color) |
|
499 | 498 | |
|
500 | 499 | |
|
501 | 500 | def _syntax_style_changed(self): |
|
502 | 501 | """ Set the style for the syntax highlighter. |
|
503 | 502 | """ |
|
504 | 503 | if self._highlighter is None: |
|
505 | 504 | # ignore premature calls |
|
506 | 505 | return |
|
507 | 506 | if self.syntax_style: |
|
508 | 507 | self._highlighter.set_style(self.syntax_style) |
|
509 | 508 | else: |
|
510 | 509 | self._highlighter.set_style_sheet(self.style_sheet) |
|
511 | 510 |
@@ -1,247 +1,247 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | # encoding: utf-8 |
|
3 | 3 | """ |
|
4 | 4 | An embedded IPython shell. |
|
5 | 5 | |
|
6 | 6 | Authors: |
|
7 | 7 | |
|
8 | 8 | * Brian Granger |
|
9 | 9 | * Fernando Perez |
|
10 | 10 | |
|
11 | 11 | Notes |
|
12 | 12 | ----- |
|
13 | 13 | """ |
|
14 | 14 | |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | # Copyright (C) 2008-2009 The IPython Development Team |
|
17 | 17 | # |
|
18 | 18 | # Distributed under the terms of the BSD License. The full license is in |
|
19 | 19 | # the file COPYING, distributed as part of this software. |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | # Imports |
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | |
|
26 | 26 | from __future__ import with_statement |
|
27 | 27 | import __main__ |
|
28 | 28 | |
|
29 | 29 | import sys |
|
30 | 30 | from contextlib import nested |
|
31 | 31 | |
|
32 | 32 | from IPython.core import ultratb |
|
33 | 33 | from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell |
|
34 | 34 | from IPython.frontend.terminal.ipapp import load_default_config |
|
35 | 35 | |
|
36 |
from IPython.utils.traitlets import Bool, |
|
|
36 | from IPython.utils.traitlets import Bool, CBool, Unicode | |
|
37 | 37 | from IPython.utils.io import ask_yes_no |
|
38 | 38 | |
|
39 | 39 | |
|
40 | 40 | #----------------------------------------------------------------------------- |
|
41 | 41 | # Classes and functions |
|
42 | 42 | #----------------------------------------------------------------------------- |
|
43 | 43 | |
|
44 | 44 | # This is an additional magic that is exposed in embedded shells. |
|
45 | 45 | def kill_embedded(self,parameter_s=''): |
|
46 | 46 | """%kill_embedded : deactivate for good the current embedded IPython. |
|
47 | 47 | |
|
48 | 48 | This function (after asking for confirmation) sets an internal flag so that |
|
49 | 49 | an embedded IPython will never activate again. This is useful to |
|
50 | 50 | permanently disable a shell that is being called inside a loop: once you've |
|
51 | 51 | figured out what you needed from it, you may then kill it and the program |
|
52 | 52 | will then continue to run without the interactive shell interfering again. |
|
53 | 53 | """ |
|
54 | 54 | |
|
55 | 55 | kill = ask_yes_no("Are you sure you want to kill this embedded instance " |
|
56 | 56 | "(y/n)? [y/N] ",'n') |
|
57 | 57 | if kill: |
|
58 | 58 | self.embedded_active = False |
|
59 | 59 | print "This embedded IPython will not reactivate anymore once you exit." |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | class InteractiveShellEmbed(TerminalInteractiveShell): |
|
63 | 63 | |
|
64 | 64 | dummy_mode = Bool(False) |
|
65 | 65 | exit_msg = Unicode('') |
|
66 | 66 | embedded = CBool(True) |
|
67 | 67 | embedded_active = CBool(True) |
|
68 | 68 | # Like the base class display_banner is not configurable, but here it |
|
69 | 69 | # is True by default. |
|
70 | 70 | display_banner = CBool(True) |
|
71 | 71 | |
|
72 | 72 | def __init__(self, config=None, ipython_dir=None, user_ns=None, |
|
73 | 73 | user_global_ns=None, custom_exceptions=((),None), |
|
74 | 74 | usage=None, banner1=None, banner2=None, |
|
75 | 75 | display_banner=None, exit_msg=u''): |
|
76 | 76 | |
|
77 | 77 | super(InteractiveShellEmbed,self).__init__( |
|
78 | 78 | config=config, ipython_dir=ipython_dir, user_ns=user_ns, |
|
79 | 79 | user_global_ns=user_global_ns, custom_exceptions=custom_exceptions, |
|
80 | 80 | usage=usage, banner1=banner1, banner2=banner2, |
|
81 | 81 | display_banner=display_banner |
|
82 | 82 | ) |
|
83 | 83 | |
|
84 | 84 | self.exit_msg = exit_msg |
|
85 | 85 | self.define_magic("kill_embedded", kill_embedded) |
|
86 | 86 | |
|
87 | 87 | # don't use the ipython crash handler so that user exceptions aren't |
|
88 | 88 | # trapped |
|
89 | 89 | sys.excepthook = ultratb.FormattedTB(color_scheme=self.colors, |
|
90 | 90 | mode=self.xmode, |
|
91 | 91 | call_pdb=self.pdb) |
|
92 | 92 | |
|
93 | 93 | def init_sys_modules(self): |
|
94 | 94 | pass |
|
95 | 95 | |
|
96 | 96 | def __call__(self, header='', local_ns=None, global_ns=None, dummy=None, |
|
97 | 97 | stack_depth=1): |
|
98 | 98 | """Activate the interactive interpreter. |
|
99 | 99 | |
|
100 | 100 | __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start |
|
101 | 101 | the interpreter shell with the given local and global namespaces, and |
|
102 | 102 | optionally print a header string at startup. |
|
103 | 103 | |
|
104 | 104 | The shell can be globally activated/deactivated using the |
|
105 | 105 | set/get_dummy_mode methods. This allows you to turn off a shell used |
|
106 | 106 | for debugging globally. |
|
107 | 107 | |
|
108 | 108 | However, *each* time you call the shell you can override the current |
|
109 | 109 | state of dummy_mode with the optional keyword parameter 'dummy'. For |
|
110 | 110 | example, if you set dummy mode on with IPShell.set_dummy_mode(1), you |
|
111 | 111 | can still have a specific call work by making it as IPShell(dummy=0). |
|
112 | 112 | |
|
113 | 113 | The optional keyword parameter dummy controls whether the call |
|
114 | 114 | actually does anything. |
|
115 | 115 | """ |
|
116 | 116 | |
|
117 | 117 | # If the user has turned it off, go away |
|
118 | 118 | if not self.embedded_active: |
|
119 | 119 | return |
|
120 | 120 | |
|
121 | 121 | # Normal exits from interactive mode set this flag, so the shell can't |
|
122 | 122 | # re-enter (it checks this variable at the start of interactive mode). |
|
123 | 123 | self.exit_now = False |
|
124 | 124 | |
|
125 | 125 | # Allow the dummy parameter to override the global __dummy_mode |
|
126 | 126 | if dummy or (dummy != 0 and self.dummy_mode): |
|
127 | 127 | return |
|
128 | 128 | |
|
129 | 129 | if self.has_readline: |
|
130 | 130 | self.set_readline_completer() |
|
131 | 131 | |
|
132 | 132 | # self.banner is auto computed |
|
133 | 133 | if header: |
|
134 | 134 | self.old_banner2 = self.banner2 |
|
135 | 135 | self.banner2 = self.banner2 + '\n' + header + '\n' |
|
136 | 136 | else: |
|
137 | 137 | self.old_banner2 = '' |
|
138 | 138 | |
|
139 | 139 | # Call the embedding code with a stack depth of 1 so it can skip over |
|
140 | 140 | # our call and get the original caller's namespaces. |
|
141 | 141 | self.mainloop(local_ns, global_ns, stack_depth=stack_depth) |
|
142 | 142 | |
|
143 | 143 | self.banner2 = self.old_banner2 |
|
144 | 144 | |
|
145 | 145 | if self.exit_msg is not None: |
|
146 | 146 | print self.exit_msg |
|
147 | 147 | |
|
148 | 148 | def mainloop(self, local_ns=None, global_ns=None, stack_depth=0, |
|
149 | 149 | display_banner=None): |
|
150 | 150 | """Embeds IPython into a running python program. |
|
151 | 151 | |
|
152 | 152 | Input: |
|
153 | 153 | |
|
154 | 154 | - header: An optional header message can be specified. |
|
155 | 155 | |
|
156 | 156 | - local_ns, global_ns: working namespaces. If given as None, the |
|
157 | 157 | IPython-initialized one is updated with __main__.__dict__, so that |
|
158 | 158 | program variables become visible but user-specific configuration |
|
159 | 159 | remains possible. |
|
160 | 160 | |
|
161 | 161 | - stack_depth: specifies how many levels in the stack to go to |
|
162 | 162 | looking for namespaces (when local_ns and global_ns are None). This |
|
163 | 163 | allows an intermediate caller to make sure that this function gets |
|
164 | 164 | the namespace from the intended level in the stack. By default (0) |
|
165 | 165 | it will get its locals and globals from the immediate caller. |
|
166 | 166 | |
|
167 | 167 | Warning: it's possible to use this in a program which is being run by |
|
168 | 168 | IPython itself (via %run), but some funny things will happen (a few |
|
169 | 169 | globals get overwritten). In the future this will be cleaned up, as |
|
170 | 170 | there is no fundamental reason why it can't work perfectly.""" |
|
171 | 171 | |
|
172 | 172 | # Get locals and globals from caller |
|
173 | 173 | if local_ns is None or global_ns is None: |
|
174 | 174 | call_frame = sys._getframe(stack_depth).f_back |
|
175 | 175 | |
|
176 | 176 | if local_ns is None: |
|
177 | 177 | local_ns = call_frame.f_locals |
|
178 | 178 | if global_ns is None: |
|
179 | 179 | global_ns = call_frame.f_globals |
|
180 | 180 | |
|
181 | 181 | # Update namespaces and fire up interpreter |
|
182 | 182 | |
|
183 | 183 | # The global one is easy, we can just throw it in |
|
184 | 184 | self.user_global_ns = global_ns |
|
185 | 185 | |
|
186 | 186 | # but the user/local one is tricky: ipython needs it to store internal |
|
187 | 187 | # data, but we also need the locals. We'll copy locals in the user |
|
188 | 188 | # one, but will track what got copied so we can delete them at exit. |
|
189 | 189 | # This is so that a later embedded call doesn't see locals from a |
|
190 | 190 | # previous call (which most likely existed in a separate scope). |
|
191 | 191 | local_varnames = local_ns.keys() |
|
192 | 192 | self.user_ns.update(local_ns) |
|
193 | 193 | #self.user_ns['local_ns'] = local_ns # dbg |
|
194 | 194 | |
|
195 | 195 | # Patch for global embedding to make sure that things don't overwrite |
|
196 | 196 | # user globals accidentally. Thanks to Richard <rxe@renre-europe.com> |
|
197 | 197 | # FIXME. Test this a bit more carefully (the if.. is new) |
|
198 | 198 | if local_ns is None and global_ns is None: |
|
199 | 199 | self.user_global_ns.update(__main__.__dict__) |
|
200 | 200 | |
|
201 | 201 | # make sure the tab-completer has the correct frame information, so it |
|
202 | 202 | # actually completes using the frame's locals/globals |
|
203 | 203 | self.set_completer_frame() |
|
204 | 204 | |
|
205 | 205 | with nested(self.builtin_trap, self.display_trap): |
|
206 | 206 | self.interact(display_banner=display_banner) |
|
207 | 207 | |
|
208 | 208 | # now, purge out the user namespace from anything we might have added |
|
209 | 209 | # from the caller's local namespace |
|
210 | 210 | delvar = self.user_ns.pop |
|
211 | 211 | for var in local_varnames: |
|
212 | 212 | delvar(var,None) |
|
213 | 213 | |
|
214 | 214 | |
|
215 | 215 | _embedded_shell = None |
|
216 | 216 | |
|
217 | 217 | |
|
218 | 218 | def embed(**kwargs): |
|
219 | 219 | """Call this to embed IPython at the current point in your program. |
|
220 | 220 | |
|
221 | 221 | The first invocation of this will create an :class:`InteractiveShellEmbed` |
|
222 | 222 | instance and then call it. Consecutive calls just call the already |
|
223 | 223 | created instance. |
|
224 | 224 | |
|
225 | 225 | Here is a simple example:: |
|
226 | 226 | |
|
227 | 227 | from IPython import embed |
|
228 | 228 | a = 10 |
|
229 | 229 | b = 20 |
|
230 | 230 | embed('First time') |
|
231 | 231 | c = 30 |
|
232 | 232 | d = 40 |
|
233 | 233 | embed |
|
234 | 234 | |
|
235 | 235 | Full customization can be done by passing a :class:`Struct` in as the |
|
236 | 236 | config argument. |
|
237 | 237 | """ |
|
238 | 238 | config = kwargs.get('config') |
|
239 | 239 | header = kwargs.pop('header', u'') |
|
240 | 240 | if config is None: |
|
241 | 241 | config = load_default_config() |
|
242 | 242 | config.InteractiveShellEmbed = config.TerminalInteractiveShell |
|
243 | 243 | kwargs['config'] = config |
|
244 | 244 | global _embedded_shell |
|
245 | 245 | if _embedded_shell is None: |
|
246 | 246 | _embedded_shell = InteractiveShellEmbed(**kwargs) |
|
247 | 247 | _embedded_shell(header=header, stack_depth=2) |
@@ -1,590 +1,590 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Subclass of InteractiveShell for terminal based frontends.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2010 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | import __builtin__ |
|
18 | 18 | import bdb |
|
19 | 19 | from contextlib import nested |
|
20 | 20 | import os |
|
21 | 21 | import re |
|
22 | 22 | import sys |
|
23 | 23 | |
|
24 | 24 | from IPython.core.error import TryNext |
|
25 | 25 | from IPython.core.usage import interactive_usage, default_banner |
|
26 | 26 | from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC |
|
27 | 27 | from IPython.lib.inputhook import enable_gui |
|
28 | 28 | from IPython.lib.pylabtools import pylab_activate |
|
29 | 29 | from IPython.testing.skipdoctest import skip_doctest |
|
30 | 30 | from IPython.utils.terminal import toggle_set_term_title, set_term_title |
|
31 | 31 | from IPython.utils.process import abbrev_cwd |
|
32 | 32 | from IPython.utils.warn import warn |
|
33 | 33 | from IPython.utils.text import num_ini_spaces |
|
34 |
from IPython.utils.traitlets import Int, |
|
|
34 | from IPython.utils.traitlets import Int, CBool, Unicode | |
|
35 | 35 | |
|
36 | 36 | #----------------------------------------------------------------------------- |
|
37 | 37 | # Utilities |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | |
|
40 | 40 | def get_default_editor(): |
|
41 | 41 | try: |
|
42 | 42 | ed = os.environ['EDITOR'] |
|
43 | 43 | except KeyError: |
|
44 | 44 | if os.name == 'posix': |
|
45 | 45 | ed = 'vi' # the only one guaranteed to be there! |
|
46 | 46 | else: |
|
47 | 47 | ed = 'notepad' # same in Windows! |
|
48 | 48 | return ed |
|
49 | 49 | |
|
50 | 50 | |
|
51 | 51 | # store the builtin raw_input globally, and use this always, in case user code |
|
52 | 52 | # overwrites it (like wx.py.PyShell does) |
|
53 | 53 | raw_input_original = raw_input |
|
54 | 54 | |
|
55 | 55 | #----------------------------------------------------------------------------- |
|
56 | 56 | # Main class |
|
57 | 57 | #----------------------------------------------------------------------------- |
|
58 | 58 | |
|
59 | 59 | class TerminalInteractiveShell(InteractiveShell): |
|
60 | 60 | |
|
61 | 61 | autoedit_syntax = CBool(False, config=True, |
|
62 | 62 | help="auto editing of files with syntax errors.") |
|
63 | 63 | banner = Unicode('') |
|
64 | 64 | banner1 = Unicode(default_banner, config=True, |
|
65 | 65 | help="""The part of the banner to be printed before the profile""" |
|
66 | 66 | ) |
|
67 | 67 | banner2 = Unicode('', config=True, |
|
68 | 68 | help="""The part of the banner to be printed after the profile""" |
|
69 | 69 | ) |
|
70 | 70 | confirm_exit = CBool(True, config=True, |
|
71 | 71 | help=""" |
|
72 | 72 | Set to confirm when you try to exit IPython with an EOF (Control-D |
|
73 | 73 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', |
|
74 | 74 | you can force a direct exit without any confirmation.""", |
|
75 | 75 | ) |
|
76 | 76 | # This display_banner only controls whether or not self.show_banner() |
|
77 | 77 | # is called when mainloop/interact are called. The default is False |
|
78 | 78 | # because for the terminal based application, the banner behavior |
|
79 | 79 | # is controlled by Global.display_banner, which IPythonApp looks at |
|
80 | 80 | # to determine if *it* should call show_banner() by hand or not. |
|
81 | 81 | display_banner = CBool(False) # This isn't configurable! |
|
82 | 82 | embedded = CBool(False) |
|
83 | 83 | embedded_active = CBool(False) |
|
84 | 84 | editor = Unicode(get_default_editor(), config=True, |
|
85 | 85 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad)." |
|
86 | 86 | ) |
|
87 | 87 | pager = Unicode('less', config=True, |
|
88 | 88 | help="The shell program to be used for paging.") |
|
89 | 89 | |
|
90 | 90 | screen_length = Int(0, config=True, |
|
91 | 91 | help= |
|
92 | 92 | """Number of lines of your screen, used to control printing of very |
|
93 | 93 | long strings. Strings longer than this number of lines will be sent |
|
94 | 94 | through a pager instead of directly printed. The default value for |
|
95 | 95 | this is 0, which means IPython will auto-detect your screen size every |
|
96 | 96 | time it needs to print certain potentially long strings (this doesn't |
|
97 | 97 | change the behavior of the 'print' keyword, it's only triggered |
|
98 | 98 | internally). If for some reason this isn't working well (it needs |
|
99 | 99 | curses support), specify it yourself. Otherwise don't change the |
|
100 | 100 | default.""", |
|
101 | 101 | ) |
|
102 | 102 | term_title = CBool(False, config=True, |
|
103 | 103 | help="Enable auto setting the terminal title." |
|
104 | 104 | ) |
|
105 | 105 | |
|
106 | 106 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, user_ns=None, |
|
107 | 107 | user_global_ns=None, custom_exceptions=((),None), |
|
108 | 108 | usage=None, banner1=None, banner2=None, |
|
109 | 109 | display_banner=None): |
|
110 | 110 | |
|
111 | 111 | super(TerminalInteractiveShell, self).__init__( |
|
112 | 112 | config=config, profile_dir=profile_dir, user_ns=user_ns, |
|
113 | 113 | user_global_ns=user_global_ns, custom_exceptions=custom_exceptions |
|
114 | 114 | ) |
|
115 | 115 | # use os.system instead of utils.process.system by default, except on Windows |
|
116 | 116 | if os.name == 'nt': |
|
117 | 117 | self.system = self.system_piped |
|
118 | 118 | else: |
|
119 | 119 | self.system = self.system_raw |
|
120 | 120 | |
|
121 | 121 | self.init_term_title() |
|
122 | 122 | self.init_usage(usage) |
|
123 | 123 | self.init_banner(banner1, banner2, display_banner) |
|
124 | 124 | |
|
125 | 125 | #------------------------------------------------------------------------- |
|
126 | 126 | # Things related to the terminal |
|
127 | 127 | #------------------------------------------------------------------------- |
|
128 | 128 | |
|
129 | 129 | @property |
|
130 | 130 | def usable_screen_length(self): |
|
131 | 131 | if self.screen_length == 0: |
|
132 | 132 | return 0 |
|
133 | 133 | else: |
|
134 | 134 | num_lines_bot = self.separate_in.count('\n')+1 |
|
135 | 135 | return self.screen_length - num_lines_bot |
|
136 | 136 | |
|
137 | 137 | def init_term_title(self): |
|
138 | 138 | # Enable or disable the terminal title. |
|
139 | 139 | if self.term_title: |
|
140 | 140 | toggle_set_term_title(True) |
|
141 | 141 | set_term_title('IPython: ' + abbrev_cwd()) |
|
142 | 142 | else: |
|
143 | 143 | toggle_set_term_title(False) |
|
144 | 144 | |
|
145 | 145 | #------------------------------------------------------------------------- |
|
146 | 146 | # Things related to aliases |
|
147 | 147 | #------------------------------------------------------------------------- |
|
148 | 148 | |
|
149 | 149 | def init_alias(self): |
|
150 | 150 | # The parent class defines aliases that can be safely used with any |
|
151 | 151 | # frontend. |
|
152 | 152 | super(TerminalInteractiveShell, self).init_alias() |
|
153 | 153 | |
|
154 | 154 | # Now define aliases that only make sense on the terminal, because they |
|
155 | 155 | # need direct access to the console in a way that we can't emulate in |
|
156 | 156 | # GUI or web frontend |
|
157 | 157 | if os.name == 'posix': |
|
158 | 158 | aliases = [('clear', 'clear'), ('more', 'more'), ('less', 'less'), |
|
159 | 159 | ('man', 'man')] |
|
160 | 160 | elif os.name == 'nt': |
|
161 | 161 | aliases = [('cls', 'cls')] |
|
162 | 162 | |
|
163 | 163 | |
|
164 | 164 | for name, cmd in aliases: |
|
165 | 165 | self.alias_manager.define_alias(name, cmd) |
|
166 | 166 | |
|
167 | 167 | #------------------------------------------------------------------------- |
|
168 | 168 | # Things related to the banner and usage |
|
169 | 169 | #------------------------------------------------------------------------- |
|
170 | 170 | |
|
171 | 171 | def _banner1_changed(self): |
|
172 | 172 | self.compute_banner() |
|
173 | 173 | |
|
174 | 174 | def _banner2_changed(self): |
|
175 | 175 | self.compute_banner() |
|
176 | 176 | |
|
177 | 177 | def _term_title_changed(self, name, new_value): |
|
178 | 178 | self.init_term_title() |
|
179 | 179 | |
|
180 | 180 | def init_banner(self, banner1, banner2, display_banner): |
|
181 | 181 | if banner1 is not None: |
|
182 | 182 | self.banner1 = banner1 |
|
183 | 183 | if banner2 is not None: |
|
184 | 184 | self.banner2 = banner2 |
|
185 | 185 | if display_banner is not None: |
|
186 | 186 | self.display_banner = display_banner |
|
187 | 187 | self.compute_banner() |
|
188 | 188 | |
|
189 | 189 | def show_banner(self, banner=None): |
|
190 | 190 | if banner is None: |
|
191 | 191 | banner = self.banner |
|
192 | 192 | self.write(banner) |
|
193 | 193 | |
|
194 | 194 | def compute_banner(self): |
|
195 | 195 | self.banner = self.banner1 |
|
196 | 196 | if self.profile and self.profile != 'default': |
|
197 | 197 | self.banner += '\nIPython profile: %s\n' % self.profile |
|
198 | 198 | if self.banner2: |
|
199 | 199 | self.banner += '\n' + self.banner2 |
|
200 | 200 | |
|
201 | 201 | def init_usage(self, usage=None): |
|
202 | 202 | if usage is None: |
|
203 | 203 | self.usage = interactive_usage |
|
204 | 204 | else: |
|
205 | 205 | self.usage = usage |
|
206 | 206 | |
|
207 | 207 | #------------------------------------------------------------------------- |
|
208 | 208 | # Mainloop and code execution logic |
|
209 | 209 | #------------------------------------------------------------------------- |
|
210 | 210 | |
|
211 | 211 | def mainloop(self, display_banner=None): |
|
212 | 212 | """Start the mainloop. |
|
213 | 213 | |
|
214 | 214 | If an optional banner argument is given, it will override the |
|
215 | 215 | internally created default banner. |
|
216 | 216 | """ |
|
217 | 217 | |
|
218 | 218 | with nested(self.builtin_trap, self.display_trap): |
|
219 | 219 | |
|
220 | 220 | while 1: |
|
221 | 221 | try: |
|
222 | 222 | self.interact(display_banner=display_banner) |
|
223 | 223 | #self.interact_with_readline() |
|
224 | 224 | # XXX for testing of a readline-decoupled repl loop, call |
|
225 | 225 | # interact_with_readline above |
|
226 | 226 | break |
|
227 | 227 | except KeyboardInterrupt: |
|
228 | 228 | # this should not be necessary, but KeyboardInterrupt |
|
229 | 229 | # handling seems rather unpredictable... |
|
230 | 230 | self.write("\nKeyboardInterrupt in interact()\n") |
|
231 | 231 | |
|
232 | 232 | def interact(self, display_banner=None): |
|
233 | 233 | """Closely emulate the interactive Python console.""" |
|
234 | 234 | |
|
235 | 235 | # batch run -> do not interact |
|
236 | 236 | if self.exit_now: |
|
237 | 237 | return |
|
238 | 238 | |
|
239 | 239 | if display_banner is None: |
|
240 | 240 | display_banner = self.display_banner |
|
241 | 241 | if display_banner: |
|
242 | 242 | self.show_banner() |
|
243 | 243 | |
|
244 | 244 | more = False |
|
245 | 245 | |
|
246 | 246 | # Mark activity in the builtins |
|
247 | 247 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
248 | 248 | |
|
249 | 249 | if self.has_readline: |
|
250 | 250 | self.readline_startup_hook(self.pre_readline) |
|
251 | 251 | # exit_now is set by a call to %Exit or %Quit, through the |
|
252 | 252 | # ask_exit callback. |
|
253 | 253 | |
|
254 | 254 | while not self.exit_now: |
|
255 | 255 | self.hooks.pre_prompt_hook() |
|
256 | 256 | if more: |
|
257 | 257 | try: |
|
258 | 258 | prompt = self.hooks.generate_prompt(True) |
|
259 | 259 | except: |
|
260 | 260 | self.showtraceback() |
|
261 | 261 | if self.autoindent: |
|
262 | 262 | self.rl_do_indent = True |
|
263 | 263 | |
|
264 | 264 | else: |
|
265 | 265 | try: |
|
266 | 266 | prompt = self.hooks.generate_prompt(False) |
|
267 | 267 | except: |
|
268 | 268 | self.showtraceback() |
|
269 | 269 | try: |
|
270 | 270 | line = self.raw_input(prompt) |
|
271 | 271 | if self.exit_now: |
|
272 | 272 | # quick exit on sys.std[in|out] close |
|
273 | 273 | break |
|
274 | 274 | if self.autoindent: |
|
275 | 275 | self.rl_do_indent = False |
|
276 | 276 | |
|
277 | 277 | except KeyboardInterrupt: |
|
278 | 278 | #double-guard against keyboardinterrupts during kbdint handling |
|
279 | 279 | try: |
|
280 | 280 | self.write('\nKeyboardInterrupt\n') |
|
281 | 281 | self.input_splitter.reset() |
|
282 | 282 | more = False |
|
283 | 283 | except KeyboardInterrupt: |
|
284 | 284 | pass |
|
285 | 285 | except EOFError: |
|
286 | 286 | if self.autoindent: |
|
287 | 287 | self.rl_do_indent = False |
|
288 | 288 | if self.has_readline: |
|
289 | 289 | self.readline_startup_hook(None) |
|
290 | 290 | self.write('\n') |
|
291 | 291 | self.exit() |
|
292 | 292 | except bdb.BdbQuit: |
|
293 | 293 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
294 | 294 | 'Because of how pdb handles the stack, it is impossible\n' |
|
295 | 295 | 'for IPython to properly format this particular exception.\n' |
|
296 | 296 | 'IPython will resume normal operation.') |
|
297 | 297 | except: |
|
298 | 298 | # exceptions here are VERY RARE, but they can be triggered |
|
299 | 299 | # asynchronously by signal handlers, for example. |
|
300 | 300 | self.showtraceback() |
|
301 | 301 | else: |
|
302 | 302 | self.input_splitter.push(line) |
|
303 | 303 | more = self.input_splitter.push_accepts_more() |
|
304 | 304 | if (self.SyntaxTB.last_syntax_error and |
|
305 | 305 | self.autoedit_syntax): |
|
306 | 306 | self.edit_syntax_error() |
|
307 | 307 | if not more: |
|
308 | 308 | source_raw = self.input_splitter.source_raw_reset()[1] |
|
309 | 309 | self.run_cell(source_raw) |
|
310 | 310 | |
|
311 | 311 | # We are off again... |
|
312 | 312 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
313 | 313 | |
|
314 | 314 | # Turn off the exit flag, so the mainloop can be restarted if desired |
|
315 | 315 | self.exit_now = False |
|
316 | 316 | |
|
317 | 317 | def raw_input(self, prompt=''): |
|
318 | 318 | """Write a prompt and read a line. |
|
319 | 319 | |
|
320 | 320 | The returned line does not include the trailing newline. |
|
321 | 321 | When the user enters the EOF key sequence, EOFError is raised. |
|
322 | 322 | |
|
323 | 323 | Optional inputs: |
|
324 | 324 | |
|
325 | 325 | - prompt(''): a string to be printed to prompt the user. |
|
326 | 326 | |
|
327 | 327 | - continue_prompt(False): whether this line is the first one or a |
|
328 | 328 | continuation in a sequence of inputs. |
|
329 | 329 | """ |
|
330 | 330 | # Code run by the user may have modified the readline completer state. |
|
331 | 331 | # We must ensure that our completer is back in place. |
|
332 | 332 | |
|
333 | 333 | if self.has_readline: |
|
334 | 334 | self.set_readline_completer() |
|
335 | 335 | |
|
336 | 336 | try: |
|
337 | 337 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
338 | 338 | except ValueError: |
|
339 | 339 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
340 | 340 | " or sys.stdout.close()!\nExiting IPython!") |
|
341 | 341 | self.ask_exit() |
|
342 | 342 | return "" |
|
343 | 343 | |
|
344 | 344 | # Try to be reasonably smart about not re-indenting pasted input more |
|
345 | 345 | # than necessary. We do this by trimming out the auto-indent initial |
|
346 | 346 | # spaces, if the user's actual input started itself with whitespace. |
|
347 | 347 | if self.autoindent: |
|
348 | 348 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
349 | 349 | line = line[self.indent_current_nsp:] |
|
350 | 350 | self.indent_current_nsp = 0 |
|
351 | 351 | |
|
352 | 352 | return line |
|
353 | 353 | |
|
354 | 354 | #------------------------------------------------------------------------- |
|
355 | 355 | # Methods to support auto-editing of SyntaxErrors. |
|
356 | 356 | #------------------------------------------------------------------------- |
|
357 | 357 | |
|
358 | 358 | def edit_syntax_error(self): |
|
359 | 359 | """The bottom half of the syntax error handler called in the main loop. |
|
360 | 360 | |
|
361 | 361 | Loop until syntax error is fixed or user cancels. |
|
362 | 362 | """ |
|
363 | 363 | |
|
364 | 364 | while self.SyntaxTB.last_syntax_error: |
|
365 | 365 | # copy and clear last_syntax_error |
|
366 | 366 | err = self.SyntaxTB.clear_err_state() |
|
367 | 367 | if not self._should_recompile(err): |
|
368 | 368 | return |
|
369 | 369 | try: |
|
370 | 370 | # may set last_syntax_error again if a SyntaxError is raised |
|
371 | 371 | self.safe_execfile(err.filename,self.user_ns) |
|
372 | 372 | except: |
|
373 | 373 | self.showtraceback() |
|
374 | 374 | else: |
|
375 | 375 | try: |
|
376 | 376 | f = file(err.filename) |
|
377 | 377 | try: |
|
378 | 378 | # This should be inside a display_trap block and I |
|
379 | 379 | # think it is. |
|
380 | 380 | sys.displayhook(f.read()) |
|
381 | 381 | finally: |
|
382 | 382 | f.close() |
|
383 | 383 | except: |
|
384 | 384 | self.showtraceback() |
|
385 | 385 | |
|
386 | 386 | def _should_recompile(self,e): |
|
387 | 387 | """Utility routine for edit_syntax_error""" |
|
388 | 388 | |
|
389 | 389 | if e.filename in ('<ipython console>','<input>','<string>', |
|
390 | 390 | '<console>','<BackgroundJob compilation>', |
|
391 | 391 | None): |
|
392 | 392 | |
|
393 | 393 | return False |
|
394 | 394 | try: |
|
395 | 395 | if (self.autoedit_syntax and |
|
396 | 396 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
397 | 397 | '[Y/n] ','y')): |
|
398 | 398 | return False |
|
399 | 399 | except EOFError: |
|
400 | 400 | return False |
|
401 | 401 | |
|
402 | 402 | def int0(x): |
|
403 | 403 | try: |
|
404 | 404 | return int(x) |
|
405 | 405 | except TypeError: |
|
406 | 406 | return 0 |
|
407 | 407 | # always pass integer line and offset values to editor hook |
|
408 | 408 | try: |
|
409 | 409 | self.hooks.fix_error_editor(e.filename, |
|
410 | 410 | int0(e.lineno),int0(e.offset),e.msg) |
|
411 | 411 | except TryNext: |
|
412 | 412 | warn('Could not open editor') |
|
413 | 413 | return False |
|
414 | 414 | return True |
|
415 | 415 | |
|
416 | 416 | #------------------------------------------------------------------------- |
|
417 | 417 | # Things related to GUI support and pylab |
|
418 | 418 | #------------------------------------------------------------------------- |
|
419 | 419 | |
|
420 | 420 | def enable_pylab(self, gui=None): |
|
421 | 421 | """Activate pylab support at runtime. |
|
422 | 422 | |
|
423 | 423 | This turns on support for matplotlib, preloads into the interactive |
|
424 | 424 | namespace all of numpy and pylab, and configures IPython to correcdtly |
|
425 | 425 | interact with the GUI event loop. The GUI backend to be used can be |
|
426 | 426 | optionally selected with the optional :param:`gui` argument. |
|
427 | 427 | |
|
428 | 428 | Parameters |
|
429 | 429 | ---------- |
|
430 | 430 | gui : optional, string |
|
431 | 431 | |
|
432 | 432 | If given, dictates the choice of matplotlib GUI backend to use |
|
433 | 433 | (should be one of IPython's supported backends, 'tk', 'qt', 'wx' or |
|
434 | 434 | 'gtk'), otherwise we use the default chosen by matplotlib (as |
|
435 | 435 | dictated by the matplotlib build-time options plus the user's |
|
436 | 436 | matplotlibrc configuration file). |
|
437 | 437 | """ |
|
438 | 438 | # We want to prevent the loading of pylab to pollute the user's |
|
439 | 439 | # namespace as shown by the %who* magics, so we execute the activation |
|
440 | 440 | # code in an empty namespace, and we update *both* user_ns and |
|
441 | 441 | # user_ns_hidden with this information. |
|
442 | 442 | ns = {} |
|
443 | 443 | gui = pylab_activate(ns, gui) |
|
444 | 444 | self.user_ns.update(ns) |
|
445 | 445 | self.user_ns_hidden.update(ns) |
|
446 | 446 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
447 | 447 | # plot updates into account |
|
448 | 448 | enable_gui(gui) |
|
449 | 449 | self.magic_run = self._pylab_magic_run |
|
450 | 450 | |
|
451 | 451 | #------------------------------------------------------------------------- |
|
452 | 452 | # Things related to exiting |
|
453 | 453 | #------------------------------------------------------------------------- |
|
454 | 454 | |
|
455 | 455 | def ask_exit(self): |
|
456 | 456 | """ Ask the shell to exit. Can be overiden and used as a callback. """ |
|
457 | 457 | self.exit_now = True |
|
458 | 458 | |
|
459 | 459 | def exit(self): |
|
460 | 460 | """Handle interactive exit. |
|
461 | 461 | |
|
462 | 462 | This method calls the ask_exit callback.""" |
|
463 | 463 | if self.confirm_exit: |
|
464 | 464 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
465 | 465 | self.ask_exit() |
|
466 | 466 | else: |
|
467 | 467 | self.ask_exit() |
|
468 | 468 | |
|
469 | 469 | #------------------------------------------------------------------------ |
|
470 | 470 | # Magic overrides |
|
471 | 471 | #------------------------------------------------------------------------ |
|
472 | 472 | # Once the base class stops inheriting from magic, this code needs to be |
|
473 | 473 | # moved into a separate machinery as well. For now, at least isolate here |
|
474 | 474 | # the magics which this class needs to implement differently from the base |
|
475 | 475 | # class, or that are unique to it. |
|
476 | 476 | |
|
477 | 477 | def magic_autoindent(self, parameter_s = ''): |
|
478 | 478 | """Toggle autoindent on/off (if available).""" |
|
479 | 479 | |
|
480 | 480 | self.shell.set_autoindent() |
|
481 | 481 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
482 | 482 | |
|
483 | 483 | @skip_doctest |
|
484 | 484 | def magic_cpaste(self, parameter_s=''): |
|
485 | 485 | """Paste & execute a pre-formatted code block from clipboard. |
|
486 | 486 | |
|
487 | 487 | You must terminate the block with '--' (two minus-signs) alone on the |
|
488 | 488 | line. You can also provide your own sentinel with '%paste -s %%' ('%%' |
|
489 | 489 | is the new sentinel for this operation) |
|
490 | 490 | |
|
491 | 491 | The block is dedented prior to execution to enable execution of method |
|
492 | 492 | definitions. '>' and '+' characters at the beginning of a line are |
|
493 | 493 | ignored, to allow pasting directly from e-mails, diff files and |
|
494 | 494 | doctests (the '...' continuation prompt is also stripped). The |
|
495 | 495 | executed block is also assigned to variable named 'pasted_block' for |
|
496 | 496 | later editing with '%edit pasted_block'. |
|
497 | 497 | |
|
498 | 498 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
499 | 499 | This assigns the pasted block to variable 'foo' as string, without |
|
500 | 500 | dedenting or executing it (preceding >>> and + is still stripped) |
|
501 | 501 | |
|
502 | 502 | '%cpaste -r' re-executes the block previously entered by cpaste. |
|
503 | 503 | |
|
504 | 504 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
505 | 505 | Just press enter and type -- (and press enter again) and the block |
|
506 | 506 | will be what was just pasted. |
|
507 | 507 | |
|
508 | 508 | IPython statements (magics, shell escapes) are not supported (yet). |
|
509 | 509 | |
|
510 | 510 | See also |
|
511 | 511 | -------- |
|
512 | 512 | paste: automatically pull code from clipboard. |
|
513 | 513 | |
|
514 | 514 | Examples |
|
515 | 515 | -------- |
|
516 | 516 | :: |
|
517 | 517 | |
|
518 | 518 | In [8]: %cpaste |
|
519 | 519 | Pasting code; enter '--' alone on the line to stop. |
|
520 | 520 | :>>> a = ["world!", "Hello"] |
|
521 | 521 | :>>> print " ".join(sorted(a)) |
|
522 | 522 | :-- |
|
523 | 523 | Hello world! |
|
524 | 524 | """ |
|
525 | 525 | |
|
526 | 526 | opts,args = self.parse_options(parameter_s,'rs:',mode='string') |
|
527 | 527 | par = args.strip() |
|
528 | 528 | if opts.has_key('r'): |
|
529 | 529 | self._rerun_pasted() |
|
530 | 530 | return |
|
531 | 531 | |
|
532 | 532 | sentinel = opts.get('s','--') |
|
533 | 533 | |
|
534 | 534 | block = self._strip_pasted_lines_for_code( |
|
535 | 535 | self._get_pasted_lines(sentinel)) |
|
536 | 536 | |
|
537 | 537 | self._execute_block(block, par) |
|
538 | 538 | |
|
539 | 539 | def magic_paste(self, parameter_s=''): |
|
540 | 540 | """Paste & execute a pre-formatted code block from clipboard. |
|
541 | 541 | |
|
542 | 542 | The text is pulled directly from the clipboard without user |
|
543 | 543 | intervention and printed back on the screen before execution (unless |
|
544 | 544 | the -q flag is given to force quiet mode). |
|
545 | 545 | |
|
546 | 546 | The block is dedented prior to execution to enable execution of method |
|
547 | 547 | definitions. '>' and '+' characters at the beginning of a line are |
|
548 | 548 | ignored, to allow pasting directly from e-mails, diff files and |
|
549 | 549 | doctests (the '...' continuation prompt is also stripped). The |
|
550 | 550 | executed block is also assigned to variable named 'pasted_block' for |
|
551 | 551 | later editing with '%edit pasted_block'. |
|
552 | 552 | |
|
553 | 553 | You can also pass a variable name as an argument, e.g. '%paste foo'. |
|
554 | 554 | This assigns the pasted block to variable 'foo' as string, without |
|
555 | 555 | dedenting or executing it (preceding >>> and + is still stripped) |
|
556 | 556 | |
|
557 | 557 | Options |
|
558 | 558 | ------- |
|
559 | 559 | |
|
560 | 560 | -r: re-executes the block previously entered by cpaste. |
|
561 | 561 | |
|
562 | 562 | -q: quiet mode: do not echo the pasted text back to the terminal. |
|
563 | 563 | |
|
564 | 564 | IPython statements (magics, shell escapes) are not supported (yet). |
|
565 | 565 | |
|
566 | 566 | See also |
|
567 | 567 | -------- |
|
568 | 568 | cpaste: manually paste code into terminal until you mark its end. |
|
569 | 569 | """ |
|
570 | 570 | opts,args = self.parse_options(parameter_s,'rq',mode='string') |
|
571 | 571 | par = args.strip() |
|
572 | 572 | if opts.has_key('r'): |
|
573 | 573 | self._rerun_pasted() |
|
574 | 574 | return |
|
575 | 575 | |
|
576 | 576 | text = self.shell.hooks.clipboard_get() |
|
577 | 577 | block = self._strip_pasted_lines_for_code(text.splitlines()) |
|
578 | 578 | |
|
579 | 579 | # By default, echo back to terminal unless quiet mode is requested |
|
580 | 580 | if not opts.has_key('q'): |
|
581 | 581 | write = self.shell.write |
|
582 | 582 | write(self.shell.pycolorize(block)) |
|
583 | 583 | if not block.endswith('\n'): |
|
584 | 584 | write('\n') |
|
585 | 585 | write("## -- End pasted text --\n") |
|
586 | 586 | |
|
587 | 587 | self._execute_block(block, par) |
|
588 | 588 | |
|
589 | 589 | |
|
590 | 590 | InteractiveShellABC.register(TerminalInteractiveShell) |
@@ -1,446 +1,447 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | # encoding: utf-8 |
|
3 | 3 | """ |
|
4 | 4 | The ipcluster application. |
|
5 | 5 | |
|
6 | 6 | Authors: |
|
7 | 7 | |
|
8 | 8 | * Brian Granger |
|
9 | 9 | * MinRK |
|
10 | 10 | |
|
11 | 11 | """ |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Copyright (C) 2008-2011 The IPython Development Team |
|
15 | 15 | # |
|
16 | 16 | # Distributed under the terms of the BSD License. The full license is in |
|
17 | 17 | # the file COPYING, distributed as part of this software. |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | 19 | |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | # Imports |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | |
|
24 | 24 | import errno |
|
25 | 25 | import logging |
|
26 | 26 | import os |
|
27 | 27 | import re |
|
28 | 28 | import signal |
|
29 | 29 | |
|
30 | 30 | from subprocess import check_call, CalledProcessError, PIPE |
|
31 | 31 | import zmq |
|
32 | 32 | from zmq.eventloop import ioloop |
|
33 | 33 | |
|
34 | 34 | from IPython.config.application import Application, boolean_flag |
|
35 | 35 | from IPython.config.loader import Config |
|
36 | 36 | from IPython.core.application import BaseIPythonApplication |
|
37 | 37 | from IPython.core.profiledir import ProfileDir |
|
38 | 38 | from IPython.utils.daemonize import daemonize |
|
39 | 39 | from IPython.utils.importstring import import_item |
|
40 | from IPython.utils.traitlets import Int, Unicode, Bool, CFloat, Dict, List | |
|
40 | from IPython.utils.traitlets import (Int, Unicode, Bool, CFloat, Dict, List, | |
|
41 | DottedObjectName) | |
|
41 | 42 | |
|
42 | 43 | from IPython.parallel.apps.baseapp import ( |
|
43 | 44 | BaseParallelApplication, |
|
44 | 45 | PIDFileError, |
|
45 | 46 | base_flags, base_aliases |
|
46 | 47 | ) |
|
47 | 48 | |
|
48 | 49 | |
|
49 | 50 | #----------------------------------------------------------------------------- |
|
50 | 51 | # Module level variables |
|
51 | 52 | #----------------------------------------------------------------------------- |
|
52 | 53 | |
|
53 | 54 | |
|
54 | 55 | default_config_file_name = u'ipcluster_config.py' |
|
55 | 56 | |
|
56 | 57 | |
|
57 | 58 | _description = """Start an IPython cluster for parallel computing. |
|
58 | 59 | |
|
59 | 60 | An IPython cluster consists of 1 controller and 1 or more engines. |
|
60 | 61 | This command automates the startup of these processes using a wide |
|
61 | 62 | range of startup methods (SSH, local processes, PBS, mpiexec, |
|
62 | 63 | Windows HPC Server 2008). To start a cluster with 4 engines on your |
|
63 | 64 | local host simply do 'ipcluster start n=4'. For more complex usage |
|
64 | 65 | you will typically do 'ipcluster create profile=mycluster', then edit |
|
65 | 66 | configuration files, followed by 'ipcluster start profile=mycluster n=4'. |
|
66 | 67 | """ |
|
67 | 68 | |
|
68 | 69 | |
|
69 | 70 | # Exit codes for ipcluster |
|
70 | 71 | |
|
71 | 72 | # This will be the exit code if the ipcluster appears to be running because |
|
72 | 73 | # a .pid file exists |
|
73 | 74 | ALREADY_STARTED = 10 |
|
74 | 75 | |
|
75 | 76 | |
|
76 | 77 | # This will be the exit code if ipcluster stop is run, but there is not .pid |
|
77 | 78 | # file to be found. |
|
78 | 79 | ALREADY_STOPPED = 11 |
|
79 | 80 | |
|
80 | 81 | # This will be the exit code if ipcluster engines is run, but there is not .pid |
|
81 | 82 | # file to be found. |
|
82 | 83 | NO_CLUSTER = 12 |
|
83 | 84 | |
|
84 | 85 | |
|
85 | 86 | #----------------------------------------------------------------------------- |
|
86 | 87 | # Main application |
|
87 | 88 | #----------------------------------------------------------------------------- |
|
88 | 89 | start_help = """Start an IPython cluster for parallel computing |
|
89 | 90 | |
|
90 | 91 | Start an ipython cluster by its profile name or cluster |
|
91 | 92 | directory. Cluster directories contain configuration, log and |
|
92 | 93 | security related files and are named using the convention |
|
93 | 94 | 'profile_<name>' and should be creating using the 'start' |
|
94 | 95 | subcommand of 'ipcluster'. If your cluster directory is in |
|
95 | 96 | the cwd or the ipython directory, you can simply refer to it |
|
96 | 97 | using its profile name, 'ipcluster start n=4 profile=<profile>`, |
|
97 | 98 | otherwise use the 'profile_dir' option. |
|
98 | 99 | """ |
|
99 | 100 | stop_help = """Stop a running IPython cluster |
|
100 | 101 | |
|
101 | 102 | Stop a running ipython cluster by its profile name or cluster |
|
102 | 103 | directory. Cluster directories are named using the convention |
|
103 | 104 | 'profile_<name>'. If your cluster directory is in |
|
104 | 105 | the cwd or the ipython directory, you can simply refer to it |
|
105 | 106 | using its profile name, 'ipcluster stop profile=<profile>`, otherwise |
|
106 | 107 | use the 'profile_dir' option. |
|
107 | 108 | """ |
|
108 | 109 | engines_help = """Start engines connected to an existing IPython cluster |
|
109 | 110 | |
|
110 | 111 | Start one or more engines to connect to an existing Cluster |
|
111 | 112 | by profile name or cluster directory. |
|
112 | 113 | Cluster directories contain configuration, log and |
|
113 | 114 | security related files and are named using the convention |
|
114 | 115 | 'profile_<name>' and should be creating using the 'start' |
|
115 | 116 | subcommand of 'ipcluster'. If your cluster directory is in |
|
116 | 117 | the cwd or the ipython directory, you can simply refer to it |
|
117 | 118 | using its profile name, 'ipcluster engines n=4 profile=<profile>`, |
|
118 | 119 | otherwise use the 'profile_dir' option. |
|
119 | 120 | """ |
|
120 | 121 | stop_aliases = dict( |
|
121 | 122 | signal='IPClusterStop.signal', |
|
122 | 123 | profile='BaseIPythonApplication.profile', |
|
123 | 124 | profile_dir='ProfileDir.location', |
|
124 | 125 | ) |
|
125 | 126 | |
|
126 | 127 | class IPClusterStop(BaseParallelApplication): |
|
127 | 128 | name = u'ipcluster' |
|
128 | 129 | description = stop_help |
|
129 | 130 | config_file_name = Unicode(default_config_file_name) |
|
130 | 131 | |
|
131 | 132 | signal = Int(signal.SIGINT, config=True, |
|
132 | 133 | help="signal to use for stopping processes.") |
|
133 | 134 | |
|
134 | 135 | aliases = Dict(stop_aliases) |
|
135 | 136 | |
|
136 | 137 | def start(self): |
|
137 | 138 | """Start the app for the stop subcommand.""" |
|
138 | 139 | try: |
|
139 | 140 | pid = self.get_pid_from_file() |
|
140 | 141 | except PIDFileError: |
|
141 | 142 | self.log.critical( |
|
142 | 143 | 'Could not read pid file, cluster is probably not running.' |
|
143 | 144 | ) |
|
144 | 145 | # Here I exit with a unusual exit status that other processes |
|
145 | 146 | # can watch for to learn how I existed. |
|
146 | 147 | self.remove_pid_file() |
|
147 | 148 | self.exit(ALREADY_STOPPED) |
|
148 | 149 | |
|
149 | 150 | if not self.check_pid(pid): |
|
150 | 151 | self.log.critical( |
|
151 | 152 | 'Cluster [pid=%r] is not running.' % pid |
|
152 | 153 | ) |
|
153 | 154 | self.remove_pid_file() |
|
154 | 155 | # Here I exit with a unusual exit status that other processes |
|
155 | 156 | # can watch for to learn how I existed. |
|
156 | 157 | self.exit(ALREADY_STOPPED) |
|
157 | 158 | |
|
158 | 159 | elif os.name=='posix': |
|
159 | 160 | sig = self.signal |
|
160 | 161 | self.log.info( |
|
161 | 162 | "Stopping cluster [pid=%r] with [signal=%r]" % (pid, sig) |
|
162 | 163 | ) |
|
163 | 164 | try: |
|
164 | 165 | os.kill(pid, sig) |
|
165 | 166 | except OSError: |
|
166 | 167 | self.log.error("Stopping cluster failed, assuming already dead.", |
|
167 | 168 | exc_info=True) |
|
168 | 169 | self.remove_pid_file() |
|
169 | 170 | elif os.name=='nt': |
|
170 | 171 | try: |
|
171 | 172 | # kill the whole tree |
|
172 | 173 | p = check_call(['taskkill', '-pid', str(pid), '-t', '-f'], stdout=PIPE,stderr=PIPE) |
|
173 | 174 | except (CalledProcessError, OSError): |
|
174 | 175 | self.log.error("Stopping cluster failed, assuming already dead.", |
|
175 | 176 | exc_info=True) |
|
176 | 177 | self.remove_pid_file() |
|
177 | 178 | |
|
178 | 179 | engine_aliases = {} |
|
179 | 180 | engine_aliases.update(base_aliases) |
|
180 | 181 | engine_aliases.update(dict( |
|
181 | 182 | n='IPClusterEngines.n', |
|
182 | 183 | elauncher = 'IPClusterEngines.engine_launcher_class', |
|
183 | 184 | )) |
|
184 | 185 | class IPClusterEngines(BaseParallelApplication): |
|
185 | 186 | |
|
186 | 187 | name = u'ipcluster' |
|
187 | 188 | description = engines_help |
|
188 | 189 | usage = None |
|
189 | 190 | config_file_name = Unicode(default_config_file_name) |
|
190 | 191 | default_log_level = logging.INFO |
|
191 | 192 | classes = List() |
|
192 | 193 | def _classes_default(self): |
|
193 | 194 | from IPython.parallel.apps import launcher |
|
194 | 195 | launchers = launcher.all_launchers |
|
195 | 196 | eslaunchers = [ l for l in launchers if 'EngineSet' in l.__name__] |
|
196 | 197 | return [ProfileDir]+eslaunchers |
|
197 | 198 | |
|
198 | 199 | n = Int(2, config=True, |
|
199 | 200 | help="The number of engines to start.") |
|
200 | 201 | |
|
201 |
engine_launcher_class = |
|
|
202 | engine_launcher_class = DottedObjectName('LocalEngineSetLauncher', | |
|
202 | 203 | config=True, |
|
203 | 204 | help="The class for launching a set of Engines." |
|
204 | 205 | ) |
|
205 | 206 | daemonize = Bool(False, config=True, |
|
206 | 207 | help='Daemonize the ipcluster program. This implies --log-to-file') |
|
207 | 208 | |
|
208 | 209 | def _daemonize_changed(self, name, old, new): |
|
209 | 210 | if new: |
|
210 | 211 | self.log_to_file = True |
|
211 | 212 | |
|
212 | 213 | aliases = Dict(engine_aliases) |
|
213 | 214 | # flags = Dict(flags) |
|
214 | 215 | _stopping = False |
|
215 | 216 | |
|
216 | 217 | def initialize(self, argv=None): |
|
217 | 218 | super(IPClusterEngines, self).initialize(argv) |
|
218 | 219 | self.init_signal() |
|
219 | 220 | self.init_launchers() |
|
220 | 221 | |
|
221 | 222 | def init_launchers(self): |
|
222 | 223 | self.engine_launcher = self.build_launcher(self.engine_launcher_class) |
|
223 | 224 | self.engine_launcher.on_stop(lambda r: self.loop.stop()) |
|
224 | 225 | |
|
225 | 226 | def init_signal(self): |
|
226 | 227 | # Setup signals |
|
227 | 228 | signal.signal(signal.SIGINT, self.sigint_handler) |
|
228 | 229 | |
|
229 | 230 | def build_launcher(self, clsname): |
|
230 | 231 | """import and instantiate a Launcher based on importstring""" |
|
231 | 232 | if '.' not in clsname: |
|
232 | 233 | # not a module, presume it's the raw name in apps.launcher |
|
233 | 234 | clsname = 'IPython.parallel.apps.launcher.'+clsname |
|
234 | 235 | # print repr(clsname) |
|
235 | 236 | klass = import_item(clsname) |
|
236 | 237 | |
|
237 | 238 | launcher = klass( |
|
238 | 239 | work_dir=self.profile_dir.location, config=self.config, log=self.log |
|
239 | 240 | ) |
|
240 | 241 | return launcher |
|
241 | 242 | |
|
242 | 243 | def start_engines(self): |
|
243 | 244 | self.log.info("Starting %i engines"%self.n) |
|
244 | 245 | self.engine_launcher.start( |
|
245 | 246 | self.n, |
|
246 | 247 | self.profile_dir.location |
|
247 | 248 | ) |
|
248 | 249 | |
|
249 | 250 | def stop_engines(self): |
|
250 | 251 | self.log.info("Stopping Engines...") |
|
251 | 252 | if self.engine_launcher.running: |
|
252 | 253 | d = self.engine_launcher.stop() |
|
253 | 254 | return d |
|
254 | 255 | else: |
|
255 | 256 | return None |
|
256 | 257 | |
|
257 | 258 | def stop_launchers(self, r=None): |
|
258 | 259 | if not self._stopping: |
|
259 | 260 | self._stopping = True |
|
260 | 261 | self.log.error("IPython cluster: stopping") |
|
261 | 262 | self.stop_engines() |
|
262 | 263 | # Wait a few seconds to let things shut down. |
|
263 | 264 | dc = ioloop.DelayedCallback(self.loop.stop, 4000, self.loop) |
|
264 | 265 | dc.start() |
|
265 | 266 | |
|
266 | 267 | def sigint_handler(self, signum, frame): |
|
267 | 268 | self.log.debug("SIGINT received, stopping launchers...") |
|
268 | 269 | self.stop_launchers() |
|
269 | 270 | |
|
270 | 271 | def start_logging(self): |
|
271 | 272 | # Remove old log files of the controller and engine |
|
272 | 273 | if self.clean_logs: |
|
273 | 274 | log_dir = self.profile_dir.log_dir |
|
274 | 275 | for f in os.listdir(log_dir): |
|
275 | 276 | if re.match(r'ip(engine|controller)z-\d+\.(log|err|out)',f): |
|
276 | 277 | os.remove(os.path.join(log_dir, f)) |
|
277 | 278 | # This will remove old log files for ipcluster itself |
|
278 | 279 | # super(IPBaseParallelApplication, self).start_logging() |
|
279 | 280 | |
|
280 | 281 | def start(self): |
|
281 | 282 | """Start the app for the engines subcommand.""" |
|
282 | 283 | self.log.info("IPython cluster: started") |
|
283 | 284 | # First see if the cluster is already running |
|
284 | 285 | |
|
285 | 286 | # Now log and daemonize |
|
286 | 287 | self.log.info( |
|
287 | 288 | 'Starting engines with [daemon=%r]' % self.daemonize |
|
288 | 289 | ) |
|
289 | 290 | # TODO: Get daemonize working on Windows or as a Windows Server. |
|
290 | 291 | if self.daemonize: |
|
291 | 292 | if os.name=='posix': |
|
292 | 293 | daemonize() |
|
293 | 294 | |
|
294 | 295 | dc = ioloop.DelayedCallback(self.start_engines, 0, self.loop) |
|
295 | 296 | dc.start() |
|
296 | 297 | # Now write the new pid file AFTER our new forked pid is active. |
|
297 | 298 | # self.write_pid_file() |
|
298 | 299 | try: |
|
299 | 300 | self.loop.start() |
|
300 | 301 | except KeyboardInterrupt: |
|
301 | 302 | pass |
|
302 | 303 | except zmq.ZMQError as e: |
|
303 | 304 | if e.errno == errno.EINTR: |
|
304 | 305 | pass |
|
305 | 306 | else: |
|
306 | 307 | raise |
|
307 | 308 | |
|
308 | 309 | start_aliases = {} |
|
309 | 310 | start_aliases.update(engine_aliases) |
|
310 | 311 | start_aliases.update(dict( |
|
311 | 312 | delay='IPClusterStart.delay', |
|
312 | 313 | clean_logs='IPClusterStart.clean_logs', |
|
313 | 314 | )) |
|
314 | 315 | |
|
315 | 316 | class IPClusterStart(IPClusterEngines): |
|
316 | 317 | |
|
317 | 318 | name = u'ipcluster' |
|
318 | 319 | description = start_help |
|
319 | 320 | default_log_level = logging.INFO |
|
320 | 321 | auto_create = Bool(True, config=True, |
|
321 | 322 | help="whether to create the profile_dir if it doesn't exist") |
|
322 | 323 | classes = List() |
|
323 | 324 | def _classes_default(self,): |
|
324 | 325 | from IPython.parallel.apps import launcher |
|
325 | 326 | return [ProfileDir] + [IPClusterEngines] + launcher.all_launchers |
|
326 | 327 | |
|
327 | 328 | clean_logs = Bool(True, config=True, |
|
328 | 329 | help="whether to cleanup old logs before starting") |
|
329 | 330 | |
|
330 | 331 | delay = CFloat(1., config=True, |
|
331 | 332 | help="delay (in s) between starting the controller and the engines") |
|
332 | 333 | |
|
333 |
controller_launcher_class = |
|
|
334 | controller_launcher_class = DottedObjectName('LocalControllerLauncher', | |
|
334 | 335 | config=True, |
|
335 | 336 | help="The class for launching a Controller." |
|
336 | 337 | ) |
|
337 | 338 | reset = Bool(False, config=True, |
|
338 | 339 | help="Whether to reset config files as part of '--create'." |
|
339 | 340 | ) |
|
340 | 341 | |
|
341 | 342 | # flags = Dict(flags) |
|
342 | 343 | aliases = Dict(start_aliases) |
|
343 | 344 | |
|
344 | 345 | def init_launchers(self): |
|
345 | 346 | self.controller_launcher = self.build_launcher(self.controller_launcher_class) |
|
346 | 347 | self.engine_launcher = self.build_launcher(self.engine_launcher_class) |
|
347 | 348 | self.controller_launcher.on_stop(self.stop_launchers) |
|
348 | 349 | |
|
349 | 350 | def start_controller(self): |
|
350 | 351 | self.controller_launcher.start( |
|
351 | 352 | self.profile_dir.location |
|
352 | 353 | ) |
|
353 | 354 | |
|
354 | 355 | def stop_controller(self): |
|
355 | 356 | # self.log.info("In stop_controller") |
|
356 | 357 | if self.controller_launcher and self.controller_launcher.running: |
|
357 | 358 | return self.controller_launcher.stop() |
|
358 | 359 | |
|
359 | 360 | def stop_launchers(self, r=None): |
|
360 | 361 | if not self._stopping: |
|
361 | 362 | self.stop_controller() |
|
362 | 363 | super(IPClusterStart, self).stop_launchers() |
|
363 | 364 | |
|
364 | 365 | def start(self): |
|
365 | 366 | """Start the app for the start subcommand.""" |
|
366 | 367 | # First see if the cluster is already running |
|
367 | 368 | try: |
|
368 | 369 | pid = self.get_pid_from_file() |
|
369 | 370 | except PIDFileError: |
|
370 | 371 | pass |
|
371 | 372 | else: |
|
372 | 373 | if self.check_pid(pid): |
|
373 | 374 | self.log.critical( |
|
374 | 375 | 'Cluster is already running with [pid=%s]. ' |
|
375 | 376 | 'use "ipcluster stop" to stop the cluster.' % pid |
|
376 | 377 | ) |
|
377 | 378 | # Here I exit with a unusual exit status that other processes |
|
378 | 379 | # can watch for to learn how I existed. |
|
379 | 380 | self.exit(ALREADY_STARTED) |
|
380 | 381 | else: |
|
381 | 382 | self.remove_pid_file() |
|
382 | 383 | |
|
383 | 384 | |
|
384 | 385 | # Now log and daemonize |
|
385 | 386 | self.log.info( |
|
386 | 387 | 'Starting ipcluster with [daemon=%r]' % self.daemonize |
|
387 | 388 | ) |
|
388 | 389 | # TODO: Get daemonize working on Windows or as a Windows Server. |
|
389 | 390 | if self.daemonize: |
|
390 | 391 | if os.name=='posix': |
|
391 | 392 | daemonize() |
|
392 | 393 | |
|
393 | 394 | dc = ioloop.DelayedCallback(self.start_controller, 0, self.loop) |
|
394 | 395 | dc.start() |
|
395 | 396 | dc = ioloop.DelayedCallback(self.start_engines, 1000*self.delay, self.loop) |
|
396 | 397 | dc.start() |
|
397 | 398 | # Now write the new pid file AFTER our new forked pid is active. |
|
398 | 399 | self.write_pid_file() |
|
399 | 400 | try: |
|
400 | 401 | self.loop.start() |
|
401 | 402 | except KeyboardInterrupt: |
|
402 | 403 | pass |
|
403 | 404 | except zmq.ZMQError as e: |
|
404 | 405 | if e.errno == errno.EINTR: |
|
405 | 406 | pass |
|
406 | 407 | else: |
|
407 | 408 | raise |
|
408 | 409 | finally: |
|
409 | 410 | self.remove_pid_file() |
|
410 | 411 | |
|
411 | 412 | base='IPython.parallel.apps.ipclusterapp.IPCluster' |
|
412 | 413 | |
|
413 | 414 | class IPClusterApp(Application): |
|
414 | 415 | name = u'ipcluster' |
|
415 | 416 | description = _description |
|
416 | 417 | |
|
417 | 418 | subcommands = { |
|
418 | 419 | 'start' : (base+'Start', start_help), |
|
419 | 420 | 'stop' : (base+'Stop', stop_help), |
|
420 | 421 | 'engines' : (base+'Engines', engines_help), |
|
421 | 422 | } |
|
422 | 423 | |
|
423 | 424 | # no aliases or flags for parent App |
|
424 | 425 | aliases = Dict() |
|
425 | 426 | flags = Dict() |
|
426 | 427 | |
|
427 | 428 | def start(self): |
|
428 | 429 | if self.subapp is None: |
|
429 | 430 | print "No subcommand specified. Must specify one of: %s"%(self.subcommands.keys()) |
|
430 | 431 | |
|
431 | 432 | self.print_description() |
|
432 | 433 | self.print_subcommands() |
|
433 | 434 | self.exit(1) |
|
434 | 435 | else: |
|
435 | 436 | return self.subapp.start() |
|
436 | 437 | |
|
437 | 438 | def launch_new_instance(): |
|
438 | 439 | """Create and run the IPython cluster.""" |
|
439 | 440 | app = IPClusterApp.instance() |
|
440 | 441 | app.initialize() |
|
441 | 442 | app.start() |
|
442 | 443 | |
|
443 | 444 | |
|
444 | 445 | if __name__ == '__main__': |
|
445 | 446 | launch_new_instance() |
|
446 | 447 |
@@ -1,1401 +1,1403 b'' | |||
|
1 | 1 | """A semi-synchronous Client for the ZMQ cluster |
|
2 | 2 | |
|
3 | 3 | Authors: |
|
4 | 4 | |
|
5 | 5 | * MinRK |
|
6 | 6 | """ |
|
7 | 7 | #----------------------------------------------------------------------------- |
|
8 | 8 | # Copyright (C) 2010-2011 The IPython Development Team |
|
9 | 9 | # |
|
10 | 10 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | 11 | # the file COPYING, distributed as part of this software. |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | # Imports |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | import os |
|
19 | 19 | import json |
|
20 | 20 | import time |
|
21 | 21 | import warnings |
|
22 | 22 | from datetime import datetime |
|
23 | 23 | from getpass import getpass |
|
24 | 24 | from pprint import pprint |
|
25 | 25 | |
|
26 | 26 | pjoin = os.path.join |
|
27 | 27 | |
|
28 | 28 | import zmq |
|
29 | 29 | # from zmq.eventloop import ioloop, zmqstream |
|
30 | 30 | |
|
31 | 31 | from IPython.config.configurable import MultipleInstanceError |
|
32 | 32 | from IPython.core.application import BaseIPythonApplication |
|
33 | 33 | |
|
34 | 34 | from IPython.utils.jsonutil import rekey |
|
35 | 35 | from IPython.utils.path import get_ipython_dir |
|
36 | 36 | from IPython.utils.traitlets import (HasTraits, Int, Instance, Unicode, |
|
37 | 37 | Dict, List, Bool, Set) |
|
38 | 38 | from IPython.external.decorator import decorator |
|
39 | 39 | from IPython.external.ssh import tunnel |
|
40 | 40 | |
|
41 | 41 | from IPython.parallel import error |
|
42 | 42 | from IPython.parallel import util |
|
43 | 43 | |
|
44 | 44 | from IPython.zmq.session import Session, Message |
|
45 | 45 | |
|
46 | 46 | from .asyncresult import AsyncResult, AsyncHubResult |
|
47 | 47 | from IPython.core.profiledir import ProfileDir, ProfileDirError |
|
48 | 48 | from .view import DirectView, LoadBalancedView |
|
49 | 49 | |
|
50 | 50 | #-------------------------------------------------------------------------- |
|
51 | 51 | # Decorators for Client methods |
|
52 | 52 | #-------------------------------------------------------------------------- |
|
53 | 53 | |
|
54 | 54 | @decorator |
|
55 | 55 | def spin_first(f, self, *args, **kwargs): |
|
56 | 56 | """Call spin() to sync state prior to calling the method.""" |
|
57 | 57 | self.spin() |
|
58 | 58 | return f(self, *args, **kwargs) |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | #-------------------------------------------------------------------------- |
|
62 | 62 | # Classes |
|
63 | 63 | #-------------------------------------------------------------------------- |
|
64 | 64 | |
|
65 | 65 | class Metadata(dict): |
|
66 | 66 | """Subclass of dict for initializing metadata values. |
|
67 | 67 | |
|
68 | 68 | Attribute access works on keys. |
|
69 | 69 | |
|
70 | 70 | These objects have a strict set of keys - errors will raise if you try |
|
71 | 71 | to add new keys. |
|
72 | 72 | """ |
|
73 | 73 | def __init__(self, *args, **kwargs): |
|
74 | 74 | dict.__init__(self) |
|
75 | 75 | md = {'msg_id' : None, |
|
76 | 76 | 'submitted' : None, |
|
77 | 77 | 'started' : None, |
|
78 | 78 | 'completed' : None, |
|
79 | 79 | 'received' : None, |
|
80 | 80 | 'engine_uuid' : None, |
|
81 | 81 | 'engine_id' : None, |
|
82 | 82 | 'follow' : None, |
|
83 | 83 | 'after' : None, |
|
84 | 84 | 'status' : None, |
|
85 | 85 | |
|
86 | 86 | 'pyin' : None, |
|
87 | 87 | 'pyout' : None, |
|
88 | 88 | 'pyerr' : None, |
|
89 | 89 | 'stdout' : '', |
|
90 | 90 | 'stderr' : '', |
|
91 | 91 | } |
|
92 | 92 | self.update(md) |
|
93 | 93 | self.update(dict(*args, **kwargs)) |
|
94 | 94 | |
|
95 | 95 | def __getattr__(self, key): |
|
96 | 96 | """getattr aliased to getitem""" |
|
97 | 97 | if key in self.iterkeys(): |
|
98 | 98 | return self[key] |
|
99 | 99 | else: |
|
100 | 100 | raise AttributeError(key) |
|
101 | 101 | |
|
102 | 102 | def __setattr__(self, key, value): |
|
103 | 103 | """setattr aliased to setitem, with strict""" |
|
104 | 104 | if key in self.iterkeys(): |
|
105 | 105 | self[key] = value |
|
106 | 106 | else: |
|
107 | 107 | raise AttributeError(key) |
|
108 | 108 | |
|
109 | 109 | def __setitem__(self, key, value): |
|
110 | 110 | """strict static key enforcement""" |
|
111 | 111 | if key in self.iterkeys(): |
|
112 | 112 | dict.__setitem__(self, key, value) |
|
113 | 113 | else: |
|
114 | 114 | raise KeyError(key) |
|
115 | 115 | |
|
116 | 116 | |
|
117 | 117 | class Client(HasTraits): |
|
118 | 118 | """A semi-synchronous client to the IPython ZMQ cluster |
|
119 | 119 | |
|
120 | 120 | Parameters |
|
121 | 121 | ---------- |
|
122 | 122 | |
|
123 | 123 | url_or_file : bytes or unicode; zmq url or path to ipcontroller-client.json |
|
124 | 124 | Connection information for the Hub's registration. If a json connector |
|
125 | 125 | file is given, then likely no further configuration is necessary. |
|
126 | 126 | [Default: use profile] |
|
127 | 127 | profile : bytes |
|
128 | 128 | The name of the Cluster profile to be used to find connector information. |
|
129 | 129 | If run from an IPython application, the default profile will be the same |
|
130 | 130 | as the running application, otherwise it will be 'default'. |
|
131 | 131 | context : zmq.Context |
|
132 | 132 | Pass an existing zmq.Context instance, otherwise the client will create its own. |
|
133 | 133 | debug : bool |
|
134 | 134 | flag for lots of message printing for debug purposes |
|
135 | 135 | timeout : int/float |
|
136 | 136 | time (in seconds) to wait for connection replies from the Hub |
|
137 | 137 | [Default: 10] |
|
138 | 138 | |
|
139 | 139 | #-------------- session related args ---------------- |
|
140 | 140 | |
|
141 | 141 | config : Config object |
|
142 | 142 | If specified, this will be relayed to the Session for configuration |
|
143 | 143 | username : str |
|
144 | 144 | set username for the session object |
|
145 | 145 | packer : str (import_string) or callable |
|
146 | 146 | Can be either the simple keyword 'json' or 'pickle', or an import_string to a |
|
147 | 147 | function to serialize messages. Must support same input as |
|
148 | 148 | JSON, and output must be bytes. |
|
149 | 149 | You can pass a callable directly as `pack` |
|
150 | 150 | unpacker : str (import_string) or callable |
|
151 | 151 | The inverse of packer. Only necessary if packer is specified as *not* one |
|
152 | 152 | of 'json' or 'pickle'. |
|
153 | 153 | |
|
154 | 154 | #-------------- ssh related args ---------------- |
|
155 | 155 | # These are args for configuring the ssh tunnel to be used |
|
156 | 156 | # credentials are used to forward connections over ssh to the Controller |
|
157 | 157 | # Note that the ip given in `addr` needs to be relative to sshserver |
|
158 | 158 | # The most basic case is to leave addr as pointing to localhost (127.0.0.1), |
|
159 | 159 | # and set sshserver as the same machine the Controller is on. However, |
|
160 | 160 | # the only requirement is that sshserver is able to see the Controller |
|
161 | 161 | # (i.e. is within the same trusted network). |
|
162 | 162 | |
|
163 | 163 | sshserver : str |
|
164 | 164 | A string of the form passed to ssh, i.e. 'server.tld' or 'user@server.tld:port' |
|
165 | 165 | If keyfile or password is specified, and this is not, it will default to |
|
166 | 166 | the ip given in addr. |
|
167 | 167 | sshkey : str; path to public ssh key file |
|
168 | 168 | This specifies a key to be used in ssh login, default None. |
|
169 | 169 | Regular default ssh keys will be used without specifying this argument. |
|
170 | 170 | password : str |
|
171 | 171 | Your ssh password to sshserver. Note that if this is left None, |
|
172 | 172 | you will be prompted for it if passwordless key based login is unavailable. |
|
173 | 173 | paramiko : bool |
|
174 | 174 | flag for whether to use paramiko instead of shell ssh for tunneling. |
|
175 | 175 | [default: True on win32, False else] |
|
176 | 176 | |
|
177 | 177 | ------- exec authentication args ------- |
|
178 | 178 | If even localhost is untrusted, you can have some protection against |
|
179 | 179 | unauthorized execution by signing messages with HMAC digests. |
|
180 | 180 | Messages are still sent as cleartext, so if someone can snoop your |
|
181 | 181 | loopback traffic this will not protect your privacy, but will prevent |
|
182 | 182 | unauthorized execution. |
|
183 | 183 | |
|
184 | 184 | exec_key : str |
|
185 | 185 | an authentication key or file containing a key |
|
186 | 186 | default: None |
|
187 | 187 | |
|
188 | 188 | |
|
189 | 189 | Attributes |
|
190 | 190 | ---------- |
|
191 | 191 | |
|
192 | 192 | ids : list of int engine IDs |
|
193 | 193 | requesting the ids attribute always synchronizes |
|
194 | 194 | the registration state. To request ids without synchronization, |
|
195 | 195 | use semi-private _ids attributes. |
|
196 | 196 | |
|
197 | 197 | history : list of msg_ids |
|
198 | 198 | a list of msg_ids, keeping track of all the execution |
|
199 | 199 | messages you have submitted in order. |
|
200 | 200 | |
|
201 | 201 | outstanding : set of msg_ids |
|
202 | 202 | a set of msg_ids that have been submitted, but whose |
|
203 | 203 | results have not yet been received. |
|
204 | 204 | |
|
205 | 205 | results : dict |
|
206 | 206 | a dict of all our results, keyed by msg_id |
|
207 | 207 | |
|
208 | 208 | block : bool |
|
209 | 209 | determines default behavior when block not specified |
|
210 | 210 | in execution methods |
|
211 | 211 | |
|
212 | 212 | Methods |
|
213 | 213 | ------- |
|
214 | 214 | |
|
215 | 215 | spin |
|
216 | 216 | flushes incoming results and registration state changes |
|
217 | 217 | control methods spin, and requesting `ids` also ensures up to date |
|
218 | 218 | |
|
219 | 219 | wait |
|
220 | 220 | wait on one or more msg_ids |
|
221 | 221 | |
|
222 | 222 | execution methods |
|
223 | 223 | apply |
|
224 | 224 | legacy: execute, run |
|
225 | 225 | |
|
226 | 226 | data movement |
|
227 | 227 | push, pull, scatter, gather |
|
228 | 228 | |
|
229 | 229 | query methods |
|
230 | 230 | queue_status, get_result, purge, result_status |
|
231 | 231 | |
|
232 | 232 | control methods |
|
233 | 233 | abort, shutdown |
|
234 | 234 | |
|
235 | 235 | """ |
|
236 | 236 | |
|
237 | 237 | |
|
238 | 238 | block = Bool(False) |
|
239 | 239 | outstanding = Set() |
|
240 | 240 | results = Instance('collections.defaultdict', (dict,)) |
|
241 | 241 | metadata = Instance('collections.defaultdict', (Metadata,)) |
|
242 | 242 | history = List() |
|
243 | 243 | debug = Bool(False) |
|
244 | 244 | |
|
245 | 245 | profile=Unicode() |
|
246 | 246 | def _profile_default(self): |
|
247 | 247 | if BaseIPythonApplication.initialized(): |
|
248 | 248 | # an IPython app *might* be running, try to get its profile |
|
249 | 249 | try: |
|
250 | 250 | return BaseIPythonApplication.instance().profile |
|
251 | 251 | except (AttributeError, MultipleInstanceError): |
|
252 | 252 | # could be a *different* subclass of config.Application, |
|
253 | 253 | # which would raise one of these two errors. |
|
254 | 254 | return u'default' |
|
255 | 255 | else: |
|
256 | 256 | return u'default' |
|
257 | 257 | |
|
258 | 258 | |
|
259 | 259 | _outstanding_dict = Instance('collections.defaultdict', (set,)) |
|
260 | 260 | _ids = List() |
|
261 | 261 | _connected=Bool(False) |
|
262 | 262 | _ssh=Bool(False) |
|
263 | 263 | _context = Instance('zmq.Context') |
|
264 | 264 | _config = Dict() |
|
265 | 265 | _engines=Instance(util.ReverseDict, (), {}) |
|
266 | 266 | # _hub_socket=Instance('zmq.Socket') |
|
267 | 267 | _query_socket=Instance('zmq.Socket') |
|
268 | 268 | _control_socket=Instance('zmq.Socket') |
|
269 | 269 | _iopub_socket=Instance('zmq.Socket') |
|
270 | 270 | _notification_socket=Instance('zmq.Socket') |
|
271 | 271 | _mux_socket=Instance('zmq.Socket') |
|
272 | 272 | _task_socket=Instance('zmq.Socket') |
|
273 | 273 | _task_scheme=Unicode() |
|
274 | 274 | _closed = False |
|
275 | 275 | _ignored_control_replies=Int(0) |
|
276 | 276 | _ignored_hub_replies=Int(0) |
|
277 | 277 | |
|
278 | 278 | def __new__(self, *args, **kw): |
|
279 | 279 | # don't raise on positional args |
|
280 | 280 | return HasTraits.__new__(self, **kw) |
|
281 | 281 | |
|
282 | 282 | def __init__(self, url_or_file=None, profile=None, profile_dir=None, ipython_dir=None, |
|
283 | 283 | context=None, debug=False, exec_key=None, |
|
284 | 284 | sshserver=None, sshkey=None, password=None, paramiko=None, |
|
285 | 285 | timeout=10, **extra_args |
|
286 | 286 | ): |
|
287 | 287 | if profile: |
|
288 | 288 | super(Client, self).__init__(debug=debug, profile=profile) |
|
289 | 289 | else: |
|
290 | 290 | super(Client, self).__init__(debug=debug) |
|
291 | 291 | if context is None: |
|
292 | 292 | context = zmq.Context.instance() |
|
293 | 293 | self._context = context |
|
294 | 294 | |
|
295 | 295 | self._setup_profile_dir(self.profile, profile_dir, ipython_dir) |
|
296 | 296 | if self._cd is not None: |
|
297 | 297 | if url_or_file is None: |
|
298 | 298 | url_or_file = pjoin(self._cd.security_dir, 'ipcontroller-client.json') |
|
299 | 299 | assert url_or_file is not None, "I can't find enough information to connect to a hub!"\ |
|
300 | 300 | " Please specify at least one of url_or_file or profile." |
|
301 | 301 | |
|
302 | 302 | try: |
|
303 | 303 | util.validate_url(url_or_file) |
|
304 | 304 | except AssertionError: |
|
305 | 305 | if not os.path.exists(url_or_file): |
|
306 | 306 | if self._cd: |
|
307 | 307 | url_or_file = os.path.join(self._cd.security_dir, url_or_file) |
|
308 | 308 | assert os.path.exists(url_or_file), "Not a valid connection file or url: %r"%url_or_file |
|
309 | 309 | with open(url_or_file) as f: |
|
310 | 310 | cfg = json.loads(f.read()) |
|
311 | 311 | else: |
|
312 | 312 | cfg = {'url':url_or_file} |
|
313 | 313 | |
|
314 | 314 | # sync defaults from args, json: |
|
315 | 315 | if sshserver: |
|
316 | 316 | cfg['ssh'] = sshserver |
|
317 | 317 | if exec_key: |
|
318 | 318 | cfg['exec_key'] = exec_key |
|
319 | 319 | exec_key = cfg['exec_key'] |
|
320 | 320 | sshserver=cfg['ssh'] |
|
321 | 321 | url = cfg['url'] |
|
322 | 322 | location = cfg.setdefault('location', None) |
|
323 | 323 | cfg['url'] = util.disambiguate_url(cfg['url'], location) |
|
324 | 324 | url = cfg['url'] |
|
325 | 325 | |
|
326 | 326 | self._config = cfg |
|
327 | 327 | |
|
328 | 328 | self._ssh = bool(sshserver or sshkey or password) |
|
329 | 329 | if self._ssh and sshserver is None: |
|
330 | 330 | # default to ssh via localhost |
|
331 | 331 | sshserver = url.split('://')[1].split(':')[0] |
|
332 | 332 | if self._ssh and password is None: |
|
333 | 333 | if tunnel.try_passwordless_ssh(sshserver, sshkey, paramiko): |
|
334 | 334 | password=False |
|
335 | 335 | else: |
|
336 | 336 | password = getpass("SSH Password for %s: "%sshserver) |
|
337 | 337 | ssh_kwargs = dict(keyfile=sshkey, password=password, paramiko=paramiko) |
|
338 | 338 | |
|
339 | 339 | # configure and construct the session |
|
340 | 340 | if exec_key is not None: |
|
341 | 341 | if os.path.isfile(exec_key): |
|
342 | 342 | extra_args['keyfile'] = exec_key |
|
343 | 343 | else: |
|
344 | if isinstance(exec_key, unicode): | |
|
345 | exec_key = exec_key.encode('ascii') | |
|
344 | 346 | extra_args['key'] = exec_key |
|
345 | 347 | self.session = Session(**extra_args) |
|
346 | 348 | |
|
347 | 349 | self._query_socket = self._context.socket(zmq.XREQ) |
|
348 | 350 | self._query_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
349 | 351 | if self._ssh: |
|
350 | 352 | tunnel.tunnel_connection(self._query_socket, url, sshserver, **ssh_kwargs) |
|
351 | 353 | else: |
|
352 | 354 | self._query_socket.connect(url) |
|
353 | 355 | |
|
354 | 356 | self.session.debug = self.debug |
|
355 | 357 | |
|
356 | 358 | self._notification_handlers = {'registration_notification' : self._register_engine, |
|
357 | 359 | 'unregistration_notification' : self._unregister_engine, |
|
358 | 360 | 'shutdown_notification' : lambda msg: self.close(), |
|
359 | 361 | } |
|
360 | 362 | self._queue_handlers = {'execute_reply' : self._handle_execute_reply, |
|
361 | 363 | 'apply_reply' : self._handle_apply_reply} |
|
362 | 364 | self._connect(sshserver, ssh_kwargs, timeout) |
|
363 | 365 | |
|
364 | 366 | def __del__(self): |
|
365 | 367 | """cleanup sockets, but _not_ context.""" |
|
366 | 368 | self.close() |
|
367 | 369 | |
|
368 | 370 | def _setup_profile_dir(self, profile, profile_dir, ipython_dir): |
|
369 | 371 | if ipython_dir is None: |
|
370 | 372 | ipython_dir = get_ipython_dir() |
|
371 | 373 | if profile_dir is not None: |
|
372 | 374 | try: |
|
373 | 375 | self._cd = ProfileDir.find_profile_dir(profile_dir) |
|
374 | 376 | return |
|
375 | 377 | except ProfileDirError: |
|
376 | 378 | pass |
|
377 | 379 | elif profile is not None: |
|
378 | 380 | try: |
|
379 | 381 | self._cd = ProfileDir.find_profile_dir_by_name( |
|
380 | 382 | ipython_dir, profile) |
|
381 | 383 | return |
|
382 | 384 | except ProfileDirError: |
|
383 | 385 | pass |
|
384 | 386 | self._cd = None |
|
385 | 387 | |
|
386 | 388 | def _update_engines(self, engines): |
|
387 | 389 | """Update our engines dict and _ids from a dict of the form: {id:uuid}.""" |
|
388 | 390 | for k,v in engines.iteritems(): |
|
389 | 391 | eid = int(k) |
|
390 | 392 | self._engines[eid] = bytes(v) # force not unicode |
|
391 | 393 | self._ids.append(eid) |
|
392 | 394 | self._ids = sorted(self._ids) |
|
393 | 395 | if sorted(self._engines.keys()) != range(len(self._engines)) and \ |
|
394 | 396 | self._task_scheme == 'pure' and self._task_socket: |
|
395 | 397 | self._stop_scheduling_tasks() |
|
396 | 398 | |
|
397 | 399 | def _stop_scheduling_tasks(self): |
|
398 | 400 | """Stop scheduling tasks because an engine has been unregistered |
|
399 | 401 | from a pure ZMQ scheduler. |
|
400 | 402 | """ |
|
401 | 403 | self._task_socket.close() |
|
402 | 404 | self._task_socket = None |
|
403 | 405 | msg = "An engine has been unregistered, and we are using pure " +\ |
|
404 | 406 | "ZMQ task scheduling. Task farming will be disabled." |
|
405 | 407 | if self.outstanding: |
|
406 | 408 | msg += " If you were running tasks when this happened, " +\ |
|
407 | 409 | "some `outstanding` msg_ids may never resolve." |
|
408 | 410 | warnings.warn(msg, RuntimeWarning) |
|
409 | 411 | |
|
410 | 412 | def _build_targets(self, targets): |
|
411 | 413 | """Turn valid target IDs or 'all' into two lists: |
|
412 | 414 | (int_ids, uuids). |
|
413 | 415 | """ |
|
414 | 416 | if not self._ids: |
|
415 | 417 | # flush notification socket if no engines yet, just in case |
|
416 | 418 | if not self.ids: |
|
417 | 419 | raise error.NoEnginesRegistered("Can't build targets without any engines") |
|
418 | 420 | |
|
419 | 421 | if targets is None: |
|
420 | 422 | targets = self._ids |
|
421 | 423 | elif isinstance(targets, str): |
|
422 | 424 | if targets.lower() == 'all': |
|
423 | 425 | targets = self._ids |
|
424 | 426 | else: |
|
425 | 427 | raise TypeError("%r not valid str target, must be 'all'"%(targets)) |
|
426 | 428 | elif isinstance(targets, int): |
|
427 | 429 | if targets < 0: |
|
428 | 430 | targets = self.ids[targets] |
|
429 | 431 | if targets not in self._ids: |
|
430 | 432 | raise IndexError("No such engine: %i"%targets) |
|
431 | 433 | targets = [targets] |
|
432 | 434 | |
|
433 | 435 | if isinstance(targets, slice): |
|
434 | 436 | indices = range(len(self._ids))[targets] |
|
435 | 437 | ids = self.ids |
|
436 | 438 | targets = [ ids[i] for i in indices ] |
|
437 | 439 | |
|
438 | 440 | if not isinstance(targets, (tuple, list, xrange)): |
|
439 | 441 | raise TypeError("targets by int/slice/collection of ints only, not %s"%(type(targets))) |
|
440 | 442 | |
|
441 | 443 | return [self._engines[t] for t in targets], list(targets) |
|
442 | 444 | |
|
443 | 445 | def _connect(self, sshserver, ssh_kwargs, timeout): |
|
444 | 446 | """setup all our socket connections to the cluster. This is called from |
|
445 | 447 | __init__.""" |
|
446 | 448 | |
|
447 | 449 | # Maybe allow reconnecting? |
|
448 | 450 | if self._connected: |
|
449 | 451 | return |
|
450 | 452 | self._connected=True |
|
451 | 453 | |
|
452 | 454 | def connect_socket(s, url): |
|
453 | 455 | url = util.disambiguate_url(url, self._config['location']) |
|
454 | 456 | if self._ssh: |
|
455 | 457 | return tunnel.tunnel_connection(s, url, sshserver, **ssh_kwargs) |
|
456 | 458 | else: |
|
457 | 459 | return s.connect(url) |
|
458 | 460 | |
|
459 | 461 | self.session.send(self._query_socket, 'connection_request') |
|
460 | 462 | # use Poller because zmq.select has wrong units in pyzmq 2.1.7 |
|
461 | 463 | poller = zmq.Poller() |
|
462 | 464 | poller.register(self._query_socket, zmq.POLLIN) |
|
463 | 465 | # poll expects milliseconds, timeout is seconds |
|
464 | 466 | evts = poller.poll(timeout*1000) |
|
465 | 467 | if not evts: |
|
466 | 468 | raise error.TimeoutError("Hub connection request timed out") |
|
467 | 469 | idents,msg = self.session.recv(self._query_socket,mode=0) |
|
468 | 470 | if self.debug: |
|
469 | 471 | pprint(msg) |
|
470 | 472 | msg = Message(msg) |
|
471 | 473 | content = msg.content |
|
472 | 474 | self._config['registration'] = dict(content) |
|
473 | 475 | if content.status == 'ok': |
|
474 | 476 | if content.mux: |
|
475 | 477 | self._mux_socket = self._context.socket(zmq.XREQ) |
|
476 | 478 | self._mux_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
477 | 479 | connect_socket(self._mux_socket, content.mux) |
|
478 | 480 | if content.task: |
|
479 | 481 | self._task_scheme, task_addr = content.task |
|
480 | 482 | self._task_socket = self._context.socket(zmq.XREQ) |
|
481 | 483 | self._task_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
482 | 484 | connect_socket(self._task_socket, task_addr) |
|
483 | 485 | if content.notification: |
|
484 | 486 | self._notification_socket = self._context.socket(zmq.SUB) |
|
485 | 487 | connect_socket(self._notification_socket, content.notification) |
|
486 | 488 | self._notification_socket.setsockopt(zmq.SUBSCRIBE, b'') |
|
487 | 489 | # if content.query: |
|
488 | 490 | # self._query_socket = self._context.socket(zmq.XREQ) |
|
489 | 491 | # self._query_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
490 | 492 | # connect_socket(self._query_socket, content.query) |
|
491 | 493 | if content.control: |
|
492 | 494 | self._control_socket = self._context.socket(zmq.XREQ) |
|
493 | 495 | self._control_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
494 | 496 | connect_socket(self._control_socket, content.control) |
|
495 | 497 | if content.iopub: |
|
496 | 498 | self._iopub_socket = self._context.socket(zmq.SUB) |
|
497 | 499 | self._iopub_socket.setsockopt(zmq.SUBSCRIBE, b'') |
|
498 | 500 | self._iopub_socket.setsockopt(zmq.IDENTITY, self.session.session) |
|
499 | 501 | connect_socket(self._iopub_socket, content.iopub) |
|
500 | 502 | self._update_engines(dict(content.engines)) |
|
501 | 503 | else: |
|
502 | 504 | self._connected = False |
|
503 | 505 | raise Exception("Failed to connect!") |
|
504 | 506 | |
|
505 | 507 | #-------------------------------------------------------------------------- |
|
506 | 508 | # handlers and callbacks for incoming messages |
|
507 | 509 | #-------------------------------------------------------------------------- |
|
508 | 510 | |
|
509 | 511 | def _unwrap_exception(self, content): |
|
510 | 512 | """unwrap exception, and remap engine_id to int.""" |
|
511 | 513 | e = error.unwrap_exception(content) |
|
512 | 514 | # print e.traceback |
|
513 | 515 | if e.engine_info: |
|
514 | 516 | e_uuid = e.engine_info['engine_uuid'] |
|
515 | 517 | eid = self._engines[e_uuid] |
|
516 | 518 | e.engine_info['engine_id'] = eid |
|
517 | 519 | return e |
|
518 | 520 | |
|
519 | 521 | def _extract_metadata(self, header, parent, content): |
|
520 | 522 | md = {'msg_id' : parent['msg_id'], |
|
521 | 523 | 'received' : datetime.now(), |
|
522 | 524 | 'engine_uuid' : header.get('engine', None), |
|
523 | 525 | 'follow' : parent.get('follow', []), |
|
524 | 526 | 'after' : parent.get('after', []), |
|
525 | 527 | 'status' : content['status'], |
|
526 | 528 | } |
|
527 | 529 | |
|
528 | 530 | if md['engine_uuid'] is not None: |
|
529 | 531 | md['engine_id'] = self._engines.get(md['engine_uuid'], None) |
|
530 | 532 | |
|
531 | 533 | if 'date' in parent: |
|
532 | 534 | md['submitted'] = parent['date'] |
|
533 | 535 | if 'started' in header: |
|
534 | 536 | md['started'] = header['started'] |
|
535 | 537 | if 'date' in header: |
|
536 | 538 | md['completed'] = header['date'] |
|
537 | 539 | return md |
|
538 | 540 | |
|
539 | 541 | def _register_engine(self, msg): |
|
540 | 542 | """Register a new engine, and update our connection info.""" |
|
541 | 543 | content = msg['content'] |
|
542 | 544 | eid = content['id'] |
|
543 | 545 | d = {eid : content['queue']} |
|
544 | 546 | self._update_engines(d) |
|
545 | 547 | |
|
546 | 548 | def _unregister_engine(self, msg): |
|
547 | 549 | """Unregister an engine that has died.""" |
|
548 | 550 | content = msg['content'] |
|
549 | 551 | eid = int(content['id']) |
|
550 | 552 | if eid in self._ids: |
|
551 | 553 | self._ids.remove(eid) |
|
552 | 554 | uuid = self._engines.pop(eid) |
|
553 | 555 | |
|
554 | 556 | self._handle_stranded_msgs(eid, uuid) |
|
555 | 557 | |
|
556 | 558 | if self._task_socket and self._task_scheme == 'pure': |
|
557 | 559 | self._stop_scheduling_tasks() |
|
558 | 560 | |
|
559 | 561 | def _handle_stranded_msgs(self, eid, uuid): |
|
560 | 562 | """Handle messages known to be on an engine when the engine unregisters. |
|
561 | 563 | |
|
562 | 564 | It is possible that this will fire prematurely - that is, an engine will |
|
563 | 565 | go down after completing a result, and the client will be notified |
|
564 | 566 | of the unregistration and later receive the successful result. |
|
565 | 567 | """ |
|
566 | 568 | |
|
567 | 569 | outstanding = self._outstanding_dict[uuid] |
|
568 | 570 | |
|
569 | 571 | for msg_id in list(outstanding): |
|
570 | 572 | if msg_id in self.results: |
|
571 | 573 | # we already |
|
572 | 574 | continue |
|
573 | 575 | try: |
|
574 | 576 | raise error.EngineError("Engine %r died while running task %r"%(eid, msg_id)) |
|
575 | 577 | except: |
|
576 | 578 | content = error.wrap_exception() |
|
577 | 579 | # build a fake message: |
|
578 | 580 | parent = {} |
|
579 | 581 | header = {} |
|
580 | 582 | parent['msg_id'] = msg_id |
|
581 | 583 | header['engine'] = uuid |
|
582 | 584 | header['date'] = datetime.now() |
|
583 | 585 | msg = dict(parent_header=parent, header=header, content=content) |
|
584 | 586 | self._handle_apply_reply(msg) |
|
585 | 587 | |
|
586 | 588 | def _handle_execute_reply(self, msg): |
|
587 | 589 | """Save the reply to an execute_request into our results. |
|
588 | 590 | |
|
589 | 591 | execute messages are never actually used. apply is used instead. |
|
590 | 592 | """ |
|
591 | 593 | |
|
592 | 594 | parent = msg['parent_header'] |
|
593 | 595 | msg_id = parent['msg_id'] |
|
594 | 596 | if msg_id not in self.outstanding: |
|
595 | 597 | if msg_id in self.history: |
|
596 | 598 | print ("got stale result: %s"%msg_id) |
|
597 | 599 | else: |
|
598 | 600 | print ("got unknown result: %s"%msg_id) |
|
599 | 601 | else: |
|
600 | 602 | self.outstanding.remove(msg_id) |
|
601 | 603 | self.results[msg_id] = self._unwrap_exception(msg['content']) |
|
602 | 604 | |
|
603 | 605 | def _handle_apply_reply(self, msg): |
|
604 | 606 | """Save the reply to an apply_request into our results.""" |
|
605 | 607 | parent = msg['parent_header'] |
|
606 | 608 | msg_id = parent['msg_id'] |
|
607 | 609 | if msg_id not in self.outstanding: |
|
608 | 610 | if msg_id in self.history: |
|
609 | 611 | print ("got stale result: %s"%msg_id) |
|
610 | 612 | print self.results[msg_id] |
|
611 | 613 | print msg |
|
612 | 614 | else: |
|
613 | 615 | print ("got unknown result: %s"%msg_id) |
|
614 | 616 | else: |
|
615 | 617 | self.outstanding.remove(msg_id) |
|
616 | 618 | content = msg['content'] |
|
617 | 619 | header = msg['header'] |
|
618 | 620 | |
|
619 | 621 | # construct metadata: |
|
620 | 622 | md = self.metadata[msg_id] |
|
621 | 623 | md.update(self._extract_metadata(header, parent, content)) |
|
622 | 624 | # is this redundant? |
|
623 | 625 | self.metadata[msg_id] = md |
|
624 | 626 | |
|
625 | 627 | e_outstanding = self._outstanding_dict[md['engine_uuid']] |
|
626 | 628 | if msg_id in e_outstanding: |
|
627 | 629 | e_outstanding.remove(msg_id) |
|
628 | 630 | |
|
629 | 631 | # construct result: |
|
630 | 632 | if content['status'] == 'ok': |
|
631 | 633 | self.results[msg_id] = util.unserialize_object(msg['buffers'])[0] |
|
632 | 634 | elif content['status'] == 'aborted': |
|
633 | 635 | self.results[msg_id] = error.TaskAborted(msg_id) |
|
634 | 636 | elif content['status'] == 'resubmitted': |
|
635 | 637 | # TODO: handle resubmission |
|
636 | 638 | pass |
|
637 | 639 | else: |
|
638 | 640 | self.results[msg_id] = self._unwrap_exception(content) |
|
639 | 641 | |
|
640 | 642 | def _flush_notifications(self): |
|
641 | 643 | """Flush notifications of engine registrations waiting |
|
642 | 644 | in ZMQ queue.""" |
|
643 | 645 | idents,msg = self.session.recv(self._notification_socket, mode=zmq.NOBLOCK) |
|
644 | 646 | while msg is not None: |
|
645 | 647 | if self.debug: |
|
646 | 648 | pprint(msg) |
|
647 | 649 | msg_type = msg['msg_type'] |
|
648 | 650 | handler = self._notification_handlers.get(msg_type, None) |
|
649 | 651 | if handler is None: |
|
650 | 652 | raise Exception("Unhandled message type: %s"%msg.msg_type) |
|
651 | 653 | else: |
|
652 | 654 | handler(msg) |
|
653 | 655 | idents,msg = self.session.recv(self._notification_socket, mode=zmq.NOBLOCK) |
|
654 | 656 | |
|
655 | 657 | def _flush_results(self, sock): |
|
656 | 658 | """Flush task or queue results waiting in ZMQ queue.""" |
|
657 | 659 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
658 | 660 | while msg is not None: |
|
659 | 661 | if self.debug: |
|
660 | 662 | pprint(msg) |
|
661 | 663 | msg_type = msg['msg_type'] |
|
662 | 664 | handler = self._queue_handlers.get(msg_type, None) |
|
663 | 665 | if handler is None: |
|
664 | 666 | raise Exception("Unhandled message type: %s"%msg.msg_type) |
|
665 | 667 | else: |
|
666 | 668 | handler(msg) |
|
667 | 669 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
668 | 670 | |
|
669 | 671 | def _flush_control(self, sock): |
|
670 | 672 | """Flush replies from the control channel waiting |
|
671 | 673 | in the ZMQ queue. |
|
672 | 674 | |
|
673 | 675 | Currently: ignore them.""" |
|
674 | 676 | if self._ignored_control_replies <= 0: |
|
675 | 677 | return |
|
676 | 678 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
677 | 679 | while msg is not None: |
|
678 | 680 | self._ignored_control_replies -= 1 |
|
679 | 681 | if self.debug: |
|
680 | 682 | pprint(msg) |
|
681 | 683 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
682 | 684 | |
|
683 | 685 | def _flush_ignored_control(self): |
|
684 | 686 | """flush ignored control replies""" |
|
685 | 687 | while self._ignored_control_replies > 0: |
|
686 | 688 | self.session.recv(self._control_socket) |
|
687 | 689 | self._ignored_control_replies -= 1 |
|
688 | 690 | |
|
689 | 691 | def _flush_ignored_hub_replies(self): |
|
690 | 692 | ident,msg = self.session.recv(self._query_socket, mode=zmq.NOBLOCK) |
|
691 | 693 | while msg is not None: |
|
692 | 694 | ident,msg = self.session.recv(self._query_socket, mode=zmq.NOBLOCK) |
|
693 | 695 | |
|
694 | 696 | def _flush_iopub(self, sock): |
|
695 | 697 | """Flush replies from the iopub channel waiting |
|
696 | 698 | in the ZMQ queue. |
|
697 | 699 | """ |
|
698 | 700 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
699 | 701 | while msg is not None: |
|
700 | 702 | if self.debug: |
|
701 | 703 | pprint(msg) |
|
702 | 704 | parent = msg['parent_header'] |
|
703 | 705 | msg_id = parent['msg_id'] |
|
704 | 706 | content = msg['content'] |
|
705 | 707 | header = msg['header'] |
|
706 | 708 | msg_type = msg['msg_type'] |
|
707 | 709 | |
|
708 | 710 | # init metadata: |
|
709 | 711 | md = self.metadata[msg_id] |
|
710 | 712 | |
|
711 | 713 | if msg_type == 'stream': |
|
712 | 714 | name = content['name'] |
|
713 | 715 | s = md[name] or '' |
|
714 | 716 | md[name] = s + content['data'] |
|
715 | 717 | elif msg_type == 'pyerr': |
|
716 | 718 | md.update({'pyerr' : self._unwrap_exception(content)}) |
|
717 | 719 | elif msg_type == 'pyin': |
|
718 | 720 | md.update({'pyin' : content['code']}) |
|
719 | 721 | else: |
|
720 | 722 | md.update({msg_type : content.get('data', '')}) |
|
721 | 723 | |
|
722 | 724 | # reduntant? |
|
723 | 725 | self.metadata[msg_id] = md |
|
724 | 726 | |
|
725 | 727 | idents,msg = self.session.recv(sock, mode=zmq.NOBLOCK) |
|
726 | 728 | |
|
727 | 729 | #-------------------------------------------------------------------------- |
|
728 | 730 | # len, getitem |
|
729 | 731 | #-------------------------------------------------------------------------- |
|
730 | 732 | |
|
731 | 733 | def __len__(self): |
|
732 | 734 | """len(client) returns # of engines.""" |
|
733 | 735 | return len(self.ids) |
|
734 | 736 | |
|
735 | 737 | def __getitem__(self, key): |
|
736 | 738 | """index access returns DirectView multiplexer objects |
|
737 | 739 | |
|
738 | 740 | Must be int, slice, or list/tuple/xrange of ints""" |
|
739 | 741 | if not isinstance(key, (int, slice, tuple, list, xrange)): |
|
740 | 742 | raise TypeError("key by int/slice/iterable of ints only, not %s"%(type(key))) |
|
741 | 743 | else: |
|
742 | 744 | return self.direct_view(key) |
|
743 | 745 | |
|
744 | 746 | #-------------------------------------------------------------------------- |
|
745 | 747 | # Begin public methods |
|
746 | 748 | #-------------------------------------------------------------------------- |
|
747 | 749 | |
|
748 | 750 | @property |
|
749 | 751 | def ids(self): |
|
750 | 752 | """Always up-to-date ids property.""" |
|
751 | 753 | self._flush_notifications() |
|
752 | 754 | # always copy: |
|
753 | 755 | return list(self._ids) |
|
754 | 756 | |
|
755 | 757 | def close(self): |
|
756 | 758 | if self._closed: |
|
757 | 759 | return |
|
758 | 760 | snames = filter(lambda n: n.endswith('socket'), dir(self)) |
|
759 | 761 | for socket in map(lambda name: getattr(self, name), snames): |
|
760 | 762 | if isinstance(socket, zmq.Socket) and not socket.closed: |
|
761 | 763 | socket.close() |
|
762 | 764 | self._closed = True |
|
763 | 765 | |
|
764 | 766 | def spin(self): |
|
765 | 767 | """Flush any registration notifications and execution results |
|
766 | 768 | waiting in the ZMQ queue. |
|
767 | 769 | """ |
|
768 | 770 | if self._notification_socket: |
|
769 | 771 | self._flush_notifications() |
|
770 | 772 | if self._mux_socket: |
|
771 | 773 | self._flush_results(self._mux_socket) |
|
772 | 774 | if self._task_socket: |
|
773 | 775 | self._flush_results(self._task_socket) |
|
774 | 776 | if self._control_socket: |
|
775 | 777 | self._flush_control(self._control_socket) |
|
776 | 778 | if self._iopub_socket: |
|
777 | 779 | self._flush_iopub(self._iopub_socket) |
|
778 | 780 | if self._query_socket: |
|
779 | 781 | self._flush_ignored_hub_replies() |
|
780 | 782 | |
|
781 | 783 | def wait(self, jobs=None, timeout=-1): |
|
782 | 784 | """waits on one or more `jobs`, for up to `timeout` seconds. |
|
783 | 785 | |
|
784 | 786 | Parameters |
|
785 | 787 | ---------- |
|
786 | 788 | |
|
787 | 789 | jobs : int, str, or list of ints and/or strs, or one or more AsyncResult objects |
|
788 | 790 | ints are indices to self.history |
|
789 | 791 | strs are msg_ids |
|
790 | 792 | default: wait on all outstanding messages |
|
791 | 793 | timeout : float |
|
792 | 794 | a time in seconds, after which to give up. |
|
793 | 795 | default is -1, which means no timeout |
|
794 | 796 | |
|
795 | 797 | Returns |
|
796 | 798 | ------- |
|
797 | 799 | |
|
798 | 800 | True : when all msg_ids are done |
|
799 | 801 | False : timeout reached, some msg_ids still outstanding |
|
800 | 802 | """ |
|
801 | 803 | tic = time.time() |
|
802 | 804 | if jobs is None: |
|
803 | 805 | theids = self.outstanding |
|
804 | 806 | else: |
|
805 | 807 | if isinstance(jobs, (int, str, AsyncResult)): |
|
806 | 808 | jobs = [jobs] |
|
807 | 809 | theids = set() |
|
808 | 810 | for job in jobs: |
|
809 | 811 | if isinstance(job, int): |
|
810 | 812 | # index access |
|
811 | 813 | job = self.history[job] |
|
812 | 814 | elif isinstance(job, AsyncResult): |
|
813 | 815 | map(theids.add, job.msg_ids) |
|
814 | 816 | continue |
|
815 | 817 | theids.add(job) |
|
816 | 818 | if not theids.intersection(self.outstanding): |
|
817 | 819 | return True |
|
818 | 820 | self.spin() |
|
819 | 821 | while theids.intersection(self.outstanding): |
|
820 | 822 | if timeout >= 0 and ( time.time()-tic ) > timeout: |
|
821 | 823 | break |
|
822 | 824 | time.sleep(1e-3) |
|
823 | 825 | self.spin() |
|
824 | 826 | return len(theids.intersection(self.outstanding)) == 0 |
|
825 | 827 | |
|
826 | 828 | #-------------------------------------------------------------------------- |
|
827 | 829 | # Control methods |
|
828 | 830 | #-------------------------------------------------------------------------- |
|
829 | 831 | |
|
830 | 832 | @spin_first |
|
831 | 833 | def clear(self, targets=None, block=None): |
|
832 | 834 | """Clear the namespace in target(s).""" |
|
833 | 835 | block = self.block if block is None else block |
|
834 | 836 | targets = self._build_targets(targets)[0] |
|
835 | 837 | for t in targets: |
|
836 | 838 | self.session.send(self._control_socket, 'clear_request', content={}, ident=t) |
|
837 | 839 | error = False |
|
838 | 840 | if block: |
|
839 | 841 | self._flush_ignored_control() |
|
840 | 842 | for i in range(len(targets)): |
|
841 | 843 | idents,msg = self.session.recv(self._control_socket,0) |
|
842 | 844 | if self.debug: |
|
843 | 845 | pprint(msg) |
|
844 | 846 | if msg['content']['status'] != 'ok': |
|
845 | 847 | error = self._unwrap_exception(msg['content']) |
|
846 | 848 | else: |
|
847 | 849 | self._ignored_control_replies += len(targets) |
|
848 | 850 | if error: |
|
849 | 851 | raise error |
|
850 | 852 | |
|
851 | 853 | |
|
852 | 854 | @spin_first |
|
853 | 855 | def abort(self, jobs=None, targets=None, block=None): |
|
854 | 856 | """Abort specific jobs from the execution queues of target(s). |
|
855 | 857 | |
|
856 | 858 | This is a mechanism to prevent jobs that have already been submitted |
|
857 | 859 | from executing. |
|
858 | 860 | |
|
859 | 861 | Parameters |
|
860 | 862 | ---------- |
|
861 | 863 | |
|
862 | 864 | jobs : msg_id, list of msg_ids, or AsyncResult |
|
863 | 865 | The jobs to be aborted |
|
864 | 866 | |
|
865 | 867 | |
|
866 | 868 | """ |
|
867 | 869 | block = self.block if block is None else block |
|
868 | 870 | targets = self._build_targets(targets)[0] |
|
869 | 871 | msg_ids = [] |
|
870 | 872 | if isinstance(jobs, (basestring,AsyncResult)): |
|
871 | 873 | jobs = [jobs] |
|
872 | 874 | bad_ids = filter(lambda obj: not isinstance(obj, (basestring, AsyncResult)), jobs) |
|
873 | 875 | if bad_ids: |
|
874 | 876 | raise TypeError("Invalid msg_id type %r, expected str or AsyncResult"%bad_ids[0]) |
|
875 | 877 | for j in jobs: |
|
876 | 878 | if isinstance(j, AsyncResult): |
|
877 | 879 | msg_ids.extend(j.msg_ids) |
|
878 | 880 | else: |
|
879 | 881 | msg_ids.append(j) |
|
880 | 882 | content = dict(msg_ids=msg_ids) |
|
881 | 883 | for t in targets: |
|
882 | 884 | self.session.send(self._control_socket, 'abort_request', |
|
883 | 885 | content=content, ident=t) |
|
884 | 886 | error = False |
|
885 | 887 | if block: |
|
886 | 888 | self._flush_ignored_control() |
|
887 | 889 | for i in range(len(targets)): |
|
888 | 890 | idents,msg = self.session.recv(self._control_socket,0) |
|
889 | 891 | if self.debug: |
|
890 | 892 | pprint(msg) |
|
891 | 893 | if msg['content']['status'] != 'ok': |
|
892 | 894 | error = self._unwrap_exception(msg['content']) |
|
893 | 895 | else: |
|
894 | 896 | self._ignored_control_replies += len(targets) |
|
895 | 897 | if error: |
|
896 | 898 | raise error |
|
897 | 899 | |
|
898 | 900 | @spin_first |
|
899 | 901 | def shutdown(self, targets=None, restart=False, hub=False, block=None): |
|
900 | 902 | """Terminates one or more engine processes, optionally including the hub.""" |
|
901 | 903 | block = self.block if block is None else block |
|
902 | 904 | if hub: |
|
903 | 905 | targets = 'all' |
|
904 | 906 | targets = self._build_targets(targets)[0] |
|
905 | 907 | for t in targets: |
|
906 | 908 | self.session.send(self._control_socket, 'shutdown_request', |
|
907 | 909 | content={'restart':restart},ident=t) |
|
908 | 910 | error = False |
|
909 | 911 | if block or hub: |
|
910 | 912 | self._flush_ignored_control() |
|
911 | 913 | for i in range(len(targets)): |
|
912 | 914 | idents,msg = self.session.recv(self._control_socket, 0) |
|
913 | 915 | if self.debug: |
|
914 | 916 | pprint(msg) |
|
915 | 917 | if msg['content']['status'] != 'ok': |
|
916 | 918 | error = self._unwrap_exception(msg['content']) |
|
917 | 919 | else: |
|
918 | 920 | self._ignored_control_replies += len(targets) |
|
919 | 921 | |
|
920 | 922 | if hub: |
|
921 | 923 | time.sleep(0.25) |
|
922 | 924 | self.session.send(self._query_socket, 'shutdown_request') |
|
923 | 925 | idents,msg = self.session.recv(self._query_socket, 0) |
|
924 | 926 | if self.debug: |
|
925 | 927 | pprint(msg) |
|
926 | 928 | if msg['content']['status'] != 'ok': |
|
927 | 929 | error = self._unwrap_exception(msg['content']) |
|
928 | 930 | |
|
929 | 931 | if error: |
|
930 | 932 | raise error |
|
931 | 933 | |
|
932 | 934 | #-------------------------------------------------------------------------- |
|
933 | 935 | # Execution related methods |
|
934 | 936 | #-------------------------------------------------------------------------- |
|
935 | 937 | |
|
936 | 938 | def _maybe_raise(self, result): |
|
937 | 939 | """wrapper for maybe raising an exception if apply failed.""" |
|
938 | 940 | if isinstance(result, error.RemoteError): |
|
939 | 941 | raise result |
|
940 | 942 | |
|
941 | 943 | return result |
|
942 | 944 | |
|
943 | 945 | def send_apply_message(self, socket, f, args=None, kwargs=None, subheader=None, track=False, |
|
944 | 946 | ident=None): |
|
945 | 947 | """construct and send an apply message via a socket. |
|
946 | 948 | |
|
947 | 949 | This is the principal method with which all engine execution is performed by views. |
|
948 | 950 | """ |
|
949 | 951 | |
|
950 | 952 | assert not self._closed, "cannot use me anymore, I'm closed!" |
|
951 | 953 | # defaults: |
|
952 | 954 | args = args if args is not None else [] |
|
953 | 955 | kwargs = kwargs if kwargs is not None else {} |
|
954 | 956 | subheader = subheader if subheader is not None else {} |
|
955 | 957 | |
|
956 | 958 | # validate arguments |
|
957 | 959 | if not callable(f): |
|
958 | 960 | raise TypeError("f must be callable, not %s"%type(f)) |
|
959 | 961 | if not isinstance(args, (tuple, list)): |
|
960 | 962 | raise TypeError("args must be tuple or list, not %s"%type(args)) |
|
961 | 963 | if not isinstance(kwargs, dict): |
|
962 | 964 | raise TypeError("kwargs must be dict, not %s"%type(kwargs)) |
|
963 | 965 | if not isinstance(subheader, dict): |
|
964 | 966 | raise TypeError("subheader must be dict, not %s"%type(subheader)) |
|
965 | 967 | |
|
966 | 968 | bufs = util.pack_apply_message(f,args,kwargs) |
|
967 | 969 | |
|
968 | 970 | msg = self.session.send(socket, "apply_request", buffers=bufs, ident=ident, |
|
969 | 971 | subheader=subheader, track=track) |
|
970 | 972 | |
|
971 | 973 | msg_id = msg['msg_id'] |
|
972 | 974 | self.outstanding.add(msg_id) |
|
973 | 975 | if ident: |
|
974 | 976 | # possibly routed to a specific engine |
|
975 | 977 | if isinstance(ident, list): |
|
976 | 978 | ident = ident[-1] |
|
977 | 979 | if ident in self._engines.values(): |
|
978 | 980 | # save for later, in case of engine death |
|
979 | 981 | self._outstanding_dict[ident].add(msg_id) |
|
980 | 982 | self.history.append(msg_id) |
|
981 | 983 | self.metadata[msg_id]['submitted'] = datetime.now() |
|
982 | 984 | |
|
983 | 985 | return msg |
|
984 | 986 | |
|
985 | 987 | #-------------------------------------------------------------------------- |
|
986 | 988 | # construct a View object |
|
987 | 989 | #-------------------------------------------------------------------------- |
|
988 | 990 | |
|
989 | 991 | def load_balanced_view(self, targets=None): |
|
990 | 992 | """construct a DirectView object. |
|
991 | 993 | |
|
992 | 994 | If no arguments are specified, create a LoadBalancedView |
|
993 | 995 | using all engines. |
|
994 | 996 | |
|
995 | 997 | Parameters |
|
996 | 998 | ---------- |
|
997 | 999 | |
|
998 | 1000 | targets: list,slice,int,etc. [default: use all engines] |
|
999 | 1001 | The subset of engines across which to load-balance |
|
1000 | 1002 | """ |
|
1001 | 1003 | if targets is not None: |
|
1002 | 1004 | targets = self._build_targets(targets)[1] |
|
1003 | 1005 | return LoadBalancedView(client=self, socket=self._task_socket, targets=targets) |
|
1004 | 1006 | |
|
1005 | 1007 | def direct_view(self, targets='all'): |
|
1006 | 1008 | """construct a DirectView object. |
|
1007 | 1009 | |
|
1008 | 1010 | If no targets are specified, create a DirectView |
|
1009 | 1011 | using all engines. |
|
1010 | 1012 | |
|
1011 | 1013 | Parameters |
|
1012 | 1014 | ---------- |
|
1013 | 1015 | |
|
1014 | 1016 | targets: list,slice,int,etc. [default: use all engines] |
|
1015 | 1017 | The engines to use for the View |
|
1016 | 1018 | """ |
|
1017 | 1019 | single = isinstance(targets, int) |
|
1018 | 1020 | targets = self._build_targets(targets)[1] |
|
1019 | 1021 | if single: |
|
1020 | 1022 | targets = targets[0] |
|
1021 | 1023 | return DirectView(client=self, socket=self._mux_socket, targets=targets) |
|
1022 | 1024 | |
|
1023 | 1025 | #-------------------------------------------------------------------------- |
|
1024 | 1026 | # Query methods |
|
1025 | 1027 | #-------------------------------------------------------------------------- |
|
1026 | 1028 | |
|
1027 | 1029 | @spin_first |
|
1028 | 1030 | def get_result(self, indices_or_msg_ids=None, block=None): |
|
1029 | 1031 | """Retrieve a result by msg_id or history index, wrapped in an AsyncResult object. |
|
1030 | 1032 | |
|
1031 | 1033 | If the client already has the results, no request to the Hub will be made. |
|
1032 | 1034 | |
|
1033 | 1035 | This is a convenient way to construct AsyncResult objects, which are wrappers |
|
1034 | 1036 | that include metadata about execution, and allow for awaiting results that |
|
1035 | 1037 | were not submitted by this Client. |
|
1036 | 1038 | |
|
1037 | 1039 | It can also be a convenient way to retrieve the metadata associated with |
|
1038 | 1040 | blocking execution, since it always retrieves |
|
1039 | 1041 | |
|
1040 | 1042 | Examples |
|
1041 | 1043 | -------- |
|
1042 | 1044 | :: |
|
1043 | 1045 | |
|
1044 | 1046 | In [10]: r = client.apply() |
|
1045 | 1047 | |
|
1046 | 1048 | Parameters |
|
1047 | 1049 | ---------- |
|
1048 | 1050 | |
|
1049 | 1051 | indices_or_msg_ids : integer history index, str msg_id, or list of either |
|
1050 | 1052 | The indices or msg_ids of indices to be retrieved |
|
1051 | 1053 | |
|
1052 | 1054 | block : bool |
|
1053 | 1055 | Whether to wait for the result to be done |
|
1054 | 1056 | |
|
1055 | 1057 | Returns |
|
1056 | 1058 | ------- |
|
1057 | 1059 | |
|
1058 | 1060 | AsyncResult |
|
1059 | 1061 | A single AsyncResult object will always be returned. |
|
1060 | 1062 | |
|
1061 | 1063 | AsyncHubResult |
|
1062 | 1064 | A subclass of AsyncResult that retrieves results from the Hub |
|
1063 | 1065 | |
|
1064 | 1066 | """ |
|
1065 | 1067 | block = self.block if block is None else block |
|
1066 | 1068 | if indices_or_msg_ids is None: |
|
1067 | 1069 | indices_or_msg_ids = -1 |
|
1068 | 1070 | |
|
1069 | 1071 | if not isinstance(indices_or_msg_ids, (list,tuple)): |
|
1070 | 1072 | indices_or_msg_ids = [indices_or_msg_ids] |
|
1071 | 1073 | |
|
1072 | 1074 | theids = [] |
|
1073 | 1075 | for id in indices_or_msg_ids: |
|
1074 | 1076 | if isinstance(id, int): |
|
1075 | 1077 | id = self.history[id] |
|
1076 | 1078 | if not isinstance(id, str): |
|
1077 | 1079 | raise TypeError("indices must be str or int, not %r"%id) |
|
1078 | 1080 | theids.append(id) |
|
1079 | 1081 | |
|
1080 | 1082 | local_ids = filter(lambda msg_id: msg_id in self.history or msg_id in self.results, theids) |
|
1081 | 1083 | remote_ids = filter(lambda msg_id: msg_id not in local_ids, theids) |
|
1082 | 1084 | |
|
1083 | 1085 | if remote_ids: |
|
1084 | 1086 | ar = AsyncHubResult(self, msg_ids=theids) |
|
1085 | 1087 | else: |
|
1086 | 1088 | ar = AsyncResult(self, msg_ids=theids) |
|
1087 | 1089 | |
|
1088 | 1090 | if block: |
|
1089 | 1091 | ar.wait() |
|
1090 | 1092 | |
|
1091 | 1093 | return ar |
|
1092 | 1094 | |
|
1093 | 1095 | @spin_first |
|
1094 | 1096 | def resubmit(self, indices_or_msg_ids=None, subheader=None, block=None): |
|
1095 | 1097 | """Resubmit one or more tasks. |
|
1096 | 1098 | |
|
1097 | 1099 | in-flight tasks may not be resubmitted. |
|
1098 | 1100 | |
|
1099 | 1101 | Parameters |
|
1100 | 1102 | ---------- |
|
1101 | 1103 | |
|
1102 | 1104 | indices_or_msg_ids : integer history index, str msg_id, or list of either |
|
1103 | 1105 | The indices or msg_ids of indices to be retrieved |
|
1104 | 1106 | |
|
1105 | 1107 | block : bool |
|
1106 | 1108 | Whether to wait for the result to be done |
|
1107 | 1109 | |
|
1108 | 1110 | Returns |
|
1109 | 1111 | ------- |
|
1110 | 1112 | |
|
1111 | 1113 | AsyncHubResult |
|
1112 | 1114 | A subclass of AsyncResult that retrieves results from the Hub |
|
1113 | 1115 | |
|
1114 | 1116 | """ |
|
1115 | 1117 | block = self.block if block is None else block |
|
1116 | 1118 | if indices_or_msg_ids is None: |
|
1117 | 1119 | indices_or_msg_ids = -1 |
|
1118 | 1120 | |
|
1119 | 1121 | if not isinstance(indices_or_msg_ids, (list,tuple)): |
|
1120 | 1122 | indices_or_msg_ids = [indices_or_msg_ids] |
|
1121 | 1123 | |
|
1122 | 1124 | theids = [] |
|
1123 | 1125 | for id in indices_or_msg_ids: |
|
1124 | 1126 | if isinstance(id, int): |
|
1125 | 1127 | id = self.history[id] |
|
1126 | 1128 | if not isinstance(id, str): |
|
1127 | 1129 | raise TypeError("indices must be str or int, not %r"%id) |
|
1128 | 1130 | theids.append(id) |
|
1129 | 1131 | |
|
1130 | 1132 | for msg_id in theids: |
|
1131 | 1133 | self.outstanding.discard(msg_id) |
|
1132 | 1134 | if msg_id in self.history: |
|
1133 | 1135 | self.history.remove(msg_id) |
|
1134 | 1136 | self.results.pop(msg_id, None) |
|
1135 | 1137 | self.metadata.pop(msg_id, None) |
|
1136 | 1138 | content = dict(msg_ids = theids) |
|
1137 | 1139 | |
|
1138 | 1140 | self.session.send(self._query_socket, 'resubmit_request', content) |
|
1139 | 1141 | |
|
1140 | 1142 | zmq.select([self._query_socket], [], []) |
|
1141 | 1143 | idents,msg = self.session.recv(self._query_socket, zmq.NOBLOCK) |
|
1142 | 1144 | if self.debug: |
|
1143 | 1145 | pprint(msg) |
|
1144 | 1146 | content = msg['content'] |
|
1145 | 1147 | if content['status'] != 'ok': |
|
1146 | 1148 | raise self._unwrap_exception(content) |
|
1147 | 1149 | |
|
1148 | 1150 | ar = AsyncHubResult(self, msg_ids=theids) |
|
1149 | 1151 | |
|
1150 | 1152 | if block: |
|
1151 | 1153 | ar.wait() |
|
1152 | 1154 | |
|
1153 | 1155 | return ar |
|
1154 | 1156 | |
|
1155 | 1157 | @spin_first |
|
1156 | 1158 | def result_status(self, msg_ids, status_only=True): |
|
1157 | 1159 | """Check on the status of the result(s) of the apply request with `msg_ids`. |
|
1158 | 1160 | |
|
1159 | 1161 | If status_only is False, then the actual results will be retrieved, else |
|
1160 | 1162 | only the status of the results will be checked. |
|
1161 | 1163 | |
|
1162 | 1164 | Parameters |
|
1163 | 1165 | ---------- |
|
1164 | 1166 | |
|
1165 | 1167 | msg_ids : list of msg_ids |
|
1166 | 1168 | if int: |
|
1167 | 1169 | Passed as index to self.history for convenience. |
|
1168 | 1170 | status_only : bool (default: True) |
|
1169 | 1171 | if False: |
|
1170 | 1172 | Retrieve the actual results of completed tasks. |
|
1171 | 1173 | |
|
1172 | 1174 | Returns |
|
1173 | 1175 | ------- |
|
1174 | 1176 | |
|
1175 | 1177 | results : dict |
|
1176 | 1178 | There will always be the keys 'pending' and 'completed', which will |
|
1177 | 1179 | be lists of msg_ids that are incomplete or complete. If `status_only` |
|
1178 | 1180 | is False, then completed results will be keyed by their `msg_id`. |
|
1179 | 1181 | """ |
|
1180 | 1182 | if not isinstance(msg_ids, (list,tuple)): |
|
1181 | 1183 | msg_ids = [msg_ids] |
|
1182 | 1184 | |
|
1183 | 1185 | theids = [] |
|
1184 | 1186 | for msg_id in msg_ids: |
|
1185 | 1187 | if isinstance(msg_id, int): |
|
1186 | 1188 | msg_id = self.history[msg_id] |
|
1187 | 1189 | if not isinstance(msg_id, basestring): |
|
1188 | 1190 | raise TypeError("msg_ids must be str, not %r"%msg_id) |
|
1189 | 1191 | theids.append(msg_id) |
|
1190 | 1192 | |
|
1191 | 1193 | completed = [] |
|
1192 | 1194 | local_results = {} |
|
1193 | 1195 | |
|
1194 | 1196 | # comment this block out to temporarily disable local shortcut: |
|
1195 | 1197 | for msg_id in theids: |
|
1196 | 1198 | if msg_id in self.results: |
|
1197 | 1199 | completed.append(msg_id) |
|
1198 | 1200 | local_results[msg_id] = self.results[msg_id] |
|
1199 | 1201 | theids.remove(msg_id) |
|
1200 | 1202 | |
|
1201 | 1203 | if theids: # some not locally cached |
|
1202 | 1204 | content = dict(msg_ids=theids, status_only=status_only) |
|
1203 | 1205 | msg = self.session.send(self._query_socket, "result_request", content=content) |
|
1204 | 1206 | zmq.select([self._query_socket], [], []) |
|
1205 | 1207 | idents,msg = self.session.recv(self._query_socket, zmq.NOBLOCK) |
|
1206 | 1208 | if self.debug: |
|
1207 | 1209 | pprint(msg) |
|
1208 | 1210 | content = msg['content'] |
|
1209 | 1211 | if content['status'] != 'ok': |
|
1210 | 1212 | raise self._unwrap_exception(content) |
|
1211 | 1213 | buffers = msg['buffers'] |
|
1212 | 1214 | else: |
|
1213 | 1215 | content = dict(completed=[],pending=[]) |
|
1214 | 1216 | |
|
1215 | 1217 | content['completed'].extend(completed) |
|
1216 | 1218 | |
|
1217 | 1219 | if status_only: |
|
1218 | 1220 | return content |
|
1219 | 1221 | |
|
1220 | 1222 | failures = [] |
|
1221 | 1223 | # load cached results into result: |
|
1222 | 1224 | content.update(local_results) |
|
1223 | 1225 | |
|
1224 | 1226 | # update cache with results: |
|
1225 | 1227 | for msg_id in sorted(theids): |
|
1226 | 1228 | if msg_id in content['completed']: |
|
1227 | 1229 | rec = content[msg_id] |
|
1228 | 1230 | parent = rec['header'] |
|
1229 | 1231 | header = rec['result_header'] |
|
1230 | 1232 | rcontent = rec['result_content'] |
|
1231 | 1233 | iodict = rec['io'] |
|
1232 | 1234 | if isinstance(rcontent, str): |
|
1233 | 1235 | rcontent = self.session.unpack(rcontent) |
|
1234 | 1236 | |
|
1235 | 1237 | md = self.metadata[msg_id] |
|
1236 | 1238 | md.update(self._extract_metadata(header, parent, rcontent)) |
|
1237 | 1239 | md.update(iodict) |
|
1238 | 1240 | |
|
1239 | 1241 | if rcontent['status'] == 'ok': |
|
1240 | 1242 | res,buffers = util.unserialize_object(buffers) |
|
1241 | 1243 | else: |
|
1242 | 1244 | print rcontent |
|
1243 | 1245 | res = self._unwrap_exception(rcontent) |
|
1244 | 1246 | failures.append(res) |
|
1245 | 1247 | |
|
1246 | 1248 | self.results[msg_id] = res |
|
1247 | 1249 | content[msg_id] = res |
|
1248 | 1250 | |
|
1249 | 1251 | if len(theids) == 1 and failures: |
|
1250 | 1252 | raise failures[0] |
|
1251 | 1253 | |
|
1252 | 1254 | error.collect_exceptions(failures, "result_status") |
|
1253 | 1255 | return content |
|
1254 | 1256 | |
|
1255 | 1257 | @spin_first |
|
1256 | 1258 | def queue_status(self, targets='all', verbose=False): |
|
1257 | 1259 | """Fetch the status of engine queues. |
|
1258 | 1260 | |
|
1259 | 1261 | Parameters |
|
1260 | 1262 | ---------- |
|
1261 | 1263 | |
|
1262 | 1264 | targets : int/str/list of ints/strs |
|
1263 | 1265 | the engines whose states are to be queried. |
|
1264 | 1266 | default : all |
|
1265 | 1267 | verbose : bool |
|
1266 | 1268 | Whether to return lengths only, or lists of ids for each element |
|
1267 | 1269 | """ |
|
1268 | 1270 | engine_ids = self._build_targets(targets)[1] |
|
1269 | 1271 | content = dict(targets=engine_ids, verbose=verbose) |
|
1270 | 1272 | self.session.send(self._query_socket, "queue_request", content=content) |
|
1271 | 1273 | idents,msg = self.session.recv(self._query_socket, 0) |
|
1272 | 1274 | if self.debug: |
|
1273 | 1275 | pprint(msg) |
|
1274 | 1276 | content = msg['content'] |
|
1275 | 1277 | status = content.pop('status') |
|
1276 | 1278 | if status != 'ok': |
|
1277 | 1279 | raise self._unwrap_exception(content) |
|
1278 | 1280 | content = rekey(content) |
|
1279 | 1281 | if isinstance(targets, int): |
|
1280 | 1282 | return content[targets] |
|
1281 | 1283 | else: |
|
1282 | 1284 | return content |
|
1283 | 1285 | |
|
1284 | 1286 | @spin_first |
|
1285 | 1287 | def purge_results(self, jobs=[], targets=[]): |
|
1286 | 1288 | """Tell the Hub to forget results. |
|
1287 | 1289 | |
|
1288 | 1290 | Individual results can be purged by msg_id, or the entire |
|
1289 | 1291 | history of specific targets can be purged. |
|
1290 | 1292 | |
|
1291 | 1293 | Parameters |
|
1292 | 1294 | ---------- |
|
1293 | 1295 | |
|
1294 | 1296 | jobs : str or list of str or AsyncResult objects |
|
1295 | 1297 | the msg_ids whose results should be forgotten. |
|
1296 | 1298 | targets : int/str/list of ints/strs |
|
1297 | 1299 | The targets, by uuid or int_id, whose entire history is to be purged. |
|
1298 | 1300 | Use `targets='all'` to scrub everything from the Hub's memory. |
|
1299 | 1301 | |
|
1300 | 1302 | default : None |
|
1301 | 1303 | """ |
|
1302 | 1304 | if not targets and not jobs: |
|
1303 | 1305 | raise ValueError("Must specify at least one of `targets` and `jobs`") |
|
1304 | 1306 | if targets: |
|
1305 | 1307 | targets = self._build_targets(targets)[1] |
|
1306 | 1308 | |
|
1307 | 1309 | # construct msg_ids from jobs |
|
1308 | 1310 | msg_ids = [] |
|
1309 | 1311 | if isinstance(jobs, (basestring,AsyncResult)): |
|
1310 | 1312 | jobs = [jobs] |
|
1311 | 1313 | bad_ids = filter(lambda obj: not isinstance(obj, (basestring, AsyncResult)), jobs) |
|
1312 | 1314 | if bad_ids: |
|
1313 | 1315 | raise TypeError("Invalid msg_id type %r, expected str or AsyncResult"%bad_ids[0]) |
|
1314 | 1316 | for j in jobs: |
|
1315 | 1317 | if isinstance(j, AsyncResult): |
|
1316 | 1318 | msg_ids.extend(j.msg_ids) |
|
1317 | 1319 | else: |
|
1318 | 1320 | msg_ids.append(j) |
|
1319 | 1321 | |
|
1320 | 1322 | content = dict(targets=targets, msg_ids=msg_ids) |
|
1321 | 1323 | self.session.send(self._query_socket, "purge_request", content=content) |
|
1322 | 1324 | idents, msg = self.session.recv(self._query_socket, 0) |
|
1323 | 1325 | if self.debug: |
|
1324 | 1326 | pprint(msg) |
|
1325 | 1327 | content = msg['content'] |
|
1326 | 1328 | if content['status'] != 'ok': |
|
1327 | 1329 | raise self._unwrap_exception(content) |
|
1328 | 1330 | |
|
1329 | 1331 | @spin_first |
|
1330 | 1332 | def hub_history(self): |
|
1331 | 1333 | """Get the Hub's history |
|
1332 | 1334 | |
|
1333 | 1335 | Just like the Client, the Hub has a history, which is a list of msg_ids. |
|
1334 | 1336 | This will contain the history of all clients, and, depending on configuration, |
|
1335 | 1337 | may contain history across multiple cluster sessions. |
|
1336 | 1338 | |
|
1337 | 1339 | Any msg_id returned here is a valid argument to `get_result`. |
|
1338 | 1340 | |
|
1339 | 1341 | Returns |
|
1340 | 1342 | ------- |
|
1341 | 1343 | |
|
1342 | 1344 | msg_ids : list of strs |
|
1343 | 1345 | list of all msg_ids, ordered by task submission time. |
|
1344 | 1346 | """ |
|
1345 | 1347 | |
|
1346 | 1348 | self.session.send(self._query_socket, "history_request", content={}) |
|
1347 | 1349 | idents, msg = self.session.recv(self._query_socket, 0) |
|
1348 | 1350 | |
|
1349 | 1351 | if self.debug: |
|
1350 | 1352 | pprint(msg) |
|
1351 | 1353 | content = msg['content'] |
|
1352 | 1354 | if content['status'] != 'ok': |
|
1353 | 1355 | raise self._unwrap_exception(content) |
|
1354 | 1356 | else: |
|
1355 | 1357 | return content['history'] |
|
1356 | 1358 | |
|
1357 | 1359 | @spin_first |
|
1358 | 1360 | def db_query(self, query, keys=None): |
|
1359 | 1361 | """Query the Hub's TaskRecord database |
|
1360 | 1362 | |
|
1361 | 1363 | This will return a list of task record dicts that match `query` |
|
1362 | 1364 | |
|
1363 | 1365 | Parameters |
|
1364 | 1366 | ---------- |
|
1365 | 1367 | |
|
1366 | 1368 | query : mongodb query dict |
|
1367 | 1369 | The search dict. See mongodb query docs for details. |
|
1368 | 1370 | keys : list of strs [optional] |
|
1369 | 1371 | The subset of keys to be returned. The default is to fetch everything but buffers. |
|
1370 | 1372 | 'msg_id' will *always* be included. |
|
1371 | 1373 | """ |
|
1372 | 1374 | if isinstance(keys, basestring): |
|
1373 | 1375 | keys = [keys] |
|
1374 | 1376 | content = dict(query=query, keys=keys) |
|
1375 | 1377 | self.session.send(self._query_socket, "db_request", content=content) |
|
1376 | 1378 | idents, msg = self.session.recv(self._query_socket, 0) |
|
1377 | 1379 | if self.debug: |
|
1378 | 1380 | pprint(msg) |
|
1379 | 1381 | content = msg['content'] |
|
1380 | 1382 | if content['status'] != 'ok': |
|
1381 | 1383 | raise self._unwrap_exception(content) |
|
1382 | 1384 | |
|
1383 | 1385 | records = content['records'] |
|
1384 | 1386 | |
|
1385 | 1387 | buffer_lens = content['buffer_lens'] |
|
1386 | 1388 | result_buffer_lens = content['result_buffer_lens'] |
|
1387 | 1389 | buffers = msg['buffers'] |
|
1388 | 1390 | has_bufs = buffer_lens is not None |
|
1389 | 1391 | has_rbufs = result_buffer_lens is not None |
|
1390 | 1392 | for i,rec in enumerate(records): |
|
1391 | 1393 | # relink buffers |
|
1392 | 1394 | if has_bufs: |
|
1393 | 1395 | blen = buffer_lens[i] |
|
1394 | 1396 | rec['buffers'], buffers = buffers[:blen],buffers[blen:] |
|
1395 | 1397 | if has_rbufs: |
|
1396 | 1398 | blen = result_buffer_lens[i] |
|
1397 | 1399 | rec['result_buffers'], buffers = buffers[:blen],buffers[blen:] |
|
1398 | 1400 | |
|
1399 | 1401 | return records |
|
1400 | 1402 | |
|
1401 | 1403 | __all__ = [ 'Client' ] |
@@ -1,1288 +1,1288 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 | 2 | """The IPython Controller Hub with 0MQ |
|
3 | 3 | This is the master object that handles connections from engines and clients, |
|
4 | 4 | and monitors traffic through the various queues. |
|
5 | 5 | |
|
6 | 6 | Authors: |
|
7 | 7 | |
|
8 | 8 | * Min RK |
|
9 | 9 | """ |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | # Copyright (C) 2010 The IPython Development Team |
|
12 | 12 | # |
|
13 | 13 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | 14 | # the file COPYING, distributed as part of this software. |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Imports |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | from __future__ import print_function |
|
21 | 21 | |
|
22 | 22 | import sys |
|
23 | 23 | import time |
|
24 | 24 | from datetime import datetime |
|
25 | 25 | |
|
26 | 26 | import zmq |
|
27 | 27 | from zmq.eventloop import ioloop |
|
28 | 28 | from zmq.eventloop.zmqstream import ZMQStream |
|
29 | 29 | |
|
30 | 30 | # internal: |
|
31 | 31 | from IPython.utils.importstring import import_item |
|
32 | 32 | from IPython.utils.traitlets import ( |
|
33 |
HasTraits, Instance, Int, Unicode, Dict, Set, Tuple, |
|
|
33 | HasTraits, Instance, Int, Unicode, Dict, Set, Tuple, Bytes, DottedObjectName | |
|
34 | 34 | ) |
|
35 | 35 | |
|
36 | 36 | from IPython.parallel import error, util |
|
37 | 37 | from IPython.parallel.factory import RegistrationFactory |
|
38 | 38 | |
|
39 | 39 | from IPython.zmq.session import SessionFactory |
|
40 | 40 | |
|
41 | 41 | from .heartmonitor import HeartMonitor |
|
42 | 42 | |
|
43 | 43 | #----------------------------------------------------------------------------- |
|
44 | 44 | # Code |
|
45 | 45 | #----------------------------------------------------------------------------- |
|
46 | 46 | |
|
47 | 47 | def _passer(*args, **kwargs): |
|
48 | 48 | return |
|
49 | 49 | |
|
50 | 50 | def _printer(*args, **kwargs): |
|
51 | 51 | print (args) |
|
52 | 52 | print (kwargs) |
|
53 | 53 | |
|
54 | 54 | def empty_record(): |
|
55 | 55 | """Return an empty dict with all record keys.""" |
|
56 | 56 | return { |
|
57 | 57 | 'msg_id' : None, |
|
58 | 58 | 'header' : None, |
|
59 | 59 | 'content': None, |
|
60 | 60 | 'buffers': None, |
|
61 | 61 | 'submitted': None, |
|
62 | 62 | 'client_uuid' : None, |
|
63 | 63 | 'engine_uuid' : None, |
|
64 | 64 | 'started': None, |
|
65 | 65 | 'completed': None, |
|
66 | 66 | 'resubmitted': None, |
|
67 | 67 | 'result_header' : None, |
|
68 | 68 | 'result_content' : None, |
|
69 | 69 | 'result_buffers' : None, |
|
70 | 70 | 'queue' : None, |
|
71 | 71 | 'pyin' : None, |
|
72 | 72 | 'pyout': None, |
|
73 | 73 | 'pyerr': None, |
|
74 | 74 | 'stdout': '', |
|
75 | 75 | 'stderr': '', |
|
76 | 76 | } |
|
77 | 77 | |
|
78 | 78 | def init_record(msg): |
|
79 | 79 | """Initialize a TaskRecord based on a request.""" |
|
80 | 80 | header = msg['header'] |
|
81 | 81 | return { |
|
82 | 82 | 'msg_id' : header['msg_id'], |
|
83 | 83 | 'header' : header, |
|
84 | 84 | 'content': msg['content'], |
|
85 | 85 | 'buffers': msg['buffers'], |
|
86 | 86 | 'submitted': header['date'], |
|
87 | 87 | 'client_uuid' : None, |
|
88 | 88 | 'engine_uuid' : None, |
|
89 | 89 | 'started': None, |
|
90 | 90 | 'completed': None, |
|
91 | 91 | 'resubmitted': None, |
|
92 | 92 | 'result_header' : None, |
|
93 | 93 | 'result_content' : None, |
|
94 | 94 | 'result_buffers' : None, |
|
95 | 95 | 'queue' : None, |
|
96 | 96 | 'pyin' : None, |
|
97 | 97 | 'pyout': None, |
|
98 | 98 | 'pyerr': None, |
|
99 | 99 | 'stdout': '', |
|
100 | 100 | 'stderr': '', |
|
101 | 101 | } |
|
102 | 102 | |
|
103 | 103 | |
|
104 | 104 | class EngineConnector(HasTraits): |
|
105 | 105 | """A simple object for accessing the various zmq connections of an object. |
|
106 | 106 | Attributes are: |
|
107 | 107 | id (int): engine ID |
|
108 | 108 | uuid (str): uuid (unused?) |
|
109 | 109 | queue (str): identity of queue's XREQ socket |
|
110 | 110 | registration (str): identity of registration XREQ socket |
|
111 | 111 | heartbeat (str): identity of heartbeat XREQ socket |
|
112 | 112 | """ |
|
113 | 113 | id=Int(0) |
|
114 |
queue= |
|
|
115 |
control= |
|
|
116 |
registration= |
|
|
117 |
heartbeat= |
|
|
114 | queue=Bytes() | |
|
115 | control=Bytes() | |
|
116 | registration=Bytes() | |
|
117 | heartbeat=Bytes() | |
|
118 | 118 | pending=Set() |
|
119 | 119 | |
|
120 | 120 | class HubFactory(RegistrationFactory): |
|
121 | 121 | """The Configurable for setting up a Hub.""" |
|
122 | 122 | |
|
123 | 123 | # port-pairs for monitoredqueues: |
|
124 | 124 | hb = Tuple(Int,Int,config=True, |
|
125 | 125 | help="""XREQ/SUB Port pair for Engine heartbeats""") |
|
126 | 126 | def _hb_default(self): |
|
127 | 127 | return tuple(util.select_random_ports(2)) |
|
128 | 128 | |
|
129 | 129 | mux = Tuple(Int,Int,config=True, |
|
130 | 130 | help="""Engine/Client Port pair for MUX queue""") |
|
131 | 131 | |
|
132 | 132 | def _mux_default(self): |
|
133 | 133 | return tuple(util.select_random_ports(2)) |
|
134 | 134 | |
|
135 | 135 | task = Tuple(Int,Int,config=True, |
|
136 | 136 | help="""Engine/Client Port pair for Task queue""") |
|
137 | 137 | def _task_default(self): |
|
138 | 138 | return tuple(util.select_random_ports(2)) |
|
139 | 139 | |
|
140 | 140 | control = Tuple(Int,Int,config=True, |
|
141 | 141 | help="""Engine/Client Port pair for Control queue""") |
|
142 | 142 | |
|
143 | 143 | def _control_default(self): |
|
144 | 144 | return tuple(util.select_random_ports(2)) |
|
145 | 145 | |
|
146 | 146 | iopub = Tuple(Int,Int,config=True, |
|
147 | 147 | help="""Engine/Client Port pair for IOPub relay""") |
|
148 | 148 | |
|
149 | 149 | def _iopub_default(self): |
|
150 | 150 | return tuple(util.select_random_ports(2)) |
|
151 | 151 | |
|
152 | 152 | # single ports: |
|
153 | 153 | mon_port = Int(config=True, |
|
154 | 154 | help="""Monitor (SUB) port for queue traffic""") |
|
155 | 155 | |
|
156 | 156 | def _mon_port_default(self): |
|
157 | 157 | return util.select_random_ports(1)[0] |
|
158 | 158 | |
|
159 | 159 | notifier_port = Int(config=True, |
|
160 | 160 | help="""PUB port for sending engine status notifications""") |
|
161 | 161 | |
|
162 | 162 | def _notifier_port_default(self): |
|
163 | 163 | return util.select_random_ports(1)[0] |
|
164 | 164 | |
|
165 | 165 | engine_ip = Unicode('127.0.0.1', config=True, |
|
166 | 166 | help="IP on which to listen for engine connections. [default: loopback]") |
|
167 | 167 | engine_transport = Unicode('tcp', config=True, |
|
168 | 168 | help="0MQ transport for engine connections. [default: tcp]") |
|
169 | 169 | |
|
170 | 170 | client_ip = Unicode('127.0.0.1', config=True, |
|
171 | 171 | help="IP on which to listen for client connections. [default: loopback]") |
|
172 | 172 | client_transport = Unicode('tcp', config=True, |
|
173 | 173 | help="0MQ transport for client connections. [default : tcp]") |
|
174 | 174 | |
|
175 | 175 | monitor_ip = Unicode('127.0.0.1', config=True, |
|
176 | 176 | help="IP on which to listen for monitor messages. [default: loopback]") |
|
177 | 177 | monitor_transport = Unicode('tcp', config=True, |
|
178 | 178 | help="0MQ transport for monitor messages. [default : tcp]") |
|
179 | 179 | |
|
180 | 180 | monitor_url = Unicode('') |
|
181 | 181 | |
|
182 |
db_class = |
|
|
183 | help="""The class to use for the DB backend""") | |
|
182 | db_class = DottedObjectName('IPython.parallel.controller.dictdb.DictDB', | |
|
183 | config=True, help="""The class to use for the DB backend""") | |
|
184 | 184 | |
|
185 | 185 | # not configurable |
|
186 | 186 | db = Instance('IPython.parallel.controller.dictdb.BaseDB') |
|
187 | 187 | heartmonitor = Instance('IPython.parallel.controller.heartmonitor.HeartMonitor') |
|
188 | 188 | |
|
189 | 189 | def _ip_changed(self, name, old, new): |
|
190 | 190 | self.engine_ip = new |
|
191 | 191 | self.client_ip = new |
|
192 | 192 | self.monitor_ip = new |
|
193 | 193 | self._update_monitor_url() |
|
194 | 194 | |
|
195 | 195 | def _update_monitor_url(self): |
|
196 | 196 | self.monitor_url = "%s://%s:%i"%(self.monitor_transport, self.monitor_ip, self.mon_port) |
|
197 | 197 | |
|
198 | 198 | def _transport_changed(self, name, old, new): |
|
199 | 199 | self.engine_transport = new |
|
200 | 200 | self.client_transport = new |
|
201 | 201 | self.monitor_transport = new |
|
202 | 202 | self._update_monitor_url() |
|
203 | 203 | |
|
204 | 204 | def __init__(self, **kwargs): |
|
205 | 205 | super(HubFactory, self).__init__(**kwargs) |
|
206 | 206 | self._update_monitor_url() |
|
207 | 207 | |
|
208 | 208 | |
|
209 | 209 | def construct(self): |
|
210 | 210 | self.init_hub() |
|
211 | 211 | |
|
212 | 212 | def start(self): |
|
213 | 213 | self.heartmonitor.start() |
|
214 | 214 | self.log.info("Heartmonitor started") |
|
215 | 215 | |
|
216 | 216 | def init_hub(self): |
|
217 | 217 | """construct""" |
|
218 | 218 | client_iface = "%s://%s:"%(self.client_transport, self.client_ip) + "%i" |
|
219 | 219 | engine_iface = "%s://%s:"%(self.engine_transport, self.engine_ip) + "%i" |
|
220 | 220 | |
|
221 | 221 | ctx = self.context |
|
222 | 222 | loop = self.loop |
|
223 | 223 | |
|
224 | 224 | # Registrar socket |
|
225 | 225 | q = ZMQStream(ctx.socket(zmq.XREP), loop) |
|
226 | 226 | q.bind(client_iface % self.regport) |
|
227 | 227 | self.log.info("Hub listening on %s for registration."%(client_iface%self.regport)) |
|
228 | 228 | if self.client_ip != self.engine_ip: |
|
229 | 229 | q.bind(engine_iface % self.regport) |
|
230 | 230 | self.log.info("Hub listening on %s for registration."%(engine_iface%self.regport)) |
|
231 | 231 | |
|
232 | 232 | ### Engine connections ### |
|
233 | 233 | |
|
234 | 234 | # heartbeat |
|
235 | 235 | hpub = ctx.socket(zmq.PUB) |
|
236 | 236 | hpub.bind(engine_iface % self.hb[0]) |
|
237 | 237 | hrep = ctx.socket(zmq.XREP) |
|
238 | 238 | hrep.bind(engine_iface % self.hb[1]) |
|
239 | 239 | self.heartmonitor = HeartMonitor(loop=loop, config=self.config, log=self.log, |
|
240 | 240 | pingstream=ZMQStream(hpub,loop), |
|
241 | 241 | pongstream=ZMQStream(hrep,loop) |
|
242 | 242 | ) |
|
243 | 243 | |
|
244 | 244 | ### Client connections ### |
|
245 | 245 | # Notifier socket |
|
246 | 246 | n = ZMQStream(ctx.socket(zmq.PUB), loop) |
|
247 | 247 | n.bind(client_iface%self.notifier_port) |
|
248 | 248 | |
|
249 | 249 | ### build and launch the queues ### |
|
250 | 250 | |
|
251 | 251 | # monitor socket |
|
252 | 252 | sub = ctx.socket(zmq.SUB) |
|
253 | 253 | sub.setsockopt(zmq.SUBSCRIBE, "") |
|
254 | 254 | sub.bind(self.monitor_url) |
|
255 | 255 | sub.bind('inproc://monitor') |
|
256 | 256 | sub = ZMQStream(sub, loop) |
|
257 | 257 | |
|
258 | 258 | # connect the db |
|
259 | 259 | self.log.info('Hub using DB backend: %r'%(self.db_class.split()[-1])) |
|
260 | 260 | # cdir = self.config.Global.cluster_dir |
|
261 | 261 | self.db = import_item(str(self.db_class))(session=self.session.session, |
|
262 | 262 | config=self.config, log=self.log) |
|
263 | 263 | time.sleep(.25) |
|
264 | 264 | try: |
|
265 | 265 | scheme = self.config.TaskScheduler.scheme_name |
|
266 | 266 | except AttributeError: |
|
267 | 267 | from .scheduler import TaskScheduler |
|
268 | 268 | scheme = TaskScheduler.scheme_name.get_default_value() |
|
269 | 269 | # build connection dicts |
|
270 | 270 | self.engine_info = { |
|
271 | 271 | 'control' : engine_iface%self.control[1], |
|
272 | 272 | 'mux': engine_iface%self.mux[1], |
|
273 | 273 | 'heartbeat': (engine_iface%self.hb[0], engine_iface%self.hb[1]), |
|
274 | 274 | 'task' : engine_iface%self.task[1], |
|
275 | 275 | 'iopub' : engine_iface%self.iopub[1], |
|
276 | 276 | # 'monitor' : engine_iface%self.mon_port, |
|
277 | 277 | } |
|
278 | 278 | |
|
279 | 279 | self.client_info = { |
|
280 | 280 | 'control' : client_iface%self.control[0], |
|
281 | 281 | 'mux': client_iface%self.mux[0], |
|
282 | 282 | 'task' : (scheme, client_iface%self.task[0]), |
|
283 | 283 | 'iopub' : client_iface%self.iopub[0], |
|
284 | 284 | 'notification': client_iface%self.notifier_port |
|
285 | 285 | } |
|
286 | 286 | self.log.debug("Hub engine addrs: %s"%self.engine_info) |
|
287 | 287 | self.log.debug("Hub client addrs: %s"%self.client_info) |
|
288 | 288 | |
|
289 | 289 | # resubmit stream |
|
290 | 290 | r = ZMQStream(ctx.socket(zmq.XREQ), loop) |
|
291 | 291 | url = util.disambiguate_url(self.client_info['task'][-1]) |
|
292 | 292 | r.setsockopt(zmq.IDENTITY, self.session.session) |
|
293 | 293 | r.connect(url) |
|
294 | 294 | |
|
295 | 295 | self.hub = Hub(loop=loop, session=self.session, monitor=sub, heartmonitor=self.heartmonitor, |
|
296 | 296 | query=q, notifier=n, resubmit=r, db=self.db, |
|
297 | 297 | engine_info=self.engine_info, client_info=self.client_info, |
|
298 | 298 | log=self.log) |
|
299 | 299 | |
|
300 | 300 | |
|
301 | 301 | class Hub(SessionFactory): |
|
302 | 302 | """The IPython Controller Hub with 0MQ connections |
|
303 | 303 | |
|
304 | 304 | Parameters |
|
305 | 305 | ========== |
|
306 | 306 | loop: zmq IOLoop instance |
|
307 | 307 | session: Session object |
|
308 | 308 | <removed> context: zmq context for creating new connections (?) |
|
309 | 309 | queue: ZMQStream for monitoring the command queue (SUB) |
|
310 | 310 | query: ZMQStream for engine registration and client queries requests (XREP) |
|
311 | 311 | heartbeat: HeartMonitor object checking the pulse of the engines |
|
312 | 312 | notifier: ZMQStream for broadcasting engine registration changes (PUB) |
|
313 | 313 | db: connection to db for out of memory logging of commands |
|
314 | 314 | NotImplemented |
|
315 | 315 | engine_info: dict of zmq connection information for engines to connect |
|
316 | 316 | to the queues. |
|
317 | 317 | client_info: dict of zmq connection information for engines to connect |
|
318 | 318 | to the queues. |
|
319 | 319 | """ |
|
320 | 320 | # internal data structures: |
|
321 | 321 | ids=Set() # engine IDs |
|
322 | 322 | keytable=Dict() |
|
323 | 323 | by_ident=Dict() |
|
324 | 324 | engines=Dict() |
|
325 | 325 | clients=Dict() |
|
326 | 326 | hearts=Dict() |
|
327 | 327 | pending=Set() |
|
328 | 328 | queues=Dict() # pending msg_ids keyed by engine_id |
|
329 | 329 | tasks=Dict() # pending msg_ids submitted as tasks, keyed by client_id |
|
330 | 330 | completed=Dict() # completed msg_ids keyed by engine_id |
|
331 | 331 | all_completed=Set() # completed msg_ids keyed by engine_id |
|
332 | 332 | dead_engines=Set() # completed msg_ids keyed by engine_id |
|
333 | 333 | unassigned=Set() # set of task msg_ds not yet assigned a destination |
|
334 | 334 | incoming_registrations=Dict() |
|
335 | 335 | registration_timeout=Int() |
|
336 | 336 | _idcounter=Int(0) |
|
337 | 337 | |
|
338 | 338 | # objects from constructor: |
|
339 | 339 | query=Instance(ZMQStream) |
|
340 | 340 | monitor=Instance(ZMQStream) |
|
341 | 341 | notifier=Instance(ZMQStream) |
|
342 | 342 | resubmit=Instance(ZMQStream) |
|
343 | 343 | heartmonitor=Instance(HeartMonitor) |
|
344 | 344 | db=Instance(object) |
|
345 | 345 | client_info=Dict() |
|
346 | 346 | engine_info=Dict() |
|
347 | 347 | |
|
348 | 348 | |
|
349 | 349 | def __init__(self, **kwargs): |
|
350 | 350 | """ |
|
351 | 351 | # universal: |
|
352 | 352 | loop: IOLoop for creating future connections |
|
353 | 353 | session: streamsession for sending serialized data |
|
354 | 354 | # engine: |
|
355 | 355 | queue: ZMQStream for monitoring queue messages |
|
356 | 356 | query: ZMQStream for engine+client registration and client requests |
|
357 | 357 | heartbeat: HeartMonitor object for tracking engines |
|
358 | 358 | # extra: |
|
359 | 359 | db: ZMQStream for db connection (NotImplemented) |
|
360 | 360 | engine_info: zmq address/protocol dict for engine connections |
|
361 | 361 | client_info: zmq address/protocol dict for client connections |
|
362 | 362 | """ |
|
363 | 363 | |
|
364 | 364 | super(Hub, self).__init__(**kwargs) |
|
365 | 365 | self.registration_timeout = max(5000, 2*self.heartmonitor.period) |
|
366 | 366 | |
|
367 | 367 | # validate connection dicts: |
|
368 | 368 | for k,v in self.client_info.iteritems(): |
|
369 | 369 | if k == 'task': |
|
370 | 370 | util.validate_url_container(v[1]) |
|
371 | 371 | else: |
|
372 | 372 | util.validate_url_container(v) |
|
373 | 373 | # util.validate_url_container(self.client_info) |
|
374 | 374 | util.validate_url_container(self.engine_info) |
|
375 | 375 | |
|
376 | 376 | # register our callbacks |
|
377 | 377 | self.query.on_recv(self.dispatch_query) |
|
378 | 378 | self.monitor.on_recv(self.dispatch_monitor_traffic) |
|
379 | 379 | |
|
380 | 380 | self.heartmonitor.add_heart_failure_handler(self.handle_heart_failure) |
|
381 | 381 | self.heartmonitor.add_new_heart_handler(self.handle_new_heart) |
|
382 | 382 | |
|
383 | 383 | self.monitor_handlers = { 'in' : self.save_queue_request, |
|
384 | 384 | 'out': self.save_queue_result, |
|
385 | 385 | 'intask': self.save_task_request, |
|
386 | 386 | 'outtask': self.save_task_result, |
|
387 | 387 | 'tracktask': self.save_task_destination, |
|
388 | 388 | 'incontrol': _passer, |
|
389 | 389 | 'outcontrol': _passer, |
|
390 | 390 | 'iopub': self.save_iopub_message, |
|
391 | 391 | } |
|
392 | 392 | |
|
393 | 393 | self.query_handlers = {'queue_request': self.queue_status, |
|
394 | 394 | 'result_request': self.get_results, |
|
395 | 395 | 'history_request': self.get_history, |
|
396 | 396 | 'db_request': self.db_query, |
|
397 | 397 | 'purge_request': self.purge_results, |
|
398 | 398 | 'load_request': self.check_load, |
|
399 | 399 | 'resubmit_request': self.resubmit_task, |
|
400 | 400 | 'shutdown_request': self.shutdown_request, |
|
401 | 401 | 'registration_request' : self.register_engine, |
|
402 | 402 | 'unregistration_request' : self.unregister_engine, |
|
403 | 403 | 'connection_request': self.connection_request, |
|
404 | 404 | } |
|
405 | 405 | |
|
406 | 406 | # ignore resubmit replies |
|
407 | 407 | self.resubmit.on_recv(lambda msg: None, copy=False) |
|
408 | 408 | |
|
409 | 409 | self.log.info("hub::created hub") |
|
410 | 410 | |
|
411 | 411 | @property |
|
412 | 412 | def _next_id(self): |
|
413 | 413 | """gemerate a new ID. |
|
414 | 414 | |
|
415 | 415 | No longer reuse old ids, just count from 0.""" |
|
416 | 416 | newid = self._idcounter |
|
417 | 417 | self._idcounter += 1 |
|
418 | 418 | return newid |
|
419 | 419 | # newid = 0 |
|
420 | 420 | # incoming = [id[0] for id in self.incoming_registrations.itervalues()] |
|
421 | 421 | # # print newid, self.ids, self.incoming_registrations |
|
422 | 422 | # while newid in self.ids or newid in incoming: |
|
423 | 423 | # newid += 1 |
|
424 | 424 | # return newid |
|
425 | 425 | |
|
426 | 426 | #----------------------------------------------------------------------------- |
|
427 | 427 | # message validation |
|
428 | 428 | #----------------------------------------------------------------------------- |
|
429 | 429 | |
|
430 | 430 | def _validate_targets(self, targets): |
|
431 | 431 | """turn any valid targets argument into a list of integer ids""" |
|
432 | 432 | if targets is None: |
|
433 | 433 | # default to all |
|
434 | 434 | targets = self.ids |
|
435 | 435 | |
|
436 | 436 | if isinstance(targets, (int,str,unicode)): |
|
437 | 437 | # only one target specified |
|
438 | 438 | targets = [targets] |
|
439 | 439 | _targets = [] |
|
440 | 440 | for t in targets: |
|
441 | 441 | # map raw identities to ids |
|
442 | 442 | if isinstance(t, (str,unicode)): |
|
443 | 443 | t = self.by_ident.get(t, t) |
|
444 | 444 | _targets.append(t) |
|
445 | 445 | targets = _targets |
|
446 | 446 | bad_targets = [ t for t in targets if t not in self.ids ] |
|
447 | 447 | if bad_targets: |
|
448 | 448 | raise IndexError("No Such Engine: %r"%bad_targets) |
|
449 | 449 | if not targets: |
|
450 | 450 | raise IndexError("No Engines Registered") |
|
451 | 451 | return targets |
|
452 | 452 | |
|
453 | 453 | #----------------------------------------------------------------------------- |
|
454 | 454 | # dispatch methods (1 per stream) |
|
455 | 455 | #----------------------------------------------------------------------------- |
|
456 | 456 | |
|
457 | 457 | |
|
458 | 458 | def dispatch_monitor_traffic(self, msg): |
|
459 | 459 | """all ME and Task queue messages come through here, as well as |
|
460 | 460 | IOPub traffic.""" |
|
461 | 461 | self.log.debug("monitor traffic: %r"%msg[:2]) |
|
462 | 462 | switch = msg[0] |
|
463 | 463 | try: |
|
464 | 464 | idents, msg = self.session.feed_identities(msg[1:]) |
|
465 | 465 | except ValueError: |
|
466 | 466 | idents=[] |
|
467 | 467 | if not idents: |
|
468 | 468 | self.log.error("Bad Monitor Message: %r"%msg) |
|
469 | 469 | return |
|
470 | 470 | handler = self.monitor_handlers.get(switch, None) |
|
471 | 471 | if handler is not None: |
|
472 | 472 | handler(idents, msg) |
|
473 | 473 | else: |
|
474 | 474 | self.log.error("Invalid monitor topic: %r"%switch) |
|
475 | 475 | |
|
476 | 476 | |
|
477 | 477 | def dispatch_query(self, msg): |
|
478 | 478 | """Route registration requests and queries from clients.""" |
|
479 | 479 | try: |
|
480 | 480 | idents, msg = self.session.feed_identities(msg) |
|
481 | 481 | except ValueError: |
|
482 | 482 | idents = [] |
|
483 | 483 | if not idents: |
|
484 | 484 | self.log.error("Bad Query Message: %r"%msg) |
|
485 | 485 | return |
|
486 | 486 | client_id = idents[0] |
|
487 | 487 | try: |
|
488 | 488 | msg = self.session.unpack_message(msg, content=True) |
|
489 | 489 | except Exception: |
|
490 | 490 | content = error.wrap_exception() |
|
491 | 491 | self.log.error("Bad Query Message: %r"%msg, exc_info=True) |
|
492 | 492 | self.session.send(self.query, "hub_error", ident=client_id, |
|
493 | 493 | content=content) |
|
494 | 494 | return |
|
495 | 495 | # print client_id, header, parent, content |
|
496 | 496 | #switch on message type: |
|
497 | 497 | msg_type = msg['msg_type'] |
|
498 | 498 | self.log.info("client::client %r requested %r"%(client_id, msg_type)) |
|
499 | 499 | handler = self.query_handlers.get(msg_type, None) |
|
500 | 500 | try: |
|
501 | 501 | assert handler is not None, "Bad Message Type: %r"%msg_type |
|
502 | 502 | except: |
|
503 | 503 | content = error.wrap_exception() |
|
504 | 504 | self.log.error("Bad Message Type: %r"%msg_type, exc_info=True) |
|
505 | 505 | self.session.send(self.query, "hub_error", ident=client_id, |
|
506 | 506 | content=content) |
|
507 | 507 | return |
|
508 | 508 | |
|
509 | 509 | else: |
|
510 | 510 | handler(idents, msg) |
|
511 | 511 | |
|
512 | 512 | def dispatch_db(self, msg): |
|
513 | 513 | """""" |
|
514 | 514 | raise NotImplementedError |
|
515 | 515 | |
|
516 | 516 | #--------------------------------------------------------------------------- |
|
517 | 517 | # handler methods (1 per event) |
|
518 | 518 | #--------------------------------------------------------------------------- |
|
519 | 519 | |
|
520 | 520 | #----------------------- Heartbeat -------------------------------------- |
|
521 | 521 | |
|
522 | 522 | def handle_new_heart(self, heart): |
|
523 | 523 | """handler to attach to heartbeater. |
|
524 | 524 | Called when a new heart starts to beat. |
|
525 | 525 | Triggers completion of registration.""" |
|
526 | 526 | self.log.debug("heartbeat::handle_new_heart(%r)"%heart) |
|
527 | 527 | if heart not in self.incoming_registrations: |
|
528 | 528 | self.log.info("heartbeat::ignoring new heart: %r"%heart) |
|
529 | 529 | else: |
|
530 | 530 | self.finish_registration(heart) |
|
531 | 531 | |
|
532 | 532 | |
|
533 | 533 | def handle_heart_failure(self, heart): |
|
534 | 534 | """handler to attach to heartbeater. |
|
535 | 535 | called when a previously registered heart fails to respond to beat request. |
|
536 | 536 | triggers unregistration""" |
|
537 | 537 | self.log.debug("heartbeat::handle_heart_failure(%r)"%heart) |
|
538 | 538 | eid = self.hearts.get(heart, None) |
|
539 | 539 | queue = self.engines[eid].queue |
|
540 | 540 | if eid is None: |
|
541 | 541 | self.log.info("heartbeat::ignoring heart failure %r"%heart) |
|
542 | 542 | else: |
|
543 | 543 | self.unregister_engine(heart, dict(content=dict(id=eid, queue=queue))) |
|
544 | 544 | |
|
545 | 545 | #----------------------- MUX Queue Traffic ------------------------------ |
|
546 | 546 | |
|
547 | 547 | def save_queue_request(self, idents, msg): |
|
548 | 548 | if len(idents) < 2: |
|
549 | 549 | self.log.error("invalid identity prefix: %r"%idents) |
|
550 | 550 | return |
|
551 | 551 | queue_id, client_id = idents[:2] |
|
552 | 552 | try: |
|
553 | 553 | msg = self.session.unpack_message(msg) |
|
554 | 554 | except Exception: |
|
555 | 555 | self.log.error("queue::client %r sent invalid message to %r: %r"%(client_id, queue_id, msg), exc_info=True) |
|
556 | 556 | return |
|
557 | 557 | |
|
558 | 558 | eid = self.by_ident.get(queue_id, None) |
|
559 | 559 | if eid is None: |
|
560 | 560 | self.log.error("queue::target %r not registered"%queue_id) |
|
561 | 561 | self.log.debug("queue:: valid are: %r"%(self.by_ident.keys())) |
|
562 | 562 | return |
|
563 | 563 | record = init_record(msg) |
|
564 | 564 | msg_id = record['msg_id'] |
|
565 | 565 | record['engine_uuid'] = queue_id |
|
566 | 566 | record['client_uuid'] = client_id |
|
567 | 567 | record['queue'] = 'mux' |
|
568 | 568 | |
|
569 | 569 | try: |
|
570 | 570 | # it's posible iopub arrived first: |
|
571 | 571 | existing = self.db.get_record(msg_id) |
|
572 | 572 | for key,evalue in existing.iteritems(): |
|
573 | 573 | rvalue = record.get(key, None) |
|
574 | 574 | if evalue and rvalue and evalue != rvalue: |
|
575 | 575 | self.log.warn("conflicting initial state for record: %r:%r <%r> %r"%(msg_id, rvalue, key, evalue)) |
|
576 | 576 | elif evalue and not rvalue: |
|
577 | 577 | record[key] = evalue |
|
578 | 578 | try: |
|
579 | 579 | self.db.update_record(msg_id, record) |
|
580 | 580 | except Exception: |
|
581 | 581 | self.log.error("DB Error updating record %r"%msg_id, exc_info=True) |
|
582 | 582 | except KeyError: |
|
583 | 583 | try: |
|
584 | 584 | self.db.add_record(msg_id, record) |
|
585 | 585 | except Exception: |
|
586 | 586 | self.log.error("DB Error adding record %r"%msg_id, exc_info=True) |
|
587 | 587 | |
|
588 | 588 | |
|
589 | 589 | self.pending.add(msg_id) |
|
590 | 590 | self.queues[eid].append(msg_id) |
|
591 | 591 | |
|
592 | 592 | def save_queue_result(self, idents, msg): |
|
593 | 593 | if len(idents) < 2: |
|
594 | 594 | self.log.error("invalid identity prefix: %r"%idents) |
|
595 | 595 | return |
|
596 | 596 | |
|
597 | 597 | client_id, queue_id = idents[:2] |
|
598 | 598 | try: |
|
599 | 599 | msg = self.session.unpack_message(msg) |
|
600 | 600 | except Exception: |
|
601 | 601 | self.log.error("queue::engine %r sent invalid message to %r: %r"%( |
|
602 | 602 | queue_id,client_id, msg), exc_info=True) |
|
603 | 603 | return |
|
604 | 604 | |
|
605 | 605 | eid = self.by_ident.get(queue_id, None) |
|
606 | 606 | if eid is None: |
|
607 | 607 | self.log.error("queue::unknown engine %r is sending a reply: "%queue_id) |
|
608 | 608 | return |
|
609 | 609 | |
|
610 | 610 | parent = msg['parent_header'] |
|
611 | 611 | if not parent: |
|
612 | 612 | return |
|
613 | 613 | msg_id = parent['msg_id'] |
|
614 | 614 | if msg_id in self.pending: |
|
615 | 615 | self.pending.remove(msg_id) |
|
616 | 616 | self.all_completed.add(msg_id) |
|
617 | 617 | self.queues[eid].remove(msg_id) |
|
618 | 618 | self.completed[eid].append(msg_id) |
|
619 | 619 | elif msg_id not in self.all_completed: |
|
620 | 620 | # it could be a result from a dead engine that died before delivering the |
|
621 | 621 | # result |
|
622 | 622 | self.log.warn("queue:: unknown msg finished %r"%msg_id) |
|
623 | 623 | return |
|
624 | 624 | # update record anyway, because the unregistration could have been premature |
|
625 | 625 | rheader = msg['header'] |
|
626 | 626 | completed = rheader['date'] |
|
627 | 627 | started = rheader.get('started', None) |
|
628 | 628 | result = { |
|
629 | 629 | 'result_header' : rheader, |
|
630 | 630 | 'result_content': msg['content'], |
|
631 | 631 | 'started' : started, |
|
632 | 632 | 'completed' : completed |
|
633 | 633 | } |
|
634 | 634 | |
|
635 | 635 | result['result_buffers'] = msg['buffers'] |
|
636 | 636 | try: |
|
637 | 637 | self.db.update_record(msg_id, result) |
|
638 | 638 | except Exception: |
|
639 | 639 | self.log.error("DB Error updating record %r"%msg_id, exc_info=True) |
|
640 | 640 | |
|
641 | 641 | |
|
642 | 642 | #--------------------- Task Queue Traffic ------------------------------ |
|
643 | 643 | |
|
644 | 644 | def save_task_request(self, idents, msg): |
|
645 | 645 | """Save the submission of a task.""" |
|
646 | 646 | client_id = idents[0] |
|
647 | 647 | |
|
648 | 648 | try: |
|
649 | 649 | msg = self.session.unpack_message(msg) |
|
650 | 650 | except Exception: |
|
651 | 651 | self.log.error("task::client %r sent invalid task message: %r"%( |
|
652 | 652 | client_id, msg), exc_info=True) |
|
653 | 653 | return |
|
654 | 654 | record = init_record(msg) |
|
655 | 655 | |
|
656 | 656 | record['client_uuid'] = client_id |
|
657 | 657 | record['queue'] = 'task' |
|
658 | 658 | header = msg['header'] |
|
659 | 659 | msg_id = header['msg_id'] |
|
660 | 660 | self.pending.add(msg_id) |
|
661 | 661 | self.unassigned.add(msg_id) |
|
662 | 662 | try: |
|
663 | 663 | # it's posible iopub arrived first: |
|
664 | 664 | existing = self.db.get_record(msg_id) |
|
665 | 665 | if existing['resubmitted']: |
|
666 | 666 | for key in ('submitted', 'client_uuid', 'buffers'): |
|
667 | 667 | # don't clobber these keys on resubmit |
|
668 | 668 | # submitted and client_uuid should be different |
|
669 | 669 | # and buffers might be big, and shouldn't have changed |
|
670 | 670 | record.pop(key) |
|
671 | 671 | # still check content,header which should not change |
|
672 | 672 | # but are not expensive to compare as buffers |
|
673 | 673 | |
|
674 | 674 | for key,evalue in existing.iteritems(): |
|
675 | 675 | if key.endswith('buffers'): |
|
676 | 676 | # don't compare buffers |
|
677 | 677 | continue |
|
678 | 678 | rvalue = record.get(key, None) |
|
679 | 679 | if evalue and rvalue and evalue != rvalue: |
|
680 | 680 | self.log.warn("conflicting initial state for record: %r:%r <%r> %r"%(msg_id, rvalue, key, evalue)) |
|
681 | 681 | elif evalue and not rvalue: |
|
682 | 682 | record[key] = evalue |
|
683 | 683 | try: |
|
684 | 684 | self.db.update_record(msg_id, record) |
|
685 | 685 | except Exception: |
|
686 | 686 | self.log.error("DB Error updating record %r"%msg_id, exc_info=True) |
|
687 | 687 | except KeyError: |
|
688 | 688 | try: |
|
689 | 689 | self.db.add_record(msg_id, record) |
|
690 | 690 | except Exception: |
|
691 | 691 | self.log.error("DB Error adding record %r"%msg_id, exc_info=True) |
|
692 | 692 | except Exception: |
|
693 | 693 | self.log.error("DB Error saving task request %r"%msg_id, exc_info=True) |
|
694 | 694 | |
|
695 | 695 | def save_task_result(self, idents, msg): |
|
696 | 696 | """save the result of a completed task.""" |
|
697 | 697 | client_id = idents[0] |
|
698 | 698 | try: |
|
699 | 699 | msg = self.session.unpack_message(msg) |
|
700 | 700 | except Exception: |
|
701 | 701 | self.log.error("task::invalid task result message send to %r: %r"%( |
|
702 | 702 | client_id, msg), exc_info=True) |
|
703 | 703 | return |
|
704 | 704 | |
|
705 | 705 | parent = msg['parent_header'] |
|
706 | 706 | if not parent: |
|
707 | 707 | # print msg |
|
708 | 708 | self.log.warn("Task %r had no parent!"%msg) |
|
709 | 709 | return |
|
710 | 710 | msg_id = parent['msg_id'] |
|
711 | 711 | if msg_id in self.unassigned: |
|
712 | 712 | self.unassigned.remove(msg_id) |
|
713 | 713 | |
|
714 | 714 | header = msg['header'] |
|
715 | 715 | engine_uuid = header.get('engine', None) |
|
716 | 716 | eid = self.by_ident.get(engine_uuid, None) |
|
717 | 717 | |
|
718 | 718 | if msg_id in self.pending: |
|
719 | 719 | self.pending.remove(msg_id) |
|
720 | 720 | self.all_completed.add(msg_id) |
|
721 | 721 | if eid is not None: |
|
722 | 722 | self.completed[eid].append(msg_id) |
|
723 | 723 | if msg_id in self.tasks[eid]: |
|
724 | 724 | self.tasks[eid].remove(msg_id) |
|
725 | 725 | completed = header['date'] |
|
726 | 726 | started = header.get('started', None) |
|
727 | 727 | result = { |
|
728 | 728 | 'result_header' : header, |
|
729 | 729 | 'result_content': msg['content'], |
|
730 | 730 | 'started' : started, |
|
731 | 731 | 'completed' : completed, |
|
732 | 732 | 'engine_uuid': engine_uuid |
|
733 | 733 | } |
|
734 | 734 | |
|
735 | 735 | result['result_buffers'] = msg['buffers'] |
|
736 | 736 | try: |
|
737 | 737 | self.db.update_record(msg_id, result) |
|
738 | 738 | except Exception: |
|
739 | 739 | self.log.error("DB Error saving task request %r"%msg_id, exc_info=True) |
|
740 | 740 | |
|
741 | 741 | else: |
|
742 | 742 | self.log.debug("task::unknown task %r finished"%msg_id) |
|
743 | 743 | |
|
744 | 744 | def save_task_destination(self, idents, msg): |
|
745 | 745 | try: |
|
746 | 746 | msg = self.session.unpack_message(msg, content=True) |
|
747 | 747 | except Exception: |
|
748 | 748 | self.log.error("task::invalid task tracking message", exc_info=True) |
|
749 | 749 | return |
|
750 | 750 | content = msg['content'] |
|
751 | 751 | # print (content) |
|
752 | 752 | msg_id = content['msg_id'] |
|
753 | 753 | engine_uuid = content['engine_id'] |
|
754 | 754 | eid = self.by_ident[engine_uuid] |
|
755 | 755 | |
|
756 | 756 | self.log.info("task::task %r arrived on %r"%(msg_id, eid)) |
|
757 | 757 | if msg_id in self.unassigned: |
|
758 | 758 | self.unassigned.remove(msg_id) |
|
759 | 759 | # else: |
|
760 | 760 | # self.log.debug("task::task %r not listed as MIA?!"%(msg_id)) |
|
761 | 761 | |
|
762 | 762 | self.tasks[eid].append(msg_id) |
|
763 | 763 | # self.pending[msg_id][1].update(received=datetime.now(),engine=(eid,engine_uuid)) |
|
764 | 764 | try: |
|
765 | 765 | self.db.update_record(msg_id, dict(engine_uuid=engine_uuid)) |
|
766 | 766 | except Exception: |
|
767 | 767 | self.log.error("DB Error saving task destination %r"%msg_id, exc_info=True) |
|
768 | 768 | |
|
769 | 769 | |
|
770 | 770 | def mia_task_request(self, idents, msg): |
|
771 | 771 | raise NotImplementedError |
|
772 | 772 | client_id = idents[0] |
|
773 | 773 | # content = dict(mia=self.mia,status='ok') |
|
774 | 774 | # self.session.send('mia_reply', content=content, idents=client_id) |
|
775 | 775 | |
|
776 | 776 | |
|
777 | 777 | #--------------------- IOPub Traffic ------------------------------ |
|
778 | 778 | |
|
779 | 779 | def save_iopub_message(self, topics, msg): |
|
780 | 780 | """save an iopub message into the db""" |
|
781 | 781 | # print (topics) |
|
782 | 782 | try: |
|
783 | 783 | msg = self.session.unpack_message(msg, content=True) |
|
784 | 784 | except Exception: |
|
785 | 785 | self.log.error("iopub::invalid IOPub message", exc_info=True) |
|
786 | 786 | return |
|
787 | 787 | |
|
788 | 788 | parent = msg['parent_header'] |
|
789 | 789 | if not parent: |
|
790 | 790 | self.log.error("iopub::invalid IOPub message: %r"%msg) |
|
791 | 791 | return |
|
792 | 792 | msg_id = parent['msg_id'] |
|
793 | 793 | msg_type = msg['msg_type'] |
|
794 | 794 | content = msg['content'] |
|
795 | 795 | |
|
796 | 796 | # ensure msg_id is in db |
|
797 | 797 | try: |
|
798 | 798 | rec = self.db.get_record(msg_id) |
|
799 | 799 | except KeyError: |
|
800 | 800 | rec = empty_record() |
|
801 | 801 | rec['msg_id'] = msg_id |
|
802 | 802 | self.db.add_record(msg_id, rec) |
|
803 | 803 | # stream |
|
804 | 804 | d = {} |
|
805 | 805 | if msg_type == 'stream': |
|
806 | 806 | name = content['name'] |
|
807 | 807 | s = rec[name] or '' |
|
808 | 808 | d[name] = s + content['data'] |
|
809 | 809 | |
|
810 | 810 | elif msg_type == 'pyerr': |
|
811 | 811 | d['pyerr'] = content |
|
812 | 812 | elif msg_type == 'pyin': |
|
813 | 813 | d['pyin'] = content['code'] |
|
814 | 814 | else: |
|
815 | 815 | d[msg_type] = content.get('data', '') |
|
816 | 816 | |
|
817 | 817 | try: |
|
818 | 818 | self.db.update_record(msg_id, d) |
|
819 | 819 | except Exception: |
|
820 | 820 | self.log.error("DB Error saving iopub message %r"%msg_id, exc_info=True) |
|
821 | 821 | |
|
822 | 822 | |
|
823 | 823 | |
|
824 | 824 | #------------------------------------------------------------------------- |
|
825 | 825 | # Registration requests |
|
826 | 826 | #------------------------------------------------------------------------- |
|
827 | 827 | |
|
828 | 828 | def connection_request(self, client_id, msg): |
|
829 | 829 | """Reply with connection addresses for clients.""" |
|
830 | 830 | self.log.info("client::client %r connected"%client_id) |
|
831 | 831 | content = dict(status='ok') |
|
832 | 832 | content.update(self.client_info) |
|
833 | 833 | jsonable = {} |
|
834 | 834 | for k,v in self.keytable.iteritems(): |
|
835 | 835 | if v not in self.dead_engines: |
|
836 | 836 | jsonable[str(k)] = v |
|
837 | 837 | content['engines'] = jsonable |
|
838 | 838 | self.session.send(self.query, 'connection_reply', content, parent=msg, ident=client_id) |
|
839 | 839 | |
|
840 | 840 | def register_engine(self, reg, msg): |
|
841 | 841 | """Register a new engine.""" |
|
842 | 842 | content = msg['content'] |
|
843 | 843 | try: |
|
844 | 844 | queue = content['queue'] |
|
845 | 845 | except KeyError: |
|
846 | 846 | self.log.error("registration::queue not specified", exc_info=True) |
|
847 | 847 | return |
|
848 | 848 | heart = content.get('heartbeat', None) |
|
849 | 849 | """register a new engine, and create the socket(s) necessary""" |
|
850 | 850 | eid = self._next_id |
|
851 | 851 | # print (eid, queue, reg, heart) |
|
852 | 852 | |
|
853 | 853 | self.log.debug("registration::register_engine(%i, %r, %r, %r)"%(eid, queue, reg, heart)) |
|
854 | 854 | |
|
855 | 855 | content = dict(id=eid,status='ok') |
|
856 | 856 | content.update(self.engine_info) |
|
857 | 857 | # check if requesting available IDs: |
|
858 | 858 | if queue in self.by_ident: |
|
859 | 859 | try: |
|
860 | 860 | raise KeyError("queue_id %r in use"%queue) |
|
861 | 861 | except: |
|
862 | 862 | content = error.wrap_exception() |
|
863 | 863 | self.log.error("queue_id %r in use"%queue, exc_info=True) |
|
864 | 864 | elif heart in self.hearts: # need to check unique hearts? |
|
865 | 865 | try: |
|
866 | 866 | raise KeyError("heart_id %r in use"%heart) |
|
867 | 867 | except: |
|
868 | 868 | self.log.error("heart_id %r in use"%heart, exc_info=True) |
|
869 | 869 | content = error.wrap_exception() |
|
870 | 870 | else: |
|
871 | 871 | for h, pack in self.incoming_registrations.iteritems(): |
|
872 | 872 | if heart == h: |
|
873 | 873 | try: |
|
874 | 874 | raise KeyError("heart_id %r in use"%heart) |
|
875 | 875 | except: |
|
876 | 876 | self.log.error("heart_id %r in use"%heart, exc_info=True) |
|
877 | 877 | content = error.wrap_exception() |
|
878 | 878 | break |
|
879 | 879 | elif queue == pack[1]: |
|
880 | 880 | try: |
|
881 | 881 | raise KeyError("queue_id %r in use"%queue) |
|
882 | 882 | except: |
|
883 | 883 | self.log.error("queue_id %r in use"%queue, exc_info=True) |
|
884 | 884 | content = error.wrap_exception() |
|
885 | 885 | break |
|
886 | 886 | |
|
887 | 887 | msg = self.session.send(self.query, "registration_reply", |
|
888 | 888 | content=content, |
|
889 | 889 | ident=reg) |
|
890 | 890 | |
|
891 | 891 | if content['status'] == 'ok': |
|
892 | 892 | if heart in self.heartmonitor.hearts: |
|
893 | 893 | # already beating |
|
894 | 894 | self.incoming_registrations[heart] = (eid,queue,reg[0],None) |
|
895 | 895 | self.finish_registration(heart) |
|
896 | 896 | else: |
|
897 | 897 | purge = lambda : self._purge_stalled_registration(heart) |
|
898 | 898 | dc = ioloop.DelayedCallback(purge, self.registration_timeout, self.loop) |
|
899 | 899 | dc.start() |
|
900 | 900 | self.incoming_registrations[heart] = (eid,queue,reg[0],dc) |
|
901 | 901 | else: |
|
902 | 902 | self.log.error("registration::registration %i failed: %r"%(eid, content['evalue'])) |
|
903 | 903 | return eid |
|
904 | 904 | |
|
905 | 905 | def unregister_engine(self, ident, msg): |
|
906 | 906 | """Unregister an engine that explicitly requested to leave.""" |
|
907 | 907 | try: |
|
908 | 908 | eid = msg['content']['id'] |
|
909 | 909 | except: |
|
910 | 910 | self.log.error("registration::bad engine id for unregistration: %r"%ident, exc_info=True) |
|
911 | 911 | return |
|
912 | 912 | self.log.info("registration::unregister_engine(%r)"%eid) |
|
913 | 913 | # print (eid) |
|
914 | 914 | uuid = self.keytable[eid] |
|
915 | 915 | content=dict(id=eid, queue=uuid) |
|
916 | 916 | self.dead_engines.add(uuid) |
|
917 | 917 | # self.ids.remove(eid) |
|
918 | 918 | # uuid = self.keytable.pop(eid) |
|
919 | 919 | # |
|
920 | 920 | # ec = self.engines.pop(eid) |
|
921 | 921 | # self.hearts.pop(ec.heartbeat) |
|
922 | 922 | # self.by_ident.pop(ec.queue) |
|
923 | 923 | # self.completed.pop(eid) |
|
924 | 924 | handleit = lambda : self._handle_stranded_msgs(eid, uuid) |
|
925 | 925 | dc = ioloop.DelayedCallback(handleit, self.registration_timeout, self.loop) |
|
926 | 926 | dc.start() |
|
927 | 927 | ############## TODO: HANDLE IT ################ |
|
928 | 928 | |
|
929 | 929 | if self.notifier: |
|
930 | 930 | self.session.send(self.notifier, "unregistration_notification", content=content) |
|
931 | 931 | |
|
932 | 932 | def _handle_stranded_msgs(self, eid, uuid): |
|
933 | 933 | """Handle messages known to be on an engine when the engine unregisters. |
|
934 | 934 | |
|
935 | 935 | It is possible that this will fire prematurely - that is, an engine will |
|
936 | 936 | go down after completing a result, and the client will be notified |
|
937 | 937 | that the result failed and later receive the actual result. |
|
938 | 938 | """ |
|
939 | 939 | |
|
940 | 940 | outstanding = self.queues[eid] |
|
941 | 941 | |
|
942 | 942 | for msg_id in outstanding: |
|
943 | 943 | self.pending.remove(msg_id) |
|
944 | 944 | self.all_completed.add(msg_id) |
|
945 | 945 | try: |
|
946 | 946 | raise error.EngineError("Engine %r died while running task %r"%(eid, msg_id)) |
|
947 | 947 | except: |
|
948 | 948 | content = error.wrap_exception() |
|
949 | 949 | # build a fake header: |
|
950 | 950 | header = {} |
|
951 | 951 | header['engine'] = uuid |
|
952 | 952 | header['date'] = datetime.now() |
|
953 | 953 | rec = dict(result_content=content, result_header=header, result_buffers=[]) |
|
954 | 954 | rec['completed'] = header['date'] |
|
955 | 955 | rec['engine_uuid'] = uuid |
|
956 | 956 | try: |
|
957 | 957 | self.db.update_record(msg_id, rec) |
|
958 | 958 | except Exception: |
|
959 | 959 | self.log.error("DB Error handling stranded msg %r"%msg_id, exc_info=True) |
|
960 | 960 | |
|
961 | 961 | |
|
962 | 962 | def finish_registration(self, heart): |
|
963 | 963 | """Second half of engine registration, called after our HeartMonitor |
|
964 | 964 | has received a beat from the Engine's Heart.""" |
|
965 | 965 | try: |
|
966 | 966 | (eid,queue,reg,purge) = self.incoming_registrations.pop(heart) |
|
967 | 967 | except KeyError: |
|
968 | 968 | self.log.error("registration::tried to finish nonexistant registration", exc_info=True) |
|
969 | 969 | return |
|
970 | 970 | self.log.info("registration::finished registering engine %i:%r"%(eid,queue)) |
|
971 | 971 | if purge is not None: |
|
972 | 972 | purge.stop() |
|
973 | 973 | control = queue |
|
974 | 974 | self.ids.add(eid) |
|
975 | 975 | self.keytable[eid] = queue |
|
976 | 976 | self.engines[eid] = EngineConnector(id=eid, queue=queue, registration=reg, |
|
977 | 977 | control=control, heartbeat=heart) |
|
978 | 978 | self.by_ident[queue] = eid |
|
979 | 979 | self.queues[eid] = list() |
|
980 | 980 | self.tasks[eid] = list() |
|
981 | 981 | self.completed[eid] = list() |
|
982 | 982 | self.hearts[heart] = eid |
|
983 | 983 | content = dict(id=eid, queue=self.engines[eid].queue) |
|
984 | 984 | if self.notifier: |
|
985 | 985 | self.session.send(self.notifier, "registration_notification", content=content) |
|
986 | 986 | self.log.info("engine::Engine Connected: %i"%eid) |
|
987 | 987 | |
|
988 | 988 | def _purge_stalled_registration(self, heart): |
|
989 | 989 | if heart in self.incoming_registrations: |
|
990 | 990 | eid = self.incoming_registrations.pop(heart)[0] |
|
991 | 991 | self.log.info("registration::purging stalled registration: %i"%eid) |
|
992 | 992 | else: |
|
993 | 993 | pass |
|
994 | 994 | |
|
995 | 995 | #------------------------------------------------------------------------- |
|
996 | 996 | # Client Requests |
|
997 | 997 | #------------------------------------------------------------------------- |
|
998 | 998 | |
|
999 | 999 | def shutdown_request(self, client_id, msg): |
|
1000 | 1000 | """handle shutdown request.""" |
|
1001 | 1001 | self.session.send(self.query, 'shutdown_reply', content={'status': 'ok'}, ident=client_id) |
|
1002 | 1002 | # also notify other clients of shutdown |
|
1003 | 1003 | self.session.send(self.notifier, 'shutdown_notice', content={'status': 'ok'}) |
|
1004 | 1004 | dc = ioloop.DelayedCallback(lambda : self._shutdown(), 1000, self.loop) |
|
1005 | 1005 | dc.start() |
|
1006 | 1006 | |
|
1007 | 1007 | def _shutdown(self): |
|
1008 | 1008 | self.log.info("hub::hub shutting down.") |
|
1009 | 1009 | time.sleep(0.1) |
|
1010 | 1010 | sys.exit(0) |
|
1011 | 1011 | |
|
1012 | 1012 | |
|
1013 | 1013 | def check_load(self, client_id, msg): |
|
1014 | 1014 | content = msg['content'] |
|
1015 | 1015 | try: |
|
1016 | 1016 | targets = content['targets'] |
|
1017 | 1017 | targets = self._validate_targets(targets) |
|
1018 | 1018 | except: |
|
1019 | 1019 | content = error.wrap_exception() |
|
1020 | 1020 | self.session.send(self.query, "hub_error", |
|
1021 | 1021 | content=content, ident=client_id) |
|
1022 | 1022 | return |
|
1023 | 1023 | |
|
1024 | 1024 | content = dict(status='ok') |
|
1025 | 1025 | # loads = {} |
|
1026 | 1026 | for t in targets: |
|
1027 | 1027 | content[bytes(t)] = len(self.queues[t])+len(self.tasks[t]) |
|
1028 | 1028 | self.session.send(self.query, "load_reply", content=content, ident=client_id) |
|
1029 | 1029 | |
|
1030 | 1030 | |
|
1031 | 1031 | def queue_status(self, client_id, msg): |
|
1032 | 1032 | """Return the Queue status of one or more targets. |
|
1033 | 1033 | if verbose: return the msg_ids |
|
1034 | 1034 | else: return len of each type. |
|
1035 | 1035 | keys: queue (pending MUX jobs) |
|
1036 | 1036 | tasks (pending Task jobs) |
|
1037 | 1037 | completed (finished jobs from both queues)""" |
|
1038 | 1038 | content = msg['content'] |
|
1039 | 1039 | targets = content['targets'] |
|
1040 | 1040 | try: |
|
1041 | 1041 | targets = self._validate_targets(targets) |
|
1042 | 1042 | except: |
|
1043 | 1043 | content = error.wrap_exception() |
|
1044 | 1044 | self.session.send(self.query, "hub_error", |
|
1045 | 1045 | content=content, ident=client_id) |
|
1046 | 1046 | return |
|
1047 | 1047 | verbose = content.get('verbose', False) |
|
1048 | 1048 | content = dict(status='ok') |
|
1049 | 1049 | for t in targets: |
|
1050 | 1050 | queue = self.queues[t] |
|
1051 | 1051 | completed = self.completed[t] |
|
1052 | 1052 | tasks = self.tasks[t] |
|
1053 | 1053 | if not verbose: |
|
1054 | 1054 | queue = len(queue) |
|
1055 | 1055 | completed = len(completed) |
|
1056 | 1056 | tasks = len(tasks) |
|
1057 | 1057 | content[bytes(t)] = {'queue': queue, 'completed': completed , 'tasks': tasks} |
|
1058 | 1058 | content['unassigned'] = list(self.unassigned) if verbose else len(self.unassigned) |
|
1059 | 1059 | |
|
1060 | 1060 | self.session.send(self.query, "queue_reply", content=content, ident=client_id) |
|
1061 | 1061 | |
|
1062 | 1062 | def purge_results(self, client_id, msg): |
|
1063 | 1063 | """Purge results from memory. This method is more valuable before we move |
|
1064 | 1064 | to a DB based message storage mechanism.""" |
|
1065 | 1065 | content = msg['content'] |
|
1066 | 1066 | msg_ids = content.get('msg_ids', []) |
|
1067 | 1067 | reply = dict(status='ok') |
|
1068 | 1068 | if msg_ids == 'all': |
|
1069 | 1069 | try: |
|
1070 | 1070 | self.db.drop_matching_records(dict(completed={'$ne':None})) |
|
1071 | 1071 | except Exception: |
|
1072 | 1072 | reply = error.wrap_exception() |
|
1073 | 1073 | else: |
|
1074 | 1074 | pending = filter(lambda m: m in self.pending, msg_ids) |
|
1075 | 1075 | if pending: |
|
1076 | 1076 | try: |
|
1077 | 1077 | raise IndexError("msg pending: %r"%pending[0]) |
|
1078 | 1078 | except: |
|
1079 | 1079 | reply = error.wrap_exception() |
|
1080 | 1080 | else: |
|
1081 | 1081 | try: |
|
1082 | 1082 | self.db.drop_matching_records(dict(msg_id={'$in':msg_ids})) |
|
1083 | 1083 | except Exception: |
|
1084 | 1084 | reply = error.wrap_exception() |
|
1085 | 1085 | |
|
1086 | 1086 | if reply['status'] == 'ok': |
|
1087 | 1087 | eids = content.get('engine_ids', []) |
|
1088 | 1088 | for eid in eids: |
|
1089 | 1089 | if eid not in self.engines: |
|
1090 | 1090 | try: |
|
1091 | 1091 | raise IndexError("No such engine: %i"%eid) |
|
1092 | 1092 | except: |
|
1093 | 1093 | reply = error.wrap_exception() |
|
1094 | 1094 | break |
|
1095 | 1095 | msg_ids = self.completed.pop(eid) |
|
1096 | 1096 | uid = self.engines[eid].queue |
|
1097 | 1097 | try: |
|
1098 | 1098 | self.db.drop_matching_records(dict(engine_uuid=uid, completed={'$ne':None})) |
|
1099 | 1099 | except Exception: |
|
1100 | 1100 | reply = error.wrap_exception() |
|
1101 | 1101 | break |
|
1102 | 1102 | |
|
1103 | 1103 | self.session.send(self.query, 'purge_reply', content=reply, ident=client_id) |
|
1104 | 1104 | |
|
1105 | 1105 | def resubmit_task(self, client_id, msg): |
|
1106 | 1106 | """Resubmit one or more tasks.""" |
|
1107 | 1107 | def finish(reply): |
|
1108 | 1108 | self.session.send(self.query, 'resubmit_reply', content=reply, ident=client_id) |
|
1109 | 1109 | |
|
1110 | 1110 | content = msg['content'] |
|
1111 | 1111 | msg_ids = content['msg_ids'] |
|
1112 | 1112 | reply = dict(status='ok') |
|
1113 | 1113 | try: |
|
1114 | 1114 | records = self.db.find_records({'msg_id' : {'$in' : msg_ids}}, keys=[ |
|
1115 | 1115 | 'header', 'content', 'buffers']) |
|
1116 | 1116 | except Exception: |
|
1117 | 1117 | self.log.error('db::db error finding tasks to resubmit', exc_info=True) |
|
1118 | 1118 | return finish(error.wrap_exception()) |
|
1119 | 1119 | |
|
1120 | 1120 | # validate msg_ids |
|
1121 | 1121 | found_ids = [ rec['msg_id'] for rec in records ] |
|
1122 | 1122 | invalid_ids = filter(lambda m: m in self.pending, found_ids) |
|
1123 | 1123 | if len(records) > len(msg_ids): |
|
1124 | 1124 | try: |
|
1125 | 1125 | raise RuntimeError("DB appears to be in an inconsistent state." |
|
1126 | 1126 | "More matching records were found than should exist") |
|
1127 | 1127 | except Exception: |
|
1128 | 1128 | return finish(error.wrap_exception()) |
|
1129 | 1129 | elif len(records) < len(msg_ids): |
|
1130 | 1130 | missing = [ m for m in msg_ids if m not in found_ids ] |
|
1131 | 1131 | try: |
|
1132 | 1132 | raise KeyError("No such msg(s): %r"%missing) |
|
1133 | 1133 | except KeyError: |
|
1134 | 1134 | return finish(error.wrap_exception()) |
|
1135 | 1135 | elif invalid_ids: |
|
1136 | 1136 | msg_id = invalid_ids[0] |
|
1137 | 1137 | try: |
|
1138 | 1138 | raise ValueError("Task %r appears to be inflight"%(msg_id)) |
|
1139 | 1139 | except Exception: |
|
1140 | 1140 | return finish(error.wrap_exception()) |
|
1141 | 1141 | |
|
1142 | 1142 | # clear the existing records |
|
1143 | 1143 | now = datetime.now() |
|
1144 | 1144 | rec = empty_record() |
|
1145 | 1145 | map(rec.pop, ['msg_id', 'header', 'content', 'buffers', 'submitted']) |
|
1146 | 1146 | rec['resubmitted'] = now |
|
1147 | 1147 | rec['queue'] = 'task' |
|
1148 | 1148 | rec['client_uuid'] = client_id[0] |
|
1149 | 1149 | try: |
|
1150 | 1150 | for msg_id in msg_ids: |
|
1151 | 1151 | self.all_completed.discard(msg_id) |
|
1152 | 1152 | self.db.update_record(msg_id, rec) |
|
1153 | 1153 | except Exception: |
|
1154 | 1154 | self.log.error('db::db error upating record', exc_info=True) |
|
1155 | 1155 | reply = error.wrap_exception() |
|
1156 | 1156 | else: |
|
1157 | 1157 | # send the messages |
|
1158 | 1158 | for rec in records: |
|
1159 | 1159 | header = rec['header'] |
|
1160 | 1160 | # include resubmitted in header to prevent digest collision |
|
1161 | 1161 | header['resubmitted'] = now |
|
1162 | 1162 | msg = self.session.msg(header['msg_type']) |
|
1163 | 1163 | msg['content'] = rec['content'] |
|
1164 | 1164 | msg['header'] = header |
|
1165 | 1165 | msg['msg_id'] = rec['msg_id'] |
|
1166 | 1166 | self.session.send(self.resubmit, msg, buffers=rec['buffers']) |
|
1167 | 1167 | |
|
1168 | 1168 | finish(dict(status='ok')) |
|
1169 | 1169 | |
|
1170 | 1170 | |
|
1171 | 1171 | def _extract_record(self, rec): |
|
1172 | 1172 | """decompose a TaskRecord dict into subsection of reply for get_result""" |
|
1173 | 1173 | io_dict = {} |
|
1174 | 1174 | for key in 'pyin pyout pyerr stdout stderr'.split(): |
|
1175 | 1175 | io_dict[key] = rec[key] |
|
1176 | 1176 | content = { 'result_content': rec['result_content'], |
|
1177 | 1177 | 'header': rec['header'], |
|
1178 | 1178 | 'result_header' : rec['result_header'], |
|
1179 | 1179 | 'io' : io_dict, |
|
1180 | 1180 | } |
|
1181 | 1181 | if rec['result_buffers']: |
|
1182 | 1182 | buffers = map(str, rec['result_buffers']) |
|
1183 | 1183 | else: |
|
1184 | 1184 | buffers = [] |
|
1185 | 1185 | |
|
1186 | 1186 | return content, buffers |
|
1187 | 1187 | |
|
1188 | 1188 | def get_results(self, client_id, msg): |
|
1189 | 1189 | """Get the result of 1 or more messages.""" |
|
1190 | 1190 | content = msg['content'] |
|
1191 | 1191 | msg_ids = sorted(set(content['msg_ids'])) |
|
1192 | 1192 | statusonly = content.get('status_only', False) |
|
1193 | 1193 | pending = [] |
|
1194 | 1194 | completed = [] |
|
1195 | 1195 | content = dict(status='ok') |
|
1196 | 1196 | content['pending'] = pending |
|
1197 | 1197 | content['completed'] = completed |
|
1198 | 1198 | buffers = [] |
|
1199 | 1199 | if not statusonly: |
|
1200 | 1200 | try: |
|
1201 | 1201 | matches = self.db.find_records(dict(msg_id={'$in':msg_ids})) |
|
1202 | 1202 | # turn match list into dict, for faster lookup |
|
1203 | 1203 | records = {} |
|
1204 | 1204 | for rec in matches: |
|
1205 | 1205 | records[rec['msg_id']] = rec |
|
1206 | 1206 | except Exception: |
|
1207 | 1207 | content = error.wrap_exception() |
|
1208 | 1208 | self.session.send(self.query, "result_reply", content=content, |
|
1209 | 1209 | parent=msg, ident=client_id) |
|
1210 | 1210 | return |
|
1211 | 1211 | else: |
|
1212 | 1212 | records = {} |
|
1213 | 1213 | for msg_id in msg_ids: |
|
1214 | 1214 | if msg_id in self.pending: |
|
1215 | 1215 | pending.append(msg_id) |
|
1216 | 1216 | elif msg_id in self.all_completed: |
|
1217 | 1217 | completed.append(msg_id) |
|
1218 | 1218 | if not statusonly: |
|
1219 | 1219 | c,bufs = self._extract_record(records[msg_id]) |
|
1220 | 1220 | content[msg_id] = c |
|
1221 | 1221 | buffers.extend(bufs) |
|
1222 | 1222 | elif msg_id in records: |
|
1223 | 1223 | if rec['completed']: |
|
1224 | 1224 | completed.append(msg_id) |
|
1225 | 1225 | c,bufs = self._extract_record(records[msg_id]) |
|
1226 | 1226 | content[msg_id] = c |
|
1227 | 1227 | buffers.extend(bufs) |
|
1228 | 1228 | else: |
|
1229 | 1229 | pending.append(msg_id) |
|
1230 | 1230 | else: |
|
1231 | 1231 | try: |
|
1232 | 1232 | raise KeyError('No such message: '+msg_id) |
|
1233 | 1233 | except: |
|
1234 | 1234 | content = error.wrap_exception() |
|
1235 | 1235 | break |
|
1236 | 1236 | self.session.send(self.query, "result_reply", content=content, |
|
1237 | 1237 | parent=msg, ident=client_id, |
|
1238 | 1238 | buffers=buffers) |
|
1239 | 1239 | |
|
1240 | 1240 | def get_history(self, client_id, msg): |
|
1241 | 1241 | """Get a list of all msg_ids in our DB records""" |
|
1242 | 1242 | try: |
|
1243 | 1243 | msg_ids = self.db.get_history() |
|
1244 | 1244 | except Exception as e: |
|
1245 | 1245 | content = error.wrap_exception() |
|
1246 | 1246 | else: |
|
1247 | 1247 | content = dict(status='ok', history=msg_ids) |
|
1248 | 1248 | |
|
1249 | 1249 | self.session.send(self.query, "history_reply", content=content, |
|
1250 | 1250 | parent=msg, ident=client_id) |
|
1251 | 1251 | |
|
1252 | 1252 | def db_query(self, client_id, msg): |
|
1253 | 1253 | """Perform a raw query on the task record database.""" |
|
1254 | 1254 | content = msg['content'] |
|
1255 | 1255 | query = content.get('query', {}) |
|
1256 | 1256 | keys = content.get('keys', None) |
|
1257 | 1257 | buffers = [] |
|
1258 | 1258 | empty = list() |
|
1259 | 1259 | try: |
|
1260 | 1260 | records = self.db.find_records(query, keys) |
|
1261 | 1261 | except Exception as e: |
|
1262 | 1262 | content = error.wrap_exception() |
|
1263 | 1263 | else: |
|
1264 | 1264 | # extract buffers from reply content: |
|
1265 | 1265 | if keys is not None: |
|
1266 | 1266 | buffer_lens = [] if 'buffers' in keys else None |
|
1267 | 1267 | result_buffer_lens = [] if 'result_buffers' in keys else None |
|
1268 | 1268 | else: |
|
1269 | 1269 | buffer_lens = [] |
|
1270 | 1270 | result_buffer_lens = [] |
|
1271 | 1271 | |
|
1272 | 1272 | for rec in records: |
|
1273 | 1273 | # buffers may be None, so double check |
|
1274 | 1274 | if buffer_lens is not None: |
|
1275 | 1275 | b = rec.pop('buffers', empty) or empty |
|
1276 | 1276 | buffer_lens.append(len(b)) |
|
1277 | 1277 | buffers.extend(b) |
|
1278 | 1278 | if result_buffer_lens is not None: |
|
1279 | 1279 | rb = rec.pop('result_buffers', empty) or empty |
|
1280 | 1280 | result_buffer_lens.append(len(rb)) |
|
1281 | 1281 | buffers.extend(rb) |
|
1282 | 1282 | content = dict(status='ok', records=records, buffer_lens=buffer_lens, |
|
1283 | 1283 | result_buffer_lens=result_buffer_lens) |
|
1284 | 1284 | |
|
1285 | 1285 | self.session.send(self.query, "db_reply", content=content, |
|
1286 | 1286 | parent=msg, ident=client_id, |
|
1287 | 1287 | buffers=buffers) |
|
1288 | 1288 |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
General Comments 0
You need to be logged in to leave comments.
Login now