Show More
The requested changes are too big and content was truncated. Show full diff
@@ -0,0 +1,32 b'' | |||
|
1 | """Error script. DO NOT EDIT FURTHER! It will break exception doctests!!!""" | |
|
2 | import sys | |
|
3 | ||
|
4 | def div0(): | |
|
5 | "foo" | |
|
6 | x = 1 | |
|
7 | y = 0 | |
|
8 | x/y | |
|
9 | ||
|
10 | def sysexit(stat, mode): | |
|
11 | raise SystemExit(stat, 'Mode = %s' % mode) | |
|
12 | ||
|
13 | def bar(mode): | |
|
14 | "bar" | |
|
15 | if mode=='div': | |
|
16 | div0() | |
|
17 | elif mode=='exit': | |
|
18 | try: | |
|
19 | stat = int(sys.argv[2]) | |
|
20 | except: | |
|
21 | stat = 1 | |
|
22 | sysexit(stat, mode) | |
|
23 | else: | |
|
24 | raise ValueError('Unknown mode') | |
|
25 | ||
|
26 | if __name__ == '__main__': | |
|
27 | try: | |
|
28 | mode = sys.argv[1] | |
|
29 | except IndexError: | |
|
30 | mode = 'div' | |
|
31 | ||
|
32 | bar(mode) |
@@ -0,0 +1,35 b'' | |||
|
1 | """Tests for the IPython tab-completion machinery. | |
|
2 | """ | |
|
3 | #----------------------------------------------------------------------------- | |
|
4 | # Module imports | |
|
5 | #----------------------------------------------------------------------------- | |
|
6 | ||
|
7 | # stdlib | |
|
8 | import sys | |
|
9 | ||
|
10 | # third party | |
|
11 | import nose.tools as nt | |
|
12 | ||
|
13 | # our own packages | |
|
14 | from IPython.core import completer | |
|
15 | ||
|
16 | #----------------------------------------------------------------------------- | |
|
17 | # Test functions | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | def test_protect_filename(): | |
|
20 | pairs = [ ('abc','abc'), | |
|
21 | (' abc',r'\ abc'), | |
|
22 | ('a bc',r'a\ bc'), | |
|
23 | ('a bc',r'a\ \ bc'), | |
|
24 | (' bc',r'\ \ bc'), | |
|
25 | ] | |
|
26 | # On posix, we also protect parens | |
|
27 | if sys.platform != 'win32': | |
|
28 | pairs.extend( [('a(bc',r'a\(bc'), | |
|
29 | ('a)bc',r'a\)bc'), | |
|
30 | ('a( )bc',r'a\(\ \)bc'), | |
|
31 | ] ) | |
|
32 | # run the actual tests | |
|
33 | for s1, s2 in pairs: | |
|
34 | s1p = completer.protect_filename(s1) | |
|
35 | nt.assert_equals(s1p, s2) |
@@ -0,0 +1,34 b'' | |||
|
1 | """Tests for input manipulation machinery.""" | |
|
2 | ||
|
3 | #----------------------------------------------------------------------------- | |
|
4 | # Imports | |
|
5 | #----------------------------------------------------------------------------- | |
|
6 | import nose.tools as nt | |
|
7 | ||
|
8 | from IPython.testing import tools as tt, decorators as dec | |
|
9 | ||
|
10 | #----------------------------------------------------------------------------- | |
|
11 | # Tests | |
|
12 | #----------------------------------------------------------------------------- | |
|
13 | @dec.parametric | |
|
14 | def test_prefilter(): | |
|
15 | """Test user input conversions""" | |
|
16 | ||
|
17 | # pairs of (raw, expected correct) input | |
|
18 | pairs = [ ('2+2','2+2'), | |
|
19 | ('>>> 2+2','2+2'), | |
|
20 | ('>>> # This is a comment\n' | |
|
21 | '... 2+2', | |
|
22 | '# This is a comment\n' | |
|
23 | '2+2'), | |
|
24 | # Some IPython input | |
|
25 | ('In [1]: 1', '1'), | |
|
26 | ('In [2]: for i in range(5):\n' | |
|
27 | ' ...: print i,', | |
|
28 | 'for i in range(5):\n' | |
|
29 | ' print i,'), | |
|
30 | ] | |
|
31 | ||
|
32 | ip = get_ipython() | |
|
33 | for raw, correct in pairs: | |
|
34 | yield nt.assert_equals(ip.prefilter(raw), correct) |
@@ -0,0 +1,169 b'' | |||
|
1 | """Tests for code execution (%run and related), which is particularly tricky. | |
|
2 | ||
|
3 | Because of how %run manages namespaces, and the fact that we are trying here to | |
|
4 | verify subtle object deletion and reference counting issues, the %run tests | |
|
5 | will be kept in this separate file. This makes it easier to aggregate in one | |
|
6 | place the tricks needed to handle it; most other magics are much easier to test | |
|
7 | and we do so in a common test_magic file. | |
|
8 | """ | |
|
9 | from __future__ import absolute_import | |
|
10 | ||
|
11 | #----------------------------------------------------------------------------- | |
|
12 | # Imports | |
|
13 | #----------------------------------------------------------------------------- | |
|
14 | ||
|
15 | import os | |
|
16 | import sys | |
|
17 | import tempfile | |
|
18 | ||
|
19 | import nose.tools as nt | |
|
20 | ||
|
21 | from IPython.testing import decorators as dec | |
|
22 | from IPython.testing import tools as tt | |
|
23 | ||
|
24 | #----------------------------------------------------------------------------- | |
|
25 | # Test functions begin | |
|
26 | #----------------------------------------------------------------------------- | |
|
27 | ||
|
28 | def doctest_refbug(): | |
|
29 | """Very nasty problem with references held by multiple runs of a script. | |
|
30 | See: https://bugs.launchpad.net/ipython/+bug/269966 | |
|
31 | ||
|
32 | In [1]: _ip.clear_main_mod_cache() | |
|
33 | # random | |
|
34 | ||
|
35 | In [2]: %run refbug | |
|
36 | ||
|
37 | In [3]: call_f() | |
|
38 | lowercased: hello | |
|
39 | ||
|
40 | In [4]: %run refbug | |
|
41 | ||
|
42 | In [5]: call_f() | |
|
43 | lowercased: hello | |
|
44 | lowercased: hello | |
|
45 | """ | |
|
46 | ||
|
47 | ||
|
48 | def doctest_run_builtins(): | |
|
49 | r"""Check that %run doesn't damage __builtins__. | |
|
50 | ||
|
51 | In [1]: import tempfile | |
|
52 | ||
|
53 | In [2]: bid1 = id(__builtins__) | |
|
54 | ||
|
55 | In [3]: fname = tempfile.mkstemp('.py')[1] | |
|
56 | ||
|
57 | In [3]: f = open(fname,'w') | |
|
58 | ||
|
59 | In [4]: f.write('pass\n') | |
|
60 | ||
|
61 | In [5]: f.flush() | |
|
62 | ||
|
63 | In [6]: t1 = type(__builtins__) | |
|
64 | ||
|
65 | In [7]: %run $fname | |
|
66 | ||
|
67 | In [7]: f.close() | |
|
68 | ||
|
69 | In [8]: bid2 = id(__builtins__) | |
|
70 | ||
|
71 | In [9]: t2 = type(__builtins__) | |
|
72 | ||
|
73 | In [10]: t1 == t2 | |
|
74 | Out[10]: True | |
|
75 | ||
|
76 | In [10]: bid1 == bid2 | |
|
77 | Out[10]: True | |
|
78 | ||
|
79 | In [12]: try: | |
|
80 | ....: os.unlink(fname) | |
|
81 | ....: except: | |
|
82 | ....: pass | |
|
83 | ....: | |
|
84 | """ | |
|
85 | ||
|
86 | # For some tests, it will be handy to organize them in a class with a common | |
|
87 | # setup that makes a temp file | |
|
88 | ||
|
89 | class TestMagicRunPass(tt.TempFileMixin): | |
|
90 | ||
|
91 | def setup(self): | |
|
92 | """Make a valid python temp file.""" | |
|
93 | self.mktmp('pass\n') | |
|
94 | ||
|
95 | def run_tmpfile(self): | |
|
96 | _ip = get_ipython() | |
|
97 | # This fails on Windows if self.tmpfile.name has spaces or "~" in it. | |
|
98 | # See below and ticket https://bugs.launchpad.net/bugs/366353 | |
|
99 | _ip.magic('run %s' % self.fname) | |
|
100 | ||
|
101 | def test_builtins_id(self): | |
|
102 | """Check that %run doesn't damage __builtins__ """ | |
|
103 | _ip = get_ipython() | |
|
104 | # Test that the id of __builtins__ is not modified by %run | |
|
105 | bid1 = id(_ip.user_ns['__builtins__']) | |
|
106 | self.run_tmpfile() | |
|
107 | bid2 = id(_ip.user_ns['__builtins__']) | |
|
108 | tt.assert_equals(bid1, bid2) | |
|
109 | ||
|
110 | def test_builtins_type(self): | |
|
111 | """Check that the type of __builtins__ doesn't change with %run. | |
|
112 | ||
|
113 | However, the above could pass if __builtins__ was already modified to | |
|
114 | be a dict (it should be a module) by a previous use of %run. So we | |
|
115 | also check explicitly that it really is a module: | |
|
116 | """ | |
|
117 | _ip = get_ipython() | |
|
118 | self.run_tmpfile() | |
|
119 | tt.assert_equals(type(_ip.user_ns['__builtins__']),type(sys)) | |
|
120 | ||
|
121 | def test_prompts(self): | |
|
122 | """Test that prompts correctly generate after %run""" | |
|
123 | self.run_tmpfile() | |
|
124 | _ip = get_ipython() | |
|
125 | p2 = str(_ip.outputcache.prompt2).strip() | |
|
126 | nt.assert_equals(p2[:3], '...') | |
|
127 | ||
|
128 | ||
|
129 | class TestMagicRunSimple(tt.TempFileMixin): | |
|
130 | ||
|
131 | def test_simpledef(self): | |
|
132 | """Test that simple class definitions work.""" | |
|
133 | src = ("class foo: pass\n" | |
|
134 | "def f(): return foo()") | |
|
135 | self.mktmp(src) | |
|
136 | _ip.magic('run %s' % self.fname) | |
|
137 | _ip.runlines('t = isinstance(f(), foo)') | |
|
138 | nt.assert_true(_ip.user_ns['t']) | |
|
139 | ||
|
140 | # We have to skip these in win32 because getoutputerr() crashes, | |
|
141 | # due to the fact that subprocess does not support close_fds when | |
|
142 | # redirecting stdout/err. So unless someone who knows more tells us how to | |
|
143 | # implement getoutputerr() in win32, we're stuck avoiding these. | |
|
144 | @dec.skip_win32 | |
|
145 | def test_obj_del(self): | |
|
146 | """Test that object's __del__ methods are called on exit.""" | |
|
147 | ||
|
148 | # This test is known to fail on win32. | |
|
149 | # See ticket https://bugs.launchpad.net/bugs/366334 | |
|
150 | src = ("class A(object):\n" | |
|
151 | " def __del__(self):\n" | |
|
152 | " print 'object A deleted'\n" | |
|
153 | "a = A()\n") | |
|
154 | self.mktmp(src) | |
|
155 | tt.ipexec_validate(self.fname, 'object A deleted') | |
|
156 | ||
|
157 | @dec.skip_win32 | |
|
158 | def test_tclass(self): | |
|
159 | mydir = os.path.dirname(__file__) | |
|
160 | tc = os.path.join(mydir, 'tclass') | |
|
161 | src = ("%%run '%s' C-first\n" | |
|
162 | "%%run '%s' C-second\n") % (tc, tc) | |
|
163 | self.mktmp(src, '.ipy') | |
|
164 | out = """\ | |
|
165 | ARGV 1-: ['C-first'] | |
|
166 | ARGV 1-: ['C-second'] | |
|
167 | tclass.py: deleting object: C-first | |
|
168 | """ | |
|
169 | tt.ipexec_validate(self.fname, out) |
@@ -0,0 +1,120 b'' | |||
|
1 | # IPython: modified copy of numpy.testing.utils, so numpy.testing.decorators | |
|
2 | # works without numpy being installed. | |
|
3 | """ | |
|
4 | Utility function to facilitate testing. | |
|
5 | """ | |
|
6 | ||
|
7 | import os | |
|
8 | import sys | |
|
9 | import re | |
|
10 | import operator | |
|
11 | import types | |
|
12 | import warnings | |
|
13 | ||
|
14 | # The following two classes are copied from python 2.6 warnings module (context | |
|
15 | # manager) | |
|
16 | class WarningMessage(object): | |
|
17 | ||
|
18 | """ | |
|
19 | Holds the result of a single showwarning() call. | |
|
20 | ||
|
21 | Notes | |
|
22 | ----- | |
|
23 | `WarningMessage` is copied from the Python 2.6 warnings module, | |
|
24 | so it can be used in NumPy with older Python versions. | |
|
25 | ||
|
26 | """ | |
|
27 | ||
|
28 | _WARNING_DETAILS = ("message", "category", "filename", "lineno", "file", | |
|
29 | "line") | |
|
30 | ||
|
31 | def __init__(self, message, category, filename, lineno, file=None, | |
|
32 | line=None): | |
|
33 | local_values = locals() | |
|
34 | for attr in self._WARNING_DETAILS: | |
|
35 | setattr(self, attr, local_values[attr]) | |
|
36 | if category: | |
|
37 | self._category_name = category.__name__ | |
|
38 | else: | |
|
39 | self._category_name = None | |
|
40 | ||
|
41 | def __str__(self): | |
|
42 | return ("{message : %r, category : %r, filename : %r, lineno : %s, " | |
|
43 | "line : %r}" % (self.message, self._category_name, | |
|
44 | self.filename, self.lineno, self.line)) | |
|
45 | ||
|
46 | class WarningManager: | |
|
47 | """ | |
|
48 | A context manager that copies and restores the warnings filter upon | |
|
49 | exiting the context. | |
|
50 | ||
|
51 | The 'record' argument specifies whether warnings should be captured by a | |
|
52 | custom implementation of ``warnings.showwarning()`` and be appended to a | |
|
53 | list returned by the context manager. Otherwise None is returned by the | |
|
54 | context manager. The objects appended to the list are arguments whose | |
|
55 | attributes mirror the arguments to ``showwarning()``. | |
|
56 | ||
|
57 | The 'module' argument is to specify an alternative module to the module | |
|
58 | named 'warnings' and imported under that name. This argument is only useful | |
|
59 | when testing the warnings module itself. | |
|
60 | ||
|
61 | Notes | |
|
62 | ----- | |
|
63 | `WarningManager` is a copy of the ``catch_warnings`` context manager | |
|
64 | from the Python 2.6 warnings module, with slight modifications. | |
|
65 | It is copied so it can be used in NumPy with older Python versions. | |
|
66 | ||
|
67 | """ | |
|
68 | def __init__(self, record=False, module=None): | |
|
69 | self._record = record | |
|
70 | if module is None: | |
|
71 | self._module = sys.modules['warnings'] | |
|
72 | else: | |
|
73 | self._module = module | |
|
74 | self._entered = False | |
|
75 | ||
|
76 | def __enter__(self): | |
|
77 | if self._entered: | |
|
78 | raise RuntimeError("Cannot enter %r twice" % self) | |
|
79 | self._entered = True | |
|
80 | self._filters = self._module.filters | |
|
81 | self._module.filters = self._filters[:] | |
|
82 | self._showwarning = self._module.showwarning | |
|
83 | if self._record: | |
|
84 | log = [] | |
|
85 | def showwarning(*args, **kwargs): | |
|
86 | log.append(WarningMessage(*args, **kwargs)) | |
|
87 | self._module.showwarning = showwarning | |
|
88 | return log | |
|
89 | else: | |
|
90 | return None | |
|
91 | ||
|
92 | def __exit__(self): | |
|
93 | if not self._entered: | |
|
94 | raise RuntimeError("Cannot exit %r without entering first" % self) | |
|
95 | self._module.filters = self._filters | |
|
96 | self._module.showwarning = self._showwarning | |
|
97 | ||
|
98 | def assert_warns(warning_class, func, *args, **kw): | |
|
99 | """Fail unless a warning of class warning_class is thrown by callable when | |
|
100 | invoked with arguments args and keyword arguments kwargs. | |
|
101 | ||
|
102 | If a different type of warning is thrown, it will not be caught, and the | |
|
103 | test case will be deemed to have suffered an error. | |
|
104 | """ | |
|
105 | ||
|
106 | # XXX: once we may depend on python >= 2.6, this can be replaced by the | |
|
107 | # warnings module context manager. | |
|
108 | ctx = WarningManager(record=True) | |
|
109 | l = ctx.__enter__() | |
|
110 | warnings.simplefilter('always') | |
|
111 | try: | |
|
112 | func(*args, **kw) | |
|
113 | if not len(l) > 0: | |
|
114 | raise AssertionError("No warning raised when calling %s" | |
|
115 | % func.__name__) | |
|
116 | if not l[0].category is warning_class: | |
|
117 | raise AssertionError("First warning for %s is not a " \ | |
|
118 | "%s( is %s)" % (func.__name__, warning_class, l[0])) | |
|
119 | finally: | |
|
120 | ctx.__exit__() |
@@ -0,0 +1,284 b'' | |||
|
1 | """ | |
|
2 | Decorators for labeling and modifying behavior of test objects. | |
|
3 | ||
|
4 | Decorators that merely return a modified version of the original | |
|
5 | function object are straightforward. Decorators that return a new | |
|
6 | function object need to use | |
|
7 | :: | |
|
8 | ||
|
9 | nose.tools.make_decorator(original_function)(decorator) | |
|
10 | ||
|
11 | in returning the decorator, in order to preserve meta-data such as | |
|
12 | function name, setup and teardown functions and so on - see | |
|
13 | ``nose.tools`` for more information. | |
|
14 | ||
|
15 | """ | |
|
16 | import warnings | |
|
17 | import sys | |
|
18 | ||
|
19 | # IPython changes: make this work if numpy not available | |
|
20 | # Original code: | |
|
21 | #from numpy.testing.utils import \ | |
|
22 | # WarningManager, WarningMessage | |
|
23 | # Our version: | |
|
24 | try: | |
|
25 | from numpy.testing.utils import WarningManager, WarningMessage | |
|
26 | except ImportError: | |
|
27 | from _numpy_testing_utils import WarningManager, WarningMessage | |
|
28 | ||
|
29 | # End IPython changes | |
|
30 | ||
|
31 | def slow(t): | |
|
32 | """ | |
|
33 | Label a test as 'slow'. | |
|
34 | ||
|
35 | The exact definition of a slow test is obviously both subjective and | |
|
36 | hardware-dependent, but in general any individual test that requires more | |
|
37 | than a second or two should be labeled as slow (the whole suite consits of | |
|
38 | thousands of tests, so even a second is significant). | |
|
39 | ||
|
40 | Parameters | |
|
41 | ---------- | |
|
42 | t : callable | |
|
43 | The test to label as slow. | |
|
44 | ||
|
45 | Returns | |
|
46 | ------- | |
|
47 | t : callable | |
|
48 | The decorated test `t`. | |
|
49 | ||
|
50 | Examples | |
|
51 | -------- | |
|
52 | The `numpy.testing` module includes ``import decorators as dec``. | |
|
53 | A test can be decorated as slow like this:: | |
|
54 | ||
|
55 | from numpy.testing import * | |
|
56 | ||
|
57 | @dec.slow | |
|
58 | def test_big(self): | |
|
59 | print 'Big, slow test' | |
|
60 | ||
|
61 | """ | |
|
62 | ||
|
63 | t.slow = True | |
|
64 | return t | |
|
65 | ||
|
66 | def setastest(tf=True): | |
|
67 | """ | |
|
68 | Signals to nose that this function is or is not a test. | |
|
69 | ||
|
70 | Parameters | |
|
71 | ---------- | |
|
72 | tf : bool | |
|
73 | If True, specifies that the decorated callable is a test. | |
|
74 | If False, specifies that the decorated callable is not a test. | |
|
75 | Default is True. | |
|
76 | ||
|
77 | Notes | |
|
78 | ----- | |
|
79 | This decorator can't use the nose namespace, because it can be | |
|
80 | called from a non-test module. See also ``istest`` and ``nottest`` in | |
|
81 | ``nose.tools``. | |
|
82 | ||
|
83 | Examples | |
|
84 | -------- | |
|
85 | `setastest` can be used in the following way:: | |
|
86 | ||
|
87 | from numpy.testing.decorators import setastest | |
|
88 | ||
|
89 | @setastest(False) | |
|
90 | def func_with_test_in_name(arg1, arg2): | |
|
91 | pass | |
|
92 | ||
|
93 | """ | |
|
94 | def set_test(t): | |
|
95 | t.__test__ = tf | |
|
96 | return t | |
|
97 | return set_test | |
|
98 | ||
|
99 | def skipif(skip_condition, msg=None): | |
|
100 | """ | |
|
101 | Make function raise SkipTest exception if a given condition is true. | |
|
102 | ||
|
103 | If the condition is a callable, it is used at runtime to dynamically | |
|
104 | make the decision. This is useful for tests that may require costly | |
|
105 | imports, to delay the cost until the test suite is actually executed. | |
|
106 | ||
|
107 | Parameters | |
|
108 | ---------- | |
|
109 | skip_condition : bool or callable | |
|
110 | Flag to determine whether to skip the decorated test. | |
|
111 | msg : str, optional | |
|
112 | Message to give on raising a SkipTest exception. Default is None. | |
|
113 | ||
|
114 | Returns | |
|
115 | ------- | |
|
116 | decorator : function | |
|
117 | Decorator which, when applied to a function, causes SkipTest | |
|
118 | to be raised when `skip_condition` is True, and the function | |
|
119 | to be called normally otherwise. | |
|
120 | ||
|
121 | Notes | |
|
122 | ----- | |
|
123 | The decorator itself is decorated with the ``nose.tools.make_decorator`` | |
|
124 | function in order to transmit function name, and various other metadata. | |
|
125 | ||
|
126 | """ | |
|
127 | ||
|
128 | def skip_decorator(f): | |
|
129 | # Local import to avoid a hard nose dependency and only incur the | |
|
130 | # import time overhead at actual test-time. | |
|
131 | import nose | |
|
132 | ||
|
133 | # Allow for both boolean or callable skip conditions. | |
|
134 | if callable(skip_condition): | |
|
135 | skip_val = lambda : skip_condition() | |
|
136 | else: | |
|
137 | skip_val = lambda : skip_condition | |
|
138 | ||
|
139 | def get_msg(func,msg=None): | |
|
140 | """Skip message with information about function being skipped.""" | |
|
141 | if msg is None: | |
|
142 | out = 'Test skipped due to test condition' | |
|
143 | else: | |
|
144 | out = '\n'+msg | |
|
145 | ||
|
146 | return "Skipping test: %s%s" % (func.__name__,out) | |
|
147 | ||
|
148 | # We need to define *two* skippers because Python doesn't allow both | |
|
149 | # return with value and yield inside the same function. | |
|
150 | def skipper_func(*args, **kwargs): | |
|
151 | """Skipper for normal test functions.""" | |
|
152 | if skip_val(): | |
|
153 | raise nose.SkipTest(get_msg(f,msg)) | |
|
154 | else: | |
|
155 | return f(*args, **kwargs) | |
|
156 | ||
|
157 | def skipper_gen(*args, **kwargs): | |
|
158 | """Skipper for test generators.""" | |
|
159 | if skip_val(): | |
|
160 | raise nose.SkipTest(get_msg(f,msg)) | |
|
161 | else: | |
|
162 | for x in f(*args, **kwargs): | |
|
163 | yield x | |
|
164 | ||
|
165 | # Choose the right skipper to use when building the actual decorator. | |
|
166 | if nose.util.isgenerator(f): | |
|
167 | skipper = skipper_gen | |
|
168 | else: | |
|
169 | skipper = skipper_func | |
|
170 | ||
|
171 | return nose.tools.make_decorator(f)(skipper) | |
|
172 | ||
|
173 | return skip_decorator | |
|
174 | ||
|
175 | ||
|
176 | def knownfailureif(fail_condition, msg=None): | |
|
177 | """ | |
|
178 | Make function raise KnownFailureTest exception if given condition is true. | |
|
179 | ||
|
180 | If the condition is a callable, it is used at runtime to dynamically | |
|
181 | make the decision. This is useful for tests that may require costly | |
|
182 | imports, to delay the cost until the test suite is actually executed. | |
|
183 | ||
|
184 | Parameters | |
|
185 | ---------- | |
|
186 | fail_condition : bool or callable | |
|
187 | Flag to determine whether to mark the decorated test as a known | |
|
188 | failure (if True) or not (if False). | |
|
189 | msg : str, optional | |
|
190 | Message to give on raising a KnownFailureTest exception. | |
|
191 | Default is None. | |
|
192 | ||
|
193 | Returns | |
|
194 | ------- | |
|
195 | decorator : function | |
|
196 | Decorator, which, when applied to a function, causes SkipTest | |
|
197 | to be raised when `skip_condition` is True, and the function | |
|
198 | to be called normally otherwise. | |
|
199 | ||
|
200 | Notes | |
|
201 | ----- | |
|
202 | The decorator itself is decorated with the ``nose.tools.make_decorator`` | |
|
203 | function in order to transmit function name, and various other metadata. | |
|
204 | ||
|
205 | """ | |
|
206 | if msg is None: | |
|
207 | msg = 'Test skipped due to known failure' | |
|
208 | ||
|
209 | # Allow for both boolean or callable known failure conditions. | |
|
210 | if callable(fail_condition): | |
|
211 | fail_val = lambda : fail_condition() | |
|
212 | else: | |
|
213 | fail_val = lambda : fail_condition | |
|
214 | ||
|
215 | def knownfail_decorator(f): | |
|
216 | # Local import to avoid a hard nose dependency and only incur the | |
|
217 | # import time overhead at actual test-time. | |
|
218 | import nose | |
|
219 | from noseclasses import KnownFailureTest | |
|
220 | def knownfailer(*args, **kwargs): | |
|
221 | if fail_val(): | |
|
222 | raise KnownFailureTest, msg | |
|
223 | else: | |
|
224 | return f(*args, **kwargs) | |
|
225 | return nose.tools.make_decorator(f)(knownfailer) | |
|
226 | ||
|
227 | return knownfail_decorator | |
|
228 | ||
|
229 | def deprecated(conditional=True): | |
|
230 | """ | |
|
231 | Filter deprecation warnings while running the test suite. | |
|
232 | ||
|
233 | This decorator can be used to filter DeprecationWarning's, to avoid | |
|
234 | printing them during the test suite run, while checking that the test | |
|
235 | actually raises a DeprecationWarning. | |
|
236 | ||
|
237 | Parameters | |
|
238 | ---------- | |
|
239 | conditional : bool or callable, optional | |
|
240 | Flag to determine whether to mark test as deprecated or not. If the | |
|
241 | condition is a callable, it is used at runtime to dynamically make the | |
|
242 | decision. Default is True. | |
|
243 | ||
|
244 | Returns | |
|
245 | ------- | |
|
246 | decorator : function | |
|
247 | The `deprecated` decorator itself. | |
|
248 | ||
|
249 | Notes | |
|
250 | ----- | |
|
251 | .. versionadded:: 1.4.0 | |
|
252 | ||
|
253 | """ | |
|
254 | def deprecate_decorator(f): | |
|
255 | # Local import to avoid a hard nose dependency and only incur the | |
|
256 | # import time overhead at actual test-time. | |
|
257 | import nose | |
|
258 | from noseclasses import KnownFailureTest | |
|
259 | ||
|
260 | def _deprecated_imp(*args, **kwargs): | |
|
261 | # Poor man's replacement for the with statement | |
|
262 | ctx = WarningManager(record=True) | |
|
263 | l = ctx.__enter__() | |
|
264 | warnings.simplefilter('always') | |
|
265 | try: | |
|
266 | f(*args, **kwargs) | |
|
267 | if not len(l) > 0: | |
|
268 | raise AssertionError("No warning raised when calling %s" | |
|
269 | % f.__name__) | |
|
270 | if not l[0].category is DeprecationWarning: | |
|
271 | raise AssertionError("First warning for %s is not a " \ | |
|
272 | "DeprecationWarning( is %s)" % (f.__name__, l[0])) | |
|
273 | finally: | |
|
274 | ctx.__exit__() | |
|
275 | ||
|
276 | if callable(conditional): | |
|
277 | cond = conditional() | |
|
278 | else: | |
|
279 | cond = conditional | |
|
280 | if cond: | |
|
281 | return nose.tools.make_decorator(f)(_deprecated_imp) | |
|
282 | else: | |
|
283 | return f | |
|
284 | return deprecate_decorator |
@@ -0,0 +1,147 b'' | |||
|
1 | # -*- coding: utf-8 -*- | |
|
2 | """Pylab (matplotlib) support utilities. | |
|
3 | ||
|
4 | Authors | |
|
5 | ------- | |
|
6 | Fernando Perez. | |
|
7 | """ | |
|
8 | ||
|
9 | #----------------------------------------------------------------------------- | |
|
10 | # Copyright (C) 2009 The IPython Development Team | |
|
11 | # | |
|
12 | # Distributed under the terms of the BSD License. The full license is in | |
|
13 | # the file COPYING, distributed as part of this software. | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | ||
|
16 | #----------------------------------------------------------------------------- | |
|
17 | # Imports | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | ||
|
20 | from IPython.utils.decorators import flag_calls | |
|
21 | ||
|
22 | #----------------------------------------------------------------------------- | |
|
23 | # Main classes and functions | |
|
24 | #----------------------------------------------------------------------------- | |
|
25 | ||
|
26 | def pylab_activate(user_ns, gui=None, import_all=True): | |
|
27 | """Activate pylab mode in the user's namespace. | |
|
28 | ||
|
29 | Loads and initializes numpy, matplotlib and friends for interactive use. | |
|
30 | ||
|
31 | Parameters | |
|
32 | ---------- | |
|
33 | user_ns : dict | |
|
34 | Namespace where the imports will occur. | |
|
35 | ||
|
36 | gui : optional, string | |
|
37 | A valid gui name following the conventions of the %gui magic. | |
|
38 | ||
|
39 | import_all : optional, boolean | |
|
40 | If true, an 'import *' is done from numpy and pylab. | |
|
41 | ||
|
42 | Returns | |
|
43 | ------- | |
|
44 | The actual gui used (if not given as input, it was obtained from matplotlib | |
|
45 | itself, and will be needed next to configure IPython's gui integration. | |
|
46 | """ | |
|
47 | ||
|
48 | # Initialize matplotlib to interactive mode always | |
|
49 | import matplotlib | |
|
50 | ||
|
51 | # If user specifies a GUI, that dictates the backend, otherwise we read the | |
|
52 | # user's mpl default from the mpl rc structure | |
|
53 | g2b = {'tk': 'TkAgg', | |
|
54 | 'gtk': 'GTKAgg', | |
|
55 | 'wx': 'WXAgg', | |
|
56 | 'qt': 'Qt4Agg', # qt3 not supported | |
|
57 | 'qt4': 'Qt4Agg' } | |
|
58 | ||
|
59 | if gui: | |
|
60 | # select backend based on requested gui | |
|
61 | backend = g2b[gui] | |
|
62 | else: | |
|
63 | backend = matplotlib.rcParams['backend'] | |
|
64 | # In this case, we need to find what the appropriate gui selection call | |
|
65 | # should be for IPython, so we can activate inputhook accordingly | |
|
66 | b2g = dict(zip(g2b.values(),g2b.keys())) | |
|
67 | gui = b2g[backend] | |
|
68 | ||
|
69 | # We must set the desired backend before importing pylab | |
|
70 | matplotlib.use(backend) | |
|
71 | ||
|
72 | # This must be imported last in the matplotlib series, after | |
|
73 | # backend/interactivity choices have been made | |
|
74 | import matplotlib.pylab as pylab | |
|
75 | ||
|
76 | # XXX For now leave this commented out, but depending on discussions with | |
|
77 | # mpl-dev, we may be able to allow interactive switching... | |
|
78 | #import matplotlib.pyplot | |
|
79 | #matplotlib.pyplot.switch_backend(backend) | |
|
80 | ||
|
81 | pylab.show._needmain = False | |
|
82 | # We need to detect at runtime whether show() is called by the user. | |
|
83 | # For this, we wrap it into a decorator which adds a 'called' flag. | |
|
84 | pylab.draw_if_interactive = flag_calls(pylab.draw_if_interactive) | |
|
85 | ||
|
86 | # Import numpy as np/pyplot as plt are conventions we're trying to | |
|
87 | # somewhat standardize on. Making them available to users by default | |
|
88 | # will greatly help this. | |
|
89 | exec ("import numpy\n" | |
|
90 | "import matplotlib\n" | |
|
91 | "from matplotlib import pylab, mlab, pyplot\n" | |
|
92 | "np = numpy\n" | |
|
93 | "plt = pyplot\n" | |
|
94 | ) in user_ns | |
|
95 | ||
|
96 | if import_all: | |
|
97 | exec("from matplotlib.pylab import *\n" | |
|
98 | "from numpy import *\n") in user_ns | |
|
99 | ||
|
100 | matplotlib.interactive(True) | |
|
101 | ||
|
102 | print """ | |
|
103 | Welcome to pylab, a matplotlib-based Python environment [backend: %s]. | |
|
104 | For more information, type 'help(pylab)'.""" % backend | |
|
105 | ||
|
106 | return gui | |
|
107 | ||
|
108 | # We need a little factory function here to create the closure where | |
|
109 | # safe_execfile can live. | |
|
110 | def mpl_runner(safe_execfile): | |
|
111 | """Factory to return a matplotlib-enabled runner for %run. | |
|
112 | ||
|
113 | Parameters | |
|
114 | ---------- | |
|
115 | safe_execfile : function | |
|
116 | This must be a function with the same interface as the | |
|
117 | :meth:`safe_execfile` method of IPython. | |
|
118 | ||
|
119 | Returns | |
|
120 | ------- | |
|
121 | A function suitable for use as the ``runner`` argument of the %run magic | |
|
122 | function. | |
|
123 | """ | |
|
124 | ||
|
125 | def mpl_execfile(fname,*where,**kw): | |
|
126 | """matplotlib-aware wrapper around safe_execfile. | |
|
127 | ||
|
128 | Its interface is identical to that of the :func:`execfile` builtin. | |
|
129 | ||
|
130 | This is ultimately a call to execfile(), but wrapped in safeties to | |
|
131 | properly handle interactive rendering.""" | |
|
132 | ||
|
133 | import matplotlib | |
|
134 | import matplotlib.pylab as pylab | |
|
135 | ||
|
136 | #print '*** Matplotlib runner ***' # dbg | |
|
137 | # turn off rendering until end of script | |
|
138 | is_interactive = matplotlib.rcParams['interactive'] | |
|
139 | matplotlib.interactive(False) | |
|
140 | safe_execfile(fname,*where,**kw) | |
|
141 | matplotlib.interactive(is_interactive) | |
|
142 | # make rendering call now, if the user tried to do it | |
|
143 | if pylab.draw_if_interactive.called: | |
|
144 | pylab.draw() | |
|
145 | pylab.draw_if_interactive.called = False | |
|
146 | ||
|
147 | return mpl_execfile |
@@ -0,0 +1,121 b'' | |||
|
1 | """Code taken from the Python2.6 standard library for backwards compatibility. | |
|
2 | ||
|
3 | This is just so we can use 2.6 features when running in 2.5, the code below is | |
|
4 | copied verbatim from the stdlib's collections and doctest modules. | |
|
5 | """ | |
|
6 | ||
|
7 | #----------------------------------------------------------------------------- | |
|
8 | # Copyright (C) 2009 The IPython Development Team | |
|
9 | # | |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
|
11 | # the file COPYING, distributed as part of this software. | |
|
12 | #----------------------------------------------------------------------------- | |
|
13 | ||
|
14 | #----------------------------------------------------------------------------- | |
|
15 | # Imports | |
|
16 | #----------------------------------------------------------------------------- | |
|
17 | ||
|
18 | from keyword import iskeyword as _iskeyword | |
|
19 | from operator import itemgetter as _itemgetter | |
|
20 | import sys as _sys | |
|
21 | ||
|
22 | def namedtuple(typename, field_names, verbose=False): | |
|
23 | """Returns a new subclass of tuple with named fields. | |
|
24 | ||
|
25 | >>> Point = namedtuple('Point', 'x y') | |
|
26 | >>> Point.__doc__ # docstring for the new class | |
|
27 | 'Point(x, y)' | |
|
28 | >>> p = Point(11, y=22) # instantiate with positional args or keywords | |
|
29 | >>> p[0] + p[1] # indexable like a plain tuple | |
|
30 | 33 | |
|
31 | >>> x, y = p # unpack like a regular tuple | |
|
32 | >>> x, y | |
|
33 | (11, 22) | |
|
34 | >>> p.x + p.y # fields also accessable by name | |
|
35 | 33 | |
|
36 | >>> d = p._asdict() # convert to a dictionary | |
|
37 | >>> d['x'] | |
|
38 | 11 | |
|
39 | >>> Point(**d) # convert from a dictionary | |
|
40 | Point(x=11, y=22) | |
|
41 | >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields | |
|
42 | Point(x=100, y=22) | |
|
43 | ||
|
44 | """ | |
|
45 | ||
|
46 | # Parse and validate the field names. Validation serves two purposes, | |
|
47 | # generating informative error messages and preventing template injection attacks. | |
|
48 | if isinstance(field_names, basestring): | |
|
49 | field_names = field_names.replace(',', ' ').split() # names separated by whitespace and/or commas | |
|
50 | field_names = tuple(map(str, field_names)) | |
|
51 | for name in (typename,) + field_names: | |
|
52 | if not all(c.isalnum() or c=='_' for c in name): | |
|
53 | raise ValueError('Type names and field names can only contain alphanumeric characters and underscores: %r' % name) | |
|
54 | if _iskeyword(name): | |
|
55 | raise ValueError('Type names and field names cannot be a keyword: %r' % name) | |
|
56 | if name[0].isdigit(): | |
|
57 | raise ValueError('Type names and field names cannot start with a number: %r' % name) | |
|
58 | seen_names = set() | |
|
59 | for name in field_names: | |
|
60 | if name.startswith('_'): | |
|
61 | raise ValueError('Field names cannot start with an underscore: %r' % name) | |
|
62 | if name in seen_names: | |
|
63 | raise ValueError('Encountered duplicate field name: %r' % name) | |
|
64 | seen_names.add(name) | |
|
65 | ||
|
66 | # Create and fill-in the class template | |
|
67 | numfields = len(field_names) | |
|
68 | argtxt = repr(field_names).replace("'", "")[1:-1] # tuple repr without parens or quotes | |
|
69 | reprtxt = ', '.join('%s=%%r' % name for name in field_names) | |
|
70 | dicttxt = ', '.join('%r: t[%d]' % (name, pos) for pos, name in enumerate(field_names)) | |
|
71 | template = '''class %(typename)s(tuple): | |
|
72 | '%(typename)s(%(argtxt)s)' \n | |
|
73 | __slots__ = () \n | |
|
74 | _fields = %(field_names)r \n | |
|
75 | def __new__(_cls, %(argtxt)s): | |
|
76 | return _tuple.__new__(_cls, (%(argtxt)s)) \n | |
|
77 | @classmethod | |
|
78 | def _make(cls, iterable, new=tuple.__new__, len=len): | |
|
79 | 'Make a new %(typename)s object from a sequence or iterable' | |
|
80 | result = new(cls, iterable) | |
|
81 | if len(result) != %(numfields)d: | |
|
82 | raise TypeError('Expected %(numfields)d arguments, got %%d' %% len(result)) | |
|
83 | return result \n | |
|
84 | def __repr__(self): | |
|
85 | return '%(typename)s(%(reprtxt)s)' %% self \n | |
|
86 | def _asdict(t): | |
|
87 | 'Return a new dict which maps field names to their values' | |
|
88 | return {%(dicttxt)s} \n | |
|
89 | def _replace(_self, **kwds): | |
|
90 | 'Return a new %(typename)s object replacing specified fields with new values' | |
|
91 | result = _self._make(map(kwds.pop, %(field_names)r, _self)) | |
|
92 | if kwds: | |
|
93 | raise ValueError('Got unexpected field names: %%r' %% kwds.keys()) | |
|
94 | return result \n | |
|
95 | def __getnewargs__(self): | |
|
96 | return tuple(self) \n\n''' % locals() | |
|
97 | for i, name in enumerate(field_names): | |
|
98 | template += ' %s = _property(_itemgetter(%d))\n' % (name, i) | |
|
99 | if verbose: | |
|
100 | print template | |
|
101 | ||
|
102 | # Execute the template string in a temporary namespace and | |
|
103 | # support tracing utilities by setting a value for frame.f_globals['__name__'] | |
|
104 | namespace = dict(_itemgetter=_itemgetter, __name__='namedtuple_%s' % typename, | |
|
105 | _property=property, _tuple=tuple) | |
|
106 | try: | |
|
107 | exec template in namespace | |
|
108 | except SyntaxError, e: | |
|
109 | raise SyntaxError(e.message + ':\n' + template) | |
|
110 | result = namespace[typename] | |
|
111 | ||
|
112 | # For pickling to work, the __module__ variable needs to be set to the frame | |
|
113 | # where the named tuple is created. Bypass this step in enviroments where | |
|
114 | # sys._getframe is not defined (Jython for example). | |
|
115 | if hasattr(_sys, '_getframe'): | |
|
116 | result.__module__ = _sys._getframe(1).f_globals.get('__name__', '__main__') | |
|
117 | ||
|
118 | return result | |
|
119 | ||
|
120 | ||
|
121 | TestResults = namedtuple('TestResults', 'failed attempted') |
@@ -0,0 +1,96 b'' | |||
|
1 | """Implementation of the parametric test support for Python 2.x | |
|
2 | """ | |
|
3 | ||
|
4 | #----------------------------------------------------------------------------- | |
|
5 | # Copyright (C) 2009 The IPython Development Team | |
|
6 | # | |
|
7 | # Distributed under the terms of the BSD License. The full license is in | |
|
8 | # the file COPYING, distributed as part of this software. | |
|
9 | #----------------------------------------------------------------------------- | |
|
10 | ||
|
11 | #----------------------------------------------------------------------------- | |
|
12 | # Imports | |
|
13 | #----------------------------------------------------------------------------- | |
|
14 | ||
|
15 | import unittest | |
|
16 | from compiler.consts import CO_GENERATOR | |
|
17 | ||
|
18 | #----------------------------------------------------------------------------- | |
|
19 | # Classes and functions | |
|
20 | #----------------------------------------------------------------------------- | |
|
21 | ||
|
22 | def isgenerator(func): | |
|
23 | try: | |
|
24 | return func.func_code.co_flags & CO_GENERATOR != 0 | |
|
25 | except AttributeError: | |
|
26 | return False | |
|
27 | ||
|
28 | class ParametricTestCase(unittest.TestCase): | |
|
29 | """Write parametric tests in normal unittest testcase form. | |
|
30 | ||
|
31 | Limitations: the last iteration misses printing out a newline when running | |
|
32 | in verbose mode. | |
|
33 | """ | |
|
34 | def run_parametric(self, result, testMethod): | |
|
35 | # But if we have a test generator, we iterate it ourselves | |
|
36 | testgen = testMethod() | |
|
37 | while True: | |
|
38 | try: | |
|
39 | # Initialize test | |
|
40 | result.startTest(self) | |
|
41 | ||
|
42 | # SetUp | |
|
43 | try: | |
|
44 | self.setUp() | |
|
45 | except KeyboardInterrupt: | |
|
46 | raise | |
|
47 | except: | |
|
48 | result.addError(self, self._exc_info()) | |
|
49 | return | |
|
50 | # Test execution | |
|
51 | ok = False | |
|
52 | try: | |
|
53 | testgen.next() | |
|
54 | ok = True | |
|
55 | except StopIteration: | |
|
56 | # We stop the loop | |
|
57 | break | |
|
58 | except self.failureException: | |
|
59 | result.addFailure(self, self._exc_info()) | |
|
60 | except KeyboardInterrupt: | |
|
61 | raise | |
|
62 | except: | |
|
63 | result.addError(self, self._exc_info()) | |
|
64 | # TearDown | |
|
65 | try: | |
|
66 | self.tearDown() | |
|
67 | except KeyboardInterrupt: | |
|
68 | raise | |
|
69 | except: | |
|
70 | result.addError(self, self._exc_info()) | |
|
71 | ok = False | |
|
72 | if ok: result.addSuccess(self) | |
|
73 | ||
|
74 | finally: | |
|
75 | result.stopTest(self) | |
|
76 | ||
|
77 | def run(self, result=None): | |
|
78 | if result is None: | |
|
79 | result = self.defaultTestResult() | |
|
80 | testMethod = getattr(self, self._testMethodName) | |
|
81 | # For normal tests, we just call the base class and return that | |
|
82 | if isgenerator(testMethod): | |
|
83 | return self.run_parametric(result, testMethod) | |
|
84 | else: | |
|
85 | return super(ParametricTestCase, self).run(result) | |
|
86 | ||
|
87 | ||
|
88 | def parametric(func): | |
|
89 | """Decorator to make a simple function into a normal test via unittest.""" | |
|
90 | ||
|
91 | class Tester(ParametricTestCase): | |
|
92 | test = staticmethod(func) | |
|
93 | ||
|
94 | Tester.__name__ = func.__name__ | |
|
95 | ||
|
96 | return Tester |
@@ -0,0 +1,69 b'' | |||
|
1 | """Implementation of the parametric test support for Python 3.x. | |
|
2 | ||
|
3 | Thanks for the py3 version to Robert Collins, from the Testing in Python | |
|
4 | mailing list. | |
|
5 | """ | |
|
6 | ||
|
7 | #----------------------------------------------------------------------------- | |
|
8 | # Copyright (C) 2009 The IPython Development Team | |
|
9 | # | |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
|
11 | # the file COPYING, distributed as part of this software. | |
|
12 | #----------------------------------------------------------------------------- | |
|
13 | ||
|
14 | #----------------------------------------------------------------------------- | |
|
15 | # Imports | |
|
16 | #----------------------------------------------------------------------------- | |
|
17 | ||
|
18 | import unittest | |
|
19 | from unittest import TestSuite | |
|
20 | ||
|
21 | #----------------------------------------------------------------------------- | |
|
22 | # Classes and functions | |
|
23 | #----------------------------------------------------------------------------- | |
|
24 | ||
|
25 | ||
|
26 | def isgenerator(func): | |
|
27 | return hasattr(func,'_generator') | |
|
28 | ||
|
29 | ||
|
30 | class IterCallableSuite(TestSuite): | |
|
31 | def __init__(self, iterator, adapter): | |
|
32 | self._iter = iterator | |
|
33 | self._adapter = adapter | |
|
34 | def __iter__(self): | |
|
35 | yield self._adapter(self._iter.__next__) | |
|
36 | ||
|
37 | class ParametricTestCase(unittest.TestCase): | |
|
38 | """Write parametric tests in normal unittest testcase form. | |
|
39 | ||
|
40 | Limitations: the last iteration misses printing out a newline when | |
|
41 | running in verbose mode. | |
|
42 | """ | |
|
43 | ||
|
44 | def run(self, result=None): | |
|
45 | testMethod = getattr(self, self._testMethodName) | |
|
46 | # For normal tests, we just call the base class and return that | |
|
47 | if isgenerator(testMethod): | |
|
48 | def adapter(next_test): | |
|
49 | return unittest.FunctionTestCase(next_test, | |
|
50 | self.setUp, | |
|
51 | self.tearDown) | |
|
52 | ||
|
53 | return IterCallableSuite(testMethod(),adapter).run(result) | |
|
54 | else: | |
|
55 | return super(ParametricTestCase, self).run(result) | |
|
56 | ||
|
57 | ||
|
58 | def parametric(func): | |
|
59 | """Decorator to make a simple function into a normal test via | |
|
60 | unittest.""" | |
|
61 | # Hack, until I figure out how to write isgenerator() for python3!! | |
|
62 | func._generator = True | |
|
63 | ||
|
64 | class Tester(ParametricTestCase): | |
|
65 | test = staticmethod(func) | |
|
66 | ||
|
67 | Tester.__name__ = func.__name__ | |
|
68 | ||
|
69 | return Tester |
@@ -0,0 +1,174 b'' | |||
|
1 | """Global IPython app to support test running. | |
|
2 | ||
|
3 | We must start our own ipython object and heavily muck with it so that all the | |
|
4 | modifications IPython makes to system behavior don't send the doctest machinery | |
|
5 | into a fit. This code should be considered a gross hack, but it gets the job | |
|
6 | done. | |
|
7 | """ | |
|
8 | ||
|
9 | from __future__ import absolute_import | |
|
10 | ||
|
11 | #----------------------------------------------------------------------------- | |
|
12 | # Copyright (C) 2009 The IPython Development Team | |
|
13 | # | |
|
14 | # Distributed under the terms of the BSD License. The full license is in | |
|
15 | # the file COPYING, distributed as part of this software. | |
|
16 | #----------------------------------------------------------------------------- | |
|
17 | ||
|
18 | #----------------------------------------------------------------------------- | |
|
19 | # Imports | |
|
20 | #----------------------------------------------------------------------------- | |
|
21 | ||
|
22 | import __builtin__ | |
|
23 | import commands | |
|
24 | import os | |
|
25 | import sys | |
|
26 | ||
|
27 | from . import tools | |
|
28 | ||
|
29 | #----------------------------------------------------------------------------- | |
|
30 | # Functions | |
|
31 | #----------------------------------------------------------------------------- | |
|
32 | ||
|
33 | # Hack to modify the %run command so we can sync the user's namespace with the | |
|
34 | # test globals. Once we move over to a clean magic system, this will be done | |
|
35 | # with much less ugliness. | |
|
36 | ||
|
37 | class py_file_finder(object): | |
|
38 | def __init__(self,test_filename): | |
|
39 | self.test_filename = test_filename | |
|
40 | ||
|
41 | def __call__(self,name): | |
|
42 | from IPython.utils.path import get_py_filename | |
|
43 | try: | |
|
44 | return get_py_filename(name) | |
|
45 | except IOError: | |
|
46 | test_dir = os.path.dirname(self.test_filename) | |
|
47 | new_path = os.path.join(test_dir,name) | |
|
48 | return get_py_filename(new_path) | |
|
49 | ||
|
50 | ||
|
51 | def _run_ns_sync(self,arg_s,runner=None): | |
|
52 | """Modified version of %run that syncs testing namespaces. | |
|
53 | ||
|
54 | This is strictly needed for running doctests that call %run. | |
|
55 | """ | |
|
56 | #print >> sys.stderr, 'in run_ns_sync', arg_s # dbg | |
|
57 | ||
|
58 | _ip = get_ipython() | |
|
59 | finder = py_file_finder(arg_s) | |
|
60 | out = _ip.magic_run_ori(arg_s,runner,finder) | |
|
61 | return out | |
|
62 | ||
|
63 | ||
|
64 | class ipnsdict(dict): | |
|
65 | """A special subclass of dict for use as an IPython namespace in doctests. | |
|
66 | ||
|
67 | This subclass adds a simple checkpointing capability so that when testing | |
|
68 | machinery clears it (we use it as the test execution context), it doesn't | |
|
69 | get completely destroyed. | |
|
70 | """ | |
|
71 | ||
|
72 | def __init__(self,*a): | |
|
73 | dict.__init__(self,*a) | |
|
74 | self._savedict = {} | |
|
75 | ||
|
76 | def clear(self): | |
|
77 | dict.clear(self) | |
|
78 | self.update(self._savedict) | |
|
79 | ||
|
80 | def _checkpoint(self): | |
|
81 | self._savedict.clear() | |
|
82 | self._savedict.update(self) | |
|
83 | ||
|
84 | def update(self,other): | |
|
85 | self._checkpoint() | |
|
86 | dict.update(self,other) | |
|
87 | ||
|
88 | # If '_' is in the namespace, python won't set it when executing code, | |
|
89 | # and we have examples that test it. So we ensure that the namespace | |
|
90 | # is always 'clean' of it before it's used for test code execution. | |
|
91 | self.pop('_',None) | |
|
92 | ||
|
93 | # The builtins namespace must *always* be the real __builtin__ module, | |
|
94 | # else weird stuff happens. The main ipython code does have provisions | |
|
95 | # to ensure this after %run, but since in this class we do some | |
|
96 | # aggressive low-level cleaning of the execution namespace, we need to | |
|
97 | # correct for that ourselves, to ensure consitency with the 'real' | |
|
98 | # ipython. | |
|
99 | self['__builtins__'] = __builtin__ | |
|
100 | ||
|
101 | ||
|
102 | def get_ipython(): | |
|
103 | # This will get replaced by the real thing once we start IPython below | |
|
104 | return start_ipython() | |
|
105 | ||
|
106 | ||
|
107 | def start_ipython(): | |
|
108 | """Start a global IPython shell, which we need for IPython-specific syntax. | |
|
109 | """ | |
|
110 | global get_ipython | |
|
111 | ||
|
112 | # This function should only ever run once! | |
|
113 | if hasattr(start_ipython, 'already_called'): | |
|
114 | return | |
|
115 | start_ipython.already_called = True | |
|
116 | ||
|
117 | # Ok, first time we're called, go ahead | |
|
118 | from IPython.core import iplib | |
|
119 | ||
|
120 | def xsys(cmd): | |
|
121 | """Execute a command and print its output. | |
|
122 | ||
|
123 | This is just a convenience function to replace the IPython system call | |
|
124 | with one that is more doctest-friendly. | |
|
125 | """ | |
|
126 | cmd = _ip.var_expand(cmd,depth=1) | |
|
127 | sys.stdout.write(commands.getoutput(cmd)) | |
|
128 | sys.stdout.flush() | |
|
129 | ||
|
130 | # Store certain global objects that IPython modifies | |
|
131 | _displayhook = sys.displayhook | |
|
132 | _excepthook = sys.excepthook | |
|
133 | _main = sys.modules.get('__main__') | |
|
134 | ||
|
135 | # Create custom argv and namespaces for our IPython to be test-friendly | |
|
136 | config = tools.default_config() | |
|
137 | ||
|
138 | # Create and initialize our test-friendly IPython instance. | |
|
139 | shell = iplib.InteractiveShell( | |
|
140 | parent=None, config=config, | |
|
141 | user_ns=ipnsdict(), user_global_ns={} | |
|
142 | ) | |
|
143 | ||
|
144 | # A few more tweaks needed for playing nicely with doctests... | |
|
145 | ||
|
146 | # These traps are normally only active for interactive use, set them | |
|
147 | # permanently since we'll be mocking interactive sessions. | |
|
148 | shell.builtin_trap.set() | |
|
149 | ||
|
150 | # Set error printing to stdout so nose can doctest exceptions | |
|
151 | shell.InteractiveTB.out_stream = 'stdout' | |
|
152 | ||
|
153 | # Modify the IPython system call with one that uses getoutput, so that we | |
|
154 | # can capture subcommands and print them to Python's stdout, otherwise the | |
|
155 | # doctest machinery would miss them. | |
|
156 | shell.system = xsys | |
|
157 | ||
|
158 | # IPython is ready, now clean up some global state... | |
|
159 | ||
|
160 | # Deactivate the various python system hooks added by ipython for | |
|
161 | # interactive convenience so we don't confuse the doctest system | |
|
162 | sys.modules['__main__'] = _main | |
|
163 | sys.displayhook = _displayhook | |
|
164 | sys.excepthook = _excepthook | |
|
165 | ||
|
166 | # So that ipython magics and aliases can be doctested (they work by making | |
|
167 | # a call into a global _ip object). Also make the top-level get_ipython | |
|
168 | # now return this without recursively calling here again. | |
|
169 | _ip = shell | |
|
170 | get_ipython = _ip.get_ipython | |
|
171 | __builtin__._ip = _ip | |
|
172 | __builtin__.get_ipython = get_ipython | |
|
173 | ||
|
174 | return _ip |
@@ -0,0 +1,188 b'' | |||
|
1 | """Experimental code for cleaner support of IPython syntax with unittest. | |
|
2 | ||
|
3 | In IPython up until 0.10, we've used very hacked up nose machinery for running | |
|
4 | tests with IPython special syntax, and this has proved to be extremely slow. | |
|
5 | This module provides decorators to try a different approach, stemming from a | |
|
6 | conversation Brian and I (FP) had about this problem Sept/09. | |
|
7 | ||
|
8 | The goal is to be able to easily write simple functions that can be seen by | |
|
9 | unittest as tests, and ultimately for these to support doctests with full | |
|
10 | IPython syntax. Nose already offers this based on naming conventions and our | |
|
11 | hackish plugins, but we are seeking to move away from nose dependencies if | |
|
12 | possible. | |
|
13 | ||
|
14 | This module follows a different approach, based on decorators. | |
|
15 | ||
|
16 | - A decorator called @ipdoctest can mark any function as having a docstring | |
|
17 | that should be viewed as a doctest, but after syntax conversion. | |
|
18 | ||
|
19 | Authors | |
|
20 | ------- | |
|
21 | ||
|
22 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
|
23 | """ | |
|
24 | ||
|
25 | from __future__ import absolute_import | |
|
26 | ||
|
27 | #----------------------------------------------------------------------------- | |
|
28 | # Copyright (C) 2009 The IPython Development Team | |
|
29 | # | |
|
30 | # Distributed under the terms of the BSD License. The full license is in | |
|
31 | # the file COPYING, distributed as part of this software. | |
|
32 | #----------------------------------------------------------------------------- | |
|
33 | ||
|
34 | #----------------------------------------------------------------------------- | |
|
35 | # Imports | |
|
36 | #----------------------------------------------------------------------------- | |
|
37 | ||
|
38 | # Stdlib | |
|
39 | import re | |
|
40 | import sys | |
|
41 | import unittest | |
|
42 | from doctest import DocTestFinder, DocTestRunner | |
|
43 | try: | |
|
44 | from doctest import TestResults | |
|
45 | except: | |
|
46 | from ._doctest26 import TestResults | |
|
47 | ||
|
48 | # We already have python3-compliant code for parametric tests | |
|
49 | if sys.version[0]=='2': | |
|
50 | from ._paramtestpy2 import ParametricTestCase | |
|
51 | else: | |
|
52 | from ._paramtestpy3 import ParametricTestCase | |
|
53 | ||
|
54 | #----------------------------------------------------------------------------- | |
|
55 | # Classes and functions | |
|
56 | #----------------------------------------------------------------------------- | |
|
57 | ||
|
58 | def count_failures(runner): | |
|
59 | """Count number of failures in a doctest runner. | |
|
60 | ||
|
61 | Code modeled after the summarize() method in doctest. | |
|
62 | """ | |
|
63 | return [TestResults(f, t) for f, t in runner._name2ft.values() if f > 0 ] | |
|
64 | ||
|
65 | ||
|
66 | class IPython2PythonConverter(object): | |
|
67 | """Convert IPython 'syntax' to valid Python. | |
|
68 | ||
|
69 | Eventually this code may grow to be the full IPython syntax conversion | |
|
70 | implementation, but for now it only does prompt convertion.""" | |
|
71 | ||
|
72 | def __init__(self): | |
|
73 | self.rps1 = re.compile(r'In\ \[\d+\]: ') | |
|
74 | self.rps2 = re.compile(r'\ \ \ \.\.\.+: ') | |
|
75 | self.rout = re.compile(r'Out\[\d+\]: \s*?\n?') | |
|
76 | self.pyps1 = '>>> ' | |
|
77 | self.pyps2 = '... ' | |
|
78 | self.rpyps1 = re.compile ('(\s*%s)(.*)$' % self.pyps1) | |
|
79 | self.rpyps2 = re.compile ('(\s*%s)(.*)$' % self.pyps2) | |
|
80 | ||
|
81 | def __call__(self, ds): | |
|
82 | """Convert IPython prompts to python ones in a string.""" | |
|
83 | from . import globalipapp | |
|
84 | ||
|
85 | pyps1 = '>>> ' | |
|
86 | pyps2 = '... ' | |
|
87 | pyout = '' | |
|
88 | ||
|
89 | dnew = ds | |
|
90 | dnew = self.rps1.sub(pyps1, dnew) | |
|
91 | dnew = self.rps2.sub(pyps2, dnew) | |
|
92 | dnew = self.rout.sub(pyout, dnew) | |
|
93 | ip = globalipapp.get_ipython() | |
|
94 | ||
|
95 | # Convert input IPython source into valid Python. | |
|
96 | out = [] | |
|
97 | newline = out.append | |
|
98 | for line in dnew.splitlines(): | |
|
99 | ||
|
100 | mps1 = self.rpyps1.match(line) | |
|
101 | if mps1 is not None: | |
|
102 | prompt, text = mps1.groups() | |
|
103 | newline(prompt+ip.prefilter(text, False)) | |
|
104 | continue | |
|
105 | ||
|
106 | mps2 = self.rpyps2.match(line) | |
|
107 | if mps2 is not None: | |
|
108 | prompt, text = mps2.groups() | |
|
109 | newline(prompt+ip.prefilter(text, True)) | |
|
110 | continue | |
|
111 | ||
|
112 | newline(line) | |
|
113 | newline('') # ensure a closing newline, needed by doctest | |
|
114 | #print "PYSRC:", '\n'.join(out) # dbg | |
|
115 | return '\n'.join(out) | |
|
116 | ||
|
117 | #return dnew | |
|
118 | ||
|
119 | ||
|
120 | class Doc2UnitTester(object): | |
|
121 | """Class whose instances act as a decorator for docstring testing. | |
|
122 | ||
|
123 | In practice we're only likely to need one instance ever, made below (though | |
|
124 | no attempt is made at turning it into a singleton, there is no need for | |
|
125 | that). | |
|
126 | """ | |
|
127 | def __init__(self, verbose=False): | |
|
128 | """New decorator. | |
|
129 | ||
|
130 | Parameters | |
|
131 | ---------- | |
|
132 | ||
|
133 | verbose : boolean, optional (False) | |
|
134 | Passed to the doctest finder and runner to control verbosity. | |
|
135 | """ | |
|
136 | self.verbose = verbose | |
|
137 | # We can reuse the same finder for all instances | |
|
138 | self.finder = DocTestFinder(verbose=verbose, recurse=False) | |
|
139 | ||
|
140 | def __call__(self, func): | |
|
141 | """Use as a decorator: doctest a function's docstring as a unittest. | |
|
142 | ||
|
143 | This version runs normal doctests, but the idea is to make it later run | |
|
144 | ipython syntax instead.""" | |
|
145 | ||
|
146 | # Capture the enclosing instance with a different name, so the new | |
|
147 | # class below can see it without confusion regarding its own 'self' | |
|
148 | # that will point to the test instance at runtime | |
|
149 | d2u = self | |
|
150 | ||
|
151 | # Rewrite the function's docstring to have python syntax | |
|
152 | if func.__doc__ is not None: | |
|
153 | func.__doc__ = ip2py(func.__doc__) | |
|
154 | ||
|
155 | # Now, create a tester object that is a real unittest instance, so | |
|
156 | # normal unittest machinery (or Nose, or Trial) can find it. | |
|
157 | class Tester(unittest.TestCase): | |
|
158 | def test(self): | |
|
159 | # Make a new runner per function to be tested | |
|
160 | runner = DocTestRunner(verbose=d2u.verbose) | |
|
161 | map(runner.run, d2u.finder.find(func, func.__name__)) | |
|
162 | failed = count_failures(runner) | |
|
163 | if failed: | |
|
164 | # Since we only looked at a single function's docstring, | |
|
165 | # failed should contain at most one item. More than that | |
|
166 | # is a case we can't handle and should error out on | |
|
167 | if len(failed) > 1: | |
|
168 | err = "Invalid number of test results:" % failed | |
|
169 | raise ValueError(err) | |
|
170 | # Report a normal failure. | |
|
171 | self.fail('failed doctests: %s' % str(failed[0])) | |
|
172 | ||
|
173 | # Rename it so test reports have the original signature. | |
|
174 | Tester.__name__ = func.__name__ | |
|
175 | return Tester | |
|
176 | ||
|
177 | ||
|
178 | def ipdocstring(func): | |
|
179 | """Change the function docstring via ip2py. | |
|
180 | """ | |
|
181 | if func.__doc__ is not None: | |
|
182 | func.__doc__ = ip2py(func.__doc__) | |
|
183 | return func | |
|
184 | ||
|
185 | ||
|
186 | # Make an instance of the classes for public use | |
|
187 | ipdoctest = Doc2UnitTester() | |
|
188 | ip2py = IPython2PythonConverter() |
@@ -0,0 +1,68 b'' | |||
|
1 | """Monkeypatch nose to accept any callable as a method. | |
|
2 | ||
|
3 | By default, nose's ismethod() fails for static methods. | |
|
4 | Once this is fixed in upstream nose we can disable it. | |
|
5 | ||
|
6 | Note: merely importing this module causes the monkeypatch to be applied.""" | |
|
7 | ||
|
8 | #----------------------------------------------------------------------------- | |
|
9 | # Copyright (C) 2009 The IPython Development Team | |
|
10 | # | |
|
11 | # Distributed under the terms of the BSD License. The full license is in | |
|
12 | # the file COPYING, distributed as part of this software. | |
|
13 | #----------------------------------------------------------------------------- | |
|
14 | ||
|
15 | #----------------------------------------------------------------------------- | |
|
16 | # Imports | |
|
17 | #----------------------------------------------------------------------------- | |
|
18 | ||
|
19 | import unittest | |
|
20 | import nose.loader | |
|
21 | from inspect import ismethod, isfunction | |
|
22 | ||
|
23 | #----------------------------------------------------------------------------- | |
|
24 | # Classes and functions | |
|
25 | #----------------------------------------------------------------------------- | |
|
26 | ||
|
27 | def getTestCaseNames(self, testCaseClass): | |
|
28 | """Override to select with selector, unless | |
|
29 | config.getTestCaseNamesCompat is True | |
|
30 | """ | |
|
31 | if self.config.getTestCaseNamesCompat: | |
|
32 | return unittest.TestLoader.getTestCaseNames(self, testCaseClass) | |
|
33 | ||
|
34 | def wanted(attr, cls=testCaseClass, sel=self.selector): | |
|
35 | item = getattr(cls, attr, None) | |
|
36 | # MONKEYPATCH: replace this: | |
|
37 | #if not ismethod(item): | |
|
38 | # return False | |
|
39 | # return sel.wantMethod(item) | |
|
40 | # With: | |
|
41 | if ismethod(item): | |
|
42 | return sel.wantMethod(item) | |
|
43 | # static method or something. If this is a static method, we | |
|
44 | # can't get the class information, and we have to treat it | |
|
45 | # as a function. Thus, we will miss things like class | |
|
46 | # attributes for test selection | |
|
47 | if isfunction(item): | |
|
48 | return sel.wantFunction(item) | |
|
49 | return False | |
|
50 | # END MONKEYPATCH | |
|
51 | ||
|
52 | cases = filter(wanted, dir(testCaseClass)) | |
|
53 | for base in testCaseClass.__bases__: | |
|
54 | for case in self.getTestCaseNames(base): | |
|
55 | if case not in cases: | |
|
56 | cases.append(case) | |
|
57 | # add runTest if nothing else picked | |
|
58 | if not cases and hasattr(testCaseClass, 'runTest'): | |
|
59 | cases = ['runTest'] | |
|
60 | if self.sortTestMethodsUsing: | |
|
61 | cases.sort(self.sortTestMethodsUsing) | |
|
62 | return cases | |
|
63 | ||
|
64 | ||
|
65 | ########################################################################## | |
|
66 | # Apply monkeypatch here | |
|
67 | nose.loader.TestLoader.getTestCaseNames = getTestCaseNames | |
|
68 | ########################################################################## |
@@ -0,0 +1,122 b'' | |||
|
1 | """Tests for IPyhton's test support utilities. | |
|
2 | ||
|
3 | These are decorators that allow standalone functions and docstrings to be seen | |
|
4 | as tests by unittest, replicating some of nose's functionality. Additionally, | |
|
5 | IPython-syntax docstrings can be auto-converted to '>>>' so that ipython | |
|
6 | sessions can be copy-pasted as tests. | |
|
7 | ||
|
8 | This file can be run as a script, and it will call unittest.main(). We must | |
|
9 | check that it works with unittest as well as with nose... | |
|
10 | ||
|
11 | ||
|
12 | Notes: | |
|
13 | ||
|
14 | - Using nosetests --with-doctest --doctest-tests testfile.py | |
|
15 | will find docstrings as tests wherever they are, even in methods. But | |
|
16 | if we use ipython syntax in the docstrings, they must be decorated with | |
|
17 | @ipdocstring. This is OK for test-only code, but not for user-facing | |
|
18 | docstrings where we want to keep the ipython syntax. | |
|
19 | ||
|
20 | - Using nosetests --with-doctest file.py | |
|
21 | also finds doctests if the file name doesn't have 'test' in it, because it is | |
|
22 | treated like a normal module. But if nose treats the file like a test file, | |
|
23 | then for normal classes to be doctested the extra --doctest-tests is | |
|
24 | necessary. | |
|
25 | ||
|
26 | - running this script with python (it has a __main__ section at the end) misses | |
|
27 | one docstring test, the one embedded in the Foo object method. Since our | |
|
28 | approach relies on using decorators that create standalone TestCase | |
|
29 | instances, it can only be used for functions, not for methods of objects. | |
|
30 | Authors | |
|
31 | ------- | |
|
32 | ||
|
33 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
|
34 | """ | |
|
35 | ||
|
36 | #----------------------------------------------------------------------------- | |
|
37 | # Copyright (C) 2009 The IPython Development Team | |
|
38 | # | |
|
39 | # Distributed under the terms of the BSD License. The full license is in | |
|
40 | # the file COPYING, distributed as part of this software. | |
|
41 | #----------------------------------------------------------------------------- | |
|
42 | ||
|
43 | ||
|
44 | #----------------------------------------------------------------------------- | |
|
45 | # Imports | |
|
46 | #----------------------------------------------------------------------------- | |
|
47 | ||
|
48 | from IPython.testing.ipunittest import ipdoctest, ipdocstring | |
|
49 | ||
|
50 | #----------------------------------------------------------------------------- | |
|
51 | # Test classes and functions | |
|
52 | #----------------------------------------------------------------------------- | |
|
53 | @ipdoctest | |
|
54 | def simple_dt(): | |
|
55 | """ | |
|
56 | >>> print 1+1 | |
|
57 | 2 | |
|
58 | """ | |
|
59 | ||
|
60 | ||
|
61 | @ipdoctest | |
|
62 | def ipdt_flush(): | |
|
63 | """ | |
|
64 | In [20]: print 1 | |
|
65 | 1 | |
|
66 | ||
|
67 | In [26]: for i in range(10): | |
|
68 | ....: print i, | |
|
69 | ....: | |
|
70 | ....: | |
|
71 | 0 1 2 3 4 5 6 7 8 9 | |
|
72 | ||
|
73 | In [27]: 3+4 | |
|
74 | Out[27]: 7 | |
|
75 | """ | |
|
76 | ||
|
77 | ||
|
78 | @ipdoctest | |
|
79 | def ipdt_indented_test(): | |
|
80 | """ | |
|
81 | In [20]: print 1 | |
|
82 | 1 | |
|
83 | ||
|
84 | In [26]: for i in range(10): | |
|
85 | ....: print i, | |
|
86 | ....: | |
|
87 | ....: | |
|
88 | 0 1 2 3 4 5 6 7 8 9 | |
|
89 | ||
|
90 | In [27]: 3+4 | |
|
91 | Out[27]: 7 | |
|
92 | """ | |
|
93 | ||
|
94 | ||
|
95 | class Foo(object): | |
|
96 | """For methods, the normal decorator doesn't work. | |
|
97 | ||
|
98 | But rewriting the docstring with ip2py does, *but only if using nose | |
|
99 | --with-doctest*. Do we want to have that as a dependency? | |
|
100 | """ | |
|
101 | ||
|
102 | @ipdocstring | |
|
103 | def ipdt_method(self): | |
|
104 | """ | |
|
105 | In [20]: print 1 | |
|
106 | 1 | |
|
107 | ||
|
108 | In [26]: for i in range(10): | |
|
109 | ....: print i, | |
|
110 | ....: | |
|
111 | ....: | |
|
112 | 0 1 2 3 4 5 6 7 8 9 | |
|
113 | ||
|
114 | In [27]: 3+4 | |
|
115 | Out[27]: 7 | |
|
116 | """ | |
|
117 | ||
|
118 | def normaldt_method(self): | |
|
119 | """ | |
|
120 | >>> print 1+1 | |
|
121 | 2 | |
|
122 | """ |
@@ -0,0 +1,167 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """ | |
|
3 | Older utilities that are not being used. | |
|
4 | ||
|
5 | WARNING: IF YOU NEED TO USE ONE OF THESE FUNCTIONS, PLEASE FIRST MOVE IT | |
|
6 | TO ANOTHER APPROPRIATE MODULE IN IPython.utils. | |
|
7 | """ | |
|
8 | ||
|
9 | #----------------------------------------------------------------------------- | |
|
10 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
11 | # | |
|
12 | # Distributed under the terms of the BSD License. The full license is in | |
|
13 | # the file COPYING, distributed as part of this software. | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | ||
|
16 | #----------------------------------------------------------------------------- | |
|
17 | # Imports | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | ||
|
20 | import sys | |
|
21 | import warnings | |
|
22 | ||
|
23 | from IPython.utils.warn import warn | |
|
24 | ||
|
25 | #----------------------------------------------------------------------------- | |
|
26 | # Code | |
|
27 | #----------------------------------------------------------------------------- | |
|
28 | ||
|
29 | ||
|
30 | def mutex_opts(dict,ex_op): | |
|
31 | """Check for presence of mutually exclusive keys in a dict. | |
|
32 | ||
|
33 | Call: mutex_opts(dict,[[op1a,op1b],[op2a,op2b]...]""" | |
|
34 | for op1,op2 in ex_op: | |
|
35 | if op1 in dict and op2 in dict: | |
|
36 | raise ValueError,'\n*** ERROR in Arguments *** '\ | |
|
37 | 'Options '+op1+' and '+op2+' are mutually exclusive.' | |
|
38 | ||
|
39 | ||
|
40 | class EvalDict: | |
|
41 | """ | |
|
42 | Emulate a dict which evaluates its contents in the caller's frame. | |
|
43 | ||
|
44 | Usage: | |
|
45 | >>> number = 19 | |
|
46 | ||
|
47 | >>> text = "python" | |
|
48 | ||
|
49 | >>> print "%(text.capitalize())s %(number/9.0).1f rules!" % EvalDict() | |
|
50 | Python 2.1 rules! | |
|
51 | """ | |
|
52 | ||
|
53 | # This version is due to sismex01@hebmex.com on c.l.py, and is basically a | |
|
54 | # modified (shorter) version of: | |
|
55 | # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/66018 by | |
|
56 | # Skip Montanaro (skip@pobox.com). | |
|
57 | ||
|
58 | def __getitem__(self, name): | |
|
59 | frame = sys._getframe(1) | |
|
60 | return eval(name, frame.f_globals, frame.f_locals) | |
|
61 | ||
|
62 | EvalString = EvalDict # for backwards compatibility | |
|
63 | ||
|
64 | ||
|
65 | def all_belong(candidates,checklist): | |
|
66 | """Check whether a list of items ALL appear in a given list of options. | |
|
67 | ||
|
68 | Returns a single 1 or 0 value.""" | |
|
69 | ||
|
70 | return 1-(0 in [x in checklist for x in candidates]) | |
|
71 | ||
|
72 | ||
|
73 | def belong(candidates,checklist): | |
|
74 | """Check whether a list of items appear in a given list of options. | |
|
75 | ||
|
76 | Returns a list of 1 and 0, one for each candidate given.""" | |
|
77 | ||
|
78 | return [x in checklist for x in candidates] | |
|
79 | ||
|
80 | ||
|
81 | def with_obj(object, **args): | |
|
82 | """Set multiple attributes for an object, similar to Pascal's with. | |
|
83 | ||
|
84 | Example: | |
|
85 | with_obj(jim, | |
|
86 | born = 1960, | |
|
87 | haircolour = 'Brown', | |
|
88 | eyecolour = 'Green') | |
|
89 | ||
|
90 | Credit: Greg Ewing, in | |
|
91 | http://mail.python.org/pipermail/python-list/2001-May/040703.html. | |
|
92 | ||
|
93 | NOTE: up until IPython 0.7.2, this was called simply 'with', but 'with' | |
|
94 | has become a keyword for Python 2.5, so we had to rename it.""" | |
|
95 | ||
|
96 | object.__dict__.update(args) | |
|
97 | ||
|
98 | ||
|
99 | def map_method(method,object_list,*argseq,**kw): | |
|
100 | """map_method(method,object_list,*args,**kw) -> list | |
|
101 | ||
|
102 | Return a list of the results of applying the methods to the items of the | |
|
103 | argument sequence(s). If more than one sequence is given, the method is | |
|
104 | called with an argument list consisting of the corresponding item of each | |
|
105 | sequence. All sequences must be of the same length. | |
|
106 | ||
|
107 | Keyword arguments are passed verbatim to all objects called. | |
|
108 | ||
|
109 | This is Python code, so it's not nearly as fast as the builtin map().""" | |
|
110 | ||
|
111 | out_list = [] | |
|
112 | idx = 0 | |
|
113 | for object in object_list: | |
|
114 | try: | |
|
115 | handler = getattr(object, method) | |
|
116 | except AttributeError: | |
|
117 | out_list.append(None) | |
|
118 | else: | |
|
119 | if argseq: | |
|
120 | args = map(lambda lst:lst[idx],argseq) | |
|
121 | #print 'ob',object,'hand',handler,'ar',args # dbg | |
|
122 | out_list.append(handler(args,**kw)) | |
|
123 | else: | |
|
124 | out_list.append(handler(**kw)) | |
|
125 | idx += 1 | |
|
126 | return out_list | |
|
127 | ||
|
128 | ||
|
129 | def import_fail_info(mod_name,fns=None): | |
|
130 | """Inform load failure for a module.""" | |
|
131 | ||
|
132 | if fns == None: | |
|
133 | warn("Loading of %s failed.\n" % (mod_name,)) | |
|
134 | else: | |
|
135 | warn("Loading of %s from %s failed.\n" % (fns,mod_name)) | |
|
136 | ||
|
137 | ||
|
138 | class NotGiven: pass | |
|
139 | ||
|
140 | def popkey(dct,key,default=NotGiven): | |
|
141 | """Return dct[key] and delete dct[key]. | |
|
142 | ||
|
143 | If default is given, return it if dct[key] doesn't exist, otherwise raise | |
|
144 | KeyError. """ | |
|
145 | ||
|
146 | try: | |
|
147 | val = dct[key] | |
|
148 | except KeyError: | |
|
149 | if default is NotGiven: | |
|
150 | raise | |
|
151 | else: | |
|
152 | return default | |
|
153 | else: | |
|
154 | del dct[key] | |
|
155 | return val | |
|
156 | ||
|
157 | ||
|
158 | def wrap_deprecated(func, suggest = '<nothing>'): | |
|
159 | def newFunc(*args, **kwargs): | |
|
160 | warnings.warn("Call to deprecated function %s, use %s instead" % | |
|
161 | ( func.__name__, suggest), | |
|
162 | category=DeprecationWarning, | |
|
163 | stacklevel = 2) | |
|
164 | return func(*args, **kwargs) | |
|
165 | return newFunc | |
|
166 | ||
|
167 |
@@ -0,0 +1,31 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """ | |
|
3 | See if we have curses. | |
|
4 | """ | |
|
5 | ||
|
6 | #----------------------------------------------------------------------------- | |
|
7 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
8 | # | |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
|
10 | # the file COPYING, distributed as part of this software. | |
|
11 | #----------------------------------------------------------------------------- | |
|
12 | ||
|
13 | #----------------------------------------------------------------------------- | |
|
14 | # Imports | |
|
15 | #----------------------------------------------------------------------------- | |
|
16 | ||
|
17 | #----------------------------------------------------------------------------- | |
|
18 | # Code | |
|
19 | #----------------------------------------------------------------------------- | |
|
20 | ||
|
21 | # Curses and termios are Unix-only modules | |
|
22 | try: | |
|
23 | import curses | |
|
24 | # We need termios as well, so if its import happens to raise, we bail on | |
|
25 | # using curses altogether. | |
|
26 | import termios | |
|
27 | except ImportError: | |
|
28 | use_curses = False | |
|
29 | else: | |
|
30 | # Curses on Solaris may not be complete, so we can't use it there | |
|
31 | use_curses = hasattr(curses,'initscr') No newline at end of file |
@@ -0,0 +1,106 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """Utilities for working with data structures like lists, dicts and tuples. | |
|
3 | """ | |
|
4 | ||
|
5 | #----------------------------------------------------------------------------- | |
|
6 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
7 | # | |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
|
9 | # the file COPYING, distributed as part of this software. | |
|
10 | #----------------------------------------------------------------------------- | |
|
11 | ||
|
12 | #----------------------------------------------------------------------------- | |
|
13 | # Imports | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | ||
|
16 | import types | |
|
17 | ||
|
18 | #----------------------------------------------------------------------------- | |
|
19 | # Code | |
|
20 | #----------------------------------------------------------------------------- | |
|
21 | ||
|
22 | def uniq_stable(elems): | |
|
23 | """uniq_stable(elems) -> list | |
|
24 | ||
|
25 | Return from an iterable, a list of all the unique elements in the input, | |
|
26 | but maintaining the order in which they first appear. | |
|
27 | ||
|
28 | A naive solution to this problem which just makes a dictionary with the | |
|
29 | elements as keys fails to respect the stability condition, since | |
|
30 | dictionaries are unsorted by nature. | |
|
31 | ||
|
32 | Note: All elements in the input must be valid dictionary keys for this | |
|
33 | routine to work, as it internally uses a dictionary for efficiency | |
|
34 | reasons.""" | |
|
35 | ||
|
36 | unique = [] | |
|
37 | unique_dict = {} | |
|
38 | for nn in elems: | |
|
39 | if nn not in unique_dict: | |
|
40 | unique.append(nn) | |
|
41 | unique_dict[nn] = None | |
|
42 | return unique | |
|
43 | ||
|
44 | ||
|
45 | def sort_compare(lst1, lst2, inplace=1): | |
|
46 | """Sort and compare two lists. | |
|
47 | ||
|
48 | By default it does it in place, thus modifying the lists. Use inplace = 0 | |
|
49 | to avoid that (at the cost of temporary copy creation).""" | |
|
50 | if not inplace: | |
|
51 | lst1 = lst1[:] | |
|
52 | lst2 = lst2[:] | |
|
53 | lst1.sort(); lst2.sort() | |
|
54 | return lst1 == lst2 | |
|
55 | ||
|
56 | ||
|
57 | def list2dict(lst): | |
|
58 | """Takes a list of (key,value) pairs and turns it into a dict.""" | |
|
59 | ||
|
60 | dic = {} | |
|
61 | for k,v in lst: dic[k] = v | |
|
62 | return dic | |
|
63 | ||
|
64 | ||
|
65 | def list2dict2(lst, default=''): | |
|
66 | """Takes a list and turns it into a dict. | |
|
67 | Much slower than list2dict, but more versatile. This version can take | |
|
68 | lists with sublists of arbitrary length (including sclars).""" | |
|
69 | ||
|
70 | dic = {} | |
|
71 | for elem in lst: | |
|
72 | if type(elem) in (types.ListType,types.TupleType): | |
|
73 | size = len(elem) | |
|
74 | if size == 0: | |
|
75 | pass | |
|
76 | elif size == 1: | |
|
77 | dic[elem] = default | |
|
78 | else: | |
|
79 | k,v = elem[0], elem[1:] | |
|
80 | if len(v) == 1: v = v[0] | |
|
81 | dic[k] = v | |
|
82 | else: | |
|
83 | dic[elem] = default | |
|
84 | return dic | |
|
85 | ||
|
86 | ||
|
87 | def flatten(seq): | |
|
88 | """Flatten a list of lists (NOT recursive, only works for 2d lists).""" | |
|
89 | ||
|
90 | return [x for subseq in seq for x in subseq] | |
|
91 | ||
|
92 | ||
|
93 | def get_slice(seq, start=0, stop=None, step=1): | |
|
94 | """Get a slice of a sequence with variable step. Specify start,stop,step.""" | |
|
95 | if stop == None: | |
|
96 | stop = len(seq) | |
|
97 | item = lambda i: seq[i] | |
|
98 | return map(item,xrange(start,stop,step)) | |
|
99 | ||
|
100 | ||
|
101 | def chop(seq, size): | |
|
102 | """Chop a sequence into chunks of the given size.""" | |
|
103 | chunk = lambda i: seq[i:i+size] | |
|
104 | return map(chunk,xrange(0,len(seq),size)) | |
|
105 | ||
|
106 |
@@ -0,0 +1,46 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """Decorators that don't go anywhere else. | |
|
3 | ||
|
4 | This module contains misc. decorators that don't really go with another module | |
|
5 | in :mod:`IPython.utils`. Beore putting something here please see if it should | |
|
6 | go into another topical module in :mod:`IPython.utils`. | |
|
7 | """ | |
|
8 | ||
|
9 | #----------------------------------------------------------------------------- | |
|
10 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
11 | # | |
|
12 | # Distributed under the terms of the BSD License. The full license is in | |
|
13 | # the file COPYING, distributed as part of this software. | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | ||
|
16 | #----------------------------------------------------------------------------- | |
|
17 | # Imports | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | ||
|
20 | #----------------------------------------------------------------------------- | |
|
21 | # Code | |
|
22 | #----------------------------------------------------------------------------- | |
|
23 | ||
|
24 | def flag_calls(func): | |
|
25 | """Wrap a function to detect and flag when it gets called. | |
|
26 | ||
|
27 | This is a decorator which takes a function and wraps it in a function with | |
|
28 | a 'called' attribute. wrapper.called is initialized to False. | |
|
29 | ||
|
30 | The wrapper.called attribute is set to False right before each call to the | |
|
31 | wrapped function, so if the call fails it remains False. After the call | |
|
32 | completes, wrapper.called is set to True and the output is returned. | |
|
33 | ||
|
34 | Testing for truth in wrapper.called allows you to determine if a call to | |
|
35 | func() was attempted and succeeded.""" | |
|
36 | ||
|
37 | def wrapper(*args,**kw): | |
|
38 | wrapper.called = False | |
|
39 | out = func(*args,**kw) | |
|
40 | wrapper.called = True | |
|
41 | return out | |
|
42 | ||
|
43 | wrapper.called = False | |
|
44 | wrapper.__doc__ = func.__doc__ | |
|
45 | return wrapper | |
|
46 |
@@ -0,0 +1,82 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """A fancy version of Python's builtin :func:`dir` function. | |
|
3 | """ | |
|
4 | ||
|
5 | #----------------------------------------------------------------------------- | |
|
6 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
7 | # | |
|
8 | # Distributed under the terms of the BSD License. The full license is in | |
|
9 | # the file COPYING, distributed as part of this software. | |
|
10 | #----------------------------------------------------------------------------- | |
|
11 | ||
|
12 | #----------------------------------------------------------------------------- | |
|
13 | # Imports | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | ||
|
16 | #----------------------------------------------------------------------------- | |
|
17 | # Code | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | ||
|
20 | def get_class_members(cls): | |
|
21 | ret = dir(cls) | |
|
22 | if hasattr(cls,'__bases__'): | |
|
23 | for base in cls.__bases__: | |
|
24 | ret.extend(get_class_members(base)) | |
|
25 | return ret | |
|
26 | ||
|
27 | ||
|
28 | def dir2(obj): | |
|
29 | """dir2(obj) -> list of strings | |
|
30 | ||
|
31 | Extended version of the Python builtin dir(), which does a few extra | |
|
32 | checks, and supports common objects with unusual internals that confuse | |
|
33 | dir(), such as Traits and PyCrust. | |
|
34 | ||
|
35 | This version is guaranteed to return only a list of true strings, whereas | |
|
36 | dir() returns anything that objects inject into themselves, even if they | |
|
37 | are later not really valid for attribute access (many extension libraries | |
|
38 | have such bugs). | |
|
39 | """ | |
|
40 | ||
|
41 | # Start building the attribute list via dir(), and then complete it | |
|
42 | # with a few extra special-purpose calls. | |
|
43 | words = dir(obj) | |
|
44 | ||
|
45 | if hasattr(obj,'__class__'): | |
|
46 | words.append('__class__') | |
|
47 | words.extend(get_class_members(obj.__class__)) | |
|
48 | #if '__base__' in words: 1/0 | |
|
49 | ||
|
50 | # Some libraries (such as traits) may introduce duplicates, we want to | |
|
51 | # track and clean this up if it happens | |
|
52 | may_have_dupes = False | |
|
53 | ||
|
54 | # this is the 'dir' function for objects with Enthought's traits | |
|
55 | if hasattr(obj, 'trait_names'): | |
|
56 | try: | |
|
57 | words.extend(obj.trait_names()) | |
|
58 | may_have_dupes = True | |
|
59 | except TypeError: | |
|
60 | # This will happen if `obj` is a class and not an instance. | |
|
61 | pass | |
|
62 | ||
|
63 | # Support for PyCrust-style _getAttributeNames magic method. | |
|
64 | if hasattr(obj, '_getAttributeNames'): | |
|
65 | try: | |
|
66 | words.extend(obj._getAttributeNames()) | |
|
67 | may_have_dupes = True | |
|
68 | except TypeError: | |
|
69 | # `obj` is a class and not an instance. Ignore | |
|
70 | # this error. | |
|
71 | pass | |
|
72 | ||
|
73 | if may_have_dupes: | |
|
74 | # eliminate possible duplicates, as some traits may also | |
|
75 | # appear as normal attributes in the dir() call. | |
|
76 | words = list(set(words)) | |
|
77 | words.sort() | |
|
78 | ||
|
79 | # filter out non-string attributes which may be stuffed by dir() calls | |
|
80 | # and poor coding in third-party modules | |
|
81 | return [w for w in words if isinstance(w, basestring)] | |
|
82 |
@@ -0,0 +1,75 b'' | |||
|
1 | # encoding: utf-8 | |
|
2 | """ | |
|
3 | A utility for handling the reloading of doctest. | |
|
4 | """ | |
|
5 | ||
|
6 | #----------------------------------------------------------------------------- | |
|
7 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
8 | # | |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
|
10 | # the file COPYING, distributed as part of this software. | |
|
11 | #----------------------------------------------------------------------------- | |
|
12 | ||
|
13 | #----------------------------------------------------------------------------- | |
|
14 | # Imports | |
|
15 | #----------------------------------------------------------------------------- | |
|
16 | ||
|
17 | import sys | |
|
18 | ||
|
19 | #----------------------------------------------------------------------------- | |
|
20 | # Code | |
|
21 | #----------------------------------------------------------------------------- | |
|
22 | ||
|
23 | def dhook_wrap(func,*a,**k): | |
|
24 | """Wrap a function call in a sys.displayhook controller. | |
|
25 | ||
|
26 | Returns a wrapper around func which calls func, with all its arguments and | |
|
27 | keywords unmodified, using the default sys.displayhook. Since IPython | |
|
28 | modifies sys.displayhook, it breaks the behavior of certain systems that | |
|
29 | rely on the default behavior, notably doctest. | |
|
30 | """ | |
|
31 | ||
|
32 | def f(*a,**k): | |
|
33 | ||
|
34 | dhook_s = sys.displayhook | |
|
35 | sys.displayhook = sys.__displayhook__ | |
|
36 | try: | |
|
37 | out = func(*a,**k) | |
|
38 | finally: | |
|
39 | sys.displayhook = dhook_s | |
|
40 | ||
|
41 | return out | |
|
42 | ||
|
43 | f.__doc__ = func.__doc__ | |
|
44 | return f | |
|
45 | ||
|
46 | ||
|
47 | def doctest_reload(): | |
|
48 | """Properly reload doctest to reuse it interactively. | |
|
49 | ||
|
50 | This routine: | |
|
51 | ||
|
52 | - imports doctest but does NOT reload it (see below). | |
|
53 | ||
|
54 | - resets its global 'master' attribute to None, so that multiple uses of | |
|
55 | the module interactively don't produce cumulative reports. | |
|
56 | ||
|
57 | - Monkeypatches its core test runner method to protect it from IPython's | |
|
58 | modified displayhook. Doctest expects the default displayhook behavior | |
|
59 | deep down, so our modification breaks it completely. For this reason, a | |
|
60 | hard monkeypatch seems like a reasonable solution rather than asking | |
|
61 | users to manually use a different doctest runner when under IPython. | |
|
62 | ||
|
63 | Notes | |
|
64 | ----- | |
|
65 | ||
|
66 | This function *used to* reload doctest, but this has been disabled because | |
|
67 | reloading doctest unconditionally can cause massive breakage of other | |
|
68 | doctest-dependent modules already in memory, such as those for IPython's | |
|
69 | own testing system. The name wasn't changed to avoid breaking people's | |
|
70 | code, but the reload call isn't actually made anymore.""" | |
|
71 | ||
|
72 | import doctest | |
|
73 | doctest.master = None | |
|
74 | doctest.DocTestRunner.run = dhook_wrap(doctest.DocTestRunner.run) | |
|
75 |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: new file 100644 | |
The requested commit or file is too big and content was truncated. Show full diff |
@@ -16,34 +16,38 b' IPython is a set of tools for interactive and exploratory computing in Python.' | |||
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | # Imports |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | from __future__ import absolute_import | |
|
19 | 20 | |
|
20 | 21 | import os |
|
21 | 22 | import sys |
|
22 | from IPython.core import release | |
|
23 | 23 | |
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | # Setup everything |
|
26 | 26 | #----------------------------------------------------------------------------- |
|
27 | 27 | |
|
28 | ||
|
29 | if sys.version[0:3] < '2.4': | |
|
30 | raise ImportError('Python Version 2.4 or above is required for IPython.') | |
|
28 | if sys.version[0:3] < '2.5': | |
|
29 | raise ImportError('Python Version 2.5 or above is required for IPython.') | |
|
31 | 30 | |
|
32 | 31 | |
|
33 | 32 | # Make it easy to import extensions - they are always directly on pythonpath. |
|
34 | # Therefore, non-IPython modules can be added to extensions directory | |
|
33 | # Therefore, non-IPython modules can be added to extensions directory. | |
|
34 | # This should probably be in ipapp.py. | |
|
35 | 35 | sys.path.append(os.path.join(os.path.dirname(__file__), "extensions")) |
|
36 | 36 | |
|
37 | 37 | #----------------------------------------------------------------------------- |
|
38 | 38 | # Setup the top level names |
|
39 | 39 | #----------------------------------------------------------------------------- |
|
40 | 40 | |
|
41 | # In some cases, these are causing circular imports. | |
|
42 | from IPython.core.iplib import InteractiveShell | |
|
43 | from IPython.core.embed import embed | |
|
44 | from IPython.core.error import TryNext | |
|
41 | from .config.loader import Config | |
|
42 | from .core import release | |
|
43 | from .core.application import Application | |
|
44 | from .core.ipapp import IPythonApp | |
|
45 | from .core.embed import embed | |
|
46 | from .core.error import TryNext | |
|
47 | from .core.iplib import InteractiveShell | |
|
48 | from .testing import test | |
|
45 | 49 | |
|
46 |
from |
|
|
50 | from .lib import ( | |
|
47 | 51 | enable_wx, disable_wx, |
|
48 | 52 | enable_gtk, disable_gtk, |
|
49 | 53 | enable_qt4, disable_qt4, |
@@ -61,4 +65,3 b' for author, email in release.authors.values():' | |||
|
61 | 65 | __license__ = release.license |
|
62 | 66 | __version__ = release.version |
|
63 | 67 | __revision__ = release.revision |
|
64 |
@@ -1,10 +1,10 b'' | |||
|
1 | #!/usr/bin/env python | |
|
2 | # encoding: utf-8 | |
|
1 | # coding: utf-8 | |
|
3 | 2 | """A simple configuration system. |
|
4 | 3 | |
|
5 |
Authors |
|
|
6 | ||
|
4 | Authors | |
|
5 | ------- | |
|
7 | 6 | * Brian Granger |
|
7 | * Fernando Perez | |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | #----------------------------------------------------------------------------- |
@@ -23,7 +23,7 b' import os' | |||
|
23 | 23 | import sys |
|
24 | 24 | |
|
25 | 25 | from IPython.external import argparse |
|
26 |
from IPython.utils. |
|
|
26 | from IPython.utils.path import filefind | |
|
27 | 27 | |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | # Exceptions |
@@ -37,6 +37,25 b' class ConfigError(Exception):' | |||
|
37 | 37 | class ConfigLoaderError(ConfigError): |
|
38 | 38 | pass |
|
39 | 39 | |
|
40 | #----------------------------------------------------------------------------- | |
|
41 | # Argparse fix | |
|
42 | #----------------------------------------------------------------------------- | |
|
43 | ||
|
44 | # Unfortunately argparse by default prints help messages to stderr instead of | |
|
45 | # stdout. This makes it annoying to capture long help screens at the command | |
|
46 | # line, since one must know how to pipe stderr, which many users don't know how | |
|
47 | # to do. So we override the print_help method with one that defaults to | |
|
48 | # stdout and use our class instead. | |
|
49 | ||
|
50 | class ArgumentParser(argparse.ArgumentParser): | |
|
51 | """Simple argparse subclass that prints help to stdout by default.""" | |
|
52 | ||
|
53 | def print_help(self, file=None): | |
|
54 | if file is None: | |
|
55 | file = sys.stdout | |
|
56 | return super(ArgumentParser, self).print_help(file) | |
|
57 | ||
|
58 | print_help.__doc__ = argparse.ArgumentParser.print_help.__doc__ | |
|
40 | 59 | |
|
41 | 60 | #----------------------------------------------------------------------------- |
|
42 | 61 | # Config class for holding config information |
@@ -182,10 +201,13 b' class ConfigLoader(object):' | |||
|
182 | 201 | self.config = Config() |
|
183 | 202 | |
|
184 | 203 | def load_config(self): |
|
185 |
"""Load a config from somewhere, return a |
|
|
204 | """Load a config from somewhere, return a :class:`Config` instance. | |
|
186 | 205 | |
|
187 | 206 | Usually, this will cause self.config to be set and then returned. |
|
207 | However, in most cases, :meth:`ConfigLoader.clear` should be called | |
|
208 | to erase any previous state. | |
|
188 | 209 | """ |
|
210 | self.clear() | |
|
189 | 211 | return self.config |
|
190 | 212 | |
|
191 | 213 | |
@@ -224,6 +246,7 b' class PyFileConfigLoader(FileConfigLoader):' | |||
|
224 | 246 | |
|
225 | 247 | def load_config(self): |
|
226 | 248 | """Load the config from a file and return it as a Struct.""" |
|
249 | self.clear() | |
|
227 | 250 | self._find_file() |
|
228 | 251 | self._read_file_as_dict() |
|
229 | 252 | self._convert_to_config() |
@@ -274,27 +297,48 b' class CommandLineConfigLoader(ConfigLoader):' | |||
|
274 | 297 | """ |
|
275 | 298 | |
|
276 | 299 | |
|
277 | class __NoConfigDefault(object): pass | |
|
278 | NoConfigDefault = __NoConfigDefault() | |
|
300 | class ArgParseConfigLoader(CommandLineConfigLoader): | |
|
279 | 301 | |
|
302 | def __init__(self, argv=None, *parser_args, **parser_kw): | |
|
303 | """Create a config loader for use with argparse. | |
|
280 | 304 |
|
|
281 | class ArgParseConfigLoader(CommandLineConfigLoader): | |
|
305 | Parameters | |
|
306 | ---------- | |
|
282 | 307 | |
|
283 | # arguments = [(('-f','--file'),dict(type=str,dest='file'))] | |
|
284 | arguments = () | |
|
308 | argv : optional, list | |
|
309 | If given, used to read command-line arguments from, otherwise | |
|
310 | sys.argv[1:] is used. | |
|
285 | 311 |
|
|
286 | def __init__(self, *args, **kw): | |
|
287 | """Create a config loader for use with argparse. | |
|
312 | parser_args : tuple | |
|
313 | A tuple of positional arguments that will be passed to the | |
|
314 | constructor of :class:`argparse.ArgumentParser`. | |
|
288 | 315 | |
|
289 | The args and kwargs arguments here are passed onto the constructor | |
|
290 | of :class:`argparse.ArgumentParser`. | |
|
316 | parser_kw : dict | |
|
317 | A tuple of keyword arguments that will be passed to the | |
|
318 | constructor of :class:`argparse.ArgumentParser`. | |
|
291 | 319 | """ |
|
292 | 320 | super(CommandLineConfigLoader, self).__init__() |
|
293 | self.args = args | |
|
294 | self.kw = kw | |
|
321 | if argv == None: | |
|
322 | argv = sys.argv[1:] | |
|
323 | self.argv = argv | |
|
324 | self.parser_args = parser_args | |
|
325 | kwargs = dict(argument_default=argparse.SUPPRESS) | |
|
326 | kwargs.update(parser_kw) | |
|
327 | self.parser_kw = kwargs | |
|
295 | 328 | |
|
296 | 329 | def load_config(self, args=None): |
|
297 |
"""Parse command line arguments and return as a Struct. |
|
|
330 | """Parse command line arguments and return as a Struct. | |
|
331 | ||
|
332 | Parameters | |
|
333 | ---------- | |
|
334 | ||
|
335 | args : optional, list | |
|
336 | If given, a list with the structure of sys.argv[1:] to parse | |
|
337 | arguments from. If not given, the instance's self.argv attribute | |
|
338 | (given at construction time) is used.""" | |
|
339 | self.clear() | |
|
340 | if args is None: | |
|
341 | args = self.argv | |
|
298 | 342 | self._create_parser() |
|
299 | 343 | self._parse_args(args) |
|
300 | 344 | self._convert_to_config() |
@@ -307,30 +351,20 b' class ArgParseConfigLoader(CommandLineConfigLoader):' | |||
|
307 | 351 | return [] |
|
308 | 352 | |
|
309 | 353 | def _create_parser(self): |
|
310 |
self.parser = |
|
|
354 | self.parser = ArgumentParser(*self.parser_args, **self.parser_kw) | |
|
311 | 355 | self._add_arguments() |
|
312 | self._add_other_arguments() | |
|
313 | ||
|
314 | def _add_other_arguments(self): | |
|
315 | pass | |
|
316 | 356 | |
|
317 | 357 | def _add_arguments(self): |
|
318 | for argument in self.arguments: | |
|
319 | if not argument[1].has_key('default'): | |
|
320 | argument[1]['default'] = NoConfigDefault | |
|
321 | self.parser.add_argument(*argument[0],**argument[1]) | |
|
358 | raise NotImplementedError("subclasses must implement _add_arguments") | |
|
322 | 359 | |
|
323 |
def _parse_args(self, args |
|
|
360 | def _parse_args(self, args): | |
|
324 | 361 | """self.parser->self.parsed_data""" |
|
325 | if args is None: | |
|
326 | self.parsed_data, self.extra_args = self.parser.parse_known_args() | |
|
327 | else: | |
|
328 | 362 |
|
|
329 | 363 | |
|
330 | 364 | def _convert_to_config(self): |
|
331 | 365 | """self.parsed_data->self.config""" |
|
332 | 366 | for k, v in vars(self.parsed_data).items(): |
|
333 | if v is not NoConfigDefault: | |
|
334 | 367 |
|
|
335 | 368 |
|
|
336 | 369 | |
|
370 |
@@ -37,17 +37,18 b' from IPython.config.loader import (' | |||
|
37 | 37 | |
|
38 | 38 | |
|
39 | 39 | pyfile = """ |
|
40 | a = 10 | |
|
41 | b = 20 | |
|
42 | Foo.Bar.value = 10 | |
|
43 |
Foo.Ba |
|
|
44 | D.C.value = 'hi there' | |
|
40 | c = get_config() | |
|
41 | c.a = 10 | |
|
42 | c.b = 20 | |
|
43 | c.Foo.Bar.value = 10 | |
|
44 | c.Foo.Bam.value = range(10) | |
|
45 | c.D.C.value = 'hi there' | |
|
45 | 46 | """ |
|
46 | 47 | |
|
47 | 48 | class TestPyFileCL(TestCase): |
|
48 | 49 | |
|
49 | 50 | def test_basic(self): |
|
50 | fd, fname = mkstemp() | |
|
51 | fd, fname = mkstemp('.py') | |
|
51 | 52 | f = os.fdopen(fd, 'w') |
|
52 | 53 | f.write(pyfile) |
|
53 | 54 | f.close() |
@@ -60,37 +61,38 b' class TestPyFileCL(TestCase):' | |||
|
60 | 61 | self.assertEquals(config.Foo.Bam.value, range(10)) |
|
61 | 62 | self.assertEquals(config.D.C.value, 'hi there') |
|
62 | 63 | |
|
64 | class MyLoader1(ArgParseConfigLoader): | |
|
65 | def _add_arguments(self): | |
|
66 | p = self.parser | |
|
67 | p.add_argument('-f', '--foo', dest='Global.foo', type=str) | |
|
68 | p.add_argument('-b', dest='MyClass.bar', type=int) | |
|
69 | p.add_argument('-n', dest='n', action='store_true') | |
|
70 | p.add_argument('Global.bam', type=str) | |
|
71 | ||
|
72 | class MyLoader2(ArgParseConfigLoader): | |
|
73 | def _add_arguments(self): | |
|
74 | subparsers = self.parser.add_subparsers(dest='subparser_name') | |
|
75 | subparser1 = subparsers.add_parser('1') | |
|
76 | subparser1.add_argument('-x',dest='Global.x') | |
|
77 | subparser2 = subparsers.add_parser('2') | |
|
78 | subparser2.add_argument('y') | |
|
63 | 79 | |
|
64 | 80 | class TestArgParseCL(TestCase): |
|
65 | 81 | |
|
66 | 82 | def test_basic(self): |
|
67 | ||
|
68 | class MyLoader(ArgParseConfigLoader): | |
|
69 | arguments = ( | |
|
70 | (('-f','--foo'), dict(dest='Global.foo', type=str)), | |
|
71 | (('-b',), dict(dest='MyClass.bar', type=int)), | |
|
72 | (('-n',), dict(dest='n', action='store_true')), | |
|
73 | (('Global.bam',), dict(type=str)) | |
|
74 | ) | |
|
75 | ||
|
76 | cl = MyLoader() | |
|
83 | cl = MyLoader1() | |
|
77 | 84 | config = cl.load_config('-f hi -b 10 -n wow'.split()) |
|
78 | 85 | self.assertEquals(config.Global.foo, 'hi') |
|
79 | 86 | self.assertEquals(config.MyClass.bar, 10) |
|
80 | 87 | self.assertEquals(config.n, True) |
|
81 | 88 | self.assertEquals(config.Global.bam, 'wow') |
|
89 | config = cl.load_config(['wow']) | |
|
90 | self.assertEquals(config.keys(), ['Global']) | |
|
91 | self.assertEquals(config.Global.keys(), ['bam']) | |
|
92 | self.assertEquals(config.Global.bam, 'wow') | |
|
82 | 93 | |
|
83 | 94 | def test_add_arguments(self): |
|
84 | ||
|
85 | class MyLoader(ArgParseConfigLoader): | |
|
86 | def _add_arguments(self): | |
|
87 | subparsers = self.parser.add_subparsers(dest='subparser_name') | |
|
88 | subparser1 = subparsers.add_parser('1') | |
|
89 | subparser1.add_argument('-x',dest='Global.x') | |
|
90 | subparser2 = subparsers.add_parser('2') | |
|
91 | subparser2.add_argument('y') | |
|
92 | ||
|
93 | cl = MyLoader() | |
|
95 | cl = MyLoader2() | |
|
94 | 96 | config = cl.load_config('2 frobble'.split()) |
|
95 | 97 | self.assertEquals(config.subparser_name, '2') |
|
96 | 98 | self.assertEquals(config.y, 'frobble') |
@@ -98,6 +100,15 b' class TestArgParseCL(TestCase):' | |||
|
98 | 100 | self.assertEquals(config.subparser_name, '1') |
|
99 | 101 | self.assertEquals(config.Global.x, 'frobble') |
|
100 | 102 | |
|
103 | def test_argv(self): | |
|
104 | cl = MyLoader1(argv='-f hi -b 10 -n wow'.split()) | |
|
105 | config = cl.load_config() | |
|
106 | self.assertEquals(config.Global.foo, 'hi') | |
|
107 | self.assertEquals(config.MyClass.bar, 10) | |
|
108 | self.assertEquals(config.n, True) | |
|
109 | self.assertEquals(config.Global.bam, 'wow') | |
|
110 | ||
|
111 | ||
|
101 | 112 | class TestConfig(TestCase): |
|
102 | 113 | |
|
103 | 114 | def test_setget(self): |
@@ -28,9 +28,9 b' import sys' | |||
|
28 | 28 | from IPython.core.component import Component |
|
29 | 29 | from IPython.core.splitinput import split_user_input |
|
30 | 30 | |
|
31 |
from IPython.utils.traitlets import |
|
|
32 | from IPython.utils.genutils import error | |
|
31 | from IPython.utils.traitlets import List | |
|
33 | 32 | from IPython.utils.autoattr import auto_attr |
|
33 | from IPython.utils.warn import warn, error | |
|
34 | 34 | |
|
35 | 35 | #----------------------------------------------------------------------------- |
|
36 | 36 | # Utilities |
@@ -1,4 +1,3 b'' | |||
|
1 | #!/usr/bin/env python | |
|
2 | 1 |
|
|
3 | 2 | """ |
|
4 | 3 | An application for IPython. |
@@ -33,64 +32,103 b' import logging' | |||
|
33 | 32 | import os |
|
34 | 33 | import sys |
|
35 | 34 | |
|
36 | from IPython.core import release | |
|
37 |
from IPython.utils. |
|
|
35 | from IPython.core import release, crashhandler | |
|
36 | from IPython.utils.path import get_ipython_dir, get_ipython_package_dir | |
|
38 | 37 | from IPython.config.loader import ( |
|
39 | 38 | PyFileConfigLoader, |
|
40 | 39 | ArgParseConfigLoader, |
|
41 | 40 | Config, |
|
42 | NoConfigDefault | |
|
43 | 41 | ) |
|
44 | 42 | |
|
45 | 43 | #----------------------------------------------------------------------------- |
|
46 | 44 | # Classes and functions |
|
47 | 45 | #----------------------------------------------------------------------------- |
|
48 | 46 | |
|
47 | class ApplicationError(Exception): | |
|
48 | pass | |
|
49 | ||
|
49 | 50 | |
|
50 |
class BaseApp |
|
|
51 | class BaseAppConfigLoader(ArgParseConfigLoader): | |
|
51 | 52 | """Default command line options for IPython based applications.""" |
|
52 | 53 | |
|
53 |
def _add_ |
|
|
54 | self.parser.add_argument('--ipython-dir', | |
|
54 | def _add_ipython_dir(self, parser): | |
|
55 | """Add the --ipython-dir option to the parser.""" | |
|
56 | paa = parser.add_argument | |
|
57 | paa('--ipython-dir', | |
|
55 | 58 | dest='Global.ipython_dir',type=unicode, |
|
56 | help='Set to override default location of Global.ipython_dir.', | |
|
57 | default=NoConfigDefault, | |
|
59 | help= | |
|
60 | """Set to override default location of the IPython directory | |
|
61 | IPYTHON_DIR, stored as Global.ipython_dir. This can also be | |
|
62 | specified through the environment variable IPYTHON_DIR.""", | |
|
58 | 63 | metavar='Global.ipython_dir') |
|
59 | self.parser.add_argument('-p', '--profile', | |
|
60 | dest='Global.profile',type=unicode, | |
|
61 | help='The string name of the ipython profile to be used.', | |
|
62 | default=NoConfigDefault, | |
|
63 | metavar='Global.profile') | |
|
64 | self.parser.add_argument('--log-level', | |
|
64 | ||
|
65 | def _add_log_level(self, parser): | |
|
66 | """Add the --log-level option to the parser.""" | |
|
67 | paa = parser.add_argument | |
|
68 | paa('--log-level', | |
|
65 | 69 | dest="Global.log_level",type=int, |
|
66 | 70 | help='Set the log level (0,10,20,30,40,50). Default is 30.', |
|
67 | default=NoConfigDefault, | |
|
68 | 71 | metavar='Global.log_level') |
|
69 | self.parser.add_argument('--config-file', | |
|
70 | dest='Global.config_file',type=unicode, | |
|
71 | help='Set the config file name to override default.', | |
|
72 | default=NoConfigDefault, | |
|
73 | metavar='Global.config_file') | |
|
74 | 72 | |
|
75 | ||
|
76 | class ApplicationError(Exception): | |
|
77 | pass | |
|
73 | def _add_arguments(self): | |
|
74 | self._add_ipython_dir(self.parser) | |
|
75 | self._add_log_level(self.parser) | |
|
78 | 76 | |
|
79 | 77 | |
|
80 | 78 | class Application(object): |
|
81 |
"""Load a config, construct components and set them running. |
|
|
79 | """Load a config, construct components and set them running. | |
|
80 | ||
|
81 | The configuration of an application can be done via three different Config | |
|
82 | objects, which are loaded and ultimately merged into a single one used | |
|
83 | from that point on by the app. These are: | |
|
84 | ||
|
85 | 1. default_config: internal defaults, implemented in code. | |
|
86 | 2. file_config: read from the filesystem. | |
|
87 | 3. command_line_config: read from the system's command line flags. | |
|
88 | ||
|
89 | During initialization, 3 is actually read before 2, since at the | |
|
90 | command-line one may override the location of the file to be read. But the | |
|
91 | above is the order in which the merge is made. | |
|
92 | """ | |
|
82 | 93 | |
|
83 | 94 | name = u'ipython' |
|
84 | 95 | description = 'IPython: an enhanced interactive Python shell.' |
|
85 | config_file_name = u'ipython_config.py' | |
|
96 | #: Usage message printed by argparse. If None, auto-generate | |
|
97 | usage = None | |
|
98 | #: The command line config loader. Subclass of ArgParseConfigLoader. | |
|
99 | command_line_loader = BaseAppConfigLoader | |
|
100 | #: The name of the config file to load, determined at runtime | |
|
101 | config_file_name = None | |
|
102 | #: The name of the default config file. Track separately from the actual | |
|
103 | #: name because some logic happens only if we aren't using the default. | |
|
104 | default_config_file_name = u'ipython_config.py' | |
|
86 | 105 | default_log_level = logging.WARN |
|
87 | ||
|
88 | def __init__(self): | |
|
89 | self._exiting = False | |
|
106 | #: Set by --profile option | |
|
107 | profile_name = None | |
|
108 | #: User's ipython directory, typically ~/.ipython/ | |
|
109 | ipython_dir = None | |
|
110 | #: Internal defaults, implemented in code. | |
|
111 | default_config = None | |
|
112 | #: Read from the filesystem. | |
|
113 | file_config = None | |
|
114 | #: Read from the system's command line flags. | |
|
115 | command_line_config = None | |
|
116 | #: The final config that will be passed to the component. | |
|
117 | master_config = None | |
|
118 | #: A reference to the argv to be used (typically ends up being sys.argv[1:]) | |
|
119 | argv = None | |
|
120 | #: extra arguments computed by the command-line loader | |
|
121 | extra_args = None | |
|
122 | #: The class to use as the crash handler. | |
|
123 | crash_handler_class = crashhandler.CrashHandler | |
|
124 | ||
|
125 | # Private attributes | |
|
126 | _exiting = False | |
|
127 | _initialized = False | |
|
128 | ||
|
129 | def __init__(self, argv=None): | |
|
130 | self.argv = sys.argv[1:] if argv is None else argv | |
|
90 | 131 | self.init_logger() |
|
91 | # Track the default and actual separately because some messages are | |
|
92 | # only printed if we aren't using the default. | |
|
93 | self.default_config_file_name = self.config_file_name | |
|
94 | 132 | |
|
95 | 133 | def init_logger(self): |
|
96 | 134 | self.log = logging.getLogger(self.__class__.__name__) |
@@ -109,36 +147,78 b' class Application(object):' | |||
|
109 | 147 | |
|
110 | 148 | log_level = property(_get_log_level, _set_log_level) |
|
111 | 149 | |
|
112 |
def |
|
|
113 |
""" |
|
|
114 | self.attempt(self.create_default_config) | |
|
150 | def initialize(self): | |
|
151 | """Initialize the application. | |
|
152 | ||
|
153 | Loads all configuration information and sets all application state, but | |
|
154 | does not start any relevant processing (typically some kind of event | |
|
155 | loop). | |
|
156 | ||
|
157 | Once this method has been called, the application is flagged as | |
|
158 | initialized and the method becomes a no-op.""" | |
|
159 | ||
|
160 | if self._initialized: | |
|
161 | return | |
|
162 | ||
|
163 | # The first part is protected with an 'attempt' wrapper, that will log | |
|
164 | # failures with the basic system traceback machinery. Once our crash | |
|
165 | # handler is in place, we can let any subsequent exception propagate, | |
|
166 | # as our handler will log it with much better detail than the default. | |
|
167 | self.attempt(self.create_crash_handler) | |
|
168 | ||
|
169 | # Configuration phase | |
|
170 | # Default config (internally hardwired in application code) | |
|
171 | self.create_default_config() | |
|
115 | 172 | self.log_default_config() |
|
116 | 173 | self.set_default_config_log_level() |
|
117 | self.attempt(self.pre_load_command_line_config) | |
|
118 | self.attempt(self.load_command_line_config, action='abort') | |
|
174 | ||
|
175 | # Command-line config | |
|
176 | self.pre_load_command_line_config() | |
|
177 | self.load_command_line_config() | |
|
119 | 178 | self.set_command_line_config_log_level() |
|
120 |
self. |
|
|
179 | self.post_load_command_line_config() | |
|
121 | 180 | self.log_command_line_config() |
|
122 | self.attempt(self.find_ipython_dir) | |
|
123 | self.attempt(self.find_resources) | |
|
124 | self.attempt(self.find_config_file_name) | |
|
125 | self.attempt(self.find_config_file_paths) | |
|
126 | self.attempt(self.pre_load_file_config) | |
|
127 | self.attempt(self.load_file_config) | |
|
181 | ||
|
182 | # Find resources needed for filesystem access, using information from | |
|
183 | # the above two | |
|
184 | self.find_ipython_dir() | |
|
185 | self.find_resources() | |
|
186 | self.find_config_file_name() | |
|
187 | self.find_config_file_paths() | |
|
188 | ||
|
189 | # File-based config | |
|
190 | self.pre_load_file_config() | |
|
191 | self.load_file_config() | |
|
128 | 192 | self.set_file_config_log_level() |
|
129 |
self. |
|
|
193 | self.post_load_file_config() | |
|
130 | 194 | self.log_file_config() |
|
131 | self.attempt(self.merge_configs) | |
|
195 | ||
|
196 | # Merge all config objects into a single one the app can then use | |
|
197 | self.merge_configs() | |
|
132 | 198 | self.log_master_config() |
|
133 | self.attempt(self.pre_construct) | |
|
134 | self.attempt(self.construct) | |
|
135 |
self. |
|
|
136 | self.attempt(self.start_app) | |
|
199 | ||
|
200 | # Construction phase | |
|
201 | self.pre_construct() | |
|
202 | self.construct() | |
|
203 | self.post_construct() | |
|
204 | ||
|
205 | # Done, flag as such and | |
|
206 | self._initialized = True | |
|
207 | ||
|
208 | def start(self): | |
|
209 | """Start the application.""" | |
|
210 | self.initialize() | |
|
211 | self.start_app() | |
|
137 | 212 | |
|
138 | 213 | #------------------------------------------------------------------------- |
|
139 | 214 | # Various stages of Application creation |
|
140 | 215 | #------------------------------------------------------------------------- |
|
141 | 216 | |
|
217 | def create_crash_handler(self): | |
|
218 | """Create a crash handler, typically setting sys.excepthook to it.""" | |
|
219 | self.crash_handler = self.crash_handler_class(self) | |
|
220 | sys.excepthook = self.crash_handler | |
|
221 | ||
|
142 | 222 | def create_default_config(self): |
|
143 | 223 | """Create defaults that can't be set elsewhere. |
|
144 | 224 | |
@@ -148,9 +228,10 b' class Application(object):' | |||
|
148 | 228 | we set them here. The Global section is for variables like this that |
|
149 | 229 | don't belong to a particular component. |
|
150 | 230 | """ |
|
151 |
|
|
|
152 |
|
|
|
153 |
|
|
|
231 | c = Config() | |
|
232 | c.Global.ipython_dir = get_ipython_dir() | |
|
233 | c.Global.log_level = self.log_level | |
|
234 | self.default_config = c | |
|
154 | 235 | |
|
155 | 236 | def log_default_config(self): |
|
156 | 237 | self.log.debug('Default config loaded:') |
@@ -165,9 +246,11 b' class Application(object):' | |||
|
165 | 246 | |
|
166 | 247 | def create_command_line_config(self): |
|
167 | 248 | """Create and return a command line config loader.""" |
|
168 |
return |
|
|
249 | return self.command_line_loader( | |
|
250 | self.argv, | |
|
169 | 251 | description=self.description, |
|
170 | version=release.version | |
|
252 | version=release.version, | |
|
253 | usage=self.usage | |
|
171 | 254 | ) |
|
172 | 255 | |
|
173 | 256 | def pre_load_command_line_config(self): |
@@ -197,10 +280,10 b' class Application(object):' | |||
|
197 | 280 | def find_ipython_dir(self): |
|
198 | 281 | """Set the IPython directory. |
|
199 | 282 | |
|
200 | This sets ``self.ipython_dir``, but the actual value that is passed | |
|
201 |
t |
|
|
283 | This sets ``self.ipython_dir``, but the actual value that is passed to | |
|
284 | the application is kept in either ``self.default_config`` or | |
|
202 | 285 | ``self.command_line_config``. This also adds ``self.ipython_dir`` to |
|
203 |
``sys.path`` so config files there can be reference |
|
|
286 | ``sys.path`` so config files there can be referenced by other config | |
|
204 | 287 | files. |
|
205 | 288 | """ |
|
206 | 289 | |
@@ -230,22 +313,26 b' class Application(object):' | |||
|
230 | 313 | config file are set in :meth:`find_config_file_paths` and then passed |
|
231 | 314 | to the config file loader where they are resolved to an absolute path. |
|
232 | 315 | |
|
233 | If a profile has been set at the command line, this will resolve | |
|
234 | it. | |
|
316 | If a profile has been set at the command line, this will resolve it. | |
|
235 | 317 | """ |
|
236 | ||
|
237 | 318 | try: |
|
238 | 319 | self.config_file_name = self.command_line_config.Global.config_file |
|
239 | 320 | except AttributeError: |
|
240 | 321 | pass |
|
322 | else: | |
|
323 | return | |
|
241 | 324 | |
|
242 | 325 | try: |
|
243 | 326 | self.profile_name = self.command_line_config.Global.profile |
|
244 | name_parts = self.config_file_name.split('.') | |
|
327 | except AttributeError: | |
|
328 | # Just use the default as there is no profile | |
|
329 | self.config_file_name = self.default_config_file_name | |
|
330 | else: | |
|
331 | # Use the default config file name and profile name if set | |
|
332 | # to determine the used config file name. | |
|
333 | name_parts = self.default_config_file_name.split('.') | |
|
245 | 334 | name_parts.insert(1, u'_' + self.profile_name + u'.') |
|
246 | 335 | self.config_file_name = ''.join(name_parts) |
|
247 | except AttributeError: | |
|
248 | pass | |
|
249 | 336 | |
|
250 | 337 | def find_config_file_paths(self): |
|
251 | 338 | """Set the search paths for resolving the config file. |
@@ -253,7 +340,11 b' class Application(object):' | |||
|
253 | 340 | This must set ``self.config_file_paths`` to a sequence of search |
|
254 | 341 | paths to pass to the config file loader. |
|
255 | 342 | """ |
|
256 | self.config_file_paths = (os.getcwd(), self.ipython_dir) | |
|
343 | # Include our own profiles directory last, so that users can still find | |
|
344 | # our shipped copies of builtin profiles even if they don't have them | |
|
345 | # in their local ipython directory. | |
|
346 | prof_dir = os.path.join(get_ipython_package_dir(), 'config', 'profile') | |
|
347 | self.config_file_paths = (os.getcwd(), self.ipython_dir, prof_dir) | |
|
257 | 348 | |
|
258 | 349 | def pre_load_file_config(self): |
|
259 | 350 | """Do actions before the config file is loaded.""" |
@@ -266,7 +357,8 b' class Application(object):' | |||
|
266 | 357 | ``CONFIG_FILE`` config variable is set to the resolved config file |
|
267 | 358 | location. If not successful, an empty config is used. |
|
268 | 359 | """ |
|
269 |
self.log.debug("Attempting to load config file: %s" % |
|
|
360 | self.log.debug("Attempting to load config file: %s" % | |
|
361 | self.config_file_name) | |
|
270 | 362 | loader = PyFileConfigLoader(self.config_file_name, |
|
271 | 363 | path=self.config_file_paths) |
|
272 | 364 | try: |
@@ -275,11 +367,11 b' class Application(object):' | |||
|
275 | 367 | except IOError: |
|
276 | 368 | # Only warn if the default config file was NOT being used. |
|
277 | 369 | if not self.config_file_name==self.default_config_file_name: |
|
278 |
self.log.warn("Config file not found, skipping: %s" % |
|
|
370 | self.log.warn("Config file not found, skipping: %s" % | |
|
279 | 371 | self.config_file_name, exc_info=True) |
|
280 | 372 | self.file_config = Config() |
|
281 | 373 | except: |
|
282 |
self.log.warn("Error loading config file: %s" % |
|
|
374 | self.log.warn("Error loading config file: %s" % | |
|
283 | 375 | self.config_file_name, exc_info=True) |
|
284 | 376 | self.file_config = Config() |
|
285 | 377 | |
@@ -299,7 +391,8 b' class Application(object):' | |||
|
299 | 391 | |
|
300 | 392 | def log_file_config(self): |
|
301 | 393 | if hasattr(self.file_config.Global, 'config_file'): |
|
302 |
self.log.debug("Config file loaded: %s" % |
|
|
394 | self.log.debug("Config file loaded: %s" % | |
|
395 | self.file_config.Global.config_file) | |
|
303 | 396 | self.log.debug(repr(self.file_config)) |
|
304 | 397 | |
|
305 | 398 | def merge_configs(self): |
@@ -308,7 +401,13 b' class Application(object):' | |||
|
308 | 401 | config._merge(self.default_config) |
|
309 | 402 | config._merge(self.file_config) |
|
310 | 403 | config._merge(self.command_line_config) |
|
404 | ||
|
405 | # XXX fperez - propose to Brian we rename master_config to simply | |
|
406 | # config, I think this is going to be heavily used in examples and | |
|
407 | # application code and the name is shorter/easier to find/remember. | |
|
408 | # For now, just alias it... | |
|
311 | 409 | self.master_config = config |
|
410 | self.config = config | |
|
312 | 411 | |
|
313 | 412 | def log_master_config(self): |
|
314 | 413 | self.log.debug("Master config created:") |
@@ -334,15 +433,6 b' class Application(object):' | |||
|
334 | 433 | # Utility methods |
|
335 | 434 | #------------------------------------------------------------------------- |
|
336 | 435 | |
|
337 | def abort(self): | |
|
338 | """Abort the starting of the application.""" | |
|
339 | if self._exiting: | |
|
340 | pass | |
|
341 | else: | |
|
342 | self.log.critical("Aborting application: %s" % self.name, exc_info=True) | |
|
343 | self._exiting = True | |
|
344 | sys.exit(1) | |
|
345 | ||
|
346 | 436 | def exit(self, exit_status=0): |
|
347 | 437 | if self._exiting: |
|
348 | 438 | pass |
@@ -351,14 +441,13 b' class Application(object):' | |||
|
351 | 441 | self._exiting = True |
|
352 | 442 | sys.exit(exit_status) |
|
353 | 443 | |
|
354 |
def attempt(self, func |
|
|
444 | def attempt(self, func): | |
|
355 | 445 | try: |
|
356 | 446 | func() |
|
357 | 447 | except SystemExit: |
|
358 | 448 | raise |
|
359 | 449 | except: |
|
360 | if action == 'abort': | |
|
361 | self.abort() | |
|
362 | elif action == 'exit': | |
|
450 | self.log.critical("Aborting application: %s" % self.name, | |
|
451 | exc_info=True) | |
|
363 | 452 |
|
|
364 | 453 |
|
1 | NO CONTENT: modified file chmod 100644 => 100755 |
@@ -44,7 +44,6 b' its input.' | |||
|
44 | 44 | |
|
45 | 45 | - When the original stdin is not a tty device, GNU readline is never |
|
46 | 46 | used, and this module (and the readline module) are silently inactive. |
|
47 | ||
|
48 | 47 | """ |
|
49 | 48 | |
|
50 | 49 | #***************************************************************************** |
@@ -54,42 +53,82 b' used, and this module (and the readline module) are silently inactive.' | |||
|
54 | 53 | # proper procedure is to maintain its copyright as belonging to the Python |
|
55 | 54 | # Software Foundation (in addition to my own, for all new code). |
|
56 | 55 | # |
|
56 | # Copyright (C) 2008-2010 IPython Development Team | |
|
57 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
|
57 | 58 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
58 | # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu> | |
|
59 | 59 | # |
|
60 | 60 | # Distributed under the terms of the BSD License. The full license is in |
|
61 | 61 | # the file COPYING, distributed as part of this software. |
|
62 | 62 | # |
|
63 | 63 | #***************************************************************************** |
|
64 | 64 | |
|
65 | #----------------------------------------------------------------------------- | |
|
66 | # Imports | |
|
67 | #----------------------------------------------------------------------------- | |
|
68 | ||
|
65 | 69 | import __builtin__ |
|
66 | 70 | import __main__ |
|
67 | 71 | import glob |
|
72 | import inspect | |
|
68 | 73 | import itertools |
|
69 | 74 | import keyword |
|
70 | 75 | import os |
|
71 | 76 | import re |
|
72 | 77 | import shlex |
|
73 | 78 | import sys |
|
74 | import types | |
|
75 | 79 | |
|
76 | 80 | from IPython.core.error import TryNext |
|
77 | 81 | from IPython.core.prefilter import ESC_MAGIC |
|
78 | ||
|
79 | import IPython.utils.rlineimpl as readline | |
|
80 | from IPython.utils.ipstruct import Struct | |
|
81 | 82 | from IPython.utils import generics |
|
83 | from IPython.utils.frame import debugx | |
|
84 | from IPython.utils.dir2 import dir2 | |
|
85 | import IPython.utils.rlineimpl as readline | |
|
82 | 86 | |
|
83 | # Python 2.4 offers sets as a builtin | |
|
84 | try: | |
|
85 | set() | |
|
86 | except NameError: | |
|
87 | from sets import Set as set | |
|
88 | ||
|
89 | from IPython.utils.genutils import debugx, dir2 | |
|
87 | #----------------------------------------------------------------------------- | |
|
88 | # Globals | |
|
89 | #----------------------------------------------------------------------------- | |
|
90 | 90 | |
|
91 | # Public API | |
|
91 | 92 | __all__ = ['Completer','IPCompleter'] |
|
92 | 93 | |
|
94 | if sys.platform == 'win32': | |
|
95 | PROTECTABLES = ' ' | |
|
96 | else: | |
|
97 | PROTECTABLES = ' ()' | |
|
98 | ||
|
99 | #----------------------------------------------------------------------------- | |
|
100 | # Main functions and classes | |
|
101 | #----------------------------------------------------------------------------- | |
|
102 | ||
|
103 | def protect_filename(s): | |
|
104 | """Escape a string to protect certain characters.""" | |
|
105 | ||
|
106 | return "".join([(ch in PROTECTABLES and '\\' + ch or ch) | |
|
107 | for ch in s]) | |
|
108 | ||
|
109 | ||
|
110 | def single_dir_expand(matches): | |
|
111 | "Recursively expand match lists containing a single dir." | |
|
112 | ||
|
113 | if len(matches) == 1 and os.path.isdir(matches[0]): | |
|
114 | # Takes care of links to directories also. Use '/' | |
|
115 | # explicitly, even under Windows, so that name completions | |
|
116 | # don't end up escaped. | |
|
117 | d = matches[0] | |
|
118 | if d[-1] in ['/','\\']: | |
|
119 | d = d[:-1] | |
|
120 | ||
|
121 | subdirs = os.listdir(d) | |
|
122 | if subdirs: | |
|
123 | matches = [ (d + '/' + p) for p in subdirs] | |
|
124 | return single_dir_expand(matches) | |
|
125 | else: | |
|
126 | return matches | |
|
127 | else: | |
|
128 | return matches | |
|
129 | ||
|
130 | class Bunch: pass | |
|
131 | ||
|
93 | 132 | class Completer: |
|
94 | 133 | def __init__(self,namespace=None,global_namespace=None): |
|
95 | 134 | """Create a new completer for the command line. |
@@ -152,6 +191,7 b' class Completer:' | |||
|
152 | 191 | defined in self.namespace or self.global_namespace that match. |
|
153 | 192 | |
|
154 | 193 | """ |
|
194 | #print 'Completer->global_matches, txt=%r' % text # dbg | |
|
155 | 195 | matches = [] |
|
156 | 196 | match_append = matches.append |
|
157 | 197 | n = len(text) |
@@ -177,8 +217,8 b' class Completer:' | |||
|
177 | 217 | with a __getattr__ hook is evaluated. |
|
178 | 218 | |
|
179 | 219 | """ |
|
180 | import re | |
|
181 | 220 | |
|
221 | #print 'Completer->attr_matches, txt=%r' % text # dbg | |
|
182 | 222 | # Another option, seems to work great. Catches things like ''.<tab> |
|
183 | 223 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
184 | 224 | |
@@ -205,6 +245,7 b' class Completer:' | |||
|
205 | 245 | res = ["%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
206 | 246 | return res |
|
207 | 247 | |
|
248 | ||
|
208 | 249 | class IPCompleter(Completer): |
|
209 | 250 | """Extension of the completer class with IPython-specific features""" |
|
210 | 251 | |
@@ -235,7 +276,7 b' class IPCompleter(Completer):' | |||
|
235 | 276 | to complete. """ |
|
236 | 277 | |
|
237 | 278 | Completer.__init__(self,namespace,global_namespace) |
|
238 | self.magic_prefix = shell.name+'.magic_' | |
|
279 | ||
|
239 | 280 | self.magic_escape = ESC_MAGIC |
|
240 | 281 | self.readline = readline |
|
241 | 282 | delims = self.readline.get_completer_delims() |
@@ -245,6 +286,7 b' class IPCompleter(Completer):' | |||
|
245 | 286 | self.get_endidx = self.readline.get_endidx |
|
246 | 287 | self.omit__names = omit__names |
|
247 | 288 |
self.merge_completions = shell.readline_merge_completions |
|
289 | self.shell = shell.shell | |
|
248 | 290 | if alias_table is None: |
|
249 | 291 | alias_table = {} |
|
250 | 292 | self.alias_table = alias_table |
@@ -263,12 +305,14 b' class IPCompleter(Completer):' | |||
|
263 | 305 | self.clean_glob = self._clean_glob_win32 |
|
264 | 306 | else: |
|
265 | 307 | self.clean_glob = self._clean_glob |
|
308 | ||
|
309 | # All active matcher routines for completion | |
|
266 | 310 | self.matchers = [self.python_matches, |
|
267 | 311 | self.file_matches, |
|
312 | self.magic_matches, | |
|
268 | 313 | self.alias_matches, |
|
269 | 314 | self.python_func_kw_matches] |
|
270 | 315 | |
|
271 | ||
|
272 | 316 | # Code contributed by Alex Schmolck, for ipython/emacs integration |
|
273 | 317 | def all_completions(self, text): |
|
274 | 318 | """Return all possible completions for the benefit of emacs.""" |
@@ -278,9 +322,8 b' class IPCompleter(Completer):' | |||
|
278 | 322 | try: |
|
279 | 323 | for i in xrange(sys.maxint): |
|
280 | 324 | res = self.complete(text, i) |
|
281 | ||
|
282 |
|
|
|
283 | ||
|
325 | if not res: | |
|
326 | break | |
|
284 | 327 | comp_append(res) |
|
285 | 328 | #XXX workaround for ``notDefined.<tab>`` |
|
286 | 329 | except NameError: |
@@ -316,41 +359,12 b' class IPCompleter(Completer):' | |||
|
316 | 359 | # don't want to treat as delimiters in filename matching |
|
317 | 360 | # when escaped with backslash |
|
318 | 361 | |
|
319 | if sys.platform == 'win32': | |
|
320 | protectables = ' ' | |
|
321 | else: | |
|
322 | protectables = ' ()' | |
|
323 | ||
|
324 | 362 | if text.startswith('!'): |
|
325 | 363 | text = text[1:] |
|
326 | 364 | text_prefix = '!' |
|
327 | 365 | else: |
|
328 | 366 | text_prefix = '' |
|
329 | 367 | |
|
330 | def protect_filename(s): | |
|
331 | return "".join([(ch in protectables and '\\' + ch or ch) | |
|
332 | for ch in s]) | |
|
333 | ||
|
334 | def single_dir_expand(matches): | |
|
335 | "Recursively expand match lists containing a single dir." | |
|
336 | ||
|
337 | if len(matches) == 1 and os.path.isdir(matches[0]): | |
|
338 | # Takes care of links to directories also. Use '/' | |
|
339 | # explicitly, even under Windows, so that name completions | |
|
340 | # don't end up escaped. | |
|
341 | d = matches[0] | |
|
342 | if d[-1] in ['/','\\']: | |
|
343 | d = d[:-1] | |
|
344 | ||
|
345 | subdirs = os.listdir(d) | |
|
346 | if subdirs: | |
|
347 | matches = [ (d + '/' + p) for p in subdirs] | |
|
348 | return single_dir_expand(matches) | |
|
349 | else: | |
|
350 | return matches | |
|
351 | else: | |
|
352 | return matches | |
|
353 | ||
|
354 | 368 | lbuf = self.lbuf |
|
355 | 369 | open_quotes = 0 # track strings with open quotes |
|
356 | 370 | try: |
@@ -402,13 +416,24 b' class IPCompleter(Completer):' | |||
|
402 | 416 | #print 'mm',matches # dbg |
|
403 | 417 | return single_dir_expand(matches) |
|
404 | 418 | |
|
419 | def magic_matches(self, text): | |
|
420 | """Match magics""" | |
|
421 | #print 'Completer->magic_matches:',text,'lb',self.lbuf # dbg | |
|
422 | # Get all shell magics now rather than statically, so magics loaded at | |
|
423 | # runtime show up too | |
|
424 | magics = self.shell.lsmagic() | |
|
425 | pre = self.magic_escape | |
|
426 | baretext = text.lstrip(pre) | |
|
427 | return [ pre+m for m in magics if m.startswith(baretext)] | |
|
428 | ||
|
405 | 429 | def alias_matches(self, text): |
|
406 | 430 | """Match internal system aliases""" |
|
407 | 431 | #print 'Completer->alias_matches:',text,'lb',self.lbuf # dbg |
|
408 | 432 | |
|
409 | 433 | # if we are not in the first 'item', alias matching |
|
410 | 434 | # doesn't make sense - unless we are starting with 'sudo' command. |
|
411 |
if ' ' in self.lbuf.lstrip() and |
|
|
435 | if ' ' in self.lbuf.lstrip() and \ | |
|
436 | not self.lbuf.lstrip().startswith('sudo'): | |
|
412 | 437 | return [] |
|
413 | 438 | text = os.path.expanduser(text) |
|
414 | 439 | aliases = self.alias_table.keys() |
@@ -420,7 +445,7 b' class IPCompleter(Completer):' | |||
|
420 | 445 | def python_matches(self,text): |
|
421 | 446 | """Match attributes or global python names""" |
|
422 | 447 | |
|
423 |
#print 'Completer->python_matches, txt= |
|
|
448 | #print 'Completer->python_matches, txt=%r' % text # dbg | |
|
424 | 449 | if "." in text: |
|
425 | 450 | try: |
|
426 | 451 | matches = self.attr_matches(text) |
@@ -439,11 +464,7 b' class IPCompleter(Completer):' | |||
|
439 | 464 | matches = [] |
|
440 | 465 | else: |
|
441 | 466 | matches = self.global_matches(text) |
|
442 | # this is so completion finds magics when automagic is on: | |
|
443 | if (matches == [] and | |
|
444 | not text.startswith(os.sep) and | |
|
445 | not ' ' in self.lbuf): | |
|
446 | matches = self.attr_matches(self.magic_prefix+text) | |
|
467 | ||
|
447 | 468 | return matches |
|
448 | 469 | |
|
449 | 470 | def _default_arguments(self, obj): |
@@ -514,9 +535,11 b' class IPCompleter(Completer):' | |||
|
514 | 535 | callableMatches = self.attr_matches('.'.join(ids[::-1])) |
|
515 | 536 | argMatches = [] |
|
516 | 537 | for callableMatch in callableMatches: |
|
517 | try: namedArgs = self._default_arguments(eval(callableMatch, | |
|
538 | try: | |
|
539 | namedArgs = self._default_arguments(eval(callableMatch, | |
|
518 | 540 | self.namespace)) |
|
519 |
except: |
|
|
541 | except: | |
|
542 | continue | |
|
520 | 543 | for namedArg in namedArgs: |
|
521 | 544 | if namedArg.startswith(text): |
|
522 | 545 | argMatches.append("%s=" %namedArg) |
@@ -528,7 +551,7 b' class IPCompleter(Completer):' | |||
|
528 | 551 | if not line.strip(): |
|
529 | 552 | return None |
|
530 | 553 | |
|
531 |
event = |
|
|
554 | event = Bunch() | |
|
532 | 555 | event.line = line |
|
533 | 556 | event.symbol = text |
|
534 | 557 | cmd = line.split(None,1)[0] |
@@ -542,9 +565,7 b' class IPCompleter(Completer):' | |||
|
542 | 565 | else: |
|
543 | 566 | try_magic = [] |
|
544 | 567 | |
|
545 | ||
|
546 | for c in itertools.chain( | |
|
547 | self.custom_completers.s_matches(cmd), | |
|
568 | for c in itertools.chain(self.custom_completers.s_matches(cmd), | |
|
548 | 569 | try_magic, |
|
549 | 570 | self.custom_completers.flat_matches(self.lbuf)): |
|
550 | 571 | #print "try",c # dbg |
@@ -555,7 +576,8 b' class IPCompleter(Completer):' | |||
|
555 | 576 | if withcase: |
|
556 | 577 | return withcase |
|
557 | 578 | # if none, then case insensitive ones are ok too |
|
558 | return [r for r in res if r.lower().startswith(text.lower())] | |
|
579 | text_low = text.lower() | |
|
580 | return [r for r in res if r.lower().startswith(text_low)] | |
|
559 | 581 | except TryNext: |
|
560 | 582 | pass |
|
561 | 583 | |
@@ -598,14 +620,11 b' class IPCompleter(Completer):' | |||
|
598 | 620 | return None |
|
599 | 621 | |
|
600 | 622 | magic_escape = self.magic_escape |
|
601 | magic_prefix = self.magic_prefix | |
|
602 | 623 | |
|
603 | 624 | self.lbuf = self.full_lbuf[:self.get_endidx()] |
|
604 | 625 | |
|
605 | 626 | try: |
|
606 |
if text.startswith( |
|
|
607 | text = text.replace(magic_escape,magic_prefix) | |
|
608 | elif text.startswith('~'): | |
|
627 | if text.startswith('~'): | |
|
609 | 628 | text = os.path.expanduser(text) |
|
610 | 629 | if state == 0: |
|
611 | 630 | custom_res = self.dispatch_custom_completer(text) |
@@ -625,13 +644,10 b' class IPCompleter(Completer):' | |||
|
625 | 644 | self.matches = matcher(text) |
|
626 | 645 | if self.matches: |
|
627 | 646 | break |
|
628 | def uniq(alist): | |
|
629 | set = {} | |
|
630 | return [set.setdefault(e,e) for e in alist if e not in set] | |
|
631 | self.matches = uniq(self.matches) | |
|
647 | self.matches = list(set(self.matches)) | |
|
632 | 648 | try: |
|
633 | ret = self.matches[state].replace(magic_prefix,magic_escape) | |
|
634 |
return |
|
|
649 | #print "MATCH: %r" % self.matches[state] # dbg | |
|
650 | return self.matches[state] | |
|
635 | 651 | except IndexError: |
|
636 | 652 | return None |
|
637 | 653 | except: |
@@ -27,7 +27,7 b' from weakref import WeakValueDictionary' | |||
|
27 | 27 | from IPython.utils.importstring import import_item |
|
28 | 28 | from IPython.config.loader import Config |
|
29 | 29 | from IPython.utils.traitlets import ( |
|
30 |
HasTraitlets |
|
|
30 | HasTraitlets, MetaHasTraitlets, Instance, This | |
|
31 | 31 | ) |
|
32 | 32 | |
|
33 | 33 |
@@ -1,73 +1,94 b'' | |||
|
1 |
# |
|
|
1 | # encoding: utf-8 | |
|
2 | 2 | """sys.excepthook for IPython itself, leaves a detailed report on disk. |
|
3 | 3 | |
|
4 | Authors: | |
|
4 | 5 | |
|
5 | Authors | |
|
6 | ------- | |
|
7 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
|
6 | * Fernando Perez | |
|
7 | * Brian E. Granger | |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | #***************************************************************************** | |
|
11 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
10 | #----------------------------------------------------------------------------- | |
|
12 | 11 |
# |
|
12 | # Copyright (C) 2008-2010 The IPython Development Team | |
|
13 | 13 | # |
|
14 | 14 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | 15 | # the file COPYING, distributed as part of this software. |
|
16 | #***************************************************************************** | |
|
16 | #----------------------------------------------------------------------------- | |
|
17 | 17 | |
|
18 | #**************************************************************************** | |
|
19 | # Required modules | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | # Imports | |
|
20 | #----------------------------------------------------------------------------- | |
|
20 | 21 | |
|
21 | # From the standard library | |
|
22 | 22 | import os |
|
23 | 23 | import sys |
|
24 | 24 | from pprint import pformat |
|
25 | 25 | |
|
26 | # Our own | |
|
27 | from IPython.core import release | |
|
28 | 26 | from IPython.core import ultratb |
|
29 | 27 | from IPython.external.Itpl import itpl |
|
28 | from IPython.utils.sysinfo import sys_info | |
|
30 | 29 | |
|
31 | from IPython.utils.genutils import * | |
|
30 | #----------------------------------------------------------------------------- | |
|
31 | # Code | |
|
32 | #----------------------------------------------------------------------------- | |
|
32 | 33 | |
|
33 | #**************************************************************************** | |
|
34 | class CrashHandler: | |
|
35 | """Customizable crash handlers for IPython-based systems. | |
|
34 | # Template for the user message. | |
|
35 | _default_message_template = """\ | |
|
36 | Oops, $self.app_name crashed. We do our best to make it stable, but... | |
|
36 | 37 | |
|
37 | Instances of this class provide a __call__ method which can be used as a | |
|
38 | sys.excepthook, i.e., the __call__ signature is: | |
|
38 | A crash report was automatically generated with the following information: | |
|
39 | - A verbatim copy of the crash traceback. | |
|
40 | - A copy of your input history during this session. | |
|
41 | - Data on your current $self.app_name configuration. | |
|
39 | 42 | |
|
40 | def __call__(self,etype, evalue, etb) | |
|
43 | It was left in the file named: | |
|
44 | \t'$self.crash_report_fname' | |
|
45 | If you can email this file to the developers, the information in it will help | |
|
46 | them in understanding and correcting the problem. | |
|
47 | ||
|
48 | You can mail it to: $self.contact_name at $self.contact_email | |
|
49 | with the subject '$self.app_name Crash Report'. | |
|
50 | ||
|
51 | If you want to do it now, the following command will work (under Unix): | |
|
52 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname | |
|
41 | 53 | |
|
54 | To ensure accurate tracking of this issue, please file a report about it at: | |
|
55 | $self.bug_tracker | |
|
42 | 56 |
|
|
43 | 57 | |
|
44 | def __init__(self,IP,app_name,contact_name,contact_email, | |
|
45 | bug_tracker,crash_report_fname, | |
|
46 | show_crash_traceback=True): | |
|
47 | """New crash handler. | |
|
48 | 58 | |
|
49 | Inputs: | |
|
59 | class CrashHandler(object): | |
|
60 | """Customizable crash handlers for IPython applications. | |
|
50 | 61 | |
|
51 | - IP: a running IPython instance, which will be queried at crash time | |
|
52 | for internal information. | |
|
62 | Instances of this class provide a :meth:`__call__` method which can be | |
|
63 | used as a ``sys.excepthook``. The :meth:`__call__` signature is:: | |
|
53 | 64 | |
|
54 | - app_name: a string containing the name of your application. | |
|
65 | def __call__(self, etype, evalue, etb) | |
|
66 | """ | |
|
55 | 67 | |
|
56 | - contact_name: a string with the name of the person to contact. | |
|
68 | message_template = _default_message_template | |
|
57 | 69 | |
|
58 | - contact_email: a string with the email address of the contact. | |
|
70 | def __init__(self, app, contact_name=None, contact_email=None, | |
|
71 | bug_tracker=None, show_crash_traceback=True, call_pdb=False): | |
|
72 | """Create a new crash handler | |
|
59 | 73 | |
|
60 | - bug_tracker: a string with the URL for your project's bug tracker. | |
|
74 | Parameters | |
|
75 | ---------- | |
|
76 | app : Application | |
|
77 | A running :class:`Application` instance, which will be queried at | |
|
78 | crash time for internal information. | |
|
61 | 79 | |
|
62 | - crash_report_fname: a string with the filename for the crash report | |
|
63 | to be saved in. These reports are left in the ipython user directory | |
|
64 | as determined by the running IPython instance. | |
|
80 | contact_name : str | |
|
81 | A string with the name of the person to contact. | |
|
65 | 82 | |
|
66 | Optional inputs: | |
|
83 | contact_email : str | |
|
84 | A string with the email address of the contact. | |
|
67 | 85 | |
|
68 | - show_crash_traceback(True): if false, don't print the crash | |
|
69 | traceback on stderr, only generate the on-disk report | |
|
86 | bug_tracker : str | |
|
87 | A string with the URL for your project's bug tracker. | |
|
70 | 88 | |
|
89 | show_crash_traceback : bool | |
|
90 | If false, don't print the crash traceback on stderr, only generate | |
|
91 | the on-disk report | |
|
71 | 92 | |
|
72 | 93 | Non-argument instance attributes: |
|
73 | 94 | |
@@ -75,44 +96,16 b' class CrashHandler:' | |||
|
75 | 96 |
further customization of the crash handler's behavior. |
|
76 | 97 | source for further details. |
|
77 | 98 | """ |
|
78 | ||
|
79 | # apply args into instance | |
|
80 | self.IP = IP # IPython instance | |
|
81 | self.app_name = app_name | |
|
99 | self.app = app | |
|
100 | self.app_name = self.app.name | |
|
82 | 101 | self.contact_name = contact_name |
|
83 | 102 | self.contact_email = contact_email |
|
84 | 103 | self.bug_tracker = bug_tracker |
|
85 |
self.crash_report_fname = |
|
|
104 | self.crash_report_fname = "Crash_report_%s.txt" % self.app_name | |
|
86 | 105 | self.show_crash_traceback = show_crash_traceback |
|
87 | ||
|
88 | # Hardcoded defaults, which can be overridden either by subclasses or | |
|
89 | # at runtime for the instance. | |
|
90 | ||
|
91 | # Template for the user message. Subclasses which completely override | |
|
92 | # this, or user apps, can modify it to suit their tastes. It gets | |
|
93 | # expanded using itpl, so calls of the kind $self.foo are valid. | |
|
94 | self.user_message_template = """ | |
|
95 | Oops, $self.app_name crashed. We do our best to make it stable, but... | |
|
96 | ||
|
97 | A crash report was automatically generated with the following information: | |
|
98 | - A verbatim copy of the crash traceback. | |
|
99 | - A copy of your input history during this session. | |
|
100 | - Data on your current $self.app_name configuration. | |
|
101 | ||
|
102 | It was left in the file named: | |
|
103 | \t'$self.crash_report_fname' | |
|
104 | If you can email this file to the developers, the information in it will help | |
|
105 | them in understanding and correcting the problem. | |
|
106 | ||
|
107 | You can mail it to: $self.contact_name at $self.contact_email | |
|
108 | with the subject '$self.app_name Crash Report'. | |
|
109 | ||
|
110 | If you want to do it now, the following command will work (under Unix): | |
|
111 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname | |
|
112 | ||
|
113 | To ensure accurate tracking of this issue, please file a report about it at: | |
|
114 | $self.bug_tracker | |
|
115 | """ | |
|
106 | self.section_sep = '\n\n'+'*'*75+'\n\n' | |
|
107 | self.call_pdb = call_pdb | |
|
108 | #self.call_pdb = True # dbg | |
|
116 | 109 | |
|
117 | 110 | def __call__(self,etype, evalue, etb): |
|
118 | 111 | """Handle an exception, call for compatible with sys.excepthook""" |
@@ -124,7 +117,7 b' $self.bug_tracker' | |||
|
124 | 117 | #color_scheme = 'Linux' # dbg |
|
125 | 118 | |
|
126 | 119 | try: |
|
127 |
rptdir = self. |
|
|
120 | rptdir = self.app.ipython_dir | |
|
128 | 121 | except: |
|
129 | 122 | rptdir = os.getcwd() |
|
130 | 123 | if not os.path.isdir(rptdir): |
@@ -133,8 +126,15 b' $self.bug_tracker' | |||
|
133 | 126 | # write the report filename into the instance dict so it can get |
|
134 | 127 | # properly expanded out in the user message template |
|
135 | 128 | self.crash_report_fname = report_name |
|
136 |
TBhandler = ultratb.VerboseTB( |
|
|
137 | long_header=1) | |
|
129 | TBhandler = ultratb.VerboseTB( | |
|
130 | color_scheme=color_scheme, | |
|
131 | long_header=1, | |
|
132 | call_pdb=self.call_pdb, | |
|
133 | ) | |
|
134 | if self.call_pdb: | |
|
135 | TBhandler(etype,evalue,etb) | |
|
136 | return | |
|
137 | else: | |
|
138 | 138 | traceback = TBhandler.text(etype,evalue,etb,context=31) |
|
139 | 139 | |
|
140 | 140 | # print traceback to screen |
@@ -149,81 +149,32 b' $self.bug_tracker' | |||
|
149 | 149 | return |
|
150 | 150 | |
|
151 | 151 | # Inform user on stderr of what happened |
|
152 |
msg = itpl('\n'+'*'*70+'\n'+self. |
|
|
152 | msg = itpl('\n'+'*'*70+'\n'+self.message_template) | |
|
153 | 153 | print >> sys.stderr, msg |
|
154 | 154 | |
|
155 | 155 | # Construct report on disk |
|
156 | 156 | report.write(self.make_report(traceback)) |
|
157 | 157 | report.close() |
|
158 | raw_input("Press enter to exit:") | |
|
158 | raw_input("Hit <Enter> to quit this message (your terminal may close):") | |
|
159 | 159 | |
|
160 | 160 | def make_report(self,traceback): |
|
161 | 161 | """Return a string containing a crash report.""" |
|
162 | 162 | |
|
163 | sec_sep = '\n\n'+'*'*75+'\n\n' | |
|
163 | sec_sep = self.section_sep | |
|
164 | 164 | |
|
165 | report = [] | |
|
165 | report = ['*'*75+'\n\n'+'IPython post-mortem report\n\n'] | |
|
166 | 166 | rpt_add = report.append |
|
167 | rpt_add(sys_info()) | |
|
167 | 168 | |
|
168 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') | |
|
169 | rpt_add('IPython version: %s \n\n' % release.version) | |
|
170 | rpt_add('BZR revision : %s \n\n' % release.revision) | |
|
171 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % | |
|
172 | (os.name,sys.platform) ) | |
|
173 | rpt_add(sec_sep+'Current user configuration structure:\n\n') | |
|
174 | rpt_add(pformat(self.IP.dict())) | |
|
175 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) | |
|
176 | 169 | try: |
|
177 | rpt_add(sec_sep+"History of session input:") | |
|
178 | for line in self.IP.user_ns['_ih']: | |
|
179 | rpt_add(line) | |
|
180 | rpt_add('\n*** Last line of input (may not be in above history):\n') | |
|
181 | rpt_add(self.IP._last_input_line+'\n') | |
|
170 | config = pformat(self.app.config) | |
|
171 | rpt_add(sec_sep) | |
|
172 | rpt_add('Application name: %s\n\n' % self.app_name) | |
|
173 | rpt_add('Current user configuration structure:\n\n') | |
|
174 | rpt_add(config) | |
|
182 | 175 | except: |
|
183 | 176 | pass |
|
184 | ||
|
185 | return ''.join(report) | |
|
186 | ||
|
187 | class IPythonCrashHandler(CrashHandler): | |
|
188 | """sys.excepthook for IPython itself, leaves a detailed report on disk.""" | |
|
189 | ||
|
190 | def __init__(self,IP): | |
|
191 | ||
|
192 | # Set here which of the IPython authors should be listed as contact | |
|
193 | AUTHOR_CONTACT = 'Fernando' | |
|
194 | ||
|
195 | # Set argument defaults | |
|
196 | app_name = 'IPython' | |
|
197 | bug_tracker = 'https://bugs.launchpad.net/ipython/+filebug' | |
|
198 | contact_name,contact_email = release.authors[AUTHOR_CONTACT][:2] | |
|
199 | crash_report_fname = 'IPython_crash_report.txt' | |
|
200 | # Call parent constructor | |
|
201 | CrashHandler.__init__(self,IP,app_name,contact_name,contact_email, | |
|
202 | bug_tracker,crash_report_fname) | |
|
203 | ||
|
204 | def make_report(self,traceback): | |
|
205 | """Return a string containing a crash report.""" | |
|
206 | ||
|
207 | sec_sep = '\n\n'+'*'*75+'\n\n' | |
|
208 | ||
|
209 | report = [] | |
|
210 | rpt_add = report.append | |
|
211 | ||
|
212 | rpt_add('*'*75+'\n\n'+'IPython post-mortem report\n\n') | |
|
213 | rpt_add('IPython version: %s \n\n' % release.version) | |
|
214 | rpt_add('BZR revision : %s \n\n' % release.revision) | |
|
215 | rpt_add('Platform info : os.name -> %s, sys.platform -> %s' % | |
|
216 | (os.name,sys.platform) ) | |
|
217 | rpt_add(sec_sep+'Current user configuration structure:\n\n') | |
|
218 | # rpt_add(pformat(self.IP.dict())) | |
|
219 | 177 | rpt_add(sec_sep+'Crash traceback:\n\n' + traceback) |
|
220 | try: | |
|
221 | rpt_add(sec_sep+"History of session input:") | |
|
222 | for line in self.IP.user_ns['_ih']: | |
|
223 | rpt_add(line) | |
|
224 | rpt_add('\n*** Last line of input (may not be in above history):\n') | |
|
225 | rpt_add(self.IP._last_input_line+'\n') | |
|
226 | except: | |
|
227 | pass | |
|
228 | 178 | |
|
229 | 179 | return ''.join(report) |
|
180 |
@@ -26,15 +26,13 b' http://www.python.org/2.2.3/license.html"""' | |||
|
26 | 26 | #***************************************************************************** |
|
27 | 27 | |
|
28 | 28 | import bdb |
|
29 | import cmd | |
|
30 | 29 | import linecache |
|
31 | import os | |
|
32 | 30 | import sys |
|
33 | 31 | |
|
34 | 32 | from IPython.utils import PyColorize |
|
35 | 33 | from IPython.core import ipapi |
|
36 | 34 | from IPython.utils import coloransi |
|
37 |
from IPython.utils. |
|
|
35 | from IPython.utils.io import Term | |
|
38 | 36 | from IPython.core.excolors import exception_colors |
|
39 | 37 | |
|
40 | 38 | # See if we can use pydb. |
@@ -477,3 +475,36 b' class Pdb(OldPdb):' | |||
|
477 | 475 | namespaces = [('Locals', self.curframe.f_locals), |
|
478 | 476 | ('Globals', self.curframe.f_globals)] |
|
479 | 477 | self.shell.magic_pinfo("pinfo %s" % arg, namespaces=namespaces) |
|
478 | ||
|
479 | def checkline(self, filename, lineno): | |
|
480 | """Check whether specified line seems to be executable. | |
|
481 | ||
|
482 | Return `lineno` if it is, 0 if not (e.g. a docstring, comment, blank | |
|
483 | line or EOF). Warning: testing is not comprehensive. | |
|
484 | """ | |
|
485 | ####################################################################### | |
|
486 | # XXX Hack! Use python-2.5 compatible code for this call, because with | |
|
487 | # all of our changes, we've drifted from the pdb api in 2.6. For now, | |
|
488 | # changing: | |
|
489 | # | |
|
490 | #line = linecache.getline(filename, lineno, self.curframe.f_globals) | |
|
491 | # to: | |
|
492 | # | |
|
493 | line = linecache.getline(filename, lineno) | |
|
494 | # | |
|
495 | # does the trick. But in reality, we need to fix this by reconciling | |
|
496 | # our updates with the new Pdb APIs in Python 2.6. | |
|
497 | # | |
|
498 | # End hack. The rest of this method is copied verbatim from 2.6 pdb.py | |
|
499 | ####################################################################### | |
|
500 | ||
|
501 | if not line: | |
|
502 | print >>self.stdout, 'End of file' | |
|
503 | return 0 | |
|
504 | line = line.strip() | |
|
505 | # Don't allow setting breakpoint at a blank line | |
|
506 | if (not line or (line[0] == '#') or | |
|
507 | (line[:3] == '"""') or line[:3] == "'''"): | |
|
508 | print >>self.stdout, '*** Blank or comment' | |
|
509 | return 0 | |
|
510 | return lineno |
@@ -24,8 +24,6 b' import sys' | |||
|
24 | 24 | |
|
25 | 25 | from IPython.core.component import Component |
|
26 | 26 | |
|
27 | from IPython.utils.autoattr import auto_attr | |
|
28 | ||
|
29 | 27 | #----------------------------------------------------------------------------- |
|
30 | 28 | # Classes and functions |
|
31 | 29 | #----------------------------------------------------------------------------- |
@@ -24,6 +24,7 b' Notes' | |||
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | |
|
26 | 26 | from __future__ import with_statement |
|
27 | import __main__ | |
|
27 | 28 | |
|
28 | 29 | import sys |
|
29 | 30 | from contextlib import nested |
@@ -33,7 +34,7 b' from IPython.core.iplib import InteractiveShell' | |||
|
33 | 34 | from IPython.core.ipapp import load_default_config |
|
34 | 35 | |
|
35 | 36 | from IPython.utils.traitlets import Bool, Str, CBool |
|
36 |
from IPython.utils. |
|
|
37 | from IPython.utils.io import ask_yes_no | |
|
37 | 38 | |
|
38 | 39 | |
|
39 | 40 | #----------------------------------------------------------------------------- |
@@ -10,8 +10,6 b' Color schemes for exception handling code in IPython.' | |||
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #***************************************************************************** |
|
12 | 12 | |
|
13 | #**************************************************************************** | |
|
14 | # Required modules | |
|
15 | 13 | from IPython.utils.coloransi import ColorSchemeTable, TermColors, ColorScheme |
|
16 | 14 | |
|
17 | 15 | def exception_colors(): |
@@ -5,7 +5,8 b'' | |||
|
5 | 5 | import fnmatch |
|
6 | 6 | import os |
|
7 | 7 | |
|
8 |
from IPython.utils. |
|
|
8 | from IPython.utils.io import Term, ask_yes_no | |
|
9 | from IPython.utils.warn import warn | |
|
9 | 10 | from IPython.core import ipapi |
|
10 | 11 | |
|
11 | 12 | def magic_history(self, parameter_s = ''): |
@@ -15,19 +16,24 b" def magic_history(self, parameter_s = ''):" | |||
|
15 | 16 | %history n -> print at most n inputs\\ |
|
16 | 17 | %history n1 n2 -> print inputs between n1 and n2 (n2 not included)\\ |
|
17 | 18 | |
|
18 | Each input's number <n> is shown, and is accessible as the | |
|
19 | automatically generated variable _i<n>. Multi-line statements are | |
|
20 | printed starting at a new line for easy copy/paste. | |
|
19 | By default, input history is printed without line numbers so it can be | |
|
20 | directly pasted into an editor. | |
|
21 | 21 | |
|
22 | With -n, each input's number <n> is shown, and is accessible as the | |
|
23 | automatically generated variable _i<n> as well as In[<n>]. Multi-line | |
|
24 | statements are printed starting at a new line for easy copy/paste. | |
|
22 | 25 | |
|
23 | 26 | Options: |
|
24 | 27 | |
|
25 | -n: do NOT print line numbers. This is useful if you want to get a | |
|
26 | printout of many lines which can be directly pasted into a text | |
|
27 | editor. | |
|
28 | ||
|
28 | -n: print line numbers for each input. | |
|
29 | 29 | This feature is only available if numbered prompts are in use. |
|
30 | 30 | |
|
31 | -o: also print outputs for each input. | |
|
32 | ||
|
33 | -p: print classic '>>>' python prompts before each input. This is useful | |
|
34 | for making documentation, and in conjunction with -o, for producing | |
|
35 | doctest-ready output. | |
|
36 | ||
|
31 | 37 | -t: (default) print the 'translated' history, as IPython understands it. |
|
32 | 38 | IPython filters your input and converts it all into valid Python source |
|
33 | 39 | before executing it (things like magics or aliases are turned into |
@@ -50,7 +56,7 b" def magic_history(self, parameter_s = ''):" | |||
|
50 | 56 | if not self.outputcache.do_full_cache: |
|
51 | 57 | print 'This feature is only available if numbered prompts are in use.' |
|
52 | 58 | return |
|
53 | opts,args = self.parse_options(parameter_s,'gntsrf:',mode='list') | |
|
59 | opts,args = self.parse_options(parameter_s,'gnoptsrf:',mode='list') | |
|
54 | 60 | |
|
55 | 61 | # Check if output to specific file was requested. |
|
56 | 62 | try: |
@@ -86,7 +92,7 b" def magic_history(self, parameter_s = ''):" | |||
|
86 | 92 | head, pattern = parts |
|
87 | 93 | pattern = "*" + pattern + "*" |
|
88 | 94 | elif len(args) == 0: |
|
89 | final = len(input_hist) | |
|
95 | final = len(input_hist)-1 | |
|
90 | 96 | init = max(1,final-default_length) |
|
91 | 97 | elif len(args) == 1: |
|
92 | 98 | final = len(input_hist) |
@@ -95,24 +101,28 b" def magic_history(self, parameter_s = ''):" | |||
|
95 | 101 | init,final = map(int,args) |
|
96 | 102 | else: |
|
97 | 103 | warn('%hist takes 0, 1 or 2 arguments separated by spaces.') |
|
98 | print self.magic_hist.__doc__ | |
|
104 | print >> Term.cout, self.magic_hist.__doc__ | |
|
99 | 105 | return |
|
106 | ||
|
100 | 107 | width = len(str(final)) |
|
101 | 108 | line_sep = ['','\n'] |
|
102 |
print_nums = |
|
|
109 | print_nums = 'n' in opts | |
|
110 | print_outputs = 'o' in opts | |
|
111 | pyprompts = 'p' in opts | |
|
103 | 112 | |
|
104 | 113 | found = False |
|
105 | 114 | if pattern is not None: |
|
106 | 115 | sh = self.shadowhist.all() |
|
107 | 116 | for idx, s in sh: |
|
108 | 117 | if fnmatch.fnmatch(s, pattern): |
|
109 | print "0%d: %s" %(idx, s) | |
|
118 | print >> outfile, "0%d: %s" %(idx, s) | |
|
110 | 119 | found = True |
|
111 | 120 | |
|
112 | 121 | if found: |
|
113 | print "===" | |
|
114 | print "shadow history ends, fetch by %rep <number> (must start with 0)" | |
|
115 | print "=== start of normal history ===" | |
|
122 | print >> outfile, "===" | |
|
123 | print >> outfile, \ | |
|
124 | "shadow history ends, fetch by %rep <number> (must start with 0)" | |
|
125 | print >> outfile, "=== start of normal history ===" | |
|
116 | 126 | |
|
117 | 127 | for in_num in range(init,final): |
|
118 | 128 | inline = input_hist[in_num] |
@@ -123,7 +133,20 b" def magic_history(self, parameter_s = ''):" | |||
|
123 | 133 | if print_nums: |
|
124 | 134 | print >> outfile, \ |
|
125 | 135 | '%s:%s' % (str(in_num).ljust(width),line_sep[multiline]), |
|
136 | if pyprompts: | |
|
137 | print >> outfile, '>>>', | |
|
138 | if multiline: | |
|
139 | lines = inline.splitlines() | |
|
140 | print >> outfile, '\n... '.join(lines) | |
|
141 | print >> outfile, '... ' | |
|
142 | else: | |
|
126 | 143 | print >> outfile, inline, |
|
144 | else: | |
|
145 | print >> outfile, inline, | |
|
146 | if print_outputs: | |
|
147 | output = self.shell.user_ns['Out'].get(in_num) | |
|
148 | if output is not None: | |
|
149 | print >> outfile, repr(output) | |
|
127 | 150 | |
|
128 | 151 | if close_at_end: |
|
129 | 152 | outfile.close() |
@@ -245,10 +268,10 b' class ShadowHist(object):' | |||
|
245 | 268 | |
|
246 | 269 | |
|
247 | 270 | def init_ipython(ip): |
|
248 | import ipy_completers | |
|
249 | ||
|
250 | 271 | ip.define_magic("rep",rep_f) |
|
251 | 272 | ip.define_magic("hist",magic_hist) |
|
252 | 273 | ip.define_magic("history",magic_history) |
|
253 | 274 | |
|
254 | ipy_completers.quick_completer('%hist' ,'-g -t -r -n') | |
|
275 | # XXX - ipy_completers are in quarantine, need to be updated to new apis | |
|
276 | #import ipy_completers | |
|
277 | #ipy_completers.quick_completer('%hist' ,'-g -t -r -n') |
@@ -43,9 +43,12 b' somewhere in your configuration files or ipython command line.' | |||
|
43 | 43 | |
|
44 | 44 | import os, bisect |
|
45 | 45 | import sys |
|
46 | from IPython.utils.genutils import Term, shell | |
|
46 | ||
|
47 | 47 | from pprint import PrettyPrinter |
|
48 | 48 | |
|
49 | from IPython.utils.io import Term | |
|
50 | from IPython.utils.process import shell | |
|
51 | ||
|
49 | 52 | from IPython.core.error import TryNext |
|
50 | 53 | |
|
51 | 54 | # List here all the default hooks. For now it's just the editor functions |
@@ -137,8 +140,7 b' class CommandChainDispatcher:' | |||
|
137 | 140 | for prio,cmd in self.chain: |
|
138 | 141 | #print "prio",prio,"cmd",cmd #dbg |
|
139 | 142 | try: |
|
140 |
ret |
|
|
141 | return ret | |
|
143 | return cmd(*args, **kw) | |
|
142 | 144 | except TryNext, exc: |
|
143 | 145 | if exc.args or exc.kwargs: |
|
144 | 146 | args = exc.args |
@@ -18,8 +18,6 b' has been made into a component, this module will be sent to deathrow.' | |||
|
18 | 18 | # Imports |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | from IPython.core.error import TryNext, UsageError, IPythonCoreError | |
|
22 | ||
|
23 | 21 | #----------------------------------------------------------------------------- |
|
24 | 22 | # Classes and functions |
|
25 | 23 | #----------------------------------------------------------------------------- |
This diff has been collapsed as it changes many lines, (619 lines changed) Show them Hide them | |||
@@ -4,17 +4,15 b'' | |||
|
4 | 4 | The :class:`~IPython.core.application.Application` object for the command |
|
5 | 5 | line :command:`ipython` program. |
|
6 | 6 | |
|
7 |
Authors |
|
|
7 | Authors | |
|
8 | ------- | |
|
8 | 9 | |
|
9 | 10 | * Brian Granger |
|
10 | 11 | * Fernando Perez |
|
11 | ||
|
12 | Notes | |
|
13 | ----- | |
|
14 | 12 | """ |
|
15 | 13 | |
|
16 | 14 | #----------------------------------------------------------------------------- |
|
17 |
# Copyright (C) 2008-200 |
|
|
15 | # Copyright (C) 2008-2010 The IPython Development Team | |
|
18 | 16 | # |
|
19 | 17 | # Distributed under the terms of the BSD License. The full license is in |
|
20 | 18 | # the file COPYING, distributed as part of this software. |
@@ -24,317 +22,406 b' Notes' | |||
|
24 | 22 | # Imports |
|
25 | 23 | #----------------------------------------------------------------------------- |
|
26 | 24 | |
|
25 | from __future__ import absolute_import | |
|
26 | ||
|
27 | 27 | import logging |
|
28 | 28 | import os |
|
29 | 29 | import sys |
|
30 | import warnings | |
|
31 | 30 | |
|
32 | from IPython.core.application import Application, BaseAppArgParseConfigLoader | |
|
33 | 31 | from IPython.core import release |
|
32 | from IPython.core.crashhandler import CrashHandler | |
|
33 | from IPython.core.application import Application, BaseAppConfigLoader | |
|
34 | 34 | from IPython.core.iplib import InteractiveShell |
|
35 | 35 | from IPython.config.loader import ( |
|
36 | NoConfigDefault, | |
|
37 | 36 | Config, |
|
38 | 37 | PyFileConfigLoader |
|
39 | 38 | ) |
|
40 | ||
|
41 | 39 | from IPython.lib import inputhook |
|
42 | ||
|
43 | from IPython.utils.genutils import filefind, get_ipython_dir | |
|
40 | from IPython.utils.path import filefind, get_ipython_dir | |
|
41 | from . import usage | |
|
44 | 42 | |
|
45 | 43 | #----------------------------------------------------------------------------- |
|
46 |
# |
|
|
44 | # Globals, utilities and helpers | |
|
47 | 45 | #----------------------------------------------------------------------------- |
|
48 | 46 | |
|
49 | ||
|
50 | ipython_desc = """ | |
|
51 | A Python shell with automatic history (input and output), dynamic object | |
|
52 | introspection, easier configuration, command completion, access to the system | |
|
53 | shell and more. | |
|
54 | """ | |
|
55 | ||
|
56 | def pylab_warning(): | |
|
57 | msg = """ | |
|
58 | ||
|
59 | IPython's -pylab mode has been disabled until matplotlib supports this version | |
|
60 | of IPython. This version of IPython has greatly improved GUI integration that | |
|
61 | matplotlib will soon be able to take advantage of. This will eventually | |
|
62 | result in greater stability and a richer API for matplotlib under IPython. | |
|
63 | However during this transition, you will either need to use an older version | |
|
64 | of IPython, or do the following to use matplotlib interactively:: | |
|
65 | ||
|
66 | import matplotlib | |
|
67 | matplotlib.interactive(True) | |
|
68 | matplotlib.use('wxagg') # adjust for your backend | |
|
69 | %gui -a wx # adjust for your GUI | |
|
70 | from matplotlib import pyplot as plt | |
|
71 | ||
|
72 | See the %gui magic for information on the new interface. | |
|
73 | """ | |
|
74 | warnings.warn(msg, category=DeprecationWarning, stacklevel=1) | |
|
47 | #: The default config file name for this application. | |
|
48 | default_config_file_name = u'ipython_config.py' | |
|
75 | 49 | |
|
76 | 50 | |
|
77 | #----------------------------------------------------------------------------- | |
|
78 | # Main classes and functions | |
|
79 | #----------------------------------------------------------------------------- | |
|
80 | ||
|
81 | cl_args = ( | |
|
82 | (('--autocall',), dict( | |
|
83 | type=int, dest='InteractiveShell.autocall', default=NoConfigDefault, | |
|
84 | help='Set the autocall value (0,1,2).', | |
|
51 | class IPAppConfigLoader(BaseAppConfigLoader): | |
|
52 | ||
|
53 | def _add_arguments(self): | |
|
54 | super(IPAppConfigLoader, self)._add_arguments() | |
|
55 | paa = self.parser.add_argument | |
|
56 | paa('-p', | |
|
57 | '--profile', dest='Global.profile', type=unicode, | |
|
58 | help= | |
|
59 | """The string name of the ipython profile to be used. Assume that your | |
|
60 | config file is ipython_config-<name>.py (looks in current dir first, | |
|
61 | then in IPYTHON_DIR). This is a quick way to keep and load multiple | |
|
62 | config files for different tasks, especially if include your basic one | |
|
63 | in your more specialized ones. You can keep a basic | |
|
64 | IPYTHON_DIR/ipython_config.py file and then have other 'profiles' which | |
|
65 | include this one and load extra things for particular tasks.""", | |
|
66 | metavar='Global.profile') | |
|
67 | paa('--config-file', | |
|
68 | dest='Global.config_file', type=unicode, | |
|
69 | help= | |
|
70 | """Set the config file name to override default. Normally IPython | |
|
71 | loads ipython_config.py (from current directory) or | |
|
72 | IPYTHON_DIR/ipython_config.py. If the loading of your config file | |
|
73 | fails, IPython starts with a bare bones configuration (no modules | |
|
74 | loaded at all).""", | |
|
75 | metavar='Global.config_file') | |
|
76 | paa('--autocall', | |
|
77 | dest='InteractiveShell.autocall', type=int, | |
|
78 | help= | |
|
79 | """Make IPython automatically call any callable object even if you | |
|
80 | didn't type explicit parentheses. For example, 'str 43' becomes | |
|
81 | 'str(43)' automatically. The value can be '0' to disable the feature, | |
|
82 | '1' for 'smart' autocall, where it is not applied if there are no more | |
|
83 | arguments on the line, and '2' for 'full' autocall, where all callable | |
|
84 | objects are automatically called (even if no arguments are present). | |
|
85 | The default is '1'.""", | |
|
85 | 86 | metavar='InteractiveShell.autocall') |
|
86 | ), | |
|
87 | (('--autoindent',), dict( | |
|
88 | action='store_true', dest='InteractiveShell.autoindent', default=NoConfigDefault, | |
|
87 | paa('--autoindent', | |
|
88 | action='store_true', dest='InteractiveShell.autoindent', | |
|
89 | 89 | help='Turn on autoindenting.') |
|
90 | ), | |
|
91 | (('--no-autoindent',), dict( | |
|
92 | action='store_false', dest='InteractiveShell.autoindent', default=NoConfigDefault, | |
|
90 | paa('--no-autoindent', | |
|
91 | action='store_false', dest='InteractiveShell.autoindent', | |
|
93 | 92 | help='Turn off autoindenting.') |
|
94 | ), | |
|
95 | (('--automagic',), dict( | |
|
96 | action='store_true', dest='InteractiveShell.automagic', default=NoConfigDefault, | |
|
97 |
|
|
|
98 | ), | |
|
99 |
|
|
|
100 |
action='store_false', dest='InteractiveShell.automagic', |
|
|
93 | paa('--automagic', | |
|
94 | action='store_true', dest='InteractiveShell.automagic', | |
|
95 | help= | |
|
96 | """Turn on the auto calling of magic commands. Type %%magic at the | |
|
97 | IPython prompt for more information.""") | |
|
98 | paa('--no-automagic', | |
|
99 | action='store_false', dest='InteractiveShell.automagic', | |
|
101 | 100 | help='Turn off the auto calling of magic commands.') |
|
102 | ), | |
|
103 | (('--autoedit-syntax',), dict( | |
|
104 | action='store_true', dest='InteractiveShell.autoedit_syntax', default=NoConfigDefault, | |
|
101 | paa('--autoedit-syntax', | |
|
102 | action='store_true', dest='InteractiveShell.autoedit_syntax', | |
|
105 | 103 | help='Turn on auto editing of files with syntax errors.') |
|
106 | ), | |
|
107 | (('--no-autoedit-syntax',), dict( | |
|
108 | action='store_false', dest='InteractiveShell.autoedit_syntax', default=NoConfigDefault, | |
|
104 | paa('--no-autoedit-syntax', | |
|
105 | action='store_false', dest='InteractiveShell.autoedit_syntax', | |
|
109 | 106 | help='Turn off auto editing of files with syntax errors.') |
|
110 | ), | |
|
111 | (('--banner',), dict( | |
|
112 | action='store_true', dest='Global.display_banner', default=NoConfigDefault, | |
|
107 | paa('--banner', | |
|
108 | action='store_true', dest='Global.display_banner', | |
|
113 | 109 | help='Display a banner upon starting IPython.') |
|
114 | ), | |
|
115 | (('--no-banner',), dict( | |
|
116 | action='store_false', dest='Global.display_banner', default=NoConfigDefault, | |
|
110 | paa('--no-banner', | |
|
111 | action='store_false', dest='Global.display_banner', | |
|
117 | 112 | help="Don't display a banner upon starting IPython.") |
|
118 | ), | |
|
119 | (('--cache-size',), dict( | |
|
120 | type=int, dest='InteractiveShell.cache_size', default=NoConfigDefault, | |
|
121 |
|
|
|
113 | paa('--cache-size', | |
|
114 | type=int, dest='InteractiveShell.cache_size', | |
|
115 | help= | |
|
116 | """Set the size of the output cache. The default is 1000, you can | |
|
117 | change it permanently in your config file. Setting it to 0 completely | |
|
118 | disables the caching system, and the minimum value accepted is 20 (if | |
|
119 | you provide a value less than 20, it is reset to 0 and a warning is | |
|
120 | issued). This limit is defined because otherwise you'll spend more | |
|
121 | time re-flushing a too small cache than working""", | |
|
122 | 122 | metavar='InteractiveShell.cache_size') |
|
123 | ), | |
|
124 | (('--classic',), dict( | |
|
125 | action='store_true', dest='Global.classic', default=NoConfigDefault, | |
|
123 | paa('--classic', | |
|
124 | action='store_true', dest='Global.classic', | |
|
126 | 125 | help="Gives IPython a similar feel to the classic Python prompt.") |
|
127 | ), | |
|
128 | (('--colors',), dict( | |
|
129 | type=str, dest='InteractiveShell.colors', default=NoConfigDefault, | |
|
126 | paa('--colors', | |
|
127 | type=str, dest='InteractiveShell.colors', | |
|
130 | 128 | help="Set the color scheme (NoColor, Linux, and LightBG).", |
|
131 | 129 | metavar='InteractiveShell.colors') |
|
132 | ), | |
|
133 | (('--color-info',), dict( | |
|
134 | action='store_true', dest='InteractiveShell.color_info', default=NoConfigDefault, | |
|
135 | help="Enable using colors for info related things.") | |
|
136 | ), | |
|
137 | (('--no-color-info',), dict( | |
|
138 | action='store_false', dest='InteractiveShell.color_info', default=NoConfigDefault, | |
|
130 | paa('--color-info', | |
|
131 | action='store_true', dest='InteractiveShell.color_info', | |
|
132 | help= | |
|
133 | """IPython can display information about objects via a set of func- | |
|
134 | tions, and optionally can use colors for this, syntax highlighting | |
|
135 | source code and various other elements. However, because this | |
|
136 | information is passed through a pager (like 'less') and many pagers get | |
|
137 | confused with color codes, this option is off by default. You can test | |
|
138 | it and turn it on permanently in your ipython_config.py file if it | |
|
139 | works for you. Test it and turn it on permanently if it works with | |
|
140 | your system. The magic function %%color_info allows you to toggle this | |
|
141 | inter- actively for testing.""") | |
|
142 | paa('--no-color-info', | |
|
143 | action='store_false', dest='InteractiveShell.color_info', | |
|
139 | 144 | help="Disable using colors for info related things.") |
|
140 | ), | |
|
141 | (('--confirm-exit',), dict( | |
|
142 | action='store_true', dest='InteractiveShell.confirm_exit', default=NoConfigDefault, | |
|
143 | help="Prompt the user when existing.") | |
|
144 | ), | |
|
145 | (('--no-confirm-exit',), dict( | |
|
146 | action='store_false', dest='InteractiveShell.confirm_exit', default=NoConfigDefault, | |
|
147 | help="Don't prompt the user when existing.") | |
|
148 | ), | |
|
149 |
|
|
|
150 |
action='store_true', dest='InteractiveShell.deep_reload', |
|
|
151 | help="Enable deep (recursive) reloading by default.") | |
|
152 | ), | |
|
153 | (('--no-deep-reload',), dict( | |
|
154 | action='store_false', dest='InteractiveShell.deep_reload', default=NoConfigDefault, | |
|
145 | paa('--confirm-exit', | |
|
146 | action='store_true', dest='InteractiveShell.confirm_exit', | |
|
147 | help= | |
|
148 | """Set to confirm when you try to exit IPython with an EOF (Control-D | |
|
149 | in Unix, Control-Z/Enter in Windows). By typing 'exit', 'quit' or | |
|
150 | '%%Exit', you can force a direct exit without any confirmation.""") | |
|
151 | paa('--no-confirm-exit', | |
|
152 | action='store_false', dest='InteractiveShell.confirm_exit', | |
|
153 | help="Don't prompt the user when exiting.") | |
|
154 | paa('--deep-reload', | |
|
155 | action='store_true', dest='InteractiveShell.deep_reload', | |
|
156 | help= | |
|
157 | """Enable deep (recursive) reloading by default. IPython can use the | |
|
158 | deep_reload module which reloads changes in modules recursively (it | |
|
159 | replaces the reload() function, so you don't need to change anything to | |
|
160 | use it). deep_reload() forces a full reload of modules whose code may | |
|
161 | have changed, which the default reload() function does not. When | |
|
162 | deep_reload is off, IPython will use the normal reload(), but | |
|
163 | deep_reload will still be available as dreload(). This fea- ture is off | |
|
164 | by default [which means that you have both normal reload() and | |
|
165 | dreload()].""") | |
|
166 | paa('--no-deep-reload', | |
|
167 | action='store_false', dest='InteractiveShell.deep_reload', | |
|
155 | 168 | help="Disable deep (recursive) reloading by default.") |
|
156 | ), | |
|
157 | (('--editor',), dict( | |
|
158 | type=str, dest='InteractiveShell.editor', default=NoConfigDefault, | |
|
169 | paa('--editor', | |
|
170 | type=str, dest='InteractiveShell.editor', | |
|
159 | 171 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad).", |
|
160 | 172 | metavar='InteractiveShell.editor') |
|
161 | ), | |
|
162 | (('--log','-l'), dict( | |
|
163 | action='store_true', dest='InteractiveShell.logstart', default=NoConfigDefault, | |
|
164 | help="Start logging to the default file (./ipython_log.py).") | |
|
165 | ), | |
|
166 | (('--logfile','-lf'), dict( | |
|
167 | type=unicode, dest='InteractiveShell.logfile', default=NoConfigDefault, | |
|
168 | help="Start logging to logfile.", | |
|
173 | paa('--log','-l', | |
|
174 | action='store_true', dest='InteractiveShell.logstart', | |
|
175 | help="Start logging to the default log file (./ipython_log.py).") | |
|
176 | paa('--logfile','-lf', | |
|
177 | type=unicode, dest='InteractiveShell.logfile', | |
|
178 | help="Start logging to logfile with this name.", | |
|
169 | 179 | metavar='InteractiveShell.logfile') |
|
170 | ), | |
|
171 | (('--log-append','-la'), dict( | |
|
172 | type=unicode, dest='InteractiveShell.logappend', default=NoConfigDefault, | |
|
173 | help="Start logging to the give file in append mode.", | |
|
180 | paa('--log-append','-la', | |
|
181 | type=unicode, dest='InteractiveShell.logappend', | |
|
182 | help="Start logging to the given file in append mode.", | |
|
174 | 183 | metavar='InteractiveShell.logfile') |
|
175 | ), | |
|
176 | (('--pdb',), dict( | |
|
177 | action='store_true', dest='InteractiveShell.pdb', default=NoConfigDefault, | |
|
184 | paa('--pdb', | |
|
185 | action='store_true', dest='InteractiveShell.pdb', | |
|
178 | 186 | help="Enable auto calling the pdb debugger after every exception.") |
|
179 | ), | |
|
180 | (('--no-pdb',), dict( | |
|
181 | action='store_false', dest='InteractiveShell.pdb', default=NoConfigDefault, | |
|
187 | paa('--no-pdb', | |
|
188 | action='store_false', dest='InteractiveShell.pdb', | |
|
182 | 189 | help="Disable auto calling the pdb debugger after every exception.") |
|
183 | ), | |
|
184 | (('--pprint',), dict( | |
|
185 | action='store_true', dest='InteractiveShell.pprint', default=NoConfigDefault, | |
|
190 | paa('--pprint', | |
|
191 | action='store_true', dest='InteractiveShell.pprint', | |
|
186 | 192 | help="Enable auto pretty printing of results.") |
|
187 | ), | |
|
188 | (('--no-pprint',), dict( | |
|
189 | action='store_false', dest='InteractiveShell.pprint', default=NoConfigDefault, | |
|
193 | paa('--no-pprint', | |
|
194 | action='store_false', dest='InteractiveShell.pprint', | |
|
190 | 195 | help="Disable auto auto pretty printing of results.") |
|
191 | ), | |
|
192 | (('--prompt-in1','-pi1'), dict( | |
|
193 | type=str, dest='InteractiveShell.prompt_in1', default=NoConfigDefault, | |
|
194 |
|
|
|
196 | paa('--prompt-in1','-pi1', | |
|
197 | type=str, dest='InteractiveShell.prompt_in1', | |
|
198 | help= | |
|
199 | """Set the main input prompt ('In [\#]: '). Note that if you are using | |
|
200 | numbered prompts, the number is represented with a '\#' in the string. | |
|
201 | Don't forget to quote strings with spaces embedded in them. Most | |
|
202 | bash-like escapes can be used to customize IPython's prompts, as well | |
|
203 | as a few additional ones which are IPython-spe- cific. All valid | |
|
204 | prompt escapes are described in detail in the Customization section of | |
|
205 | the IPython manual.""", | |
|
195 | 206 | metavar='InteractiveShell.prompt_in1') |
|
196 | ), | |
|
197 | (('--prompt-in2','-pi2'), dict( | |
|
198 | type=str, dest='InteractiveShell.prompt_in2', default=NoConfigDefault, | |
|
199 |
|
|
|
207 | paa('--prompt-in2','-pi2', | |
|
208 | type=str, dest='InteractiveShell.prompt_in2', | |
|
209 | help= | |
|
210 | """Set the secondary input prompt (' .\D.: '). Similar to the previous | |
|
211 | option, but used for the continuation prompts. The special sequence | |
|
212 | '\D' is similar to '\#', but with all digits replaced by dots (so you | |
|
213 | can have your continuation prompt aligned with your input prompt). | |
|
214 | Default: ' .\D.: ' (note three spaces at the start for alignment with | |
|
215 | 'In [\#]')""", | |
|
200 | 216 | metavar='InteractiveShell.prompt_in2') |
|
201 | ), | |
|
202 | (('--prompt-out','-po'), dict( | |
|
203 | type=str, dest='InteractiveShell.prompt_out', default=NoConfigDefault, | |
|
217 | paa('--prompt-out','-po', | |
|
218 | type=str, dest='InteractiveShell.prompt_out', | |
|
204 | 219 | help="Set the output prompt ('Out[\#]:')", |
|
205 | 220 | metavar='InteractiveShell.prompt_out') |
|
206 | ), | |
|
207 | (('--quick',), dict( | |
|
208 | action='store_true', dest='Global.quick', default=NoConfigDefault, | |
|
221 | paa('--quick', | |
|
222 | action='store_true', dest='Global.quick', | |
|
209 | 223 | help="Enable quick startup with no config files.") |
|
210 | ), | |
|
211 | (('--readline',), dict( | |
|
212 | action='store_true', dest='InteractiveShell.readline_use', default=NoConfigDefault, | |
|
224 | paa('--readline', | |
|
225 | action='store_true', dest='InteractiveShell.readline_use', | |
|
213 | 226 | help="Enable readline for command line usage.") |
|
214 | ), | |
|
215 | (('--no-readline',), dict( | |
|
216 | action='store_false', dest='InteractiveShell.readline_use', default=NoConfigDefault, | |
|
227 | paa('--no-readline', | |
|
228 | action='store_false', dest='InteractiveShell.readline_use', | |
|
217 | 229 | help="Disable readline for command line usage.") |
|
218 | ), | |
|
219 | (('--screen-length','-sl'), dict( | |
|
220 | type=int, dest='InteractiveShell.screen_length', default=NoConfigDefault, | |
|
221 |
|
|
|
230 | paa('--screen-length','-sl', | |
|
231 | type=int, dest='InteractiveShell.screen_length', | |
|
232 | help= | |
|
233 | """Number of lines of your screen, used to control printing of very | |
|
234 | long strings. Strings longer than this number of lines will be sent | |
|
235 | through a pager instead of directly printed. The default value for | |
|
236 | this is 0, which means IPython will auto-detect your screen size every | |
|
237 | time it needs to print certain potentially long strings (this doesn't | |
|
238 | change the behavior of the 'print' keyword, it's only triggered | |
|
239 | internally). If for some reason this isn't working well (it needs | |
|
240 | curses support), specify it yourself. Otherwise don't change the | |
|
241 | default.""", | |
|
222 | 242 | metavar='InteractiveShell.screen_length') |
|
223 | ), | |
|
224 | (('--separate-in','-si'), dict( | |
|
225 | type=str, dest='InteractiveShell.separate_in', default=NoConfigDefault, | |
|
226 | help="Separator before input prompts. Default '\n'.", | |
|
243 | paa('--separate-in','-si', | |
|
244 | type=str, dest='InteractiveShell.separate_in', | |
|
245 | help="Separator before input prompts. Default '\\n'.", | |
|
227 | 246 | metavar='InteractiveShell.separate_in') |
|
228 | ), | |
|
229 | (('--separate-out','-so'), dict( | |
|
230 | type=str, dest='InteractiveShell.separate_out', default=NoConfigDefault, | |
|
247 | paa('--separate-out','-so', | |
|
248 | type=str, dest='InteractiveShell.separate_out', | |
|
231 | 249 | help="Separator before output prompts. Default 0 (nothing).", |
|
232 | 250 | metavar='InteractiveShell.separate_out') |
|
233 | ), | |
|
234 | (('--separate-out2','-so2'), dict( | |
|
235 | type=str, dest='InteractiveShell.separate_out2', default=NoConfigDefault, | |
|
251 | paa('--separate-out2','-so2', | |
|
252 | type=str, dest='InteractiveShell.separate_out2', | |
|
236 | 253 | help="Separator after output prompts. Default 0 (nonight).", |
|
237 | 254 | metavar='InteractiveShell.separate_out2') |
|
238 | ), | |
|
239 | (('-no-sep',), dict( | |
|
240 | action='store_true', dest='Global.nosep', default=NoConfigDefault, | |
|
255 | paa('--no-sep', | |
|
256 | action='store_true', dest='Global.nosep', | |
|
241 | 257 | help="Eliminate all spacing between prompts.") |
|
242 | ), | |
|
243 | (('--term-title',), dict( | |
|
244 | action='store_true', dest='InteractiveShell.term_title', default=NoConfigDefault, | |
|
258 | paa('--term-title', | |
|
259 | action='store_true', dest='InteractiveShell.term_title', | |
|
245 | 260 | help="Enable auto setting the terminal title.") |
|
246 | ), | |
|
247 | (('--no-term-title',), dict( | |
|
248 | action='store_false', dest='InteractiveShell.term_title', default=NoConfigDefault, | |
|
261 | paa('--no-term-title', | |
|
262 | action='store_false', dest='InteractiveShell.term_title', | |
|
249 | 263 | help="Disable auto setting the terminal title.") |
|
250 | ), | |
|
251 | (('--xmode',), dict( | |
|
252 | type=str, dest='InteractiveShell.xmode', default=NoConfigDefault, | |
|
253 |
|
|
|
264 | paa('--xmode', | |
|
265 | type=str, dest='InteractiveShell.xmode', | |
|
266 | help= | |
|
267 | """Exception reporting mode ('Plain','Context','Verbose'). Plain: | |
|
268 | similar to python's normal traceback printing. Context: prints 5 lines | |
|
269 | of context source code around each line in the traceback. Verbose: | |
|
270 | similar to Context, but additionally prints the variables currently | |
|
271 | visible where the exception happened (shortening their strings if too | |
|
272 | long). This can potentially be very slow, if you happen to have a huge | |
|
273 | data structure whose string representation is complex to compute. | |
|
274 | Your computer may appear to freeze for a while with cpu usage at 100%%. | |
|
275 | If this occurs, you can cancel the traceback with Ctrl-C (maybe hitting | |
|
276 | it more than once). | |
|
277 | """, | |
|
254 | 278 | metavar='InteractiveShell.xmode') |
|
255 | ), | |
|
256 | (('--ext',), dict( | |
|
257 | type=str, dest='Global.extra_extension', default=NoConfigDefault, | |
|
279 | paa('--ext', | |
|
280 | type=str, dest='Global.extra_extension', | |
|
258 | 281 | help="The dotted module name of an IPython extension to load.", |
|
259 | 282 | metavar='Global.extra_extension') |
|
260 | ), | |
|
261 | (('-c',), dict( | |
|
262 | type=str, dest='Global.code_to_run', default=NoConfigDefault, | |
|
283 | paa('-c', | |
|
284 | type=str, dest='Global.code_to_run', | |
|
263 | 285 | help="Execute the given command string.", |
|
264 | 286 | metavar='Global.code_to_run') |
|
265 | ), | |
|
266 | (('-i',), dict( | |
|
267 | action='store_true', dest='Global.force_interact', default=NoConfigDefault, | |
|
268 |
|
|
|
269 | ), | |
|
270 | (('--wthread',), dict( | |
|
271 | action='store_true', dest='Global.wthread', default=NoConfigDefault, | |
|
272 | help="Enable wxPython event loop integration.") | |
|
273 | ), | |
|
274 | (('--q4thread','--qthread'), dict( | |
|
275 | action='store_true', dest='Global.q4thread', default=NoConfigDefault, | |
|
276 | help="Enable Qt4 event loop integration. Qt3 is no longer supported.") | |
|
277 | ), | |
|
278 | (('--gthread',), dict( | |
|
279 | action='store_true', dest='Global.gthread', default=NoConfigDefault, | |
|
280 | help="Enable GTK event loop integration.") | |
|
281 | ), | |
|
282 | # # These are only here to get the proper deprecation warnings | |
|
283 | (('--pylab',), dict( | |
|
284 | action='store_true', dest='Global.pylab', default=NoConfigDefault, | |
|
285 | help="Disabled. Pylab has been disabled until matplotlib " | |
|
286 | "supports this version of IPython.") | |
|
287 | ) | |
|
288 | ) | |
|
287 | paa('-i', | |
|
288 | action='store_true', dest='Global.force_interact', | |
|
289 | help= | |
|
290 | "If running code from the command line, become interactive afterwards.") | |
|
291 | ||
|
292 | # Options to start with GUI control enabled from the beginning | |
|
293 | paa('--gui', | |
|
294 | type=str, dest='Global.gui', | |
|
295 | help="Enable GUI event loop integration ('qt', 'wx', 'gtk').", | |
|
296 | metavar='gui-mode') | |
|
297 | paa('--pylab','-pylab', | |
|
298 | type=str, dest='Global.pylab', | |
|
299 | nargs='?', const='auto', metavar='gui-mode', | |
|
300 | help="Pre-load matplotlib and numpy for interactive use. "+ | |
|
301 | "If no value is given, the gui backend is matplotlib's, else use "+ | |
|
302 | "one of: ['tk', 'qt', 'wx', 'gtk'].") | |
|
303 | ||
|
304 | # Legacy GUI options. Leave them in for backwards compatibility, but the | |
|
305 | # 'thread' names are really a misnomer now. | |
|
306 | paa('--wthread', '-wthread', | |
|
307 | action='store_true', dest='Global.wthread', | |
|
308 | help= | |
|
309 | """Enable wxPython event loop integration. (DEPRECATED, use --gui wx)""") | |
|
310 | paa('--q4thread', '--qthread', '-q4thread', '-qthread', | |
|
311 | action='store_true', dest='Global.q4thread', | |
|
312 | help= | |
|
313 | """Enable Qt4 event loop integration. Qt3 is no longer supported. | |
|
314 | (DEPRECATED, use --gui qt)""") | |
|
315 | paa('--gthread', '-gthread', | |
|
316 | action='store_true', dest='Global.gthread', | |
|
317 | help= | |
|
318 | """Enable GTK event loop integration. (DEPRECATED, use --gui gtk)""") | |
|
289 | 319 | |
|
290 | 320 | |
|
291 | class IPythonAppCLConfigLoader(BaseAppArgParseConfigLoader): | |
|
321 | #----------------------------------------------------------------------------- | |
|
322 | # Crash handler for this application | |
|
323 | #----------------------------------------------------------------------------- | |
|
292 | 324 | |
|
293 | arguments = cl_args | |
|
294 | 325 | |
|
326 | _message_template = """\ | |
|
327 | Oops, $self.app_name crashed. We do our best to make it stable, but... | |
|
295 | 328 | |
|
296 | default_config_file_name = u'ipython_config.py' | |
|
329 | A crash report was automatically generated with the following information: | |
|
330 | - A verbatim copy of the crash traceback. | |
|
331 | - A copy of your input history during this session. | |
|
332 | - Data on your current $self.app_name configuration. | |
|
333 | ||
|
334 | It was left in the file named: | |
|
335 | \t'$self.crash_report_fname' | |
|
336 | If you can email this file to the developers, the information in it will help | |
|
337 | them in understanding and correcting the problem. | |
|
338 | ||
|
339 | You can mail it to: $self.contact_name at $self.contact_email | |
|
340 | with the subject '$self.app_name Crash Report'. | |
|
341 | ||
|
342 | If you want to do it now, the following command will work (under Unix): | |
|
343 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname | |
|
344 | ||
|
345 | To ensure accurate tracking of this issue, please file a report about it at: | |
|
346 | $self.bug_tracker | |
|
347 | """ | |
|
348 | ||
|
349 | class IPAppCrashHandler(CrashHandler): | |
|
350 | """sys.excepthook for IPython itself, leaves a detailed report on disk.""" | |
|
297 | 351 | |
|
352 | message_template = _message_template | |
|
353 | ||
|
354 | def __init__(self, app): | |
|
355 | contact_name = release.authors['Fernando'][0] | |
|
356 | contact_email = release.authors['Fernando'][1] | |
|
357 | bug_tracker = 'https://bugs.launchpad.net/ipython/+filebug' | |
|
358 | super(IPAppCrashHandler,self).__init__( | |
|
359 | app, contact_name, contact_email, bug_tracker | |
|
360 | ) | |
|
361 | ||
|
362 | def make_report(self,traceback): | |
|
363 | """Return a string containing a crash report.""" | |
|
364 | ||
|
365 | sec_sep = self.section_sep | |
|
366 | # Start with parent report | |
|
367 | report = [super(IPAppCrashHandler, self).make_report(traceback)] | |
|
368 | # Add interactive-specific info we may have | |
|
369 | rpt_add = report.append | |
|
370 | try: | |
|
371 | rpt_add(sec_sep+"History of session input:") | |
|
372 | for line in self.app.shell.user_ns['_ih']: | |
|
373 | rpt_add(line) | |
|
374 | rpt_add('\n*** Last line of input (may not be in above history):\n') | |
|
375 | rpt_add(self.app.shell._last_input_line+'\n') | |
|
376 | except: | |
|
377 | pass | |
|
378 | ||
|
379 | return ''.join(report) | |
|
380 | ||
|
381 | ||
|
382 | #----------------------------------------------------------------------------- | |
|
383 | # Main classes and functions | |
|
384 | #----------------------------------------------------------------------------- | |
|
298 | 385 | |
|
299 | 386 | class IPythonApp(Application): |
|
300 | 387 | name = u'ipython' |
|
301 | description = 'IPython: an enhanced interactive Python shell.' | |
|
302 | config_file_name = default_config_file_name | |
|
388 | #: argparse formats better the 'usage' than the 'description' field | |
|
389 | description = None | |
|
390 | usage = usage.cl_usage | |
|
391 | command_line_loader = IPAppConfigLoader | |
|
392 | default_config_file_name = default_config_file_name | |
|
393 | crash_handler_class = IPAppCrashHandler | |
|
303 | 394 | |
|
304 | 395 | def create_default_config(self): |
|
305 | 396 | super(IPythonApp, self).create_default_config() |
|
306 | self.default_config.Global.display_banner = True | |
|
397 | # Eliminate multiple lookups | |
|
398 | Global = self.default_config.Global | |
|
399 | ||
|
400 | # Set all default values | |
|
401 | Global.display_banner = True | |
|
307 | 402 | |
|
308 | 403 | # If the -c flag is given or a file is given to run at the cmd line |
|
309 | 404 | # like "ipython foo.py", normally we exit without starting the main |
|
310 | 405 | # loop. The force_interact config variable allows a user to override |
|
311 | 406 | # this and interact. It is also set by the -i cmd line flag, just |
|
312 | 407 | # like Python. |
|
313 |
|
|
|
408 | Global.force_interact = False | |
|
314 | 409 | |
|
315 | 410 | # By default always interact by starting the IPython mainloop. |
|
316 |
|
|
|
411 | Global.interact = True | |
|
317 | 412 | |
|
318 | 413 | # No GUI integration by default |
|
319 |
|
|
|
320 | self.default_config.Global.q4thread = False | |
|
321 |
|
|
|
322 | ||
|
323 | def create_command_line_config(self): | |
|
324 | """Create and return a command line config loader.""" | |
|
325 | return IPythonAppCLConfigLoader( | |
|
326 | description=self.description, | |
|
327 | version=release.version | |
|
328 | ) | |
|
329 | ||
|
330 | def post_load_command_line_config(self): | |
|
331 | """Do actions after loading cl config.""" | |
|
332 | clc = self.command_line_config | |
|
333 | ||
|
334 | # Display the deprecation warnings about threaded shells | |
|
335 | if hasattr(clc.Global, 'pylab'): | |
|
336 | pylab_warning() | |
|
337 | del clc.Global['pylab'] | |
|
414 | Global.gui = False | |
|
415 | # Pylab off by default | |
|
416 | Global.pylab = False | |
|
417 | ||
|
418 | # Deprecated versions of gui support that used threading, we support | |
|
419 | # them just for bacwards compatibility as an alternate spelling for | |
|
420 | # '--gui X' | |
|
421 | Global.qthread = False | |
|
422 | Global.q4thread = False | |
|
423 | Global.wthread = False | |
|
424 | Global.gthread = False | |
|
338 | 425 | |
|
339 | 426 | def load_file_config(self): |
|
340 | 427 | if hasattr(self.command_line_config.Global, 'quick'): |
@@ -377,8 +464,7 b' class IPythonApp(Application):' | |||
|
377 | 464 | # unless the -i flag (Global.force_interact) is true. |
|
378 | 465 | code_to_run = config.Global.get('code_to_run','') |
|
379 | 466 | file_to_run = False |
|
380 |
if |
|
|
381 | if self.extra_args[0]: | |
|
467 | if self.extra_args and self.extra_args[0]: | |
|
382 | 468 | file_to_run = True |
|
383 | 469 | if file_to_run or code_to_run: |
|
384 | 470 | if not config.Global.force_interact: |
@@ -390,10 +476,7 b' class IPythonApp(Application):' | |||
|
390 | 476 | sys.path.insert(0, '') |
|
391 | 477 | |
|
392 | 478 | # Create an InteractiveShell instance |
|
393 | self.shell = InteractiveShell( | |
|
394 | parent=None, | |
|
395 | config=self.master_config | |
|
396 | ) | |
|
479 | self.shell = InteractiveShell(None, self.master_config) | |
|
397 | 480 | |
|
398 | 481 | def post_construct(self): |
|
399 | 482 | """Do actions after construct, but before starting the app.""" |
@@ -403,7 +486,6 b' class IPythonApp(Application):' | |||
|
403 | 486 | # based app, because we call shell.show_banner() by hand below |
|
404 | 487 | # so the banner shows *before* all extension loading stuff. |
|
405 | 488 | self.shell.display_banner = False |
|
406 | ||
|
407 | 489 | if config.Global.display_banner and \ |
|
408 | 490 | config.Global.interact: |
|
409 | 491 | self.shell.show_banner() |
@@ -412,26 +494,48 b' class IPythonApp(Application):' | |||
|
412 | 494 | if self.log_level <= logging.INFO: print |
|
413 | 495 | |
|
414 | 496 | # Now a variety of things that happen after the banner is printed. |
|
415 | self._enable_gui() | |
|
497 | self._enable_gui_pylab() | |
|
416 | 498 | self._load_extensions() |
|
417 | 499 | self._run_exec_lines() |
|
418 | 500 | self._run_exec_files() |
|
419 | 501 | self._run_cmd_line_code() |
|
420 | 502 | |
|
421 | def _enable_gui(self): | |
|
422 | """Enable GUI event loop integration.""" | |
|
423 |
|
|
|
503 | def _enable_gui_pylab(self): | |
|
504 | """Enable GUI event loop integration, taking pylab into account.""" | |
|
505 | Global = self.master_config.Global | |
|
506 | ||
|
507 | # Select which gui to use | |
|
508 | if Global.gui: | |
|
509 | gui = Global.gui | |
|
510 | # The following are deprecated, but there's likely to be a lot of use | |
|
511 | # of this form out there, so we might as well support it for now. But | |
|
512 | # the --gui option above takes precedence. | |
|
513 | elif Global.wthread: | |
|
514 | gui = inputhook.GUI_WX | |
|
515 | elif Global.qthread: | |
|
516 | gui = inputhook.GUI_QT | |
|
517 | elif Global.gthread: | |
|
518 | gui = inputhook.GUI_GTK | |
|
519 | else: | |
|
520 | gui = None | |
|
521 | ||
|
522 | # Using --pylab will also require gui activation, though which toolkit | |
|
523 | # to use may be chosen automatically based on mpl configuration. | |
|
524 | if Global.pylab: | |
|
525 | activate = self.shell.enable_pylab | |
|
526 | if Global.pylab == 'auto': | |
|
527 | gui = None | |
|
528 | else: | |
|
529 | gui = Global.pylab | |
|
530 | else: | |
|
531 | # Enable only GUI integration, no pylab | |
|
532 | activate = inputhook.enable_gui | |
|
533 | ||
|
534 | if gui or Global.pylab: | |
|
424 | 535 | try: |
|
425 |
|
|
|
426 | if config.Global.wthread: | |
|
427 | self.log.info("Enabling wx GUI event loop integration") | |
|
428 | inputhook.enable_wx(app=True) | |
|
429 | elif config.Global.q4thread: | |
|
430 | self.log.info("Enabling Qt4 GUI event loop integration") | |
|
431 | inputhook.enable_qt4(app=True) | |
|
432 | elif config.Global.gthread: | |
|
433 | self.log.info("Enabling GTK GUI event loop integration") | |
|
434 | inputhook.enable_gtk(app=True) | |
|
536 | self.log.info("Enabling GUI event loop integration, " | |
|
537 | "toolkit=%s, pylab=%s" % (gui, Global.pylab) ) | |
|
538 | activate(gui) | |
|
435 | 539 | except: |
|
436 | 540 | self.log.warn("Error in enabling GUI event loop integration:") |
|
437 | 541 | self.shell.showtraceback() |
@@ -523,6 +627,8 b' class IPythonApp(Application):' | |||
|
523 | 627 | if self.master_config.Global.interact: |
|
524 | 628 | self.log.debug("Starting IPython's mainloop...") |
|
525 | 629 | self.shell.mainloop() |
|
630 | else: | |
|
631 | self.log.debug("IPython not interactive, start_app is no-op...") | |
|
526 | 632 | |
|
527 | 633 | |
|
528 | 634 | def load_default_config(ipython_dir=None): |
@@ -542,3 +648,6 b' def launch_new_instance():' | |||
|
542 | 648 | app = IPythonApp() |
|
543 | 649 | app.start() |
|
544 | 650 | |
|
651 | ||
|
652 | if __name__ == '__main__': | |
|
653 | launch_new_instance() |
@@ -17,9 +17,9 b' Main IPython Component' | |||
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | from __future__ import with_statement |
|
20 | from __future__ import absolute_import | |
|
20 | 21 | |
|
21 | 22 | import __builtin__ |
|
22 | import StringIO | |
|
23 | 23 | import bdb |
|
24 | 24 | import codeop |
|
25 | 25 | import exceptions |
@@ -31,46 +31,54 b' import sys' | |||
|
31 | 31 | import tempfile |
|
32 | 32 | from contextlib import nested |
|
33 | 33 | |
|
34 | from IPython.core import ultratb | |
|
35 | 34 | from IPython.core import debugger, oinspect |
|
36 | from IPython.core import shadowns | |
|
37 | 35 | from IPython.core import history as ipcorehist |
|
38 | 36 | from IPython.core import prefilter |
|
37 | from IPython.core import shadowns | |
|
38 | from IPython.core import ultratb | |
|
39 | 39 | from IPython.core.alias import AliasManager |
|
40 | 40 | from IPython.core.builtin_trap import BuiltinTrap |
|
41 | from IPython.core.component import Component | |
|
41 | 42 | from IPython.core.display_trap import DisplayTrap |
|
43 | from IPython.core.error import TryNext, UsageError | |
|
42 | 44 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
43 | 45 | from IPython.core.logger import Logger |
|
44 | 46 | from IPython.core.magic import Magic |
|
45 | from IPython.core.prompts import CachedOutput | |
|
46 | 47 | from IPython.core.prefilter import PrefilterManager |
|
47 |
from IPython.core. |
|
|
48 | from IPython.core.prompts import CachedOutput | |
|
48 | 49 | from IPython.core.usage import interactive_usage, default_banner |
|
49 | from IPython.core.error import TryNext, UsageError | |
|
50 | ||
|
51 | from IPython.utils import pickleshare | |
|
50 | import IPython.core.hooks | |
|
52 | 51 | from IPython.external.Itpl import ItplNS |
|
52 | from IPython.lib.inputhook import enable_gui | |
|
53 | 53 | from IPython.lib.backgroundjobs import BackgroundJobManager |
|
54 | from IPython.utils.ipstruct import Struct | |
|
54 | from IPython.lib.pylabtools import pylab_activate | |
|
55 | 55 | from IPython.utils import PyColorize |
|
56 |
from IPython.utils |
|
|
57 |
from IPython.utils. |
|
|
58 | from IPython.utils.platutils import toggle_set_term_title, set_term_title | |
|
56 | from IPython.utils import pickleshare | |
|
57 | from IPython.utils.doctestreload import doctest_reload | |
|
58 | from IPython.utils.ipstruct import Struct | |
|
59 | from IPython.utils.io import Term, ask_yes_no | |
|
60 | from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError | |
|
61 | from IPython.utils.process import ( | |
|
62 | abbrev_cwd, | |
|
63 | getoutput, | |
|
64 | getoutputerror | |
|
65 | ) | |
|
66 | # import IPython.utils.rlineimpl as readline | |
|
59 | 67 | from IPython.utils.strdispatch import StrDispatch |
|
60 | 68 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
61 | ||
|
62 |
|
|
|
63 | # growl.start("IPython") | |
|
64 | ||
|
69 | from IPython.utils.terminal import toggle_set_term_title, set_term_title | |
|
70 | from IPython.utils.warn import warn, error, fatal | |
|
65 | 71 | from IPython.utils.traitlets import ( |
|
66 | 72 | Int, Str, CBool, CaselessStrEnum, Enum, List, Unicode |
|
67 | 73 | ) |
|
68 | 74 | |
|
75 | # from IPython.utils import growl | |
|
76 | # growl.start("IPython") | |
|
77 | ||
|
69 | 78 | #----------------------------------------------------------------------------- |
|
70 | 79 | # Globals |
|
71 | 80 | #----------------------------------------------------------------------------- |
|
72 | 81 | |
|
73 | ||
|
74 | 82 | # store the builtin raw_input globally, and use this always, in case user code |
|
75 | 83 | # overwrites it (like wx.py.PyShell does) |
|
76 | 84 | raw_input_original = raw_input |
@@ -78,12 +86,10 b' raw_input_original = raw_input' | |||
|
78 | 86 | # compiled regexps for autoindent management |
|
79 | 87 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
80 | 88 | |
|
81 | ||
|
82 | 89 | #----------------------------------------------------------------------------- |
|
83 | 90 | # Utilities |
|
84 | 91 | #----------------------------------------------------------------------------- |
|
85 | 92 | |
|
86 | ||
|
87 | 93 | ini_spaces_re = re.compile(r'^(\s+)') |
|
88 | 94 | |
|
89 | 95 | |
@@ -113,6 +119,8 b' def softspace(file, newvalue):' | |||
|
113 | 119 | return oldvalue |
|
114 | 120 | |
|
115 | 121 | |
|
122 | def no_op(*a, **kw): pass | |
|
123 | ||
|
116 | 124 | class SpaceInInput(exceptions.Exception): pass |
|
117 | 125 | |
|
118 | 126 | class Bunch: pass |
@@ -329,6 +337,7 b' class InteractiveShell(Component, Magic):' | |||
|
329 | 337 | self.hooks.late_startup_hook() |
|
330 | 338 | |
|
331 | 339 | def get_ipython(self): |
|
340 | """Return the currently running IPython instance.""" | |
|
332 | 341 | return self |
|
333 | 342 | |
|
334 | 343 | #------------------------------------------------------------------------- |
@@ -596,7 +605,6 b' class InteractiveShell(Component, Magic):' | |||
|
596 | 605 | self.strdispatchers = {} |
|
597 | 606 | |
|
598 | 607 | # Set all default hooks, defined in the IPython.hooks module. |
|
599 | import IPython.core.hooks | |
|
600 | 608 | hooks = IPython.core.hooks |
|
601 | 609 | for hook_name in hooks.__all__: |
|
602 | 610 | # default hooks have priority 100, i.e. low; user hooks should have |
@@ -814,8 +822,7 b' class InteractiveShell(Component, Magic):' | |||
|
814 | 822 | # These routines return properly built dicts as needed by the rest of |
|
815 | 823 | # the code, and can also be used by extension writers to generate |
|
816 | 824 | # properly initialized namespaces. |
|
817 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, | |
|
818 | user_global_ns) | |
|
825 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, user_global_ns) | |
|
819 | 826 | |
|
820 | 827 | # Assign namespaces |
|
821 | 828 | # This is the namespace where all normal user variables live |
@@ -825,8 +832,8 b' class InteractiveShell(Component, Magic):' | |||
|
825 | 832 | # An auxiliary namespace that checks what parts of the user_ns were |
|
826 | 833 | # loaded at startup, so we can list later only variables defined in |
|
827 | 834 | # actual interactive use. Since it is always a subset of user_ns, it |
|
828 |
# doesn't need to be se |
|
|
829 |
self.user_ |
|
|
835 | # doesn't need to be separately tracked in the ns_table. | |
|
836 | self.user_ns_hidden = {} | |
|
830 | 837 | |
|
831 | 838 | # A namespace to keep track of internal data structures to prevent |
|
832 | 839 | # them from cluttering user-visible stuff. Will be updated later |
@@ -872,34 +879,9 b' class InteractiveShell(Component, Magic):' | |||
|
872 | 879 | # Similarly, track all namespaces where references can be held and that |
|
873 | 880 | # we can safely clear (so it can NOT include builtin). This one can be |
|
874 | 881 | # a simple list. |
|
875 |
self.ns_refs_table = [ user_ns, user_global_ns, self.user_ |
|
|
882 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_ns_hidden, | |
|
876 | 883 | self.internal_ns, self._main_ns_cache ] |
|
877 | 884 | |
|
878 | def init_sys_modules(self): | |
|
879 | # We need to insert into sys.modules something that looks like a | |
|
880 | # module but which accesses the IPython namespace, for shelve and | |
|
881 | # pickle to work interactively. Normally they rely on getting | |
|
882 | # everything out of __main__, but for embedding purposes each IPython | |
|
883 | # instance has its own private namespace, so we can't go shoving | |
|
884 | # everything into __main__. | |
|
885 | ||
|
886 | # note, however, that we should only do this for non-embedded | |
|
887 | # ipythons, which really mimic the __main__.__dict__ with their own | |
|
888 | # namespace. Embedded instances, on the other hand, should not do | |
|
889 | # this because they need to manage the user local/global namespaces | |
|
890 | # only, but they live within a 'normal' __main__ (meaning, they | |
|
891 | # shouldn't overtake the execution environment of the script they're | |
|
892 | # embedded in). | |
|
893 | ||
|
894 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
|
895 | ||
|
896 | try: | |
|
897 | main_name = self.user_ns['__name__'] | |
|
898 | except KeyError: | |
|
899 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
|
900 | else: | |
|
901 | sys.modules[main_name] = FakeModule(self.user_ns) | |
|
902 | ||
|
903 | 885 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
904 | 886 | """Return a valid local and global user interactive namespaces. |
|
905 | 887 | |
@@ -916,7 +898,8 b' class InteractiveShell(Component, Magic):' | |||
|
916 | 898 | |
|
917 | 899 | Raises TypeError if the provided globals namespace is not a true dict. |
|
918 | 900 | |
|
919 |
|
|
|
901 | Parameters | |
|
902 | ---------- | |
|
920 | 903 |
|
|
921 | 904 |
|
|
922 | 905 |
|
@@ -926,19 +909,27 b' class InteractiveShell(Component, Magic):' | |||
|
926 | 909 |
|
|
927 | 910 |
|
|
928 | 911 | |
|
929 |
|
|
|
930 | A tuple pair of dictionary-like object to be used as the local namespace | |
|
912 | Returns | |
|
913 | ------- | |
|
914 | A pair of dictionary-like object to be used as the local namespace | |
|
931 | 915 | of the interpreter and a dict to be used as the global namespace. |
|
932 | 916 | """ |
|
933 | 917 | |
|
918 | ||
|
919 | # We must ensure that __builtin__ (without the final 's') is always | |
|
920 | # available and pointing to the __builtin__ *module*. For more details: | |
|
921 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
|
922 | ||
|
934 | 923 | if user_ns is None: |
|
935 | 924 | # Set __name__ to __main__ to better match the behavior of the |
|
936 | 925 | # normal interpreter. |
|
937 | 926 | user_ns = {'__name__' :'__main__', |
|
927 | '__builtin__' : __builtin__, | |
|
938 | 928 | '__builtins__' : __builtin__, |
|
939 | 929 | } |
|
940 | 930 | else: |
|
941 | 931 | user_ns.setdefault('__name__','__main__') |
|
932 | user_ns.setdefault('__builtin__',__builtin__) | |
|
942 | 933 | user_ns.setdefault('__builtins__',__builtin__) |
|
943 | 934 | |
|
944 | 935 | if user_global_ns is None: |
@@ -949,6 +940,31 b' class InteractiveShell(Component, Magic):' | |||
|
949 | 940 | |
|
950 | 941 | return user_ns, user_global_ns |
|
951 | 942 | |
|
943 | def init_sys_modules(self): | |
|
944 | # We need to insert into sys.modules something that looks like a | |
|
945 | # module but which accesses the IPython namespace, for shelve and | |
|
946 | # pickle to work interactively. Normally they rely on getting | |
|
947 | # everything out of __main__, but for embedding purposes each IPython | |
|
948 | # instance has its own private namespace, so we can't go shoving | |
|
949 | # everything into __main__. | |
|
950 | ||
|
951 | # note, however, that we should only do this for non-embedded | |
|
952 | # ipythons, which really mimic the __main__.__dict__ with their own | |
|
953 | # namespace. Embedded instances, on the other hand, should not do | |
|
954 | # this because they need to manage the user local/global namespaces | |
|
955 | # only, but they live within a 'normal' __main__ (meaning, they | |
|
956 | # shouldn't overtake the execution environment of the script they're | |
|
957 | # embedded in). | |
|
958 | ||
|
959 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
|
960 | ||
|
961 | try: | |
|
962 | main_name = self.user_ns['__name__'] | |
|
963 | except KeyError: | |
|
964 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
|
965 | else: | |
|
966 | sys.modules[main_name] = FakeModule(self.user_ns) | |
|
967 | ||
|
952 | 968 | def init_user_ns(self): |
|
953 | 969 | """Initialize all user-visible namespaces to their minimum defaults. |
|
954 | 970 | |
@@ -961,27 +977,59 b' class InteractiveShell(Component, Magic):' | |||
|
961 | 977 | method. If they were not empty before, data will simply be added to |
|
962 | 978 | therm. |
|
963 | 979 | """ |
|
964 | # Store myself as the public api!!! | |
|
965 | self.user_ns['get_ipython'] = self.get_ipython | |
|
966 | ||
|
967 | # make global variables for user access to the histories | |
|
968 | self.user_ns['_ih'] = self.input_hist | |
|
969 | self.user_ns['_oh'] = self.output_hist | |
|
970 | self.user_ns['_dh'] = self.dir_hist | |
|
971 | ||
|
972 | # user aliases to input and output histories | |
|
973 | self.user_ns['In'] = self.input_hist | |
|
974 | self.user_ns['Out'] = self.output_hist | |
|
975 | ||
|
976 | self.user_ns['_sh'] = shadowns | |
|
980 | # This function works in two parts: first we put a few things in | |
|
981 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
|
982 | # initial variables aren't shown by %who. After the sync, we add the | |
|
983 | # rest of what we *do* want the user to see with %who even on a new | |
|
984 | # session (probably nothing, so theye really only see their own stuff) | |
|
985 | ||
|
986 | # The user dict must *always* have a __builtin__ reference to the | |
|
987 | # Python standard __builtin__ namespace, which must be imported. | |
|
988 | # This is so that certain operations in prompt evaluation can be | |
|
989 | # reliably executed with builtins. Note that we can NOT use | |
|
990 | # __builtins__ (note the 's'), because that can either be a dict or a | |
|
991 | # module, and can even mutate at runtime, depending on the context | |
|
992 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
|
993 | # always a module object, though it must be explicitly imported. | |
|
994 | ||
|
995 | # For more details: | |
|
996 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
|
997 | ns = dict(__builtin__ = __builtin__) | |
|
977 | 998 | |
|
978 | 999 | # Put 'help' in the user namespace |
|
979 | 1000 | try: |
|
980 | 1001 | from site import _Helper |
|
981 |
|
|
|
1002 | ns['help'] = _Helper() | |
|
982 | 1003 | except ImportError: |
|
983 | 1004 | warn('help() not available - check site.py') |
|
984 | 1005 | |
|
1006 | # make global variables for user access to the histories | |
|
1007 | ns['_ih'] = self.input_hist | |
|
1008 | ns['_oh'] = self.output_hist | |
|
1009 | ns['_dh'] = self.dir_hist | |
|
1010 | ||
|
1011 | ns['_sh'] = shadowns | |
|
1012 | ||
|
1013 | # user aliases to input and output histories. These shouldn't show up | |
|
1014 | # in %who, as they can have very large reprs. | |
|
1015 | ns['In'] = self.input_hist | |
|
1016 | ns['Out'] = self.output_hist | |
|
1017 | ||
|
1018 | # Store myself as the public api!!! | |
|
1019 | ns['get_ipython'] = self.get_ipython | |
|
1020 | ||
|
1021 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
|
1022 | # by %who | |
|
1023 | self.user_ns_hidden.update(ns) | |
|
1024 | ||
|
1025 | # Anything put into ns now would show up in %who. Think twice before | |
|
1026 | # putting anything here, as we really want %who to show the user their | |
|
1027 | # stuff, not our variables. | |
|
1028 | ||
|
1029 | # Finally, update the real user's namespace | |
|
1030 | self.user_ns.update(ns) | |
|
1031 | ||
|
1032 | ||
|
985 | 1033 | def reset(self): |
|
986 | 1034 | """Clear all internal namespaces. |
|
987 | 1035 | |
@@ -1045,7 +1093,7 b' class InteractiveShell(Component, Magic):' | |||
|
1045 | 1093 | self.user_ns.update(vdict) |
|
1046 | 1094 | |
|
1047 | 1095 | # And configure interactive visibility |
|
1048 |
config_ns = self.user_ |
|
|
1096 | config_ns = self.user_ns_hidden | |
|
1049 | 1097 | if interactive: |
|
1050 | 1098 | for name, val in vdict.iteritems(): |
|
1051 | 1099 | config_ns.pop(name, None) |
@@ -1099,9 +1147,6 b' class InteractiveShell(Component, Magic):' | |||
|
1099 | 1147 | def savehist(self): |
|
1100 | 1148 | """Save input history to a file (via readline library).""" |
|
1101 | 1149 | |
|
1102 | if not self.has_readline: | |
|
1103 | return | |
|
1104 | ||
|
1105 | 1150 | try: |
|
1106 | 1151 | self.readline.write_history_file(self.histfile) |
|
1107 | 1152 | except: |
@@ -1111,7 +1156,6 b' class InteractiveShell(Component, Magic):' | |||
|
1111 | 1156 | def reloadhist(self): |
|
1112 | 1157 | """Reload the input history from disk file.""" |
|
1113 | 1158 | |
|
1114 | if self.has_readline: | |
|
1115 | 1159 |
|
|
1116 | 1160 |
|
|
1117 | 1161 |
|
@@ -1124,7 +1168,9 b' class InteractiveShell(Component, Magic):' | |||
|
1124 | 1168 | Convert func into callable that saves & restores |
|
1125 | 1169 | history around the call """ |
|
1126 | 1170 | |
|
1127 |
if |
|
|
1171 | if self.has_readline: | |
|
1172 | from IPython.utils import rlineimpl as readline | |
|
1173 | else: | |
|
1128 | 1174 | return func |
|
1129 | 1175 | |
|
1130 | 1176 | def wrapper(): |
@@ -1150,36 +1196,16 b' class InteractiveShell(Component, Magic):' | |||
|
1150 | 1196 | color_scheme='NoColor', |
|
1151 | 1197 | tb_offset = 1) |
|
1152 | 1198 | |
|
1153 | # IPython itself shouldn't crash. This will produce a detailed | |
|
1154 | # post-mortem if it does. But we only install the crash handler for | |
|
1155 | # non-threaded shells, the threaded ones use a normal verbose reporter | |
|
1156 | # and lose the crash handler. This is because exceptions in the main | |
|
1157 | # thread (such as in GUI code) propagate directly to sys.excepthook, | |
|
1158 | # and there's no point in printing crash dumps for every user exception. | |
|
1159 | if self.isthreaded: | |
|
1160 | ipCrashHandler = ultratb.FormattedTB() | |
|
1161 | else: | |
|
1162 | from IPython.core import crashhandler | |
|
1163 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) | |
|
1164 | self.set_crash_handler(ipCrashHandler) | |
|
1199 | # The instance will store a pointer to the system-wide exception hook, | |
|
1200 | # so that runtime code (such as magics) can access it. This is because | |
|
1201 | # during the read-eval loop, it may get temporarily overwritten. | |
|
1202 | self.sys_excepthook = sys.excepthook | |
|
1165 | 1203 | |
|
1166 | 1204 | # and add any custom exception handlers the user may have specified |
|
1167 | 1205 | self.set_custom_exc(*custom_exceptions) |
|
1168 | 1206 | |
|
1169 | def set_crash_handler(self, crashHandler): | |
|
1170 | """Set the IPython crash handler. | |
|
1171 | ||
|
1172 | This must be a callable with a signature suitable for use as | |
|
1173 | sys.excepthook.""" | |
|
1174 | ||
|
1175 | # Install the given crash handler as the Python exception hook | |
|
1176 | sys.excepthook = crashHandler | |
|
1177 | ||
|
1178 | # The instance will store a pointer to this, so that runtime code | |
|
1179 | # (such as magics) can access it. This is because during the | |
|
1180 | # read-eval loop, it gets temporarily overwritten (to deal with GUI | |
|
1181 | # frameworks). | |
|
1182 | self.sys_excepthook = sys.excepthook | |
|
1207 | # Set the exception mode | |
|
1208 | self.InteractiveTB.set_mode(mode=self.xmode) | |
|
1183 | 1209 | |
|
1184 | 1210 | def set_custom_exc(self,exc_tuple,handler): |
|
1185 | 1211 | """set_custom_exc(exc_tuple,handler) |
@@ -1248,7 +1274,8 b' class InteractiveShell(Component, Magic):' | |||
|
1248 | 1274 | """ |
|
1249 | 1275 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1250 | 1276 | |
|
1251 |
def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None |
|
|
1277 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None, | |
|
1278 | exception_only=False): | |
|
1252 | 1279 | """Display the exception that just occurred. |
|
1253 | 1280 | |
|
1254 | 1281 | If nothing is known about the exception, this is the method which |
@@ -1260,17 +1287,23 b' class InteractiveShell(Component, Magic):' | |||
|
1260 | 1287 | SyntaxError exception, don't try to analyze the stack manually and |
|
1261 | 1288 | simply call this method.""" |
|
1262 | 1289 | |
|
1263 | ||
|
1264 | # Though this won't be called by syntax errors in the input line, | |
|
1265 | # there may be SyntaxError cases whith imported code. | |
|
1266 | ||
|
1267 | 1290 | try: |
|
1268 | 1291 | if exc_tuple is None: |
|
1269 | 1292 | etype, value, tb = sys.exc_info() |
|
1270 | 1293 | else: |
|
1271 | 1294 | etype, value, tb = exc_tuple |
|
1272 | 1295 | |
|
1296 | if etype is None: | |
|
1297 | if hasattr(sys, 'last_type'): | |
|
1298 | etype, value, tb = sys.last_type, sys.last_value, \ | |
|
1299 | sys.last_traceback | |
|
1300 | else: | |
|
1301 | self.write('No traceback available to show.\n') | |
|
1302 | return | |
|
1303 | ||
|
1273 | 1304 | if etype is SyntaxError: |
|
1305 | # Though this won't be called by syntax errors in the input | |
|
1306 | # line, there may be SyntaxError cases whith imported code. | |
|
1274 | 1307 | self.showsyntaxerror(filename) |
|
1275 | 1308 | elif etype is UsageError: |
|
1276 | 1309 | print "UsageError:", value |
@@ -1286,13 +1319,21 b' class InteractiveShell(Component, Magic):' | |||
|
1286 | 1319 | if etype in self.custom_exceptions: |
|
1287 | 1320 | self.CustomTB(etype,value,tb) |
|
1288 | 1321 | else: |
|
1322 | if exception_only: | |
|
1323 | m = ('An exception has occurred, use %tb to see the ' | |
|
1324 | 'full traceback.') | |
|
1325 | print m | |
|
1326 | self.InteractiveTB.show_exception_only(etype, value) | |
|
1327 | else: | |
|
1289 | 1328 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1290 |
if self.InteractiveTB.call_pdb |
|
|
1329 | if self.InteractiveTB.call_pdb: | |
|
1291 | 1330 | # pdb mucks up readline, fix it back |
|
1292 | 1331 | self.set_completer() |
|
1332 | ||
|
1293 | 1333 | except KeyboardInterrupt: |
|
1294 | 1334 | self.write("\nKeyboardInterrupt\n") |
|
1295 | 1335 | |
|
1336 | ||
|
1296 | 1337 | def showsyntaxerror(self, filename=None): |
|
1297 | 1338 | """Display the syntax error that just occurred. |
|
1298 | 1339 | |
@@ -1304,7 +1345,7 b' class InteractiveShell(Component, Magic):' | |||
|
1304 | 1345 | """ |
|
1305 | 1346 | etype, value, last_traceback = sys.exc_info() |
|
1306 | 1347 | |
|
1307 |
# See note about these variables in showtraceback() |
|
|
1348 | # See note about these variables in showtraceback() above | |
|
1308 | 1349 | sys.last_type = etype |
|
1309 | 1350 | sys.last_value = value |
|
1310 | 1351 | sys.last_traceback = last_traceback |
@@ -1464,20 +1505,25 b' class InteractiveShell(Component, Magic):' | |||
|
1464 | 1505 | def init_readline(self): |
|
1465 | 1506 | """Command history completion/saving/reloading.""" |
|
1466 | 1507 | |
|
1508 | if self.readline_use: | |
|
1509 | import IPython.utils.rlineimpl as readline | |
|
1510 | ||
|
1467 | 1511 | self.rl_next_input = None |
|
1468 | 1512 | self.rl_do_indent = False |
|
1469 | 1513 | |
|
1470 | if not self.readline_use: | |
|
1471 | return | |
|
1472 | ||
|
1473 | import IPython.utils.rlineimpl as readline | |
|
1474 | ||
|
1475 | if not readline.have_readline: | |
|
1476 | self.has_readline = 0 | |
|
1514 | if not self.readline_use or not readline.have_readline: | |
|
1515 | self.has_readline = False | |
|
1477 | 1516 | self.readline = None |
|
1478 | # no point in bugging windows users with this every time: | |
|
1479 | warn('Readline services not available on this platform.') | |
|
1517 | # Set a number of methods that depend on readline to be no-op | |
|
1518 | self.savehist = no_op | |
|
1519 | self.reloadhist = no_op | |
|
1520 | self.set_completer = no_op | |
|
1521 | self.set_custom_completer = no_op | |
|
1522 | self.set_completer_frame = no_op | |
|
1523 | warn('Readline services not available or not loaded.') | |
|
1480 | 1524 | else: |
|
1525 | self.has_readline = True | |
|
1526 | self.readline = readline | |
|
1481 | 1527 | sys.modules['readline'] = readline |
|
1482 | 1528 | import atexit |
|
1483 | 1529 | from IPython.core.completer import IPCompleter |
@@ -1512,8 +1558,6 b' class InteractiveShell(Component, Magic):' | |||
|
1512 | 1558 | warn('Problems reading readline initialization file <%s>' |
|
1513 | 1559 | % inputrc_name) |
|
1514 | 1560 | |
|
1515 | self.has_readline = 1 | |
|
1516 | self.readline = readline | |
|
1517 | 1561 | # save this in sys so embedded copies can restore it properly |
|
1518 | 1562 | sys.ipcompleter = self.Completer.complete |
|
1519 | 1563 | self.set_completer() |
@@ -1585,6 +1629,9 b' class InteractiveShell(Component, Magic):' | |||
|
1585 | 1629 | # Set user colors (don't do it in the constructor above so that it |
|
1586 | 1630 | # doesn't crash if colors option is invalid) |
|
1587 | 1631 | self.magic_colors(self.colors) |
|
1632 | # History was moved to a separate module | |
|
1633 | from . import history | |
|
1634 | history.init_ipython(self) | |
|
1588 | 1635 | |
|
1589 | 1636 | def magic(self,arg_s): |
|
1590 | 1637 | """Call a magic function by name. |
@@ -1603,7 +1650,6 b' class InteractiveShell(Component, Magic):' | |||
|
1603 | 1650 | valid Python code you can type at the interpreter, including loops and |
|
1604 | 1651 | compound statements. |
|
1605 | 1652 | """ |
|
1606 | ||
|
1607 | 1653 | args = arg_s.split(' ',1) |
|
1608 | 1654 | magic_name = args[0] |
|
1609 | 1655 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
@@ -1842,6 +1888,7 b' class InteractiveShell(Component, Magic):' | |||
|
1842 | 1888 | except EOFError: |
|
1843 | 1889 | if self.autoindent: |
|
1844 | 1890 | self.rl_do_indent = False |
|
1891 | if self.has_readline: | |
|
1845 | 1892 | self.readline_startup_hook(None) |
|
1846 | 1893 | self.write('\n') |
|
1847 | 1894 | self.exit() |
@@ -1863,6 +1910,9 b' class InteractiveShell(Component, Magic):' | |||
|
1863 | 1910 | # We are off again... |
|
1864 | 1911 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1865 | 1912 | |
|
1913 | # Turn off the exit flag, so the mainloop can be restarted if desired | |
|
1914 | self.exit_now = False | |
|
1915 | ||
|
1866 | 1916 | def safe_execfile(self, fname, *where, **kw): |
|
1867 | 1917 | """A safe version of the builtin execfile(). |
|
1868 | 1918 | |
@@ -1878,7 +1928,8 b' class InteractiveShell(Component, Magic):' | |||
|
1878 | 1928 | One or two namespaces, passed to execfile() as (globals,locals). |
|
1879 | 1929 | If only one is given, it is passed as both. |
|
1880 | 1930 | exit_ignore : bool (False) |
|
1881 |
If True, then |
|
|
1931 | If True, then silence SystemExit for non-zero status (it is always | |
|
1932 | silenced for zero status, as it is so common). | |
|
1882 | 1933 | """ |
|
1883 | 1934 | kw.setdefault('exit_ignore', False) |
|
1884 | 1935 | |
@@ -1903,40 +1954,21 b' class InteractiveShell(Component, Magic):' | |||
|
1903 | 1954 | |
|
1904 | 1955 | with prepended_to_syspath(dname): |
|
1905 | 1956 | try: |
|
1906 | if sys.platform == 'win32' and sys.version_info < (2,5,1): | |
|
1907 | # Work around a bug in Python for Windows. The bug was | |
|
1908 | # fixed in in Python 2.5 r54159 and 54158, but that's still | |
|
1909 | # SVN Python as of March/07. For details, see: | |
|
1910 | # http://projects.scipy.org/ipython/ipython/ticket/123 | |
|
1911 | try: | |
|
1912 | globs,locs = where[0:2] | |
|
1913 | except: | |
|
1914 | try: | |
|
1915 | globs = locs = where[0] | |
|
1916 | except: | |
|
1917 | globs = locs = globals() | |
|
1918 | exec file(fname) in globs,locs | |
|
1919 | else: | |
|
1920 | 1957 |
|
|
1921 | except SyntaxError: | |
|
1922 | self.showsyntaxerror() | |
|
1923 | warn('Failure executing file: <%s>' % fname) | |
|
1924 | 1958 | except SystemExit, status: |
|
1925 | # Code that correctly sets the exit status flag to success (0) | |
|
1926 |
# |
|
|
1927 | # sys.exit() does NOT set the message to 0 (it's empty) so that | |
|
1928 | # will still get a traceback. Note that the structure of the | |
|
1929 | # SystemExit exception changed between Python 2.4 and 2.5, so | |
|
1930 | # the checks must be done in a version-dependent way. | |
|
1931 |
|
|
|
1932 | if status.args[0]==0 and not kw['exit_ignore']: | |
|
1933 | show = True | |
|
1934 | if show: | |
|
1935 | self.showtraceback() | |
|
1936 | warn('Failure executing file: <%s>' % fname) | |
|
1959 | # If the call was made with 0 or None exit status (sys.exit(0) | |
|
1960 | # or sys.exit() ), don't bother showing a traceback, as both of | |
|
1961 | # these are considered normal by the OS: | |
|
1962 | # > python -c'import sys;sys.exit(0)'; echo $? | |
|
1963 | # 0 | |
|
1964 | # > python -c'import sys;sys.exit()'; echo $? | |
|
1965 | # 0 | |
|
1966 | # For other exit status, we show the exception unless | |
|
1967 | # explicitly silenced, but only in short form. | |
|
1968 | if status.code not in (0, None) and not kw['exit_ignore']: | |
|
1969 | self.showtraceback(exception_only=True) | |
|
1937 | 1970 | except: |
|
1938 | 1971 | self.showtraceback() |
|
1939 | warn('Failure executing file: <%s>' % fname) | |
|
1940 | 1972 | |
|
1941 | 1973 | def safe_execfile_ipy(self, fname): |
|
1942 | 1974 | """Like safe_execfile, but for .ipy files with IPython syntax. |
@@ -2150,9 +2182,8 b' class InteractiveShell(Component, Magic):' | |||
|
2150 | 2182 | sys.excepthook = old_excepthook |
|
2151 | 2183 | except SystemExit: |
|
2152 | 2184 | self.resetbuffer() |
|
2153 | self.showtraceback() | |
|
2154 | warn("Type %exit or %quit to exit IPython " | |
|
2155 | "(%Exit or %Quit do so unconditionally).",level=1) | |
|
2185 | self.showtraceback(exception_only=True) | |
|
2186 | warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1) | |
|
2156 | 2187 | except self.custom_exceptions: |
|
2157 | 2188 | etype,value,tb = sys.exc_info() |
|
2158 | 2189 | self.CustomTB(etype,value,tb) |
@@ -2329,6 +2360,9 b' class InteractiveShell(Component, Magic):' | |||
|
2329 | 2360 | to make it easy to write extensions, you can also put your extensions |
|
2330 | 2361 | in ``os.path.join(self.ipython_dir, 'extensions')``. This directory |
|
2331 | 2362 | is added to ``sys.path`` automatically. |
|
2363 | ||
|
2364 | If :func:`load_ipython_extension` returns anything, this function | |
|
2365 | will return that object. | |
|
2332 | 2366 | """ |
|
2333 | 2367 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
2334 | 2368 | |
@@ -2336,7 +2370,7 b' class InteractiveShell(Component, Magic):' | |||
|
2336 | 2370 | with prepended_to_syspath(self.ipython_extension_dir): |
|
2337 | 2371 | __import__(module_str) |
|
2338 | 2372 | mod = sys.modules[module_str] |
|
2339 | self._call_load_ipython_extension(mod) | |
|
2373 | return self._call_load_ipython_extension(mod) | |
|
2340 | 2374 | |
|
2341 | 2375 | def unload_extension(self, module_str): |
|
2342 | 2376 | """Unload an IPython extension by its module name. |
@@ -2368,11 +2402,11 b' class InteractiveShell(Component, Magic):' | |||
|
2368 | 2402 | |
|
2369 | 2403 | def _call_load_ipython_extension(self, mod): |
|
2370 | 2404 | if hasattr(mod, 'load_ipython_extension'): |
|
2371 | mod.load_ipython_extension(self) | |
|
2405 | return mod.load_ipython_extension(self) | |
|
2372 | 2406 | |
|
2373 | 2407 | def _call_unload_ipython_extension(self, mod): |
|
2374 | 2408 | if hasattr(mod, 'unload_ipython_extension'): |
|
2375 | mod.unload_ipython_extension(self) | |
|
2409 | return mod.unload_ipython_extension(self) | |
|
2376 | 2410 | |
|
2377 | 2411 | #------------------------------------------------------------------------- |
|
2378 | 2412 | # Things related to the prefilter |
@@ -2380,6 +2414,10 b' class InteractiveShell(Component, Magic):' | |||
|
2380 | 2414 | |
|
2381 | 2415 | def init_prefilter(self): |
|
2382 | 2416 | self.prefilter_manager = PrefilterManager(self, config=self.config) |
|
2417 | # Ultimately this will be refactored in the new interpreter code, but | |
|
2418 | # for now, we should expose the main prefilter method (there's legacy | |
|
2419 | # code out there that may rely on this). | |
|
2420 | self.prefilter = self.prefilter_manager.prefilter_lines | |
|
2383 | 2421 | |
|
2384 | 2422 | #------------------------------------------------------------------------- |
|
2385 | 2423 | # Utilities |
@@ -2445,11 +2483,46 b' class InteractiveShell(Component, Magic):' | |||
|
2445 | 2483 | return ask_yes_no(prompt,default) |
|
2446 | 2484 | |
|
2447 | 2485 | #------------------------------------------------------------------------- |
|
2486 | # Things related to GUI support and pylab | |
|
2487 | #------------------------------------------------------------------------- | |
|
2488 | ||
|
2489 | def enable_pylab(self, gui=None): | |
|
2490 | """Activate pylab support at runtime. | |
|
2491 | ||
|
2492 | This turns on support for matplotlib, preloads into the interactive | |
|
2493 | namespace all of numpy and pylab, and configures IPython to correcdtly | |
|
2494 | interact with the GUI event loop. The GUI backend to be used can be | |
|
2495 | optionally selected with the optional :param:`gui` argument. | |
|
2496 | ||
|
2497 | Parameters | |
|
2498 | ---------- | |
|
2499 | gui : optional, string | |
|
2500 | ||
|
2501 | If given, dictates the choice of matplotlib GUI backend to use | |
|
2502 | (should be one of IPython's supported backends, 'tk', 'qt', 'wx' or | |
|
2503 | 'gtk'), otherwise we use the default chosen by matplotlib (as | |
|
2504 | dictated by the matplotlib build-time options plus the user's | |
|
2505 | matplotlibrc configuration file). | |
|
2506 | """ | |
|
2507 | # We want to prevent the loading of pylab to pollute the user's | |
|
2508 | # namespace as shown by the %who* magics, so we execute the activation | |
|
2509 | # code in an empty namespace, and we update *both* user_ns and | |
|
2510 | # user_ns_hidden with this information. | |
|
2511 | ns = {} | |
|
2512 | gui = pylab_activate(ns, gui) | |
|
2513 | self.user_ns.update(ns) | |
|
2514 | self.user_ns_hidden.update(ns) | |
|
2515 | # Now we must activate the gui pylab wants to use, and fix %run to take | |
|
2516 | # plot updates into account | |
|
2517 | enable_gui(gui) | |
|
2518 | self.magic_run = self._pylab_magic_run | |
|
2519 | ||
|
2520 | #------------------------------------------------------------------------- | |
|
2448 | 2521 | # Things related to IPython exiting |
|
2449 | 2522 | #------------------------------------------------------------------------- |
|
2450 | 2523 | |
|
2451 | 2524 | def ask_exit(self): |
|
2452 |
""" |
|
|
2525 | """ Ask the shell to exit. Can be overiden and used as a callback. """ | |
|
2453 | 2526 | self.exit_now = True |
|
2454 | 2527 | |
|
2455 | 2528 | def exit(self): |
@@ -7,7 +7,7 b'' | |||
|
7 | 7 | # the file COPYING, distributed as part of this software. |
|
8 | 8 | #***************************************************************************** |
|
9 | 9 | |
|
10 |
from IPython.utils. |
|
|
10 | from IPython.utils.io import Term | |
|
11 | 11 | from IPython.core.autocall import IPyAutocall |
|
12 | 12 | |
|
13 | 13 | class Macro(IPyAutocall): |
@@ -1,35 +1,33 b'' | |||
|
1 |
# |
|
|
1 | # encoding: utf-8 | |
|
2 | 2 | """Magic functions for InteractiveShell. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | #***************************************************************************** | |
|
5 | #----------------------------------------------------------------------------- | |
|
6 | 6 |
# |
|
7 |
# |
|
|
8 | # | |
|
7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> | |
|
8 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
9 | ||
|
9 | 10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 11 | # the file COPYING, distributed as part of this software. |
|
11 | #***************************************************************************** | |
|
12 | #----------------------------------------------------------------------------- | |
|
12 | 13 | |
|
13 | #**************************************************************************** | |
|
14 | # Modules and globals | |
|
14 | #----------------------------------------------------------------------------- | |
|
15 | # Imports | |
|
16 | #----------------------------------------------------------------------------- | |
|
15 | 17 | |
|
16 | # Python standard modules | |
|
17 | 18 | import __builtin__ |
|
18 | 19 | import bdb |
|
19 | 20 | import inspect |
|
20 | 21 | import os |
|
21 | import pdb | |
|
22 | import pydoc | |
|
23 | 22 | import sys |
|
24 | 23 | import shutil |
|
25 | 24 | import re |
|
26 | import tempfile | |
|
27 | 25 | import time |
|
28 | import cPickle as pickle | |
|
29 | 26 | import textwrap |
|
27 | import types | |
|
30 | 28 | from cStringIO import StringIO |
|
31 | 29 | from getopt import getopt,GetoptError |
|
32 |
from pprint import |
|
|
30 | from pprint import pformat | |
|
33 | 31 | |
|
34 | 32 | # cProfile was added in Python2.5 |
|
35 | 33 | try: |
@@ -42,26 +40,32 b' except ImportError:' | |||
|
42 | 40 | except ImportError: |
|
43 | 41 | profile = pstats = None |
|
44 | 42 | |
|
45 | # Homebrewed | |
|
46 | 43 | import IPython |
|
47 | from IPython.utils import wildcard | |
|
48 | 44 | from IPython.core import debugger, oinspect |
|
49 | 45 | from IPython.core.error import TryNext |
|
46 | from IPython.core.error import UsageError | |
|
50 | 47 | from IPython.core.fakemodule import FakeModule |
|
51 | from IPython.core.prefilter import ESC_MAGIC | |
|
52 | from IPython.external.Itpl import Itpl, itpl, printpl,itplns | |
|
53 | from IPython.utils.PyColorize import Parser | |
|
54 | from IPython.utils.ipstruct import Struct | |
|
55 | 48 | from IPython.core.macro import Macro |
|
56 | from IPython.utils.genutils import * | |
|
57 | 49 | from IPython.core.page import page |
|
58 | from IPython.utils import platutils | |
|
59 | import IPython.utils.generics | |
|
60 | from IPython.core.error import UsageError | |
|
50 | from IPython.core.prefilter import ESC_MAGIC | |
|
51 | from IPython.lib.pylabtools import mpl_runner | |
|
52 | from IPython.lib.inputhook import enable_gui | |
|
53 | from IPython.external.Itpl import itpl, printpl | |
|
61 | 54 | from IPython.testing import decorators as testdec |
|
55 | from IPython.utils.io import Term, file_read, nlprint | |
|
56 | from IPython.utils.path import get_py_filename | |
|
57 | from IPython.utils.process import arg_split, abbrev_cwd | |
|
58 | from IPython.utils.terminal import set_term_title | |
|
59 | from IPython.utils.text import LSString, SList, StringTypes | |
|
60 | from IPython.utils.timing import clock, clock2 | |
|
61 | from IPython.utils.warn import warn, error | |
|
62 | from IPython.utils.ipstruct import Struct | |
|
63 | import IPython.utils.generics | |
|
62 | 64 | |
|
63 | #*************************************************************************** | |
|
65 | #----------------------------------------------------------------------------- | |
|
64 | 66 | # Utility functions |
|
67 | #----------------------------------------------------------------------------- | |
|
68 | ||
|
65 | 69 | def on_off(tag): |
|
66 | 70 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
67 | 71 | return ['OFF','ON'][tag] |
@@ -84,6 +88,15 b' def compress_dhist(dh):' | |||
|
84 | 88 | |
|
85 | 89 | #*************************************************************************** |
|
86 | 90 | # Main class implementing Magic functionality |
|
91 | ||
|
92 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors | |
|
93 | # on construction of the main InteractiveShell object. Something odd is going | |
|
94 | # on with super() calls, Component and the MRO... For now leave it as-is, but | |
|
95 | # eventually this needs to be clarified. | |
|
96 | # BG: This is because InteractiveShell inherits from this, but is itself a | |
|
97 | # Component. This messes up the MRO in some way. The fix is that we need to | |
|
98 | # make Magic a component that InteractiveShell does not subclass. | |
|
99 | ||
|
87 | 100 | class Magic: |
|
88 | 101 | """Magic functions for InteractiveShell. |
|
89 | 102 | |
@@ -266,7 +279,7 b' python-profiler package from non-free.""")' | |||
|
266 | 279 | def arg_err(self,func): |
|
267 | 280 | """Print docstring if incorrect arguments were passed""" |
|
268 | 281 | print 'Error in arguments:' |
|
269 |
print |
|
|
282 | print oinspect.getdoc(func) | |
|
270 | 283 | |
|
271 | 284 | def format_latex(self,strng): |
|
272 | 285 | """Format a string for latex inclusion.""" |
@@ -335,7 +348,7 b' python-profiler package from non-free.""")' | |||
|
335 | 348 | raise ValueError,'incorrect mode given: %s' % mode |
|
336 | 349 | # Get options |
|
337 | 350 | list_all = kw.get('list_all',0) |
|
338 |
posix = kw.get('posix', |
|
|
351 | posix = kw.get('posix', os.name == 'posix') | |
|
339 | 352 | |
|
340 | 353 | # Check if we have more than one argument to warrant extra processing: |
|
341 | 354 | odict = {} # Dictionary with options |
@@ -873,18 +886,16 b' Currently the magic system has the following functions:\\n"""' | |||
|
873 | 886 | |
|
874 | 887 | user_ns = self.shell.user_ns |
|
875 | 888 | internal_ns = self.shell.internal_ns |
|
876 |
user_ |
|
|
877 |
out = [ |
|
|
878 | typelist = parameter_s.split() | |
|
889 | user_ns_hidden = self.shell.user_ns_hidden | |
|
890 | out = [ i for i in user_ns | |
|
891 | if not i.startswith('_') \ | |
|
892 | and not (i in internal_ns or i in user_ns_hidden) ] | |
|
879 | 893 | |
|
880 | for i in user_ns: | |
|
881 | if not (i.startswith('_') or i.startswith('_i')) \ | |
|
882 | and not (i in internal_ns or i in user_config_ns): | |
|
894 | typelist = parameter_s.split() | |
|
883 | 895 |
|
|
884 | if type(user_ns[i]).__name__ in typelist: | |
|
885 | out.append(i) | |
|
886 | else: | |
|
887 | out.append(i) | |
|
896 | typeset = set(typelist) | |
|
897 | out = [i for i in out if type(i).__name__ in typeset] | |
|
898 | ||
|
888 | 899 | out.sort() |
|
889 | 900 | return out |
|
890 | 901 | |
@@ -1161,7 +1172,7 b' Currently the magic system has the following functions:\\n"""' | |||
|
1161 | 1172 | started = logger.logstart(logfname,loghead,logmode, |
|
1162 | 1173 | log_output,timestamp,log_raw_input) |
|
1163 | 1174 | except: |
|
1164 |
|
|
|
1175 | self.shell.logfile = old_logfile | |
|
1165 | 1176 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1166 | 1177 | else: |
|
1167 | 1178 | # log input history up to this point, optionally interleaving |
@@ -1571,7 +1582,7 b' Currently the magic system has the following functions:\\n"""' | |||
|
1571 | 1582 | return |
|
1572 | 1583 | |
|
1573 | 1584 | if filename.lower().endswith('.ipy'): |
|
1574 | self.safe_execfile_ipy(filename) | |
|
1585 | self.shell.safe_execfile_ipy(filename) | |
|
1575 | 1586 | return |
|
1576 | 1587 | |
|
1577 | 1588 | # Control the response to exit() calls made by the script being run |
@@ -2523,24 +2534,14 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
2523 | 2534 | print 'Pretty printing has been turned', \ |
|
2524 | 2535 | ['OFF','ON'][self.shell.pprint] |
|
2525 | 2536 | |
|
2526 | def magic_exit(self, parameter_s=''): | |
|
2527 | """Exit IPython, confirming if configured to do so. | |
|
2528 | ||
|
2529 | You can configure whether IPython asks for confirmation upon exit by | |
|
2530 | setting the confirm_exit flag in the ipythonrc file.""" | |
|
2531 | ||
|
2532 | self.shell.exit() | |
|
2533 | ||
|
2534 | def magic_quit(self, parameter_s=''): | |
|
2535 | """Exit IPython, confirming if configured to do so (like %exit)""" | |
|
2536 | ||
|
2537 | self.shell.exit() | |
|
2538 | ||
|
2539 | 2537 | def magic_Exit(self, parameter_s=''): |
|
2540 | 2538 | """Exit IPython without confirmation.""" |
|
2541 | 2539 | |
|
2542 | 2540 | self.shell.ask_exit() |
|
2543 | 2541 | |
|
2542 | # Add aliases as magics so all common forms work: exit, quit, Exit, Quit. | |
|
2543 | magic_exit = magic_quit = magic_Quit = magic_Exit | |
|
2544 | ||
|
2544 | 2545 | #...................................................................... |
|
2545 | 2546 | # Functions to implement unix shell-type things |
|
2546 | 2547 | |
@@ -2685,11 +2686,12 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
2685 | 2686 | else: |
|
2686 | 2687 | syscmdlist.append(ff) |
|
2687 | 2688 | else: |
|
2689 | no_alias = self.shell.alias_manager.no_alias | |
|
2688 | 2690 | for pdir in path: |
|
2689 | 2691 | os.chdir(pdir) |
|
2690 | 2692 | for ff in os.listdir(pdir): |
|
2691 | 2693 | base, ext = os.path.splitext(ff) |
|
2692 |
if isexec(ff) and base.lower() not in |
|
|
2694 | if isexec(ff) and base.lower() not in no_alias: | |
|
2693 | 2695 | if ext.lower() == '.exe': |
|
2694 | 2696 | ff = base |
|
2695 | 2697 | try: |
@@ -2811,7 +2813,7 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
2811 | 2813 | try: |
|
2812 | 2814 | os.chdir(os.path.expanduser(ps)) |
|
2813 | 2815 | if self.shell.term_title: |
|
2814 |
|
|
|
2816 | set_term_title('IPython: ' + abbrev_cwd()) | |
|
2815 | 2817 | except OSError: |
|
2816 | 2818 | print sys.exc_info()[1] |
|
2817 | 2819 | else: |
@@ -2824,7 +2826,7 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
2824 | 2826 | else: |
|
2825 | 2827 | os.chdir(self.shell.home_dir) |
|
2826 | 2828 | if self.shell.term_title: |
|
2827 |
|
|
|
2829 | set_term_title('IPython: ' + '~') | |
|
2828 | 2830 | cwd = os.getcwd() |
|
2829 | 2831 | dhist = self.shell.user_ns['_dh'] |
|
2830 | 2832 | |
@@ -3399,8 +3401,6 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3399 | 3401 | your existing IPython session. |
|
3400 | 3402 | """ |
|
3401 | 3403 | |
|
3402 | # XXX - Fix this to have cleaner activate/deactivate calls. | |
|
3403 | from IPython.extensions import InterpreterPasteInput as ipaste | |
|
3404 | 3404 | from IPython.utils.ipstruct import Struct |
|
3405 | 3405 | |
|
3406 | 3406 | # Shorthands |
@@ -3423,8 +3423,6 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3423 | 3423 | |
|
3424 | 3424 | if mode == False: |
|
3425 | 3425 | # turn on |
|
3426 | ipaste.activate_prefilter() | |
|
3427 | ||
|
3428 | 3426 | oc.prompt1.p_template = '>>> ' |
|
3429 | 3427 | oc.prompt2.p_template = '... ' |
|
3430 | 3428 | oc.prompt_out.p_template = '' |
@@ -3443,8 +3441,6 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3443 | 3441 | |
|
3444 | 3442 | else: |
|
3445 | 3443 | # turn off |
|
3446 | ipaste.deactivate_prefilter() | |
|
3447 | ||
|
3448 | 3444 | oc.prompt1.p_template = shell.prompt_in1 |
|
3449 | 3445 | oc.prompt2.p_template = shell.prompt_in2 |
|
3450 | 3446 | oc.prompt_out.p_template = shell.prompt_out |
@@ -3457,7 +3453,7 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3457 | 3453 | oc.prompt1.pad_left = oc.prompt2.pad_left = \ |
|
3458 | 3454 | oc.prompt_out.pad_left = dstore.rc_prompts_pad_left |
|
3459 | 3455 | |
|
3460 |
|
|
|
3456 | shell.pprint = dstore.rc_pprint | |
|
3461 | 3457 | |
|
3462 | 3458 | shell.magic_xmode(dstore.xmode) |
|
3463 | 3459 | |
@@ -3475,7 +3471,7 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3475 | 3471 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
3476 | 3472 | can now be enabled, disabled and swtiched at runtime and keyboard |
|
3477 | 3473 | interrupts should work without any problems. The following toolkits |
|
3478 |
are support |
|
|
3474 | are supported: wxPython, PyQt4, PyGTK, and Tk:: | |
|
3479 | 3475 | |
|
3480 | 3476 | %gui wx # enable wxPython event loop integration |
|
3481 | 3477 | %gui qt4|qt # enable PyQt4 event loop integration |
@@ -3494,25 +3490,13 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3494 | 3490 | |
|
3495 | 3491 | This is highly recommended for most users. |
|
3496 | 3492 | """ |
|
3497 | from IPython.lib import inputhook | |
|
3498 | if "-a" in parameter_s: | |
|
3499 | app = True | |
|
3500 | else: | |
|
3501 | app = False | |
|
3502 | if not parameter_s: | |
|
3503 | inputhook.clear_inputhook() | |
|
3504 | elif 'wx' in parameter_s: | |
|
3505 | return inputhook.enable_wx(app) | |
|
3506 | elif ('qt4' in parameter_s) or ('qt' in parameter_s): | |
|
3507 | return inputhook.enable_qt4(app) | |
|
3508 | elif 'gtk' in parameter_s: | |
|
3509 | return inputhook.enable_gtk(app) | |
|
3510 | elif 'tk' in parameter_s: | |
|
3511 | return inputhook.enable_tk(app) | |
|
3493 | opts, arg = self.parse_options(parameter_s,'a') | |
|
3494 | if arg=='': arg = None | |
|
3495 | return enable_gui(arg, 'a' in opts) | |
|
3512 | 3496 | |
|
3513 | 3497 | def magic_load_ext(self, module_str): |
|
3514 | 3498 | """Load an IPython extension by its module name.""" |
|
3515 | self.load_extension(module_str) | |
|
3499 | return self.load_extension(module_str) | |
|
3516 | 3500 | |
|
3517 | 3501 | def magic_unload_ext(self, module_str): |
|
3518 | 3502 | """Unload an IPython extension by its module name.""" |
@@ -3522,6 +3506,7 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3522 | 3506 | """Reload an IPython extension by its module name.""" |
|
3523 | 3507 | self.reload_extension(module_str) |
|
3524 | 3508 | |
|
3509 | @testdec.skip_doctest | |
|
3525 | 3510 | def magic_install_profiles(self, s): |
|
3526 | 3511 | """Install the default IPython profiles into the .ipython dir. |
|
3527 | 3512 | |
@@ -3576,5 +3561,58 b' Defaulting color scheme to \'NoColor\'"""' | |||
|
3576 | 3561 | shutil.copy(src, dst) |
|
3577 | 3562 | print "Installing default config file: %s" % dst |
|
3578 | 3563 | |
|
3564 | # Pylab support: simple wrappers that activate pylab, load gui input | |
|
3565 | # handling and modify slightly %run | |
|
3566 | ||
|
3567 | @testdec.skip_doctest | |
|
3568 | def _pylab_magic_run(self, parameter_s=''): | |
|
3569 | Magic.magic_run(self, parameter_s, | |
|
3570 | runner=mpl_runner(self.shell.safe_execfile)) | |
|
3571 | ||
|
3572 | _pylab_magic_run.__doc__ = magic_run.__doc__ | |
|
3573 | ||
|
3574 | @testdec.skip_doctest | |
|
3575 | def magic_pylab(self, s): | |
|
3576 | """Load numpy and matplotlib to work interactively. | |
|
3577 | ||
|
3578 | %pylab [GUINAME] | |
|
3579 | ||
|
3580 | This function lets you activate pylab (matplotlib, numpy and | |
|
3581 | interactive support) at any point during an IPython session. | |
|
3582 | ||
|
3583 | It will import at the top level numpy as np, pyplot as plt, matplotlib, | |
|
3584 | pylab and mlab, as well as all names from numpy and pylab. | |
|
3585 | ||
|
3586 | Parameters | |
|
3587 | ---------- | |
|
3588 | guiname : optional | |
|
3589 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk' or | |
|
3590 | 'tk'). If given, the corresponding Matplotlib backend is used, | |
|
3591 | otherwise matplotlib's default (which you can override in your | |
|
3592 | matplotlib config file) is used. | |
|
3593 | ||
|
3594 | Examples | |
|
3595 | -------- | |
|
3596 | In this case, where the MPL default is TkAgg: | |
|
3597 | In [2]: %pylab | |
|
3598 | ||
|
3599 | Welcome to pylab, a matplotlib-based Python environment. | |
|
3600 | Backend in use: TkAgg | |
|
3601 | For more information, type 'help(pylab)'. | |
|
3602 | ||
|
3603 | But you can explicitly request a different backend: | |
|
3604 | In [3]: %pylab qt | |
|
3605 | ||
|
3606 | Welcome to pylab, a matplotlib-based Python environment. | |
|
3607 | Backend in use: Qt4Agg | |
|
3608 | For more information, type 'help(pylab)'. | |
|
3609 | """ | |
|
3610 | self.shell.enable_pylab(s) | |
|
3611 | ||
|
3612 | def magic_tb(self, s): | |
|
3613 | """Print the last traceback with the currently active exception mode. | |
|
3614 | ||
|
3615 | See %xmode for changing exception reporting modes.""" | |
|
3616 | self.shell.showtraceback() | |
|
3579 | 3617 | |
|
3580 | 3618 | # end Magic |
@@ -27,10 +27,11 b' import sys' | |||
|
27 | 27 | import types |
|
28 | 28 | |
|
29 | 29 | # IPython's own |
|
30 | from IPython.utils import PyColorize | |
|
31 | from IPython.utils.genutils import indent, Term | |
|
32 | 30 | from IPython.core.page import page |
|
33 | 31 | from IPython.external.Itpl import itpl |
|
32 | from IPython.utils import PyColorize | |
|
33 | from IPython.utils.io import Term | |
|
34 | from IPython.utils.text import indent | |
|
34 | 35 | from IPython.utils.wildcard import list_namespace |
|
35 | 36 | from IPython.utils.coloransi import * |
|
36 | 37 |
@@ -30,15 +30,15 b' rid of that dependency, we could move it there.' | |||
|
30 | 30 | import os |
|
31 | 31 | import re |
|
32 | 32 | import sys |
|
33 | import tempfile | |
|
33 | 34 | |
|
34 | 35 | from IPython.core import ipapi |
|
35 | 36 | from IPython.core.error import TryNext |
|
36 |
from IPython.utils. |
|
|
37 | chop, Term, USE_CURSES | |
|
38 | ) | |
|
39 | ||
|
40 | if os.name == "nt": | |
|
41 | from IPython.utils.winconsole import get_console_size | |
|
37 | from IPython.utils.cursesimport import use_curses | |
|
38 | from IPython.utils.data import chop | |
|
39 | from IPython.utils.io import Term | |
|
40 | from IPython.utils.process import xsys | |
|
41 | from IPython.utils.terminal import get_terminal_size | |
|
42 | 42 | |
|
43 | 43 | |
|
44 | 44 | #----------------------------------------------------------------------------- |
@@ -69,7 +69,7 b' def page_dumb(strng,start=0,screen_lines=25):' | |||
|
69 | 69 | last_escape = esc_list[-1] |
|
70 | 70 | print >>Term.cout, last_escape + os.linesep.join(screens[-1]) |
|
71 | 71 | |
|
72 | #---------------------------------------------------------------------------- | |
|
72 | ||
|
73 | 73 |
def page(strng,start=0,screen_lines=0,pager_cmd |
|
74 | 74 | """Print a string, piping through a pager after a certain length. |
|
75 | 75 | |
@@ -120,19 +120,16 b' def page(strng,start=0,screen_lines=0,pager_cmd = None):' | |||
|
120 | 120 | # terminals. If someone later feels like refining it, it's not hard. |
|
121 | 121 | numlines = max(num_newlines,int(len_str/80)+1) |
|
122 | 122 | |
|
123 | if os.name == "nt": | |
|
124 | screen_lines_def = get_console_size(defaulty=25)[1] | |
|
125 | else: | |
|
126 | screen_lines_def = 25 # default value if we can't auto-determine | |
|
123 | screen_lines_def = get_terminal_size()[1] | |
|
127 | 124 | |
|
128 | 125 | # auto-determine screen size |
|
129 | 126 | if screen_lines <= 0: |
|
130 | 127 | if TERM=='xterm' or TERM=='xterm-color': |
|
131 |
use_curses = |
|
|
128 | local_use_curses = use_curses | |
|
132 | 129 | else: |
|
133 | 130 | # curses causes problems on many terminals other than xterm. |
|
134 | use_curses = False | |
|
135 | if use_curses: | |
|
131 | local_use_curses = False | |
|
132 | if local_use_curses: | |
|
136 | 133 | import termios |
|
137 | 134 | import curses |
|
138 | 135 | # There is a bug in curses, where *sometimes* it fails to properly |
@@ -201,7 +198,7 b' def page(strng,start=0,screen_lines=0,pager_cmd = None):' | |||
|
201 | 198 | if retval is not None: |
|
202 | 199 | page_dumb(strng,screen_lines=screen_lines) |
|
203 | 200 | |
|
204 | #---------------------------------------------------------------------------- | |
|
201 | ||
|
205 | 202 |
def page_file(fname,start |
|
206 | 203 | """Page a file, using an optional pager command and starting line. |
|
207 | 204 | """ |
@@ -221,12 +218,12 b' def page_file(fname,start = 0, pager_cmd = None):' | |||
|
221 | 218 | except: |
|
222 | 219 | print 'Unable to show file',`fname` |
|
223 | 220 | |
|
224 | #---------------------------------------------------------------------------- | |
|
221 | ||
|
225 | 222 |
def get_pager_cmd(pager_cmd |
|
226 | 223 | """Return a pager command. |
|
227 | 224 | |
|
228 |
Makes some attempts at finding an OS-correct one. |
|
|
229 | ||
|
225 | Makes some attempts at finding an OS-correct one. | |
|
226 | """ | |
|
230 | 227 | if os.name == 'posix': |
|
231 | 228 | default_pager_cmd = 'less -r' # -r for color control sequences |
|
232 | 229 | elif os.name in ['nt','dos']: |
@@ -239,7 +236,7 b' def get_pager_cmd(pager_cmd = None):' | |||
|
239 | 236 | pager_cmd = default_pager_cmd |
|
240 | 237 | return pager_cmd |
|
241 | 238 | |
|
242 | #----------------------------------------------------------------------------- | |
|
239 | ||
|
243 | 240 | def get_pager_start(pager,start): |
|
244 | 241 | """Return the string for paging files with an offset. |
|
245 | 242 | |
@@ -255,8 +252,8 b' def get_pager_start(pager,start):' | |||
|
255 | 252 | start_string = '' |
|
256 | 253 | return start_string |
|
257 | 254 | |
|
258 | #---------------------------------------------------------------------------- | |
|
259 |
# (X)emacs on |
|
|
255 | ||
|
256 | # (X)emacs on win32 doesn't like to be bypassed with msvcrt.getch() | |
|
260 | 257 | if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs': |
|
261 | 258 | import msvcrt |
|
262 | 259 | def page_more(): |
@@ -280,7 +277,7 b' else:' | |||
|
280 | 277 | else: |
|
281 | 278 | return True |
|
282 | 279 | |
|
283 | #---------------------------------------------------------------------------- | |
|
280 | ||
|
284 | 281 | def snip_print(str,width = 75,print_full = 0,header = ''): |
|
285 | 282 | """Print a string snipping the midsection to fit in width. |
|
286 | 283 | |
@@ -306,3 +303,4 b" def snip_print(str,width = 75,print_full = 0,header = ''):" | |||
|
306 | 303 | if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y': |
|
307 | 304 | page(str) |
|
308 | 305 | return snip |
|
306 |
@@ -27,10 +27,7 b' Authors:' | |||
|
27 | 27 | |
|
28 | 28 | import __builtin__ |
|
29 | 29 | import codeop |
|
30 | import keyword | |
|
31 | import os | |
|
32 | 30 | import re |
|
33 | import sys | |
|
34 | 31 | |
|
35 | 32 | from IPython.core.alias import AliasManager |
|
36 | 33 | from IPython.core.autocall import IPyAutocall |
@@ -39,7 +36,8 b' from IPython.core.splitinput import split_user_input' | |||
|
39 | 36 | from IPython.core.page import page |
|
40 | 37 | |
|
41 | 38 | from IPython.utils.traitlets import List, Int, Any, Str, CBool, Bool |
|
42 |
from IPython.utils. |
|
|
39 | from IPython.utils.io import Term | |
|
40 | from IPython.utils.text import make_quoted_expr | |
|
43 | 41 | from IPython.utils.autoattr import auto_attr |
|
44 | 42 | |
|
45 | 43 | #----------------------------------------------------------------------------- |
@@ -158,7 +156,8 b' class LineInfo(object):' | |||
|
158 | 156 | without worrying about *further* damaging state. |
|
159 | 157 | """ |
|
160 | 158 | if not self._oinfo: |
|
161 | self._oinfo = ip._ofind(self.ifun) | |
|
159 | # ip.shell._ofind is actually on the Magic class! | |
|
160 | self._oinfo = ip.shell._ofind(self.ifun) | |
|
162 | 161 | return self._oinfo |
|
163 | 162 | |
|
164 | 163 | def __str__(self): |
@@ -362,7 +361,7 b' class PrefilterManager(Component):' | |||
|
362 | 361 | line = transformer.transform(line, continue_prompt) |
|
363 | 362 | return line |
|
364 | 363 | |
|
365 | def prefilter_line(self, line, continue_prompt): | |
|
364 | def prefilter_line(self, line, continue_prompt=False): | |
|
366 | 365 | """Prefilter a single input line as text. |
|
367 | 366 | |
|
368 | 367 | This method prefilters a single line of text by calling the |
@@ -416,7 +415,7 b' class PrefilterManager(Component):' | |||
|
416 | 415 | # print "prefiltered line: %r" % prefiltered |
|
417 | 416 | return prefiltered |
|
418 | 417 | |
|
419 | def prefilter_lines(self, lines, continue_prompt): | |
|
418 | def prefilter_lines(self, lines, continue_prompt=False): | |
|
420 | 419 | """Prefilter multiple input lines of text. |
|
421 | 420 | |
|
422 | 421 | This is the main entry point for prefiltering multiple lines of |
@@ -427,11 +426,19 b' class PrefilterManager(Component):' | |||
|
427 | 426 | which is the case when the user goes back to a multiline history |
|
428 | 427 | entry and presses enter. |
|
429 | 428 | """ |
|
430 | out = [] | |
|
431 | for line in lines.rstrip('\n').split('\n'): | |
|
432 | out.append(self.prefilter_line(line, continue_prompt)) | |
|
433 | return '\n'.join(out) | |
|
429 | llines = lines.rstrip('\n').split('\n') | |
|
430 | # We can get multiple lines in one shot, where multiline input 'blends' | |
|
431 | # into one line, in cases like recalling from the readline history | |
|
432 | # buffer. We need to make sure that in such cases, we correctly | |
|
433 | # communicate downstream which line is first and which are continuation | |
|
434 | # ones. | |
|
435 | if len(llines) > 1: | |
|
436 | out = '\n'.join([self.prefilter_line(line, lnum>0) | |
|
437 | for lnum, line in enumerate(llines) ]) | |
|
438 | else: | |
|
439 | out = self.prefilter_line(llines[0], continue_prompt) | |
|
434 | 440 | |
|
441 | return out | |
|
435 | 442 | |
|
436 | 443 | #----------------------------------------------------------------------------- |
|
437 | 444 | # Prefilter transformers |
@@ -508,6 +515,47 b' class AssignMagicTransformer(PrefilterTransformer):' | |||
|
508 | 515 | return line |
|
509 | 516 | |
|
510 | 517 | |
|
518 | _classic_prompt_re = re.compile(r'(^[ \t]*>>> |^[ \t]*\.\.\. )') | |
|
519 | ||
|
520 | class PyPromptTransformer(PrefilterTransformer): | |
|
521 | """Handle inputs that start with '>>> ' syntax.""" | |
|
522 | ||
|
523 | priority = Int(50, config=True) | |
|
524 | ||
|
525 | def transform(self, line, continue_prompt): | |
|
526 | ||
|
527 | if not line or line.isspace() or line.strip() == '...': | |
|
528 | # This allows us to recognize multiple input prompts separated by | |
|
529 | # blank lines and pasted in a single chunk, very common when | |
|
530 | # pasting doctests or long tutorial passages. | |
|
531 | return '' | |
|
532 | m = _classic_prompt_re.match(line) | |
|
533 | if m: | |
|
534 | return line[len(m.group(0)):] | |
|
535 | else: | |
|
536 | return line | |
|
537 | ||
|
538 | ||
|
539 | _ipy_prompt_re = re.compile(r'(^[ \t]*In \[\d+\]: |^[ \t]*\ \ \ \.\.\.+: )') | |
|
540 | ||
|
541 | class IPyPromptTransformer(PrefilterTransformer): | |
|
542 | """Handle inputs that start classic IPython prompt syntax.""" | |
|
543 | ||
|
544 | priority = Int(50, config=True) | |
|
545 | ||
|
546 | def transform(self, line, continue_prompt): | |
|
547 | ||
|
548 | if not line or line.isspace() or line.strip() == '...': | |
|
549 | # This allows us to recognize multiple input prompts separated by | |
|
550 | # blank lines and pasted in a single chunk, very common when | |
|
551 | # pasting doctests or long tutorial passages. | |
|
552 | return '' | |
|
553 | m = _ipy_prompt_re.match(line) | |
|
554 | if m: | |
|
555 | return line[len(m.group(0)):] | |
|
556 | else: | |
|
557 | return line | |
|
558 | ||
|
511 | 559 | #----------------------------------------------------------------------------- |
|
512 | 560 | # Prefilter checkers |
|
513 | 561 | #----------------------------------------------------------------------------- |
@@ -755,9 +803,17 b' class PrefilterHandler(Component):' | |||
|
755 | 803 | line = line_info.line |
|
756 | 804 | continue_prompt = line_info.continue_prompt |
|
757 | 805 | |
|
758 | if (continue_prompt and self.shell.autoindent and line.isspace() and | |
|
759 | (0 < abs(len(line) - self.shell.indent_current_nsp) <= 2 or | |
|
760 |
|
|
|
806 | if (continue_prompt and | |
|
807 | self.shell.autoindent and | |
|
808 | line.isspace() and | |
|
809 | ||
|
810 | (0 < abs(len(line) - self.shell.indent_current_nsp) <= 2 | |
|
811 | or | |
|
812 | not self.shell.buffer | |
|
813 | or | |
|
814 | (self.shell.buffer[-1]).isspace() | |
|
815 | ) | |
|
816 | ): | |
|
761 | 817 | line = '' |
|
762 | 818 | |
|
763 | 819 | self.shell.log(line, line, continue_prompt) |
@@ -845,12 +901,11 b' class AutoHandler(PrefilterHandler):' | |||
|
845 | 901 | pre = line_info.pre |
|
846 | 902 | continue_prompt = line_info.continue_prompt |
|
847 | 903 | obj = line_info.ofind(self)['obj'] |
|
848 | ||
|
849 | 904 | #print 'pre <%s> ifun <%s> rest <%s>' % (pre,ifun,the_rest) # dbg |
|
850 | 905 | |
|
851 | 906 | # This should only be active for single-line input! |
|
852 | 907 | if continue_prompt: |
|
853 | self.log(line,line,continue_prompt) | |
|
908 | self.shell.log(line,line,continue_prompt) | |
|
854 | 909 | return line |
|
855 | 910 | |
|
856 | 911 | force_auto = isinstance(obj, IPyAutocall) |
@@ -967,7 +1022,9 b' class EmacsHandler(PrefilterHandler):' | |||
|
967 | 1022 | |
|
968 | 1023 | _default_transformers = [ |
|
969 | 1024 | AssignSystemTransformer, |
|
970 | AssignMagicTransformer | |
|
1025 | AssignMagicTransformer, | |
|
1026 | PyPromptTransformer, | |
|
1027 | IPyPromptTransformer, | |
|
971 | 1028 | ] |
|
972 | 1029 | |
|
973 | 1030 | _default_checkers = [ |
@@ -992,4 +1049,3 b' _default_handlers = [' | |||
|
992 | 1049 | HelpHandler, |
|
993 | 1050 | EmacsHandler |
|
994 | 1051 | ] |
|
995 |
@@ -12,23 +12,20 b' Classes for handling input/output prompts.' | |||
|
12 | 12 | #***************************************************************************** |
|
13 | 13 | |
|
14 | 14 | #**************************************************************************** |
|
15 | # Required modules | |
|
15 | ||
|
16 | 16 | import __builtin__ |
|
17 | 17 | import os |
|
18 | import re | |
|
18 | 19 | import socket |
|
19 | 20 | import sys |
|
20 | import time | |
|
21 | 21 | |
|
22 | # IPython's own | |
|
23 | from IPython.utils import coloransi | |
|
24 | 22 | from IPython.core import release |
|
25 | 23 | from IPython.external.Itpl import ItplNS |
|
26 | 24 | from IPython.core.error import TryNext |
|
27 |
from IPython.utils |
|
|
28 | from IPython.core.macro import Macro | |
|
25 | from IPython.utils import coloransi | |
|
29 | 26 | import IPython.utils.generics |
|
30 | ||
|
31 |
from IPython.utils. |
|
|
27 | from IPython.utils.warn import warn | |
|
28 | from IPython.utils.io import Term | |
|
32 | 29 | |
|
33 | 30 | #**************************************************************************** |
|
34 | 31 | #Color schemes for Prompts. |
@@ -131,8 +128,14 b' prompt_specials_color = {' | |||
|
131 | 128 | # Prompt/history count, with the actual digits replaced by dots. Used |
|
132 | 129 | # mainly in continuation prompts (prompt_in2) |
|
133 | 130 | #r'\D': '${"."*len(str(self.cache.prompt_count))}', |
|
134 | # More robust form of the above expression, that uses __builtins__ | |
|
135 | r'\D': '${"."*__builtins__.len(__builtins__.str(self.cache.prompt_count))}', | |
|
131 | ||
|
132 | # More robust form of the above expression, that uses the __builtin__ | |
|
133 | # module. Note that we can NOT use __builtins__ (note the 's'), because | |
|
134 | # that can either be a dict or a module, and can even mutate at runtime, | |
|
135 | # depending on the context (Python makes no guarantees on it). In | |
|
136 | # contrast, __builtin__ is always a module object, though it must be | |
|
137 | # explicitly imported. | |
|
138 | r'\D': '${"."*__builtin__.len(__builtin__.str(self.cache.prompt_count))}', | |
|
136 | 139 | |
|
137 | 140 | # Current working directory |
|
138 | 141 | r'\w': '${os.getcwd()}', |
@@ -215,6 +218,7 b' def str_safe(arg):' | |||
|
215 | 218 | out = '<ERROR: %s>' % msg |
|
216 | 219 | except Exception,msg: |
|
217 | 220 | out = '<ERROR: %s>' % msg |
|
221 | #raise # dbg | |
|
218 | 222 | return out |
|
219 | 223 | |
|
220 | 224 | class BasePrompt(object): |
@@ -549,15 +553,20 b' class CachedOutput:' | |||
|
549 | 553 | # print "Got prompt: ", outprompt |
|
550 | 554 | if self.do_full_cache: |
|
551 | 555 | cout_write(outprompt) |
|
552 | else: | |
|
553 | print "self.do_full_cache = False" | |
|
554 | 556 | |
|
555 | # and now call a possibly user-defined print mechanism | |
|
557 | # and now call a possibly user-defined print mechanism. Note that | |
|
558 | # self.display typically prints as a side-effect, we don't do any | |
|
559 | # printing to stdout here. | |
|
560 | try: | |
|
556 | 561 | manipulated_val = self.display(arg) |
|
562 | except TypeError: | |
|
563 | # If the user's display hook didn't return a string we can | |
|
564 | # print, we're done. Happens commonly if they return None | |
|
565 | cout_write('\n') | |
|
566 | return | |
|
557 | 567 | |
|
558 | 568 | # user display hooks can change the variable to be stored in |
|
559 | 569 | # output history |
|
560 | ||
|
561 | 570 | if manipulated_val is not None: |
|
562 | 571 | arg = manipulated_val |
|
563 | 572 |
@@ -1,10 +1,10 b'' | |||
|
1 | #!/usr/bin/env python | |
|
2 | # encoding: utf-8 | |
|
1 | # coding: utf-8 | |
|
3 | 2 | """ |
|
4 | 3 | A simple class for quitting IPython. |
|
5 | 4 | |
|
6 |
Authors |
|
|
7 | ||
|
5 | Authors | |
|
6 | ------- | |
|
7 | * Fernando Perez | |
|
8 | 8 | * Brian Granger |
|
9 | 9 | """ |
|
10 | 10 | |
@@ -20,6 +20,11 b' Authors:' | |||
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | |
|
23 | #----------------------------------------------------------------------------- | |
|
24 | # Code | |
|
25 | #----------------------------------------------------------------------------- | |
|
26 | ||
|
27 | ||
|
23 | 28 | class Quitter(object): |
|
24 | 29 | """Simple class to handle exit, similar to Python 2.5's. |
|
25 | 30 | |
@@ -30,9 +35,13 b' class Quitter(object):' | |||
|
30 | 35 | self.shell = shell |
|
31 | 36 | self.name = name |
|
32 | 37 | |
|
33 |
def __ |
|
|
38 | def __str__(self): | |
|
34 | 39 | return 'Type %s() to exit.' % self.name |
|
35 | __str__ = __repr__ | |
|
36 | 40 | |
|
37 | 41 | def __call__(self): |
|
38 | self.shell.exit() No newline at end of file | |
|
42 | self.shell.ask_exit() | |
|
43 | ||
|
44 | # Repr MUST return a string, else display like pprint hooks get confused | |
|
45 | def __repr__(self): | |
|
46 | self.shell.ask_exit() | |
|
47 | return '' |
@@ -23,7 +23,7 b" name = 'ipython'" | |||
|
23 | 23 | development = True # change this to False to do a release |
|
24 | 24 | version_base = '0.11' |
|
25 | 25 | branch = 'ipython' |
|
26 |
revision = '1 |
|
|
26 | revision = '1363' | |
|
27 | 27 | |
|
28 | 28 | if development: |
|
29 | 29 | if branch == 'ipython': |
@@ -1,22 +1,19 b'' | |||
|
1 | """Simple script to instantiate a class for testing %run""" | |
|
1 | """Simple script to be run *twice*, to check reference counting bugs. | |
|
2 | 2 |
|
|
3 | import sys | |
|
4 | ||
|
5 | # An external test will check that calls to f() work after %run | |
|
6 | class foo: pass | |
|
3 | See test_run for details.""" | |
|
7 | 4 | |
|
8 | def f(): | |
|
9 | return foo() | |
|
5 | import sys | |
|
10 | 6 | |
|
11 |
# We |
|
|
12 |
# |
|
|
13 |
# a |
|
|
7 | # We want to ensure that while objects remain available for immediate access, | |
|
8 | # objects from *previous* runs of the same script get collected, to avoid | |
|
9 | # accumulating massive amounts of old references. | |
|
14 | 10 | class C(object): |
|
15 | 11 | def __init__(self,name): |
|
16 | 12 | self.name = name |
|
17 | 13 | |
|
18 | 14 | def __del__(self): |
|
19 | 15 | print 'tclass.py: deleting object:',self.name |
|
16 | sys.stdout.flush() | |
|
20 | 17 | |
|
21 | 18 | try: |
|
22 | 19 | name = sys.argv[1] |
@@ -25,3 +22,10 b' except IndexError:' | |||
|
25 | 22 | else: |
|
26 | 23 | if name.startswith('C'): |
|
27 | 24 | c = C(name) |
|
25 | ||
|
26 | #print >> sys.stderr, "ARGV:", sys.argv # dbg | |
|
27 | ||
|
28 | # This next print statement is NOT debugging, we're making the check on a | |
|
29 | # completely separate process so we verify by capturing stdout: | |
|
30 | print 'ARGV 1-:', sys.argv[1:] | |
|
31 | sys.stdout.flush() |
@@ -13,45 +13,233 b' import tempfile' | |||
|
13 | 13 | import nose.tools as nt |
|
14 | 14 | |
|
15 | 15 | # our own packages |
|
16 | from IPython.core import iplib | |
|
17 | from IPython.core import ipapi | |
|
18 | ||
|
16 | from IPython.testing import decorators as dec | |
|
17 | from IPython.testing.globalipapp import get_ipython | |
|
19 | 18 | |
|
20 | 19 | #----------------------------------------------------------------------------- |
|
21 | 20 | # Globals |
|
22 | 21 | #----------------------------------------------------------------------------- |
|
23 | 22 | |
|
24 | # Useful global ipapi object and main IPython one. Unfortunately we have a | |
|
25 | # long precedent of carrying the 'ipapi' global object which is injected into | |
|
26 | # the system namespace as _ip, but that keeps a pointer to the actual IPython | |
|
27 | # InteractiveShell instance, which is named IP. Since in testing we do need | |
|
28 | # access to the real thing (we want to probe beyond what ipapi exposes), make | |
|
29 | # here a global reference to each. In general, things that are exposed by the | |
|
30 | # ipapi instance should be read from there, but we also will often need to use | |
|
31 | # the actual IPython one. | |
|
32 | ||
|
33 | # Get the public instance of IPython, and if it's None, make one so we can use | |
|
34 | # it for testing | |
|
35 | ip = ipapi.get() | |
|
36 | if ip is None: | |
|
37 | # IPython not running yet, make one from the testing machinery for | |
|
38 | # consistency when the test suite is being run via iptest | |
|
39 | from IPython.testing.plugin import ipdoctest | |
|
40 | ip = ipapi.get() | |
|
23 | # Get the public instance of IPython | |
|
24 | ip = get_ipython() | |
|
41 | 25 | |
|
42 | 26 | #----------------------------------------------------------------------------- |
|
43 | 27 | # Test functions |
|
44 | 28 | #----------------------------------------------------------------------------- |
|
45 | 29 | |
|
30 | @dec.parametric | |
|
46 | 31 | def test_reset(): |
|
47 | 32 | """reset must clear most namespaces.""" |
|
48 | ip.reset() # first, it should run without error | |
|
49 | # Then, check that most namespaces end up empty | |
|
33 | # The number of variables in the private user_ns_hidden is not zero, but it | |
|
34 | # should be constant regardless of what we do | |
|
35 | nvars_config_ns = len(ip.user_ns_hidden) | |
|
36 | ||
|
37 | # Check that reset runs without error | |
|
38 | ip.reset() | |
|
39 | ||
|
40 | # Once we've reset it (to clear of any junk that might have been there from | |
|
41 | # other tests, we can count how many variables are in the user's namespace | |
|
42 | nvars_user_ns = len(ip.user_ns) | |
|
43 | ||
|
44 | # Now add a few variables to user_ns, and check that reset clears them | |
|
45 | ip.user_ns['x'] = 1 | |
|
46 | ip.user_ns['y'] = 1 | |
|
47 | ip.reset() | |
|
48 | ||
|
49 | # Finally, check that all namespaces have only as many variables as we | |
|
50 | # expect to find in them: | |
|
50 | 51 | for ns in ip.ns_refs_table: |
|
51 | 52 | if ns is ip.user_ns: |
|
52 | # The user namespace is reset with some data, so we can't check for | |
|
53 | # it being empty | |
|
54 | continue | |
|
55 | nt.assert_equals(len(ns),0) | |
|
53 | nvars_expected = nvars_user_ns | |
|
54 | elif ns is ip.user_ns_hidden: | |
|
55 | nvars_expected = nvars_config_ns | |
|
56 | else: | |
|
57 | nvars_expected = 0 | |
|
58 | ||
|
59 | yield nt.assert_equals(len(ns), nvars_expected) | |
|
60 | ||
|
61 | ||
|
62 | # Tests for reporting of exceptions in various modes, handling of SystemExit, | |
|
63 | # and %tb functionality. This is really a mix of testing ultraTB and iplib. | |
|
56 | 64 | |
|
65 | def doctest_tb_plain(): | |
|
66 | """ | |
|
67 | In [18]: xmode plain | |
|
68 | Exception reporting mode: Plain | |
|
69 | ||
|
70 | In [19]: run simpleerr.py | |
|
71 | Traceback (most recent call last): | |
|
72 | ...line 32, in <module> | |
|
73 | bar(mode) | |
|
74 | ...line 16, in bar | |
|
75 | div0() | |
|
76 | ...line 8, in div0 | |
|
77 | x/y | |
|
78 | ZeroDivisionError: integer division or modulo by zero | |
|
79 | """ | |
|
80 | ||
|
81 | ||
|
82 | def doctest_tb_context(): | |
|
83 | """ | |
|
84 | In [3]: xmode context | |
|
85 | Exception reporting mode: Context | |
|
86 | ||
|
87 | In [4]: run simpleerr.py | |
|
88 | --------------------------------------------------------------------------- | |
|
89 | ZeroDivisionError Traceback (most recent call last) | |
|
90 | <BLANKLINE> | |
|
91 | ... in <module>() | |
|
92 | 30 mode = 'div' | |
|
93 | 31 | |
|
94 | ---> 32 bar(mode) | |
|
95 | 33 | |
|
96 | 34 | |
|
97 | <BLANKLINE> | |
|
98 | ... in bar(mode) | |
|
99 | 14 "bar" | |
|
100 | 15 if mode=='div': | |
|
101 | ---> 16 div0() | |
|
102 | 17 elif mode=='exit': | |
|
103 | 18 try: | |
|
104 | <BLANKLINE> | |
|
105 | ... in div0() | |
|
106 | 6 x = 1 | |
|
107 | 7 y = 0 | |
|
108 | ----> 8 x/y | |
|
109 | 9 | |
|
110 | 10 def sysexit(stat, mode): | |
|
111 | <BLANKLINE> | |
|
112 | ZeroDivisionError: integer division or modulo by zero | |
|
113 | """ | |
|
57 | 114 | |
|
115 | ||
|
116 | def doctest_tb_verbose(): | |
|
117 | """ | |
|
118 | In [5]: xmode verbose | |
|
119 | Exception reporting mode: Verbose | |
|
120 | ||
|
121 | In [6]: run simpleerr.py | |
|
122 | --------------------------------------------------------------------------- | |
|
123 | ZeroDivisionError Traceback (most recent call last) | |
|
124 | <BLANKLINE> | |
|
125 | ... in <module>() | |
|
126 | 30 mode = 'div' | |
|
127 | 31 | |
|
128 | ---> 32 bar(mode) | |
|
129 | global bar = <function bar at ...> | |
|
130 | global mode = 'div' | |
|
131 | 33 | |
|
132 | 34 | |
|
133 | <BLANKLINE> | |
|
134 | ... in bar(mode='div') | |
|
135 | 14 "bar" | |
|
136 | 15 if mode=='div': | |
|
137 | ---> 16 div0() | |
|
138 | global div0 = <function div0 at ...> | |
|
139 | 17 elif mode=='exit': | |
|
140 | 18 try: | |
|
141 | <BLANKLINE> | |
|
142 | ... in div0() | |
|
143 | 6 x = 1 | |
|
144 | 7 y = 0 | |
|
145 | ----> 8 x/y | |
|
146 | x = 1 | |
|
147 | y = 0 | |
|
148 | 9 | |
|
149 | 10 def sysexit(stat, mode): | |
|
150 | <BLANKLINE> | |
|
151 | ZeroDivisionError: integer division or modulo by zero | |
|
152 | """ | |
|
153 | ||
|
154 | ||
|
155 | def doctest_tb_sysexit(): | |
|
156 | """ | |
|
157 | In [17]: %xmode plain | |
|
158 | Exception reporting mode: Plain | |
|
159 | ||
|
160 | In [18]: %run simpleerr.py exit | |
|
161 | An exception has occurred, use %tb to see the full traceback. | |
|
162 | SystemExit: (1, 'Mode = exit') | |
|
163 | ||
|
164 | In [19]: %run simpleerr.py exit 2 | |
|
165 | An exception has occurred, use %tb to see the full traceback. | |
|
166 | SystemExit: (2, 'Mode = exit') | |
|
167 | ||
|
168 | In [20]: %tb | |
|
169 | Traceback (most recent call last): | |
|
170 | File ... in <module> | |
|
171 | bar(mode) | |
|
172 | File ... line 22, in bar | |
|
173 | sysexit(stat, mode) | |
|
174 | File ... line 11, in sysexit | |
|
175 | raise SystemExit(stat, 'Mode = %s' % mode) | |
|
176 | SystemExit: (2, 'Mode = exit') | |
|
177 | ||
|
178 | In [21]: %xmode context | |
|
179 | Exception reporting mode: Context | |
|
180 | ||
|
181 | In [22]: %tb | |
|
182 | --------------------------------------------------------------------------- | |
|
183 | SystemExit Traceback (most recent call last) | |
|
184 | <BLANKLINE> | |
|
185 | ...<module>() | |
|
186 | 30 mode = 'div' | |
|
187 | 31 | |
|
188 | ---> 32 bar(mode) | |
|
189 | 33 | |
|
190 | 34 | |
|
191 | <BLANKLINE> | |
|
192 | ...bar(mode) | |
|
193 | 20 except: | |
|
194 | 21 stat = 1 | |
|
195 | ---> 22 sysexit(stat, mode) | |
|
196 | 23 else: | |
|
197 | 24 raise ValueError('Unknown mode') | |
|
198 | <BLANKLINE> | |
|
199 | ...sysexit(stat, mode) | |
|
200 | 9 | |
|
201 | 10 def sysexit(stat, mode): | |
|
202 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) | |
|
203 | 12 | |
|
204 | 13 def bar(mode): | |
|
205 | <BLANKLINE> | |
|
206 | SystemExit: (2, 'Mode = exit') | |
|
207 | ||
|
208 | In [23]: %xmode verbose | |
|
209 | Exception reporting mode: Verbose | |
|
210 | ||
|
211 | In [24]: %tb | |
|
212 | --------------------------------------------------------------------------- | |
|
213 | SystemExit Traceback (most recent call last) | |
|
214 | <BLANKLINE> | |
|
215 | ... in <module>() | |
|
216 | 30 mode = 'div' | |
|
217 | 31 | |
|
218 | ---> 32 bar(mode) | |
|
219 | global bar = <function bar at ...> | |
|
220 | global mode = 'exit' | |
|
221 | 33 | |
|
222 | 34 | |
|
223 | <BLANKLINE> | |
|
224 | ... in bar(mode='exit') | |
|
225 | 20 except: | |
|
226 | 21 stat = 1 | |
|
227 | ---> 22 sysexit(stat, mode) | |
|
228 | global sysexit = <function sysexit at ...> | |
|
229 | stat = 2 | |
|
230 | mode = 'exit' | |
|
231 | 23 else: | |
|
232 | 24 raise ValueError('Unknown mode') | |
|
233 | <BLANKLINE> | |
|
234 | ... in sysexit(stat=2, mode='exit') | |
|
235 | 9 | |
|
236 | 10 def sysexit(stat, mode): | |
|
237 | ---> 11 raise SystemExit(stat, 'Mode = %s' % mode) | |
|
238 | global SystemExit = undefined | |
|
239 | stat = 2 | |
|
240 | mode = 'exit' | |
|
241 | 12 | |
|
242 | 13 def bar(mode): | |
|
243 | <BLANKLINE> | |
|
244 | SystemExit: (2, 'Mode = exit') | |
|
245 | """ |
@@ -2,6 +2,11 b'' | |||
|
2 | 2 | |
|
3 | 3 | Needs to be run by nose (to make ipython session available). |
|
4 | 4 | """ |
|
5 | from __future__ import absolute_import | |
|
6 | ||
|
7 | #----------------------------------------------------------------------------- | |
|
8 | # Imports | |
|
9 | #----------------------------------------------------------------------------- | |
|
5 | 10 | |
|
6 | 11 | import os |
|
7 | 12 | import sys |
@@ -11,13 +16,13 b' from cStringIO import StringIO' | |||
|
11 | 16 | |
|
12 | 17 | import nose.tools as nt |
|
13 | 18 | |
|
14 |
from IPython.utils.p |
|
|
19 | from IPython.utils.path import get_long_path_name | |
|
15 | 20 | from IPython.testing import decorators as dec |
|
16 | 21 | from IPython.testing import tools as tt |
|
17 | 22 | |
|
18 | 23 | #----------------------------------------------------------------------------- |
|
19 | 24 | # Test functions begin |
|
20 | ||
|
25 | #----------------------------------------------------------------------------- | |
|
21 | 26 | def test_rehashx(): |
|
22 | 27 | # clear up everything |
|
23 | 28 | _ip = get_ipython() |
@@ -37,6 +42,19 b' def test_rehashx():' | |||
|
37 | 42 | yield (nt.assert_true, len(scoms) > 10) |
|
38 | 43 | |
|
39 | 44 | |
|
45 | def test_magic_parse_options(): | |
|
46 | """Test that we don't mangle paths when parsing magic options.""" | |
|
47 | ip = get_ipython() | |
|
48 | path = 'c:\\x' | |
|
49 | opts = ip.parse_options('-f %s' % path,'f:')[0] | |
|
50 | # argv splitting is os-dependent | |
|
51 | if os.name == 'posix': | |
|
52 | expected = 'c:x' | |
|
53 | else: | |
|
54 | expected = path | |
|
55 | nt.assert_equals(opts['f'], expected) | |
|
56 | ||
|
57 | ||
|
40 | 58 | def doctest_hist_f(): |
|
41 | 59 | """Test %hist -f with temporary filename. |
|
42 | 60 | |
@@ -45,35 +63,93 b' def doctest_hist_f():' | |||
|
45 | 63 | In [10]: tfile = tempfile.mktemp('.py','tmp-ipython-') |
|
46 | 64 | |
|
47 | 65 | In [11]: %hist -n -f $tfile 3 |
|
66 | ||
|
67 | In [13]: import os; os.unlink(tfile) | |
|
48 | 68 | """ |
|
49 | 69 | |
|
50 | 70 | |
|
51 | 71 | def doctest_hist_r(): |
|
52 | 72 | """Test %hist -r |
|
53 | 73 | |
|
54 |
XXX - This test is not recording the output correctly. |
|
|
74 | XXX - This test is not recording the output correctly. For some reason, in | |
|
75 | testing mode the raw history isn't getting populated. No idea why. | |
|
76 | Disabling the output checking for now, though at least we do run it. | |
|
55 | 77 | |
|
56 |
In [ |
|
|
57 |
Out[ |
|
|
78 | In [1]: 'hist' in _ip.lsmagic() | |
|
79 | Out[1]: True | |
|
58 | 80 | |
|
59 |
In [ |
|
|
81 | In [2]: x=1 | |
|
60 | 82 | |
|
61 |
In [ |
|
|
83 | In [3]: %hist -r 2 | |
|
62 | 84 |
x=1 |
|
63 |
hist |
|
|
85 | %hist -r 2 | |
|
64 | 86 | """ |
|
65 | 87 | |
|
66 | # This test is known to fail on win32. | |
|
67 | # See ticket https://bugs.launchpad.net/bugs/366334 | |
|
68 | def test_obj_del(): | |
|
69 | _ip = get_ipython() | |
|
70 | """Test that object's __del__ methods are called on exit.""" | |
|
71 | test_dir = os.path.dirname(__file__) | |
|
72 | del_file = os.path.join(test_dir,'obj_del.py') | |
|
73 | ipython_cmd = find_cmd('ipython') | |
|
74 | out = _ip.getoutput('%s %s' % (ipython_cmd, del_file)) | |
|
75 | nt.assert_equals(out,'obj_del.py: object A deleted') | |
|
88 | def doctest_hist_op(): | |
|
89 | """Test %hist -op | |
|
90 | ||
|
91 | In [1]: class b: | |
|
92 | ...: pass | |
|
93 | ...: | |
|
94 | ||
|
95 | In [2]: class s(b): | |
|
96 | ...: def __str__(self): | |
|
97 | ...: return 's' | |
|
98 | ...: | |
|
99 | ||
|
100 | In [3]: | |
|
76 | 101 |
|
|
102 | In [4]: class r(b): | |
|
103 | ...: def __repr__(self): | |
|
104 | ...: return 'r' | |
|
105 | ...: | |
|
106 | ||
|
107 | In [5]: class sr(s,r): pass | |
|
108 | ...: | |
|
109 | ||
|
110 | In [6]: | |
|
111 | ||
|
112 | In [7]: bb=b() | |
|
113 | ||
|
114 | In [8]: ss=s() | |
|
115 | ||
|
116 | In [9]: rr=r() | |
|
117 | ||
|
118 | In [10]: ssrr=sr() | |
|
119 | ||
|
120 | In [11]: bb | |
|
121 | Out[11]: <...b instance at ...> | |
|
122 | ||
|
123 | In [12]: ss | |
|
124 | Out[12]: <...s instance at ...> | |
|
125 | ||
|
126 | In [13]: | |
|
127 | ||
|
128 | In [14]: %hist -op | |
|
129 | >>> class b: | |
|
130 | ... pass | |
|
131 | ... | |
|
132 | >>> class s(b): | |
|
133 | ... def __str__(self): | |
|
134 | ... return 's' | |
|
135 | ... | |
|
136 | >>> | |
|
137 | >>> class r(b): | |
|
138 | ... def __repr__(self): | |
|
139 | ... return 'r' | |
|
140 | ... | |
|
141 | >>> class sr(s,r): pass | |
|
142 | >>> | |
|
143 | >>> bb=b() | |
|
144 | >>> ss=s() | |
|
145 | >>> rr=r() | |
|
146 | >>> ssrr=sr() | |
|
147 | >>> bb | |
|
148 | <...b instance at ...> | |
|
149 | >>> ss | |
|
150 | <...s instance at ...> | |
|
151 | >>> | |
|
152 | """ | |
|
77 | 153 | |
|
78 | 154 | def test_shist(): |
|
79 | 155 | # Simple tests of ShadowHist class - test generator. |
@@ -98,7 +174,11 b' def test_shist():' | |||
|
98 | 174 | |
|
99 | 175 | shutil.rmtree(tfile) |
|
100 | 176 | |
|
101 | @dec.skipif_not_numpy | |
|
177 | ||
|
178 | # XXX failing for now, until we get clearcmd out of quarantine. But we should | |
|
179 | # fix this and revert the skip to happen only if numpy is not around. | |
|
180 | #@dec.skipif_not_numpy | |
|
181 | @dec.skipknownfailure | |
|
102 | 182 | def test_numpy_clear_array_undec(): |
|
103 | 183 | from IPython.extensions import clearcmd |
|
104 | 184 | |
@@ -109,162 +189,8 b' def test_numpy_clear_array_undec():' | |||
|
109 | 189 | yield (nt.assert_false, 'a' in _ip.user_ns) |
|
110 | 190 | |
|
111 | 191 | |
|
112 | @dec.skip() | |
|
113 | def test_fail_dec(*a,**k): | |
|
114 | yield nt.assert_true, False | |
|
115 | ||
|
116 | @dec.skip('This one shouldn not run') | |
|
117 | def test_fail_dec2(*a,**k): | |
|
118 | yield nt.assert_true, False | |
|
119 | ||
|
120 | @dec.skipknownfailure | |
|
121 | def test_fail_dec3(*a,**k): | |
|
122 | yield nt.assert_true, False | |
|
123 | ||
|
124 | ||
|
125 | def doctest_refbug(): | |
|
126 | """Very nasty problem with references held by multiple runs of a script. | |
|
127 | See: https://bugs.launchpad.net/ipython/+bug/269966 | |
|
128 | ||
|
129 | In [1]: _ip.clear_main_mod_cache() | |
|
130 | ||
|
131 | In [2]: run refbug | |
|
132 | ||
|
133 | In [3]: call_f() | |
|
134 | lowercased: hello | |
|
135 | ||
|
136 | In [4]: run refbug | |
|
137 | ||
|
138 | In [5]: call_f() | |
|
139 | lowercased: hello | |
|
140 | lowercased: hello | |
|
141 | """ | |
|
142 | ||
|
143 | #----------------------------------------------------------------------------- | |
|
144 | # Tests for %run | |
|
145 | #----------------------------------------------------------------------------- | |
|
146 | ||
|
147 | # %run is critical enough that it's a good idea to have a solid collection of | |
|
148 | # tests for it, some as doctests and some as normal tests. | |
|
149 | ||
|
150 | def doctest_run_ns(): | |
|
151 | """Classes declared %run scripts must be instantiable afterwards. | |
|
152 | ||
|
153 | In [11]: run tclass foo | |
|
154 | ||
|
155 | In [12]: isinstance(f(),foo) | |
|
156 | Out[12]: True | |
|
157 | """ | |
|
158 | ||
|
159 | ||
|
160 | def doctest_run_ns2(): | |
|
161 | """Classes declared %run scripts must be instantiable afterwards. | |
|
162 | ||
|
163 | In [4]: run tclass C-first_pass | |
|
164 | ||
|
165 | In [5]: run tclass C-second_pass | |
|
166 | tclass.py: deleting object: C-first_pass | |
|
167 | """ | |
|
168 | ||
|
169 | def doctest_run_builtins(): | |
|
170 | """Check that %run doesn't damage __builtins__ via a doctest. | |
|
171 | ||
|
172 | This is similar to the test_run_builtins, but I want *both* forms of the | |
|
173 | test to catch any possible glitches in our testing machinery, since that | |
|
174 | modifies %run somewhat. So for this, we have both a normal test (below) | |
|
175 | and a doctest (this one). | |
|
176 | ||
|
177 | In [1]: import tempfile | |
|
178 | ||
|
179 | In [2]: bid1 = id(__builtins__) | |
|
180 | ||
|
181 | In [3]: fname = tempfile.mkstemp()[1] | |
|
182 | ||
|
183 | In [3]: f = open(fname,'w') | |
|
184 | ||
|
185 | In [4]: f.write('pass\\n') | |
|
186 | ||
|
187 | In [5]: f.flush() | |
|
188 | ||
|
189 | In [6]: print type(__builtins__) | |
|
190 | <type 'module'> | |
|
191 | ||
|
192 | In [7]: %run "$fname" | |
|
193 | ||
|
194 | In [7]: f.close() | |
|
195 | ||
|
196 | In [8]: bid2 = id(__builtins__) | |
|
197 | ||
|
198 | In [9]: print type(__builtins__) | |
|
199 | <type 'module'> | |
|
200 | ||
|
201 | In [10]: bid1 == bid2 | |
|
202 | Out[10]: True | |
|
203 | ||
|
204 | In [12]: try: | |
|
205 | ....: os.unlink(fname) | |
|
206 | ....: except: | |
|
207 | ....: pass | |
|
208 | ....: | |
|
209 | """ | |
|
210 | ||
|
211 | # For some tests, it will be handy to organize them in a class with a common | |
|
212 | # setup that makes a temp file | |
|
213 | ||
|
214 | class TestMagicRun(object): | |
|
215 | ||
|
216 | def setup(self): | |
|
217 | """Make a valid python temp file.""" | |
|
218 | fname = tempfile.mkstemp()[1] | |
|
219 | f = open(fname,'w') | |
|
220 | f.write('pass\n') | |
|
221 | f.flush() | |
|
222 | self.tmpfile = f | |
|
223 | self.fname = fname | |
|
224 | ||
|
225 | def run_tmpfile(self): | |
|
226 | _ip = get_ipython() | |
|
227 | # This fails on Windows if self.tmpfile.name has spaces or "~" in it. | |
|
228 | # See below and ticket https://bugs.launchpad.net/bugs/366353 | |
|
229 | _ip.magic('run "%s"' % self.fname) | |
|
230 | ||
|
231 | def test_builtins_id(self): | |
|
232 | """Check that %run doesn't damage __builtins__ """ | |
|
233 | _ip = get_ipython() | |
|
234 | # Test that the id of __builtins__ is not modified by %run | |
|
235 | bid1 = id(_ip.user_ns['__builtins__']) | |
|
236 | self.run_tmpfile() | |
|
237 | bid2 = id(_ip.user_ns['__builtins__']) | |
|
238 | tt.assert_equals(bid1, bid2) | |
|
239 | ||
|
240 | def test_builtins_type(self): | |
|
241 | """Check that the type of __builtins__ doesn't change with %run. | |
|
242 | ||
|
243 | However, the above could pass if __builtins__ was already modified to | |
|
244 | be a dict (it should be a module) by a previous use of %run. So we | |
|
245 | also check explicitly that it really is a module: | |
|
246 | """ | |
|
247 | _ip = get_ipython() | |
|
248 | self.run_tmpfile() | |
|
249 | tt.assert_equals(type(_ip.user_ns['__builtins__']),type(sys)) | |
|
250 | ||
|
251 | def test_prompts(self): | |
|
252 | """Test that prompts correctly generate after %run""" | |
|
253 | self.run_tmpfile() | |
|
254 | _ip = get_ipython() | |
|
255 | p2 = str(_ip.outputcache.prompt2).strip() | |
|
256 | nt.assert_equals(p2[:3], '...') | |
|
257 | ||
|
258 | def teardown(self): | |
|
259 | self.tmpfile.close() | |
|
260 | try: | |
|
261 | os.unlink(self.fname) | |
|
262 | except: | |
|
263 | # On Windows, even though we close the file, we still can't delete | |
|
264 | # it. I have no clue why | |
|
265 | pass | |
|
266 | ||
|
267 | 192 | # Multiple tests for clipboard pasting |
|
193 | @dec.parametric | |
|
268 | 194 | def test_paste(): |
|
269 | 195 | _ip = get_ipython() |
|
270 | 196 | def paste(txt, flags='-q'): |
@@ -286,11 +212,11 b' def test_paste():' | |||
|
286 | 212 | # Run tests with fake clipboard function |
|
287 | 213 | user_ns.pop('x', None) |
|
288 | 214 | paste('x=1') |
|
289 |
yield |
|
|
215 | yield nt.assert_equal(user_ns['x'], 1) | |
|
290 | 216 | |
|
291 | 217 | user_ns.pop('x', None) |
|
292 | 218 | paste('>>> x=2') |
|
293 |
yield |
|
|
219 | yield nt.assert_equal(user_ns['x'], 2) | |
|
294 | 220 | |
|
295 | 221 | paste(""" |
|
296 | 222 | >>> x = [1,2,3] |
@@ -299,14 +225,14 b' def test_paste():' | |||
|
299 | 225 | ... y.append(i**2) |
|
300 | 226 | ... |
|
301 | 227 | """) |
|
302 |
yield |
|
|
303 |
yield |
|
|
228 | yield nt.assert_equal(user_ns['x'], [1,2,3]) | |
|
229 | yield nt.assert_equal(user_ns['y'], [1,4,9]) | |
|
304 | 230 | |
|
305 | 231 | # Now, test that paste -r works |
|
306 | 232 | user_ns.pop('x', None) |
|
307 |
yield |
|
|
233 | yield nt.assert_false('x' in user_ns) | |
|
308 | 234 | _ip.magic('paste -r') |
|
309 |
yield |
|
|
235 | yield nt.assert_equal(user_ns['x'], [1,2,3]) | |
|
310 | 236 | |
|
311 | 237 | # Also test paste echoing, by temporarily faking the writer |
|
312 | 238 | w = StringIO() |
@@ -320,12 +246,29 b' def test_paste():' | |||
|
320 | 246 | out = w.getvalue() |
|
321 | 247 | finally: |
|
322 | 248 | _ip.write = writer |
|
323 |
yield |
|
|
324 |
yield |
|
|
325 |
yield |
|
|
249 | yield nt.assert_equal(user_ns['a'], 100) | |
|
250 | yield nt.assert_equal(user_ns['b'], 200) | |
|
251 | yield nt.assert_equal(out, code+"\n## -- End pasted text --\n") | |
|
326 | 252 | |
|
327 | 253 | finally: |
|
328 | 254 | # This should be in a finally clause, instead of the bare except above. |
|
329 | 255 | # Restore original hook |
|
330 | 256 | hooks.clipboard_get = original_clip |
|
331 | 257 | |
|
258 | ||
|
259 | def test_time(): | |
|
260 | _ip.magic('time None') | |
|
261 | ||
|
262 | ||
|
263 | def doctest_time(): | |
|
264 | """ | |
|
265 | In [10]: %time None | |
|
266 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s | |
|
267 | Wall time: 0.00 s | |
|
268 | """ | |
|
269 | ||
|
270 | def test_doctest_mode(): | |
|
271 | "Toggle doctest_mode twice, it should be a no-op and run without error" | |
|
272 | _ip.magic('doctest_mode') | |
|
273 | _ip.magic('doctest_mode') | |
|
274 |
@@ -88,15 +88,15 b' import types' | |||
|
88 | 88 | from inspect import getsourcefile, getfile, getmodule,\ |
|
89 | 89 | ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode |
|
90 | 90 | |
|
91 | ||
|
92 | 91 | # IPython's own modules |
|
93 | 92 | # Modified pdb which doesn't damage IPython's readline handling |
|
94 | 93 | from IPython.utils import PyColorize |
|
95 | 94 | from IPython.core import debugger, ipapi |
|
96 | 95 | from IPython.core.display_trap import DisplayTrap |
|
97 | from IPython.utils.ipstruct import Struct | |
|
98 | 96 | from IPython.core.excolors import exception_colors |
|
99 |
from IPython.utils. |
|
|
97 | from IPython.utils.data import uniq_stable | |
|
98 | from IPython.utils.io import Term | |
|
99 | from IPython.utils.warn import info, error | |
|
100 | 100 | |
|
101 | 101 | # Globals |
|
102 | 102 | # amount of space to put line numbers before verbose tracebacks |
@@ -263,7 +263,7 b' def _fixed_getinnerframes(etb, context=1,tb_offset=0):' | |||
|
263 | 263 | |
|
264 | 264 | _parser = PyColorize.Parser() |
|
265 | 265 | |
|
266 |
def _format |
|
|
266 | def _format_traceback_lines(lnum, index, lines, Colors, lvals=None,scheme=None): | |
|
267 | 267 | numbers_width = INDENT_SIZE - 1 |
|
268 | 268 | res = [] |
|
269 | 269 | i = lnum - index |
@@ -313,6 +313,15 b' def _formatTracebackLines(lnum, index, lines, Colors, lvals=None,scheme=None):' | |||
|
313 | 313 | class TBTools: |
|
314 | 314 | """Basic tools used by all traceback printer classes.""" |
|
315 | 315 | |
|
316 | #: Default output stream, can be overridden at call time. A special value | |
|
317 | #: of 'stdout' *as a string* can be given to force extraction of sys.stdout | |
|
318 | #: at runtime. This allows testing exception printing with doctests, that | |
|
319 | #: swap sys.stdout just at execution time. | |
|
320 | #: Warning: be VERY careful to set this to one of the Term streams, NEVER | |
|
321 | #: directly to sys.stdout/err, because under win32 the Term streams come from | |
|
322 | #: pyreadline and know how to handle color correctly, whie stdout/err don't. | |
|
323 | out_stream = Term.cerr | |
|
324 | ||
|
316 | 325 | def __init__(self,color_scheme = 'NoColor',call_pdb=False): |
|
317 | 326 | # Whether to call the interactive pdb debugger after printing |
|
318 | 327 | # tracebacks or not |
@@ -376,16 +385,32 b' class ListTB(TBTools):' | |||
|
376 | 385 | |
|
377 | 386 | def __call__(self, etype, value, elist): |
|
378 | 387 | Term.cout.flush() |
|
379 |
|
|
|
380 |
Term.cerr. |
|
|
388 | Term.cerr.write(self.text(etype,value,elist)) | |
|
389 | Term.cerr.write('\n') | |
|
381 | 390 | |
|
382 | 391 | def text(self,etype, value, elist,context=5): |
|
383 |
"""Return a color formatted string with the traceback info. |
|
|
392 | """Return a color formatted string with the traceback info. | |
|
393 | ||
|
394 | Parameters | |
|
395 | ---------- | |
|
396 | etype : exception type | |
|
397 | Type of the exception raised. | |
|
398 | ||
|
399 | value : object | |
|
400 | Data stored in the exception | |
|
401 | ||
|
402 | elist : list | |
|
403 | List of frames, see class docstring for details. | |
|
404 | ||
|
405 | Returns | |
|
406 | ------- | |
|
407 | String with formatted exception. | |
|
408 | """ | |
|
384 | 409 | |
|
385 | 410 | Colors = self.Colors |
|
386 | out_string = ['%s%s%s\n' % (Colors.topline,'-'*60,Colors.Normal)] | |
|
411 | out_string = [] | |
|
387 | 412 | if elist: |
|
388 |
out_string.append('Traceback %s(most recent call last)%s:' % |
|
|
413 | out_string.append('Traceback %s(most recent call last)%s:' % | |
|
389 | 414 | (Colors.normalEm, Colors.Normal) + '\n') |
|
390 | 415 | out_string.extend(self._format_list(elist)) |
|
391 | 416 | lines = self._format_exception_only(etype, value) |
@@ -492,15 +517,29 b' class ListTB(TBTools):' | |||
|
492 | 517 | else: |
|
493 | 518 | list.append('%s\n' % str(stype)) |
|
494 | 519 | |
|
495 | # vds:>> | |
|
520 | # sync with user hooks | |
|
496 | 521 | if have_filedata: |
|
497 | 522 | ipinst = ipapi.get() |
|
498 | 523 | if ipinst is not None: |
|
499 | 524 | ipinst.hooks.synchronize_with_editor(filename, lineno, 0) |
|
500 | # vds:<< | |
|
501 | 525 | |
|
502 | 526 | return list |
|
503 | 527 | |
|
528 | def show_exception_only(self, etype, value): | |
|
529 | """Only print the exception type and message, without a traceback. | |
|
530 | ||
|
531 | Parameters | |
|
532 | ---------- | |
|
533 | etype : exception type | |
|
534 | value : exception value | |
|
535 | """ | |
|
536 | # This method needs to use __call__ from *this* class, not the one from | |
|
537 | # a subclass whose signature or behavior may be different | |
|
538 | Term.cout.flush() | |
|
539 | ostream = sys.stdout if self.out_stream == 'stdout' else Term.cerr | |
|
540 | ostream.write(ListTB.text(self, etype, value, [])) | |
|
541 | ostream.flush() | |
|
542 | ||
|
504 | 543 | def _some_str(self, value): |
|
505 | 544 | # Lifted from traceback.py |
|
506 | 545 | try: |
@@ -781,7 +820,7 b' class VerboseTB(TBTools):' | |||
|
781 | 820 | frames.append(level) |
|
782 | 821 | else: |
|
783 | 822 | frames.append('%s%s' % (level,''.join( |
|
784 |
_format |
|
|
823 | _format_traceback_lines(lnum,index,lines,Colors,lvals, | |
|
785 | 824 | col_scheme)))) |
|
786 | 825 | |
|
787 | 826 | # Get (safely) a string form of the exception info |
@@ -854,11 +893,11 b' class VerboseTB(TBTools):' | |||
|
854 | 893 | with display_trap: |
|
855 | 894 | self.pdb.reset() |
|
856 | 895 | # Find the right frame so we don't pop up inside ipython itself |
|
857 | if hasattr(self,'tb'): | |
|
896 | if hasattr(self,'tb') and self.tb is not None: | |
|
858 | 897 | etb = self.tb |
|
859 | 898 | else: |
|
860 | 899 | etb = self.tb = sys.last_traceback |
|
861 | while self.tb.tb_next is not None: | |
|
900 | while self.tb is not None and self.tb.tb_next is not None: | |
|
862 | 901 | self.tb = self.tb.tb_next |
|
863 | 902 | if etb and etb.tb_next: |
|
864 | 903 | etb = etb.tb_next |
@@ -872,8 +911,8 b' class VerboseTB(TBTools):' | |||
|
872 | 911 | (etype, evalue, etb) = info or sys.exc_info() |
|
873 | 912 | self.tb = etb |
|
874 | 913 | Term.cout.flush() |
|
875 |
|
|
|
876 |
Term.cerr. |
|
|
914 | Term.cerr.write(self.text(etype, evalue, etb)) | |
|
915 | Term.cerr.write('\n') | |
|
877 | 916 | |
|
878 | 917 | # Changed so an instance can just be called as VerboseTB_inst() and print |
|
879 | 918 | # out the right info on its own. |
@@ -980,6 +1019,7 b' class AutoFormattedTB(FormattedTB):' | |||
|
980 | 1019 | except: |
|
981 | 1020 | AutoTB() # or AutoTB(out=logfile) where logfile is an open file object |
|
982 | 1021 | """ |
|
1022 | ||
|
983 | 1023 | def __call__(self,etype=None,evalue=None,etb=None, |
|
984 | 1024 | out=None,tb_offset=None): |
|
985 | 1025 | """Print out a formatted exception traceback. |
@@ -992,14 +1032,16 b' class AutoFormattedTB(FormattedTB):' | |||
|
992 | 1032 | given at initialization time. """ |
|
993 | 1033 | |
|
994 | 1034 | if out is None: |
|
995 | out = Term.cerr | |
|
1035 | out = sys.stdout if self.out_stream=='stdout' else self.out_stream | |
|
996 | 1036 | Term.cout.flush() |
|
997 | 1037 | if tb_offset is not None: |
|
998 | 1038 | tb_offset, self.tb_offset = self.tb_offset, tb_offset |
|
999 |
|
|
|
1039 | out.write(self.text(etype, evalue, etb)) | |
|
1040 | out.write('\n') | |
|
1000 | 1041 | self.tb_offset = tb_offset |
|
1001 | 1042 | else: |
|
1002 |
|
|
|
1043 | out.write(self.text(etype, evalue, etb)) | |
|
1044 | out.write('\n') | |
|
1003 | 1045 | out.flush() |
|
1004 | 1046 | try: |
|
1005 | 1047 | self.debugger() |
@@ -1,338 +1,47 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | #***************************************************************************** | |
|
3 | # Copyright (C) 2001-2004 Fernando Perez. <fperez@colorado.edu> | |
|
2 | """Usage information for the main IPython applications. | |
|
3 | """ | |
|
4 | #----------------------------------------------------------------------------- | |
|
5 | # Copyright (C) 2008-2010 The IPython Development Team | |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
|
4 | 7 | # |
|
5 | 8 | # Distributed under the terms of the BSD License. The full license is in |
|
6 | 9 | # the file COPYING, distributed as part of this software. |
|
7 | #***************************************************************************** | |
|
10 | #----------------------------------------------------------------------------- | |
|
8 | 11 | |
|
9 | 12 | import sys |
|
10 | 13 | from IPython.core import release |
|
11 | 14 | |
|
12 | __doc__ = """ | |
|
13 | IPython -- An enhanced Interactive Python | |
|
14 | ========================================= | |
|
15 | cl_usage = """\ | |
|
16 | ipython [options] [files] | |
|
17 | ||
|
18 | IPython: an enhanced interactive Python shell. | |
|
15 | 19 | |
|
16 | 20 | A Python shell with automatic history (input and output), dynamic object |
|
17 |
introspection, easier configuration, command completion, access to the |
|
|
18 | shell and more. | |
|
19 | ||
|
20 | IPython can also be embedded in running programs. See EMBEDDING below. | |
|
21 | ||
|
22 | ||
|
23 | USAGE | |
|
24 | ipython [options] files | |
|
25 | ||
|
26 | If invoked with no options, it executes all the files listed in | |
|
27 | sequence and drops you into the interpreter while still acknowledging | |
|
28 | any options you may have set in your ipythonrc file. This behavior is | |
|
29 | different from standard Python, which when called as python -i will | |
|
30 | only execute one file and will ignore your configuration setup. | |
|
31 | ||
|
32 | Please note that some of the configuration options are not available at | |
|
33 | the command line, simply because they are not practical here. Look into | |
|
34 | your ipythonrc configuration file for details on those. This file | |
|
35 | typically installed in the $HOME/.ipython directory. | |
|
36 | ||
|
37 | For Windows users, $HOME resolves to C:\\Documents and | |
|
38 | Settings\\YourUserName in most instances, and _ipython is used instead | |
|
39 | of .ipython, since some Win32 programs have problems with dotted names | |
|
40 | in directories. | |
|
41 | ||
|
42 | In the rest of this text, we will refer to this directory as | |
|
43 | IPYTHON_DIR. | |
|
44 | ||
|
45 | REGULAR OPTIONS | |
|
46 | After the above threading options have been given, regular options can | |
|
47 | follow in any order. All options can be abbreviated to their shortest | |
|
48 | non-ambiguous form and are case-sensitive. One or two dashes can be | |
|
49 | used. Some options have an alternate short form, indicated after a |. | |
|
50 | ||
|
51 | Most options can also be set from your ipythonrc configuration file. | |
|
52 | See the provided examples for assistance. Options given on the comman- | |
|
53 | dline override the values set in the ipythonrc file. | |
|
54 | ||
|
55 | All options with a [no] prepended can be specified in negated form | |
|
56 | (using -nooption instead of -option) to turn the feature off. | |
|
57 | ||
|
58 | -h, --help | |
|
59 | Show summary of options. | |
|
60 | ||
|
61 | -autocall <val> | |
|
62 | Make IPython automatically call any callable object even if you | |
|
63 | didn't type explicit parentheses. For example, 'str 43' becomes | |
|
64 | 'str(43)' automatically. The value can be '0' to disable the | |
|
65 | feature, '1' for 'smart' autocall, where it is not applied if | |
|
66 | there are no more arguments on the line, and '2' for 'full' | |
|
67 | autocall, where all callable objects are automatically called | |
|
68 | (even if no arguments are present). The default is '1'. | |
|
69 | ||
|
70 | -[no]autoindent | |
|
71 | Turn automatic indentation on/off. | |
|
72 | ||
|
73 | -[no]automagic | |
|
74 | Make magic commands automatic (without needing their first char- | |
|
75 | acter to be %). Type %magic at the IPython prompt for more | |
|
76 | information. | |
|
77 | ||
|
78 | -[no]autoedit_syntax | |
|
79 | When a syntax error occurs after editing a file, automatically | |
|
80 | open the file to the trouble causing line for convenient fixing. | |
|
81 | ||
|
82 | -[no]banner | |
|
83 | Print the intial information banner (default on). | |
|
84 | ||
|
85 | -c <command> | |
|
86 | Execute the given command string, and set sys.argv to ['c']. | |
|
87 | This is similar to the -c option in the normal Python inter- | |
|
88 | preter. | |
|
89 | ||
|
90 | -cache_size|cs <n> | |
|
91 | Size of the output cache (maximum number of entries to hold in | |
|
92 | memory). The default is 1000, you can change it permanently in | |
|
93 | your config file. Setting it to 0 completely disables the | |
|
94 | caching system, and the minimum value accepted is 20 (if you | |
|
95 | provide a value less than 20, it is reset to 0 and a warning is | |
|
96 | issued). This limit is defined because otherwise you'll spend | |
|
97 | more time re-flushing a too small cache than working. | |
|
98 | ||
|
99 | -classic|cl | |
|
100 | Gives IPython a similar feel to the classic Python prompt. | |
|
101 | ||
|
102 | -colors <scheme> | |
|
103 | Color scheme for prompts and exception reporting. Currently | |
|
104 | implemented: NoColor, Linux, and LightBG. | |
|
105 | ||
|
106 | -[no]color_info | |
|
107 | IPython can display information about objects via a set of func- | |
|
108 | tions, and optionally can use colors for this, syntax highlight- | |
|
109 | ing source code and various other elements. However, because | |
|
110 | this information is passed through a pager (like 'less') and | |
|
111 | many pagers get confused with color codes, this option is off by | |
|
112 | default. You can test it and turn it on permanently in your | |
|
113 | ipythonrc file if it works for you. As a reference, the 'less' | |
|
114 | pager supplied with Mandrake 8.2 works ok, but that in RedHat | |
|
115 | 7.2 doesn't. | |
|
116 | ||
|
117 | Test it and turn it on permanently if it works with your system. | |
|
118 | The magic function @color_info allows you to toggle this inter- | |
|
119 | actively for testing. | |
|
120 | ||
|
121 | -[no]confirm_exit | |
|
122 | Set to confirm when you try to exit IPython with an EOF (Con- | |
|
123 | trol-D in Unix, Control-Z/Enter in Windows). Note that using the | |
|
124 | magic functions @Exit or @Quit you can force a direct exit, | |
|
125 | bypassing any confirmation. | |
|
126 | ||
|
127 | -[no]debug | |
|
128 | Show information about the loading process. Very useful to pin | |
|
129 | down problems with your configuration files or to get details | |
|
130 | about session restores. | |
|
131 | ||
|
132 | -[no]deep_reload | |
|
133 | IPython can use the deep_reload module which reloads changes in | |
|
134 | modules recursively (it replaces the reload() function, so you | |
|
135 | don't need to change anything to use it). deep_reload() forces a | |
|
136 | full reload of modules whose code may have changed, which the | |
|
137 | default reload() function does not. | |
|
138 | ||
|
139 | When deep_reload is off, IPython will use the normal reload(), | |
|
140 | but deep_reload will still be available as dreload(). This fea- | |
|
141 | ture is off by default [which means that you have both normal | |
|
142 | reload() and dreload()]. | |
|
143 | ||
|
144 | -editor <name> | |
|
145 | Which editor to use with the @edit command. By default, IPython | |
|
146 | will honor your EDITOR environment variable (if not set, vi is | |
|
147 | the Unix default and notepad the Windows one). Since this editor | |
|
148 | is invoked on the fly by IPython and is meant for editing small | |
|
149 | code snippets, you may want to use a small, lightweight editor | |
|
150 | here (in case your default EDITOR is something like Emacs). | |
|
151 | ||
|
152 | -ipythondir <name> | |
|
153 | The name of your IPython configuration directory IPYTHON_DIR. | |
|
154 | This can also be specified through the environment variable | |
|
155 | IPYTHON_DIR. | |
|
156 | ||
|
157 | -log|l Generate a log file of all input. The file is named | |
|
158 | ipython_log.py in your current directory (which prevents logs | |
|
159 | from multiple IPython sessions from trampling each other). You | |
|
160 | can use this to later restore a session by loading your logfile | |
|
161 | as a file to be executed with option -logplay (see below). | |
|
162 | ||
|
163 | -logfile|lf | |
|
164 | Specify the name of your logfile. | |
|
165 | ||
|
166 | -logplay|lp | |
|
167 | Replay a previous log. For restoring a session as close as pos- | |
|
168 | sible to the state you left it in, use this option (don't just | |
|
169 | run the logfile). With -logplay, IPython will try to reconstruct | |
|
170 | the previous working environment in full, not just execute the | |
|
171 | commands in the logfile. | |
|
172 | When a session is restored, logging is automatically turned on | |
|
173 | again with the name of the logfile it was invoked with (it is | |
|
174 | read from the log header). So once you've turned logging on for | |
|
175 | a session, you can quit IPython and reload it as many times as | |
|
176 | you want and it will continue to log its history and restore | |
|
177 | from the beginning every time. | |
|
178 | ||
|
179 | Caveats: there are limitations in this option. The history vari- | |
|
180 | ables _i*,_* and _dh don't get restored properly. In the future | |
|
181 | we will try to implement full session saving by writing and | |
|
182 | retrieving a failed because of inherent limitations of Python's | |
|
183 | Pickle module, so this may have to wait. | |
|
184 | ||
|
185 | -[no]messages | |
|
186 | Print messages which IPython collects about its startup process | |
|
187 | (default on). | |
|
188 | ||
|
189 | -[no]pdb | |
|
190 | Automatically call the pdb debugger after every uncaught excep- | |
|
191 | tion. If you are used to debugging using pdb, this puts you | |
|
192 | automatically inside of it after any call (either in IPython or | |
|
193 | in code called by it) which triggers an exception which goes | |
|
194 | uncaught. | |
|
195 | ||
|
196 | -[no]pprint | |
|
197 | IPython can optionally use the pprint (pretty printer) module | |
|
198 | for displaying results. pprint tends to give a nicer display of | |
|
199 | nested data structures. If you like it, you can turn it on per- | |
|
200 | manently in your config file (default off). | |
|
201 | ||
|
202 | -profile|p <name> | |
|
203 | Assume that your config file is ipythonrc-<name> (looks in cur- | |
|
204 | rent dir first, then in IPYTHON_DIR). This is a quick way to keep | |
|
205 | and load multiple config files for different tasks, especially | |
|
206 | if you use the include option of config files. You can keep a | |
|
207 | basic IPYTHON_DIR/ipythonrc file and then have other 'profiles' | |
|
208 | which include this one and load extra things for particular | |
|
209 | tasks. For example: | |
|
210 | ||
|
211 | 1) $HOME/.ipython/ipythonrc : load basic things you always want. | |
|
212 | 2) $HOME/.ipython/ipythonrc-math : load (1) and basic math- | |
|
213 | related modules. | |
|
214 | 3) $HOME/.ipython/ipythonrc-numeric : load (1) and Numeric and | |
|
215 | plotting modules. | |
|
216 | ||
|
217 | Since it is possible to create an endless loop by having circu- | |
|
218 | lar file inclusions, IPython will stop if it reaches 15 recur- | |
|
219 | sive inclusions. | |
|
220 | ||
|
221 | -prompt_in1|pi1 <string> | |
|
222 | Specify the string used for input prompts. Note that if you are | |
|
223 | using numbered prompts, the number is represented with a '\#' in | |
|
224 | the string. Don't forget to quote strings with spaces embedded | |
|
225 | in them. Default: 'In [\#]: '. | |
|
226 | ||
|
227 | Most bash-like escapes can be used to customize IPython's | |
|
228 | prompts, as well as a few additional ones which are IPython-spe- | |
|
229 | cific. All valid prompt escapes are described in detail in the | |
|
230 | Customization section of the IPython HTML/PDF manual. | |
|
231 | ||
|
232 | -prompt_in2|pi2 <string> | |
|
233 | Similar to the previous option, but used for the continuation | |
|
234 | prompts. The special sequence '\D' is similar to '\#', but with | |
|
235 | all digits replaced dots (so you can have your continuation | |
|
236 | prompt aligned with your input prompt). Default: ' .\D.: ' | |
|
237 | (note three spaces at the start for alignment with 'In [\#]'). | |
|
238 | ||
|
239 | -prompt_out|po <string> | |
|
240 | String used for output prompts, also uses numbers like | |
|
241 | prompt_in1. Default: 'Out[\#]:'. | |
|
242 | ||
|
243 | -quick Start in bare bones mode (no config file loaded). | |
|
244 | ||
|
245 | -rcfile <name> | |
|
246 | Name of your IPython resource configuration file. normally | |
|
247 | IPython loads ipythonrc (from current directory) or | |
|
248 | IPYTHON_DIR/ipythonrc. If the loading of your config file fails, | |
|
249 | IPython starts with a bare bones configuration (no modules | |
|
250 | loaded at all). | |
|
251 | ||
|
252 | -[no]readline | |
|
253 | Use the readline library, which is needed to support name com- | |
|
254 | pletion and command history, among other things. It is enabled | |
|
255 | by default, but may cause problems for users of X/Emacs in | |
|
256 | Python comint or shell buffers. | |
|
257 | ||
|
258 | Note that emacs 'eterm' buffers (opened with M-x term) support | |
|
259 | IPython's readline and syntax coloring fine, only 'emacs' (M-x | |
|
260 | shell and C-c !) buffers do not. | |
|
261 | ||
|
262 | -screen_length|sl <n> | |
|
263 | Number of lines of your screen. This is used to control print- | |
|
264 | ing of very long strings. Strings longer than this number of | |
|
265 | lines will be sent through a pager instead of directly printed. | |
|
266 | ||
|
267 | The default value for this is 0, which means IPython will auto- | |
|
268 | detect your screen size every time it needs to print certain | |
|
269 | potentially long strings (this doesn't change the behavior of | |
|
270 | the 'print' keyword, it's only triggered internally). If for | |
|
271 | some reason this isn't working well (it needs curses support), | |
|
272 | specify it yourself. Otherwise don't change the default. | |
|
273 | ||
|
274 | -separate_in|si <string> | |
|
275 | Separator before input prompts. Default '0. | |
|
276 | ||
|
277 | -separate_out|so <string> | |
|
278 | Separator before output prompts. Default: 0 (nothing). | |
|
279 | ||
|
280 | -separate_out2|so2 <string> | |
|
281 | Separator after output prompts. Default: 0 (nothing). | |
|
282 | ||
|
283 | -nosep Shorthand for '-separate_in 0 -separate_out 0 -separate_out2 0'. | |
|
284 | Simply removes all input/output separators. | |
|
285 | ||
|
286 | -upgrade | |
|
287 | Allows you to upgrade your IPYTHON_DIR configuration when you | |
|
288 | install a new version of IPython. Since new versions may | |
|
289 | include new command lines options or example files, this copies | |
|
290 | updated ipythonrc-type files. However, it backs up (with a .old | |
|
291 | extension) all files which it overwrites so that you can merge | |
|
292 | back any custimizations you might have in your personal files. | |
|
293 | ||
|
294 | -Version | |
|
295 | Print version information and exit. | |
|
296 | ||
|
297 | -wxversion <string> | |
|
298 | Select a specific version of wxPython (used in conjunction with | |
|
299 | -wthread). Requires the wxversion module, part of recent | |
|
300 | wxPython distributions. | |
|
301 | ||
|
302 | -xmode <modename> | |
|
303 | Mode for exception reporting. The valid modes are Plain, Con- | |
|
304 | text, and Verbose. | |
|
305 | ||
|
306 | - Plain: similar to python's normal traceback printing. | |
|
307 | ||
|
308 | - Context: prints 5 lines of context source code around each | |
|
309 | line in the traceback. | |
|
310 | ||
|
311 | - Verbose: similar to Context, but additionally prints the vari- | |
|
312 | ables currently visible where the exception happened (shortening | |
|
313 | their strings if too long). This can potentially be very slow, | |
|
314 | if you happen to have a huge data structure whose string repre- | |
|
315 | sentation is complex to compute. Your computer may appear to | |
|
316 | freeze for a while with cpu usage at 100%. If this occurs, you | |
|
317 | can cancel the traceback with Ctrl-C (maybe hitting it more than | |
|
318 | once). | |
|
319 | ||
|
320 | ||
|
321 | EMBEDDING | |
|
322 | It is possible to start an IPython instance inside your own Python pro- | |
|
323 | grams. In the documentation example files there are some illustrations | |
|
324 | on how to do this. | |
|
325 | ||
|
326 | This feature allows you to evalutate dynamically the state of your | |
|
327 | code, operate with your variables, analyze them, etc. Note however | |
|
328 | that any changes you make to values while in the shell do NOT propagate | |
|
329 | back to the running code, so it is safe to modify your values because | |
|
330 | you won't break your code in bizarre ways by doing so. | |
|
331 | """ | |
|
21 | introspection, easier configuration, command completion, access to the | |
|
22 | system shell and more. IPython can also be embedded in running programs. | |
|
332 | 23 | |
|
333 | cmd_line_usage = __doc__ | |
|
24 | If invoked with no options, it executes all the files listed in sequence | |
|
25 | and exits, use -i to enter interactive mode after running the files. Files | |
|
26 | ending in .py will be treated as normal Python, but files ending in .ipy | |
|
27 | can contain special IPython syntax (magic commands, shell expansions, etc.) | |
|
28 | ||
|
29 | Please note that some of the configuration options are not available at the | |
|
30 | command line, simply because they are not practical here. Look into your | |
|
31 | ipython_config.py configuration file for details on those. | |
|
32 | ||
|
33 | This file typically installed in the $HOME/.ipython directory. For Windows | |
|
34 | users, $HOME resolves to C:\\Documents and Settings\\YourUserName in most | |
|
35 | instances. | |
|
36 | ||
|
37 | In IPython's documentation, we will refer to this directory as IPYTHON_DIR, | |
|
38 | you can change its default location by setting any path you want in this | |
|
39 | environment variable. | |
|
40 | ||
|
41 | For more information, see the manual available in HTML and PDF in your | |
|
42 | installation, or online at http://ipython.scipy.org. | |
|
43 | """ | |
|
334 | 44 | |
|
335 | #--------------------------------------------------------------------------- | |
|
336 | 45 | interactive_usage = """ |
|
337 | 46 | IPython -- An enhanced Interactive Python |
|
338 | 47 | ========================================= |
@@ -53,7 +53,7 b" __all__ = ['Gnuplot','gp','gp_new','Data','File','Func','GridData'," | |||
|
53 | 53 | 'pm3d_config','eps_fix_bbox'] |
|
54 | 54 | |
|
55 | 55 | import os,tempfile,sys |
|
56 |
from IPython.utils. |
|
|
56 | from IPython.utils.process import getoutput | |
|
57 | 57 | |
|
58 | 58 | #--------------------------------------------------------------------------- |
|
59 | 59 | # Notes on mouse support for Gnuplot.py |
@@ -133,10 +133,10 b' from IPython.external import simplegeneric' | |||
|
133 | 133 | from IPython.external import path |
|
134 | 134 | |
|
135 | 135 | try: |
|
136 |
from IPython.utils import |
|
|
136 | from IPython.utils.io import Term | |
|
137 | 137 | from IPython.utils import generics |
|
138 | 138 | except ImportError: |
|
139 |
|
|
|
139 | Term = None | |
|
140 | 140 | generics = None |
|
141 | 141 | |
|
142 | 142 | from IPython.core import ipapi |
@@ -2168,7 +2168,7 b' class idump(Display):' | |||
|
2168 | 2168 | self.datasepchar = "|" |
|
2169 | 2169 | |
|
2170 | 2170 | def display(self): |
|
2171 |
stream = |
|
|
2171 | stream = Term.cout | |
|
2172 | 2172 | allattrs = [] |
|
2173 | 2173 | attrset = set() |
|
2174 | 2174 | colwidths = {} |
@@ -54,7 +54,7 b' from enthought.traits import api as T' | |||
|
54 | 54 | # IPython imports |
|
55 | 55 | from IPython.core.error import TryNext |
|
56 | 56 | from IPython.core.ipapi import get as ipget |
|
57 |
from IPython.utils. |
|
|
57 | from IPython.utils.dir2 import dir2 | |
|
58 | 58 | try: |
|
59 | 59 | set |
|
60 | 60 | except: |
@@ -14,7 +14,9 b' from IPython.core.iplib import InteractiveShell' | |||
|
14 | 14 | from IPython.utils.ipstruct import Struct |
|
15 | 15 | import Queue,thread,threading,signal |
|
16 | 16 | from signal import signal, SIGINT |
|
17 |
from IPython.utils. |
|
|
17 | from IPython.utils.io import Term, ask_yes_no | |
|
18 | from IPython.utils.warn import warn, error | |
|
19 | from IPython.utils.decorators import flag_calls | |
|
18 | 20 | from IPython.core import shellglobals |
|
19 | 21 | |
|
20 | 22 | def install_gtk2(): |
@@ -19,6 +19,7 b' import new' | |||
|
19 | 19 | from IPython.core.component import Component |
|
20 | 20 | from IPython.utils.traitlets import Bool, Any |
|
21 | 21 | from IPython.utils.autoattr import auto_attr |
|
22 | from IPython.testing import decorators as testdec | |
|
22 | 23 | |
|
23 | 24 | #----------------------------------------------------------------------------- |
|
24 | 25 | # Definitions of magic functions for use with IPython |
@@ -58,6 +59,7 b' class ParalleMagicComponent(Component):' | |||
|
58 | 59 | self.shell.define_magic('px', self.magic_px) |
|
59 | 60 | self.shell.define_magic('autopx', self.magic_autopx) |
|
60 | 61 | |
|
62 | @testdec.skip_doctest | |
|
61 | 63 | def magic_result(self, ipself, parameter_s=''): |
|
62 | 64 | """Print the result of command i on all engines.. |
|
63 | 65 | |
@@ -89,6 +91,7 b' class ParalleMagicComponent(Component):' | |||
|
89 | 91 | result = self.active_multiengine_client.get_result(index) |
|
90 | 92 | return result |
|
91 | 93 | |
|
94 | @testdec.skip_doctest | |
|
92 | 95 | def magic_px(self, ipself, parameter_s=''): |
|
93 | 96 | """Executes the given python command in parallel. |
|
94 | 97 | |
@@ -112,6 +115,7 b' class ParalleMagicComponent(Component):' | |||
|
112 | 115 | result = self.active_multiengine_client.execute(parameter_s) |
|
113 | 116 | return result |
|
114 | 117 | |
|
118 | @testdec.skip_doctest | |
|
115 | 119 | def magic_autopx(self, ipself, parameter_s=''): |
|
116 | 120 | """Toggles auto parallel mode. |
|
117 | 121 |
@@ -39,7 +39,7 b' from IPython.core.error import TryNext' | |||
|
39 | 39 | from IPython.external import pretty |
|
40 | 40 | from IPython.core.component import Component |
|
41 | 41 | from IPython.utils.traitlets import Bool, List |
|
42 |
from IPython.utils. |
|
|
42 | from IPython.utils.io import Term | |
|
43 | 43 | from IPython.utils.autoattr import auto_attr |
|
44 | 44 | from IPython.utils.importstring import import_item |
|
45 | 45 | |
@@ -135,6 +135,7 b' def load_ipython_extension(ip):' | |||
|
135 | 135 | prd = PrettyResultDisplay(ip, name='pretty_result_display') |
|
136 | 136 | ip.set_hook('result_display', prd, priority=99) |
|
137 | 137 | _loaded = True |
|
138 | return prd | |
|
138 | 139 | |
|
139 | 140 | def unload_ipython_extension(ip): |
|
140 | 141 | """Unload the extension.""" |
@@ -163,60 +164,3 b' def dtype_pprinter(obj, p, cycle):' | |||
|
163 | 164 | p.breakable() |
|
164 | 165 | p.pretty(field) |
|
165 | 166 | p.end_group(7, '])') |
|
166 | ||
|
167 | ||
|
168 | #----------------------------------------------------------------------------- | |
|
169 | # Tests | |
|
170 | #----------------------------------------------------------------------------- | |
|
171 | ||
|
172 | ||
|
173 | def test_pretty(): | |
|
174 | """ | |
|
175 | In [1]: from IPython.extensions import ipy_pretty | |
|
176 | ||
|
177 | In [2]: ipy_pretty.activate() | |
|
178 | ||
|
179 | In [3]: class A(object): | |
|
180 | ...: def __repr__(self): | |
|
181 | ...: return 'A()' | |
|
182 | ...: | |
|
183 | ...: | |
|
184 | ||
|
185 | In [4]: a = A() | |
|
186 | ||
|
187 | In [5]: a | |
|
188 | Out[5]: A() | |
|
189 | ||
|
190 | In [6]: def a_pretty_printer(obj, p, cycle): | |
|
191 | ...: p.text('<A>') | |
|
192 | ...: | |
|
193 | ...: | |
|
194 | ||
|
195 | In [7]: ipy_pretty.for_type(A, a_pretty_printer) | |
|
196 | ||
|
197 | In [8]: a | |
|
198 | Out[8]: <A> | |
|
199 | ||
|
200 | In [9]: class B(object): | |
|
201 | ...: def __repr__(self): | |
|
202 | ...: return 'B()' | |
|
203 | ...: | |
|
204 | ...: | |
|
205 | ||
|
206 | In [10]: B.__module__, B.__name__ | |
|
207 | Out[10]: ('__main__', 'B') | |
|
208 | ||
|
209 | In [11]: def b_pretty_printer(obj, p, cycle): | |
|
210 | ....: p.text('<B>') | |
|
211 | ....: | |
|
212 | ....: | |
|
213 | ||
|
214 | In [12]: ipy_pretty.for_type_by_name('__main__', 'B', b_pretty_printer) | |
|
215 | ||
|
216 | In [13]: b = B() | |
|
217 | ||
|
218 | In [14]: b | |
|
219 | Out[14]: <B> | |
|
220 | """ | |
|
221 | assert False, "This should only be doctested, not run." | |
|
222 |
@@ -15,21 +15,20 b' Simple tests for :mod:`IPython.extensions.pretty`.' | |||
|
15 | 15 | # Imports |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | import sys | |
|
19 | 18 | from unittest import TestCase |
|
20 | 19 | |
|
21 | 20 | from IPython.core.component import Component, masquerade_as |
|
22 | 21 | from IPython.core.iplib import InteractiveShell |
|
23 | 22 | from IPython.extensions import pretty as pretty_ext |
|
24 | 23 | from IPython.external import pretty |
|
25 | ||
|
24 | from IPython.testing import decorators as dec | |
|
25 | from IPython.testing import tools as tt | |
|
26 | 26 | from IPython.utils.traitlets import Bool |
|
27 | 27 | |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | # Tests |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | |
|
32 | ||
|
33 | 32 | class InteractiveShellStub(Component): |
|
34 | 33 | pprint = Bool(True) |
|
35 | 34 | |
@@ -43,9 +42,11 b' class TestPrettyResultDisplay(TestCase):' | |||
|
43 | 42 | |
|
44 | 43 | def setUp(self): |
|
45 | 44 | self.ip = InteractiveShellStub(None) |
|
46 |
# This allows our stub to be retrieved instead of the real |
|
|
45 | # This allows our stub to be retrieved instead of the real | |
|
46 | # InteractiveShell | |
|
47 | 47 | masquerade_as(self.ip, InteractiveShell) |
|
48 |
self.prd = pretty_ext.PrettyResultDisplay(self.ip, |
|
|
48 | self.prd = pretty_ext.PrettyResultDisplay(self.ip, | |
|
49 | name='pretty_result_display') | |
|
49 | 50 | |
|
50 | 51 | def test_for_type(self): |
|
51 | 52 | self.prd.for_type(A, a_pprinter) |
@@ -53,4 +54,48 b' class TestPrettyResultDisplay(TestCase):' | |||
|
53 | 54 | result = pretty.pretty(a) |
|
54 | 55 | self.assertEquals(result, "<A>") |
|
55 | 56 | |
|
57 | ipy_src = """ | |
|
58 | class A(object): | |
|
59 | def __repr__(self): | |
|
60 | return 'A()' | |
|
61 | ||
|
62 | class B(object): | |
|
63 | def __repr__(self): | |
|
64 | return 'B()' | |
|
65 | ||
|
66 | a = A() | |
|
67 | b = B() | |
|
68 | ||
|
69 | def a_pretty_printer(obj, p, cycle): | |
|
70 | p.text('<A>') | |
|
71 | ||
|
72 | def b_pretty_printer(obj, p, cycle): | |
|
73 | p.text('<B>') | |
|
74 | ||
|
75 | ||
|
76 | a | |
|
77 | b | |
|
78 | ||
|
79 | ip = get_ipython() | |
|
80 | prd = ip.load_extension('pretty') | |
|
81 | prd.for_type(A, a_pretty_printer) | |
|
82 | prd.for_type_by_name(B.__module__, B.__name__, b_pretty_printer) | |
|
83 | ||
|
84 | a | |
|
85 | b | |
|
86 | """ | |
|
87 | ipy_out = """ | |
|
88 | A() | |
|
89 | B() | |
|
90 | <A> | |
|
91 | <B> | |
|
92 | """ | |
|
93 | ||
|
94 | class TestPrettyInteractively(tt.TempFileMixin): | |
|
56 | 95 | |
|
96 | # XXX Unfortunately, ipexec_validate fails under win32. If someone helps | |
|
97 | # us write a win32-compatible version, we can reactivate this test. | |
|
98 | @dec.skip_win32 | |
|
99 | def test_printers(self): | |
|
100 | self.mktmp(ipy_src, '.ipy') | |
|
101 | tt.ipexec_validate(self.fname, ipy_out) |
@@ -2,25 +2,17 b'' | |||
|
2 | 2 | |
|
3 | 3 | # Copyright © 2006-2009 Steven J. Bethard <steven.bethard@gmail.com>. |
|
4 | 4 | # |
|
5 | # Redistribution and use in source and binary forms, with or without | |
|
6 | # modification, are permitted provided that the following conditions are met: | |
|
5 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not | |
|
6 | # use this file except in compliance with the License. You may obtain a copy | |
|
7 | # of the License at | |
|
7 | 8 | # |
|
8 | # * Redistributions of source code must retain the above copyright notice, this | |
|
9 | # list of conditions and the following disclaimer. | |
|
10 | # * Redistributions in binary form must reproduce the above copyright notice, | |
|
11 | # this list of conditions and the following disclaimer in the documentation | |
|
12 | # and/or other materials provided with the distribution. | |
|
9 | # http://www.apache.org/licenses/LICENSE-2.0 | |
|
13 | 10 | # |
|
14 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
|
15 | # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
|
16 | # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
|
17 | # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
|
18 | # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
|
19 | # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
|
20 | # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
|
21 | # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
|
22 | # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
|
23 | # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
|
11 | # Unless required by applicable law or agreed to in writing, software | |
|
12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | |
|
13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | |
|
14 | # License for the specific language governing permissions and limitations | |
|
15 | # under the License. | |
|
24 | 16 | |
|
25 | 17 | """Command-line parsing library |
|
26 | 18 | |
@@ -83,7 +75,7 b' considered public as object names -- the API of the formatter objects is' | |||
|
83 | 75 | still considered an implementation detail.) |
|
84 | 76 | """ |
|
85 | 77 | |
|
86 |
__version__ = '1. |
|
|
78 | __version__ = '1.1a1' | |
|
87 | 79 | __all__ = [ |
|
88 | 80 | 'ArgumentParser', |
|
89 | 81 | 'ArgumentError', |
@@ -92,7 +84,7 b' __all__ = [' | |||
|
92 | 84 | 'FileType', |
|
93 | 85 | 'HelpFormatter', |
|
94 | 86 | 'RawDescriptionHelpFormatter', |
|
95 | 'RawTextHelpFormatter' | |
|
87 | 'RawTextHelpFormatter', | |
|
96 | 88 | 'ArgumentDefaultsHelpFormatter', |
|
97 | 89 | ] |
|
98 | 90 | |
@@ -126,6 +118,10 b' except NameError:' | |||
|
126 | 118 | result.reverse() |
|
127 | 119 | return result |
|
128 | 120 | |
|
121 | ||
|
122 | def _callable(obj): | |
|
123 | return hasattr(obj, '__call__') or hasattr(obj, '__bases__') | |
|
124 | ||
|
129 | 125 | # silence Python 2.6 buggy warnings about Exception.message |
|
130 | 126 | if _sys.version_info[:2] == (2, 6): |
|
131 | 127 | import warnings |
@@ -141,7 +137,8 b" SUPPRESS = '==SUPPRESS=='" | |||
|
141 | 137 | OPTIONAL = '?' |
|
142 | 138 | ZERO_OR_MORE = '*' |
|
143 | 139 | ONE_OR_MORE = '+' |
|
144 |
PARSER = ' |
|
|
140 | PARSER = 'A...' | |
|
141 | REMAINDER = '...' | |
|
145 | 142 | |
|
146 | 143 | # ============================= |
|
147 | 144 | # Utility functions and classes |
@@ -508,6 +505,8 b' class HelpFormatter(object):' | |||
|
508 | 505 | return text |
|
509 | 506 | |
|
510 | 507 | def _format_text(self, text): |
|
508 | if '%(prog)' in text: | |
|
509 | text = text % dict(prog=self._prog) | |
|
511 | 510 | text_width = self._width - self._current_indent |
|
512 | 511 | indent = ' ' * self._current_indent |
|
513 | 512 | return self._fill_text(text, text_width, indent) + '\n\n' |
@@ -608,7 +607,9 b' class HelpFormatter(object):' | |||
|
608 | 607 | result = '[%s [%s ...]]' % get_metavar(2) |
|
609 | 608 | elif action.nargs == ONE_OR_MORE: |
|
610 | 609 | result = '%s [%s ...]' % get_metavar(2) |
|
611 |
elif action.nargs |
|
|
610 | elif action.nargs == REMAINDER: | |
|
611 | result = '...' | |
|
612 | elif action.nargs == PARSER: | |
|
612 | 613 | result = '%s ...' % get_metavar(1) |
|
613 | 614 | else: |
|
614 | 615 | formats = ['%s' for _ in range(action.nargs)] |
@@ -724,6 +725,12 b' class ArgumentError(Exception):' | |||
|
724 | 725 | return format % dict(message=self.message, |
|
725 | 726 | argument_name=self.argument_name) |
|
726 | 727 | |
|
728 | ||
|
729 | class ArgumentTypeError(Exception): | |
|
730 | """An error from trying to convert a command line string to a type.""" | |
|
731 | pass | |
|
732 | ||
|
733 | ||
|
727 | 734 | # ============== |
|
728 | 735 | # Action classes |
|
729 | 736 | # ============== |
@@ -1018,6 +1025,7 b' class _VersionAction(Action):' | |||
|
1018 | 1025 | |
|
1019 | 1026 | def __init__(self, |
|
1020 | 1027 | option_strings, |
|
1028 | version=None, | |
|
1021 | 1029 | dest=SUPPRESS, |
|
1022 | 1030 | default=SUPPRESS, |
|
1023 | 1031 | help=None): |
@@ -1027,10 +1035,15 b' class _VersionAction(Action):' | |||
|
1027 | 1035 | default=default, |
|
1028 | 1036 | nargs=0, |
|
1029 | 1037 | help=help) |
|
1038 | self.version = version | |
|
1030 | 1039 | |
|
1031 | 1040 | def __call__(self, parser, namespace, values, option_string=None): |
|
1032 | parser.print_version() | |
|
1033 | parser.exit() | |
|
1041 | version = self.version | |
|
1042 | if version is None: | |
|
1043 | version = parser.version | |
|
1044 | formatter = parser._get_formatter() | |
|
1045 | formatter.add_text(version) | |
|
1046 | parser.exit(message=formatter.format_help()) | |
|
1034 | 1047 | |
|
1035 | 1048 | |
|
1036 | 1049 | class _SubParsersAction(Action): |
@@ -1156,8 +1169,7 b' class Namespace(_AttributeHolder):' | |||
|
1156 | 1169 | """ |
|
1157 | 1170 | |
|
1158 | 1171 | def __init__(self, **kwargs): |
|
1159 | for name in kwargs: | |
|
1160 | setattr(self, name, kwargs[name]) | |
|
1172 | self.__dict__.update(**kwargs) | |
|
1161 | 1173 | |
|
1162 | 1174 | def __eq__(self, other): |
|
1163 | 1175 | return vars(self) == vars(other) |
@@ -1165,6 +1177,9 b' class Namespace(_AttributeHolder):' | |||
|
1165 | 1177 | def __ne__(self, other): |
|
1166 | 1178 | return not (self == other) |
|
1167 | 1179 | |
|
1180 | def __contains__(self, key): | |
|
1181 | return key in self.__dict__ | |
|
1182 | ||
|
1168 | 1183 | |
|
1169 | 1184 | class _ActionsContainer(object): |
|
1170 | 1185 | |
@@ -1211,7 +1226,7 b' class _ActionsContainer(object):' | |||
|
1211 | 1226 | self._defaults = {} |
|
1212 | 1227 | |
|
1213 | 1228 | # determines whether an "option" looks like a negative number |
|
1214 | self._negative_number_matcher = _re.compile(r'^-\d+|-\d*.\d+$') | |
|
1229 | self._negative_number_matcher = _re.compile(r'^-\d+$|^-\d*\.\d+$') | |
|
1215 | 1230 | |
|
1216 | 1231 | # whether or not there are any optionals that look like negative |
|
1217 | 1232 | # numbers -- uses a list so it can be shared and edited |
@@ -1228,7 +1243,7 b' class _ActionsContainer(object):' | |||
|
1228 | 1243 | return self._registries[registry_name].get(value, default) |
|
1229 | 1244 | |
|
1230 | 1245 | # ================================== |
|
1231 |
# Namespace default |
|
|
1246 | # Namespace default accessor methods | |
|
1232 | 1247 | # ================================== |
|
1233 | 1248 | def set_defaults(self, **kwargs): |
|
1234 | 1249 | self._defaults.update(kwargs) |
@@ -1239,6 +1254,13 b' class _ActionsContainer(object):' | |||
|
1239 | 1254 | if action.dest in kwargs: |
|
1240 | 1255 | action.default = kwargs[action.dest] |
|
1241 | 1256 | |
|
1257 | def get_default(self, dest): | |
|
1258 | for action in self._actions: | |
|
1259 | if action.dest == dest and action.default is not None: | |
|
1260 | return action.default | |
|
1261 | return self._defaults.get(dest, None) | |
|
1262 | ||
|
1263 | ||
|
1242 | 1264 | # ======================= |
|
1243 | 1265 | # Adding argument actions |
|
1244 | 1266 | # ======================= |
@@ -1253,6 +1275,8 b' class _ActionsContainer(object):' | |||
|
1253 | 1275 | # argument |
|
1254 | 1276 | chars = self.prefix_chars |
|
1255 | 1277 | if not args or len(args) == 1 and args[0][0] not in chars: |
|
1278 | if args and 'dest' in kwargs: | |
|
1279 | raise ValueError('dest supplied twice for positional argument') | |
|
1256 | 1280 | kwargs = self._get_positional_kwargs(*args, **kwargs) |
|
1257 | 1281 | |
|
1258 | 1282 | # otherwise, we're adding an optional argument |
@@ -1269,6 +1293,8 b' class _ActionsContainer(object):' | |||
|
1269 | 1293 | |
|
1270 | 1294 | # create the action object, and add it to the parser |
|
1271 | 1295 | action_class = self._pop_action_class(kwargs) |
|
1296 | if not _callable(action_class): | |
|
1297 | raise ValueError('unknown action "%s"' % action_class) | |
|
1272 | 1298 | action = action_class(**kwargs) |
|
1273 | 1299 | return self._add_action(action) |
|
1274 | 1300 | |
@@ -1578,6 +1604,7 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
1578 | 1604 | if self.version: |
|
1579 | 1605 | self.add_argument( |
|
1580 | 1606 | '-v', '--version', action='version', default=SUPPRESS, |
|
1607 | version=self.version, | |
|
1581 | 1608 | help=_("show program's version number and exit")) |
|
1582 | 1609 | |
|
1583 | 1610 | # add parent arguments and defaults |
@@ -2011,6 +2038,13 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2011 | 2038 | action = self._option_string_actions[arg_string] |
|
2012 | 2039 | return action, arg_string, None |
|
2013 | 2040 | |
|
2041 | # if the option string before the "=" is present, return the action | |
|
2042 | if '=' in arg_string: | |
|
2043 | option_string, explicit_arg = arg_string.split('=', 1) | |
|
2044 | if option_string in self._option_string_actions: | |
|
2045 | action = self._option_string_actions[option_string] | |
|
2046 | return action, option_string, explicit_arg | |
|
2047 | ||
|
2014 | 2048 | # search through all possible prefixes of the option string |
|
2015 | 2049 | # and all actions in the parser for possible interpretations |
|
2016 | 2050 | option_tuples = self._get_option_tuples(arg_string) |
@@ -2108,8 +2142,12 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2108 | 2142 | elif nargs == ONE_OR_MORE: |
|
2109 | 2143 | nargs_pattern = '(-*A[A-]*)' |
|
2110 | 2144 | |
|
2145 | # allow any number of options or arguments | |
|
2146 | elif nargs == REMAINDER: | |
|
2147 | nargs_pattern = '([-AO]*)' | |
|
2148 | ||
|
2111 | 2149 | # allow one argument followed by any number of options or arguments |
|
2112 |
elif nargs |
|
|
2150 | elif nargs == PARSER: | |
|
2113 | 2151 | nargs_pattern = '(-*A[-AO]*)' |
|
2114 | 2152 | |
|
2115 | 2153 | # all others should be integers |
@@ -2129,7 +2167,7 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2129 | 2167 | # ======================== |
|
2130 | 2168 | def _get_values(self, action, arg_strings): |
|
2131 | 2169 | # for everything but PARSER args, strip out '--' |
|
2132 |
if action.nargs |
|
|
2170 | if action.nargs not in [PARSER, REMAINDER]: | |
|
2133 | 2171 | arg_strings = [s for s in arg_strings if s != '--'] |
|
2134 | 2172 | |
|
2135 | 2173 | # optional argument produces a default when not present |
@@ -2158,8 +2196,12 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2158 | 2196 | value = self._get_value(action, arg_string) |
|
2159 | 2197 | self._check_value(action, value) |
|
2160 | 2198 | |
|
2199 | # REMAINDER arguments convert all values, checking none | |
|
2200 | elif action.nargs == REMAINDER: | |
|
2201 | value = [self._get_value(action, v) for v in arg_strings] | |
|
2202 | ||
|
2161 | 2203 | # PARSER arguments convert all values, but check only the first |
|
2162 |
elif action.nargs |
|
|
2204 | elif action.nargs == PARSER: | |
|
2163 | 2205 | value = [self._get_value(action, v) for v in arg_strings] |
|
2164 | 2206 | self._check_value(action, value[0]) |
|
2165 | 2207 | |
@@ -2174,8 +2216,7 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2174 | 2216 | |
|
2175 | 2217 | def _get_value(self, action, arg_string): |
|
2176 | 2218 | type_func = self._registry_get('type', action.type, action.type) |
|
2177 |
if not |
|
|
2178 | if not hasattr(type_func, '__bases__'): # classic classes | |
|
2219 | if not _callable(type_func): | |
|
2179 | 2220 |
|
|
2180 | 2221 |
|
|
2181 | 2222 | |
@@ -2183,7 +2224,13 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2183 | 2224 | try: |
|
2184 | 2225 | result = type_func(arg_string) |
|
2185 | 2226 | |
|
2186 |
# Typ |
|
|
2227 | # ArgumentTypeErrors indicate errors | |
|
2228 | except ArgumentTypeError: | |
|
2229 | name = getattr(action.type, '__name__', repr(action.type)) | |
|
2230 | msg = str(_sys.exc_info()[1]) | |
|
2231 | raise ArgumentError(action, msg) | |
|
2232 | ||
|
2233 | # TypeErrors or ValueErrors also indicate errors | |
|
2187 | 2234 | except (TypeError, ValueError): |
|
2188 | 2235 | name = getattr(action.type, '__name__', repr(action.type)) |
|
2189 | 2236 | msg = _('invalid %s value: %r') |
@@ -2243,9 +2290,13 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2243 | 2290 | # Help-printing methods |
|
2244 | 2291 | # ===================== |
|
2245 | 2292 | def print_usage(self, file=None): |
|
2293 | if file is None: | |
|
2294 | file = _sys.stdout | |
|
2246 | 2295 | self._print_message(self.format_usage(), file) |
|
2247 | 2296 | |
|
2248 | 2297 | def print_help(self, file=None): |
|
2298 | if file is None: | |
|
2299 | file = _sys.stdout | |
|
2249 | 2300 | self._print_message(self.format_help(), file) |
|
2250 | 2301 | |
|
2251 | 2302 | def print_version(self, file=None): |
@@ -2262,7 +2313,7 b' class ArgumentParser(_AttributeHolder, _ActionsContainer):' | |||
|
2262 | 2313 | # =============== |
|
2263 | 2314 | def exit(self, status=0, message=None): |
|
2264 | 2315 | if message: |
|
2265 | _sys.stderr.write(message) | |
|
2316 | self._print_message(message, _sys.stderr) | |
|
2266 | 2317 | _sys.exit(status) |
|
2267 | 2318 | |
|
2268 | 2319 | def error(self, message): |
@@ -213,7 +213,7 b' def main():' | |||
|
213 | 213 | print "\n".join(expand(sys.argv[1:])), |
|
214 | 214 | |
|
215 | 215 | def mglob_f(self, arg): |
|
216 |
from IPython.utils. |
|
|
216 | from IPython.utils.text import SList | |
|
217 | 217 | if arg.strip(): |
|
218 | 218 | return SList(expand(arg)) |
|
219 | 219 | print "Please specify pattern!" |
@@ -39,9 +39,10 b' def common_prefix(strings):' | |||
|
39 | 39 | |
|
40 | 40 | return prefix |
|
41 | 41 | |
|
42 |
#----------------------------------------------------------------------------- |
|
|
42 | #----------------------------------------------------------------------------- | |
|
43 | 43 | # Base class for the line-oriented front ends |
|
44 |
#----------------------------------------------------------------------------- |
|
|
44 | #----------------------------------------------------------------------------- | |
|
45 | ||
|
45 | 46 | class LineFrontEndBase(FrontEndBase): |
|
46 | 47 | """ Concrete implementation of the FrontEndBase class. This is meant |
|
47 | 48 | to be the base class behind all the frontend that are line-oriented, |
@@ -9,7 +9,6 b' functionnality is abstracted out of ipython0 in reusable functions and' | |||
|
9 | 9 | is added on the interpreter. This class can be a used to guide this |
|
10 | 10 | refactoring. |
|
11 | 11 | """ |
|
12 | __docformat__ = "restructuredtext en" | |
|
13 | 12 | |
|
14 | 13 | #------------------------------------------------------------------------------- |
|
15 | 14 | # Copyright (C) 2008 The IPython Development Team |
@@ -27,15 +26,18 b' import os' | |||
|
27 | 26 | import re |
|
28 | 27 | import __builtin__ |
|
29 | 28 | |
|
30 |
from IPython.core.ip |
|
|
29 | from IPython.core.iplib import InteractiveShell | |
|
31 | 30 | from IPython.kernel.core.redirector_output_trap import RedirectorOutputTrap |
|
32 | 31 | |
|
33 | 32 | from IPython.kernel.core.sync_traceback_trap import SyncTracebackTrap |
|
34 | 33 | |
|
35 |
from IPython.utils. |
|
|
34 | from IPython.utils.io import Term | |
|
36 | 35 | |
|
37 | 36 | from linefrontendbase import LineFrontEndBase, common_prefix |
|
38 | 37 | |
|
38 | #----------------------------------------------------------------------------- | |
|
39 | # Utility functions | |
|
40 | #----------------------------------------------------------------------------- | |
|
39 | 41 | |
|
40 | 42 | def mk_system_call(system_call_function, command): |
|
41 | 43 | """ given a os.system replacement, and a leading string command, |
@@ -48,9 +50,10 b' def mk_system_call(system_call_function, command):' | |||
|
48 | 50 | my_system_call.__doc__ = "Calls %s" % command |
|
49 | 51 | return my_system_call |
|
50 | 52 | |
|
51 |
#----------------------------------------------------------------------------- |
|
|
53 | #----------------------------------------------------------------------------- | |
|
52 | 54 | # Frontend class using ipython0 to do the prefiltering. |
|
53 |
#----------------------------------------------------------------------------- |
|
|
55 | #----------------------------------------------------------------------------- | |
|
56 | ||
|
54 | 57 | class PrefilterFrontEnd(LineFrontEndBase): |
|
55 | 58 | """ Class that uses ipython0 to do prefilter the input, do the |
|
56 | 59 | completion and the magics. |
@@ -63,25 +66,13 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
63 | 66 | |
|
64 | 67 | debug = False |
|
65 | 68 | |
|
66 |
def __init__(self, ipython0=None, |
|
|
69 | def __init__(self, ipython0=None, *args, **kwargs): | |
|
67 | 70 | """ Parameters |
|
68 | 71 | ---------- |
|
69 | 72 | |
|
70 | 73 | ipython0: an optional ipython0 instance to use for command |
|
71 | 74 | prefiltering and completion. |
|
72 | ||
|
73 | argv : list, optional | |
|
74 | Used as the instance's argv value. If not given, [] is used. | |
|
75 | 75 | """ |
|
76 | if argv is None: | |
|
77 | argv = [] | |
|
78 | # This is a hack to avoid the IPython exception hook to trigger | |
|
79 | # on exceptions (https://bugs.launchpad.net/bugs/337105) | |
|
80 | # XXX: This is horrible: module-leve monkey patching -> side | |
|
81 | # effects. | |
|
82 | from IPython.core import iplib | |
|
83 | iplib.InteractiveShell.isthreaded = True | |
|
84 | ||
|
85 | 76 | LineFrontEndBase.__init__(self, *args, **kwargs) |
|
86 | 77 | self.shell.output_trap = RedirectorOutputTrap( |
|
87 | 78 | out_callback=self.write, |
@@ -94,17 +85,17 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
94 | 85 | # Start the ipython0 instance: |
|
95 | 86 | self.save_output_hooks() |
|
96 | 87 | if ipython0 is None: |
|
97 |
# Instanciate an IPython0 |
|
|
88 | # Instanciate an IPython0 InteractiveShell to be able to use the | |
|
98 | 89 | # prefiltering. |
|
99 | 90 | # Suppress all key input, to avoid waiting |
|
100 | 91 | def my_rawinput(x=None): |
|
101 | 92 | return '\n' |
|
102 | 93 | old_rawinput = __builtin__.raw_input |
|
103 | 94 | __builtin__.raw_input = my_rawinput |
|
104 | # XXX: argv=[] is a bit bold. | |
|
105 | ipython0 = make_IPython(argv=argv, | |
|
106 |
|
|
|
107 | user_global_ns=self.shell.user_global_ns) | |
|
95 | ipython0 = InteractiveShell( | |
|
96 | parent=None, user_ns=self.shell.user_ns, | |
|
97 | user_global_ns=self.shell.user_global_ns | |
|
98 | ) | |
|
108 | 99 | __builtin__.raw_input = old_rawinput |
|
109 | 100 | self.ipython0 = ipython0 |
|
110 | 101 | # Set the pager: |
@@ -125,7 +116,7 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
125 | 116 | |
|
126 | 117 | |
|
127 | 118 | if not 'banner' in kwargs and self.banner is None: |
|
128 |
self.banner = self.ipython0. |
|
|
119 | self.banner = self.ipython0.banner | |
|
129 | 120 | |
|
130 | 121 | # FIXME: __init__ and start should be two different steps |
|
131 | 122 | self.start() |
@@ -204,7 +195,6 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
204 | 195 | line = line[:-len(word)] + prefix |
|
205 | 196 |
return line, completions |
|
206 | 197 | |
|
207 | ||
|
208 | 198 | #-------------------------------------------------------------------------- |
|
209 | 199 | # LineFrontEndBase interface |
|
210 | 200 | #-------------------------------------------------------------------------- |
@@ -220,23 +210,11 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
220 | 210 | self.capture_output() |
|
221 | 211 | self.last_result = dict(number=self.prompt_number) |
|
222 | 212 | |
|
223 | ## try: | |
|
224 | ## for line in input_string.split('\n'): | |
|
225 | ## filtered_lines.append( | |
|
226 | ## self.ipython0.prefilter(line, False).rstrip()) | |
|
227 | ## except: | |
|
228 | ## # XXX: probably not the right thing to do. | |
|
229 | ## self.ipython0.showsyntaxerror() | |
|
230 | ## self.after_execute() | |
|
231 | ## finally: | |
|
232 | ## self.release_output() | |
|
233 | ||
|
234 | ||
|
235 | 213 | try: |
|
236 | 214 | try: |
|
237 | 215 | for line in input_string.split('\n'): |
|
238 | filtered_lines.append( | |
|
239 |
|
|
|
216 | pf = self.ipython0.prefilter_manager.prefilter_lines | |
|
217 | filtered_lines.append(pf(line, False).rstrip()) | |
|
240 | 218 | except: |
|
241 | 219 | # XXX: probably not the right thing to do. |
|
242 | 220 | self.ipython0.showsyntaxerror() |
@@ -244,13 +222,10 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
244 | 222 | finally: |
|
245 | 223 | self.release_output() |
|
246 | 224 | |
|
247 | ||
|
248 | ||
|
249 | 225 | # Clean up the trailing whitespace, to avoid indentation errors |
|
250 | 226 | filtered_string = '\n'.join(filtered_lines) |
|
251 | 227 | return filtered_string |
|
252 | 228 | |
|
253 | ||
|
254 | 229 | #-------------------------------------------------------------------------- |
|
255 | 230 | # PrefilterFrontEnd interface |
|
256 | 231 | #-------------------------------------------------------------------------- |
@@ -261,13 +236,11 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
261 | 236 | """ |
|
262 | 237 | return os.system(command_string) |
|
263 | 238 | |
|
264 | ||
|
265 | 239 | def do_exit(self): |
|
266 | 240 | """ Exit the shell, cleanup and save the history. |
|
267 | 241 | """ |
|
268 | 242 | self.ipython0.atexit_operations() |
|
269 | 243 | |
|
270 | ||
|
271 | 244 | def _get_completion_text(self, line): |
|
272 | 245 | """ Returns the text to be completed by breaking the line at specified |
|
273 | 246 | delimiters. |
@@ -281,4 +254,3 b' class PrefilterFrontEnd(LineFrontEndBase):' | |||
|
281 | 254 | complete_sep = re.compile(expression) |
|
282 | 255 | text = complete_sep.split(line)[-1] |
|
283 | 256 | return text |
|
284 |
@@ -1,14 +1,8 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | ||
|
3 | 2 | """This file contains unittests for the asyncfrontendbase module.""" |
|
4 | 3 | |
|
5 | __docformat__ = "restructuredtext en" | |
|
6 | ||
|
7 | # Tell nose to skip this module | |
|
8 | __test__ = {} | |
|
9 | ||
|
10 | 4 | #--------------------------------------------------------------------------- |
|
11 | # Copyright (C) 2008 The IPython Development Team | |
|
5 | # Copyright (C) 2008-2009 The IPython Development Team | |
|
12 | 6 | # |
|
13 | 7 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | 8 | # the file COPYING, distributed as part of this software. |
@@ -20,9 +20,11 b' import sys' | |||
|
20 | 20 | from nose.tools import assert_equal |
|
21 | 21 | |
|
22 | 22 | from IPython.frontend.prefilterfrontend import PrefilterFrontEnd |
|
23 |
from IPython. |
|
|
24 | from IPython.testing.plugin.ipdoctest import default_argv | |
|
23 | from IPython.testing.globalipapp import get_ipython | |
|
25 | 24 | |
|
25 | #----------------------------------------------------------------------------- | |
|
26 | # Support utilities | |
|
27 | #----------------------------------------------------------------------------- | |
|
26 | 28 | |
|
27 | 29 | class TestPrefilterFrontEnd(PrefilterFrontEnd): |
|
28 | 30 | |
@@ -32,7 +34,7 b' class TestPrefilterFrontEnd(PrefilterFrontEnd):' | |||
|
32 | 34 | |
|
33 | 35 | def __init__(self): |
|
34 | 36 | self.out = StringIO() |
|
35 |
PrefilterFrontEnd.__init__(self |
|
|
37 | PrefilterFrontEnd.__init__(self) | |
|
36 | 38 | # Some more code for isolation (yeah, crazy) |
|
37 | 39 | self._on_enter() |
|
38 | 40 | self.out.flush() |
@@ -57,7 +59,7 b' def isolate_ipython0(func):' | |||
|
57 | 59 | with arguments. |
|
58 | 60 | """ |
|
59 | 61 | def my_func(): |
|
60 |
ip0 = get_ipython |
|
|
62 | ip0 = get_ipython() | |
|
61 | 63 | if ip0 is None: |
|
62 | 64 | return func() |
|
63 | 65 | # We have a real ipython running... |
@@ -85,14 +87,14 b' def isolate_ipython0(func):' | |||
|
85 | 87 | del user_ns[k] |
|
86 | 88 | for k in new_globals: |
|
87 | 89 | del user_global_ns[k] |
|
88 | # Undo the hack at creation of PrefilterFrontEnd | |
|
89 | from IPython.core import iplib | |
|
90 | iplib.InteractiveShell.isthreaded = False | |
|
91 | 90 | return out |
|
92 | 91 | |
|
93 | 92 | my_func.__name__ = func.__name__ |
|
94 | 93 | return my_func |
|
95 | 94 | |
|
95 | #----------------------------------------------------------------------------- | |
|
96 | # Tests | |
|
97 | #----------------------------------------------------------------------------- | |
|
96 | 98 | |
|
97 | 99 | @isolate_ipython0 |
|
98 | 100 | def test_execution(): |
@@ -47,6 +47,7 b' def test_io():' | |||
|
47 | 47 | assert result == test_string |
|
48 | 48 | |
|
49 | 49 | |
|
50 | @testdec.skip_win32 | |
|
50 | 51 | def test_kill(): |
|
51 | 52 | """ Check that we can kill a process, and its subprocess. |
|
52 | 53 | """ |
@@ -135,9 +135,10 b' else:' | |||
|
135 | 135 | } |
|
136 | 136 | |
|
137 | 137 | |
|
138 |
#----------------------------------------------------------------------------- |
|
|
138 | #----------------------------------------------------------------------------- | |
|
139 | 139 | # The console widget class |
|
140 |
#----------------------------------------------------------------------------- |
|
|
140 | #----------------------------------------------------------------------------- | |
|
141 | ||
|
141 | 142 | class ConsoleWidget(editwindow.EditWindow): |
|
142 | 143 | """ Specialized styled text control view for console-like workflow. |
|
143 | 144 |
@@ -47,7 +47,7 b' class IPythonXController(WxController):' | |||
|
47 | 47 | self._input_state = 'subprocess' |
|
48 | 48 | self.write('\n', refresh=False) |
|
49 | 49 | self.capture_output() |
|
50 |
self.ipython0. |
|
|
50 | self.ipython0.exit() | |
|
51 | 51 | self.release_output() |
|
52 | 52 | if not self.ipython0.exit_now: |
|
53 | 53 | wx.CallAfter(self.new_prompt, |
@@ -23,13 +23,8 b' import os' | |||
|
23 | 23 | import locale |
|
24 | 24 | from thread_ex import ThreadEx |
|
25 | 25 | |
|
26 | try: | |
|
27 | import IPython | |
|
28 | from IPython.utils import genutils | |
|
29 | 26 |
|
|
30 | except Exception,e: | |
|
31 | print "Error importing IPython (%s)" % str(e) | |
|
32 | raise Exception, e | |
|
27 | from IPython.utils.io import Term | |
|
33 | 28 | |
|
34 | 29 | ############################################################################## |
|
35 | 30 | class _Helper(object): |
@@ -92,12 +87,10 b' class NonBlockingIPShell(object):' | |||
|
92 | 87 | via raise_exc() |
|
93 | 88 | ''' |
|
94 | 89 | |
|
95 |
def __init__(self |
|
|
90 | def __init__(self, user_ns={}, user_global_ns=None, | |
|
96 | 91 | cin=None, cout=None, cerr=None, |
|
97 | 92 | ask_exit_handler=None): |
|
98 | 93 | ''' |
|
99 | @param argv: Command line options for IPython | |
|
100 | @type argv: list | |
|
101 | 94 | @param user_ns: User namespace. |
|
102 | 95 | @type user_ns: dictionary |
|
103 | 96 | @param user_global_ns: User global namespace. |
@@ -115,7 +108,7 b' class NonBlockingIPShell(object):' | |||
|
115 | 108 | ''' |
|
116 | 109 | #ipython0 initialisation |
|
117 | 110 | self._IP = None |
|
118 |
self.init_ipython0( |
|
|
111 | self.init_ipython0(user_ns, user_global_ns, | |
|
119 | 112 | cin, cout, cerr, |
|
120 | 113 | ask_exit_handler) |
|
121 | 114 | |
@@ -135,7 +128,7 b' class NonBlockingIPShell(object):' | |||
|
135 | 128 | self._help_text = None |
|
136 | 129 | self._add_button = None |
|
137 | 130 | |
|
138 |
def init_ipython0(self |
|
|
131 | def init_ipython0(self, user_ns={}, user_global_ns=None, | |
|
139 | 132 | cin=None, cout=None, cerr=None, |
|
140 | 133 | ask_exit_handler=None): |
|
141 | 134 | ''' Initialize an ipython0 instance ''' |
@@ -145,22 +138,22 b' class NonBlockingIPShell(object):' | |||
|
145 | 138 | #only one instance can be instanciated else tehre will be |
|
146 | 139 | #cin/cout/cerr clash... |
|
147 | 140 | if cin: |
|
148 |
|
|
|
141 | Term.cin = cin | |
|
149 | 142 | if cout: |
|
150 |
|
|
|
143 | Term.cout = cout | |
|
151 | 144 | if cerr: |
|
152 |
|
|
|
145 | Term.cerr = cerr | |
|
153 | 146 | |
|
154 | 147 | excepthook = sys.excepthook |
|
155 | 148 | |
|
156 | 149 | #Hack to save sys.displayhook, because ipython seems to overwrite it... |
|
157 | 150 | self.sys_displayhook_ori = sys.displayhook |
|
158 | ||
|
159 | self._IP = IPython.shell.make_IPython( | |
|
160 |
|
|
|
161 |
|
|
|
162 | embedded=True, | |
|
163 | shell_class=IPython.shell.InteractiveShell) | |
|
151 | ipython0 = iplib.InteractiveShell( | |
|
152 | parent=None, config=None, | |
|
153 | user_ns=user_ns, | |
|
154 | user_global_ns=user_global_ns | |
|
155 | ) | |
|
156 | self._IP = ipython0 | |
|
164 | 157 | |
|
165 | 158 | #we save ipython0 displayhook and we restore sys.displayhook |
|
166 | 159 | self.displayhook = sys.displayhook |
@@ -184,12 +177,10 b' class NonBlockingIPShell(object):' | |||
|
184 | 177 | #we replace the help command |
|
185 | 178 | self._IP.user_ns['help'] = _Helper(self._pager_help) |
|
186 | 179 | |
|
187 | #we disable cpase magic... until we found a way to use it properly. | |
|
188 | from IPython.core import ipapi | |
|
189 | ip = ipapi.get() | |
|
180 | #we disable cpaste magic... until we found a way to use it properly. | |
|
190 | 181 | def bypass_magic(self, arg): |
|
191 | 182 | print '%this magic is currently disabled.' |
|
192 | ip.define_magic('cpaste', bypass_magic) | |
|
183 | ipython0.define_magic('cpaste', bypass_magic) | |
|
193 | 184 | |
|
194 | 185 | import __builtin__ |
|
195 | 186 | __builtin__.raw_input = self._raw_input |
@@ -273,7 +264,7 b' class NonBlockingIPShell(object):' | |||
|
273 | 264 | @return: The banner string. |
|
274 | 265 | @rtype: string |
|
275 | 266 | """ |
|
276 |
return self._IP. |
|
|
267 | return self._IP.banner | |
|
277 | 268 | |
|
278 | 269 | def get_prompt_count(self): |
|
279 | 270 | """ |
@@ -470,7 +461,7 b' class NonBlockingIPShell(object):' | |||
|
470 | 461 | ''' |
|
471 | 462 | |
|
472 | 463 | orig_stdout = sys.stdout |
|
473 |
sys.stdout = |
|
|
464 | sys.stdout = Term.cout | |
|
474 | 465 | #self.sys_displayhook_ori = sys.displayhook |
|
475 | 466 | #sys.displayhook = self.displayhook |
|
476 | 467 |
@@ -11,6 +11,7 b' __author__ = "Laurent Dufrechou"' | |||
|
11 | 11 | __email__ = "laurent.dufrechou _at_ gmail.com" |
|
12 | 12 | __license__ = "BSD" |
|
13 | 13 | #----------------------------------------- |
|
14 | ||
|
14 | 15 | class IPythonHistoryPanel(wx.Panel): |
|
15 | 16 | |
|
16 | 17 | def __init__(self, parent,flt_empty=True, |
|
1 | NO CONTENT: modified file |
@@ -27,7 +27,6 b' The main classes in this module are:' | |||
|
27 | 27 | # Imports |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | |
|
30 | from cStringIO import StringIO | |
|
31 | 30 | import sys |
|
32 | 31 | import warnings |
|
33 | 32 |
@@ -33,7 +33,7 b' from IPython.kernel.twistedutil import (' | |||
|
33 | 33 | sleep_deferred |
|
34 | 34 | ) |
|
35 | 35 | from IPython.utils.importstring import import_item |
|
36 |
from IPython.utils. |
|
|
36 | from IPython.utils.path import get_ipython_dir | |
|
37 | 37 | |
|
38 | 38 | from twisted.internet import defer |
|
39 | 39 | from twisted.internet.defer import inlineCallbacks, returnValue |
@@ -15,7 +15,7 b' __docformat__ = "restructuredtext en"' | |||
|
15 | 15 | # Imports |
|
16 | 16 | #------------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 |
from zope.interface import Interface |
|
|
18 | from zope.interface import Interface | |
|
19 | 19 | |
|
20 | 20 | class IFCClientInterfaceProvider(Interface): |
|
21 | 21 |
@@ -20,21 +20,36 b' from __future__ import with_statement' | |||
|
20 | 20 | import os |
|
21 | 21 | import shutil |
|
22 | 22 | import sys |
|
23 | import warnings | |
|
23 | 24 | |
|
24 | 25 | from twisted.python import log |
|
25 | 26 | |
|
26 | from IPython.core import release | |
|
27 | 27 | from IPython.config.loader import PyFileConfigLoader |
|
28 | from IPython.core.application import Application | |
|
28 | from IPython.core.application import Application, BaseAppConfigLoader | |
|
29 | 29 | from IPython.core.component import Component |
|
30 | from IPython.config.loader import ArgParseConfigLoader, NoConfigDefault | |
|
31 |
from IPython. |
|
|
32 |
from IPython.utils import |
|
|
30 | from IPython.core.crashhandler import CrashHandler | |
|
31 | from IPython.core import release | |
|
32 | from IPython.utils.path import ( | |
|
33 | get_ipython_package_dir, | |
|
34 | expand_path | |
|
35 | ) | |
|
36 | from IPython.utils.traitlets import Unicode | |
|
33 | 37 | |
|
34 | 38 | #----------------------------------------------------------------------------- |
|
35 | # Imports | |
|
39 | # Warnings control | |
|
36 | 40 | #----------------------------------------------------------------------------- |
|
41 | # Twisted generates annoying warnings with Python 2.6, as will do other code | |
|
42 | # that imports 'sets' as of today | |
|
43 | warnings.filterwarnings('ignore', 'the sets module is deprecated', | |
|
44 | DeprecationWarning ) | |
|
45 | ||
|
46 | # This one also comes from Twisted | |
|
47 | warnings.filterwarnings('ignore', 'the sha module is deprecated', | |
|
48 | DeprecationWarning) | |
|
37 | 49 | |
|
50 | #----------------------------------------------------------------------------- | |
|
51 | # Module errors | |
|
52 | #----------------------------------------------------------------------------- | |
|
38 | 53 | |
|
39 | 54 | class ClusterDirError(Exception): |
|
40 | 55 | pass |
@@ -44,6 +59,10 b' class PIDFileError(Exception):' | |||
|
44 | 59 | pass |
|
45 | 60 | |
|
46 | 61 | |
|
62 | #----------------------------------------------------------------------------- | |
|
63 | # Class for managing cluster directories | |
|
64 | #----------------------------------------------------------------------------- | |
|
65 | ||
|
47 | 66 | class ClusterDir(Component): |
|
48 | 67 | """An object to manage the cluster directory and its resources. |
|
49 | 68 | |
@@ -213,61 +232,110 b' class ClusterDir(Component):' | |||
|
213 | 232 | The path of the cluster directory. This is expanded using |
|
214 | 233 | :func:`IPython.utils.genutils.expand_path`. |
|
215 | 234 | """ |
|
216 |
cluster_dir = |
|
|
235 | cluster_dir = expand_path(cluster_dir) | |
|
217 | 236 | if not os.path.isdir(cluster_dir): |
|
218 | 237 | raise ClusterDirError('Cluster directory not found: %s' % cluster_dir) |
|
219 | 238 | return ClusterDir(cluster_dir) |
|
220 | 239 | |
|
221 | 240 | |
|
222 | class AppWithClusterDirArgParseConfigLoader(ArgParseConfigLoader): | |
|
223 | """Default command line options for IPython cluster applications.""" | |
|
241 | #----------------------------------------------------------------------------- | |
|
242 | # Command line options | |
|
243 | #----------------------------------------------------------------------------- | |
|
244 | ||
|
245 | class ClusterDirConfigLoader(BaseAppConfigLoader): | |
|
224 | 246 | |
|
225 |
def _add_ |
|
|
226 |
|
|
|
227 | dest='Global.ipython_dir',type=unicode, | |
|
228 | help='Set to override default location of Global.ipython_dir.', | |
|
229 | default=NoConfigDefault, | |
|
230 | metavar='Global.ipython_dir' | |
|
231 | ) | |
|
232 | self.parser.add_argument('-p', '--profile', | |
|
247 | def _add_cluster_profile(self, parser): | |
|
248 | paa = parser.add_argument | |
|
249 | paa('-p', '--profile', | |
|
233 | 250 | dest='Global.profile',type=unicode, |
|
234 | help='The string name of the profile to be used. This determines ' | |
|
235 | 'the name of the cluster dir as: cluster_<profile>. The default profile ' | |
|
236 | 'is named "default". The cluster directory is resolve this way ' | |
|
237 | 'if the --cluster-dir option is not used.', | |
|
238 | default=NoConfigDefault, | |
|
239 | metavar='Global.profile' | |
|
240 | ) | |
|
241 | self.parser.add_argument('--log-level', | |
|
242 | dest="Global.log_level",type=int, | |
|
243 | help='Set the log level (0,10,20,30,40,50). Default is 30.', | |
|
244 | default=NoConfigDefault, | |
|
245 | metavar="Global.log_level" | |
|
246 | ) | |
|
247 | self.parser.add_argument('--cluster-dir', | |
|
251 | help= | |
|
252 | """The string name of the profile to be used. This determines the name | |
|
253 | of the cluster dir as: cluster_<profile>. The default profile is named | |
|
254 | 'default'. The cluster directory is resolve this way if the | |
|
255 | --cluster-dir option is not used.""", | |
|
256 | metavar='Global.profile') | |
|
257 | ||
|
258 | def _add_cluster_dir(self, parser): | |
|
259 | paa = parser.add_argument | |
|
260 | paa('--cluster-dir', | |
|
248 | 261 | dest='Global.cluster_dir',type=unicode, |
|
249 |
help= |
|
|
250 |
|
|
|
251 | default=NoConfigDefault, | |
|
252 | metavar='Global.cluster_dir' | |
|
253 | ), | |
|
254 |
|
|
|
262 | help="""Set the cluster dir. This overrides the logic used by the | |
|
263 | --profile option.""", | |
|
264 | metavar='Global.cluster_dir') | |
|
265 | ||
|
266 | def _add_work_dir(self, parser): | |
|
267 | paa = parser.add_argument | |
|
268 | paa('--work-dir', | |
|
255 | 269 | dest='Global.work_dir',type=unicode, |
|
256 | 270 | help='Set the working dir for the process.', |
|
257 | default=NoConfigDefault, | |
|
258 | metavar='Global.work_dir' | |
|
259 | ) | |
|
260 |
|
|
|
271 | metavar='Global.work_dir') | |
|
272 | ||
|
273 | def _add_clean_logs(self, parser): | |
|
274 | paa = parser.add_argument | |
|
275 | paa('--clean-logs', | |
|
261 | 276 | dest='Global.clean_logs', action='store_true', |
|
262 |
help='Delete old log flies before starting.' |
|
|
263 | default=NoConfigDefault | |
|
264 | ) | |
|
265 |
|
|
|
277 | help='Delete old log flies before starting.') | |
|
278 | ||
|
279 | def _add_no_clean_logs(self, parser): | |
|
280 | paa = parser.add_argument | |
|
281 | paa('--no-clean-logs', | |
|
266 | 282 | dest='Global.clean_logs', action='store_false', |
|
267 |
help="Don't Delete old log flies before starting." |
|
|
268 | default=NoConfigDefault | |
|
283 | help="Don't Delete old log flies before starting.") | |
|
284 | ||
|
285 | def _add_arguments(self): | |
|
286 | super(ClusterDirConfigLoader, self)._add_arguments() | |
|
287 | self._add_cluster_profile(self.parser) | |
|
288 | self._add_cluster_dir(self.parser) | |
|
289 | self._add_work_dir(self.parser) | |
|
290 | self._add_clean_logs(self.parser) | |
|
291 | self._add_no_clean_logs(self.parser) | |
|
292 | ||
|
293 | ||
|
294 | #----------------------------------------------------------------------------- | |
|
295 | # Crash handler for this application | |
|
296 | #----------------------------------------------------------------------------- | |
|
297 | ||
|
298 | ||
|
299 | _message_template = """\ | |
|
300 | Oops, $self.app_name crashed. We do our best to make it stable, but... | |
|
301 | ||
|
302 | A crash report was automatically generated with the following information: | |
|
303 | - A verbatim copy of the crash traceback. | |
|
304 | - Data on your current $self.app_name configuration. | |
|
305 | ||
|
306 | It was left in the file named: | |
|
307 | \t'$self.crash_report_fname' | |
|
308 | If you can email this file to the developers, the information in it will help | |
|
309 | them in understanding and correcting the problem. | |
|
310 | ||
|
311 | You can mail it to: $self.contact_name at $self.contact_email | |
|
312 | with the subject '$self.app_name Crash Report'. | |
|
313 | ||
|
314 | If you want to do it now, the following command will work (under Unix): | |
|
315 | mail -s '$self.app_name Crash Report' $self.contact_email < $self.crash_report_fname | |
|
316 | ||
|
317 | To ensure accurate tracking of this issue, please file a report about it at: | |
|
318 | $self.bug_tracker | |
|
319 | """ | |
|
320 | ||
|
321 | class ClusterDirCrashHandler(CrashHandler): | |
|
322 | """sys.excepthook for IPython itself, leaves a detailed report on disk.""" | |
|
323 | ||
|
324 | message_template = _message_template | |
|
325 | ||
|
326 | def __init__(self, app): | |
|
327 | contact_name = release.authors['Brian'][0] | |
|
328 | contact_email = release.authors['Brian'][1] | |
|
329 | bug_tracker = 'https://bugs.launchpad.net/ipython/+filebug' | |
|
330 | super(ClusterDirCrashHandler,self).__init__( | |
|
331 | app, contact_name, contact_email, bug_tracker | |
|
269 | 332 | ) |
|
270 | 333 | |
|
334 | ||
|
335 | #----------------------------------------------------------------------------- | |
|
336 | # Main application | |
|
337 | #----------------------------------------------------------------------------- | |
|
338 | ||
|
271 | 339 | class ApplicationWithClusterDir(Application): |
|
272 | 340 | """An application that puts everything into a cluster directory. |
|
273 | 341 | |
@@ -287,6 +355,8 b' class ApplicationWithClusterDir(Application):' | |||
|
287 | 355 | dir and named the value of the ``config_file_name`` class attribute. |
|
288 | 356 | """ |
|
289 | 357 | |
|
358 | command_line_loader = ClusterDirConfigLoader | |
|
359 | crash_handler_class = ClusterDirCrashHandler | |
|
290 | 360 | auto_create_cluster_dir = True |
|
291 | 361 | |
|
292 | 362 | def create_default_config(self): |
@@ -297,13 +367,6 b' class ApplicationWithClusterDir(Application):' | |||
|
297 | 367 | self.default_config.Global.log_to_file = False |
|
298 | 368 | self.default_config.Global.clean_logs = False |
|
299 | 369 | |
|
300 | def create_command_line_config(self): | |
|
301 | """Create and return a command line config loader.""" | |
|
302 | return AppWithClusterDirArgParseConfigLoader( | |
|
303 | description=self.description, | |
|
304 | version=release.version | |
|
305 | ) | |
|
306 | ||
|
307 | 370 | def find_resources(self): |
|
308 | 371 | """This resolves the cluster directory. |
|
309 | 372 | |
@@ -326,7 +389,7 b' class ApplicationWithClusterDir(Application):' | |||
|
326 | 389 | cluster_dir = self.command_line_config.Global.cluster_dir |
|
327 | 390 | except AttributeError: |
|
328 | 391 | cluster_dir = self.default_config.Global.cluster_dir |
|
329 |
cluster_dir = |
|
|
392 | cluster_dir = expand_path(cluster_dir) | |
|
330 | 393 | try: |
|
331 | 394 | self.cluster_dir_obj = ClusterDir.find_cluster_dir(cluster_dir) |
|
332 | 395 | except ClusterDirError: |
@@ -375,17 +438,19 b' class ApplicationWithClusterDir(Application):' | |||
|
375 | 438 | self.default_config.Global.cluster_dir = self.cluster_dir |
|
376 | 439 | self.command_line_config.Global.cluster_dir = self.cluster_dir |
|
377 | 440 | |
|
378 | # Set the search path to the cluster directory | |
|
379 | self.config_file_paths = (self.cluster_dir,) | |
|
380 | ||
|
381 | 441 | def find_config_file_name(self): |
|
382 | 442 | """Find the config file name for this application.""" |
|
383 | 443 | # For this type of Application it should be set as a class attribute. |
|
384 | if not hasattr(self, 'config_file_name'): | |
|
444 | if not hasattr(self, 'default_config_file_name'): | |
|
385 | 445 | self.log.critical("No config filename found") |
|
446 | else: | |
|
447 | self.config_file_name = self.default_config_file_name | |
|
386 | 448 | |
|
387 | 449 | def find_config_file_paths(self): |
|
388 | # Set the search path to the cluster directory | |
|
450 | # Set the search path to to the cluster directory. We should NOT | |
|
451 | # include IPython.config.default here as the default config files | |
|
452 | # are ALWAYS automatically moved to the cluster directory. | |
|
453 | conf_dir = os.path.join(get_ipython_package_dir(), 'config', 'default') | |
|
389 | 454 | self.config_file_paths = (self.cluster_dir,) |
|
390 | 455 | |
|
391 | 456 | def pre_construct(self): |
@@ -399,7 +464,7 b' class ApplicationWithClusterDir(Application):' | |||
|
399 | 464 | pdir = self.cluster_dir_obj.pid_dir |
|
400 | 465 | self.pid_dir = config.Global.pid_dir = pdir |
|
401 | 466 | self.log.info("Cluster directory set to: %s" % self.cluster_dir) |
|
402 |
config.Global.work_dir = unicode( |
|
|
467 | config.Global.work_dir = unicode(expand_path(config.Global.work_dir)) | |
|
403 | 468 | # Change to the working directory. We do this just before construct |
|
404 | 469 | # is called so all the components there have the right working dir. |
|
405 | 470 | self.to_work_dir() |
@@ -472,4 +537,3 b' class ApplicationWithClusterDir(Application):' | |||
|
472 | 537 | else: |
|
473 | 538 | raise PIDFileError('pid file not found: %s' % pid_file) |
|
474 | 539 | |
|
475 |
@@ -24,9 +24,7 b' __docformat__ = "restructuredtext en"' | |||
|
24 | 24 | import linecache |
|
25 | 25 | import sys |
|
26 | 26 | |
|
27 | from twisted.internet.error import ConnectionRefusedError | |
|
28 | ||
|
29 | from IPython.core.ultratb import _fixed_getinnerframes, findsource | |
|
27 | from IPython.core.ultratb import findsource | |
|
30 | 28 | from IPython.core import ipapi |
|
31 | 29 | |
|
32 | 30 | from IPython.kernel import error |
@@ -37,20 +37,18 b' __docformat__ = "restructuredtext en"' | |||
|
37 | 37 | # Imports |
|
38 | 38 | #------------------------------------------------------------------------------- |
|
39 | 39 | |
|
40 |
import os |
|
|
40 | import os | |
|
41 | 41 | |
|
42 | 42 | from twisted.application import service |
|
43 |
from twisted. |
|
|
44 | from twisted.python import log, components | |
|
43 | from twisted.python import log | |
|
45 | 44 | from zope.interface import Interface, implements, Attribute |
|
46 | import zope.interface as zi | |
|
47 | 45 | |
|
48 | 46 | from IPython.kernel.engineservice import \ |
|
49 | 47 | IEngineCore, \ |
|
50 | 48 | IEngineSerialized, \ |
|
51 | 49 | IEngineQueued |
|
52 | 50 | |
|
53 |
from IPython.utils. |
|
|
51 | from IPython.utils.path import get_ipython_dir | |
|
54 | 52 | from IPython.kernel import codeutil |
|
55 | 53 | |
|
56 | 54 | #------------------------------------------------------------------------------- |
@@ -211,7 +211,7 b' class Interpreter(object):' | |||
|
211 | 211 | |
|
212 | 212 | #### Public 'Interpreter' interface ######################################## |
|
213 | 213 | |
|
214 |
def format |
|
|
214 | def format_traceback(self, et, ev, tb, message=''): | |
|
215 | 215 | """Put a formatted version of the traceback into value and reraise. |
|
216 | 216 | |
|
217 | 217 | When exceptions have to be sent over the network, the traceback |
@@ -375,7 +375,6 b' class Interpreter(object):' | |||
|
375 | 375 | exec code in self.user_ns |
|
376 | 376 | outflag = 0 |
|
377 | 377 | except SystemExit: |
|
378 | self.resetbuffer() | |
|
379 | 378 | self.traceback_trap.args = sys.exc_info() |
|
380 | 379 | except: |
|
381 | 380 | self.traceback_trap.args = sys.exc_info() |
@@ -395,7 +394,7 b' class Interpreter(object):' | |||
|
395 | 394 | python = self.translator(python) |
|
396 | 395 | self.execute_python(python) |
|
397 | 396 | |
|
398 |
def get |
|
|
397 | def get_command(self, i=None): | |
|
399 | 398 | """Gets the ith message in the message_cache. |
|
400 | 399 | |
|
401 | 400 | This is implemented here for compatibility with the old ipython1 shell |
@@ -492,7 +491,7 b' class Interpreter(object):' | |||
|
492 | 491 | # somehow. In the meantime, we'll just stop if there are two lines |
|
493 | 492 | # of pure whitespace at the end. |
|
494 | 493 | last_two = source.rsplit('\n',2)[-2:] |
|
495 | print 'last two:',last_two # dbg | |
|
494 | #print 'last two:',last_two # dbg | |
|
496 | 495 | if len(last_two)==2 and all(s.isspace() for s in last_two): |
|
497 | 496 | return COMPLETE_INPUT,False |
|
498 | 497 | else: |
@@ -21,6 +21,8 b' __docformat__ = "restructuredtext en"' | |||
|
21 | 21 | |
|
22 | 22 | # Required modules |
|
23 | 23 | import __builtin__ |
|
24 | import os | |
|
25 | import re | |
|
24 | 26 | import socket |
|
25 | 27 | import sys |
|
26 | 28 | |
@@ -30,7 +32,8 b' from IPython.external.Itpl import ItplNS' | |||
|
30 | 32 | from IPython.utils import coloransi |
|
31 | 33 | from IPython.core import release |
|
32 | 34 | from IPython.core.error import TryNext |
|
33 |
from IPython.utils. |
|
|
35 | from IPython.utils.io import Term | |
|
36 | from IPython.utils.warn import warn | |
|
34 | 37 | import IPython.utils.generics |
|
35 | 38 | |
|
36 | 39 | #**************************************************************************** |
@@ -18,6 +18,7 b' __test__ = {}' | |||
|
18 | 18 | |
|
19 | 19 | from cStringIO import StringIO |
|
20 | 20 | import os |
|
21 | import sys | |
|
21 | 22 | |
|
22 | 23 | from twisted.trial import unittest |
|
23 | 24 | |
@@ -27,7 +28,6 b' from IPython.testing import decorators_trial as dec' | |||
|
27 | 28 | # Tests |
|
28 | 29 | #----------------------------------------------------------------------------- |
|
29 | 30 | |
|
30 | ||
|
31 | 31 | class TestRedirector(unittest.TestCase): |
|
32 | 32 | |
|
33 | 33 | @dec.skip_win32 |
@@ -59,7 +59,8 b' class TestRedirector(unittest.TestCase):' | |||
|
59 | 59 | trap the output, but also that it does it in a gready way, that |
|
60 | 60 | is by calling the callback ASAP. |
|
61 | 61 | """ |
|
62 |
from IPython.kernel.core.redirector_output_trap import |
|
|
62 | from IPython.kernel.core.redirector_output_trap import \ | |
|
63 | RedirectorOutputTrap | |
|
63 | 64 | out = StringIO() |
|
64 | 65 | trap = RedirectorOutputTrap(out.write, out.write) |
|
65 | 66 | try: |
@@ -17,8 +17,7 b'' | |||
|
17 | 17 | import os |
|
18 | 18 | import cPickle as pickle |
|
19 | 19 | |
|
20 |
from twisted.python import log |
|
|
21 | from twisted.internet import defer | |
|
20 | from twisted.python import log | |
|
22 | 21 | from twisted.internet.defer import inlineCallbacks, returnValue |
|
23 | 22 | |
|
24 | 23 | from IPython.kernel.fcutil import find_furl, validate_furl_or_file |
@@ -19,14 +19,11 b' __docformat__ = "restructuredtext en"' | |||
|
19 | 19 | # Imports |
|
20 | 20 | #------------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | import os, time | |
|
23 | 22 | import cPickle as pickle |
|
24 | 23 | |
|
25 | 24 | from twisted.python import components, log, failure |
|
26 |
from twisted. |
|
|
27 | from twisted.internet import defer, reactor, threads | |
|
28 | from twisted.internet.interfaces import IProtocolFactory | |
|
29 | from zope.interface import Interface, implements, Attribute | |
|
25 | from twisted.internet import defer, threads | |
|
26 | from zope.interface import Interface, implements | |
|
30 | 27 | |
|
31 | 28 | from twisted.internet.base import DelayedCall |
|
32 | 29 | DelayedCall.debug = True |
@@ -35,24 +32,20 b' from foolscap import Referenceable, DeadReferenceError' | |||
|
35 | 32 | from foolscap.referenceable import RemoteReference |
|
36 | 33 | |
|
37 | 34 | from IPython.kernel.pbutil import packageFailure, unpackageFailure |
|
38 | from IPython.kernel.util import printer | |
|
39 | from IPython.kernel.twistedutil import gatherBoth | |
|
40 | from IPython.kernel import newserialized | |
|
41 | from IPython.kernel.error import ProtocolError | |
|
42 | from IPython.kernel import controllerservice | |
|
43 | 35 | from IPython.kernel.controllerservice import IControllerBase |
|
44 |
from IPython.kernel.engineservice import |
|
|
45 |
IEngineBase, |
|
|
46 |
IEngineQueued, |
|
|
47 | EngineService, \ | |
|
36 | from IPython.kernel.engineservice import ( | |
|
37 | IEngineBase, | |
|
38 | IEngineQueued, | |
|
48 | 39 | StrictDict |
|
49 | from IPython.kernel.pickleutil import \ | |
|
50 | can, \ | |
|
51 |
can |
|
|
52 |
can |
|
|
53 | uncan, \ | |
|
54 |
uncan |
|
|
40 | ) | |
|
41 | from IPython.kernel.pickleutil import ( | |
|
42 | can, | |
|
43 | canDict, | |
|
44 | canSequence, | |
|
45 | uncan, | |
|
46 | uncanDict, | |
|
55 | 47 | uncanSequence |
|
48 | ) | |
|
56 | 49 | |
|
57 | 50 | |
|
58 | 51 | #------------------------------------------------------------------------------- |
@@ -387,7 +387,7 b' class EngineService(object, service.Service):' | |||
|
387 | 387 | # tb=traceback object |
|
388 | 388 | et,ev,tb = sys.exc_info() |
|
389 | 389 | # This call adds attributes to the exception value |
|
390 |
et,ev,tb = self.shell.format |
|
|
390 | et,ev,tb = self.shell.format_traceback(et,ev,tb,msg) | |
|
391 | 391 | # Add another attribute |
|
392 | 392 | ev._ipython_engine_info = msg |
|
393 | 393 | f = failure.Failure(ev,et,None) |
@@ -444,7 +444,7 b' class EngineService(object, service.Service):' | |||
|
444 | 444 | msg = {'engineid':self.id, |
|
445 | 445 | 'method':'get_result', |
|
446 | 446 | 'args':[repr(i)]} |
|
447 |
d = self.executeAndRaise(msg, self.shell.get |
|
|
447 | d = self.executeAndRaise(msg, self.shell.get_command, i) | |
|
448 | 448 | d.addCallback(self.addIDToResult) |
|
449 | 449 | return d |
|
450 | 450 | |
@@ -877,7 +877,7 b' class ThreadedEngineService(EngineService):' | |||
|
877 | 877 | # tb=traceback object |
|
878 | 878 | et,ev,tb = sys.exc_info() |
|
879 | 879 | # This call adds attributes to the exception value |
|
880 |
et,ev,tb = self.shell.format |
|
|
880 | et,ev,tb = self.shell.format_traceback(et,ev,tb,msg) | |
|
881 | 881 | # Add another attribute |
|
882 | 882 | |
|
883 | 883 | # Create a new exception with the new attributes |
@@ -17,6 +17,7 b' __test__ = {}' | |||
|
17 | 17 | #------------------------------------------------------------------------------- |
|
18 | 18 | # Imports |
|
19 | 19 | #------------------------------------------------------------------------------- |
|
20 | ||
|
20 | 21 | from twisted.python import failure |
|
21 | 22 | |
|
22 | 23 | from IPython.kernel.core import error |
@@ -28,6 +29,7 b' from IPython.kernel.core import error' | |||
|
28 | 29 | class KernelError(error.IPythonError): |
|
29 | 30 | pass |
|
30 | 31 | |
|
32 | ||
|
31 | 33 | class NotDefined(KernelError): |
|
32 | 34 | def __init__(self, name): |
|
33 | 35 | self.name = name |
@@ -38,78 +40,102 b' class NotDefined(KernelError):' | |||
|
38 | 40 | |
|
39 | 41 | __str__ = __repr__ |
|
40 | 42 | |
|
43 | ||
|
41 | 44 | class QueueCleared(KernelError): |
|
42 | 45 | pass |
|
43 | 46 | |
|
47 | ||
|
44 | 48 | class IdInUse(KernelError): |
|
45 | 49 | pass |
|
46 | 50 | |
|
51 | ||
|
47 | 52 | class ProtocolError(KernelError): |
|
48 | 53 | pass |
|
49 | 54 | |
|
55 | ||
|
50 | 56 | class ConnectionError(KernelError): |
|
51 | 57 | pass |
|
52 | 58 | |
|
59 | ||
|
53 | 60 | class InvalidEngineID(KernelError): |
|
54 | 61 | pass |
|
55 | 62 | |
|
63 | ||
|
56 | 64 | class NoEnginesRegistered(KernelError): |
|
57 | 65 | pass |
|
58 | 66 | |
|
67 | ||
|
59 | 68 | class InvalidClientID(KernelError): |
|
60 | 69 | pass |
|
61 | 70 | |
|
71 | ||
|
62 | 72 | class InvalidDeferredID(KernelError): |
|
63 | 73 | pass |
|
64 | 74 | |
|
75 | ||
|
65 | 76 | class SerializationError(KernelError): |
|
66 | 77 | pass |
|
67 | 78 | |
|
79 | ||
|
68 | 80 | class MessageSizeError(KernelError): |
|
69 | 81 | pass |
|
70 | 82 | |
|
83 | ||
|
71 | 84 | class PBMessageSizeError(MessageSizeError): |
|
72 | 85 | pass |
|
73 | 86 | |
|
87 | ||
|
74 | 88 | class ResultNotCompleted(KernelError): |
|
75 | 89 | pass |
|
76 | 90 | |
|
91 | ||
|
77 | 92 | class ResultAlreadyRetrieved(KernelError): |
|
78 | 93 | pass |
|
79 | 94 | |
|
80 | 95 | class ClientError(KernelError): |
|
81 | 96 | pass |
|
82 | 97 | |
|
98 | ||
|
83 | 99 | class TaskAborted(KernelError): |
|
84 | 100 | pass |
|
85 | 101 | |
|
102 | ||
|
86 | 103 | class TaskTimeout(KernelError): |
|
87 | 104 | pass |
|
88 | 105 | |
|
106 | ||
|
89 | 107 | class NotAPendingResult(KernelError): |
|
90 | 108 | pass |
|
91 | 109 | |
|
110 | ||
|
92 | 111 | class UnpickleableException(KernelError): |
|
93 | 112 | pass |
|
94 | 113 | |
|
114 | ||
|
95 | 115 | class AbortedPendingDeferredError(KernelError): |
|
96 | 116 | pass |
|
97 | 117 | |
|
118 | ||
|
98 | 119 | class InvalidProperty(KernelError): |
|
99 | 120 | pass |
|
100 | 121 | |
|
122 | ||
|
101 | 123 | class MissingBlockArgument(KernelError): |
|
102 | 124 | pass |
|
103 | 125 | |
|
126 | ||
|
104 | 127 | class StopLocalExecution(KernelError): |
|
105 | 128 | pass |
|
106 | 129 | |
|
130 | ||
|
107 | 131 | class SecurityError(KernelError): |
|
108 | 132 | pass |
|
109 | 133 | |
|
134 | ||
|
110 | 135 | class FileTimeoutError(KernelError): |
|
111 | 136 | pass |
|
112 | 137 | |
|
138 | ||
|
113 | 139 | class TaskRejectError(KernelError): |
|
114 | 140 | """Exception to raise when a task should be rejected by an engine. |
|
115 | 141 | |
@@ -124,6 +150,7 b' class TaskRejectError(KernelError):' | |||
|
124 | 150 | properties don't have to be managed or tested by the controller. |
|
125 | 151 | """ |
|
126 | 152 | |
|
153 | ||
|
127 | 154 | class CompositeError(KernelError): |
|
128 | 155 | def __init__(self, message, elist): |
|
129 | 156 | Exception.__init__(self, *(message, elist)) |
@@ -178,6 +205,7 b' class CompositeError(KernelError):' | |||
|
178 | 205 | else: |
|
179 | 206 | raise et, ev, etb |
|
180 | 207 | |
|
208 | ||
|
181 | 209 | def collect_exceptions(rlist, method): |
|
182 | 210 | elist = [] |
|
183 | 211 | for r in rlist: |
@@ -204,4 +232,3 b' def collect_exceptions(rlist, method):' | |||
|
204 | 232 | except CompositeError, e: |
|
205 | 233 | raise e |
|
206 | 234 | |
|
207 |
@@ -265,8 +265,12 b' class FCServiceFactory(AdaptedConfiguredObjectFactory):' | |||
|
265 | 265 | """Register the reference with the FURL file. |
|
266 | 266 | |
|
267 | 267 | The FURL file is created and then moved to make sure that when the |
|
268 | file appears, the buffer has been flushed and the file closed. | |
|
268 | file appears, the buffer has been flushed and the file closed. This | |
|
269 | is not done if we are re-using FURLS however. | |
|
269 | 270 | """ |
|
271 | if self.reuse_furls: | |
|
272 | self.tub.registerReference(ref, furlFile=furl_file) | |
|
273 | else: | |
|
270 | 274 | temp_furl_file = get_temp_furlfile(furl_file) |
|
271 | 275 | self.tub.registerReference(ref, furlFile=temp_furl_file) |
|
272 | 276 | os.rename(temp_furl_file, furl_file) |
@@ -18,176 +18,207 b' The ipcluster application.' | |||
|
18 | 18 | import logging |
|
19 | 19 | import os |
|
20 | 20 | import signal |
|
21 | import sys | |
|
22 | 21 | |
|
23 | 22 | if os.name=='posix': |
|
24 | 23 | from twisted.scripts._twistd_unix import daemonize |
|
25 | 24 | |
|
26 | from IPython.core import release | |
|
27 | from IPython.external import argparse | |
|
28 | from IPython.config.loader import ArgParseConfigLoader, NoConfigDefault | |
|
29 | from IPython.utils.importstring import import_item | |
|
25 | from twisted.internet import reactor, defer | |
|
26 | from twisted.python import log, failure | |
|
27 | ||
|
30 | 28 | |
|
29 | from IPython.external.argparse import ArgumentParser, SUPPRESS | |
|
30 | from IPython.utils.importstring import import_item | |
|
31 | 31 | from IPython.kernel.clusterdir import ( |
|
32 |
ApplicationWithClusterDir, ClusterDir |
|
|
32 | ApplicationWithClusterDir, ClusterDirConfigLoader, | |
|
33 | ClusterDirError, PIDFileError | |
|
33 | 34 | ) |
|
34 | 35 | |
|
35 | from twisted.internet import reactor, defer | |
|
36 | from twisted.python import log, failure | |
|
37 | ||
|
38 | 36 | |
|
39 | 37 | #----------------------------------------------------------------------------- |
|
40 | # The ipcluster application | |
|
38 | # Module level variables | |
|
41 | 39 | #----------------------------------------------------------------------------- |
|
42 | 40 | |
|
43 | 41 | |
|
42 | default_config_file_name = u'ipcluster_config.py' | |
|
43 | ||
|
44 | ||
|
45 | _description = """\ | |
|
46 | Start an IPython cluster for parallel computing.\n\n | |
|
47 | ||
|
48 | An IPython cluster consists of 1 controller and 1 or more engines. | |
|
49 | This command automates the startup of these processes using a wide | |
|
50 | range of startup methods (SSH, local processes, PBS, mpiexec, | |
|
51 | Windows HPC Server 2008). To start a cluster with 4 engines on your | |
|
52 | local host simply do 'ipcluster start -n 4'. For more complex usage | |
|
53 | you will typically do 'ipcluster create -p mycluster', then edit | |
|
54 | configuration files, followed by 'ipcluster start -p mycluster -n 4'. | |
|
55 | """ | |
|
56 | ||
|
57 | ||
|
44 | 58 | # Exit codes for ipcluster |
|
45 | 59 | |
|
46 | 60 | # This will be the exit code if the ipcluster appears to be running because |
|
47 | 61 | # a .pid file exists |
|
48 | 62 | ALREADY_STARTED = 10 |
|
49 | 63 | |
|
64 | ||
|
50 | 65 | # This will be the exit code if ipcluster stop is run, but there is not .pid |
|
51 | 66 | # file to be found. |
|
52 | 67 | ALREADY_STOPPED = 11 |
|
53 | 68 | |
|
54 | 69 | |
|
55 | class IPClusterCLLoader(ArgParseConfigLoader): | |
|
70 | #----------------------------------------------------------------------------- | |
|
71 | # Command line options | |
|
72 | #----------------------------------------------------------------------------- | |
|
73 | ||
|
74 | ||
|
75 | class IPClusterAppConfigLoader(ClusterDirConfigLoader): | |
|
56 | 76 | |
|
57 | 77 | def _add_arguments(self): |
|
78 | # Don't call ClusterDirConfigLoader._add_arguments as we don't want | |
|
79 | # its defaults on self.parser. Instead, we will put those on | |
|
80 | # default options on our subparsers. | |
|
81 | ||
|
58 | 82 | # This has all the common options that all subcommands use |
|
59 |
parent_parser1 = |
|
|
60 | parent_parser1.add_argument('--ipython-dir', | |
|
61 | dest='Global.ipython_dir',type=unicode, | |
|
62 | help='Set to override default location of Global.ipython_dir.', | |
|
63 | default=NoConfigDefault, | |
|
64 | metavar='Global.ipython_dir') | |
|
65 | parent_parser1.add_argument('--log-level', | |
|
66 | dest="Global.log_level",type=int, | |
|
67 | help='Set the log level (0,10,20,30,40,50). Default is 30.', | |
|
68 | default=NoConfigDefault, | |
|
69 | metavar='Global.log_level') | |
|
83 | parent_parser1 = ArgumentParser( | |
|
84 | add_help=False, | |
|
85 | argument_default=SUPPRESS | |
|
86 | ) | |
|
87 | self._add_ipython_dir(parent_parser1) | |
|
88 | self._add_log_level(parent_parser1) | |
|
70 | 89 | |
|
71 | 90 | # This has all the common options that other subcommands use |
|
72 |
parent_parser2 = |
|
|
73 | parent_parser2.add_argument('-p','--profile', | |
|
74 | dest='Global.profile',type=unicode, | |
|
75 | help='The string name of the profile to be used. This determines ' | |
|
76 | 'the name of the cluster dir as: cluster_<profile>. The default profile ' | |
|
77 | 'is named "default". The cluster directory is resolve this way ' | |
|
78 | 'if the --cluster-dir option is not used.', | |
|
79 | default=NoConfigDefault, | |
|
80 | metavar='Global.profile') | |
|
81 | parent_parser2.add_argument('--cluster-dir', | |
|
82 | dest='Global.cluster_dir',type=unicode, | |
|
83 | help='Set the cluster dir. This overrides the logic used by the ' | |
|
84 | '--profile option.', | |
|
85 | default=NoConfigDefault, | |
|
86 | metavar='Global.cluster_dir'), | |
|
87 | parent_parser2.add_argument('--work-dir', | |
|
88 | dest='Global.work_dir',type=unicode, | |
|
89 | help='Set the working dir for the process.', | |
|
90 | default=NoConfigDefault, | |
|
91 | metavar='Global.work_dir') | |
|
92 | parent_parser2.add_argument('--log-to-file', | |
|
93 | action='store_true', dest='Global.log_to_file', | |
|
94 | default=NoConfigDefault, | |
|
95 | help='Log to a file in the log directory (default is stdout)' | |
|
91 | parent_parser2 = ArgumentParser( | |
|
92 | add_help=False, | |
|
93 | argument_default=SUPPRESS | |
|
96 | 94 | ) |
|
95 | self._add_cluster_profile(parent_parser2) | |
|
96 | self._add_cluster_dir(parent_parser2) | |
|
97 | self._add_work_dir(parent_parser2) | |
|
98 | paa = parent_parser2.add_argument | |
|
99 | paa('--log-to-file', | |
|
100 | action='store_true', dest='Global.log_to_file', | |
|
101 | help='Log to a file in the log directory (default is stdout)') | |
|
97 | 102 | |
|
103 | # Create the object used to create the subparsers. | |
|
98 | 104 | subparsers = self.parser.add_subparsers( |
|
99 | 105 | dest='Global.subcommand', |
|
100 | 106 | title='ipcluster subcommands', |
|
101 | description='ipcluster has a variety of subcommands. ' | |
|
102 | 'The general way of running ipcluster is "ipcluster <cmd> ' | |
|
103 | ' [options]""', | |
|
104 | help='For more help, type "ipcluster <cmd> -h"') | |
|
107 | description= | |
|
108 | """ipcluster has a variety of subcommands. The general way of | |
|
109 | running ipcluster is 'ipcluster <cmd> [options]'. To get help | |
|
110 | on a particular subcommand do 'ipcluster <cmd> -h'.""" | |
|
111 | # help="For more help, type 'ipcluster <cmd> -h'", | |
|
112 | ) | |
|
105 | 113 | |
|
114 | # The "list" subcommand parser | |
|
106 | 115 | parser_list = subparsers.add_parser( |
|
107 | 116 | 'list', |
|
108 | help='List all clusters in cwd and ipython_dir.', | |
|
109 | parents=[parent_parser1] | |
|
117 | parents=[parent_parser1], | |
|
118 | argument_default=SUPPRESS, | |
|
119 | help="List all clusters in cwd and ipython_dir.", | |
|
120 | description= | |
|
121 | """List all available clusters, by cluster directory, that can | |
|
122 | be found in the current working directly or in the ipython | |
|
123 | directory. Cluster directories are named using the convention | |
|
124 | 'cluster_<profile>'.""" | |
|
110 | 125 | ) |
|
111 | 126 | |
|
127 | # The "create" subcommand parser | |
|
112 | 128 | parser_create = subparsers.add_parser( |
|
113 | 129 | 'create', |
|
114 | help='Create a new cluster directory.', | |
|
115 | parents=[parent_parser1, parent_parser2] | |
|
130 | parents=[parent_parser1, parent_parser2], | |
|
131 | argument_default=SUPPRESS, | |
|
132 | help="Create a new cluster directory.", | |
|
133 | description= | |
|
134 | """Create an ipython cluster directory by its profile name or | |
|
135 | cluster directory path. Cluster directories contain | |
|
136 | configuration, log and security related files and are named | |
|
137 | using the convention 'cluster_<profile>'. By default they are | |
|
138 | located in your ipython directory. Once created, you will | |
|
139 | probably need to edit the configuration files in the cluster | |
|
140 | directory to configure your cluster. Most users will create a | |
|
141 | cluster directory by profile name, | |
|
142 | 'ipcluster create -p mycluster', which will put the directory | |
|
143 | in '<ipython_dir>/cluster_mycluster'. | |
|
144 | """ | |
|
116 | 145 | ) |
|
117 |
parser_create.add_argument |
|
|
118 |
|
|
|
146 | paa = parser_create.add_argument | |
|
147 | paa('--reset-config', | |
|
119 | 148 | dest='Global.reset_config', action='store_true', |
|
120 | default=NoConfigDefault, | |
|
121 |
|
|
|
122 |
|
|
|
123 | ) | |
|
149 | help= | |
|
150 | """Recopy the default config files to the cluster directory. | |
|
151 | You will loose any modifications you have made to these files.""") | |
|
124 | 152 | |
|
153 | # The "start" subcommand parser | |
|
125 | 154 | parser_start = subparsers.add_parser( |
|
126 | 155 | 'start', |
|
127 | help='Start a cluster.', | |
|
128 | parents=[parent_parser1, parent_parser2] | |
|
156 | parents=[parent_parser1, parent_parser2], | |
|
157 | argument_default=SUPPRESS, | |
|
158 | help="Start a cluster.", | |
|
159 | description= | |
|
160 | """Start an ipython cluster by its profile name or cluster | |
|
161 | directory. Cluster directories contain configuration, log and | |
|
162 | security related files and are named using the convention | |
|
163 | 'cluster_<profile>' and should be creating using the 'start' | |
|
164 | subcommand of 'ipcluster'. If your cluster directory is in | |
|
165 | the cwd or the ipython directory, you can simply refer to it | |
|
166 | using its profile name, 'ipcluster start -n 4 -p <profile>`, | |
|
167 | otherwise use the '--cluster-dir' option. | |
|
168 | """ | |
|
129 | 169 | ) |
|
130 |
parser_start.add_argument |
|
|
131 |
|
|
|
170 | paa = parser_start.add_argument | |
|
171 | paa('-n', '--number', | |
|
132 | 172 | type=int, dest='Global.n', |
|
133 | default=NoConfigDefault, | |
|
134 | 173 | help='The number of engines to start.', |
|
135 | metavar='Global.n' | |
|
136 | ) | |
|
137 | parser_start.add_argument('--clean-logs', | |
|
174 | metavar='Global.n') | |
|
175 | paa('--clean-logs', | |
|
138 | 176 | dest='Global.clean_logs', action='store_true', |
|
139 |
help='Delete old log flies before starting.' |
|
|
140 | default=NoConfigDefault | |
|
141 | ) | |
|
142 | parser_start.add_argument('--no-clean-logs', | |
|
177 | help='Delete old log flies before starting.') | |
|
178 | paa('--no-clean-logs', | |
|
143 | 179 | dest='Global.clean_logs', action='store_false', |
|
144 |
help="Don't delete old log flies before starting." |
|
|
145 | default=NoConfigDefault | |
|
146 | ) | |
|
147 | parser_start.add_argument('--daemon', | |
|
180 | help="Don't delete old log flies before starting.") | |
|
181 | paa('--daemon', | |
|
148 | 182 | dest='Global.daemonize', action='store_true', |
|
149 |
help='Daemonize the ipcluster program. This implies --log-to-file' |
|
|
150 | default=NoConfigDefault | |
|
151 | ) | |
|
152 | parser_start.add_argument('--no-daemon', | |
|
183 | help='Daemonize the ipcluster program. This implies --log-to-file') | |
|
184 | paa('--no-daemon', | |
|
153 | 185 | dest='Global.daemonize', action='store_false', |
|
154 |
help="Dont't daemonize the ipcluster program." |
|
|
155 | default=NoConfigDefault | |
|
156 | ) | |
|
186 | help="Dont't daemonize the ipcluster program.") | |
|
157 | 187 | |
|
158 | parser_start = subparsers.add_parser( | |
|
188 | # The "stop" subcommand parser | |
|
189 | parser_stop = subparsers.add_parser( | |
|
159 | 190 | 'stop', |
|
160 | help='Stop a cluster.', | |
|
161 | parents=[parent_parser1, parent_parser2] | |
|
191 | parents=[parent_parser1, parent_parser2], | |
|
192 | argument_default=SUPPRESS, | |
|
193 | help="Stop a running cluster.", | |
|
194 | description= | |
|
195 | """Stop a running ipython cluster by its profile name or cluster | |
|
196 | directory. Cluster directories are named using the convention | |
|
197 | 'cluster_<profile>'. If your cluster directory is in | |
|
198 | the cwd or the ipython directory, you can simply refer to it | |
|
199 | using its profile name, 'ipcluster stop -p <profile>`, otherwise | |
|
200 | use the '--cluster-dir' option. | |
|
201 | """ | |
|
162 | 202 | ) |
|
163 |
parser_st |
|
|
203 | paa = parser_stop.add_argument | |
|
204 | paa('--signal', | |
|
164 | 205 | dest='Global.signal', type=int, |
|
165 | 206 | help="The signal number to use in stopping the cluster (default=2).", |
|
166 |
metavar="Global.signal" |
|
|
167 | default=NoConfigDefault | |
|
168 | ) | |
|
207 | metavar="Global.signal") | |
|
169 | 208 | |
|
170 | 209 | |
|
171 | default_config_file_name = u'ipcluster_config.py' | |
|
172 | ||
|
173 | ||
|
174 | _description = """Start an IPython cluster for parallel computing.\n\n | |
|
175 | ||
|
176 | An IPython cluster consists of 1 controller and 1 or more engines. | |
|
177 | This command automates the startup of these processes using a wide | |
|
178 | range of startup methods (SSH, local processes, PBS, mpiexec, | |
|
179 | Windows HPC Server 2008). To start a cluster with 4 engines on your | |
|
180 | local host simply do "ipcluster start -n 4". For more complex usage | |
|
181 | you will typically do "ipcluster create -p mycluster", then edit | |
|
182 | configuration files, followed by "ipcluster start -p mycluster -n 4". | |
|
183 | """ | |
|
210 | #----------------------------------------------------------------------------- | |
|
211 | # Main application | |
|
212 | #----------------------------------------------------------------------------- | |
|
184 | 213 | |
|
185 | 214 | |
|
186 | 215 | class IPClusterApp(ApplicationWithClusterDir): |
|
187 | 216 | |
|
188 | 217 | name = u'ipcluster' |
|
189 | 218 | description = _description |
|
190 | config_file_name = default_config_file_name | |
|
219 | usage = None | |
|
220 | command_line_loader = IPClusterAppConfigLoader | |
|
221 | default_config_file_name = default_config_file_name | |
|
191 | 222 | default_log_level = logging.INFO |
|
192 | 223 | auto_create_cluster_dir = False |
|
193 | 224 | |
@@ -203,13 +234,6 b' class IPClusterApp(ApplicationWithClusterDir):' | |||
|
203 | 234 | self.default_config.Global.signal = 2 |
|
204 | 235 | self.default_config.Global.daemonize = False |
|
205 | 236 | |
|
206 | def create_command_line_config(self): | |
|
207 | """Create and return a command line config loader.""" | |
|
208 | return IPClusterCLLoader( | |
|
209 | description=self.description, | |
|
210 | version=release.version | |
|
211 | ) | |
|
212 | ||
|
213 | 237 | def find_resources(self): |
|
214 | 238 | subcommand = self.command_line_config.Global.subcommand |
|
215 | 239 | if subcommand=='list': |
@@ -372,7 +396,10 b' class IPClusterApp(ApplicationWithClusterDir):' | |||
|
372 | 396 | log.msg('Unexpected error in ipcluster:') |
|
373 | 397 | log.msg(r.getTraceback()) |
|
374 | 398 | log.msg("IPython cluster: stopping") |
|
375 | d= self.stop_engines() | |
|
399 | # These return deferreds. We are not doing anything with them | |
|
400 | # but we are holding refs to them as a reminder that they | |
|
401 | # do return deferreds. | |
|
402 | d1 = self.stop_engines() | |
|
376 | 403 | d2 = self.stop_controller() |
|
377 | 404 | # Wait a few seconds to let things shut down. |
|
378 | 405 | reactor.callLater(4.0, reactor.stop) |
@@ -460,6 +487,7 b' class IPClusterApp(ApplicationWithClusterDir):' | |||
|
460 | 487 | # old .pid files. |
|
461 | 488 | self.remove_pid_file() |
|
462 | 489 | |
|
490 | ||
|
463 | 491 | def launch_new_instance(): |
|
464 | 492 | """Create and run the IPython cluster.""" |
|
465 | 493 | app = IPClusterApp() |
@@ -18,33 +18,45 b' The IPython controller application.' | |||
|
18 | 18 | from __future__ import with_statement |
|
19 | 19 | |
|
20 | 20 | import copy |
|
21 | import os | |
|
22 | 21 | import sys |
|
23 | 22 | |
|
24 | 23 | from twisted.application import service |
|
25 | 24 | from twisted.internet import reactor |
|
26 | 25 | from twisted.python import log |
|
27 | 26 | |
|
28 |
from IPython.config.loader import Config |
|
|
29 | ||
|
27 | from IPython.config.loader import Config | |
|
28 | from IPython.kernel import controllerservice | |
|
30 | 29 | from IPython.kernel.clusterdir import ( |
|
31 | 30 |
ApplicationWithClusterDir, |
|
32 |
|
|
|
31 | ClusterDirConfigLoader | |
|
33 | 32 | ) |
|
33 | from IPython.kernel.fcutil import FCServiceFactory, FURLError | |
|
34 | from IPython.utils.traitlets import Instance, Unicode | |
|
34 | 35 | |
|
35 | from IPython.core import release | |
|
36 | 36 | |
|
37 | from IPython.utils.traitlets import Str, Instance, Unicode | |
|
37 | #----------------------------------------------------------------------------- | |
|
38 | # Module level variables | |
|
39 | #----------------------------------------------------------------------------- | |
|
38 | 40 | |
|
39 | from IPython.kernel import controllerservice | |
|
40 | 41 | |
|
41 | from IPython.kernel.fcutil import FCServiceFactory | |
|
42 | #: The default config file name for this application | |
|
43 | default_config_file_name = u'ipcontroller_config.py' | |
|
44 | ||
|
45 | ||
|
46 | _description = """Start the IPython controller for parallel computing. | |
|
47 | ||
|
48 | The IPython controller provides a gateway between the IPython engines and | |
|
49 | clients. The controller needs to be started before the engines and can be | |
|
50 | configured using command line options or using a cluster directory. Cluster | |
|
51 | directories contain config, log and security files and are usually located in | |
|
52 | your .ipython directory and named as "cluster_<profile>". See the --profile | |
|
53 | and --cluster-dir options for details. | |
|
54 | """ | |
|
42 | 55 | |
|
43 | 56 | #----------------------------------------------------------------------------- |
|
44 | 57 | # Default interfaces |
|
45 | 58 | #----------------------------------------------------------------------------- |
|
46 | 59 | |
|
47 | ||
|
48 | 60 | # The default client interfaces for FCClientServiceFactory.interfaces |
|
49 | 61 | default_client_interfaces = Config() |
|
50 | 62 | default_client_interfaces.Task.interface_chain = [ |
@@ -100,119 +112,96 b' class FCEngineServiceFactory(FCServiceFactory):' | |||
|
100 | 112 | |
|
101 | 113 | |
|
102 | 114 | #----------------------------------------------------------------------------- |
|
103 | # The main application | |
|
115 | # Command line options | |
|
104 | 116 | #----------------------------------------------------------------------------- |
|
105 | 117 | |
|
106 | 118 | |
|
107 | cl_args = ( | |
|
119 | class IPControllerAppConfigLoader(ClusterDirConfigLoader): | |
|
120 | ||
|
121 | def _add_arguments(self): | |
|
122 | super(IPControllerAppConfigLoader, self)._add_arguments() | |
|
123 | paa = self.parser.add_argument | |
|
108 | 124 | # Client config |
|
109 |
|
|
|
110 |
type=str, dest='FCClientServiceFactory.ip', |
|
|
125 | paa('--client-ip', | |
|
126 | type=str, dest='FCClientServiceFactory.ip', | |
|
111 | 127 | help='The IP address or hostname the controller will listen on for ' |
|
112 | 128 | 'client connections.', |
|
113 | 129 | metavar='FCClientServiceFactory.ip') |
|
114 | ), | |
|
115 | (('--client-port',), dict( | |
|
116 | type=int, dest='FCClientServiceFactory.port', default=NoConfigDefault, | |
|
130 | paa('--client-port', | |
|
131 | type=int, dest='FCClientServiceFactory.port', | |
|
117 | 132 | help='The port the controller will listen on for client connections. ' |
|
118 | 133 | 'The default is to use 0, which will autoselect an open port.', |
|
119 | 134 | metavar='FCClientServiceFactory.port') |
|
120 | ), | |
|
121 | (('--client-location',), dict( | |
|
122 | type=str, dest='FCClientServiceFactory.location', default=NoConfigDefault, | |
|
135 | paa('--client-location',), dict( | |
|
136 | type=str, dest='FCClientServiceFactory.location', | |
|
123 | 137 | help='The hostname or IP that clients should connect to. This does ' |
|
124 | 138 | 'not control which interface the controller listens on. Instead, this ' |
|
125 | 139 | 'determines the hostname/IP that is listed in the FURL, which is how ' |
|
126 | 140 | 'clients know where to connect. Useful if the controller is listening ' |
|
127 | 141 | 'on multiple interfaces.', |
|
128 | 142 | metavar='FCClientServiceFactory.location') |
|
129 | ), | |
|
130 | 143 | # Engine config |
|
131 |
|
|
|
132 |
type=str, dest='FCEngineServiceFactory.ip', |
|
|
144 | paa('--engine-ip', | |
|
145 | type=str, dest='FCEngineServiceFactory.ip', | |
|
133 | 146 | help='The IP address or hostname the controller will listen on for ' |
|
134 | 147 | 'engine connections.', |
|
135 | 148 | metavar='FCEngineServiceFactory.ip') |
|
136 | ), | |
|
137 | (('--engine-port',), dict( | |
|
138 | type=int, dest='FCEngineServiceFactory.port', default=NoConfigDefault, | |
|
149 | paa('--engine-port', | |
|
150 | type=int, dest='FCEngineServiceFactory.port', | |
|
139 | 151 | help='The port the controller will listen on for engine connections. ' |
|
140 | 152 | 'The default is to use 0, which will autoselect an open port.', |
|
141 | 153 | metavar='FCEngineServiceFactory.port') |
|
142 | ), | |
|
143 | (('--engine-location',), dict( | |
|
144 | type=str, dest='FCEngineServiceFactory.location', default=NoConfigDefault, | |
|
154 | paa('--engine-location', | |
|
155 | type=str, dest='FCEngineServiceFactory.location', | |
|
145 | 156 | help='The hostname or IP that engines should connect to. This does ' |
|
146 | 157 | 'not control which interface the controller listens on. Instead, this ' |
|
147 | 158 | 'determines the hostname/IP that is listed in the FURL, which is how ' |
|
148 | 159 | 'engines know where to connect. Useful if the controller is listening ' |
|
149 | 160 | 'on multiple interfaces.', |
|
150 | 161 | metavar='FCEngineServiceFactory.location') |
|
151 | ), | |
|
152 | 162 | # Global config |
|
153 |
|
|
|
154 |
action='store_true', dest='Global.log_to_file', |
|
|
163 | paa('--log-to-file', | |
|
164 | action='store_true', dest='Global.log_to_file', | |
|
155 | 165 | help='Log to a file in the log directory (default is stdout)') |
|
156 | ), | |
|
157 | (('-r','--reuse-furls'), dict( | |
|
158 | action='store_true', dest='Global.reuse_furls', default=NoConfigDefault, | |
|
166 | paa('-r','--reuse-furls', | |
|
167 | action='store_true', dest='Global.reuse_furls', | |
|
159 | 168 | help='Try to reuse all FURL files. If this is not set all FURL files ' |
|
160 | 169 | 'are deleted before the controller starts. This must be set if ' |
|
161 | 170 | 'specific ports are specified by --engine-port or --client-port.') |
|
162 | ), | |
|
163 | (('--no-secure',), dict( | |
|
164 | action='store_false', dest='Global.secure', default=NoConfigDefault, | |
|
171 | paa('--no-secure', | |
|
172 | action='store_false', dest='Global.secure', | |
|
165 | 173 | help='Turn off SSL encryption for all connections.') |
|
166 | ), | |
|
167 | (('--secure',), dict( | |
|
168 | action='store_true', dest='Global.secure', default=NoConfigDefault, | |
|
174 | paa('--secure', | |
|
175 | action='store_true', dest='Global.secure', | |
|
169 | 176 | help='Turn off SSL encryption for all connections.') |
|
170 | ) | |
|
171 | ) | |
|
172 | 177 | |
|
173 | 178 | |
|
174 | class IPControllerAppCLConfigLoader(AppWithClusterDirArgParseConfigLoader): | |
|
175 | ||
|
176 | arguments = cl_args | |
|
177 | ||
|
178 | ||
|
179 | _description = """Start the IPython controller for parallel computing. | |
|
180 | ||
|
181 | The IPython controller provides a gateway between the IPython engines and | |
|
182 | clients. The controller needs to be started before the engines and can be | |
|
183 | configured using command line options or using a cluster directory. Cluster | |
|
184 | directories contain config, log and security files and are usually located in | |
|
185 | your .ipython directory and named as "cluster_<profile>". See the --profile | |
|
186 | and --cluster-dir options for details. | |
|
187 | """ | |
|
188 | ||
|
189 | default_config_file_name = u'ipcontroller_config.py' | |
|
179 | #----------------------------------------------------------------------------- | |
|
180 | # The main application | |
|
181 | #----------------------------------------------------------------------------- | |
|
190 | 182 | |
|
191 | 183 | |
|
192 | 184 | class IPControllerApp(ApplicationWithClusterDir): |
|
193 | 185 | |
|
194 | 186 | name = u'ipcontroller' |
|
195 | 187 | description = _description |
|
196 | config_file_name = default_config_file_name | |
|
188 | command_line_loader = IPControllerAppConfigLoader | |
|
189 | default_config_file_name = default_config_file_name | |
|
197 | 190 | auto_create_cluster_dir = True |
|
198 | 191 | |
|
199 | 192 | def create_default_config(self): |
|
200 | 193 | super(IPControllerApp, self).create_default_config() |
|
201 |
|
|
|
202 | self.default_config.Global.secure = True | |
|
194 | # Don't set defaults for Global.secure or Global.reuse_furls | |
|
195 | # as those are set in a component. | |
|
203 | 196 | self.default_config.Global.import_statements = [] |
|
204 | 197 | self.default_config.Global.clean_logs = True |
|
205 | 198 | |
|
206 |
def |
|
|
207 | """Create and return a command line config loader.""" | |
|
208 | return IPControllerAppCLConfigLoader( | |
|
209 | description=self.description, | |
|
210 | version=release.version | |
|
211 | ) | |
|
212 | ||
|
213 | def post_load_command_line_config(self): | |
|
214 | # Now setup reuse_furls | |
|
215 | c = self.command_line_config | |
|
199 | def pre_construct(self): | |
|
200 | super(IPControllerApp, self).pre_construct() | |
|
201 | c = self.master_config | |
|
202 | # The defaults for these are set in FCClientServiceFactory and | |
|
203 | # FCEngineServiceFactory, so we only set them here if the global | |
|
204 | # options have be set to override the class level defaults. | |
|
216 | 205 | if hasattr(c.Global, 'reuse_furls'): |
|
217 | 206 | c.FCClientServiceFactory.reuse_furls = c.Global.reuse_furls |
|
218 | 207 | c.FCEngineServiceFactory.reuse_furls = c.Global.reuse_furls |
@@ -235,11 +224,19 b' class IPControllerApp(ApplicationWithClusterDir):' | |||
|
235 | 224 | controller_service = controllerservice.ControllerService() |
|
236 | 225 | controller_service.setServiceParent(self.main_service) |
|
237 | 226 | # The client tub and all its refereceables |
|
227 | try: | |
|
238 | 228 | csfactory = FCClientServiceFactory(self.master_config, controller_service) |
|
229 | except FURLError, e: | |
|
230 | log.err(e) | |
|
231 | self.exit(0) | |
|
239 | 232 | client_service = csfactory.create() |
|
240 | 233 | client_service.setServiceParent(self.main_service) |
|
241 | 234 | # The engine tub |
|
235 | try: | |
|
242 | 236 | esfactory = FCEngineServiceFactory(self.master_config, controller_service) |
|
237 | except FURLError, e: | |
|
238 | log.err(e) | |
|
239 | self.exit(0) | |
|
243 | 240 | engine_service = esfactory.create() |
|
244 | 241 | engine_service.setServiceParent(self.main_service) |
|
245 | 242 | |
@@ -272,4 +269,3 b' def launch_new_instance():' | |||
|
272 | 269 | |
|
273 | 270 | if __name__ == '__main__': |
|
274 | 271 | launch_new_instance() |
|
275 |
@@ -22,52 +22,21 b' from twisted.application import service' | |||
|
22 | 22 | from twisted.internet import reactor |
|
23 | 23 | from twisted.python import log |
|
24 | 24 | |
|
25 | from IPython.config.loader import NoConfigDefault | |
|
26 | ||
|
27 | 25 | from IPython.kernel.clusterdir import ( |
|
28 | 26 |
ApplicationWithClusterDir, |
|
29 |
|
|
|
27 | ClusterDirConfigLoader | |
|
30 | 28 | ) |
|
31 | from IPython.core import release | |
|
32 | ||
|
33 | from IPython.utils.importstring import import_item | |
|
34 | ||
|
29 | from IPython.kernel.engineconnector import EngineConnector | |
|
35 | 30 | from IPython.kernel.engineservice import EngineService |
|
36 | 31 | from IPython.kernel.fcutil import Tub |
|
37 | from IPython.kernel.engineconnector import EngineConnector | |
|
32 | from IPython.utils.importstring import import_item | |
|
38 | 33 | |
|
39 | 34 | #----------------------------------------------------------------------------- |
|
40 | # The main application | |
|
35 | # Module level variables | |
|
41 | 36 | #----------------------------------------------------------------------------- |
|
42 | 37 | |
|
43 | ||
|
44 | cl_args = ( | |
|
45 | # Controller config | |
|
46 | (('--furl-file',), dict( | |
|
47 | type=unicode, dest='Global.furl_file', default=NoConfigDefault, | |
|
48 | help='The full location of the file containing the FURL of the ' | |
|
49 | 'controller. If this is not given, the FURL file must be in the ' | |
|
50 | 'security directory of the cluster directory. This location is ' | |
|
51 | 'resolved using the --profile and --app-dir options.', | |
|
52 | metavar='Global.furl_file') | |
|
53 | ), | |
|
54 | # MPI | |
|
55 | (('--mpi',), dict( | |
|
56 | type=str, dest='MPI.use', default=NoConfigDefault, | |
|
57 | help='How to enable MPI (mpi4py, pytrilinos, or empty string to disable).', | |
|
58 | metavar='MPI.use') | |
|
59 | ), | |
|
60 | # Global config | |
|
61 | (('--log-to-file',), dict( | |
|
62 | action='store_true', dest='Global.log_to_file', default=NoConfigDefault, | |
|
63 | help='Log to a file in the log directory (default is stdout)') | |
|
64 | ) | |
|
65 | ) | |
|
66 | ||
|
67 | ||
|
68 | class IPEngineAppCLConfigLoader(AppWithClusterDirArgParseConfigLoader): | |
|
69 | ||
|
70 | arguments = cl_args | |
|
38 | #: The default config file name for this application | |
|
39 | default_config_file_name = u'ipengine_config.py' | |
|
71 | 40 | |
|
72 | 41 | |
|
73 | 42 | mpi4py_init = """from mpi4py import MPI as mpi |
@@ -75,6 +44,7 b' mpi.size = mpi.COMM_WORLD.Get_size()' | |||
|
75 | 44 | mpi.rank = mpi.COMM_WORLD.Get_rank() |
|
76 | 45 | """ |
|
77 | 46 | |
|
47 | ||
|
78 | 48 | pytrilinos_init = """from PyTrilinos import Epetra |
|
79 | 49 | class SimpleStruct: |
|
80 | 50 | pass |
@@ -84,9 +54,6 b' mpi.size = 0' | |||
|
84 | 54 | """ |
|
85 | 55 | |
|
86 | 56 | |
|
87 | default_config_file_name = u'ipengine_config.py' | |
|
88 | ||
|
89 | ||
|
90 | 57 | _description = """Start an IPython engine for parallel computing.\n\n |
|
91 | 58 | |
|
92 | 59 | IPython engines run in parallel and perform computations on behalf of a client |
@@ -97,12 +64,46 b' usually located in your .ipython directory and named as "cluster_<profile>".' | |||
|
97 | 64 | See the --profile and --cluster-dir options for details. |
|
98 | 65 | """ |
|
99 | 66 | |
|
67 | #----------------------------------------------------------------------------- | |
|
68 | # Command line options | |
|
69 | #----------------------------------------------------------------------------- | |
|
70 | ||
|
71 | ||
|
72 | class IPEngineAppConfigLoader(ClusterDirConfigLoader): | |
|
73 | ||
|
74 | def _add_arguments(self): | |
|
75 | super(IPEngineAppConfigLoader, self)._add_arguments() | |
|
76 | paa = self.parser.add_argument | |
|
77 | # Controller config | |
|
78 | paa('--furl-file', | |
|
79 | type=unicode, dest='Global.furl_file', | |
|
80 | help='The full location of the file containing the FURL of the ' | |
|
81 | 'controller. If this is not given, the FURL file must be in the ' | |
|
82 | 'security directory of the cluster directory. This location is ' | |
|
83 | 'resolved using the --profile and --app-dir options.', | |
|
84 | metavar='Global.furl_file') | |
|
85 | # MPI | |
|
86 | paa('--mpi', | |
|
87 | type=str, dest='MPI.use', | |
|
88 | help='How to enable MPI (mpi4py, pytrilinos, or empty string to disable).', | |
|
89 | metavar='MPI.use') | |
|
90 | # Global config | |
|
91 | paa('--log-to-file', | |
|
92 | action='store_true', dest='Global.log_to_file', | |
|
93 | help='Log to a file in the log directory (default is stdout)') | |
|
94 | ||
|
95 | ||
|
96 | #----------------------------------------------------------------------------- | |
|
97 | # Main application | |
|
98 | #----------------------------------------------------------------------------- | |
|
99 | ||
|
100 | 100 | |
|
101 | 101 | class IPEngineApp(ApplicationWithClusterDir): |
|
102 | 102 | |
|
103 | 103 | name = u'ipengine' |
|
104 | 104 | description = _description |
|
105 | config_file_name = default_config_file_name | |
|
105 | command_line_loader = IPEngineAppConfigLoader | |
|
106 | default_config_file_name = default_config_file_name | |
|
106 | 107 | auto_create_cluster_dir = True |
|
107 | 108 | |
|
108 | 109 | def create_default_config(self): |
@@ -134,13 +135,6 b' class IPEngineApp(ApplicationWithClusterDir):' | |||
|
134 | 135 | self.default_config.MPI.mpi4py = mpi4py_init |
|
135 | 136 | self.default_config.MPI.pytrilinos = pytrilinos_init |
|
136 | 137 | |
|
137 | def create_command_line_config(self): | |
|
138 | """Create and return a command line config loader.""" | |
|
139 | return IPEngineAppCLConfigLoader( | |
|
140 | description=self.description, | |
|
141 | version=release.version | |
|
142 | ) | |
|
143 | ||
|
144 | 138 | def post_load_command_line_config(self): |
|
145 | 139 | pass |
|
146 | 140 |
@@ -21,11 +21,15 b' import sys' | |||
|
21 | 21 | |
|
22 | 22 | from IPython.core.component import Component |
|
23 | 23 | from IPython.external import Itpl |
|
24 |
from IPython.utils.traitlets import Str, Int, List, Unicode |
|
|
25 |
from IPython.utils.p |
|
|
26 | from IPython.kernel.twistedutil import gatherBoth, make_deferred, sleep_deferred | |
|
24 | from IPython.utils.traitlets import Str, Int, List, Unicode | |
|
25 | from IPython.utils.path import get_ipython_module_path | |
|
26 | from IPython.utils.process import find_cmd, pycmd2argv | |
|
27 | from IPython.kernel.twistedutil import ( | |
|
28 | gatherBoth, | |
|
29 | make_deferred, | |
|
30 | sleep_deferred | |
|
31 | ) | |
|
27 | 32 | from IPython.kernel.winhpcjob import ( |
|
28 | WinHPCJob, WinHPCTask, | |
|
29 | 33 | IPControllerTask, IPEngineTask, |
|
30 | 34 | IPControllerJob, IPEngineSetJob |
|
31 | 35 | ) |
@@ -38,46 +42,23 b' from twisted.internet.error import ProcessDone, ProcessTerminated' | |||
|
38 | 42 | from twisted.python import log |
|
39 | 43 | from twisted.python.failure import Failure |
|
40 | 44 | |
|
45 | ||
|
41 | 46 | #----------------------------------------------------------------------------- |
|
42 | # Utilities | |
|
47 | # Paths to the kernel apps | |
|
43 | 48 | #----------------------------------------------------------------------------- |
|
44 | 49 | |
|
45 | 50 | |
|
46 | def find_controller_cmd(): | |
|
47 | """Find the command line ipcontroller program in a cross platform way.""" | |
|
48 | if sys.platform == 'win32': | |
|
49 | # This logic is needed because the ipcontroller script doesn't | |
|
50 | # always get installed in the same way or in the same location. | |
|
51 | from IPython.kernel import ipcontrollerapp | |
|
52 | script_location = ipcontrollerapp.__file__.replace('.pyc', '.py') | |
|
53 | # The -u option here turns on unbuffered output, which is required | |
|
54 | # on Win32 to prevent wierd conflict and problems with Twisted. | |
|
55 | # Also, use sys.executable to make sure we are picking up the | |
|
56 | # right python exe. | |
|
57 | cmd = [sys.executable, '-u', script_location] | |
|
58 | else: | |
|
59 | # ipcontroller has to be on the PATH in this case. | |
|
60 | cmd = ['ipcontroller'] | |
|
61 | return cmd | |
|
62 | ||
|
63 | ||
|
64 | def find_engine_cmd(): | |
|
65 | """Find the command line ipengine program in a cross platform way.""" | |
|
66 | if sys.platform == 'win32': | |
|
67 | # This logic is needed because the ipengine script doesn't | |
|
68 | # always get installed in the same way or in the same location. | |
|
69 | from IPython.kernel import ipengineapp | |
|
70 | script_location = ipengineapp.__file__.replace('.pyc', '.py') | |
|
71 | # The -u option here turns on unbuffered output, which is required | |
|
72 | # on Win32 to prevent wierd conflict and problems with Twisted. | |
|
73 | # Also, use sys.executable to make sure we are picking up the | |
|
74 | # right python exe. | |
|
75 | cmd = [sys.executable, '-u', script_location] | |
|
76 | else: | |
|
77 | # ipcontroller has to be on the PATH in this case. | |
|
78 | cmd = ['ipengine'] | |
|
79 | return cmd | |
|
51 | ipcluster_cmd_argv = pycmd2argv(get_ipython_module_path( | |
|
52 | 'IPython.kernel.ipclusterapp' | |
|
53 | )) | |
|
80 | 54 | |
|
55 | ipengine_cmd_argv = pycmd2argv(get_ipython_module_path( | |
|
56 | 'IPython.kernel.ipengineapp' | |
|
57 | )) | |
|
58 | ||
|
59 | ipcontroller_cmd_argv = pycmd2argv(get_ipython_module_path( | |
|
60 | 'IPython.kernel.ipcontrollerapp' | |
|
61 | )) | |
|
81 | 62 | |
|
82 | 63 | #----------------------------------------------------------------------------- |
|
83 | 64 | # Base launchers and errors |
@@ -333,7 +314,7 b' class LocalProcessLauncher(BaseLauncher):' | |||
|
333 | 314 | class LocalControllerLauncher(LocalProcessLauncher): |
|
334 | 315 | """Launch a controller as a regular external process.""" |
|
335 | 316 | |
|
336 |
controller_cmd = List( |
|
|
317 | controller_cmd = List(ipcontroller_cmd_argv, config=True) | |
|
337 | 318 | # Command line arguments to ipcontroller. |
|
338 | 319 | controller_args = List(['--log-to-file','--log-level', '40'], config=True) |
|
339 | 320 | |
@@ -351,7 +332,7 b' class LocalControllerLauncher(LocalProcessLauncher):' | |||
|
351 | 332 | class LocalEngineLauncher(LocalProcessLauncher): |
|
352 | 333 | """Launch a single engine as a regular externall process.""" |
|
353 | 334 | |
|
354 |
engine_cmd = List( |
|
|
335 | engine_cmd = List(ipengine_cmd_argv, config=True) | |
|
355 | 336 | # Command line arguments for ipengine. |
|
356 | 337 | engine_args = List( |
|
357 | 338 | ['--log-to-file','--log-level', '40'], config=True |
@@ -462,7 +443,7 b' class MPIExecLauncher(LocalProcessLauncher):' | |||
|
462 | 443 | class MPIExecControllerLauncher(MPIExecLauncher): |
|
463 | 444 | """Launch a controller using mpiexec.""" |
|
464 | 445 | |
|
465 |
controller_cmd = List( |
|
|
446 | controller_cmd = List(ipcontroller_cmd_argv, config=True) | |
|
466 | 447 | # Command line arguments to ipcontroller. |
|
467 | 448 | controller_args = List(['--log-to-file','--log-level', '40'], config=True) |
|
468 | 449 | n = Int(1, config=False) |
@@ -481,7 +462,7 b' class MPIExecControllerLauncher(MPIExecLauncher):' | |||
|
481 | 462 | |
|
482 | 463 | class MPIExecEngineSetLauncher(MPIExecLauncher): |
|
483 | 464 | |
|
484 |
engine_cmd = List( |
|
|
465 | engine_cmd = List(ipengine_cmd_argv, config=True) | |
|
485 | 466 | # Command line arguments for ipengine. |
|
486 | 467 | engine_args = List( |
|
487 | 468 | ['--log-to-file','--log-level', '40'], config=True |
@@ -831,28 +812,10 b' class PBSEngineSetLauncher(PBSLauncher):' | |||
|
831 | 812 | #----------------------------------------------------------------------------- |
|
832 | 813 | |
|
833 | 814 | |
|
834 | def find_ipcluster_cmd(): | |
|
835 | """Find the command line ipcluster program in a cross platform way.""" | |
|
836 | if sys.platform == 'win32': | |
|
837 | # This logic is needed because the ipcluster script doesn't | |
|
838 | # always get installed in the same way or in the same location. | |
|
839 | from IPython.kernel import ipclusterapp | |
|
840 | script_location = ipclusterapp.__file__.replace('.pyc', '.py') | |
|
841 | # The -u option here turns on unbuffered output, which is required | |
|
842 | # on Win32 to prevent wierd conflict and problems with Twisted. | |
|
843 | # Also, use sys.executable to make sure we are picking up the | |
|
844 | # right python exe. | |
|
845 | cmd = [sys.executable, '-u', script_location] | |
|
846 | else: | |
|
847 | # ipcontroller has to be on the PATH in this case. | |
|
848 | cmd = ['ipcluster'] | |
|
849 | return cmd | |
|
850 | ||
|
851 | ||
|
852 | 815 | class IPClusterLauncher(LocalProcessLauncher): |
|
853 | 816 | """Launch the ipcluster program in an external process.""" |
|
854 | 817 | |
|
855 |
ipcluster_cmd = List( |
|
|
818 | ipcluster_cmd = List(ipcluster_cmd_argv, config=True) | |
|
856 | 819 | # Command line arguments to pass to ipcluster. |
|
857 | 820 | ipcluster_args = List( |
|
858 | 821 | ['--clean-logs', '--log-to-file', '--log-level', '40'], config=True) |
@@ -21,7 +21,7 b' __docformat__ = "restructuredtext en"' | |||
|
21 | 21 | |
|
22 | 22 | import types |
|
23 | 23 | |
|
24 |
from IPython.utils. |
|
|
24 | from IPython.utils.data import flatten as utils_flatten | |
|
25 | 25 | |
|
26 | 26 | #------------------------------------------------------------------------------- |
|
27 | 27 | # Figure out which array packages are present and their array types |
@@ -87,7 +87,7 b' class Map:' | |||
|
87 | 87 | return m['module'].concatenate(listOfPartitions) |
|
88 | 88 | # Next try for Python sequence types |
|
89 | 89 | if isinstance(testObject, (types.ListType, types.TupleType)): |
|
90 |
return |
|
|
90 | return utils_flatten(listOfPartitions) | |
|
91 | 91 | # If we have scalars, just return listOfPartitions |
|
92 | 92 | return listOfPartitions |
|
93 | 93 |
@@ -18,8 +18,7 b' __docformat__ = "restructuredtext en"' | |||
|
18 | 18 | from types import FunctionType |
|
19 | 19 | from zope.interface import Interface, implements |
|
20 | 20 | from IPython.kernel.task import MapTask |
|
21 |
from IPython.kernel.twistedutil import |
|
|
22 | from IPython.kernel.util import printer | |
|
21 | from IPython.kernel.twistedutil import gatherBoth | |
|
23 | 22 | from IPython.kernel.error import collect_exceptions |
|
24 | 23 | |
|
25 | 24 | #---------------------------------------------------------------------------- |
@@ -27,24 +27,17 b' __docformat__ = "restructuredtext en"' | |||
|
27 | 27 | # Imports |
|
28 | 28 | #------------------------------------------------------------------------------- |
|
29 | 29 | |
|
30 | from new import instancemethod | |
|
31 | from types import FunctionType | |
|
32 | ||
|
33 | from twisted.application import service | |
|
34 | 30 | from twisted.internet import defer, reactor |
|
35 | 31 | from twisted.python import log, components, failure |
|
36 |
from zope.interface import Interface, implements |
|
|
32 | from zope.interface import Interface, implements | |
|
37 | 33 | |
|
38 | from IPython.utils import growl | |
|
39 | from IPython.kernel.util import printer | |
|
40 | 34 | from IPython.kernel.twistedutil import gatherBoth |
|
41 | from IPython.kernel import map as Map | |
|
42 | 35 | from IPython.kernel import error |
|
43 | 36 | from IPython.kernel.pendingdeferred import PendingDeferredManager, two_phase |
|
44 |
from IPython.kernel.controllerservice import |
|
|
45 |
ControllerAdapterBase, |
|
|
46 | ControllerService, \ | |
|
37 | from IPython.kernel.controllerservice import ( | |
|
38 | ControllerAdapterBase, | |
|
47 | 39 | IControllerBase |
|
40 | ) | |
|
48 | 41 | |
|
49 | 42 | |
|
50 | 43 | #------------------------------------------------------------------------------- |
@@ -22,12 +22,11 b' from types import FunctionType' | |||
|
22 | 22 | |
|
23 | 23 | from zope.interface import Interface, implements |
|
24 | 24 | from twisted.internet import defer |
|
25 |
from twisted.python import components, failure |
|
|
25 | from twisted.python import components, failure | |
|
26 | 26 | |
|
27 | 27 | from foolscap import Referenceable |
|
28 | 28 | |
|
29 | 29 | from IPython.kernel import error |
|
30 | from IPython.kernel.util import printer | |
|
31 | 30 | from IPython.kernel import map as Map |
|
32 | 31 | from IPython.kernel.parallelfunction import ParallelFunction |
|
33 | 32 | from IPython.kernel.mapper import ( |
@@ -36,14 +35,15 b' from IPython.kernel.mapper import (' | |||
|
36 | 35 | IMapper |
|
37 | 36 | ) |
|
38 | 37 | from IPython.kernel.twistedutil import gatherBoth |
|
39 |
from IPython.kernel.multiengine import ( |
|
|
38 | from IPython.kernel.multiengine import ( | |
|
40 | 39 | IMultiEngine, |
|
41 | 40 | IFullSynchronousMultiEngine, |
|
42 | 41 | ISynchronousMultiEngine) |
|
43 | from IPython.kernel.multiengineclient import wrapResultList | |
|
44 | 42 | from IPython.kernel.pendingdeferred import PendingDeferredManager |
|
45 |
from IPython.kernel.pickleutil import ( |
|
|
46 | canSequence, uncan, uncanDict, uncanSequence) | |
|
43 | from IPython.kernel.pickleutil import ( | |
|
44 | canDict, | |
|
45 | canSequence, uncanDict, uncanSequence | |
|
46 | ) | |
|
47 | 47 | |
|
48 | 48 | from IPython.kernel.clientinterfaces import ( |
|
49 | 49 | IFCClientInterfaceProvider, |
@@ -19,7 +19,6 b' import cPickle as pickle' | |||
|
19 | 19 | |
|
20 | 20 | from twisted.python.failure import Failure |
|
21 | 21 | from twisted.python import failure |
|
22 | import threading, sys | |
|
23 | 22 | |
|
24 | 23 | from IPython.kernel import pbconfig |
|
25 | 24 | from IPython.kernel.error import PBMessageSizeError, UnpickleableException |
@@ -58,7 +57,7 b' def unpackageFailure(r):' | |||
|
58 | 57 | result = pickle.loads(r[8:]) |
|
59 | 58 | except pickle.PickleError: |
|
60 | 59 | return failure.Failure( \ |
|
61 |
|
|
|
60 | UnpickleableException("Could not unpickle failure.")) | |
|
62 | 61 | else: |
|
63 | 62 | return result |
|
64 | 63 | return r |
@@ -22,15 +22,11 b' __docformat__ = "restructuredtext en"' | |||
|
22 | 22 | # Imports |
|
23 | 23 | #------------------------------------------------------------------------------- |
|
24 | 24 | |
|
25 |
from twisted. |
|
|
26 |
from twisted. |
|
|
27 | from twisted.python import log, components, failure | |
|
28 | from zope.interface import Interface, implements, Attribute | |
|
25 | from twisted.internet import defer | |
|
26 | from twisted.python import failure | |
|
29 | 27 | |
|
30 | from IPython.kernel.twistedutil import gatherBoth | |
|
31 | 28 | from IPython.kernel import error |
|
32 | 29 | from IPython.external import guid |
|
33 | from IPython.utils import growl | |
|
34 | 30 | |
|
35 | 31 | class PendingDeferredManager(object): |
|
36 | 32 | """A class to track pending deferreds. |
@@ -16,7 +16,6 b' __docformat__ = "restructuredtext en"' | |||
|
16 | 16 | #------------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | from types import FunctionType |
|
19 | from twisted.python import log | |
|
20 | 19 | |
|
21 | 20 | class CannedObject(object): |
|
22 | 21 | pass |
@@ -19,19 +19,18 b' __docformat__ = "restructuredtext en"' | |||
|
19 | 19 | # Tell nose to skip the testing of this module |
|
20 | 20 | __test__ = {} |
|
21 | 21 | |
|
22 |
import |
|
|
22 | import time | |
|
23 | 23 | from types import FunctionType |
|
24 | 24 | |
|
25 |
import zope.interface as zi |
|
|
25 | import zope.interface as zi | |
|
26 | 26 | from twisted.internet import defer, reactor |
|
27 | 27 | from twisted.python import components, log, failure |
|
28 | 28 | |
|
29 | from IPython.kernel.util import printer | |
|
30 | 29 | from IPython.kernel import engineservice as es, error |
|
31 | 30 | from IPython.kernel import controllerservice as cs |
|
32 |
from IPython.kernel.twistedutil import |
|
|
31 | from IPython.kernel.twistedutil import DeferredList | |
|
33 | 32 | |
|
34 |
from IPython.kernel.pickleutil import can, uncan |
|
|
33 | from IPython.kernel.pickleutil import can, uncan | |
|
35 | 34 | |
|
36 | 35 | #----------------------------------------------------------------------------- |
|
37 | 36 | # Definition of the Task objects |
@@ -19,10 +19,10 b' __docformat__ = "restructuredtext en"' | |||
|
19 | 19 | #------------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | from zope.interface import Interface, implements |
|
22 |
from twisted.python import components |
|
|
22 | from twisted.python import components | |
|
23 | 23 | |
|
24 | 24 | from IPython.kernel.twistedutil import blockingCallFromThread |
|
25 |
from IPython.kernel import task |
|
|
25 | from IPython.kernel import task | |
|
26 | 26 | from IPython.kernel.mapper import ( |
|
27 | 27 | SynchronousTaskMapper, |
|
28 | 28 | ITaskMapperFactory, |
@@ -19,17 +19,14 b' __docformat__ = "restructuredtext en"' | |||
|
19 | 19 | #------------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | import cPickle as pickle |
|
22 | import xmlrpclib, copy | |
|
23 | 22 | |
|
24 | 23 | from zope.interface import Interface, implements |
|
25 | 24 | from twisted.internet import defer |
|
26 |
from twisted.python import components |
|
|
25 | from twisted.python import components | |
|
27 | 26 | |
|
28 | 27 | from foolscap import Referenceable |
|
29 | 28 | |
|
30 | from IPython.kernel.twistedutil import blockingCallFromThread | |
|
31 | from IPython.kernel import error, task as taskmodule, taskclient | |
|
32 | from IPython.kernel.pickleutil import can, uncan | |
|
29 | from IPython.kernel import task as taskmodule | |
|
33 | 30 | from IPython.kernel.clientinterfaces import ( |
|
34 | 31 | IFCClientInterfaceProvider, |
|
35 | 32 | IBlockingClientAdaptor |
@@ -42,6 +42,14 b' def _raise_it(f):' | |||
|
42 | 42 | |
|
43 | 43 | class FullSynchronousMultiEngineTestCase(DeferredTestCase, IFullSynchronousMultiEngineTestCase): |
|
44 | 44 | |
|
45 | # XXX (fperez) this is awful: I'm fully disabling this entire test class. | |
|
46 | # Right now it's blocking the tests from running at all, and I don't know | |
|
47 | # how to fix it. I hope Brian can have a stab at it, but at least by doing | |
|
48 | # this we can run the entire suite to completion. | |
|
49 | # Once the problem is cleared, remove this skip method. | |
|
50 | skip = True | |
|
51 | # END XXX | |
|
52 | ||
|
45 | 53 | def setUp(self): |
|
46 | 54 | |
|
47 | 55 | self.engines = [] |
@@ -48,6 +48,14 b' def _raise_it(f):' | |||
|
48 | 48 | |
|
49 | 49 | class TaskTest(DeferredTestCase, ITaskControllerTestCase): |
|
50 | 50 | |
|
51 | # XXX (fperez) this is awful: I'm fully disabling this entire test class. | |
|
52 | # Right now it's blocking the tests from running at all, and I don't know | |
|
53 | # how to fix it. I hope Brian can have a stab at it, but at least by doing | |
|
54 | # this we can run the entire suite to completion. | |
|
55 | # Once the problem is cleared, remove this skip method. | |
|
56 | skip = True | |
|
57 | # END XXX | |
|
58 | ||
|
51 | 59 | def setUp(self): |
|
52 | 60 | |
|
53 | 61 | self.engines = [] |
@@ -15,7 +15,7 b'' | |||
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | import os, sys |
|
18 |
import threading, Queue |
|
|
18 | import threading, Queue | |
|
19 | 19 | |
|
20 | 20 | import twisted |
|
21 | 21 | from twisted.internet import defer, reactor |
@@ -23,12 +23,10 b' import re' | |||
|
23 | 23 | import uuid |
|
24 | 24 | |
|
25 | 25 | from xml.etree import ElementTree as ET |
|
26 | from xml.dom import minidom | |
|
27 | 26 | |
|
28 | 27 | from IPython.core.component import Component |
|
29 | from IPython.external import Itpl | |
|
30 | 28 | from IPython.utils.traitlets import ( |
|
31 |
Str, Int, List, |
|
|
29 | Str, Int, List, Instance, | |
|
32 | 30 | Enum, Bool, CStr |
|
33 | 31 | ) |
|
34 | 32 |
@@ -31,7 +31,7 b' import sys' | |||
|
31 | 31 | import threading |
|
32 | 32 | |
|
33 | 33 | from IPython.core.ultratb import AutoFormattedTB |
|
34 |
from IPython.utils. |
|
|
34 | from IPython.utils.warn import warn, error | |
|
35 | 35 | |
|
36 | 36 | class BackgroundJobManager: |
|
37 | 37 | """Class to manage a pool of backgrounded threaded jobs. |
@@ -1,15 +1,18 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | 3 | A module to change reload() so that it acts recursively. |
|
4 | To enable it type: | |
|
5 | >>> import __builtin__, deepreload | |
|
6 | >>> __builtin__.reload = deepreload.reload | |
|
4 | To enable it type:: | |
|
7 | 5 | |
|
8 | You can then disable it with: | |
|
9 |
|
|
|
6 | import __builtin__, deepreload | |
|
7 | __builtin__.reload = deepreload.reload | |
|
10 | 8 | |
|
11 | Alternatively, you can add a dreload builtin alongside normal reload with: | |
|
12 | >>> __builtin__.dreload = deepreload.reload | |
|
9 | You can then disable it with:: | |
|
10 | ||
|
11 | __builtin__.reload = deepreload.original_reload | |
|
12 | ||
|
13 | Alternatively, you can add a dreload builtin alongside normal reload with:: | |
|
14 | ||
|
15 | __builtin__.dreload = deepreload.reload | |
|
13 | 16 | |
|
14 | 17 | This code is almost entirely based on knee.py from the standard library. |
|
15 | 18 | """ |
@@ -176,7 +176,8 b' import shlex' | |||
|
176 | 176 | import sys |
|
177 | 177 | |
|
178 | 178 | from IPython.utils.PyColorize import Parser |
|
179 |
from IPython.utils. |
|
|
179 | from IPython.utils.io import file_read, file_readlines, Term | |
|
180 | from IPython.utils.text import marquee | |
|
180 | 181 | |
|
181 | 182 | __all__ = ['Demo','IPythonDemo','LineDemo','IPythonLineDemo','DemoError'] |
|
182 | 183 | |
@@ -543,7 +544,7 b' class ClearMixin(object):' | |||
|
543 | 544 | """Method called before executing each block. |
|
544 | 545 | |
|
545 | 546 | This one simply clears the screen.""" |
|
546 |
from IPython.utils. |
|
|
547 | from IPython.utils.terminal import term_clear | |
|
547 | 548 | term_clear() |
|
548 | 549 | |
|
549 | 550 | class ClearDemo(ClearMixin,Demo): |
@@ -1,5 +1,5 b'' | |||
|
1 | 1 | #!/usr/bin/env python |
|
2 |
# |
|
|
2 | # coding: utf-8 | |
|
3 | 3 | """ |
|
4 | 4 | Inputhook management for GUI event loop integration. |
|
5 | 5 | """ |
@@ -24,6 +24,7 b' import sys' | |||
|
24 | 24 | |
|
25 | 25 | # Constants for identifying the GUI toolkits. |
|
26 | 26 | GUI_WX = 'wx' |
|
27 | GUI_QT = 'qt' | |
|
27 | 28 | GUI_QT4 = 'qt4' |
|
28 | 29 | GUI_GTK = 'gtk' |
|
29 | 30 | GUI_TK = 'tk' |
@@ -326,8 +327,17 b' class InputHookManager(object):' | |||
|
326 | 327 | self._installed = True |
|
327 | 328 | return original |
|
328 | 329 | |
|
329 | def clear_inputhook(self): | |
|
330 |
"""Set PyOS_InputHook to NULL and return the previous one. |
|
|
330 | def clear_inputhook(self, app=None): | |
|
331 | """Set PyOS_InputHook to NULL and return the previous one. | |
|
332 | ||
|
333 | Parameters | |
|
334 | ---------- | |
|
335 | app : optional, ignored | |
|
336 | This parameter is allowed only so that clear_inputhook() can be | |
|
337 | called with a similar interface as all the ``enable_*`` methods. But | |
|
338 | the actual value of the parameter is ignored. This uniform interface | |
|
339 | makes it easier to have user-level entry points in the main IPython | |
|
340 | app like :meth:`enable_gui`.""" | |
|
331 | 341 | pyos_inputhook_ptr = self.get_pyos_inputhook() |
|
332 | 342 | original = self.get_pyos_inputhook_as_func() |
|
333 | 343 | pyos_inputhook_ptr.value = ctypes.c_void_p(None).value |
@@ -523,3 +533,39 b' set_inputhook = inputhook_manager.set_inputhook' | |||
|
523 | 533 | current_gui = inputhook_manager.current_gui |
|
524 | 534 | clear_app_refs = inputhook_manager.clear_app_refs |
|
525 | 535 | spin = inputhook_manager.spin |
|
536 | ||
|
537 | ||
|
538 | # Convenience function to switch amongst them | |
|
539 | def enable_gui(gui=None, app=True): | |
|
540 | """Switch amongst GUI input hooks by name. | |
|
541 | ||
|
542 | This is just a utility wrapper around the methods of the InputHookManager | |
|
543 | object. | |
|
544 | ||
|
545 | Parameters | |
|
546 | ---------- | |
|
547 | gui : optional, string or None | |
|
548 | If None, clears input hook, otherwise it must be one of the recognized | |
|
549 | GUI names (see ``GUI_*`` constants in module). | |
|
550 | ||
|
551 | app : optional, bool | |
|
552 | If true, create an app object and return it. | |
|
553 | ||
|
554 | Returns | |
|
555 | ------- | |
|
556 | The output of the underlying gui switch routine, typically the actual | |
|
557 | PyOS_InputHook wrapper object or the GUI toolkit app created, if there was | |
|
558 | one. | |
|
559 | """ | |
|
560 | guis = {None: clear_inputhook, | |
|
561 | GUI_TK: enable_tk, | |
|
562 | GUI_GTK: enable_gtk, | |
|
563 | GUI_WX: enable_wx, | |
|
564 | GUI_QT: enable_qt4, # qt3 not supported | |
|
565 | GUI_QT4: enable_qt4 } | |
|
566 | try: | |
|
567 | gui_hook = guis[gui] | |
|
568 | except KeyError: | |
|
569 | e="Invalid GUI request %r, valid ones are:%s" % (gui, guis.keys()) | |
|
570 | raise ValueError(e) | |
|
571 | return gui_hook(app) |
@@ -50,7 +50,7 b' del InteractiveShell,prefilter_shell' | |||
|
50 | 50 | |
|
51 | 51 | # Provide pysh and further shell-oriented services |
|
52 | 52 | import os,sys,shutil |
|
53 |
from IPython.utils. |
|
|
53 | from IPython.utils.process import system,shell,getoutput,getoutputerror | |
|
54 | 54 | |
|
55 | 55 | # Short aliases for getting shell output as a string and a list |
|
56 | 56 | sout = getoutput |
@@ -10,6 +10,7 b' var = !ls' | |||
|
10 | 10 | |
|
11 | 11 | from IPython.core import ipapi |
|
12 | 12 | from IPython.core.error import TryNext |
|
13 | from IPython.utils.text import make_quoted_expr | |
|
13 | 14 | from IPython.utils.genutils import * |
|
14 | 15 | |
|
15 | 16 | ip = ipapi.get() |
@@ -12,7 +12,7 b' do the same in default completer.' | |||
|
12 | 12 | from IPython.core import ipapi |
|
13 | 13 | from IPython.core.error import TryNext |
|
14 | 14 | from IPython.utils import generics |
|
15 |
from IPython.utils. |
|
|
15 | from IPython.utils.dir2 import dir2 | |
|
16 | 16 | |
|
17 | 17 | def attr_matches(self, text): |
|
18 | 18 | """Compute matches when text contains a dot. |
@@ -16,6 +16,7 b' import pickleshare' | |||
|
16 | 16 | import inspect,pickle,os,sys,textwrap |
|
17 | 17 | from IPython.core.fakemodule import FakeModule |
|
18 | 18 | from IPython.utils.ipstruct import Struct |
|
19 | from IPython.utils.warn import error | |
|
19 | 20 | |
|
20 | 21 | |
|
21 | 22 | def refresh_variables(ip, key=None): |
@@ -1,6 +1,6 b'' | |||
|
1 | 1 | import inspect |
|
2 | 2 | from IPython.core import ipapi |
|
3 |
from IPython.utils. |
|
|
3 | from IPython.utils.process import arg_split | |
|
4 | 4 | ip = ipapi.get() |
|
5 | 5 | |
|
6 | 6 | from IPython.core import debugger |
@@ -45,10 +45,9 b' from subprocess import *' | |||
|
45 | 45 | import os,shlex,sys,time |
|
46 | 46 | import threading,Queue |
|
47 | 47 | |
|
48 | from IPython.utils import genutils | |
|
49 | ||
|
50 | 48 | from IPython.core import ipapi |
|
51 | 49 | from IPython.core.error import TryNext |
|
50 | from IPython.utils.text import make_quoted_expr | |
|
52 | 51 | |
|
53 | 52 | if os.name == 'nt': |
|
54 | 53 | def kill_process(pid): |
@@ -126,8 +125,8 b' def jobctrl_prefilter_f(self,line):' | |||
|
126 | 125 | |
|
127 | 126 | line = ip.expand_aliases(fn,rest) |
|
128 | 127 | if not _jobq: |
|
129 |
return 'get_ipython().startjob(%s)' % |
|
|
130 |
return 'get_ipython().jobq(%s)' % |
|
|
128 | return 'get_ipython().startjob(%s)' % make_quoted_expr(line) | |
|
129 | return 'get_ipython().jobq(%s)' % make_quoted_expr(line) | |
|
131 | 130 | |
|
132 | 131 | raise TryNext |
|
133 | 132 |
@@ -3,6 +3,22 b'' | |||
|
3 | 3 | """IPython Test Suite Runner. |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | from IPython.testing import iptest | |
|
6 | # The tests can't even run if nose isn't available, so might as well give the | |
|
7 | # user a civilized error message in that case. | |
|
8 | ||
|
9 | try: | |
|
10 | import nose | |
|
11 | except ImportError: | |
|
12 | error = """\ | |
|
13 | ERROR: The IPython test suite requires nose to run. | |
|
7 | 14 | |
|
15 | Please install nose on your system first and try again. | |
|
16 | For information on installing nose, see: | |
|
17 | http://somethingaboutorange.com/mrl/projects/nose | |
|
18 | ||
|
19 | Exiting.""" | |
|
20 | import sys | |
|
21 | print >> sys.stderr, error | |
|
22 | else: | |
|
23 | from IPython.testing import iptest | |
|
8 | 24 | iptest.main() |
@@ -0,0 +1,29 b'' | |||
|
1 | """Testing support (tools to test IPython itself). | |
|
2 | """ | |
|
3 | ||
|
4 | #----------------------------------------------------------------------------- | |
|
5 | # Copyright (C) 2009 The IPython Development Team | |
|
6 | # | |
|
7 | # Distributed under the terms of the BSD License. The full license is in | |
|
8 | # the file COPYING, distributed as part of this software. | |
|
9 | #----------------------------------------------------------------------------- | |
|
10 | ||
|
11 | #----------------------------------------------------------------------------- | |
|
12 | # Functions | |
|
13 | #----------------------------------------------------------------------------- | |
|
14 | ||
|
15 | # User-level entry point for testing | |
|
16 | def test(): | |
|
17 | """Run the entire IPython test suite. | |
|
18 | ||
|
19 | For fine-grained control, you should use the :file:`iptest` script supplied | |
|
20 | with the IPython installation.""" | |
|
21 | ||
|
22 | # Do the import internally, so that this function doesn't increase total | |
|
23 | # import time | |
|
24 | from iptest import run_iptestall | |
|
25 | run_iptestall() | |
|
26 | ||
|
27 | # So nose doesn't try to run this as a test itself and we end up with an | |
|
28 | # infinite test loop | |
|
29 | test.__test__ = False |
@@ -10,27 +10,79 b' This module provides a set of useful decorators meant to be ready to use in' | |||
|
10 | 10 | your own tests. See the bottom of the file for the ready-made ones, and if you |
|
11 | 11 | find yourself writing a new one that may be of generic use, add it here. |
|
12 | 12 | |
|
13 | Included decorators: | |
|
14 | ||
|
15 | ||
|
16 | Lightweight testing that remains unittest-compatible. | |
|
17 | ||
|
18 | - @parametric, for parametric test support that is vastly easier to use than | |
|
19 | nose's for debugging. With ours, if a test fails, the stack under inspection | |
|
20 | is that of the test and not that of the test framework. | |
|
21 | ||
|
22 | - An @as_unittest decorator can be used to tag any normal parameter-less | |
|
23 | function as a unittest TestCase. Then, both nose and normal unittest will | |
|
24 | recognize it as such. This will make it easier to migrate away from Nose if | |
|
25 | we ever need/want to while maintaining very lightweight tests. | |
|
26 | ||
|
13 | 27 | NOTE: This file contains IPython-specific decorators and imports the |
|
14 | 28 | numpy.testing.decorators file, which we've copied verbatim. Any of our own |
|
15 | 29 | code will be added at the bottom if we end up extending this. |
|
30 | ||
|
31 | Authors | |
|
32 | ------- | |
|
33 | ||
|
34 | - Fernando Perez <Fernando.Perez@berkeley.edu> | |
|
16 | 35 | """ |
|
17 | 36 | |
|
37 | #----------------------------------------------------------------------------- | |
|
38 | # Copyright (C) 2009-2010 The IPython Development Team | |
|
39 | # | |
|
40 | # Distributed under the terms of the BSD License. The full license is in | |
|
41 | # the file COPYING, distributed as part of this software. | |
|
42 | #----------------------------------------------------------------------------- | |
|
43 | ||
|
44 | #----------------------------------------------------------------------------- | |
|
45 | # Imports | |
|
46 | #----------------------------------------------------------------------------- | |
|
47 | ||
|
18 | 48 | # Stdlib imports |
|
19 | 49 | import inspect |
|
20 | 50 | import sys |
|
51 | import unittest | |
|
21 | 52 | |
|
22 | 53 | # Third-party imports |
|
23 | 54 | |
|
24 |
# This is Michele Simionato's decorator module, |
|
|
55 | # This is Michele Simionato's decorator module, kept verbatim. | |
|
25 | 56 | from IPython.external.decorator import decorator, update_wrapper |
|
26 | 57 | |
|
58 | # We already have python3-compliant code for parametric tests | |
|
59 | if sys.version[0]=='2': | |
|
60 | from _paramtestpy2 import parametric, ParametricTestCase | |
|
61 | else: | |
|
62 | from _paramtestpy3 import parametric, ParametricTestCase | |
|
63 | ||
|
64 | # Expose the unittest-driven decorators | |
|
65 | from ipunittest import ipdoctest, ipdocstring | |
|
66 | ||
|
27 | 67 | # Grab the numpy-specific decorators which we keep in a file that we |
|
28 |
# occasionally update from upstream: decorators |
|
|
29 |
# |
|
|
30 |
from decorators |
|
|
68 | # occasionally update from upstream: decorators.py is a copy of | |
|
69 | # numpy.testing.decorators, we expose all of it here. | |
|
70 | from IPython.external.decorators import * | |
|
31 | 71 | |
|
32 | ############################################################################## | |
|
33 | # Local code begins | |
|
72 | #----------------------------------------------------------------------------- | |
|
73 | # Classes and functions | |
|
74 | #----------------------------------------------------------------------------- | |
|
75 | ||
|
76 | # Simple example of the basic idea | |
|
77 | def as_unittest(func): | |
|
78 | """Decorator to make a simple function into a normal test via unittest.""" | |
|
79 | class Tester(unittest.TestCase): | |
|
80 | def test(self): | |
|
81 | func() | |
|
82 | ||
|
83 | Tester.__name__ = func.__name__ | |
|
84 | ||
|
85 | return Tester | |
|
34 | 86 | |
|
35 | 87 | # Utility functions |
|
36 | 88 | |
@@ -51,21 +103,23 b' def apply_wrapper(wrapper,func):' | |||
|
51 | 103 | def make_label_dec(label,ds=None): |
|
52 | 104 | """Factory function to create a decorator that applies one or more labels. |
|
53 | 105 | |
|
54 |
|
|
|
106 | Parameters | |
|
107 | ---------- | |
|
55 | 108 | label : string or sequence |
|
56 | 109 | One or more labels that will be applied by the decorator to the functions |
|
57 | 110 | it decorates. Labels are attributes of the decorated function with their |
|
58 | 111 | value set to True. |
|
59 | 112 | |
|
60 | :Keywords: | |
|
61 | 113 | ds : string |
|
62 | 114 | An optional docstring for the resulting decorator. If not given, a |
|
63 | 115 | default docstring is auto-generated. |
|
64 | 116 | |
|
65 |
|
|
|
117 | Returns | |
|
118 | ------- | |
|
66 | 119 | A decorator. |
|
67 | 120 | |
|
68 |
|
|
|
121 | Examples | |
|
122 | -------- | |
|
69 | 123 | |
|
70 | 124 | A simple labeling decorator: |
|
71 | 125 | >>> slow = make_label_dec('slow') |
@@ -151,7 +205,7 b' def skipif(skip_condition, msg=None):' | |||
|
151 | 205 | |
|
152 | 206 | # Allow for both boolean or callable skip conditions. |
|
153 | 207 | if callable(skip_condition): |
|
154 |
skip_val = |
|
|
208 | skip_val = skip_condition | |
|
155 | 209 | else: |
|
156 | 210 | skip_val = lambda : skip_condition |
|
157 | 211 | |
@@ -193,11 +247,13 b' def skipif(skip_condition, msg=None):' | |||
|
193 | 247 | def skip(msg=None): |
|
194 | 248 | """Decorator factory - mark a test function for skipping from test suite. |
|
195 | 249 | |
|
196 |
|
|
|
250 | Parameters | |
|
251 | ---------- | |
|
197 | 252 | msg : string |
|
198 | 253 | Optional message to be added. |
|
199 | 254 | |
|
200 |
|
|
|
255 | Returns | |
|
256 | ------- | |
|
201 | 257 | decorator : function |
|
202 | 258 | Decorator, which, when applied to a function, causes SkipTest |
|
203 | 259 | to be raised, with the optional message added. |
@@ -206,6 +262,16 b' def skip(msg=None):' | |||
|
206 | 262 | return skipif(True,msg) |
|
207 | 263 | |
|
208 | 264 | |
|
265 | def onlyif(condition, msg): | |
|
266 | """The reverse from skipif, see skipif for details.""" | |
|
267 | ||
|
268 | if callable(condition): | |
|
269 | skip_condition = lambda : not condition() | |
|
270 | else: | |
|
271 | skip_condition = lambda : not condition | |
|
272 | ||
|
273 | return skipif(skip_condition, msg) | |
|
274 | ||
|
209 | 275 | #----------------------------------------------------------------------------- |
|
210 | 276 | # Utility functions for decorators |
|
211 | 277 | def numpy_not_available(): |
@@ -252,3 +318,7 b" skip_if_not_osx = skipif(sys.platform != 'darwin'," | |||
|
252 | 318 | skipif_not_numpy = skipif(numpy_not_available,"This test requires numpy") |
|
253 | 319 | |
|
254 | 320 | skipknownfailure = skip('This test is known to fail') |
|
321 | ||
|
322 | # A null 'decorator', useful to make more readable code that needs to pick | |
|
323 | # between different decorators based on OS or other conditions | |
|
324 | null_deco = lambda f: f |
@@ -17,25 +17,68 b' will change in the future.' | |||
|
17 | 17 | """ |
|
18 | 18 | |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | # Module imports | |
|
20 | # Copyright (C) 2009 The IPython Development Team | |
|
21 | # | |
|
22 | # Distributed under the terms of the BSD License. The full license is in | |
|
23 | # the file COPYING, distributed as part of this software. | |
|
21 | 24 | #----------------------------------------------------------------------------- |
|
22 | 25 | |
|
26 | #----------------------------------------------------------------------------- | |
|
27 | # Imports | |
|
28 | #----------------------------------------------------------------------------- | |
|
29 | ||
|
30 | # Stdlib | |
|
23 | 31 | import os |
|
24 | 32 | import os.path as path |
|
33 | import signal | |
|
25 | 34 | import sys |
|
26 | 35 | import subprocess |
|
27 | 36 | import tempfile |
|
28 | 37 | import time |
|
29 | 38 | import warnings |
|
30 | 39 | |
|
40 | # Note: monkeypatch! | |
|
41 | # We need to monkeypatch a small problem in nose itself first, before importing | |
|
42 | # it for actual use. This should get into nose upstream, but its release cycle | |
|
43 | # is slow and we need it for our parametric tests to work correctly. | |
|
44 | from IPython.testing import nosepatch | |
|
45 | # Now, proceed to import nose itself | |
|
31 | 46 | import nose.plugins.builtin |
|
32 | 47 | from nose.core import TestProgram |
|
33 | 48 | |
|
34 | from IPython.utils.platutils import find_cmd | |
|
35 | # from IPython.testing.plugin.ipdoctest import IPythonDoctest | |
|
49 | # Our own imports | |
|
50 | from IPython.utils.path import get_ipython_module_path | |
|
51 | from IPython.utils.process import find_cmd, pycmd2argv | |
|
52 | from IPython.utils.sysinfo import sys_info | |
|
53 | ||
|
54 | from IPython.testing import globalipapp | |
|
55 | from IPython.testing.plugin.ipdoctest import IPythonDoctest | |
|
36 | 56 | |
|
37 | 57 | pjoin = path.join |
|
38 | 58 | |
|
59 | ||
|
60 | #----------------------------------------------------------------------------- | |
|
61 | # Globals | |
|
62 | #----------------------------------------------------------------------------- | |
|
63 | ||
|
64 | ||
|
65 | #----------------------------------------------------------------------------- | |
|
66 | # Warnings control | |
|
67 | #----------------------------------------------------------------------------- | |
|
68 | ||
|
69 | # Twisted generates annoying warnings with Python 2.6, as will do other code | |
|
70 | # that imports 'sets' as of today | |
|
71 | warnings.filterwarnings('ignore', 'the sets module is deprecated', | |
|
72 | DeprecationWarning ) | |
|
73 | ||
|
74 | # This one also comes from Twisted | |
|
75 | warnings.filterwarnings('ignore', 'the sha module is deprecated', | |
|
76 | DeprecationWarning) | |
|
77 | ||
|
78 | # Wx on Fedora11 spits these out | |
|
79 | warnings.filterwarnings('ignore', 'wxPython/wxWidgets release number mismatch', | |
|
80 | UserWarning) | |
|
81 | ||
|
39 | 82 | #----------------------------------------------------------------------------- |
|
40 | 83 | # Logic for skipping doctests |
|
41 | 84 | #----------------------------------------------------------------------------- |
@@ -44,167 +87,165 b' def test_for(mod):' | |||
|
44 | 87 | """Test to see if mod is importable.""" |
|
45 | 88 | try: |
|
46 | 89 | __import__(mod) |
|
47 | except ImportError: | |
|
90 | except (ImportError, RuntimeError): | |
|
91 | # GTK reports Runtime error if it can't be initialized even if it's | |
|
92 | # importable. | |
|
48 | 93 | return False |
|
49 | 94 | else: |
|
50 | 95 | return True |
|
51 | 96 | |
|
52 | have_curses = test_for('_curses') | |
|
53 | have_wx = test_for('wx') | |
|
54 | have_wx_aui = test_for('wx.aui') | |
|
55 | have_zi = test_for('zope.interface') | |
|
56 |
have |
|
|
57 |
have |
|
|
58 |
have |
|
|
59 |
have |
|
|
60 |
have |
|
|
61 |
have |
|
|
97 | # Global dict where we can store information on what we have and what we don't | |
|
98 | # have available at test run time | |
|
99 | have = {} | |
|
100 | ||
|
101 | have['curses'] = test_for('_curses') | |
|
102 | have['wx'] = test_for('wx') | |
|
103 | have['wx.aui'] = test_for('wx.aui') | |
|
104 | have['zope.interface'] = test_for('zope.interface') | |
|
105 | have['twisted'] = test_for('twisted') | |
|
106 | have['foolscap'] = test_for('foolscap') | |
|
107 | have['objc'] = test_for('objc') | |
|
108 | have['pexpect'] = test_for('pexpect') | |
|
109 | have['gtk'] = test_for('gtk') | |
|
110 | have['gobject'] = test_for('gobject') | |
|
111 | ||
|
112 | #----------------------------------------------------------------------------- | |
|
113 | # Functions and classes | |
|
114 | #----------------------------------------------------------------------------- | |
|
115 | ||
|
116 | def report(): | |
|
117 | """Return a string with a summary report of test-related variables.""" | |
|
118 | ||
|
119 | out = [ sys_info() ] | |
|
120 | ||
|
121 | avail = [] | |
|
122 | not_avail = [] | |
|
123 | ||
|
124 | for k, is_avail in have.items(): | |
|
125 | if is_avail: | |
|
126 | avail.append(k) | |
|
127 | else: | |
|
128 | not_avail.append(k) | |
|
129 | ||
|
130 | if avail: | |
|
131 | out.append('\nTools and libraries available at test time:\n') | |
|
132 | avail.sort() | |
|
133 | out.append(' ' + ' '.join(avail)+'\n') | |
|
134 | ||
|
135 | if not_avail: | |
|
136 | out.append('\nTools and libraries NOT available at test time:\n') | |
|
137 | not_avail.sort() | |
|
138 | out.append(' ' + ' '.join(not_avail)+'\n') | |
|
139 | ||
|
140 | return ''.join(out) | |
|
62 | 141 | |
|
63 | 142 | |
|
64 | 143 | def make_exclude(): |
|
144 | """Make patterns of modules and packages to exclude from testing. | |
|
145 | ||
|
146 | For the IPythonDoctest plugin, we need to exclude certain patterns that | |
|
147 | cause testing problems. We should strive to minimize the number of | |
|
148 | skipped modules, since this means untested code. | |
|
65 | 149 |
|
|
66 | # For the IPythonDoctest plugin, we need to exclude certain patterns that cause | |
|
67 | # testing problems. We should strive to minimize the number of skipped | |
|
68 | # modules, since this means untested code. As the testing machinery | |
|
69 | # solidifies, this list should eventually become empty. | |
|
70 | EXCLUDE = [pjoin('IPython', 'external'), | |
|
71 | pjoin('IPython', 'frontend', 'process', 'winprocess.py'), | |
|
150 | These modules and packages will NOT get scanned by nose at all for tests. | |
|
151 | """ | |
|
152 | # Simple utility to make IPython paths more readably, we need a lot of | |
|
153 | # these below | |
|
154 | ipjoin = lambda *paths: pjoin('IPython', *paths) | |
|
155 | ||
|
156 | exclusions = [ipjoin('external'), | |
|
157 | ipjoin('frontend', 'process', 'winprocess.py'), | |
|
158 | # Deprecated old Shell and iplib modules, skip to avoid | |
|
159 | # warnings | |
|
160 | ipjoin('Shell'), | |
|
161 | ipjoin('iplib'), | |
|
72 | 162 | pjoin('IPython_doctest_plugin'), |
|
73 |
pjoin( |
|
|
74 |
pjoin( |
|
|
75 |
pjoin( |
|
|
76 | pjoin('IPython', 'testing', 'tools'), | |
|
77 |
pjoin( |
|
|
78 | pjoin('IPython', 'lib', 'inputhook') | |
|
163 | ipjoin('quarantine'), | |
|
164 | ipjoin('deathrow'), | |
|
165 | ipjoin('testing', 'attic'), | |
|
166 | # This guy is probably attic material | |
|
167 | ipjoin('testing', 'mkdoctests'), | |
|
168 | # Testing inputhook will need a lot of thought, to figure out | |
|
169 | # how to have tests that don't lock up with the gui event | |
|
170 | # loops in the picture | |
|
171 | ipjoin('lib', 'inputhook'), | |
|
172 | # Config files aren't really importable stand-alone | |
|
173 | ipjoin('config', 'default'), | |
|
174 | ipjoin('config', 'profile'), | |
|
79 | 175 | ] |
|
80 | 176 | |
|
81 |
if not have |
|
|
82 |
|
|
|
83 |
|
|
|
84 |
|
|
|
85 | ||
|
86 | if not have_gtk or not have_gobject: | |
|
87 | EXCLUDE.append(pjoin('IPython', 'lib', 'inputhookgtk')) | |
|
177 | if not have['wx']: | |
|
178 | exclusions.append(ipjoin('gui')) | |
|
179 | exclusions.append(ipjoin('frontend', 'wx')) | |
|
180 | exclusions.append(ipjoin('lib', 'inputhookwx')) | |
|
88 | 181 | |
|
89 | if not have_wx_aui: | |
|
90 | EXCLUDE.append(pjoin('IPython', 'gui', 'wx', 'wxIPython')) | |
|
182 | if not have['gtk'] or not have['gobject']: | |
|
183 | exclusions.append(ipjoin('lib', 'inputhookgtk')) | |
|
91 | 184 | |
|
92 |
if not have |
|
|
93 | EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa')) | |
|
185 | if not have['wx.aui']: | |
|
186 | exclusions.append(ipjoin('gui', 'wx', 'wxIPython')) | |
|
94 | 187 | |
|
95 | if not sys.platform == 'win32': | |
|
96 | EXCLUDE.append(pjoin('IPython', 'utils', 'platutils_win32')) | |
|
188 | if not have['objc']: | |
|
189 | exclusions.append(ipjoin('frontend', 'cocoa')) | |
|
97 | 190 | |
|
98 | 191 | # These have to be skipped on win32 because the use echo, rm, cd, etc. |
|
99 | 192 | # See ticket https://bugs.launchpad.net/bugs/366982 |
|
100 | 193 | if sys.platform == 'win32': |
|
101 |
|
|
|
102 |
|
|
|
194 | exclusions.append(ipjoin('testing', 'plugin', 'test_exampleip')) | |
|
195 | exclusions.append(ipjoin('testing', 'plugin', 'dtexample')) | |
|
103 | 196 | |
|
104 |
if not |
|
|
105 | EXCLUDE.append(pjoin('IPython', 'utils', 'platutils_posix')) | |
|
106 | ||
|
107 | if not have_pexpect: | |
|
108 | EXCLUDE.append(pjoin('IPython', 'scripts', 'irunner')) | |
|
197 | if not have['pexpect']: | |
|
198 | exclusions.extend([ipjoin('scripts', 'irunner'), | |
|
199 | ipjoin('lib', 'irunner')]) | |
|
109 | 200 | |
|
110 | 201 | # This is scary. We still have things in frontend and testing that |
|
111 | 202 | # are being tested by nose that use twisted. We need to rethink |
|
112 | 203 | # how we are isolating dependencies in testing. |
|
113 |
if not (have |
|
|
114 | EXCLUDE.append(pjoin('IPython', 'frontend', 'asyncfrontendbase')) | |
|
115 | EXCLUDE.append(pjoin('IPython', 'frontend', 'prefilterfrontend')) | |
|
116 |
|
|
|
117 |
|
|
|
118 | EXCLUDE.append(pjoin('IPython', 'frontend', 'tests', | |
|
119 |
|
|
|
120 | EXCLUDE.append(pjoin('IPython', 'frontend', 'tests', | |
|
121 | 'test_frontendbase')) | |
|
122 | EXCLUDE.append(pjoin('IPython', 'frontend', 'tests', | |
|
123 | 'test_prefilterfrontend')) | |
|
124 | EXCLUDE.append(pjoin('IPython', 'frontend', 'tests', | |
|
125 | 'test_asyncfrontendbase')), | |
|
126 | EXCLUDE.append(pjoin('IPython', 'testing', 'parametric')) | |
|
127 | EXCLUDE.append(pjoin('IPython', 'testing', 'util')) | |
|
128 | EXCLUDE.append(pjoin('IPython', 'testing', 'tests', | |
|
129 | 'test_decorators_trial')) | |
|
204 | if not (have['twisted'] and have['zope.interface'] and have['foolscap']): | |
|
205 | exclusions.extend( | |
|
206 | [ipjoin('frontend', 'asyncfrontendbase'), | |
|
207 | ipjoin('frontend', 'prefilterfrontend'), | |
|
208 | ipjoin('frontend', 'frontendbase'), | |
|
209 | ipjoin('frontend', 'linefrontendbase'), | |
|
210 | ipjoin('frontend', 'tests', 'test_linefrontend'), | |
|
211 | ipjoin('frontend', 'tests', 'test_frontendbase'), | |
|
212 | ipjoin('frontend', 'tests', 'test_prefilterfrontend'), | |
|
213 | ipjoin('frontend', 'tests', 'test_asyncfrontendbase'), | |
|
214 | ipjoin('testing', 'parametric'), | |
|
215 | ipjoin('testing', 'util'), | |
|
216 | ipjoin('testing', 'tests', 'test_decorators_trial'), | |
|
217 | ] ) | |
|
130 | 218 | |
|
131 | 219 | # This is needed for the reg-exp to match on win32 in the ipdoctest plugin. |
|
132 | 220 | if sys.platform == 'win32': |
|
133 |
|
|
|
134 | ||
|
135 | return EXCLUDE | |
|
136 | ||
|
137 | ||
|
138 | #----------------------------------------------------------------------------- | |
|
139 | # Functions and classes | |
|
140 | #----------------------------------------------------------------------------- | |
|
141 | ||
|
142 | def run_iptest(): | |
|
143 | """Run the IPython test suite using nose. | |
|
144 | ||
|
145 | This function is called when this script is **not** called with the form | |
|
146 | `iptest all`. It simply calls nose with appropriate command line flags | |
|
147 | and accepts all of the standard nose arguments. | |
|
148 | """ | |
|
149 | ||
|
150 | warnings.filterwarnings('ignore', | |
|
151 | 'This will be removed soon. Use IPython.testing.util instead') | |
|
152 | ||
|
153 | argv = sys.argv + [ | |
|
154 | # Loading ipdoctest causes problems with Twisted. | |
|
155 | # I am removing this as a temporary fix to get the | |
|
156 | # test suite back into working shape. Our nose | |
|
157 | # plugin needs to be gone through with a fine | |
|
158 | # toothed comb to find what is causing the problem. | |
|
159 | # '--with-ipdoctest', | |
|
160 | # '--ipdoctest-tests','--ipdoctest-extension=txt', | |
|
161 | # '--detailed-errors', | |
|
162 | ||
|
163 | # We add --exe because of setuptools' imbecility (it | |
|
164 | # blindly does chmod +x on ALL files). Nose does the | |
|
165 | # right thing and it tries to avoid executables, | |
|
166 | # setuptools unfortunately forces our hand here. This | |
|
167 | # has been discussed on the distutils list and the | |
|
168 | # setuptools devs refuse to fix this problem! | |
|
169 | '--exe', | |
|
170 | ] | |
|
171 | ||
|
172 | # Detect if any tests were required by explicitly calling an IPython | |
|
173 | # submodule or giving a specific path | |
|
174 | has_tests = False | |
|
175 | for arg in sys.argv: | |
|
176 | if 'IPython' in arg or arg.endswith('.py') or \ | |
|
177 | (':' in arg and '.py' in arg): | |
|
178 | has_tests = True | |
|
179 | break | |
|
180 | ||
|
181 | # If nothing was specifically requested, test full IPython | |
|
182 | if not has_tests: | |
|
183 | argv.append('IPython') | |
|
184 | ||
|
185 | # Construct list of plugins, omitting the existing doctest plugin, which | |
|
186 | # ours replaces (and extends). | |
|
187 | EXCLUDE = make_exclude() | |
|
188 | plugins = [] | |
|
189 | # plugins = [IPythonDoctest(EXCLUDE)] | |
|
190 | for p in nose.plugins.builtin.plugins: | |
|
191 | plug = p() | |
|
192 | if plug.name == 'doctest': | |
|
193 | continue | |
|
194 | plugins.append(plug) | |
|
221 | exclusions = [s.replace('\\','\\\\') for s in exclusions] | |
|
195 | 222 | |
|
196 | TestProgram(argv=argv,plugins=plugins) | |
|
223 | return exclusions | |
|
197 | 224 | |
|
198 | 225 | |
|
199 | 226 | class IPTester(object): |
|
200 | 227 | """Call that calls iptest or trial in a subprocess. |
|
201 | 228 | """ |
|
229 | #: string, name of test runner that will be called | |
|
230 | runner = None | |
|
231 | #: list, parameters for test runner | |
|
232 | params = None | |
|
233 | #: list, arguments of system call to be made to call test runner | |
|
234 | call_args = None | |
|
235 | #: list, process ids of subprocesses we start (for cleanup) | |
|
236 | pids = None | |
|
237 | ||
|
202 | 238 | def __init__(self,runner='iptest',params=None): |
|
203 | """ """ | |
|
239 | """Create new test runner.""" | |
|
240 | p = os.path | |
|
204 | 241 | if runner == 'iptest': |
|
205 | self.runner = ['iptest','-v'] | |
|
242 | iptest_app = get_ipython_module_path('IPython.testing.iptest') | |
|
243 | self.runner = pycmd2argv(iptest_app) + sys.argv[1:] | |
|
244 | elif runner == 'trial': | |
|
245 | # For trial, it needs to be installed system-wide | |
|
246 | self.runner = pycmd2argv(p.abspath(find_cmd('trial'))) | |
|
206 | 247 | else: |
|
207 | self.runner = [find_cmd('trial')] | |
|
248 | raise Exception('Not a valid test runner: %s' % repr(runner)) | |
|
208 | 249 | if params is None: |
|
209 | 250 | params = [] |
|
210 | 251 | if isinstance(params,str): |
@@ -214,58 +255,147 b' class IPTester(object):' | |||
|
214 | 255 | # Assemble call |
|
215 | 256 | self.call_args = self.runner+self.params |
|
216 | 257 | |
|
258 | # Store pids of anything we start to clean up on deletion, if possible | |
|
259 | # (on posix only, since win32 has no os.kill) | |
|
260 | self.pids = [] | |
|
261 | ||
|
217 | 262 | if sys.platform == 'win32': |
|
218 | def run(self): | |
|
219 | """Run the stored commands""" | |
|
220 | # On Windows, cd to temporary directory to run tests. Otherwise, | |
|
221 | # Twisted's trial may not be able to execute 'trial IPython', since | |
|
222 | # it will confuse the IPython module name with the ipython | |
|
223 | # execution scripts, because the windows file system isn't case | |
|
224 | # sensitive. | |
|
225 | # We also use os.system instead of subprocess.call, because I was | |
|
226 | # having problems with subprocess and I just don't know enough | |
|
263 | def _run_cmd(self): | |
|
264 | # On Windows, use os.system instead of subprocess.call, because I | |
|
265 | # was having problems with subprocess and I just don't know enough | |
|
227 | 266 | # about win32 to debug this reliably. Os.system may be the 'old |
|
228 | 267 | # fashioned' way to do it, but it works just fine. If someone |
|
229 | 268 | # later can clean this up that's fine, as long as the tests run |
|
230 | 269 | # reliably in win32. |
|
231 | curdir = os.getcwd() | |
|
232 | os.chdir(tempfile.gettempdir()) | |
|
233 |
|
|
|
234 | os.chdir(curdir) | |
|
235 | return stat | |
|
270 | # What types of problems are you having. They may be related to | |
|
271 | # running Python in unboffered mode. BG. | |
|
272 | return os.system(' '.join(self.call_args)) | |
|
236 | 273 | else: |
|
274 | def _run_cmd(self): | |
|
275 | #print >> sys.stderr, '*** CMD:', ' '.join(self.call_args) # dbg | |
|
276 | subp = subprocess.Popen(self.call_args) | |
|
277 | self.pids.append(subp.pid) | |
|
278 | # If this fails, the pid will be left in self.pids and cleaned up | |
|
279 | # later, but if the wait call succeeds, then we can clear the | |
|
280 | # stored pid. | |
|
281 | retcode = subp.wait() | |
|
282 | self.pids.pop() | |
|
283 | return retcode | |
|
284 | ||
|
237 | 285 |
|
|
238 | 286 |
|
|
239 | return subprocess.call(self.call_args) | |
|
287 | try: | |
|
288 | return self._run_cmd() | |
|
289 | except: | |
|
290 | import traceback | |
|
291 | traceback.print_exc() | |
|
292 | return 1 # signal failure | |
|
293 | ||
|
294 | def __del__(self): | |
|
295 | """Cleanup on exit by killing any leftover processes.""" | |
|
296 | ||
|
297 | if not hasattr(os, 'kill'): | |
|
298 | return | |
|
299 | ||
|
300 | for pid in self.pids: | |
|
301 | try: | |
|
302 | print 'Cleaning stale PID:', pid | |
|
303 | os.kill(pid, signal.SIGKILL) | |
|
304 | except OSError: | |
|
305 | # This is just a best effort, if we fail or the process was | |
|
306 | # really gone, ignore it. | |
|
307 | pass | |
|
240 | 308 | |
|
241 | 309 | |
|
242 | 310 | def make_runners(): |
|
243 | 311 | """Define the top-level packages that need to be tested. |
|
244 | 312 | """ |
|
245 | 313 | |
|
246 | nose_packages = ['config', 'core', 'extensions', | |
|
247 | 'frontend', 'lib', | |
|
314 | # Packages to be tested via nose, that only depend on the stdlib | |
|
315 | nose_pkg_names = ['config', 'core', 'extensions', 'frontend', 'lib', | |
|
248 | 316 | 'scripts', 'testing', 'utils'] |
|
249 | trial_packages = ['kernel'] | |
|
317 | # The machinery in kernel needs twisted for real testing | |
|
318 | trial_pkg_names = [] | |
|
250 | 319 | |
|
251 |
if have |
|
|
252 |
nose_p |
|
|
320 | if have['wx']: | |
|
321 | nose_pkg_names.append('gui') | |
|
253 | 322 | |
|
254 | nose_packages = ['IPython.%s' % m for m in nose_packages ] | |
|
255 | trial_packages = ['IPython.%s' % m for m in trial_packages ] | |
|
323 | # And add twisted ones if conditions are met | |
|
324 | if have['zope.interface'] and have['twisted'] and have['foolscap']: | |
|
325 | # We only list IPython.kernel for testing using twisted.trial as | |
|
326 | # nose and twisted.trial have conflicts that make the testing system | |
|
327 | # unstable. | |
|
328 | trial_pkg_names.append('kernel') | |
|
256 | 329 | |
|
257 | # Make runners | |
|
258 | runners = dict() | |
|
330 | # For debugging this code, only load quick stuff | |
|
331 | #nose_pkg_names = ['core', 'extensions'] # dbg | |
|
332 | #trial_pkg_names = [] # dbg | |
|
333 | ||
|
334 | # Make fully qualified package names prepending 'IPython.' to our name lists | |
|
335 | nose_packages = ['IPython.%s' % m for m in nose_pkg_names ] | |
|
336 | trial_packages = ['IPython.%s' % m for m in trial_pkg_names ] | |
|
259 | 337 | |
|
260 | nose_runners = dict(zip(nose_packages, [IPTester(params=v) for v in nose_packages])) | |
|
261 | if have_zi and have_twisted and have_foolscap: | |
|
262 |
|
|
|
263 | runners.update(nose_runners) | |
|
264 | runners.update(trial_runners) | |
|
338 | # Make runners | |
|
339 | runners = [ (v, IPTester('iptest', params=v)) for v in nose_packages ] | |
|
340 | runners.extend([ (v, IPTester('trial', params=v)) for v in trial_packages ]) | |
|
265 | 341 | |
|
266 | 342 | return runners |
|
267 | 343 | |
|
268 | 344 | |
|
345 | def run_iptest(): | |
|
346 | """Run the IPython test suite using nose. | |
|
347 | ||
|
348 | This function is called when this script is **not** called with the form | |
|
349 | `iptest all`. It simply calls nose with appropriate command line flags | |
|
350 | and accepts all of the standard nose arguments. | |
|
351 | """ | |
|
352 | ||
|
353 | warnings.filterwarnings('ignore', | |
|
354 | 'This will be removed soon. Use IPython.testing.util instead') | |
|
355 | ||
|
356 | argv = sys.argv + [ '--detailed-errors', # extra info in tracebacks | |
|
357 | ||
|
358 | # Loading ipdoctest causes problems with Twisted, but | |
|
359 | # our test suite runner now separates things and runs | |
|
360 | # all Twisted tests with trial. | |
|
361 | '--with-ipdoctest', | |
|
362 | '--ipdoctest-tests','--ipdoctest-extension=txt', | |
|
363 | ||
|
364 | # We add --exe because of setuptools' imbecility (it | |
|
365 | # blindly does chmod +x on ALL files). Nose does the | |
|
366 | # right thing and it tries to avoid executables, | |
|
367 | # setuptools unfortunately forces our hand here. This | |
|
368 | # has been discussed on the distutils list and the | |
|
369 | # setuptools devs refuse to fix this problem! | |
|
370 | '--exe', | |
|
371 | ] | |
|
372 | ||
|
373 | if nose.__version__ >= '0.11': | |
|
374 | # I don't fully understand why we need this one, but depending on what | |
|
375 | # directory the test suite is run from, if we don't give it, 0 tests | |
|
376 | # get run. Specifically, if the test suite is run from the source dir | |
|
377 | # with an argument (like 'iptest.py IPython.core', 0 tests are run, | |
|
378 | # even if the same call done in this directory works fine). It appears | |
|
379 | # that if the requested package is in the current dir, nose bails early | |
|
380 | # by default. Since it's otherwise harmless, leave it in by default | |
|
381 | # for nose >= 0.11, though unfortunately nose 0.10 doesn't support it. | |
|
382 | argv.append('--traverse-namespace') | |
|
383 | ||
|
384 | # Construct list of plugins, omitting the existing doctest plugin, which | |
|
385 | # ours replaces (and extends). | |
|
386 | plugins = [IPythonDoctest(make_exclude())] | |
|
387 | for p in nose.plugins.builtin.plugins: | |
|
388 | plug = p() | |
|
389 | if plug.name == 'doctest': | |
|
390 | continue | |
|
391 | plugins.append(plug) | |
|
392 | ||
|
393 | # We need a global ipython running in this process | |
|
394 | globalipapp.start_ipython() | |
|
395 | # Now nose can run | |
|
396 | TestProgram(argv=argv, plugins=plugins) | |
|
397 | ||
|
398 | ||
|
269 | 399 | def run_iptestall(): |
|
270 | 400 | """Run the entire IPython test suite by calling nose and trial. |
|
271 | 401 | |
@@ -277,32 +407,45 b' def run_iptestall():' | |||
|
277 | 407 | |
|
278 | 408 | runners = make_runners() |
|
279 | 409 | |
|
410 | # Run the test runners in a temporary dir so we can nuke it when finished | |
|
411 | # to clean up any junk files left over by accident. This also makes it | |
|
412 | # robust against being run in non-writeable directories by mistake, as the | |
|
413 | # temp dir will always be user-writeable. | |
|
414 | curdir = os.getcwd() | |
|
415 | testdir = tempfile.gettempdir() | |
|
416 | os.chdir(testdir) | |
|
417 | ||
|
280 | 418 | # Run all test runners, tracking execution time |
|
281 |
failed = |
|
|
419 | failed = [] | |
|
282 | 420 | t_start = time.time() |
|
283 | for name,runner in runners.iteritems(): | |
|
284 | print '*'*77 | |
|
421 | try: | |
|
422 | for (name, runner) in runners: | |
|
423 | print '*'*70 | |
|
285 | 424 | print 'IPython test group:',name |
|
286 | 425 | res = runner.run() |
|
287 | 426 | if res: |
|
288 |
failed |
|
|
427 | failed.append( (name, runner) ) | |
|
428 | finally: | |
|
429 | os.chdir(curdir) | |
|
289 | 430 | t_end = time.time() |
|
290 | 431 | t_tests = t_end - t_start |
|
291 | 432 | nrunners = len(runners) |
|
292 | 433 | nfail = len(failed) |
|
293 | 434 | # summarize results |
|
294 | 435 | |
|
295 |
print '*'*7 |
|
|
436 | print '*'*70 | |
|
437 | print 'Test suite completed for system with the following information:' | |
|
438 | print report() | |
|
296 | 439 | print 'Ran %s test groups in %.3fs' % (nrunners, t_tests) |
|
297 | 440 | |
|
441 | print 'Status:' | |
|
298 | 442 | if not failed: |
|
299 | 443 | print 'OK' |
|
300 | 444 | else: |
|
301 | 445 | # If anything went wrong, point out what command to rerun manually to |
|
302 | 446 | # see the actual errors and individual summary |
|
303 | 447 | print 'ERROR - %s out of %s test groups failed.' % (nfail, nrunners) |
|
304 | for name in failed: | |
|
305 | failed_runner = runners[name] | |
|
448 | for name, failed_runner in failed: | |
|
306 | 449 | print '-'*40 |
|
307 | 450 | print 'Runner failed:',name |
|
308 | 451 | print 'You may wish to rerun this one individually, with:' |
@@ -311,13 +454,13 b' def run_iptestall():' | |||
|
311 | 454 | |
|
312 | 455 | |
|
313 | 456 | def main(): |
|
314 | if len(sys.argv) == 1: | |
|
315 | run_iptestall() | |
|
457 | for arg in sys.argv[1:]: | |
|
458 | if arg.startswith('IPython'): | |
|
459 | # This is in-process | |
|
460 | run_iptest() | |
|
316 | 461 | else: |
|
317 | if sys.argv[1] == 'all': | |
|
462 | # This starts subprocesses | |
|
318 | 463 |
|
|
319 | else: | |
|
320 | run_iptest() | |
|
321 | 464 | |
|
322 | 465 | |
|
323 | 466 | if __name__ == '__main__': |
@@ -38,7 +38,7 b' import tempfile' | |||
|
38 | 38 | |
|
39 | 39 | # IPython-specific libraries |
|
40 | 40 | from IPython.lib import irunner |
|
41 |
from IPython.utils. |
|
|
41 | from IPython.utils.warn import fatal | |
|
42 | 42 | |
|
43 | 43 | class IndentOut(object): |
|
44 | 44 | """A simple output stream that indents all output by a fixed amount. |
@@ -1,11 +1,31 b'' | |||
|
1 | 1 | """Parametric testing on top of twisted.trial.unittest. |
|
2 | 2 | |
|
3 | XXX - It may be possbile to deprecate this in favor of the new, cleaner | |
|
4 | parametric code. We just need to double-check that the new code doesn't clash | |
|
5 | with Twisted (we know it works with nose and unittest). | |
|
3 | 6 | """ |
|
4 | 7 | |
|
5 | __all__ = ['parametric','Parametric'] | |
|
8 | #----------------------------------------------------------------------------- | |
|
9 | # Copyright (C) 2009 The IPython Development Team | |
|
10 | # | |
|
11 | # Distributed under the terms of the BSD License. The full license is in | |
|
12 | # the file COPYING, distributed as part of this software. | |
|
13 | #----------------------------------------------------------------------------- | |
|
14 | ||
|
15 | #----------------------------------------------------------------------------- | |
|
16 | # Imports | |
|
17 | #----------------------------------------------------------------------------- | |
|
18 | ||
|
6 | 19 | |
|
7 | 20 | from twisted.trial.unittest import TestCase |
|
8 | 21 | |
|
22 | #----------------------------------------------------------------------------- | |
|
23 | # Classes and functions | |
|
24 | #----------------------------------------------------------------------------- | |
|
25 | ||
|
26 | __all__ = ['parametric','Parametric'] | |
|
27 | ||
|
28 | ||
|
9 | 29 | def partial(f, *partial_args, **partial_kwargs): |
|
10 | 30 | """Generate a partial class method. |
|
11 | 31 | |
@@ -17,6 +37,7 b' def partial(f, *partial_args, **partial_kwargs):' | |||
|
17 | 37 | |
|
18 | 38 | return partial_func |
|
19 | 39 | |
|
40 | ||
|
20 | 41 | def parametric(f): |
|
21 | 42 | """Mark f as a parametric test. |
|
22 | 43 | |
@@ -24,6 +45,7 b' def parametric(f):' | |||
|
24 | 45 | f._parametric = True |
|
25 | 46 | return classmethod(f) |
|
26 | 47 | |
|
48 | ||
|
27 | 49 | def Parametric(cls): |
|
28 | 50 | """Register parametric tests with a class. |
|
29 | 51 | |
@@ -53,3 +75,4 b' def Parametric(cls):' | |||
|
53 | 75 | |
|
54 | 76 | # rename test generator so it isn't called again by nose |
|
55 | 77 | test_gen.im_func.func_name = '__done_' + test_name |
|
78 |
@@ -49,182 +49,14 b' from nose.util import anyp, getpackage, test_address, resolve_name, tolist' | |||
|
49 | 49 | |
|
50 | 50 | #----------------------------------------------------------------------------- |
|
51 | 51 | # Module globals and other constants |
|
52 | #----------------------------------------------------------------------------- | |
|
52 | 53 | |
|
53 | 54 | log = logging.getLogger(__name__) |
|
54 | 55 | |
|
55 | ########################################################################### | |
|
56 | # *** HACK *** | |
|
57 | # We must start our own ipython object and heavily muck with it so that all the | |
|
58 | # modifications IPython makes to system behavior don't send the doctest | |
|
59 | # machinery into a fit. This code should be considered a gross hack, but it | |
|
60 | # gets the job done. | |
|
61 | ||
|
62 | def default_argv(): | |
|
63 | """Return a valid default argv for creating testing instances of ipython""" | |
|
64 | ||
|
65 | # Get the install directory for the user configuration and tell ipython to | |
|
66 | # use the default profile from there. | |
|
67 | from IPython.config import userconfig | |
|
68 | ipcdir = os.path.dirname(userconfig.__file__) | |
|
69 | #ipconf = os.path.join(ipcdir,'ipy_user_conf.py') | |
|
70 | ipconf = os.path.join(ipcdir,'ipythonrc') | |
|
71 | #print 'conf:',ipconf # dbg | |
|
72 | ||
|
73 | return ['--colors=NoColor','--noterm_title','-rcfile=%s' % ipconf] | |
|
74 | ||
|
75 | ||
|
76 | # Hack to modify the %run command so we can sync the user's namespace with the | |
|
77 | # test globals. Once we move over to a clean magic system, this will be done | |
|
78 | # with much less ugliness. | |
|
79 | ||
|
80 | class py_file_finder(object): | |
|
81 | def __init__(self,test_filename): | |
|
82 | self.test_filename = test_filename | |
|
83 | ||
|
84 | def __call__(self,name): | |
|
85 | from IPython.utils.genutils import get_py_filename | |
|
86 | try: | |
|
87 | return get_py_filename(name) | |
|
88 | except IOError: | |
|
89 | test_dir = os.path.dirname(self.test_filename) | |
|
90 | new_path = os.path.join(test_dir,name) | |
|
91 | return get_py_filename(new_path) | |
|
92 | ||
|
93 | ||
|
94 | def _run_ns_sync(self,arg_s,runner=None): | |
|
95 | """Modified version of %run that syncs testing namespaces. | |
|
96 | ||
|
97 | This is strictly needed for running doctests that call %run. | |
|
98 | """ | |
|
99 | ||
|
100 | # When tests call %run directly (not via doctest) these function attributes | |
|
101 | # are not set | |
|
102 | try: | |
|
103 | fname = _run_ns_sync.test_filename | |
|
104 | except AttributeError: | |
|
105 | fname = arg_s | |
|
106 | ||
|
107 | finder = py_file_finder(fname) | |
|
108 | out = _ip.magic_run_ori(arg_s,runner,finder) | |
|
109 | ||
|
110 | # Simliarly, there is no test_globs when a test is NOT a doctest | |
|
111 | if hasattr(_run_ns_sync,'test_globs'): | |
|
112 | _run_ns_sync.test_globs.update(_ip.user_ns) | |
|
113 | return out | |
|
114 | ||
|
115 | ||
|
116 | class ipnsdict(dict): | |
|
117 | """A special subclass of dict for use as an IPython namespace in doctests. | |
|
118 | ||
|
119 | This subclass adds a simple checkpointing capability so that when testing | |
|
120 | machinery clears it (we use it as the test execution context), it doesn't | |
|
121 | get completely destroyed. | |
|
122 | """ | |
|
123 | ||
|
124 | def __init__(self,*a): | |
|
125 | dict.__init__(self,*a) | |
|
126 | self._savedict = {} | |
|
127 | ||
|
128 | def clear(self): | |
|
129 | dict.clear(self) | |
|
130 | self.update(self._savedict) | |
|
131 | ||
|
132 | def _checkpoint(self): | |
|
133 | self._savedict.clear() | |
|
134 | self._savedict.update(self) | |
|
135 | ||
|
136 | def update(self,other): | |
|
137 | self._checkpoint() | |
|
138 | dict.update(self,other) | |
|
139 | ||
|
140 | # If '_' is in the namespace, python won't set it when executing code, | |
|
141 | # and we have examples that test it. So we ensure that the namespace | |
|
142 | # is always 'clean' of it before it's used for test code execution. | |
|
143 | self.pop('_',None) | |
|
144 | ||
|
145 | # The builtins namespace must *always* be the real __builtin__ module, | |
|
146 | # else weird stuff happens. The main ipython code does have provisions | |
|
147 | # to ensure this after %run, but since in this class we do some | |
|
148 | # aggressive low-level cleaning of the execution namespace, we need to | |
|
149 | # correct for that ourselves, to ensure consitency with the 'real' | |
|
150 | # ipython. | |
|
151 | self['__builtins__'] = __builtin__ | |
|
152 | ||
|
153 | ||
|
154 | def start_ipython(): | |
|
155 | """Start a global IPython shell, which we need for IPython-specific syntax. | |
|
156 | """ | |
|
157 | ||
|
158 | # This function should only ever run once! | |
|
159 | if hasattr(start_ipython,'already_called'): | |
|
160 | return | |
|
161 | start_ipython.already_called = True | |
|
162 | ||
|
163 | # Ok, first time we're called, go ahead | |
|
164 | import new | |
|
165 | ||
|
166 | import IPython | |
|
167 | from IPython.core import ipapi | |
|
168 | ||
|
169 | def xsys(cmd): | |
|
170 | """Execute a command and print its output. | |
|
171 | ||
|
172 | This is just a convenience function to replace the IPython system call | |
|
173 | with one that is more doctest-friendly. | |
|
174 | """ | |
|
175 | cmd = _ip.var_expand(cmd,depth=1) | |
|
176 | sys.stdout.write(commands.getoutput(cmd)) | |
|
177 | sys.stdout.flush() | |
|
178 | ||
|
179 | # Store certain global objects that IPython modifies | |
|
180 | _displayhook = sys.displayhook | |
|
181 | _excepthook = sys.excepthook | |
|
182 | _main = sys.modules.get('__main__') | |
|
183 | ||
|
184 | argv = default_argv() | |
|
185 | ||
|
186 | # Start IPython instance. We customize it to start with minimal frills. | |
|
187 | IPython.shell.IPShell(argv,ipnsdict(),global_ns) | |
|
188 | ||
|
189 | # Deactivate the various python system hooks added by ipython for | |
|
190 | # interactive convenience so we don't confuse the doctest system | |
|
191 | sys.modules['__main__'] = _main | |
|
192 | sys.displayhook = _displayhook | |
|
193 | sys.excepthook = _excepthook | |
|
194 | ||
|
195 | # So that ipython magics and aliases can be doctested (they work by making | |
|
196 | # a call into a global _ip object) | |
|
197 | _ip = ipapi.get() | |
|
198 | __builtin__._ip = _ip | |
|
199 | ||
|
200 | # Modify the IPython system call with one that uses getoutput, so that we | |
|
201 | # can capture subcommands and print them to Python's stdout, otherwise the | |
|
202 | # doctest machinery would miss them. | |
|
203 | _ip.system = xsys | |
|
204 | ||
|
205 | # Also patch our %run function in. | |
|
206 | im = new.instancemethod(_run_ns_sync,_ip, _ip.__class__) | |
|
207 | _ip.magic_run_ori = _ip.magic_run | |
|
208 | _ip.magic_run = im | |
|
209 | ||
|
210 | # XXX - For some very bizarre reason, the loading of %history by default is | |
|
211 | # failing. This needs to be fixed later, but for now at least this ensures | |
|
212 | # that tests that use %hist run to completion. | |
|
213 | from IPython.core import history | |
|
214 | history.init_ipython(_ip) | |
|
215 | if not hasattr(_ip,'magic_history'): | |
|
216 | raise RuntimeError("Can't load magics, aborting") | |
|
217 | ||
|
218 | ||
|
219 | # The start call MUST be made here. I'm not sure yet why it doesn't work if | |
|
220 | # it is made later, at plugin initialization time, but in all my tests, that's | |
|
221 | # the case. | |
|
222 | start_ipython() | |
|
223 | ||
|
224 | # *** END HACK *** | |
|
225 | ########################################################################### | |
|
226 | 56 | |
|
57 | #----------------------------------------------------------------------------- | |
|
227 | 58 | # Classes and functions |
|
59 | #----------------------------------------------------------------------------- | |
|
228 | 60 | |
|
229 | 61 | def is_extension_module(filename): |
|
230 | 62 | """Return whether the given filename is an extension module. |
@@ -287,7 +119,7 b' class DocTestFinder(doctest.DocTestFinder):' | |||
|
287 | 119 | Find tests for the given object and any contained objects, and |
|
288 | 120 | add them to `tests`. |
|
289 | 121 | """ |
|
290 | ||
|
122 | #print '_find for:', obj, name, module # dbg | |
|
291 | 123 | if hasattr(obj,"skip_doctest"): |
|
292 | 124 | #print 'SKIPPING DOCTEST FOR:',obj # dbg |
|
293 | 125 | obj = DocTestSkip(obj) |
@@ -386,6 +218,7 b' class DocTestCase(doctests.DocTestCase):' | |||
|
386 | 218 | self._dt_optionflags = optionflags |
|
387 | 219 | self._dt_checker = checker |
|
388 | 220 | self._dt_test = test |
|
221 | self._dt_test_globs_ori = test.globs | |
|
389 | 222 | self._dt_setUp = setUp |
|
390 | 223 | self._dt_tearDown = tearDown |
|
391 | 224 | |
@@ -395,8 +228,9 b' class DocTestCase(doctests.DocTestCase):' | |||
|
395 | 228 | self._dt_runner = runner |
|
396 | 229 | |
|
397 | 230 | |
|
398 |
# Each doctest should remember |
|
|
399 | self._ori_dir = os.getcwd() | |
|
231 | # Each doctest should remember the directory it was loaded from, so | |
|
232 | # things like %run work without too many contortions | |
|
233 | self._ori_dir = os.path.dirname(test.filename) | |
|
400 | 234 | |
|
401 | 235 | # Modified runTest from the default stdlib |
|
402 | 236 | def runTest(self): |
@@ -417,6 +251,7 b' class DocTestCase(doctests.DocTestCase):' | |||
|
417 | 251 | # test was originally created, in case another doctest did a |
|
418 | 252 | # directory change. We'll restore this in the finally clause. |
|
419 | 253 | curdir = os.getcwd() |
|
254 | #print 'runTest in dir:', self._ori_dir # dbg | |
|
420 | 255 | os.chdir(self._ori_dir) |
|
421 | 256 | |
|
422 | 257 | runner.DIVIDER = "-"*70 |
@@ -431,7 +266,7 b' class DocTestCase(doctests.DocTestCase):' | |||
|
431 | 266 | |
|
432 | 267 | def setUp(self): |
|
433 | 268 | """Modified test setup that syncs with ipython namespace""" |
|
434 | ||
|
269 | #print "setUp test", self._dt_test.examples # dbg | |
|
435 | 270 | if isinstance(self._dt_test.examples[0],IPExample): |
|
436 | 271 | # for IPython examples *only*, we swap the globals with the ipython |
|
437 | 272 | # namespace, after updating it with the globals (which doctest |
@@ -442,6 +277,12 b' class DocTestCase(doctests.DocTestCase):' | |||
|
442 | 277 | super(DocTestCase, self).setUp() |
|
443 | 278 | |
|
444 | 279 | def tearDown(self): |
|
280 | ||
|
281 | # Undo the test.globs reassignment we made, so that the parent class | |
|
282 | # teardown doesn't destroy the ipython namespace | |
|
283 | if isinstance(self._dt_test.examples[0],IPExample): | |
|
284 | self._dt_test.globs = self._dt_test_globs_ori | |
|
285 | ||
|
445 | 286 | # XXX - fperez: I am not sure if this is truly a bug in nose 0.11, but |
|
446 | 287 | # it does look like one to me: its tearDown method tries to run |
|
447 | 288 | # |
@@ -730,8 +571,10 b' class IPDocTestRunner(doctest.DocTestRunner,object):' | |||
|
730 | 571 | # attribute. Our new %run will then only make the namespace update |
|
731 | 572 | # when called (rather than unconconditionally updating test.globs here |
|
732 | 573 | # for all examples, most of which won't be calling %run anyway). |
|
733 |
|
|
|
734 |
|
|
|
574 | #_ip._ipdoctest_test_globs = test.globs | |
|
575 | #_ip._ipdoctest_test_filename = test.filename | |
|
576 | ||
|
577 | test.globs.update(_ip.user_ns) | |
|
735 | 578 | |
|
736 | 579 | return super(IPDocTestRunner,self).run(test, |
|
737 | 580 | compileflags,out,clear_globs) |
@@ -845,6 +688,7 b' class ExtensionDoctest(doctests.Doctest):' | |||
|
845 | 688 | |
|
846 | 689 | |
|
847 | 690 | def loadTestsFromFile(self, filename): |
|
691 | #print "ipdoctest - from file", filename # dbg | |
|
848 | 692 | if is_extension_module(filename): |
|
849 | 693 | for t in self.loadTestsFromExtensionModule(filename): |
|
850 | 694 | yield t |
@@ -894,6 +738,7 b' class IPythonDoctest(ExtensionDoctest):' | |||
|
894 | 738 | """Look for doctests in the given object, which will be a |
|
895 | 739 | function, method or class. |
|
896 | 740 | """ |
|
741 | #print 'Plugin analyzing:', obj, parent # dbg | |
|
897 | 742 | # always use whitespace and ellipsis options |
|
898 | 743 | optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS |
|
899 | 744 | |
@@ -908,6 +753,7 b' class IPythonDoctest(ExtensionDoctest):' | |||
|
908 | 753 | checker=self.checker) |
|
909 | 754 | |
|
910 | 755 | def options(self, parser, env=os.environ): |
|
756 | #print "Options for nose plugin:", self.name # dbg | |
|
911 | 757 | Plugin.options(self, parser, env) |
|
912 | 758 | parser.add_option('--ipdoctest-tests', action='store_true', |
|
913 | 759 | dest='ipdoctest_tests', |
@@ -928,6 +774,7 b' class IPythonDoctest(ExtensionDoctest):' | |||
|
928 | 774 | parser.set_defaults(ipdoctest_extension=tolist(env_setting)) |
|
929 | 775 | |
|
930 | 776 | def configure(self, options, config): |
|
777 | #print "Configuring nose plugin:", self.name # dbg | |
|
931 | 778 | Plugin.configure(self, options, config) |
|
932 | 779 | self.doctest_tests = options.ipdoctest_tests |
|
933 | 780 | self.extension = tolist(options.ipdoctest_extension) |
@@ -18,25 +18,6 b' def doctest_simple():' | |||
|
18 | 18 | """ |
|
19 | 19 | |
|
20 | 20 | |
|
21 | def doctest_run_builtins(): | |
|
22 | """Check that %run doesn't damage __builtins__ via a doctest. | |
|
23 | ||
|
24 | This is similar to the test_run_builtins, but I want *both* forms of the | |
|
25 | test to catch any possible glitches in our testing machinery, since that | |
|
26 | modifies %run somewhat. So for this, we have both a normal test (below) | |
|
27 | and a doctest (this one). | |
|
28 | ||
|
29 | In [1]: import tempfile | |
|
30 | ||
|
31 | In [3]: f = tempfile.NamedTemporaryFile() | |
|
32 | ||
|
33 | In [4]: f.write('pass\\n') | |
|
34 | ||
|
35 | In [5]: f.flush() | |
|
36 | ||
|
37 | In [7]: %run $f.name | |
|
38 | """ | |
|
39 | ||
|
40 | 21 | def doctest_multiline1(): |
|
41 | 22 | """The ipdoctest machinery must handle multiline examples gracefully. |
|
42 | 23 |
@@ -5,13 +5,14 b'' | |||
|
5 | 5 | # Std lib |
|
6 | 6 | import inspect |
|
7 | 7 | import sys |
|
8 | import unittest | |
|
8 | 9 | |
|
9 | 10 | # Third party |
|
10 | 11 | import nose.tools as nt |
|
11 | 12 | |
|
12 | 13 | # Our own |
|
13 | 14 | from IPython.testing import decorators as dec |
|
14 | ||
|
15 | from IPython.testing.ipunittest import ParametricTestCase | |
|
15 | 16 | |
|
16 | 17 | #----------------------------------------------------------------------------- |
|
17 | 18 | # Utilities |
@@ -41,6 +42,30 b' def getargspec(obj):' | |||
|
41 | 42 | #----------------------------------------------------------------------------- |
|
42 | 43 | # Testing functions |
|
43 | 44 | |
|
45 | @dec.as_unittest | |
|
46 | def trivial(): | |
|
47 | """A trivial test""" | |
|
48 | pass | |
|
49 | ||
|
50 | # Some examples of parametric tests. | |
|
51 | ||
|
52 | def is_smaller(i,j): | |
|
53 | assert i<j,"%s !< %s" % (i,j) | |
|
54 | ||
|
55 | class Tester(ParametricTestCase): | |
|
56 | ||
|
57 | def test_parametric(self): | |
|
58 | yield is_smaller(3, 4) | |
|
59 | x, y = 1, 2 | |
|
60 | yield is_smaller(x, y) | |
|
61 | ||
|
62 | @dec.parametric | |
|
63 | def test_par_standalone(): | |
|
64 | yield is_smaller(3, 4) | |
|
65 | x, y = 1, 2 | |
|
66 | yield is_smaller(x, y) | |
|
67 | ||
|
68 | ||
|
44 | 69 | @dec.skip |
|
45 | 70 | def test_deliberately_broken(): |
|
46 | 71 | """A deliberately broken test - we want to skip this one.""" |
@@ -89,11 +114,12 b' def test_skip_dt_decorator():' | |||
|
89 | 114 | # Fetch the docstring from doctest_bad after decoration. |
|
90 | 115 | val = doctest_bad.__doc__ |
|
91 | 116 | |
|
92 |
assert |
|
|
117 | nt.assert_equal(check,val,"doctest_bad docstrings don't match") | |
|
118 | ||
|
93 | 119 | |
|
94 | 120 | # Doctest skipping should work for class methods too |
|
95 |
class |
|
|
96 | """Foo | |
|
121 | class FooClass(object): | |
|
122 | """FooClass | |
|
97 | 123 | |
|
98 | 124 | Example: |
|
99 | 125 | |
@@ -103,22 +129,22 b' class foo(object):' | |||
|
103 | 129 | |
|
104 | 130 | @dec.skip_doctest |
|
105 | 131 | def __init__(self,x): |
|
106 |
"""Make a |
|
|
132 | """Make a FooClass. | |
|
107 | 133 | |
|
108 | 134 | Example: |
|
109 | 135 | |
|
110 |
>>> f = |
|
|
136 | >>> f = FooClass(3) | |
|
111 | 137 | junk |
|
112 | 138 | """ |
|
113 |
print 'Making a |
|
|
139 | print 'Making a FooClass.' | |
|
114 | 140 | self.x = x |
|
115 | 141 | |
|
116 | 142 | @dec.skip_doctest |
|
117 | 143 | def bar(self,y): |
|
118 | 144 | """Example: |
|
119 | 145 | |
|
120 |
>>> f |
|
|
121 | >>> f.bar(0) | |
|
146 | >>> ff = FooClass(3) | |
|
147 | >>> ff.bar(0) | |
|
122 | 148 | boom! |
|
123 | 149 | >>> 1/0 |
|
124 | 150 | bam! |
@@ -128,15 +154,14 b' class foo(object):' | |||
|
128 | 154 | def baz(self,y): |
|
129 | 155 | """Example: |
|
130 | 156 | |
|
131 |
>>> f |
|
|
132 |
Making a |
|
|
133 | >>> f.baz(3) | |
|
157 | >>> ff2 = FooClass(3) | |
|
158 | Making a FooClass. | |
|
159 | >>> ff2.baz(3) | |
|
134 | 160 | True |
|
135 | 161 | """ |
|
136 | 162 | return self.x==y |
|
137 | 163 | |
|
138 | 164 | |
|
139 | ||
|
140 | 165 | def test_skip_dt_decorator2(): |
|
141 | 166 | """Doctest-skipping decorator should preserve function signature. |
|
142 | 167 | """ |
@@ -159,3 +184,36 b' def test_win32():' | |||
|
159 | 184 | @dec.skip_osx |
|
160 | 185 | def test_osx(): |
|
161 | 186 | nt.assert_not_equals(sys.platform,'darwin',"This test can't run under osx") |
|
187 | ||
|
188 | ||
|
189 | # Verify that the same decorators work for methods. | |
|
190 | # Note: this code is identical to that in test_decorators_trial, but that one | |
|
191 | # uses twisted's unittest, not the one from the stdlib, which we are using | |
|
192 | # here. While somewhat redundant, we want to check both with the stdlib and | |
|
193 | # with twisted, so the duplication is OK. | |
|
194 | class TestDecoratorsTrial(unittest.TestCase): | |
|
195 | ||
|
196 | @dec.skip() | |
|
197 | def test_deliberately_broken(self): | |
|
198 | """A deliberately broken test - we want to skip this one.""" | |
|
199 | 1/0 | |
|
200 | ||
|
201 | @dec.skip('Testing the skip decorator') | |
|
202 | def test_deliberately_broken2(self): | |
|
203 | """Another deliberately broken test - we want to skip this one.""" | |
|
204 | 1/0 | |
|
205 | ||
|
206 | @dec.skip_linux | |
|
207 | def test_linux(self): | |
|
208 | self.assertNotEquals(sys.platform, 'linux2', | |
|
209 | "This test can't run under linux") | |
|
210 | ||
|
211 | @dec.skip_win32 | |
|
212 | def test_win32(self): | |
|
213 | self.assertNotEquals(sys.platform, 'win32', | |
|
214 | "This test can't run under windows") | |
|
215 | ||
|
216 | @dec.skip_osx | |
|
217 | def test_osx(self): | |
|
218 | self.assertNotEquals(sys.platform, 'darwin', | |
|
219 | "This test can't run under osx") |
|
1 | NO CONTENT: modified file |
@@ -14,6 +14,7 b' Tests for testing.tools' | |||
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | # Imports |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | from __future__ import with_statement | |
|
17 | 18 | |
|
18 | 19 | import os |
|
19 | 20 | import sys |
@@ -21,32 +22,53 b' import sys' | |||
|
21 | 22 | import nose.tools as nt |
|
22 | 23 | |
|
23 | 24 | from IPython.testing import decorators as dec |
|
24 |
from IPython.testing |
|
|
25 | from IPython.testing import tools as tt | |
|
25 | 26 | |
|
26 | 27 | #----------------------------------------------------------------------------- |
|
27 | 28 | # Tests |
|
28 | 29 | #----------------------------------------------------------------------------- |
|
29 | 30 | |
|
30 | ||
|
31 | 31 | @dec.skip_win32 |
|
32 | 32 | def test_full_path_posix(): |
|
33 | 33 | spath = '/foo/bar.py' |
|
34 | result = full_path(spath,['a.txt','b.txt']) | |
|
34 | result = tt.full_path(spath,['a.txt','b.txt']) | |
|
35 | 35 | nt.assert_equal(result, ['/foo/a.txt', '/foo/b.txt']) |
|
36 | 36 | spath = '/foo' |
|
37 | result = full_path(spath,['a.txt','b.txt']) | |
|
37 | result = tt.full_path(spath,['a.txt','b.txt']) | |
|
38 | 38 | nt.assert_equal(result, ['/a.txt', '/b.txt']) |
|
39 | result = full_path(spath,'a.txt') | |
|
39 | result = tt.full_path(spath,'a.txt') | |
|
40 | 40 | nt.assert_equal(result, ['/a.txt']) |
|
41 | 41 | |
|
42 | 42 | |
|
43 | 43 | @dec.skip_if_not_win32 |
|
44 | 44 | def test_full_path_win32(): |
|
45 | 45 | spath = 'c:\\foo\\bar.py' |
|
46 | result = full_path(spath,['a.txt','b.txt']) | |
|
46 | result = tt.full_path(spath,['a.txt','b.txt']) | |
|
47 | 47 | nt.assert_equal(result, ['c:\\foo\\a.txt', 'c:\\foo\\b.txt']) |
|
48 | 48 | spath = 'c:\\foo' |
|
49 | result = full_path(spath,['a.txt','b.txt']) | |
|
49 | result = tt.full_path(spath,['a.txt','b.txt']) | |
|
50 | 50 | nt.assert_equal(result, ['c:\\a.txt', 'c:\\b.txt']) |
|
51 | result = full_path(spath,'a.txt') | |
|
51 | result = tt.full_path(spath,'a.txt') | |
|
52 | 52 | nt.assert_equal(result, ['c:\\a.txt']) |
|
53 | ||
|
54 | ||
|
55 | @dec.parametric | |
|
56 | def test_parser(): | |
|
57 | err = ("FAILED (errors=1)", 1, 0) | |
|
58 | fail = ("FAILED (failures=1)", 0, 1) | |
|
59 | both = ("FAILED (errors=1, failures=1)", 1, 1) | |
|
60 | for txt, nerr, nfail in [err, fail, both]: | |
|
61 | nerr1, nfail1 = tt.parse_test_output(txt) | |
|
62 | yield nt.assert_equal(nerr, nerr1) | |
|
63 | yield nt.assert_equal(nfail, nfail1) | |
|
64 | ||
|
65 | ||
|
66 | @dec.parametric | |
|
67 | def test_temp_pyfile(): | |
|
68 | src = 'pass\n' | |
|
69 | fname, fh = tt.temp_pyfile(src) | |
|
70 | yield nt.assert_true(os.path.isfile(fname)) | |
|
71 | fh.close() | |
|
72 | with open(fname) as fh2: | |
|
73 | src2 = fh2.read() | |
|
74 | yield nt.assert_equal(src2, src) |
@@ -15,24 +15,38 b' Authors' | |||
|
15 | 15 | - Fernando Perez <Fernando.Perez@berkeley.edu> |
|
16 | 16 | """ |
|
17 | 17 | |
|
18 | #***************************************************************************** | |
|
18 | from __future__ import absolute_import | |
|
19 | ||
|
20 | #----------------------------------------------------------------------------- | |
|
19 | 21 |
# |
|
20 | 22 | # |
|
21 | 23 | # Distributed under the terms of the BSD License. The full license is in |
|
22 | 24 | # the file COPYING, distributed as part of this software. |
|
23 | #***************************************************************************** | |
|
25 | #----------------------------------------------------------------------------- | |
|
24 | 26 | |
|
25 | 27 | #----------------------------------------------------------------------------- |
|
26 | # Required modules and packages | |
|
28 | # Imports | |
|
27 | 29 | #----------------------------------------------------------------------------- |
|
28 | 30 | |
|
29 | 31 | import os |
|
32 | import re | |
|
30 | 33 | import sys |
|
31 | 34 | |
|
35 | try: | |
|
36 | # These tools are used by parts of the runtime, so we make the nose | |
|
37 | # dependency optional at this point. Nose is a hard dependency to run the | |
|
38 | # test suite, but NOT to use ipython itself. | |
|
32 | 39 | import nose.tools as nt |
|
40 | has_nose = True | |
|
41 | except ImportError: | |
|
42 | has_nose = False | |
|
43 | ||
|
44 | from IPython.config.loader import Config | |
|
45 | from IPython.utils.process import find_cmd, getoutputerror | |
|
46 | from IPython.utils.text import list_strings | |
|
47 | from IPython.utils.io import temp_pyfile | |
|
33 | 48 | |
|
34 | from IPython.utils import genutils | |
|
35 | from IPython.testing import decorators as dec | |
|
49 | from . import decorators as dec | |
|
36 | 50 | |
|
37 | 51 | #----------------------------------------------------------------------------- |
|
38 | 52 | # Globals |
@@ -46,6 +60,7 b' def %(name)s(*a,**kw):' | |||
|
46 | 60 | return nt.%(name)s(*a,**kw) |
|
47 | 61 | """ |
|
48 | 62 | |
|
63 | if has_nose: | |
|
49 | 64 | for _x in [a for a in dir(nt) if a.startswith('assert')]: |
|
50 | 65 | exec _tpl % dict(name=_x) |
|
51 | 66 | |
@@ -53,7 +68,11 b" for _x in [a for a in dir(nt) if a.startswith('assert')]:" | |||
|
53 | 68 | # Functions and classes |
|
54 | 69 | #----------------------------------------------------------------------------- |
|
55 | 70 | |
|
71 | # The docstring for full_path doctests differently on win32 (different path | |
|
72 | # separator) so just skip the doctest there. The example remains informative. | |
|
73 | doctest_deco = dec.skip_doctest if sys.platform == 'win32' else dec.null_deco | |
|
56 | 74 | |
|
75 | @doctest_deco | |
|
57 | 76 | def full_path(startPath,files): |
|
58 | 77 | """Make full paths for all the listed files, based on startPath. |
|
59 | 78 | |
@@ -84,6 +103,175 b' def full_path(startPath,files):' | |||
|
84 | 103 | ['/a.txt'] |
|
85 | 104 | """ |
|
86 | 105 | |
|
87 |
files = |
|
|
106 | files = list_strings(files) | |
|
88 | 107 | base = os.path.split(startPath)[0] |
|
89 | 108 | return [ os.path.join(base,f) for f in files ] |
|
109 | ||
|
110 | ||
|
111 | def parse_test_output(txt): | |
|
112 | """Parse the output of a test run and return errors, failures. | |
|
113 | ||
|
114 | Parameters | |
|
115 | ---------- | |
|
116 | txt : str | |
|
117 | Text output of a test run, assumed to contain a line of one of the | |
|
118 | following forms:: | |
|
119 | 'FAILED (errors=1)' | |
|
120 | 'FAILED (failures=1)' | |
|
121 | 'FAILED (errors=1, failures=1)' | |
|
122 | ||
|
123 | Returns | |
|
124 | ------- | |
|
125 | nerr, nfail: number of errors and failures. | |
|
126 | """ | |
|
127 | ||
|
128 | err_m = re.search(r'^FAILED \(errors=(\d+)\)', txt, re.MULTILINE) | |
|
129 | if err_m: | |
|
130 | nerr = int(err_m.group(1)) | |
|
131 | nfail = 0 | |
|
132 | return nerr, nfail | |
|
133 | ||
|
134 | fail_m = re.search(r'^FAILED \(failures=(\d+)\)', txt, re.MULTILINE) | |
|
135 | if fail_m: | |
|
136 | nerr = 0 | |
|
137 | nfail = int(fail_m.group(1)) | |
|
138 | return nerr, nfail | |
|
139 | ||
|
140 | both_m = re.search(r'^FAILED \(errors=(\d+), failures=(\d+)\)', txt, | |
|
141 | re.MULTILINE) | |
|
142 | if both_m: | |
|
143 | nerr = int(both_m.group(1)) | |
|
144 | nfail = int(both_m.group(2)) | |
|
145 | return nerr, nfail | |
|
146 | ||
|
147 | # If the input didn't match any of these forms, assume no error/failures | |
|
148 | return 0, 0 | |
|
149 | ||
|
150 | ||
|
151 | # So nose doesn't think this is a test | |
|
152 | parse_test_output.__test__ = False | |
|
153 | ||
|
154 | ||
|
155 | def default_argv(): | |
|
156 | """Return a valid default argv for creating testing instances of ipython""" | |
|
157 | ||
|
158 | return ['--quick', # so no config file is loaded | |
|
159 | # Other defaults to minimize side effects on stdout | |
|
160 | '--colors=NoColor', '--no-term-title','--no-banner', | |
|
161 | '--autocall=0'] | |
|
162 | ||
|
163 | ||
|
164 | def default_config(): | |
|
165 | """Return a config object with good defaults for testing.""" | |
|
166 | config = Config() | |
|
167 | config.InteractiveShell.colors = 'NoColor' | |
|
168 | config.InteractiveShell.term_title = False, | |
|
169 | config.InteractiveShell.autocall = 0 | |
|
170 | return config | |
|
171 | ||
|
172 | ||
|
173 | def ipexec(fname, options=None): | |
|
174 | """Utility to call 'ipython filename'. | |
|
175 | ||
|
176 | Starts IPython witha minimal and safe configuration to make startup as fast | |
|
177 | as possible. | |
|
178 | ||
|
179 | Note that this starts IPython in a subprocess! | |
|
180 | ||
|
181 | Parameters | |
|
182 | ---------- | |
|
183 | fname : str | |
|
184 | Name of file to be executed (should have .py or .ipy extension). | |
|
185 | ||
|
186 | options : optional, list | |
|
187 | Extra command-line flags to be passed to IPython. | |
|
188 | ||
|
189 | Returns | |
|
190 | ------- | |
|
191 | (stdout, stderr) of ipython subprocess. | |
|
192 | """ | |
|
193 | if options is None: options = [] | |
|
194 | ||
|
195 | # For these subprocess calls, eliminate all prompt printing so we only see | |
|
196 | # output from script execution | |
|
197 | prompt_opts = ['--prompt-in1=""', '--prompt-in2=""', '--prompt-out=""'] | |
|
198 | cmdargs = ' '.join(default_argv() + prompt_opts + options) | |
|
199 | ||
|
200 | _ip = get_ipython() | |
|
201 | test_dir = os.path.dirname(__file__) | |
|
202 | ||
|
203 | ipython_cmd = find_cmd('ipython') | |
|
204 | # Absolute path for filename | |
|
205 | full_fname = os.path.join(test_dir, fname) | |
|
206 | full_cmd = '%s %s %s' % (ipython_cmd, cmdargs, full_fname) | |
|
207 | #print >> sys.stderr, 'FULL CMD:', full_cmd # dbg | |
|
208 | return getoutputerror(full_cmd) | |
|
209 | ||
|
210 | ||
|
211 | def ipexec_validate(fname, expected_out, expected_err='', | |
|
212 | options=None): | |
|
213 | """Utility to call 'ipython filename' and validate output/error. | |
|
214 | ||
|
215 | This function raises an AssertionError if the validation fails. | |
|
216 | ||
|
217 | Note that this starts IPython in a subprocess! | |
|
218 | ||
|
219 | Parameters | |
|
220 | ---------- | |
|
221 | fname : str | |
|
222 | Name of the file to be executed (should have .py or .ipy extension). | |
|
223 | ||
|
224 | expected_out : str | |
|
225 | Expected stdout of the process. | |
|
226 | ||
|
227 | expected_err : optional, str | |
|
228 | Expected stderr of the process. | |
|
229 | ||
|
230 | options : optional, list | |
|
231 | Extra command-line flags to be passed to IPython. | |
|
232 | ||
|
233 | Returns | |
|
234 | ------- | |
|
235 | None | |
|
236 | """ | |
|
237 | ||
|
238 | import nose.tools as nt | |
|
239 | ||
|
240 | out, err = ipexec(fname) | |
|
241 | #print 'OUT', out # dbg | |
|
242 | #print 'ERR', err # dbg | |
|
243 | # If there are any errors, we must check those befor stdout, as they may be | |
|
244 | # more informative than simply having an empty stdout. | |
|
245 | if err: | |
|
246 | if expected_err: | |
|
247 | nt.assert_equals(err.strip(), expected_err.strip()) | |
|
248 | else: | |
|
249 | raise ValueError('Running file %r produced error: %r' % | |
|
250 | (fname, err)) | |
|
251 | # If no errors or output on stderr was expected, match stdout | |
|
252 | nt.assert_equals(out.strip(), expected_out.strip()) | |
|
253 | ||
|
254 | ||
|
255 | class TempFileMixin(object): | |
|
256 | """Utility class to create temporary Python/IPython files. | |
|
257 | ||
|
258 | Meant as a mixin class for test cases.""" | |
|
259 | ||
|
260 | def mktmp(self, src, ext='.py'): | |
|
261 | """Make a valid python temp file.""" | |
|
262 | fname, f = temp_pyfile(src, ext) | |
|
263 | self.tmpfile = f | |
|
264 | self.fname = fname | |
|
265 | ||
|
266 | def teardown(self): | |
|
267 | if hasattr(self, 'tmpfile'): | |
|
268 | # If the tmpfile wasn't made because of skipped tests, like in | |
|
269 | # win32, there's nothing to cleanup. | |
|
270 | self.tmpfile.close() | |
|
271 | try: | |
|
272 | os.unlink(self.fname) | |
|
273 | except: | |
|
274 | # On Windows, even though we close the file, we still can't | |
|
275 | # delete it. I have no clue why | |
|
276 | pass | |
|
277 |
@@ -1,23 +1,24 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """This file contains utility classes for performing tests with Deferreds. |
|
3 | 3 | """ |
|
4 | __docformat__ = "restructuredtext en" | |
|
5 | #------------------------------------------------------------------------------- | |
|
6 | # Copyright (C) 2005 Fernando Perez <fperez@colorado.edu> | |
|
7 | # Brian E Granger <ellisonbg@gmail.com> | |
|
8 | # Benjamin Ragan-Kelley <benjaminrk@gmail.com> | |
|
4 | #----------------------------------------------------------------------------- | |
|
5 | # Copyright (C) 2009 The IPython Development Team | |
|
9 | 6 | # |
|
10 | 7 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | 8 | # the file COPYING, distributed as part of this software. |
|
12 |
#----------------------------------------------------------------------------- |
|
|
9 | #----------------------------------------------------------------------------- | |
|
13 | 10 | |
|
14 |
#----------------------------------------------------------------------------- |
|
|
11 | #----------------------------------------------------------------------------- | |
|
15 | 12 | # Imports |
|
16 |
#----------------------------------------------------------------------------- |
|
|
13 | #----------------------------------------------------------------------------- | |
|
17 | 14 | |
|
18 | 15 | from twisted.trial import unittest |
|
19 | 16 | from twisted.internet import defer |
|
20 | 17 | |
|
18 | #----------------------------------------------------------------------------- | |
|
19 | # Classes and functions | |
|
20 | #----------------------------------------------------------------------------- | |
|
21 | ||
|
21 | 22 | class DeferredTestCase(unittest.TestCase): |
|
22 | 23 | |
|
23 | 24 | def assertDeferredEquals(self, deferred, expectedResult, |
|
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 |
|
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: file renamed from IPython/utils/tests/test_genutils.py to IPython/utils/tests/test_path.py | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file renamed from IPython/utils/tests/test_platutils.py to IPython/utils/tests/test_process.py | |
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 |
|
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 |
|
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 |
|
1 | NO CONTENT: modified file | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed |
|
1 | NO CONTENT: file was removed | |
This diff has been collapsed as it changes many lines, (690 lines changed) Show them Hide them |
|
1 | NO CONTENT: file was removed | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
The requested commit or file is too big and content was truncated. Show full diff |
|
1 | NO CONTENT: file was removed | |
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