Show More
The requested changes are too big and content was truncated. Show full diff
@@ -1,300 +1,304 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 | """ |
|
3 | """ | |
4 | An application for IPython |
|
4 | An application for IPython | |
5 |
|
5 | |||
6 | Authors: |
|
6 | Authors: | |
7 |
|
7 | |||
8 | * Brian Granger |
|
8 | * Brian Granger | |
9 | * Fernando Perez |
|
9 | * Fernando Perez | |
10 |
|
10 | |||
11 | Notes |
|
11 | Notes | |
12 | ----- |
|
12 | ----- | |
13 | """ |
|
13 | """ | |
14 |
|
14 | |||
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 | # Copyright (C) 2008-2009 The IPython Development Team |
|
16 | # Copyright (C) 2008-2009 The IPython Development Team | |
17 | # |
|
17 | # | |
18 | # Distributed under the terms of the BSD License. The full license is in |
|
18 | # Distributed under the terms of the BSD License. The full license is in | |
19 | # the file COPYING, distributed as part of this software. |
|
19 | # the file COPYING, distributed as part of this software. | |
20 | #----------------------------------------------------------------------------- |
|
20 | #----------------------------------------------------------------------------- | |
21 |
|
21 | |||
22 | #----------------------------------------------------------------------------- |
|
22 | #----------------------------------------------------------------------------- | |
23 | # Imports |
|
23 | # Imports | |
24 | #----------------------------------------------------------------------------- |
|
24 | #----------------------------------------------------------------------------- | |
25 |
|
25 | |||
26 | import logging |
|
26 | import logging | |
27 | import os |
|
27 | import os | |
28 | import sys |
|
28 | import sys | |
29 | import traceback |
|
29 | import traceback | |
30 | from copy import deepcopy |
|
30 | from copy import deepcopy | |
31 |
|
31 | |||
32 | from IPython.utils.genutils import get_ipython_dir, filefind |
|
32 | from IPython.utils.genutils import get_ipython_dir, filefind | |
33 | from IPython.config.loader import ( |
|
33 | from IPython.config.loader import ( | |
34 | PyFileConfigLoader, |
|
34 | PyFileConfigLoader, | |
35 | ArgParseConfigLoader, |
|
35 | ArgParseConfigLoader, | |
36 | Config, |
|
36 | Config, | |
37 | NoConfigDefault |
|
37 | NoConfigDefault | |
38 | ) |
|
38 | ) | |
39 |
|
39 | |||
40 | #----------------------------------------------------------------------------- |
|
40 | #----------------------------------------------------------------------------- | |
41 | # Classes and functions |
|
41 | # Classes and functions | |
42 | #----------------------------------------------------------------------------- |
|
42 | #----------------------------------------------------------------------------- | |
43 |
|
43 | |||
44 |
|
44 | |||
45 | class IPythonArgParseConfigLoader(ArgParseConfigLoader): |
|
45 | class IPythonArgParseConfigLoader(ArgParseConfigLoader): | |
46 | """Default command line options for IPython based applications.""" |
|
46 | """Default command line options for IPython based applications.""" | |
47 |
|
47 | |||
48 | def _add_other_arguments(self): |
|
48 | def _add_other_arguments(self): | |
49 |
self.parser.add_argument('-ipythondir', |
|
49 | self.parser.add_argument('-ipythondir', '--ipythondir', | |
|
50 | dest='Global.ipythondir',type=str, | |||
50 | help='Set to override default location of Global.ipythondir.', |
|
51 | help='Set to override default location of Global.ipythondir.', | |
51 | default=NoConfigDefault, |
|
52 | default=NoConfigDefault, | |
52 | metavar='Global.ipythondir') |
|
53 | metavar='Global.ipythondir') | |
53 |
self.parser.add_argument('-p','-profile', |
|
54 | self.parser.add_argument('-p','-profile', '--profile', | |
|
55 | dest='Global.profile',type=str, | |||
54 | help='The string name of the ipython profile to be used.', |
|
56 | help='The string name of the ipython profile to be used.', | |
55 | default=NoConfigDefault, |
|
57 | default=NoConfigDefault, | |
56 | metavar='Global.profile') |
|
58 | metavar='Global.profile') | |
57 |
self.parser.add_argument('-log_level', |
|
59 | self.parser.add_argument('-log_level', '--log-level', | |
|
60 | dest="Global.log_level",type=int, | |||
58 | help='Set the log level (0,10,20,30,40,50). Default is 30.', |
|
61 | help='Set the log level (0,10,20,30,40,50). Default is 30.', | |
59 | default=NoConfigDefault) |
|
62 | default=NoConfigDefault) | |
60 |
self.parser.add_argument('-config_file', |
|
63 | self.parser.add_argument('-config_file', '--config-file', | |
|
64 | dest='Global.config_file',type=str, | |||
61 | help='Set the config file name to override default.', |
|
65 | help='Set the config file name to override default.', | |
62 | default=NoConfigDefault, |
|
66 | default=NoConfigDefault, | |
63 | metavar='Global.config_file') |
|
67 | metavar='Global.config_file') | |
64 |
|
68 | |||
65 |
|
69 | |||
66 | class ApplicationError(Exception): |
|
70 | class ApplicationError(Exception): | |
67 | pass |
|
71 | pass | |
68 |
|
72 | |||
69 |
|
73 | |||
70 | class Application(object): |
|
74 | class Application(object): | |
71 | """Load a config, construct an app and run it. |
|
75 | """Load a config, construct an app and run it. | |
72 | """ |
|
76 | """ | |
73 |
|
77 | |||
74 | config_file_name = 'ipython_config.py' |
|
78 | config_file_name = 'ipython_config.py' | |
75 | name = 'ipython' |
|
79 | name = 'ipython' | |
76 |
|
80 | |||
77 | def __init__(self): |
|
81 | def __init__(self): | |
78 | self.init_logger() |
|
82 | self.init_logger() | |
79 | self.default_config_file_name = self.config_file_name |
|
83 | self.default_config_file_name = self.config_file_name | |
80 |
|
84 | |||
81 | def init_logger(self): |
|
85 | def init_logger(self): | |
82 | self.log = logging.getLogger(self.__class__.__name__) |
|
86 | self.log = logging.getLogger(self.__class__.__name__) | |
83 | # This is used as the default until the command line arguments are read. |
|
87 | # This is used as the default until the command line arguments are read. | |
84 | self.log.setLevel(logging.WARN) |
|
88 | self.log.setLevel(logging.WARN) | |
85 | self._log_handler = logging.StreamHandler() |
|
89 | self._log_handler = logging.StreamHandler() | |
86 | self._log_formatter = logging.Formatter("[%(name)s] %(message)s") |
|
90 | self._log_formatter = logging.Formatter("[%(name)s] %(message)s") | |
87 | self._log_handler.setFormatter(self._log_formatter) |
|
91 | self._log_handler.setFormatter(self._log_formatter) | |
88 | self.log.addHandler(self._log_handler) |
|
92 | self.log.addHandler(self._log_handler) | |
89 |
|
93 | |||
90 | def _set_log_level(self, level): |
|
94 | def _set_log_level(self, level): | |
91 | self.log.setLevel(level) |
|
95 | self.log.setLevel(level) | |
92 |
|
96 | |||
93 | def _get_log_level(self): |
|
97 | def _get_log_level(self): | |
94 | return self.log.level |
|
98 | return self.log.level | |
95 |
|
99 | |||
96 | log_level = property(_get_log_level, _set_log_level) |
|
100 | log_level = property(_get_log_level, _set_log_level) | |
97 |
|
101 | |||
98 | def start(self): |
|
102 | def start(self): | |
99 | """Start the application.""" |
|
103 | """Start the application.""" | |
100 | self.attempt(self.create_default_config) |
|
104 | self.attempt(self.create_default_config) | |
101 | self.attempt(self.pre_load_command_line_config) |
|
105 | self.attempt(self.pre_load_command_line_config) | |
102 | self.attempt(self.load_command_line_config, action='abort') |
|
106 | self.attempt(self.load_command_line_config, action='abort') | |
103 | self.attempt(self.post_load_command_line_config) |
|
107 | self.attempt(self.post_load_command_line_config) | |
104 | self.attempt(self.find_ipythondir) |
|
108 | self.attempt(self.find_ipythondir) | |
105 | self.attempt(self.find_config_file_name) |
|
109 | self.attempt(self.find_config_file_name) | |
106 | self.attempt(self.find_config_file_paths) |
|
110 | self.attempt(self.find_config_file_paths) | |
107 | self.attempt(self.pre_load_file_config) |
|
111 | self.attempt(self.pre_load_file_config) | |
108 | self.attempt(self.load_file_config) |
|
112 | self.attempt(self.load_file_config) | |
109 | self.attempt(self.post_load_file_config) |
|
113 | self.attempt(self.post_load_file_config) | |
110 | self.attempt(self.merge_configs) |
|
114 | self.attempt(self.merge_configs) | |
111 | self.attempt(self.pre_construct) |
|
115 | self.attempt(self.pre_construct) | |
112 | self.attempt(self.construct) |
|
116 | self.attempt(self.construct) | |
113 | self.attempt(self.post_construct) |
|
117 | self.attempt(self.post_construct) | |
114 | self.attempt(self.start_app) |
|
118 | self.attempt(self.start_app) | |
115 |
|
119 | |||
116 | #------------------------------------------------------------------------- |
|
120 | #------------------------------------------------------------------------- | |
117 | # Various stages of Application creation |
|
121 | # Various stages of Application creation | |
118 | #------------------------------------------------------------------------- |
|
122 | #------------------------------------------------------------------------- | |
119 |
|
123 | |||
120 | def create_default_config(self): |
|
124 | def create_default_config(self): | |
121 | """Create defaults that can't be set elsewhere. |
|
125 | """Create defaults that can't be set elsewhere. | |
122 |
|
126 | |||
123 | For the most part, we try to set default in the class attributes |
|
127 | For the most part, we try to set default in the class attributes | |
124 | of Components. But, defaults the top-level Application (which is |
|
128 | of Components. But, defaults the top-level Application (which is | |
125 | not a HasTraitlets or Component) are not set in this way. Instead |
|
129 | not a HasTraitlets or Component) are not set in this way. Instead | |
126 | we set them here. The Global section is for variables like this that |
|
130 | we set them here. The Global section is for variables like this that | |
127 | don't belong to a particular component. |
|
131 | don't belong to a particular component. | |
128 | """ |
|
132 | """ | |
129 | self.default_config = Config() |
|
133 | self.default_config = Config() | |
130 | self.default_config.Global.ipythondir = get_ipython_dir() |
|
134 | self.default_config.Global.ipythondir = get_ipython_dir() | |
131 | self.log.debug('Default config loaded:') |
|
135 | self.log.debug('Default config loaded:') | |
132 | self.log.debug(repr(self.default_config)) |
|
136 | self.log.debug(repr(self.default_config)) | |
133 |
|
137 | |||
134 | def create_command_line_config(self): |
|
138 | def create_command_line_config(self): | |
135 | """Create and return a command line config loader.""" |
|
139 | """Create and return a command line config loader.""" | |
136 | return IPythonArgParseConfigLoader(description=self.name) |
|
140 | return IPythonArgParseConfigLoader(description=self.name) | |
137 |
|
141 | |||
138 | def pre_load_command_line_config(self): |
|
142 | def pre_load_command_line_config(self): | |
139 | """Do actions just before loading the command line config.""" |
|
143 | """Do actions just before loading the command line config.""" | |
140 | pass |
|
144 | pass | |
141 |
|
145 | |||
142 | def load_command_line_config(self): |
|
146 | def load_command_line_config(self): | |
143 | """Load the command line config. |
|
147 | """Load the command line config. | |
144 |
|
148 | |||
145 | This method also sets ``self.debug``. |
|
149 | This method also sets ``self.debug``. | |
146 | """ |
|
150 | """ | |
147 |
|
151 | |||
148 | loader = self.create_command_line_config() |
|
152 | loader = self.create_command_line_config() | |
149 | self.command_line_config = loader.load_config() |
|
153 | self.command_line_config = loader.load_config() | |
150 | self.extra_args = loader.get_extra_args() |
|
154 | self.extra_args = loader.get_extra_args() | |
151 |
|
155 | |||
152 | try: |
|
156 | try: | |
153 | self.log_level = self.command_line_config.Global.log_level |
|
157 | self.log_level = self.command_line_config.Global.log_level | |
154 | except AttributeError: |
|
158 | except AttributeError: | |
155 | pass # Use existing value which is set in Application.init_logger. |
|
159 | pass # Use existing value which is set in Application.init_logger. | |
156 | self.log.debug("Command line config loaded:") |
|
160 | self.log.debug("Command line config loaded:") | |
157 | self.log.debug(repr(self.command_line_config)) |
|
161 | self.log.debug(repr(self.command_line_config)) | |
158 |
|
162 | |||
159 | def post_load_command_line_config(self): |
|
163 | def post_load_command_line_config(self): | |
160 | """Do actions just after loading the command line config.""" |
|
164 | """Do actions just after loading the command line config.""" | |
161 | pass |
|
165 | pass | |
162 |
|
166 | |||
163 | def find_ipythondir(self): |
|
167 | def find_ipythondir(self): | |
164 | """Set the IPython directory. |
|
168 | """Set the IPython directory. | |
165 |
|
169 | |||
166 | This sets ``self.ipythondir``, but the actual value that is passed |
|
170 | This sets ``self.ipythondir``, but the actual value that is passed | |
167 | to the application is kept in either ``self.default_config`` or |
|
171 | to the application is kept in either ``self.default_config`` or | |
168 | ``self.command_line_config``. This also added ``self.ipythondir`` to |
|
172 | ``self.command_line_config``. This also added ``self.ipythondir`` to | |
169 | ``sys.path`` so config files there can be references by other config |
|
173 | ``sys.path`` so config files there can be references by other config | |
170 | files. |
|
174 | files. | |
171 | """ |
|
175 | """ | |
172 |
|
176 | |||
173 | try: |
|
177 | try: | |
174 | self.ipythondir = self.command_line_config.Global.ipythondir |
|
178 | self.ipythondir = self.command_line_config.Global.ipythondir | |
175 | except AttributeError: |
|
179 | except AttributeError: | |
176 | self.ipythondir = self.default_config.Global.ipythondir |
|
180 | self.ipythondir = self.default_config.Global.ipythondir | |
177 | sys.path.append(os.path.abspath(self.ipythondir)) |
|
181 | sys.path.append(os.path.abspath(self.ipythondir)) | |
178 | if not os.path.isdir(self.ipythondir): |
|
182 | if not os.path.isdir(self.ipythondir): | |
179 | os.makedirs(self.ipythondir, mode = 0777) |
|
183 | os.makedirs(self.ipythondir, mode = 0777) | |
180 | self.log.debug("IPYTHONDIR set to: %s" % self.ipythondir) |
|
184 | self.log.debug("IPYTHONDIR set to: %s" % self.ipythondir) | |
181 |
|
185 | |||
182 | def find_config_file_name(self): |
|
186 | def find_config_file_name(self): | |
183 | """Find the config file name for this application. |
|
187 | """Find the config file name for this application. | |
184 |
|
188 | |||
185 | If a profile has been set at the command line, this will resolve |
|
189 | If a profile has been set at the command line, this will resolve | |
186 | it. The search paths for the config file are set in |
|
190 | it. The search paths for the config file are set in | |
187 | :meth:`find_config_file_paths` and then passed to the config file |
|
191 | :meth:`find_config_file_paths` and then passed to the config file | |
188 | loader where they are resolved to an absolute path. |
|
192 | loader where they are resolved to an absolute path. | |
189 | """ |
|
193 | """ | |
190 |
|
194 | |||
191 | try: |
|
195 | try: | |
192 | self.config_file_name = self.command_line_config.Global.config_file |
|
196 | self.config_file_name = self.command_line_config.Global.config_file | |
193 | except AttributeError: |
|
197 | except AttributeError: | |
194 | pass |
|
198 | pass | |
195 |
|
199 | |||
196 | try: |
|
200 | try: | |
197 | self.profile_name = self.command_line_config.Global.profile |
|
201 | self.profile_name = self.command_line_config.Global.profile | |
198 | name_parts = self.config_file_name.split('.') |
|
202 | name_parts = self.config_file_name.split('.') | |
199 | name_parts.insert(1, '_' + self.profile_name + '.') |
|
203 | name_parts.insert(1, '_' + self.profile_name + '.') | |
200 | self.config_file_name = ''.join(name_parts) |
|
204 | self.config_file_name = ''.join(name_parts) | |
201 | except AttributeError: |
|
205 | except AttributeError: | |
202 | pass |
|
206 | pass | |
203 |
|
207 | |||
204 | def find_config_file_paths(self): |
|
208 | def find_config_file_paths(self): | |
205 | """Set the search paths for resolving the config file.""" |
|
209 | """Set the search paths for resolving the config file.""" | |
206 | self.config_file_paths = (os.getcwd(), self.ipythondir) |
|
210 | self.config_file_paths = (os.getcwd(), self.ipythondir) | |
207 |
|
211 | |||
208 | def pre_load_file_config(self): |
|
212 | def pre_load_file_config(self): | |
209 | """Do actions before the config file is loaded.""" |
|
213 | """Do actions before the config file is loaded.""" | |
210 | pass |
|
214 | pass | |
211 |
|
215 | |||
212 | def load_file_config(self): |
|
216 | def load_file_config(self): | |
213 | """Load the config file. |
|
217 | """Load the config file. | |
214 |
|
218 | |||
215 | This tries to load the config file from disk. If successful, the |
|
219 | This tries to load the config file from disk. If successful, the | |
216 | ``CONFIG_FILE`` config variable is set to the resolved config file |
|
220 | ``CONFIG_FILE`` config variable is set to the resolved config file | |
217 | location. If not successful, an empty config is used. |
|
221 | location. If not successful, an empty config is used. | |
218 | """ |
|
222 | """ | |
219 | self.log.debug("Attempting to load config file: <%s>" % self.config_file_name) |
|
223 | self.log.debug("Attempting to load config file: <%s>" % self.config_file_name) | |
220 | loader = PyFileConfigLoader(self.config_file_name, |
|
224 | loader = PyFileConfigLoader(self.config_file_name, | |
221 | path=self.config_file_paths) |
|
225 | path=self.config_file_paths) | |
222 | try: |
|
226 | try: | |
223 | self.file_config = loader.load_config() |
|
227 | self.file_config = loader.load_config() | |
224 | self.file_config.Global.config_file = loader.full_filename |
|
228 | self.file_config.Global.config_file = loader.full_filename | |
225 | except IOError: |
|
229 | except IOError: | |
226 | # Only warn if the default config file was NOT being used. |
|
230 | # Only warn if the default config file was NOT being used. | |
227 | if not self.config_file_name==self.default_config_file_name: |
|
231 | if not self.config_file_name==self.default_config_file_name: | |
228 | self.log.warn("Config file not found, skipping: <%s>" % \ |
|
232 | self.log.warn("Config file not found, skipping: <%s>" % \ | |
229 | self.config_file_name, exc_info=True) |
|
233 | self.config_file_name, exc_info=True) | |
230 | self.file_config = Config() |
|
234 | self.file_config = Config() | |
231 | except: |
|
235 | except: | |
232 | self.log.warn("Error loading config file: <%s>" % \ |
|
236 | self.log.warn("Error loading config file: <%s>" % \ | |
233 | self.config_file_name, exc_info=True) |
|
237 | self.config_file_name, exc_info=True) | |
234 | self.file_config = Config() |
|
238 | self.file_config = Config() | |
235 | else: |
|
239 | else: | |
236 | self.log.debug("Config file loaded: <%s>" % loader.full_filename) |
|
240 | self.log.debug("Config file loaded: <%s>" % loader.full_filename) | |
237 | self.log.debug(repr(self.file_config)) |
|
241 | self.log.debug(repr(self.file_config)) | |
238 | # We need to keeep self.log_level updated. But we only use the value |
|
242 | # We need to keeep self.log_level updated. But we only use the value | |
239 | # of the file_config if a value was not specified at the command |
|
243 | # of the file_config if a value was not specified at the command | |
240 | # line. |
|
244 | # line. | |
241 | if not hasattr(self.command_line_config.Global, 'log_level'): |
|
245 | if not hasattr(self.command_line_config.Global, 'log_level'): | |
242 | try: |
|
246 | try: | |
243 | self.log_level = self.file_config.Global.log_level |
|
247 | self.log_level = self.file_config.Global.log_level | |
244 | except AttributeError: |
|
248 | except AttributeError: | |
245 | pass # Use existing value |
|
249 | pass # Use existing value | |
246 |
|
250 | |||
247 | def post_load_file_config(self): |
|
251 | def post_load_file_config(self): | |
248 | """Do actions after the config file is loaded.""" |
|
252 | """Do actions after the config file is loaded.""" | |
249 | pass |
|
253 | pass | |
250 |
|
254 | |||
251 | def merge_configs(self): |
|
255 | def merge_configs(self): | |
252 | """Merge the default, command line and file config objects.""" |
|
256 | """Merge the default, command line and file config objects.""" | |
253 | config = Config() |
|
257 | config = Config() | |
254 | config._merge(self.default_config) |
|
258 | config._merge(self.default_config) | |
255 | config._merge(self.file_config) |
|
259 | config._merge(self.file_config) | |
256 | config._merge(self.command_line_config) |
|
260 | config._merge(self.command_line_config) | |
257 | self.master_config = config |
|
261 | self.master_config = config | |
258 | self.log.debug("Master config created:") |
|
262 | self.log.debug("Master config created:") | |
259 | self.log.debug(repr(self.master_config)) |
|
263 | self.log.debug(repr(self.master_config)) | |
260 |
|
264 | |||
261 | def pre_construct(self): |
|
265 | def pre_construct(self): | |
262 | """Do actions after the config has been built, but before construct.""" |
|
266 | """Do actions after the config has been built, but before construct.""" | |
263 | pass |
|
267 | pass | |
264 |
|
268 | |||
265 | def construct(self): |
|
269 | def construct(self): | |
266 | """Construct the main components that make up this app.""" |
|
270 | """Construct the main components that make up this app.""" | |
267 | self.log.debug("Constructing components for application") |
|
271 | self.log.debug("Constructing components for application") | |
268 |
|
272 | |||
269 | def post_construct(self): |
|
273 | def post_construct(self): | |
270 | """Do actions after construct, but before starting the app.""" |
|
274 | """Do actions after construct, but before starting the app.""" | |
271 | pass |
|
275 | pass | |
272 |
|
276 | |||
273 | def start_app(self): |
|
277 | def start_app(self): | |
274 | """Actually start the app.""" |
|
278 | """Actually start the app.""" | |
275 | self.log.debug("Starting application") |
|
279 | self.log.debug("Starting application") | |
276 |
|
280 | |||
277 | #------------------------------------------------------------------------- |
|
281 | #------------------------------------------------------------------------- | |
278 | # Utility methods |
|
282 | # Utility methods | |
279 | #------------------------------------------------------------------------- |
|
283 | #------------------------------------------------------------------------- | |
280 |
|
284 | |||
281 | def abort(self): |
|
285 | def abort(self): | |
282 | """Abort the starting of the application.""" |
|
286 | """Abort the starting of the application.""" | |
283 | self.log.critical("Aborting application: %s" % self.name, exc_info=True) |
|
287 | self.log.critical("Aborting application: %s" % self.name, exc_info=True) | |
284 | sys.exit(1) |
|
288 | sys.exit(1) | |
285 |
|
289 | |||
286 | def exit(self): |
|
290 | def exit(self): | |
287 | self.log.critical("Aborting application: %s" % self.name) |
|
291 | self.log.critical("Aborting application: %s" % self.name) | |
288 | sys.exit(1) |
|
292 | sys.exit(1) | |
289 |
|
293 | |||
290 | def attempt(self, func, action='abort'): |
|
294 | def attempt(self, func, action='abort'): | |
291 | try: |
|
295 | try: | |
292 | func() |
|
296 | func() | |
293 | except SystemExit: |
|
297 | except SystemExit: | |
294 | self.exit() |
|
298 | self.exit() | |
295 | except: |
|
299 | except: | |
296 | if action == 'abort': |
|
300 | if action == 'abort': | |
297 | self.abort() |
|
301 | self.abort() | |
298 | elif action == 'exit': |
|
302 | elif action == 'exit': | |
299 | self.exit() |
|
303 | self.exit() | |
300 | No newline at end of file |
|
304 |
@@ -1,76 +1,76 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 | """ |
|
3 | """ | |
4 | A context manager for handling sys.displayhook. |
|
4 | A context manager for handling sys.displayhook. | |
5 |
|
5 | |||
6 | Authors: |
|
6 | Authors: | |
7 |
|
7 | |||
8 | * Robert Kern |
|
8 | * Robert Kern | |
9 | * Brian Granger |
|
9 | * Brian Granger | |
10 | """ |
|
10 | """ | |
11 |
|
11 | |||
12 | #----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 | # Copyright (C) 2008-2009 The IPython Development Team |
|
13 | # Copyright (C) 2008-2009 The IPython Development Team | |
14 | # |
|
14 | # | |
15 | # Distributed under the terms of the BSD License. The full license is in |
|
15 | # Distributed under the terms of the BSD License. The full license is in | |
16 | # the file COPYING, distributed as part of this software. |
|
16 | # the file COPYING, distributed as part of this software. | |
17 | #----------------------------------------------------------------------------- |
|
17 | #----------------------------------------------------------------------------- | |
18 |
|
18 | |||
19 | #----------------------------------------------------------------------------- |
|
19 | #----------------------------------------------------------------------------- | |
20 | # Imports |
|
20 | # Imports | |
21 | #----------------------------------------------------------------------------- |
|
21 | #----------------------------------------------------------------------------- | |
22 |
|
22 | |||
23 | import sys |
|
23 | import sys | |
24 |
|
24 | |||
25 | from IPython.core.component import Component |
|
25 | from IPython.core.component import Component | |
26 |
|
26 | |||
27 | from IPython.utils.autoattr import auto_attr |
|
27 | from IPython.utils.autoattr import auto_attr | |
28 |
|
28 | |||
29 | #----------------------------------------------------------------------------- |
|
29 | #----------------------------------------------------------------------------- | |
30 | # Classes and functions |
|
30 | # Classes and functions | |
31 | #----------------------------------------------------------------------------- |
|
31 | #----------------------------------------------------------------------------- | |
32 |
|
32 | |||
33 |
|
33 | |||
34 | class DisplayTrap(Component): |
|
34 | class DisplayTrap(Component): | |
35 | """Object to manage sys.displayhook. |
|
35 | """Object to manage sys.displayhook. | |
36 |
|
36 | |||
37 | This came from IPython.core.kernel.display_hook, but is simplified |
|
37 | This came from IPython.core.kernel.display_hook, but is simplified | |
38 | (no callbacks or formatters) until more of the core is refactored. |
|
38 | (no callbacks or formatters) until more of the core is refactored. | |
39 | """ |
|
39 | """ | |
40 |
|
40 | |||
41 | def __init__(self, parent, hook): |
|
41 | def __init__(self, parent, hook): | |
42 | super(DisplayTrap, self).__init__(parent, None, None) |
|
42 | super(DisplayTrap, self).__init__(parent, None, None) | |
43 | self.hook = hook |
|
43 | self.hook = hook | |
44 | self.old_hook = None |
|
44 | self.old_hook = None | |
45 | # We define this to track if a single BuiltinTrap is nested. |
|
45 | # We define this to track if a single BuiltinTrap is nested. | |
46 | # Only turn off the trap when the outermost call to __exit__ is made. |
|
46 | # Only turn off the trap when the outermost call to __exit__ is made. | |
47 | self._nested_level = 0 |
|
47 | self._nested_level = 0 | |
48 |
|
48 | |||
49 | @auto_attr |
|
49 | # @auto_attr | |
50 | def shell(self): |
|
50 | # def shell(self): | |
51 | return Component.get_instances( |
|
51 | # return Component.get_instances( | |
52 | root=self.root, |
|
52 | # root=self.root, | |
53 | klass='IPython.core.iplib.InteractiveShell')[0] |
|
53 | # klass='IPython.core.iplib.InteractiveShell')[0] | |
54 |
|
54 | |||
55 | def __enter__(self): |
|
55 | def __enter__(self): | |
56 | if self._nested_level == 0: |
|
56 | if self._nested_level == 0: | |
57 | self.set() |
|
57 | self.set() | |
58 | self._nested_level += 1 |
|
58 | self._nested_level += 1 | |
59 | return self |
|
59 | return self | |
60 |
|
60 | |||
61 | def __exit__(self, type, value, traceback): |
|
61 | def __exit__(self, type, value, traceback): | |
62 | if self._nested_level == 1: |
|
62 | if self._nested_level == 1: | |
63 | self.unset() |
|
63 | self.unset() | |
64 | self._nested_level -= 1 |
|
64 | self._nested_level -= 1 | |
65 | return True |
|
65 | return True | |
66 |
|
66 | |||
67 | def set(self): |
|
67 | def set(self): | |
68 | """Set the hook.""" |
|
68 | """Set the hook.""" | |
69 | if sys.displayhook is not self.hook: |
|
69 | if sys.displayhook is not self.hook: | |
70 | self.old_hook = sys.displayhook |
|
70 | self.old_hook = sys.displayhook | |
71 | sys.displayhook = self.hook |
|
71 | sys.displayhook = self.hook | |
72 |
|
72 | |||
73 | def unset(self): |
|
73 | def unset(self): | |
74 | """Unset the hook.""" |
|
74 | """Unset the hook.""" | |
75 | sys.displayhook = self.old_hook |
|
75 | sys.displayhook = self.old_hook | |
76 |
|
76 |
@@ -1,2438 +1,2438 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """ |
|
2 | """ | |
3 | Main IPython Component |
|
3 | Main IPython Component | |
4 | """ |
|
4 | """ | |
5 |
|
5 | |||
6 | #----------------------------------------------------------------------------- |
|
6 | #----------------------------------------------------------------------------- | |
7 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
7 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> | |
8 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
8 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
9 | # Copyright (C) 2008-2009 The IPython Development Team |
|
9 | # Copyright (C) 2008-2009 The IPython Development Team | |
10 | # |
|
10 | # | |
11 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | # Distributed under the terms of the BSD License. The full license is in | |
12 | # the file COPYING, distributed as part of this software. |
|
12 | # the file COPYING, distributed as part of this software. | |
13 | #----------------------------------------------------------------------------- |
|
13 | #----------------------------------------------------------------------------- | |
14 |
|
14 | |||
15 | #----------------------------------------------------------------------------- |
|
15 | #----------------------------------------------------------------------------- | |
16 | # Imports |
|
16 | # Imports | |
17 | #----------------------------------------------------------------------------- |
|
17 | #----------------------------------------------------------------------------- | |
18 |
|
18 | |||
19 | from __future__ import with_statement |
|
19 | from __future__ import with_statement | |
20 |
|
20 | |||
21 | import __builtin__ |
|
21 | import __builtin__ | |
22 | import StringIO |
|
22 | import StringIO | |
23 | import bdb |
|
23 | import bdb | |
24 | import codeop |
|
24 | import codeop | |
25 | import exceptions |
|
25 | import exceptions | |
26 | import new |
|
26 | import new | |
27 | import os |
|
27 | import os | |
28 | import re |
|
28 | import re | |
29 | import string |
|
29 | import string | |
30 | import sys |
|
30 | import sys | |
31 | import tempfile |
|
31 | import tempfile | |
32 | from contextlib import nested |
|
32 | from contextlib import nested | |
33 |
|
33 | |||
34 | from IPython.core import ultratb |
|
34 | from IPython.core import ultratb | |
35 | from IPython.core import debugger, oinspect |
|
35 | from IPython.core import debugger, oinspect | |
36 | from IPython.core import shadowns |
|
36 | from IPython.core import shadowns | |
37 | from IPython.core import history as ipcorehist |
|
37 | from IPython.core import history as ipcorehist | |
38 | from IPython.core import prefilter |
|
38 | from IPython.core import prefilter | |
39 | from IPython.core.alias import AliasManager |
|
39 | from IPython.core.alias import AliasManager | |
40 | from IPython.core.builtin_trap import BuiltinTrap |
|
40 | from IPython.core.builtin_trap import BuiltinTrap | |
41 | from IPython.core.display_trap import DisplayTrap |
|
41 | from IPython.core.display_trap import DisplayTrap | |
42 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict |
|
42 | from IPython.core.fakemodule import FakeModule, init_fakemod_dict | |
43 | from IPython.core.logger import Logger |
|
43 | from IPython.core.logger import Logger | |
44 | from IPython.core.magic import Magic |
|
44 | from IPython.core.magic import Magic | |
45 | from IPython.core.prompts import CachedOutput |
|
45 | from IPython.core.prompts import CachedOutput | |
46 | from IPython.core.prefilter import PrefilterManager |
|
46 | from IPython.core.prefilter import PrefilterManager | |
47 | from IPython.core.component import Component |
|
47 | from IPython.core.component import Component | |
48 | from IPython.core.usage import interactive_usage, default_banner |
|
48 | from IPython.core.usage import interactive_usage, default_banner | |
49 | from IPython.core.error import TryNext, UsageError |
|
49 | from IPython.core.error import TryNext, UsageError | |
50 |
|
50 | |||
51 | from IPython.utils import pickleshare |
|
51 | from IPython.utils import pickleshare | |
52 | from IPython.external.Itpl import ItplNS |
|
52 | from IPython.external.Itpl import ItplNS | |
53 | from IPython.lib.backgroundjobs import BackgroundJobManager |
|
53 | from IPython.lib.backgroundjobs import BackgroundJobManager | |
54 | from IPython.utils.ipstruct import Struct |
|
54 | from IPython.utils.ipstruct import Struct | |
55 | from IPython.utils import PyColorize |
|
55 | from IPython.utils import PyColorize | |
56 | from IPython.utils.genutils import * |
|
56 | from IPython.utils.genutils import * | |
57 | from IPython.utils.genutils import get_ipython_dir |
|
57 | from IPython.utils.genutils import get_ipython_dir | |
58 | from IPython.utils.platutils import toggle_set_term_title, set_term_title |
|
58 | from IPython.utils.platutils import toggle_set_term_title, set_term_title | |
59 | from IPython.utils.strdispatch import StrDispatch |
|
59 | from IPython.utils.strdispatch import StrDispatch | |
60 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
60 | from IPython.utils.syspathcontext import prepended_to_syspath | |
61 |
|
61 | |||
62 | # from IPython.utils import growl |
|
62 | # from IPython.utils import growl | |
63 | # growl.start("IPython") |
|
63 | # growl.start("IPython") | |
64 |
|
64 | |||
65 | from IPython.utils.traitlets import ( |
|
65 | from IPython.utils.traitlets import ( | |
66 | Int, Str, CBool, CaselessStrEnum, Enum, List, Unicode |
|
66 | Int, Str, CBool, CaselessStrEnum, Enum, List, Unicode | |
67 | ) |
|
67 | ) | |
68 |
|
68 | |||
69 | #----------------------------------------------------------------------------- |
|
69 | #----------------------------------------------------------------------------- | |
70 | # Globals |
|
70 | # Globals | |
71 | #----------------------------------------------------------------------------- |
|
71 | #----------------------------------------------------------------------------- | |
72 |
|
72 | |||
73 |
|
73 | |||
74 | # store the builtin raw_input globally, and use this always, in case user code |
|
74 | # store the builtin raw_input globally, and use this always, in case user code | |
75 | # overwrites it (like wx.py.PyShell does) |
|
75 | # overwrites it (like wx.py.PyShell does) | |
76 | raw_input_original = raw_input |
|
76 | raw_input_original = raw_input | |
77 |
|
77 | |||
78 | # compiled regexps for autoindent management |
|
78 | # compiled regexps for autoindent management | |
79 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
79 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
80 |
|
80 | |||
81 |
|
81 | |||
82 | #----------------------------------------------------------------------------- |
|
82 | #----------------------------------------------------------------------------- | |
83 | # Utilities |
|
83 | # Utilities | |
84 | #----------------------------------------------------------------------------- |
|
84 | #----------------------------------------------------------------------------- | |
85 |
|
85 | |||
86 |
|
86 | |||
87 | ini_spaces_re = re.compile(r'^(\s+)') |
|
87 | ini_spaces_re = re.compile(r'^(\s+)') | |
88 |
|
88 | |||
89 |
|
89 | |||
90 | def num_ini_spaces(strng): |
|
90 | def num_ini_spaces(strng): | |
91 | """Return the number of initial spaces in a string""" |
|
91 | """Return the number of initial spaces in a string""" | |
92 |
|
92 | |||
93 | ini_spaces = ini_spaces_re.match(strng) |
|
93 | ini_spaces = ini_spaces_re.match(strng) | |
94 | if ini_spaces: |
|
94 | if ini_spaces: | |
95 | return ini_spaces.end() |
|
95 | return ini_spaces.end() | |
96 | else: |
|
96 | else: | |
97 | return 0 |
|
97 | return 0 | |
98 |
|
98 | |||
99 |
|
99 | |||
100 | def softspace(file, newvalue): |
|
100 | def softspace(file, newvalue): | |
101 | """Copied from code.py, to remove the dependency""" |
|
101 | """Copied from code.py, to remove the dependency""" | |
102 |
|
102 | |||
103 | oldvalue = 0 |
|
103 | oldvalue = 0 | |
104 | try: |
|
104 | try: | |
105 | oldvalue = file.softspace |
|
105 | oldvalue = file.softspace | |
106 | except AttributeError: |
|
106 | except AttributeError: | |
107 | pass |
|
107 | pass | |
108 | try: |
|
108 | try: | |
109 | file.softspace = newvalue |
|
109 | file.softspace = newvalue | |
110 | except (AttributeError, TypeError): |
|
110 | except (AttributeError, TypeError): | |
111 | # "attribute-less object" or "read-only attributes" |
|
111 | # "attribute-less object" or "read-only attributes" | |
112 | pass |
|
112 | pass | |
113 | return oldvalue |
|
113 | return oldvalue | |
114 |
|
114 | |||
115 |
|
115 | |||
116 | class SpaceInInput(exceptions.Exception): pass |
|
116 | class SpaceInInput(exceptions.Exception): pass | |
117 |
|
117 | |||
118 | class Bunch: pass |
|
118 | class Bunch: pass | |
119 |
|
119 | |||
120 | class InputList(list): |
|
120 | class InputList(list): | |
121 | """Class to store user input. |
|
121 | """Class to store user input. | |
122 |
|
122 | |||
123 | It's basically a list, but slices return a string instead of a list, thus |
|
123 | It's basically a list, but slices return a string instead of a list, thus | |
124 | allowing things like (assuming 'In' is an instance): |
|
124 | allowing things like (assuming 'In' is an instance): | |
125 |
|
125 | |||
126 | exec In[4:7] |
|
126 | exec In[4:7] | |
127 |
|
127 | |||
128 | or |
|
128 | or | |
129 |
|
129 | |||
130 | exec In[5:9] + In[14] + In[21:25]""" |
|
130 | exec In[5:9] + In[14] + In[21:25]""" | |
131 |
|
131 | |||
132 | def __getslice__(self,i,j): |
|
132 | def __getslice__(self,i,j): | |
133 | return ''.join(list.__getslice__(self,i,j)) |
|
133 | return ''.join(list.__getslice__(self,i,j)) | |
134 |
|
134 | |||
135 |
|
135 | |||
136 | class SyntaxTB(ultratb.ListTB): |
|
136 | class SyntaxTB(ultratb.ListTB): | |
137 | """Extension which holds some state: the last exception value""" |
|
137 | """Extension which holds some state: the last exception value""" | |
138 |
|
138 | |||
139 | def __init__(self,color_scheme = 'NoColor'): |
|
139 | def __init__(self,color_scheme = 'NoColor'): | |
140 | ultratb.ListTB.__init__(self,color_scheme) |
|
140 | ultratb.ListTB.__init__(self,color_scheme) | |
141 | self.last_syntax_error = None |
|
141 | self.last_syntax_error = None | |
142 |
|
142 | |||
143 | def __call__(self, etype, value, elist): |
|
143 | def __call__(self, etype, value, elist): | |
144 | self.last_syntax_error = value |
|
144 | self.last_syntax_error = value | |
145 | ultratb.ListTB.__call__(self,etype,value,elist) |
|
145 | ultratb.ListTB.__call__(self,etype,value,elist) | |
146 |
|
146 | |||
147 | def clear_err_state(self): |
|
147 | def clear_err_state(self): | |
148 | """Return the current error state and clear it""" |
|
148 | """Return the current error state and clear it""" | |
149 | e = self.last_syntax_error |
|
149 | e = self.last_syntax_error | |
150 | self.last_syntax_error = None |
|
150 | self.last_syntax_error = None | |
151 | return e |
|
151 | return e | |
152 |
|
152 | |||
153 |
|
153 | |||
154 | def get_default_editor(): |
|
154 | def get_default_editor(): | |
155 | try: |
|
155 | try: | |
156 | ed = os.environ['EDITOR'] |
|
156 | ed = os.environ['EDITOR'] | |
157 | except KeyError: |
|
157 | except KeyError: | |
158 | if os.name == 'posix': |
|
158 | if os.name == 'posix': | |
159 | ed = 'vi' # the only one guaranteed to be there! |
|
159 | ed = 'vi' # the only one guaranteed to be there! | |
160 | else: |
|
160 | else: | |
161 | ed = 'notepad' # same in Windows! |
|
161 | ed = 'notepad' # same in Windows! | |
162 | return ed |
|
162 | return ed | |
163 |
|
163 | |||
164 |
|
164 | |||
165 | class SeparateStr(Str): |
|
165 | class SeparateStr(Str): | |
166 | """A Str subclass to validate separate_in, separate_out, etc. |
|
166 | """A Str subclass to validate separate_in, separate_out, etc. | |
167 |
|
167 | |||
168 | This is a Str based traitlet that converts '0'->'' and '\\n'->'\n'. |
|
168 | This is a Str based traitlet that converts '0'->'' and '\\n'->'\n'. | |
169 | """ |
|
169 | """ | |
170 |
|
170 | |||
171 | def validate(self, obj, value): |
|
171 | def validate(self, obj, value): | |
172 | if value == '0': value = '' |
|
172 | if value == '0': value = '' | |
173 | value = value.replace('\\n','\n') |
|
173 | value = value.replace('\\n','\n') | |
174 | return super(SeparateStr, self).validate(obj, value) |
|
174 | return super(SeparateStr, self).validate(obj, value) | |
175 |
|
175 | |||
176 |
|
176 | |||
177 | #----------------------------------------------------------------------------- |
|
177 | #----------------------------------------------------------------------------- | |
178 | # Main IPython class |
|
178 | # Main IPython class | |
179 | #----------------------------------------------------------------------------- |
|
179 | #----------------------------------------------------------------------------- | |
180 |
|
180 | |||
181 |
|
181 | |||
182 | class InteractiveShell(Component, Magic): |
|
182 | class InteractiveShell(Component, Magic): | |
183 | """An enhanced, interactive shell for Python.""" |
|
183 | """An enhanced, interactive shell for Python.""" | |
184 |
|
184 | |||
185 | autocall = Enum((0,1,2), config=True) |
|
185 | autocall = Enum((0,1,2), config=True) | |
186 | autoedit_syntax = CBool(False, config=True) |
|
186 | autoedit_syntax = CBool(False, config=True) | |
187 | autoindent = CBool(True, config=True) |
|
187 | autoindent = CBool(True, config=True) | |
188 | automagic = CBool(True, config=True) |
|
188 | automagic = CBool(True, config=True) | |
189 | banner = Str('') |
|
189 | banner = Str('') | |
190 | banner1 = Str(default_banner, config=True) |
|
190 | banner1 = Str(default_banner, config=True) | |
191 | banner2 = Str('', config=True) |
|
191 | banner2 = Str('', config=True) | |
192 | cache_size = Int(1000, config=True) |
|
192 | cache_size = Int(1000, config=True) | |
193 | color_info = CBool(True, config=True) |
|
193 | color_info = CBool(True, config=True) | |
194 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
194 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
195 | default_value='LightBG', config=True) |
|
195 | default_value='LightBG', config=True) | |
196 | confirm_exit = CBool(True, config=True) |
|
196 | confirm_exit = CBool(True, config=True) | |
197 | debug = CBool(False, config=True) |
|
197 | debug = CBool(False, config=True) | |
198 | deep_reload = CBool(False, config=True) |
|
198 | deep_reload = CBool(False, config=True) | |
199 | # This display_banner only controls whether or not self.show_banner() |
|
199 | # This display_banner only controls whether or not self.show_banner() | |
200 | # is called when mainloop/interact are called. The default is False |
|
200 | # is called when mainloop/interact are called. The default is False | |
201 | # because for the terminal based application, the banner behavior |
|
201 | # because for the terminal based application, the banner behavior | |
202 | # is controlled by Global.display_banner, which IPythonApp looks at |
|
202 | # is controlled by Global.display_banner, which IPythonApp looks at | |
203 | # to determine if *it* should call show_banner() by hand or not. |
|
203 | # to determine if *it* should call show_banner() by hand or not. | |
204 | display_banner = CBool(False) # This isn't configurable! |
|
204 | display_banner = CBool(False) # This isn't configurable! | |
205 | embedded = CBool(False) |
|
205 | embedded = CBool(False) | |
206 | embedded_active = CBool(False) |
|
206 | embedded_active = CBool(False) | |
207 | editor = Str(get_default_editor(), config=True) |
|
207 | editor = Str(get_default_editor(), config=True) | |
208 | filename = Str("<ipython console>") |
|
208 | filename = Str("<ipython console>") | |
209 | ipythondir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
209 | ipythondir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
210 | logstart = CBool(False, config=True) |
|
210 | logstart = CBool(False, config=True) | |
211 | logfile = Str('', config=True) |
|
211 | logfile = Str('', config=True) | |
212 | logappend = Str('', config=True) |
|
212 | logappend = Str('', config=True) | |
213 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
213 | object_info_string_level = Enum((0,1,2), default_value=0, | |
214 | config=True) |
|
214 | config=True) | |
215 | pager = Str('less', config=True) |
|
215 | pager = Str('less', config=True) | |
216 | pdb = CBool(False, config=True) |
|
216 | pdb = CBool(False, config=True) | |
217 | pprint = CBool(True, config=True) |
|
217 | pprint = CBool(True, config=True) | |
218 | profile = Str('', config=True) |
|
218 | profile = Str('', config=True) | |
219 | prompt_in1 = Str('In [\\#]: ', config=True) |
|
219 | prompt_in1 = Str('In [\\#]: ', config=True) | |
220 | prompt_in2 = Str(' .\\D.: ', config=True) |
|
220 | prompt_in2 = Str(' .\\D.: ', config=True) | |
221 | prompt_out = Str('Out[\\#]: ', config=True) |
|
221 | prompt_out = Str('Out[\\#]: ', config=True) | |
222 | prompts_pad_left = CBool(True, config=True) |
|
222 | prompts_pad_left = CBool(True, config=True) | |
223 | quiet = CBool(False, config=True) |
|
223 | quiet = CBool(False, config=True) | |
224 |
|
224 | |||
225 | readline_use = CBool(True, config=True) |
|
225 | readline_use = CBool(True, config=True) | |
226 | readline_merge_completions = CBool(True, config=True) |
|
226 | readline_merge_completions = CBool(True, config=True) | |
227 | readline_omit__names = Enum((0,1,2), default_value=0, config=True) |
|
227 | readline_omit__names = Enum((0,1,2), default_value=0, config=True) | |
228 | readline_remove_delims = Str('-/~', config=True) |
|
228 | readline_remove_delims = Str('-/~', config=True) | |
229 | readline_parse_and_bind = List([ |
|
229 | readline_parse_and_bind = List([ | |
230 | 'tab: complete', |
|
230 | 'tab: complete', | |
231 | '"\C-l": possible-completions', |
|
231 | '"\C-l": possible-completions', | |
232 | 'set show-all-if-ambiguous on', |
|
232 | 'set show-all-if-ambiguous on', | |
233 | '"\C-o": tab-insert', |
|
233 | '"\C-o": tab-insert', | |
234 | '"\M-i": " "', |
|
234 | '"\M-i": " "', | |
235 | '"\M-o": "\d\d\d\d"', |
|
235 | '"\M-o": "\d\d\d\d"', | |
236 | '"\M-I": "\d\d\d\d"', |
|
236 | '"\M-I": "\d\d\d\d"', | |
237 | '"\C-r": reverse-search-history', |
|
237 | '"\C-r": reverse-search-history', | |
238 | '"\C-s": forward-search-history', |
|
238 | '"\C-s": forward-search-history', | |
239 | '"\C-p": history-search-backward', |
|
239 | '"\C-p": history-search-backward', | |
240 | '"\C-n": history-search-forward', |
|
240 | '"\C-n": history-search-forward', | |
241 | '"\e[A": history-search-backward', |
|
241 | '"\e[A": history-search-backward', | |
242 | '"\e[B": history-search-forward', |
|
242 | '"\e[B": history-search-forward', | |
243 | '"\C-k": kill-line', |
|
243 | '"\C-k": kill-line', | |
244 | '"\C-u": unix-line-discard', |
|
244 | '"\C-u": unix-line-discard', | |
245 | ], allow_none=False, config=True) |
|
245 | ], allow_none=False, config=True) | |
246 |
|
246 | |||
247 | screen_length = Int(0, config=True) |
|
247 | screen_length = Int(0, config=True) | |
248 |
|
248 | |||
249 | # Use custom TraitletTypes that convert '0'->'' and '\\n'->'\n' |
|
249 | # Use custom TraitletTypes that convert '0'->'' and '\\n'->'\n' | |
250 | separate_in = SeparateStr('\n', config=True) |
|
250 | separate_in = SeparateStr('\n', config=True) | |
251 | separate_out = SeparateStr('', config=True) |
|
251 | separate_out = SeparateStr('', config=True) | |
252 | separate_out2 = SeparateStr('', config=True) |
|
252 | separate_out2 = SeparateStr('', config=True) | |
253 |
|
253 | |||
254 | system_header = Str('IPython system call: ', config=True) |
|
254 | system_header = Str('IPython system call: ', config=True) | |
255 | system_verbose = CBool(False, config=True) |
|
255 | system_verbose = CBool(False, config=True) | |
256 | term_title = CBool(False, config=True) |
|
256 | term_title = CBool(False, config=True) | |
257 | wildcards_case_sensitive = CBool(True, config=True) |
|
257 | wildcards_case_sensitive = CBool(True, config=True) | |
258 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
258 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
259 | default_value='Context', config=True) |
|
259 | default_value='Context', config=True) | |
260 |
|
260 | |||
261 | autoexec = List(allow_none=False) |
|
261 | autoexec = List(allow_none=False) | |
262 |
|
262 | |||
263 | # class attribute to indicate whether the class supports threads or not. |
|
263 | # class attribute to indicate whether the class supports threads or not. | |
264 | # Subclasses with thread support should override this as needed. |
|
264 | # Subclasses with thread support should override this as needed. | |
265 | isthreaded = False |
|
265 | isthreaded = False | |
266 |
|
266 | |||
267 | def __init__(self, parent=None, config=None, ipythondir=None, usage=None, |
|
267 | def __init__(self, parent=None, config=None, ipythondir=None, usage=None, | |
268 | user_ns=None, user_global_ns=None, |
|
268 | user_ns=None, user_global_ns=None, | |
269 | banner1=None, banner2=None, display_banner=None, |
|
269 | banner1=None, banner2=None, display_banner=None, | |
270 | custom_exceptions=((),None)): |
|
270 | custom_exceptions=((),None)): | |
271 |
|
271 | |||
272 | # This is where traitlets with a config_key argument are updated |
|
272 | # This is where traitlets with a config_key argument are updated | |
273 | # from the values on config. |
|
273 | # from the values on config. | |
274 | super(InteractiveShell, self).__init__(parent, config=config) |
|
274 | super(InteractiveShell, self).__init__(parent, config=config) | |
275 |
|
275 | |||
276 | # These are relatively independent and stateless |
|
276 | # These are relatively independent and stateless | |
277 | self.init_ipythondir(ipythondir) |
|
277 | self.init_ipythondir(ipythondir) | |
278 | self.init_instance_attrs() |
|
278 | self.init_instance_attrs() | |
279 | self.init_term_title() |
|
279 | self.init_term_title() | |
280 | self.init_usage(usage) |
|
280 | self.init_usage(usage) | |
281 | self.init_banner(banner1, banner2, display_banner) |
|
281 | self.init_banner(banner1, banner2, display_banner) | |
282 |
|
282 | |||
283 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
283 | # Create namespaces (user_ns, user_global_ns, etc.) | |
284 | self.init_create_namespaces(user_ns, user_global_ns) |
|
284 | self.init_create_namespaces(user_ns, user_global_ns) | |
285 | # This has to be done after init_create_namespaces because it uses |
|
285 | # This has to be done after init_create_namespaces because it uses | |
286 | # something in self.user_ns, but before init_sys_modules, which |
|
286 | # something in self.user_ns, but before init_sys_modules, which | |
287 | # is the first thing to modify sys. |
|
287 | # is the first thing to modify sys. | |
288 | self.save_sys_module_state() |
|
288 | self.save_sys_module_state() | |
289 | self.init_sys_modules() |
|
289 | self.init_sys_modules() | |
290 |
|
290 | |||
291 | self.init_history() |
|
291 | self.init_history() | |
292 | self.init_encoding() |
|
292 | self.init_encoding() | |
293 | self.init_prefilter() |
|
293 | self.init_prefilter() | |
294 |
|
294 | |||
295 | Magic.__init__(self, self) |
|
295 | Magic.__init__(self, self) | |
296 |
|
296 | |||
297 | self.init_syntax_highlighting() |
|
297 | self.init_syntax_highlighting() | |
298 | self.init_hooks() |
|
298 | self.init_hooks() | |
299 | self.init_pushd_popd_magic() |
|
299 | self.init_pushd_popd_magic() | |
300 | self.init_traceback_handlers(custom_exceptions) |
|
300 | self.init_traceback_handlers(custom_exceptions) | |
301 | self.init_user_ns() |
|
301 | self.init_user_ns() | |
302 | self.init_logger() |
|
302 | self.init_logger() | |
303 | self.init_alias() |
|
303 | self.init_alias() | |
304 | self.init_builtins() |
|
304 | self.init_builtins() | |
305 |
|
305 | |||
306 | # pre_config_initialization |
|
306 | # pre_config_initialization | |
307 | self.init_shadow_hist() |
|
307 | self.init_shadow_hist() | |
308 |
|
308 | |||
309 | # The next section should contain averything that was in ipmaker. |
|
309 | # The next section should contain averything that was in ipmaker. | |
310 | self.init_logstart() |
|
310 | self.init_logstart() | |
311 |
|
311 | |||
312 | # The following was in post_config_initialization |
|
312 | # The following was in post_config_initialization | |
313 | self.init_inspector() |
|
313 | self.init_inspector() | |
314 | self.init_readline() |
|
314 | self.init_readline() | |
315 | self.init_prompts() |
|
315 | self.init_prompts() | |
316 | self.init_displayhook() |
|
316 | self.init_displayhook() | |
317 | self.init_reload_doctest() |
|
317 | self.init_reload_doctest() | |
318 | self.init_magics() |
|
318 | self.init_magics() | |
319 | self.init_pdb() |
|
319 | self.init_pdb() | |
320 | self.hooks.late_startup_hook() |
|
320 | self.hooks.late_startup_hook() | |
321 |
|
321 | |||
322 | def get_ipython(self): |
|
322 | def get_ipython(self): | |
323 | return self |
|
323 | return self | |
324 |
|
324 | |||
325 | #------------------------------------------------------------------------- |
|
325 | #------------------------------------------------------------------------- | |
326 | # Traitlet changed handlers |
|
326 | # Traitlet changed handlers | |
327 | #------------------------------------------------------------------------- |
|
327 | #------------------------------------------------------------------------- | |
328 |
|
328 | |||
329 | def _banner1_changed(self): |
|
329 | def _banner1_changed(self): | |
330 | self.compute_banner() |
|
330 | self.compute_banner() | |
331 |
|
331 | |||
332 | def _banner2_changed(self): |
|
332 | def _banner2_changed(self): | |
333 | self.compute_banner() |
|
333 | self.compute_banner() | |
334 |
|
334 | |||
335 | def _ipythondir_changed(self, name, new): |
|
335 | def _ipythondir_changed(self, name, new): | |
336 | if not os.path.isdir(new): |
|
336 | if not os.path.isdir(new): | |
337 | os.makedirs(new, mode = 0777) |
|
337 | os.makedirs(new, mode = 0777) | |
338 | if not os.path.isdir(self.ipython_extension_dir): |
|
338 | if not os.path.isdir(self.ipython_extension_dir): | |
339 | os.makedirs(self.ipython_extension_dir, mode = 0777) |
|
339 | os.makedirs(self.ipython_extension_dir, mode = 0777) | |
340 |
|
340 | |||
341 | @property |
|
341 | @property | |
342 | def ipython_extension_dir(self): |
|
342 | def ipython_extension_dir(self): | |
343 | return os.path.join(self.ipythondir, 'extensions') |
|
343 | return os.path.join(self.ipythondir, 'extensions') | |
344 |
|
344 | |||
345 | @property |
|
345 | @property | |
346 | def usable_screen_length(self): |
|
346 | def usable_screen_length(self): | |
347 | if self.screen_length == 0: |
|
347 | if self.screen_length == 0: | |
348 | return 0 |
|
348 | return 0 | |
349 | else: |
|
349 | else: | |
350 | num_lines_bot = self.separate_in.count('\n')+1 |
|
350 | num_lines_bot = self.separate_in.count('\n')+1 | |
351 | return self.screen_length - num_lines_bot |
|
351 | return self.screen_length - num_lines_bot | |
352 |
|
352 | |||
353 | def _term_title_changed(self, name, new_value): |
|
353 | def _term_title_changed(self, name, new_value): | |
354 | self.init_term_title() |
|
354 | self.init_term_title() | |
355 |
|
355 | |||
356 | def set_autoindent(self,value=None): |
|
356 | def set_autoindent(self,value=None): | |
357 | """Set the autoindent flag, checking for readline support. |
|
357 | """Set the autoindent flag, checking for readline support. | |
358 |
|
358 | |||
359 | If called with no arguments, it acts as a toggle.""" |
|
359 | If called with no arguments, it acts as a toggle.""" | |
360 |
|
360 | |||
361 | if not self.has_readline: |
|
361 | if not self.has_readline: | |
362 | if os.name == 'posix': |
|
362 | if os.name == 'posix': | |
363 | warn("The auto-indent feature requires the readline library") |
|
363 | warn("The auto-indent feature requires the readline library") | |
364 | self.autoindent = 0 |
|
364 | self.autoindent = 0 | |
365 | return |
|
365 | return | |
366 | if value is None: |
|
366 | if value is None: | |
367 | self.autoindent = not self.autoindent |
|
367 | self.autoindent = not self.autoindent | |
368 | else: |
|
368 | else: | |
369 | self.autoindent = value |
|
369 | self.autoindent = value | |
370 |
|
370 | |||
371 | #------------------------------------------------------------------------- |
|
371 | #------------------------------------------------------------------------- | |
372 | # init_* methods called by __init__ |
|
372 | # init_* methods called by __init__ | |
373 | #------------------------------------------------------------------------- |
|
373 | #------------------------------------------------------------------------- | |
374 |
|
374 | |||
375 | def init_ipythondir(self, ipythondir): |
|
375 | def init_ipythondir(self, ipythondir): | |
376 | if ipythondir is not None: |
|
376 | if ipythondir is not None: | |
377 | self.ipythondir = ipythondir |
|
377 | self.ipythondir = ipythondir | |
378 | self.config.Global.ipythondir = self.ipythondir |
|
378 | self.config.Global.ipythondir = self.ipythondir | |
379 | return |
|
379 | return | |
380 |
|
380 | |||
381 | if hasattr(self.config.Global, 'ipythondir'): |
|
381 | if hasattr(self.config.Global, 'ipythondir'): | |
382 | self.ipythondir = self.config.Global.ipythondir |
|
382 | self.ipythondir = self.config.Global.ipythondir | |
383 | else: |
|
383 | else: | |
384 | self.ipythondir = get_ipython_dir() |
|
384 | self.ipythondir = get_ipython_dir() | |
385 |
|
385 | |||
386 | # All children can just read this |
|
386 | # All children can just read this | |
387 | self.config.Global.ipythondir = self.ipythondir |
|
387 | self.config.Global.ipythondir = self.ipythondir | |
388 |
|
388 | |||
389 | def init_instance_attrs(self): |
|
389 | def init_instance_attrs(self): | |
390 | self.jobs = BackgroundJobManager() |
|
390 | self.jobs = BackgroundJobManager() | |
391 | self.more = False |
|
391 | self.more = False | |
392 |
|
392 | |||
393 | # command compiler |
|
393 | # command compiler | |
394 | self.compile = codeop.CommandCompiler() |
|
394 | self.compile = codeop.CommandCompiler() | |
395 |
|
395 | |||
396 | # User input buffer |
|
396 | # User input buffer | |
397 | self.buffer = [] |
|
397 | self.buffer = [] | |
398 |
|
398 | |||
399 | # Make an empty namespace, which extension writers can rely on both |
|
399 | # Make an empty namespace, which extension writers can rely on both | |
400 | # existing and NEVER being used by ipython itself. This gives them a |
|
400 | # existing and NEVER being used by ipython itself. This gives them a | |
401 | # convenient location for storing additional information and state |
|
401 | # convenient location for storing additional information and state | |
402 | # their extensions may require, without fear of collisions with other |
|
402 | # their extensions may require, without fear of collisions with other | |
403 | # ipython names that may develop later. |
|
403 | # ipython names that may develop later. | |
404 | self.meta = Struct() |
|
404 | self.meta = Struct() | |
405 |
|
405 | |||
406 | # Object variable to store code object waiting execution. This is |
|
406 | # Object variable to store code object waiting execution. This is | |
407 | # used mainly by the multithreaded shells, but it can come in handy in |
|
407 | # used mainly by the multithreaded shells, but it can come in handy in | |
408 | # other situations. No need to use a Queue here, since it's a single |
|
408 | # other situations. No need to use a Queue here, since it's a single | |
409 | # item which gets cleared once run. |
|
409 | # item which gets cleared once run. | |
410 | self.code_to_run = None |
|
410 | self.code_to_run = None | |
411 |
|
411 | |||
412 | # Flag to mark unconditional exit |
|
412 | # Flag to mark unconditional exit | |
413 | self.exit_now = False |
|
413 | self.exit_now = False | |
414 |
|
414 | |||
415 | # Temporary files used for various purposes. Deleted at exit. |
|
415 | # Temporary files used for various purposes. Deleted at exit. | |
416 | self.tempfiles = [] |
|
416 | self.tempfiles = [] | |
417 |
|
417 | |||
418 | # Keep track of readline usage (later set by init_readline) |
|
418 | # Keep track of readline usage (later set by init_readline) | |
419 | self.has_readline = False |
|
419 | self.has_readline = False | |
420 |
|
420 | |||
421 | # keep track of where we started running (mainly for crash post-mortem) |
|
421 | # keep track of where we started running (mainly for crash post-mortem) | |
422 | # This is not being used anywhere currently. |
|
422 | # This is not being used anywhere currently. | |
423 | self.starting_dir = os.getcwd() |
|
423 | self.starting_dir = os.getcwd() | |
424 |
|
424 | |||
425 | # Indentation management |
|
425 | # Indentation management | |
426 | self.indent_current_nsp = 0 |
|
426 | self.indent_current_nsp = 0 | |
427 |
|
427 | |||
428 | def init_term_title(self): |
|
428 | def init_term_title(self): | |
429 | # Enable or disable the terminal title. |
|
429 | # Enable or disable the terminal title. | |
430 | if self.term_title: |
|
430 | if self.term_title: | |
431 | toggle_set_term_title(True) |
|
431 | toggle_set_term_title(True) | |
432 | set_term_title('IPython: ' + abbrev_cwd()) |
|
432 | set_term_title('IPython: ' + abbrev_cwd()) | |
433 | else: |
|
433 | else: | |
434 | toggle_set_term_title(False) |
|
434 | toggle_set_term_title(False) | |
435 |
|
435 | |||
436 | def init_usage(self, usage=None): |
|
436 | def init_usage(self, usage=None): | |
437 | if usage is None: |
|
437 | if usage is None: | |
438 | self.usage = interactive_usage |
|
438 | self.usage = interactive_usage | |
439 | else: |
|
439 | else: | |
440 | self.usage = usage |
|
440 | self.usage = usage | |
441 |
|
441 | |||
442 | def init_encoding(self): |
|
442 | def init_encoding(self): | |
443 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
443 | # Get system encoding at startup time. Certain terminals (like Emacs | |
444 | # under Win32 have it set to None, and we need to have a known valid |
|
444 | # under Win32 have it set to None, and we need to have a known valid | |
445 | # encoding to use in the raw_input() method |
|
445 | # encoding to use in the raw_input() method | |
446 | try: |
|
446 | try: | |
447 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
447 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
448 | except AttributeError: |
|
448 | except AttributeError: | |
449 | self.stdin_encoding = 'ascii' |
|
449 | self.stdin_encoding = 'ascii' | |
450 |
|
450 | |||
451 | def init_syntax_highlighting(self): |
|
451 | def init_syntax_highlighting(self): | |
452 | # Python source parser/formatter for syntax highlighting |
|
452 | # Python source parser/formatter for syntax highlighting | |
453 | pyformat = PyColorize.Parser().format |
|
453 | pyformat = PyColorize.Parser().format | |
454 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
454 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
455 |
|
455 | |||
456 | def init_pushd_popd_magic(self): |
|
456 | def init_pushd_popd_magic(self): | |
457 | # for pushd/popd management |
|
457 | # for pushd/popd management | |
458 | try: |
|
458 | try: | |
459 | self.home_dir = get_home_dir() |
|
459 | self.home_dir = get_home_dir() | |
460 | except HomeDirError, msg: |
|
460 | except HomeDirError, msg: | |
461 | fatal(msg) |
|
461 | fatal(msg) | |
462 |
|
462 | |||
463 | self.dir_stack = [] |
|
463 | self.dir_stack = [] | |
464 |
|
464 | |||
465 | def init_logger(self): |
|
465 | def init_logger(self): | |
466 | self.logger = Logger(self, logfname='ipython_log.py', logmode='rotate') |
|
466 | self.logger = Logger(self, logfname='ipython_log.py', logmode='rotate') | |
467 | # local shortcut, this is used a LOT |
|
467 | # local shortcut, this is used a LOT | |
468 | self.log = self.logger.log |
|
468 | self.log = self.logger.log | |
469 |
|
469 | |||
470 | def init_logstart(self): |
|
470 | def init_logstart(self): | |
471 | if self.logappend: |
|
471 | if self.logappend: | |
472 | self.magic_logstart(self.logappend + ' append') |
|
472 | self.magic_logstart(self.logappend + ' append') | |
473 | elif self.logfile: |
|
473 | elif self.logfile: | |
474 | self.magic_logstart(self.logfile) |
|
474 | self.magic_logstart(self.logfile) | |
475 | elif self.logstart: |
|
475 | elif self.logstart: | |
476 | self.magic_logstart() |
|
476 | self.magic_logstart() | |
477 |
|
477 | |||
478 | def init_builtins(self): |
|
478 | def init_builtins(self): | |
479 | self.builtin_trap = BuiltinTrap(self) |
|
479 | self.builtin_trap = BuiltinTrap(self) | |
480 |
|
480 | |||
481 | def init_inspector(self): |
|
481 | def init_inspector(self): | |
482 | # Object inspector |
|
482 | # Object inspector | |
483 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
483 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
484 | PyColorize.ANSICodeColors, |
|
484 | PyColorize.ANSICodeColors, | |
485 | 'NoColor', |
|
485 | 'NoColor', | |
486 | self.object_info_string_level) |
|
486 | self.object_info_string_level) | |
487 |
|
487 | |||
488 | def init_prompts(self): |
|
488 | def init_prompts(self): | |
489 | # Initialize cache, set in/out prompts and printing system |
|
489 | # Initialize cache, set in/out prompts and printing system | |
490 | self.outputcache = CachedOutput(self, |
|
490 | self.outputcache = CachedOutput(self, | |
491 | self.cache_size, |
|
491 | self.cache_size, | |
492 | self.pprint, |
|
492 | self.pprint, | |
493 | input_sep = self.separate_in, |
|
493 | input_sep = self.separate_in, | |
494 | output_sep = self.separate_out, |
|
494 | output_sep = self.separate_out, | |
495 | output_sep2 = self.separate_out2, |
|
495 | output_sep2 = self.separate_out2, | |
496 | ps1 = self.prompt_in1, |
|
496 | ps1 = self.prompt_in1, | |
497 | ps2 = self.prompt_in2, |
|
497 | ps2 = self.prompt_in2, | |
498 | ps_out = self.prompt_out, |
|
498 | ps_out = self.prompt_out, | |
499 | pad_left = self.prompts_pad_left) |
|
499 | pad_left = self.prompts_pad_left) | |
500 |
|
500 | |||
501 | # user may have over-ridden the default print hook: |
|
501 | # user may have over-ridden the default print hook: | |
502 | try: |
|
502 | try: | |
503 | self.outputcache.__class__.display = self.hooks.display |
|
503 | self.outputcache.__class__.display = self.hooks.display | |
504 | except AttributeError: |
|
504 | except AttributeError: | |
505 | pass |
|
505 | pass | |
506 |
|
506 | |||
507 | def init_displayhook(self): |
|
507 | def init_displayhook(self): | |
508 | self.display_trap = DisplayTrap(self, self.outputcache) |
|
508 | self.display_trap = DisplayTrap(self, self.outputcache) | |
509 |
|
509 | |||
510 | def init_reload_doctest(self): |
|
510 | def init_reload_doctest(self): | |
511 | # Do a proper resetting of doctest, including the necessary displayhook |
|
511 | # Do a proper resetting of doctest, including the necessary displayhook | |
512 | # monkeypatching |
|
512 | # monkeypatching | |
513 | try: |
|
513 | try: | |
514 | doctest_reload() |
|
514 | doctest_reload() | |
515 | except ImportError: |
|
515 | except ImportError: | |
516 | warn("doctest module does not exist.") |
|
516 | warn("doctest module does not exist.") | |
517 |
|
517 | |||
518 | #------------------------------------------------------------------------- |
|
518 | #------------------------------------------------------------------------- | |
519 | # Things related to the banner |
|
519 | # Things related to the banner | |
520 | #------------------------------------------------------------------------- |
|
520 | #------------------------------------------------------------------------- | |
521 |
|
521 | |||
522 | def init_banner(self, banner1, banner2, display_banner): |
|
522 | def init_banner(self, banner1, banner2, display_banner): | |
523 | if banner1 is not None: |
|
523 | if banner1 is not None: | |
524 | self.banner1 = banner1 |
|
524 | self.banner1 = banner1 | |
525 | if banner2 is not None: |
|
525 | if banner2 is not None: | |
526 | self.banner2 = banner2 |
|
526 | self.banner2 = banner2 | |
527 | if display_banner is not None: |
|
527 | if display_banner is not None: | |
528 | self.display_banner = display_banner |
|
528 | self.display_banner = display_banner | |
529 | self.compute_banner() |
|
529 | self.compute_banner() | |
530 |
|
530 | |||
531 | def show_banner(self, banner=None): |
|
531 | def show_banner(self, banner=None): | |
532 | if banner is None: |
|
532 | if banner is None: | |
533 | banner = self.banner |
|
533 | banner = self.banner | |
534 | self.write(banner) |
|
534 | self.write(banner) | |
535 |
|
535 | |||
536 | def compute_banner(self): |
|
536 | def compute_banner(self): | |
537 | self.banner = self.banner1 + '\n' |
|
537 | self.banner = self.banner1 + '\n' | |
538 | if self.profile: |
|
538 | if self.profile: | |
539 | self.banner += '\nIPython profile: %s\n' % self.profile |
|
539 | self.banner += '\nIPython profile: %s\n' % self.profile | |
540 | if self.banner2: |
|
540 | if self.banner2: | |
541 | self.banner += '\n' + self.banner2 + '\n' |
|
541 | self.banner += '\n' + self.banner2 + '\n' | |
542 |
|
542 | |||
543 | #------------------------------------------------------------------------- |
|
543 | #------------------------------------------------------------------------- | |
544 | # Things related to injections into the sys module |
|
544 | # Things related to injections into the sys module | |
545 | #------------------------------------------------------------------------- |
|
545 | #------------------------------------------------------------------------- | |
546 |
|
546 | |||
547 | def save_sys_module_state(self): |
|
547 | def save_sys_module_state(self): | |
548 | """Save the state of hooks in the sys module. |
|
548 | """Save the state of hooks in the sys module. | |
549 |
|
549 | |||
550 | This has to be called after self.user_ns is created. |
|
550 | This has to be called after self.user_ns is created. | |
551 | """ |
|
551 | """ | |
552 | self._orig_sys_module_state = {} |
|
552 | self._orig_sys_module_state = {} | |
553 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
553 | self._orig_sys_module_state['stdin'] = sys.stdin | |
554 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
554 | self._orig_sys_module_state['stdout'] = sys.stdout | |
555 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
555 | self._orig_sys_module_state['stderr'] = sys.stderr | |
556 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
556 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
557 | try: |
|
557 | try: | |
558 | self._orig_sys_modules_main_name = self.user_ns['__name__'] |
|
558 | self._orig_sys_modules_main_name = self.user_ns['__name__'] | |
559 | except KeyError: |
|
559 | except KeyError: | |
560 | pass |
|
560 | pass | |
561 |
|
561 | |||
562 | def restore_sys_module_state(self): |
|
562 | def restore_sys_module_state(self): | |
563 | """Restore the state of the sys module.""" |
|
563 | """Restore the state of the sys module.""" | |
564 | try: |
|
564 | try: | |
565 | for k, v in self._orig_sys_module_state.items(): |
|
565 | for k, v in self._orig_sys_module_state.items(): | |
566 | setattr(sys, k, v) |
|
566 | setattr(sys, k, v) | |
567 | except AttributeError: |
|
567 | except AttributeError: | |
568 | pass |
|
568 | pass | |
569 | try: |
|
569 | try: | |
570 | delattr(sys, 'ipcompleter') |
|
570 | delattr(sys, 'ipcompleter') | |
571 | except AttributeError: |
|
571 | except AttributeError: | |
572 | pass |
|
572 | pass | |
573 | # Reset what what done in self.init_sys_modules |
|
573 | # Reset what what done in self.init_sys_modules | |
574 | try: |
|
574 | try: | |
575 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name |
|
575 | sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name | |
576 | except (AttributeError, KeyError): |
|
576 | except (AttributeError, KeyError): | |
577 | pass |
|
577 | pass | |
578 |
|
578 | |||
579 | #------------------------------------------------------------------------- |
|
579 | #------------------------------------------------------------------------- | |
580 | # Things related to hooks |
|
580 | # Things related to hooks | |
581 | #------------------------------------------------------------------------- |
|
581 | #------------------------------------------------------------------------- | |
582 |
|
582 | |||
583 | def init_hooks(self): |
|
583 | def init_hooks(self): | |
584 | # hooks holds pointers used for user-side customizations |
|
584 | # hooks holds pointers used for user-side customizations | |
585 | self.hooks = Struct() |
|
585 | self.hooks = Struct() | |
586 |
|
586 | |||
587 | self.strdispatchers = {} |
|
587 | self.strdispatchers = {} | |
588 |
|
588 | |||
589 | # Set all default hooks, defined in the IPython.hooks module. |
|
589 | # Set all default hooks, defined in the IPython.hooks module. | |
590 | import IPython.core.hooks |
|
590 | import IPython.core.hooks | |
591 | hooks = IPython.core.hooks |
|
591 | hooks = IPython.core.hooks | |
592 | for hook_name in hooks.__all__: |
|
592 | for hook_name in hooks.__all__: | |
593 | # default hooks have priority 100, i.e. low; user hooks should have |
|
593 | # default hooks have priority 100, i.e. low; user hooks should have | |
594 | # 0-100 priority |
|
594 | # 0-100 priority | |
595 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) |
|
595 | self.set_hook(hook_name,getattr(hooks,hook_name), 100) | |
596 |
|
596 | |||
597 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): |
|
597 | def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None): | |
598 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
598 | """set_hook(name,hook) -> sets an internal IPython hook. | |
599 |
|
599 | |||
600 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
600 | IPython exposes some of its internal API as user-modifiable hooks. By | |
601 | adding your function to one of these hooks, you can modify IPython's |
|
601 | adding your function to one of these hooks, you can modify IPython's | |
602 | behavior to call at runtime your own routines.""" |
|
602 | behavior to call at runtime your own routines.""" | |
603 |
|
603 | |||
604 | # At some point in the future, this should validate the hook before it |
|
604 | # At some point in the future, this should validate the hook before it | |
605 | # accepts it. Probably at least check that the hook takes the number |
|
605 | # accepts it. Probably at least check that the hook takes the number | |
606 | # of args it's supposed to. |
|
606 | # of args it's supposed to. | |
607 |
|
607 | |||
608 | f = new.instancemethod(hook,self,self.__class__) |
|
608 | f = new.instancemethod(hook,self,self.__class__) | |
609 |
|
609 | |||
610 | # check if the hook is for strdispatcher first |
|
610 | # check if the hook is for strdispatcher first | |
611 | if str_key is not None: |
|
611 | if str_key is not None: | |
612 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
612 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
613 | sdp.add_s(str_key, f, priority ) |
|
613 | sdp.add_s(str_key, f, priority ) | |
614 | self.strdispatchers[name] = sdp |
|
614 | self.strdispatchers[name] = sdp | |
615 | return |
|
615 | return | |
616 | if re_key is not None: |
|
616 | if re_key is not None: | |
617 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
617 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
618 | sdp.add_re(re.compile(re_key), f, priority ) |
|
618 | sdp.add_re(re.compile(re_key), f, priority ) | |
619 | self.strdispatchers[name] = sdp |
|
619 | self.strdispatchers[name] = sdp | |
620 | return |
|
620 | return | |
621 |
|
621 | |||
622 | dp = getattr(self.hooks, name, None) |
|
622 | dp = getattr(self.hooks, name, None) | |
623 | if name not in IPython.core.hooks.__all__: |
|
623 | if name not in IPython.core.hooks.__all__: | |
624 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) |
|
624 | print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ ) | |
625 | if not dp: |
|
625 | if not dp: | |
626 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
626 | dp = IPython.core.hooks.CommandChainDispatcher() | |
627 |
|
627 | |||
628 | try: |
|
628 | try: | |
629 | dp.add(f,priority) |
|
629 | dp.add(f,priority) | |
630 | except AttributeError: |
|
630 | except AttributeError: | |
631 | # it was not commandchain, plain old func - replace |
|
631 | # it was not commandchain, plain old func - replace | |
632 | dp = f |
|
632 | dp = f | |
633 |
|
633 | |||
634 | setattr(self.hooks,name, dp) |
|
634 | setattr(self.hooks,name, dp) | |
635 |
|
635 | |||
636 | #------------------------------------------------------------------------- |
|
636 | #------------------------------------------------------------------------- | |
637 | # Things related to the "main" module |
|
637 | # Things related to the "main" module | |
638 | #------------------------------------------------------------------------- |
|
638 | #------------------------------------------------------------------------- | |
639 |
|
639 | |||
640 | def new_main_mod(self,ns=None): |
|
640 | def new_main_mod(self,ns=None): | |
641 | """Return a new 'main' module object for user code execution. |
|
641 | """Return a new 'main' module object for user code execution. | |
642 | """ |
|
642 | """ | |
643 | main_mod = self._user_main_module |
|
643 | main_mod = self._user_main_module | |
644 | init_fakemod_dict(main_mod,ns) |
|
644 | init_fakemod_dict(main_mod,ns) | |
645 | return main_mod |
|
645 | return main_mod | |
646 |
|
646 | |||
647 | def cache_main_mod(self,ns,fname): |
|
647 | def cache_main_mod(self,ns,fname): | |
648 | """Cache a main module's namespace. |
|
648 | """Cache a main module's namespace. | |
649 |
|
649 | |||
650 | When scripts are executed via %run, we must keep a reference to the |
|
650 | When scripts are executed via %run, we must keep a reference to the | |
651 | namespace of their __main__ module (a FakeModule instance) around so |
|
651 | namespace of their __main__ module (a FakeModule instance) around so | |
652 | that Python doesn't clear it, rendering objects defined therein |
|
652 | that Python doesn't clear it, rendering objects defined therein | |
653 | useless. |
|
653 | useless. | |
654 |
|
654 | |||
655 | This method keeps said reference in a private dict, keyed by the |
|
655 | This method keeps said reference in a private dict, keyed by the | |
656 | absolute path of the module object (which corresponds to the script |
|
656 | absolute path of the module object (which corresponds to the script | |
657 | path). This way, for multiple executions of the same script we only |
|
657 | path). This way, for multiple executions of the same script we only | |
658 | keep one copy of the namespace (the last one), thus preventing memory |
|
658 | keep one copy of the namespace (the last one), thus preventing memory | |
659 | leaks from old references while allowing the objects from the last |
|
659 | leaks from old references while allowing the objects from the last | |
660 | execution to be accessible. |
|
660 | execution to be accessible. | |
661 |
|
661 | |||
662 | Note: we can not allow the actual FakeModule instances to be deleted, |
|
662 | Note: we can not allow the actual FakeModule instances to be deleted, | |
663 | because of how Python tears down modules (it hard-sets all their |
|
663 | because of how Python tears down modules (it hard-sets all their | |
664 | references to None without regard for reference counts). This method |
|
664 | references to None without regard for reference counts). This method | |
665 | must therefore make a *copy* of the given namespace, to allow the |
|
665 | must therefore make a *copy* of the given namespace, to allow the | |
666 | original module's __dict__ to be cleared and reused. |
|
666 | original module's __dict__ to be cleared and reused. | |
667 |
|
667 | |||
668 |
|
668 | |||
669 | Parameters |
|
669 | Parameters | |
670 | ---------- |
|
670 | ---------- | |
671 | ns : a namespace (a dict, typically) |
|
671 | ns : a namespace (a dict, typically) | |
672 |
|
672 | |||
673 | fname : str |
|
673 | fname : str | |
674 | Filename associated with the namespace. |
|
674 | Filename associated with the namespace. | |
675 |
|
675 | |||
676 | Examples |
|
676 | Examples | |
677 | -------- |
|
677 | -------- | |
678 |
|
678 | |||
679 | In [10]: import IPython |
|
679 | In [10]: import IPython | |
680 |
|
680 | |||
681 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
681 | In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
682 |
|
682 | |||
683 | In [12]: IPython.__file__ in _ip._main_ns_cache |
|
683 | In [12]: IPython.__file__ in _ip._main_ns_cache | |
684 | Out[12]: True |
|
684 | Out[12]: True | |
685 | """ |
|
685 | """ | |
686 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() |
|
686 | self._main_ns_cache[os.path.abspath(fname)] = ns.copy() | |
687 |
|
687 | |||
688 | def clear_main_mod_cache(self): |
|
688 | def clear_main_mod_cache(self): | |
689 | """Clear the cache of main modules. |
|
689 | """Clear the cache of main modules. | |
690 |
|
690 | |||
691 | Mainly for use by utilities like %reset. |
|
691 | Mainly for use by utilities like %reset. | |
692 |
|
692 | |||
693 | Examples |
|
693 | Examples | |
694 | -------- |
|
694 | -------- | |
695 |
|
695 | |||
696 | In [15]: import IPython |
|
696 | In [15]: import IPython | |
697 |
|
697 | |||
698 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) |
|
698 | In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__) | |
699 |
|
699 | |||
700 | In [17]: len(_ip._main_ns_cache) > 0 |
|
700 | In [17]: len(_ip._main_ns_cache) > 0 | |
701 | Out[17]: True |
|
701 | Out[17]: True | |
702 |
|
702 | |||
703 | In [18]: _ip.clear_main_mod_cache() |
|
703 | In [18]: _ip.clear_main_mod_cache() | |
704 |
|
704 | |||
705 | In [19]: len(_ip._main_ns_cache) == 0 |
|
705 | In [19]: len(_ip._main_ns_cache) == 0 | |
706 | Out[19]: True |
|
706 | Out[19]: True | |
707 | """ |
|
707 | """ | |
708 | self._main_ns_cache.clear() |
|
708 | self._main_ns_cache.clear() | |
709 |
|
709 | |||
710 | #------------------------------------------------------------------------- |
|
710 | #------------------------------------------------------------------------- | |
711 | # Things related to debugging |
|
711 | # Things related to debugging | |
712 | #------------------------------------------------------------------------- |
|
712 | #------------------------------------------------------------------------- | |
713 |
|
713 | |||
714 | def init_pdb(self): |
|
714 | def init_pdb(self): | |
715 | # Set calling of pdb on exceptions |
|
715 | # Set calling of pdb on exceptions | |
716 | # self.call_pdb is a property |
|
716 | # self.call_pdb is a property | |
717 | self.call_pdb = self.pdb |
|
717 | self.call_pdb = self.pdb | |
718 |
|
718 | |||
719 | def _get_call_pdb(self): |
|
719 | def _get_call_pdb(self): | |
720 | return self._call_pdb |
|
720 | return self._call_pdb | |
721 |
|
721 | |||
722 | def _set_call_pdb(self,val): |
|
722 | def _set_call_pdb(self,val): | |
723 |
|
723 | |||
724 | if val not in (0,1,False,True): |
|
724 | if val not in (0,1,False,True): | |
725 | raise ValueError,'new call_pdb value must be boolean' |
|
725 | raise ValueError,'new call_pdb value must be boolean' | |
726 |
|
726 | |||
727 | # store value in instance |
|
727 | # store value in instance | |
728 | self._call_pdb = val |
|
728 | self._call_pdb = val | |
729 |
|
729 | |||
730 | # notify the actual exception handlers |
|
730 | # notify the actual exception handlers | |
731 | self.InteractiveTB.call_pdb = val |
|
731 | self.InteractiveTB.call_pdb = val | |
732 | if self.isthreaded: |
|
732 | if self.isthreaded: | |
733 | try: |
|
733 | try: | |
734 | self.sys_excepthook.call_pdb = val |
|
734 | self.sys_excepthook.call_pdb = val | |
735 | except: |
|
735 | except: | |
736 | warn('Failed to activate pdb for threaded exception handler') |
|
736 | warn('Failed to activate pdb for threaded exception handler') | |
737 |
|
737 | |||
738 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
738 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
739 | 'Control auto-activation of pdb at exceptions') |
|
739 | 'Control auto-activation of pdb at exceptions') | |
740 |
|
740 | |||
741 | def debugger(self,force=False): |
|
741 | def debugger(self,force=False): | |
742 | """Call the pydb/pdb debugger. |
|
742 | """Call the pydb/pdb debugger. | |
743 |
|
743 | |||
744 | Keywords: |
|
744 | Keywords: | |
745 |
|
745 | |||
746 | - force(False): by default, this routine checks the instance call_pdb |
|
746 | - force(False): by default, this routine checks the instance call_pdb | |
747 | flag and does not actually invoke the debugger if the flag is false. |
|
747 | flag and does not actually invoke the debugger if the flag is false. | |
748 | The 'force' option forces the debugger to activate even if the flag |
|
748 | The 'force' option forces the debugger to activate even if the flag | |
749 | is false. |
|
749 | is false. | |
750 | """ |
|
750 | """ | |
751 |
|
751 | |||
752 | if not (force or self.call_pdb): |
|
752 | if not (force or self.call_pdb): | |
753 | return |
|
753 | return | |
754 |
|
754 | |||
755 | if not hasattr(sys,'last_traceback'): |
|
755 | if not hasattr(sys,'last_traceback'): | |
756 | error('No traceback has been produced, nothing to debug.') |
|
756 | error('No traceback has been produced, nothing to debug.') | |
757 | return |
|
757 | return | |
758 |
|
758 | |||
759 | # use pydb if available |
|
759 | # use pydb if available | |
760 | if debugger.has_pydb: |
|
760 | if debugger.has_pydb: | |
761 | from pydb import pm |
|
761 | from pydb import pm | |
762 | else: |
|
762 | else: | |
763 | # fallback to our internal debugger |
|
763 | # fallback to our internal debugger | |
764 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
764 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
765 | self.history_saving_wrapper(pm)() |
|
765 | self.history_saving_wrapper(pm)() | |
766 |
|
766 | |||
767 | #------------------------------------------------------------------------- |
|
767 | #------------------------------------------------------------------------- | |
768 | # Things related to IPython's various namespaces |
|
768 | # Things related to IPython's various namespaces | |
769 | #------------------------------------------------------------------------- |
|
769 | #------------------------------------------------------------------------- | |
770 |
|
770 | |||
771 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): |
|
771 | def init_create_namespaces(self, user_ns=None, user_global_ns=None): | |
772 | # Create the namespace where the user will operate. user_ns is |
|
772 | # Create the namespace where the user will operate. user_ns is | |
773 | # normally the only one used, and it is passed to the exec calls as |
|
773 | # normally the only one used, and it is passed to the exec calls as | |
774 | # the locals argument. But we do carry a user_global_ns namespace |
|
774 | # the locals argument. But we do carry a user_global_ns namespace | |
775 | # given as the exec 'globals' argument, This is useful in embedding |
|
775 | # given as the exec 'globals' argument, This is useful in embedding | |
776 | # situations where the ipython shell opens in a context where the |
|
776 | # situations where the ipython shell opens in a context where the | |
777 | # distinction between locals and globals is meaningful. For |
|
777 | # distinction between locals and globals is meaningful. For | |
778 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
778 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
779 |
|
779 | |||
780 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
780 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
781 | # level as a dict instead of a module. This is a manual fix, but I |
|
781 | # level as a dict instead of a module. This is a manual fix, but I | |
782 | # should really track down where the problem is coming from. Alex |
|
782 | # should really track down where the problem is coming from. Alex | |
783 | # Schmolck reported this problem first. |
|
783 | # Schmolck reported this problem first. | |
784 |
|
784 | |||
785 | # A useful post by Alex Martelli on this topic: |
|
785 | # A useful post by Alex Martelli on this topic: | |
786 | # Re: inconsistent value from __builtins__ |
|
786 | # Re: inconsistent value from __builtins__ | |
787 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
787 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
788 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
788 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
789 | # Gruppen: comp.lang.python |
|
789 | # Gruppen: comp.lang.python | |
790 |
|
790 | |||
791 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
791 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
792 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
792 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
793 | # > <type 'dict'> |
|
793 | # > <type 'dict'> | |
794 | # > >>> print type(__builtins__) |
|
794 | # > >>> print type(__builtins__) | |
795 | # > <type 'module'> |
|
795 | # > <type 'module'> | |
796 | # > Is this difference in return value intentional? |
|
796 | # > Is this difference in return value intentional? | |
797 |
|
797 | |||
798 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
798 | # Well, it's documented that '__builtins__' can be either a dictionary | |
799 | # or a module, and it's been that way for a long time. Whether it's |
|
799 | # or a module, and it's been that way for a long time. Whether it's | |
800 | # intentional (or sensible), I don't know. In any case, the idea is |
|
800 | # intentional (or sensible), I don't know. In any case, the idea is | |
801 | # that if you need to access the built-in namespace directly, you |
|
801 | # that if you need to access the built-in namespace directly, you | |
802 | # should start with "import __builtin__" (note, no 's') which will |
|
802 | # should start with "import __builtin__" (note, no 's') which will | |
803 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
803 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
804 |
|
804 | |||
805 | # These routines return properly built dicts as needed by the rest of |
|
805 | # These routines return properly built dicts as needed by the rest of | |
806 | # the code, and can also be used by extension writers to generate |
|
806 | # the code, and can also be used by extension writers to generate | |
807 | # properly initialized namespaces. |
|
807 | # properly initialized namespaces. | |
808 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, |
|
808 | user_ns, user_global_ns = self.make_user_namespaces(user_ns, | |
809 | user_global_ns) |
|
809 | user_global_ns) | |
810 |
|
810 | |||
811 | # Assign namespaces |
|
811 | # Assign namespaces | |
812 | # This is the namespace where all normal user variables live |
|
812 | # This is the namespace where all normal user variables live | |
813 | self.user_ns = user_ns |
|
813 | self.user_ns = user_ns | |
814 | self.user_global_ns = user_global_ns |
|
814 | self.user_global_ns = user_global_ns | |
815 |
|
815 | |||
816 | # An auxiliary namespace that checks what parts of the user_ns were |
|
816 | # An auxiliary namespace that checks what parts of the user_ns were | |
817 | # loaded at startup, so we can list later only variables defined in |
|
817 | # loaded at startup, so we can list later only variables defined in | |
818 | # actual interactive use. Since it is always a subset of user_ns, it |
|
818 | # actual interactive use. Since it is always a subset of user_ns, it | |
819 | # doesn't need to be seaparately tracked in the ns_table |
|
819 | # doesn't need to be seaparately tracked in the ns_table | |
820 | self.user_config_ns = {} |
|
820 | self.user_config_ns = {} | |
821 |
|
821 | |||
822 | # A namespace to keep track of internal data structures to prevent |
|
822 | # A namespace to keep track of internal data structures to prevent | |
823 | # them from cluttering user-visible stuff. Will be updated later |
|
823 | # them from cluttering user-visible stuff. Will be updated later | |
824 | self.internal_ns = {} |
|
824 | self.internal_ns = {} | |
825 |
|
825 | |||
826 | # Now that FakeModule produces a real module, we've run into a nasty |
|
826 | # Now that FakeModule produces a real module, we've run into a nasty | |
827 | # problem: after script execution (via %run), the module where the user |
|
827 | # problem: after script execution (via %run), the module where the user | |
828 | # code ran is deleted. Now that this object is a true module (needed |
|
828 | # code ran is deleted. Now that this object is a true module (needed | |
829 | # so docetst and other tools work correctly), the Python module |
|
829 | # so docetst and other tools work correctly), the Python module | |
830 | # teardown mechanism runs over it, and sets to None every variable |
|
830 | # teardown mechanism runs over it, and sets to None every variable | |
831 | # present in that module. Top-level references to objects from the |
|
831 | # present in that module. Top-level references to objects from the | |
832 | # script survive, because the user_ns is updated with them. However, |
|
832 | # script survive, because the user_ns is updated with them. However, | |
833 | # calling functions defined in the script that use other things from |
|
833 | # calling functions defined in the script that use other things from | |
834 | # the script will fail, because the function's closure had references |
|
834 | # the script will fail, because the function's closure had references | |
835 | # to the original objects, which are now all None. So we must protect |
|
835 | # to the original objects, which are now all None. So we must protect | |
836 | # these modules from deletion by keeping a cache. |
|
836 | # these modules from deletion by keeping a cache. | |
837 | # |
|
837 | # | |
838 | # To avoid keeping stale modules around (we only need the one from the |
|
838 | # To avoid keeping stale modules around (we only need the one from the | |
839 | # last run), we use a dict keyed with the full path to the script, so |
|
839 | # last run), we use a dict keyed with the full path to the script, so | |
840 | # only the last version of the module is held in the cache. Note, |
|
840 | # only the last version of the module is held in the cache. Note, | |
841 | # however, that we must cache the module *namespace contents* (their |
|
841 | # however, that we must cache the module *namespace contents* (their | |
842 | # __dict__). Because if we try to cache the actual modules, old ones |
|
842 | # __dict__). Because if we try to cache the actual modules, old ones | |
843 | # (uncached) could be destroyed while still holding references (such as |
|
843 | # (uncached) could be destroyed while still holding references (such as | |
844 | # those held by GUI objects that tend to be long-lived)> |
|
844 | # those held by GUI objects that tend to be long-lived)> | |
845 | # |
|
845 | # | |
846 | # The %reset command will flush this cache. See the cache_main_mod() |
|
846 | # The %reset command will flush this cache. See the cache_main_mod() | |
847 | # and clear_main_mod_cache() methods for details on use. |
|
847 | # and clear_main_mod_cache() methods for details on use. | |
848 |
|
848 | |||
849 | # This is the cache used for 'main' namespaces |
|
849 | # This is the cache used for 'main' namespaces | |
850 | self._main_ns_cache = {} |
|
850 | self._main_ns_cache = {} | |
851 | # And this is the single instance of FakeModule whose __dict__ we keep |
|
851 | # And this is the single instance of FakeModule whose __dict__ we keep | |
852 | # copying and clearing for reuse on each %run |
|
852 | # copying and clearing for reuse on each %run | |
853 | self._user_main_module = FakeModule() |
|
853 | self._user_main_module = FakeModule() | |
854 |
|
854 | |||
855 | # A table holding all the namespaces IPython deals with, so that |
|
855 | # A table holding all the namespaces IPython deals with, so that | |
856 | # introspection facilities can search easily. |
|
856 | # introspection facilities can search easily. | |
857 | self.ns_table = {'user':user_ns, |
|
857 | self.ns_table = {'user':user_ns, | |
858 | 'user_global':user_global_ns, |
|
858 | 'user_global':user_global_ns, | |
859 | 'internal':self.internal_ns, |
|
859 | 'internal':self.internal_ns, | |
860 | 'builtin':__builtin__.__dict__ |
|
860 | 'builtin':__builtin__.__dict__ | |
861 | } |
|
861 | } | |
862 |
|
862 | |||
863 | # Similarly, track all namespaces where references can be held and that |
|
863 | # Similarly, track all namespaces where references can be held and that | |
864 | # we can safely clear (so it can NOT include builtin). This one can be |
|
864 | # we can safely clear (so it can NOT include builtin). This one can be | |
865 | # a simple list. |
|
865 | # a simple list. | |
866 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, |
|
866 | self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns, | |
867 | self.internal_ns, self._main_ns_cache ] |
|
867 | self.internal_ns, self._main_ns_cache ] | |
868 |
|
868 | |||
869 | def init_sys_modules(self): |
|
869 | def init_sys_modules(self): | |
870 | # We need to insert into sys.modules something that looks like a |
|
870 | # We need to insert into sys.modules something that looks like a | |
871 | # module but which accesses the IPython namespace, for shelve and |
|
871 | # module but which accesses the IPython namespace, for shelve and | |
872 | # pickle to work interactively. Normally they rely on getting |
|
872 | # pickle to work interactively. Normally they rely on getting | |
873 | # everything out of __main__, but for embedding purposes each IPython |
|
873 | # everything out of __main__, but for embedding purposes each IPython | |
874 | # instance has its own private namespace, so we can't go shoving |
|
874 | # instance has its own private namespace, so we can't go shoving | |
875 | # everything into __main__. |
|
875 | # everything into __main__. | |
876 |
|
876 | |||
877 | # note, however, that we should only do this for non-embedded |
|
877 | # note, however, that we should only do this for non-embedded | |
878 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
878 | # ipythons, which really mimic the __main__.__dict__ with their own | |
879 | # namespace. Embedded instances, on the other hand, should not do |
|
879 | # namespace. Embedded instances, on the other hand, should not do | |
880 | # this because they need to manage the user local/global namespaces |
|
880 | # this because they need to manage the user local/global namespaces | |
881 | # only, but they live within a 'normal' __main__ (meaning, they |
|
881 | # only, but they live within a 'normal' __main__ (meaning, they | |
882 | # shouldn't overtake the execution environment of the script they're |
|
882 | # shouldn't overtake the execution environment of the script they're | |
883 | # embedded in). |
|
883 | # embedded in). | |
884 |
|
884 | |||
885 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
885 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
886 |
|
886 | |||
887 | try: |
|
887 | try: | |
888 | main_name = self.user_ns['__name__'] |
|
888 | main_name = self.user_ns['__name__'] | |
889 | except KeyError: |
|
889 | except KeyError: | |
890 | raise KeyError('user_ns dictionary MUST have a "__name__" key') |
|
890 | raise KeyError('user_ns dictionary MUST have a "__name__" key') | |
891 | else: |
|
891 | else: | |
892 | sys.modules[main_name] = FakeModule(self.user_ns) |
|
892 | sys.modules[main_name] = FakeModule(self.user_ns) | |
893 |
|
893 | |||
894 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): |
|
894 | def make_user_namespaces(self, user_ns=None, user_global_ns=None): | |
895 | """Return a valid local and global user interactive namespaces. |
|
895 | """Return a valid local and global user interactive namespaces. | |
896 |
|
896 | |||
897 | This builds a dict with the minimal information needed to operate as a |
|
897 | This builds a dict with the minimal information needed to operate as a | |
898 | valid IPython user namespace, which you can pass to the various |
|
898 | valid IPython user namespace, which you can pass to the various | |
899 | embedding classes in ipython. The default implementation returns the |
|
899 | embedding classes in ipython. The default implementation returns the | |
900 | same dict for both the locals and the globals to allow functions to |
|
900 | same dict for both the locals and the globals to allow functions to | |
901 | refer to variables in the namespace. Customized implementations can |
|
901 | refer to variables in the namespace. Customized implementations can | |
902 | return different dicts. The locals dictionary can actually be anything |
|
902 | return different dicts. The locals dictionary can actually be anything | |
903 | following the basic mapping protocol of a dict, but the globals dict |
|
903 | following the basic mapping protocol of a dict, but the globals dict | |
904 | must be a true dict, not even a subclass. It is recommended that any |
|
904 | must be a true dict, not even a subclass. It is recommended that any | |
905 | custom object for the locals namespace synchronize with the globals |
|
905 | custom object for the locals namespace synchronize with the globals | |
906 | dict somehow. |
|
906 | dict somehow. | |
907 |
|
907 | |||
908 | Raises TypeError if the provided globals namespace is not a true dict. |
|
908 | Raises TypeError if the provided globals namespace is not a true dict. | |
909 |
|
909 | |||
910 | :Parameters: |
|
910 | :Parameters: | |
911 | user_ns : dict-like, optional |
|
911 | user_ns : dict-like, optional | |
912 | The current user namespace. The items in this namespace should |
|
912 | The current user namespace. The items in this namespace should | |
913 | be included in the output. If None, an appropriate blank |
|
913 | be included in the output. If None, an appropriate blank | |
914 | namespace should be created. |
|
914 | namespace should be created. | |
915 | user_global_ns : dict, optional |
|
915 | user_global_ns : dict, optional | |
916 | The current user global namespace. The items in this namespace |
|
916 | The current user global namespace. The items in this namespace | |
917 | should be included in the output. If None, an appropriate |
|
917 | should be included in the output. If None, an appropriate | |
918 | blank namespace should be created. |
|
918 | blank namespace should be created. | |
919 |
|
919 | |||
920 | :Returns: |
|
920 | :Returns: | |
921 | A tuple pair of dictionary-like object to be used as the local namespace |
|
921 | A tuple pair of dictionary-like object to be used as the local namespace | |
922 | of the interpreter and a dict to be used as the global namespace. |
|
922 | of the interpreter and a dict to be used as the global namespace. | |
923 | """ |
|
923 | """ | |
924 |
|
924 | |||
925 | if user_ns is None: |
|
925 | if user_ns is None: | |
926 | # Set __name__ to __main__ to better match the behavior of the |
|
926 | # Set __name__ to __main__ to better match the behavior of the | |
927 | # normal interpreter. |
|
927 | # normal interpreter. | |
928 | user_ns = {'__name__' :'__main__', |
|
928 | user_ns = {'__name__' :'__main__', | |
929 | '__builtins__' : __builtin__, |
|
929 | '__builtins__' : __builtin__, | |
930 | } |
|
930 | } | |
931 | else: |
|
931 | else: | |
932 | user_ns.setdefault('__name__','__main__') |
|
932 | user_ns.setdefault('__name__','__main__') | |
933 | user_ns.setdefault('__builtins__',__builtin__) |
|
933 | user_ns.setdefault('__builtins__',__builtin__) | |
934 |
|
934 | |||
935 | if user_global_ns is None: |
|
935 | if user_global_ns is None: | |
936 | user_global_ns = user_ns |
|
936 | user_global_ns = user_ns | |
937 | if type(user_global_ns) is not dict: |
|
937 | if type(user_global_ns) is not dict: | |
938 | raise TypeError("user_global_ns must be a true dict; got %r" |
|
938 | raise TypeError("user_global_ns must be a true dict; got %r" | |
939 | % type(user_global_ns)) |
|
939 | % type(user_global_ns)) | |
940 |
|
940 | |||
941 | return user_ns, user_global_ns |
|
941 | return user_ns, user_global_ns | |
942 |
|
942 | |||
943 | def init_user_ns(self): |
|
943 | def init_user_ns(self): | |
944 | """Initialize all user-visible namespaces to their minimum defaults. |
|
944 | """Initialize all user-visible namespaces to their minimum defaults. | |
945 |
|
945 | |||
946 | Certain history lists are also initialized here, as they effectively |
|
946 | Certain history lists are also initialized here, as they effectively | |
947 | act as user namespaces. |
|
947 | act as user namespaces. | |
948 |
|
948 | |||
949 | Notes |
|
949 | Notes | |
950 | ----- |
|
950 | ----- | |
951 | All data structures here are only filled in, they are NOT reset by this |
|
951 | All data structures here are only filled in, they are NOT reset by this | |
952 | method. If they were not empty before, data will simply be added to |
|
952 | method. If they were not empty before, data will simply be added to | |
953 | therm. |
|
953 | therm. | |
954 | """ |
|
954 | """ | |
955 | # Store myself as the public api!!! |
|
955 | # Store myself as the public api!!! | |
956 | self.user_ns['get_ipython'] = self.get_ipython |
|
956 | self.user_ns['get_ipython'] = self.get_ipython | |
957 |
|
957 | |||
958 | # make global variables for user access to the histories |
|
958 | # make global variables for user access to the histories | |
959 | self.user_ns['_ih'] = self.input_hist |
|
959 | self.user_ns['_ih'] = self.input_hist | |
960 | self.user_ns['_oh'] = self.output_hist |
|
960 | self.user_ns['_oh'] = self.output_hist | |
961 | self.user_ns['_dh'] = self.dir_hist |
|
961 | self.user_ns['_dh'] = self.dir_hist | |
962 |
|
962 | |||
963 | # user aliases to input and output histories |
|
963 | # user aliases to input and output histories | |
964 | self.user_ns['In'] = self.input_hist |
|
964 | self.user_ns['In'] = self.input_hist | |
965 | self.user_ns['Out'] = self.output_hist |
|
965 | self.user_ns['Out'] = self.output_hist | |
966 |
|
966 | |||
967 | self.user_ns['_sh'] = shadowns |
|
967 | self.user_ns['_sh'] = shadowns | |
968 |
|
968 | |||
969 | # Put 'help' in the user namespace |
|
969 | # Put 'help' in the user namespace | |
970 | try: |
|
970 | try: | |
971 | from site import _Helper |
|
971 | from site import _Helper | |
972 | self.user_ns['help'] = _Helper() |
|
972 | self.user_ns['help'] = _Helper() | |
973 | except ImportError: |
|
973 | except ImportError: | |
974 | warn('help() not available - check site.py') |
|
974 | warn('help() not available - check site.py') | |
975 |
|
975 | |||
976 | def reset(self): |
|
976 | def reset(self): | |
977 | """Clear all internal namespaces. |
|
977 | """Clear all internal namespaces. | |
978 |
|
978 | |||
979 | Note that this is much more aggressive than %reset, since it clears |
|
979 | Note that this is much more aggressive than %reset, since it clears | |
980 | fully all namespaces, as well as all input/output lists. |
|
980 | fully all namespaces, as well as all input/output lists. | |
981 | """ |
|
981 | """ | |
982 | for ns in self.ns_refs_table: |
|
982 | for ns in self.ns_refs_table: | |
983 | ns.clear() |
|
983 | ns.clear() | |
984 |
|
984 | |||
985 | self.alias_manager.clear_aliases() |
|
985 | self.alias_manager.clear_aliases() | |
986 |
|
986 | |||
987 | # Clear input and output histories |
|
987 | # Clear input and output histories | |
988 | self.input_hist[:] = [] |
|
988 | self.input_hist[:] = [] | |
989 | self.input_hist_raw[:] = [] |
|
989 | self.input_hist_raw[:] = [] | |
990 | self.output_hist.clear() |
|
990 | self.output_hist.clear() | |
991 |
|
991 | |||
992 | # Restore the user namespaces to minimal usability |
|
992 | # Restore the user namespaces to minimal usability | |
993 | self.init_user_ns() |
|
993 | self.init_user_ns() | |
994 |
|
994 | |||
995 | # Restore the default and user aliases |
|
995 | # Restore the default and user aliases | |
996 | self.alias_manager.init_aliases() |
|
996 | self.alias_manager.init_aliases() | |
997 |
|
997 | |||
998 | def push(self, variables, interactive=True): |
|
998 | def push(self, variables, interactive=True): | |
999 | """Inject a group of variables into the IPython user namespace. |
|
999 | """Inject a group of variables into the IPython user namespace. | |
1000 |
|
1000 | |||
1001 | Parameters |
|
1001 | Parameters | |
1002 | ---------- |
|
1002 | ---------- | |
1003 | variables : dict, str or list/tuple of str |
|
1003 | variables : dict, str or list/tuple of str | |
1004 | The variables to inject into the user's namespace. If a dict, |
|
1004 | The variables to inject into the user's namespace. If a dict, | |
1005 | a simple update is done. If a str, the string is assumed to |
|
1005 | a simple update is done. If a str, the string is assumed to | |
1006 | have variable names separated by spaces. A list/tuple of str |
|
1006 | have variable names separated by spaces. A list/tuple of str | |
1007 | can also be used to give the variable names. If just the variable |
|
1007 | can also be used to give the variable names. If just the variable | |
1008 | names are give (list/tuple/str) then the variable values looked |
|
1008 | names are give (list/tuple/str) then the variable values looked | |
1009 | up in the callers frame. |
|
1009 | up in the callers frame. | |
1010 | interactive : bool |
|
1010 | interactive : bool | |
1011 | If True (default), the variables will be listed with the ``who`` |
|
1011 | If True (default), the variables will be listed with the ``who`` | |
1012 | magic. |
|
1012 | magic. | |
1013 | """ |
|
1013 | """ | |
1014 | vdict = None |
|
1014 | vdict = None | |
1015 |
|
1015 | |||
1016 | # We need a dict of name/value pairs to do namespace updates. |
|
1016 | # We need a dict of name/value pairs to do namespace updates. | |
1017 | if isinstance(variables, dict): |
|
1017 | if isinstance(variables, dict): | |
1018 | vdict = variables |
|
1018 | vdict = variables | |
1019 | elif isinstance(variables, (basestring, list, tuple)): |
|
1019 | elif isinstance(variables, (basestring, list, tuple)): | |
1020 | if isinstance(variables, basestring): |
|
1020 | if isinstance(variables, basestring): | |
1021 | vlist = variables.split() |
|
1021 | vlist = variables.split() | |
1022 | else: |
|
1022 | else: | |
1023 | vlist = variables |
|
1023 | vlist = variables | |
1024 | vdict = {} |
|
1024 | vdict = {} | |
1025 | cf = sys._getframe(1) |
|
1025 | cf = sys._getframe(1) | |
1026 | for name in vlist: |
|
1026 | for name in vlist: | |
1027 | try: |
|
1027 | try: | |
1028 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1028 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1029 | except: |
|
1029 | except: | |
1030 | print ('Could not get variable %s from %s' % |
|
1030 | print ('Could not get variable %s from %s' % | |
1031 | (name,cf.f_code.co_name)) |
|
1031 | (name,cf.f_code.co_name)) | |
1032 | else: |
|
1032 | else: | |
1033 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1033 | raise ValueError('variables must be a dict/str/list/tuple') | |
1034 |
|
1034 | |||
1035 | # Propagate variables to user namespace |
|
1035 | # Propagate variables to user namespace | |
1036 | self.user_ns.update(vdict) |
|
1036 | self.user_ns.update(vdict) | |
1037 |
|
1037 | |||
1038 | # And configure interactive visibility |
|
1038 | # And configure interactive visibility | |
1039 | config_ns = self.user_config_ns |
|
1039 | config_ns = self.user_config_ns | |
1040 | if interactive: |
|
1040 | if interactive: | |
1041 | for name, val in vdict.iteritems(): |
|
1041 | for name, val in vdict.iteritems(): | |
1042 | config_ns.pop(name, None) |
|
1042 | config_ns.pop(name, None) | |
1043 | else: |
|
1043 | else: | |
1044 | for name,val in vdict.iteritems(): |
|
1044 | for name,val in vdict.iteritems(): | |
1045 | config_ns[name] = val |
|
1045 | config_ns[name] = val | |
1046 |
|
1046 | |||
1047 | #------------------------------------------------------------------------- |
|
1047 | #------------------------------------------------------------------------- | |
1048 | # Things related to history management |
|
1048 | # Things related to history management | |
1049 | #------------------------------------------------------------------------- |
|
1049 | #------------------------------------------------------------------------- | |
1050 |
|
1050 | |||
1051 | def init_history(self): |
|
1051 | def init_history(self): | |
1052 | # List of input with multi-line handling. |
|
1052 | # List of input with multi-line handling. | |
1053 | self.input_hist = InputList() |
|
1053 | self.input_hist = InputList() | |
1054 | # This one will hold the 'raw' input history, without any |
|
1054 | # This one will hold the 'raw' input history, without any | |
1055 | # pre-processing. This will allow users to retrieve the input just as |
|
1055 | # pre-processing. This will allow users to retrieve the input just as | |
1056 | # it was exactly typed in by the user, with %hist -r. |
|
1056 | # it was exactly typed in by the user, with %hist -r. | |
1057 | self.input_hist_raw = InputList() |
|
1057 | self.input_hist_raw = InputList() | |
1058 |
|
1058 | |||
1059 | # list of visited directories |
|
1059 | # list of visited directories | |
1060 | try: |
|
1060 | try: | |
1061 | self.dir_hist = [os.getcwd()] |
|
1061 | self.dir_hist = [os.getcwd()] | |
1062 | except OSError: |
|
1062 | except OSError: | |
1063 | self.dir_hist = [] |
|
1063 | self.dir_hist = [] | |
1064 |
|
1064 | |||
1065 | # dict of output history |
|
1065 | # dict of output history | |
1066 | self.output_hist = {} |
|
1066 | self.output_hist = {} | |
1067 |
|
1067 | |||
1068 | # Now the history file |
|
1068 | # Now the history file | |
1069 | if self.profile: |
|
1069 | if self.profile: | |
1070 | histfname = 'history-%s' % self.profile |
|
1070 | histfname = 'history-%s' % self.profile | |
1071 | else: |
|
1071 | else: | |
1072 | histfname = 'history' |
|
1072 | histfname = 'history' | |
1073 | self.histfile = os.path.join(self.ipythondir, histfname) |
|
1073 | self.histfile = os.path.join(self.ipythondir, histfname) | |
1074 |
|
1074 | |||
1075 | # Fill the history zero entry, user counter starts at 1 |
|
1075 | # Fill the history zero entry, user counter starts at 1 | |
1076 | self.input_hist.append('\n') |
|
1076 | self.input_hist.append('\n') | |
1077 | self.input_hist_raw.append('\n') |
|
1077 | self.input_hist_raw.append('\n') | |
1078 |
|
1078 | |||
1079 | def init_shadow_hist(self): |
|
1079 | def init_shadow_hist(self): | |
1080 | try: |
|
1080 | try: | |
1081 | self.db = pickleshare.PickleShareDB(self.ipythondir + "/db") |
|
1081 | self.db = pickleshare.PickleShareDB(self.ipythondir + "/db") | |
1082 | except exceptions.UnicodeDecodeError: |
|
1082 | except exceptions.UnicodeDecodeError: | |
1083 | print "Your ipythondir can't be decoded to unicode!" |
|
1083 | print "Your ipythondir can't be decoded to unicode!" | |
1084 | print "Please set HOME environment variable to something that" |
|
1084 | print "Please set HOME environment variable to something that" | |
1085 | print r"only has ASCII characters, e.g. c:\home" |
|
1085 | print r"only has ASCII characters, e.g. c:\home" | |
1086 | print "Now it is", self.ipythondir |
|
1086 | print "Now it is", self.ipythondir | |
1087 | sys.exit() |
|
1087 | sys.exit() | |
1088 | self.shadowhist = ipcorehist.ShadowHist(self.db) |
|
1088 | self.shadowhist = ipcorehist.ShadowHist(self.db) | |
1089 |
|
1089 | |||
1090 | def savehist(self): |
|
1090 | def savehist(self): | |
1091 | """Save input history to a file (via readline library).""" |
|
1091 | """Save input history to a file (via readline library).""" | |
1092 |
|
1092 | |||
1093 | if not self.has_readline: |
|
1093 | if not self.has_readline: | |
1094 | return |
|
1094 | return | |
1095 |
|
1095 | |||
1096 | try: |
|
1096 | try: | |
1097 | self.readline.write_history_file(self.histfile) |
|
1097 | self.readline.write_history_file(self.histfile) | |
1098 | except: |
|
1098 | except: | |
1099 | print 'Unable to save IPython command history to file: ' + \ |
|
1099 | print 'Unable to save IPython command history to file: ' + \ | |
1100 | `self.histfile` |
|
1100 | `self.histfile` | |
1101 |
|
1101 | |||
1102 | def reloadhist(self): |
|
1102 | def reloadhist(self): | |
1103 | """Reload the input history from disk file.""" |
|
1103 | """Reload the input history from disk file.""" | |
1104 |
|
1104 | |||
1105 | if self.has_readline: |
|
1105 | if self.has_readline: | |
1106 | try: |
|
1106 | try: | |
1107 | self.readline.clear_history() |
|
1107 | self.readline.clear_history() | |
1108 | self.readline.read_history_file(self.shell.histfile) |
|
1108 | self.readline.read_history_file(self.shell.histfile) | |
1109 | except AttributeError: |
|
1109 | except AttributeError: | |
1110 | pass |
|
1110 | pass | |
1111 |
|
1111 | |||
1112 | def history_saving_wrapper(self, func): |
|
1112 | def history_saving_wrapper(self, func): | |
1113 | """ Wrap func for readline history saving |
|
1113 | """ Wrap func for readline history saving | |
1114 |
|
1114 | |||
1115 | Convert func into callable that saves & restores |
|
1115 | Convert func into callable that saves & restores | |
1116 | history around the call """ |
|
1116 | history around the call """ | |
1117 |
|
1117 | |||
1118 | if not self.has_readline: |
|
1118 | if not self.has_readline: | |
1119 | return func |
|
1119 | return func | |
1120 |
|
1120 | |||
1121 | def wrapper(): |
|
1121 | def wrapper(): | |
1122 | self.savehist() |
|
1122 | self.savehist() | |
1123 | try: |
|
1123 | try: | |
1124 | func() |
|
1124 | func() | |
1125 | finally: |
|
1125 | finally: | |
1126 | readline.read_history_file(self.histfile) |
|
1126 | readline.read_history_file(self.histfile) | |
1127 | return wrapper |
|
1127 | return wrapper | |
1128 |
|
1128 | |||
1129 | #------------------------------------------------------------------------- |
|
1129 | #------------------------------------------------------------------------- | |
1130 | # Things related to exception handling and tracebacks (not debugging) |
|
1130 | # Things related to exception handling and tracebacks (not debugging) | |
1131 | #------------------------------------------------------------------------- |
|
1131 | #------------------------------------------------------------------------- | |
1132 |
|
1132 | |||
1133 | def init_traceback_handlers(self, custom_exceptions): |
|
1133 | def init_traceback_handlers(self, custom_exceptions): | |
1134 | # Syntax error handler. |
|
1134 | # Syntax error handler. | |
1135 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') |
|
1135 | self.SyntaxTB = SyntaxTB(color_scheme='NoColor') | |
1136 |
|
1136 | |||
1137 | # The interactive one is initialized with an offset, meaning we always |
|
1137 | # The interactive one is initialized with an offset, meaning we always | |
1138 | # want to remove the topmost item in the traceback, which is our own |
|
1138 | # want to remove the topmost item in the traceback, which is our own | |
1139 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1139 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1140 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1140 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1141 | color_scheme='NoColor', |
|
1141 | color_scheme='NoColor', | |
1142 | tb_offset = 1) |
|
1142 | tb_offset = 1) | |
1143 |
|
1143 | |||
1144 | # IPython itself shouldn't crash. This will produce a detailed |
|
1144 | # IPython itself shouldn't crash. This will produce a detailed | |
1145 | # post-mortem if it does. But we only install the crash handler for |
|
1145 | # post-mortem if it does. But we only install the crash handler for | |
1146 | # non-threaded shells, the threaded ones use a normal verbose reporter |
|
1146 | # non-threaded shells, the threaded ones use a normal verbose reporter | |
1147 | # and lose the crash handler. This is because exceptions in the main |
|
1147 | # and lose the crash handler. This is because exceptions in the main | |
1148 | # thread (such as in GUI code) propagate directly to sys.excepthook, |
|
1148 | # thread (such as in GUI code) propagate directly to sys.excepthook, | |
1149 | # and there's no point in printing crash dumps for every user exception. |
|
1149 | # and there's no point in printing crash dumps for every user exception. | |
1150 | if self.isthreaded: |
|
1150 | if self.isthreaded: | |
1151 | ipCrashHandler = ultratb.FormattedTB() |
|
1151 | ipCrashHandler = ultratb.FormattedTB() | |
1152 | else: |
|
1152 | else: | |
1153 | from IPython.core import crashhandler |
|
1153 | from IPython.core import crashhandler | |
1154 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) |
|
1154 | ipCrashHandler = crashhandler.IPythonCrashHandler(self) | |
1155 | self.set_crash_handler(ipCrashHandler) |
|
1155 | self.set_crash_handler(ipCrashHandler) | |
1156 |
|
1156 | |||
1157 | # and add any custom exception handlers the user may have specified |
|
1157 | # and add any custom exception handlers the user may have specified | |
1158 | self.set_custom_exc(*custom_exceptions) |
|
1158 | self.set_custom_exc(*custom_exceptions) | |
1159 |
|
1159 | |||
1160 | def set_crash_handler(self, crashHandler): |
|
1160 | def set_crash_handler(self, crashHandler): | |
1161 | """Set the IPython crash handler. |
|
1161 | """Set the IPython crash handler. | |
1162 |
|
1162 | |||
1163 | This must be a callable with a signature suitable for use as |
|
1163 | This must be a callable with a signature suitable for use as | |
1164 | sys.excepthook.""" |
|
1164 | sys.excepthook.""" | |
1165 |
|
1165 | |||
1166 | # Install the given crash handler as the Python exception hook |
|
1166 | # Install the given crash handler as the Python exception hook | |
1167 | sys.excepthook = crashHandler |
|
1167 | sys.excepthook = crashHandler | |
1168 |
|
1168 | |||
1169 | # The instance will store a pointer to this, so that runtime code |
|
1169 | # The instance will store a pointer to this, so that runtime code | |
1170 | # (such as magics) can access it. This is because during the |
|
1170 | # (such as magics) can access it. This is because during the | |
1171 | # read-eval loop, it gets temporarily overwritten (to deal with GUI |
|
1171 | # read-eval loop, it gets temporarily overwritten (to deal with GUI | |
1172 | # frameworks). |
|
1172 | # frameworks). | |
1173 | self.sys_excepthook = sys.excepthook |
|
1173 | self.sys_excepthook = sys.excepthook | |
1174 |
|
1174 | |||
1175 | def set_custom_exc(self,exc_tuple,handler): |
|
1175 | def set_custom_exc(self,exc_tuple,handler): | |
1176 | """set_custom_exc(exc_tuple,handler) |
|
1176 | """set_custom_exc(exc_tuple,handler) | |
1177 |
|
1177 | |||
1178 | Set a custom exception handler, which will be called if any of the |
|
1178 | Set a custom exception handler, which will be called if any of the | |
1179 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1179 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1180 | runcode() method. |
|
1180 | runcode() method. | |
1181 |
|
1181 | |||
1182 | Inputs: |
|
1182 | Inputs: | |
1183 |
|
1183 | |||
1184 | - exc_tuple: a *tuple* of valid exceptions to call the defined |
|
1184 | - exc_tuple: a *tuple* of valid exceptions to call the defined | |
1185 | handler for. It is very important that you use a tuple, and NOT A |
|
1185 | handler for. It is very important that you use a tuple, and NOT A | |
1186 | LIST here, because of the way Python's except statement works. If |
|
1186 | LIST here, because of the way Python's except statement works. If | |
1187 | you only want to trap a single exception, use a singleton tuple: |
|
1187 | you only want to trap a single exception, use a singleton tuple: | |
1188 |
|
1188 | |||
1189 | exc_tuple == (MyCustomException,) |
|
1189 | exc_tuple == (MyCustomException,) | |
1190 |
|
1190 | |||
1191 | - handler: this must be defined as a function with the following |
|
1191 | - handler: this must be defined as a function with the following | |
1192 | basic interface: def my_handler(self,etype,value,tb). |
|
1192 | basic interface: def my_handler(self,etype,value,tb). | |
1193 |
|
1193 | |||
1194 | This will be made into an instance method (via new.instancemethod) |
|
1194 | This will be made into an instance method (via new.instancemethod) | |
1195 | of IPython itself, and it will be called if any of the exceptions |
|
1195 | of IPython itself, and it will be called if any of the exceptions | |
1196 | listed in the exc_tuple are caught. If the handler is None, an |
|
1196 | listed in the exc_tuple are caught. If the handler is None, an | |
1197 | internal basic one is used, which just prints basic info. |
|
1197 | internal basic one is used, which just prints basic info. | |
1198 |
|
1198 | |||
1199 | WARNING: by putting in your own exception handler into IPython's main |
|
1199 | WARNING: by putting in your own exception handler into IPython's main | |
1200 | execution loop, you run a very good chance of nasty crashes. This |
|
1200 | execution loop, you run a very good chance of nasty crashes. This | |
1201 | facility should only be used if you really know what you are doing.""" |
|
1201 | facility should only be used if you really know what you are doing.""" | |
1202 |
|
1202 | |||
1203 | assert type(exc_tuple)==type(()) , \ |
|
1203 | assert type(exc_tuple)==type(()) , \ | |
1204 | "The custom exceptions must be given AS A TUPLE." |
|
1204 | "The custom exceptions must be given AS A TUPLE." | |
1205 |
|
1205 | |||
1206 | def dummy_handler(self,etype,value,tb): |
|
1206 | def dummy_handler(self,etype,value,tb): | |
1207 | print '*** Simple custom exception handler ***' |
|
1207 | print '*** Simple custom exception handler ***' | |
1208 | print 'Exception type :',etype |
|
1208 | print 'Exception type :',etype | |
1209 | print 'Exception value:',value |
|
1209 | print 'Exception value:',value | |
1210 | print 'Traceback :',tb |
|
1210 | print 'Traceback :',tb | |
1211 | print 'Source code :','\n'.join(self.buffer) |
|
1211 | print 'Source code :','\n'.join(self.buffer) | |
1212 |
|
1212 | |||
1213 | if handler is None: handler = dummy_handler |
|
1213 | if handler is None: handler = dummy_handler | |
1214 |
|
1214 | |||
1215 | self.CustomTB = new.instancemethod(handler,self,self.__class__) |
|
1215 | self.CustomTB = new.instancemethod(handler,self,self.__class__) | |
1216 | self.custom_exceptions = exc_tuple |
|
1216 | self.custom_exceptions = exc_tuple | |
1217 |
|
1217 | |||
1218 | def excepthook(self, etype, value, tb): |
|
1218 | def excepthook(self, etype, value, tb): | |
1219 | """One more defense for GUI apps that call sys.excepthook. |
|
1219 | """One more defense for GUI apps that call sys.excepthook. | |
1220 |
|
1220 | |||
1221 | GUI frameworks like wxPython trap exceptions and call |
|
1221 | GUI frameworks like wxPython trap exceptions and call | |
1222 | sys.excepthook themselves. I guess this is a feature that |
|
1222 | sys.excepthook themselves. I guess this is a feature that | |
1223 | enables them to keep running after exceptions that would |
|
1223 | enables them to keep running after exceptions that would | |
1224 | otherwise kill their mainloop. This is a bother for IPython |
|
1224 | otherwise kill their mainloop. This is a bother for IPython | |
1225 | which excepts to catch all of the program exceptions with a try: |
|
1225 | which excepts to catch all of the program exceptions with a try: | |
1226 | except: statement. |
|
1226 | except: statement. | |
1227 |
|
1227 | |||
1228 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1228 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1229 | any app directly invokes sys.excepthook, it will look to the user like |
|
1229 | any app directly invokes sys.excepthook, it will look to the user like | |
1230 | IPython crashed. In order to work around this, we can disable the |
|
1230 | IPython crashed. In order to work around this, we can disable the | |
1231 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1231 | CrashHandler and replace it with this excepthook instead, which prints a | |
1232 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1232 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1233 | call sys.excepthook will generate a regular-looking exception from |
|
1233 | call sys.excepthook will generate a regular-looking exception from | |
1234 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1234 | IPython, and the CrashHandler will only be triggered by real IPython | |
1235 | crashes. |
|
1235 | crashes. | |
1236 |
|
1236 | |||
1237 | This hook should be used sparingly, only in places which are not likely |
|
1237 | This hook should be used sparingly, only in places which are not likely | |
1238 | to be true IPython errors. |
|
1238 | to be true IPython errors. | |
1239 | """ |
|
1239 | """ | |
1240 | self.showtraceback((etype,value,tb),tb_offset=0) |
|
1240 | self.showtraceback((etype,value,tb),tb_offset=0) | |
1241 |
|
1241 | |||
1242 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): |
|
1242 | def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None): | |
1243 | """Display the exception that just occurred. |
|
1243 | """Display the exception that just occurred. | |
1244 |
|
1244 | |||
1245 | If nothing is known about the exception, this is the method which |
|
1245 | If nothing is known about the exception, this is the method which | |
1246 | should be used throughout the code for presenting user tracebacks, |
|
1246 | should be used throughout the code for presenting user tracebacks, | |
1247 | rather than directly invoking the InteractiveTB object. |
|
1247 | rather than directly invoking the InteractiveTB object. | |
1248 |
|
1248 | |||
1249 | A specific showsyntaxerror() also exists, but this method can take |
|
1249 | A specific showsyntaxerror() also exists, but this method can take | |
1250 | care of calling it if needed, so unless you are explicitly catching a |
|
1250 | care of calling it if needed, so unless you are explicitly catching a | |
1251 | SyntaxError exception, don't try to analyze the stack manually and |
|
1251 | SyntaxError exception, don't try to analyze the stack manually and | |
1252 | simply call this method.""" |
|
1252 | simply call this method.""" | |
1253 |
|
1253 | |||
1254 |
|
1254 | |||
1255 | # Though this won't be called by syntax errors in the input line, |
|
1255 | # Though this won't be called by syntax errors in the input line, | |
1256 | # there may be SyntaxError cases whith imported code. |
|
1256 | # there may be SyntaxError cases whith imported code. | |
1257 |
|
1257 | |||
1258 | try: |
|
1258 | try: | |
1259 | if exc_tuple is None: |
|
1259 | if exc_tuple is None: | |
1260 | etype, value, tb = sys.exc_info() |
|
1260 | etype, value, tb = sys.exc_info() | |
1261 | else: |
|
1261 | else: | |
1262 | etype, value, tb = exc_tuple |
|
1262 | etype, value, tb = exc_tuple | |
1263 |
|
1263 | |||
1264 | if etype is SyntaxError: |
|
1264 | if etype is SyntaxError: | |
1265 | self.showsyntaxerror(filename) |
|
1265 | self.showsyntaxerror(filename) | |
1266 | elif etype is UsageError: |
|
1266 | elif etype is UsageError: | |
1267 | print "UsageError:", value |
|
1267 | print "UsageError:", value | |
1268 | else: |
|
1268 | else: | |
1269 | # WARNING: these variables are somewhat deprecated and not |
|
1269 | # WARNING: these variables are somewhat deprecated and not | |
1270 | # necessarily safe to use in a threaded environment, but tools |
|
1270 | # necessarily safe to use in a threaded environment, but tools | |
1271 | # like pdb depend on their existence, so let's set them. If we |
|
1271 | # like pdb depend on their existence, so let's set them. If we | |
1272 | # find problems in the field, we'll need to revisit their use. |
|
1272 | # find problems in the field, we'll need to revisit their use. | |
1273 | sys.last_type = etype |
|
1273 | sys.last_type = etype | |
1274 | sys.last_value = value |
|
1274 | sys.last_value = value | |
1275 | sys.last_traceback = tb |
|
1275 | sys.last_traceback = tb | |
1276 |
|
1276 | |||
1277 | if etype in self.custom_exceptions: |
|
1277 | if etype in self.custom_exceptions: | |
1278 | self.CustomTB(etype,value,tb) |
|
1278 | self.CustomTB(etype,value,tb) | |
1279 | else: |
|
1279 | else: | |
1280 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) |
|
1280 | self.InteractiveTB(etype,value,tb,tb_offset=tb_offset) | |
1281 | if self.InteractiveTB.call_pdb and self.has_readline: |
|
1281 | if self.InteractiveTB.call_pdb and self.has_readline: | |
1282 | # pdb mucks up readline, fix it back |
|
1282 | # pdb mucks up readline, fix it back | |
1283 | self.set_completer() |
|
1283 | self.set_completer() | |
1284 | except KeyboardInterrupt: |
|
1284 | except KeyboardInterrupt: | |
1285 | self.write("\nKeyboardInterrupt\n") |
|
1285 | self.write("\nKeyboardInterrupt\n") | |
1286 |
|
1286 | |||
1287 | def showsyntaxerror(self, filename=None): |
|
1287 | def showsyntaxerror(self, filename=None): | |
1288 | """Display the syntax error that just occurred. |
|
1288 | """Display the syntax error that just occurred. | |
1289 |
|
1289 | |||
1290 | This doesn't display a stack trace because there isn't one. |
|
1290 | This doesn't display a stack trace because there isn't one. | |
1291 |
|
1291 | |||
1292 | If a filename is given, it is stuffed in the exception instead |
|
1292 | If a filename is given, it is stuffed in the exception instead | |
1293 | of what was there before (because Python's parser always uses |
|
1293 | of what was there before (because Python's parser always uses | |
1294 | "<string>" when reading from a string). |
|
1294 | "<string>" when reading from a string). | |
1295 | """ |
|
1295 | """ | |
1296 | etype, value, last_traceback = sys.exc_info() |
|
1296 | etype, value, last_traceback = sys.exc_info() | |
1297 |
|
1297 | |||
1298 | # See note about these variables in showtraceback() below |
|
1298 | # See note about these variables in showtraceback() below | |
1299 | sys.last_type = etype |
|
1299 | sys.last_type = etype | |
1300 | sys.last_value = value |
|
1300 | sys.last_value = value | |
1301 | sys.last_traceback = last_traceback |
|
1301 | sys.last_traceback = last_traceback | |
1302 |
|
1302 | |||
1303 | if filename and etype is SyntaxError: |
|
1303 | if filename and etype is SyntaxError: | |
1304 | # Work hard to stuff the correct filename in the exception |
|
1304 | # Work hard to stuff the correct filename in the exception | |
1305 | try: |
|
1305 | try: | |
1306 | msg, (dummy_filename, lineno, offset, line) = value |
|
1306 | msg, (dummy_filename, lineno, offset, line) = value | |
1307 | except: |
|
1307 | except: | |
1308 | # Not the format we expect; leave it alone |
|
1308 | # Not the format we expect; leave it alone | |
1309 | pass |
|
1309 | pass | |
1310 | else: |
|
1310 | else: | |
1311 | # Stuff in the right filename |
|
1311 | # Stuff in the right filename | |
1312 | try: |
|
1312 | try: | |
1313 | # Assume SyntaxError is a class exception |
|
1313 | # Assume SyntaxError is a class exception | |
1314 | value = SyntaxError(msg, (filename, lineno, offset, line)) |
|
1314 | value = SyntaxError(msg, (filename, lineno, offset, line)) | |
1315 | except: |
|
1315 | except: | |
1316 | # If that failed, assume SyntaxError is a string |
|
1316 | # If that failed, assume SyntaxError is a string | |
1317 | value = msg, (filename, lineno, offset, line) |
|
1317 | value = msg, (filename, lineno, offset, line) | |
1318 | self.SyntaxTB(etype,value,[]) |
|
1318 | self.SyntaxTB(etype,value,[]) | |
1319 |
|
1319 | |||
1320 | def edit_syntax_error(self): |
|
1320 | def edit_syntax_error(self): | |
1321 | """The bottom half of the syntax error handler called in the main loop. |
|
1321 | """The bottom half of the syntax error handler called in the main loop. | |
1322 |
|
1322 | |||
1323 | Loop until syntax error is fixed or user cancels. |
|
1323 | Loop until syntax error is fixed or user cancels. | |
1324 | """ |
|
1324 | """ | |
1325 |
|
1325 | |||
1326 | while self.SyntaxTB.last_syntax_error: |
|
1326 | while self.SyntaxTB.last_syntax_error: | |
1327 | # copy and clear last_syntax_error |
|
1327 | # copy and clear last_syntax_error | |
1328 | err = self.SyntaxTB.clear_err_state() |
|
1328 | err = self.SyntaxTB.clear_err_state() | |
1329 | if not self._should_recompile(err): |
|
1329 | if not self._should_recompile(err): | |
1330 | return |
|
1330 | return | |
1331 | try: |
|
1331 | try: | |
1332 | # may set last_syntax_error again if a SyntaxError is raised |
|
1332 | # may set last_syntax_error again if a SyntaxError is raised | |
1333 | self.safe_execfile(err.filename,self.user_ns) |
|
1333 | self.safe_execfile(err.filename,self.user_ns) | |
1334 | except: |
|
1334 | except: | |
1335 | self.showtraceback() |
|
1335 | self.showtraceback() | |
1336 | else: |
|
1336 | else: | |
1337 | try: |
|
1337 | try: | |
1338 | f = file(err.filename) |
|
1338 | f = file(err.filename) | |
1339 | try: |
|
1339 | try: | |
1340 | # This should be inside a display_trap block and I |
|
1340 | # This should be inside a display_trap block and I | |
1341 | # think it is. |
|
1341 | # think it is. | |
1342 | sys.displayhook(f.read()) |
|
1342 | sys.displayhook(f.read()) | |
1343 | finally: |
|
1343 | finally: | |
1344 | f.close() |
|
1344 | f.close() | |
1345 | except: |
|
1345 | except: | |
1346 | self.showtraceback() |
|
1346 | self.showtraceback() | |
1347 |
|
1347 | |||
1348 | def _should_recompile(self,e): |
|
1348 | def _should_recompile(self,e): | |
1349 | """Utility routine for edit_syntax_error""" |
|
1349 | """Utility routine for edit_syntax_error""" | |
1350 |
|
1350 | |||
1351 | if e.filename in ('<ipython console>','<input>','<string>', |
|
1351 | if e.filename in ('<ipython console>','<input>','<string>', | |
1352 | '<console>','<BackgroundJob compilation>', |
|
1352 | '<console>','<BackgroundJob compilation>', | |
1353 | None): |
|
1353 | None): | |
1354 |
|
1354 | |||
1355 | return False |
|
1355 | return False | |
1356 | try: |
|
1356 | try: | |
1357 | if (self.autoedit_syntax and |
|
1357 | if (self.autoedit_syntax and | |
1358 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
1358 | not self.ask_yes_no('Return to editor to correct syntax error? ' | |
1359 | '[Y/n] ','y')): |
|
1359 | '[Y/n] ','y')): | |
1360 | return False |
|
1360 | return False | |
1361 | except EOFError: |
|
1361 | except EOFError: | |
1362 | return False |
|
1362 | return False | |
1363 |
|
1363 | |||
1364 | def int0(x): |
|
1364 | def int0(x): | |
1365 | try: |
|
1365 | try: | |
1366 | return int(x) |
|
1366 | return int(x) | |
1367 | except TypeError: |
|
1367 | except TypeError: | |
1368 | return 0 |
|
1368 | return 0 | |
1369 | # always pass integer line and offset values to editor hook |
|
1369 | # always pass integer line and offset values to editor hook | |
1370 | try: |
|
1370 | try: | |
1371 | self.hooks.fix_error_editor(e.filename, |
|
1371 | self.hooks.fix_error_editor(e.filename, | |
1372 | int0(e.lineno),int0(e.offset),e.msg) |
|
1372 | int0(e.lineno),int0(e.offset),e.msg) | |
1373 | except TryNext: |
|
1373 | except TryNext: | |
1374 | warn('Could not open editor') |
|
1374 | warn('Could not open editor') | |
1375 | return False |
|
1375 | return False | |
1376 | return True |
|
1376 | return True | |
1377 |
|
1377 | |||
1378 | #------------------------------------------------------------------------- |
|
1378 | #------------------------------------------------------------------------- | |
1379 | # Things related to tab completion |
|
1379 | # Things related to tab completion | |
1380 | #------------------------------------------------------------------------- |
|
1380 | #------------------------------------------------------------------------- | |
1381 |
|
1381 | |||
1382 | def complete(self, text): |
|
1382 | def complete(self, text): | |
1383 | """Return a sorted list of all possible completions on text. |
|
1383 | """Return a sorted list of all possible completions on text. | |
1384 |
|
1384 | |||
1385 | Inputs: |
|
1385 | Inputs: | |
1386 |
|
1386 | |||
1387 | - text: a string of text to be completed on. |
|
1387 | - text: a string of text to be completed on. | |
1388 |
|
1388 | |||
1389 | This is a wrapper around the completion mechanism, similar to what |
|
1389 | This is a wrapper around the completion mechanism, similar to what | |
1390 | readline does at the command line when the TAB key is hit. By |
|
1390 | readline does at the command line when the TAB key is hit. By | |
1391 | exposing it as a method, it can be used by other non-readline |
|
1391 | exposing it as a method, it can be used by other non-readline | |
1392 | environments (such as GUIs) for text completion. |
|
1392 | environments (such as GUIs) for text completion. | |
1393 |
|
1393 | |||
1394 | Simple usage example: |
|
1394 | Simple usage example: | |
1395 |
|
1395 | |||
1396 | In [7]: x = 'hello' |
|
1396 | In [7]: x = 'hello' | |
1397 |
|
1397 | |||
1398 | In [8]: x |
|
1398 | In [8]: x | |
1399 | Out[8]: 'hello' |
|
1399 | Out[8]: 'hello' | |
1400 |
|
1400 | |||
1401 | In [9]: print x |
|
1401 | In [9]: print x | |
1402 | hello |
|
1402 | hello | |
1403 |
|
1403 | |||
1404 | In [10]: _ip.complete('x.l') |
|
1404 | In [10]: _ip.complete('x.l') | |
1405 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] |
|
1405 | Out[10]: ['x.ljust', 'x.lower', 'x.lstrip'] | |
1406 | """ |
|
1406 | """ | |
1407 |
|
1407 | |||
1408 | # Inject names into __builtin__ so we can complete on the added names. |
|
1408 | # Inject names into __builtin__ so we can complete on the added names. | |
1409 | with self.builtin_trap: |
|
1409 | with self.builtin_trap: | |
1410 | complete = self.Completer.complete |
|
1410 | complete = self.Completer.complete | |
1411 | state = 0 |
|
1411 | state = 0 | |
1412 | # use a dict so we get unique keys, since ipyhton's multiple |
|
1412 | # use a dict so we get unique keys, since ipyhton's multiple | |
1413 | # completers can return duplicates. When we make 2.4 a requirement, |
|
1413 | # completers can return duplicates. When we make 2.4 a requirement, | |
1414 | # start using sets instead, which are faster. |
|
1414 | # start using sets instead, which are faster. | |
1415 | comps = {} |
|
1415 | comps = {} | |
1416 | while True: |
|
1416 | while True: | |
1417 | newcomp = complete(text,state,line_buffer=text) |
|
1417 | newcomp = complete(text,state,line_buffer=text) | |
1418 | if newcomp is None: |
|
1418 | if newcomp is None: | |
1419 | break |
|
1419 | break | |
1420 | comps[newcomp] = 1 |
|
1420 | comps[newcomp] = 1 | |
1421 | state += 1 |
|
1421 | state += 1 | |
1422 | outcomps = comps.keys() |
|
1422 | outcomps = comps.keys() | |
1423 | outcomps.sort() |
|
1423 | outcomps.sort() | |
1424 | #print "T:",text,"OC:",outcomps # dbg |
|
1424 | #print "T:",text,"OC:",outcomps # dbg | |
1425 | #print "vars:",self.user_ns.keys() |
|
1425 | #print "vars:",self.user_ns.keys() | |
1426 | return outcomps |
|
1426 | return outcomps | |
1427 |
|
1427 | |||
1428 | def set_custom_completer(self,completer,pos=0): |
|
1428 | def set_custom_completer(self,completer,pos=0): | |
1429 | """set_custom_completer(completer,pos=0) |
|
1429 | """set_custom_completer(completer,pos=0) | |
1430 |
|
1430 | |||
1431 | Adds a new custom completer function. |
|
1431 | Adds a new custom completer function. | |
1432 |
|
1432 | |||
1433 | The position argument (defaults to 0) is the index in the completers |
|
1433 | The position argument (defaults to 0) is the index in the completers | |
1434 | list where you want the completer to be inserted.""" |
|
1434 | list where you want the completer to be inserted.""" | |
1435 |
|
1435 | |||
1436 | newcomp = new.instancemethod(completer,self.Completer, |
|
1436 | newcomp = new.instancemethod(completer,self.Completer, | |
1437 | self.Completer.__class__) |
|
1437 | self.Completer.__class__) | |
1438 | self.Completer.matchers.insert(pos,newcomp) |
|
1438 | self.Completer.matchers.insert(pos,newcomp) | |
1439 |
|
1439 | |||
1440 | def set_completer(self): |
|
1440 | def set_completer(self): | |
1441 | """reset readline's completer to be our own.""" |
|
1441 | """reset readline's completer to be our own.""" | |
1442 | self.readline.set_completer(self.Completer.complete) |
|
1442 | self.readline.set_completer(self.Completer.complete) | |
1443 |
|
1443 | |||
1444 | #------------------------------------------------------------------------- |
|
1444 | #------------------------------------------------------------------------- | |
1445 | # Things related to readline |
|
1445 | # Things related to readline | |
1446 | #------------------------------------------------------------------------- |
|
1446 | #------------------------------------------------------------------------- | |
1447 |
|
1447 | |||
1448 | def init_readline(self): |
|
1448 | def init_readline(self): | |
1449 | """Command history completion/saving/reloading.""" |
|
1449 | """Command history completion/saving/reloading.""" | |
1450 |
|
1450 | |||
1451 | self.rl_next_input = None |
|
1451 | self.rl_next_input = None | |
1452 | self.rl_do_indent = False |
|
1452 | self.rl_do_indent = False | |
1453 |
|
1453 | |||
1454 | if not self.readline_use: |
|
1454 | if not self.readline_use: | |
1455 | return |
|
1455 | return | |
1456 |
|
1456 | |||
1457 | import IPython.utils.rlineimpl as readline |
|
1457 | import IPython.utils.rlineimpl as readline | |
1458 |
|
1458 | |||
1459 | if not readline.have_readline: |
|
1459 | if not readline.have_readline: | |
1460 | self.has_readline = 0 |
|
1460 | self.has_readline = 0 | |
1461 | self.readline = None |
|
1461 | self.readline = None | |
1462 | # no point in bugging windows users with this every time: |
|
1462 | # no point in bugging windows users with this every time: | |
1463 | warn('Readline services not available on this platform.') |
|
1463 | warn('Readline services not available on this platform.') | |
1464 | else: |
|
1464 | else: | |
1465 | sys.modules['readline'] = readline |
|
1465 | sys.modules['readline'] = readline | |
1466 | import atexit |
|
1466 | import atexit | |
1467 | from IPython.core.completer import IPCompleter |
|
1467 | from IPython.core.completer import IPCompleter | |
1468 | self.Completer = IPCompleter(self, |
|
1468 | self.Completer = IPCompleter(self, | |
1469 | self.user_ns, |
|
1469 | self.user_ns, | |
1470 | self.user_global_ns, |
|
1470 | self.user_global_ns, | |
1471 | self.readline_omit__names, |
|
1471 | self.readline_omit__names, | |
1472 | self.alias_manager.alias_table) |
|
1472 | self.alias_manager.alias_table) | |
1473 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1473 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1474 | self.strdispatchers['complete_command'] = sdisp |
|
1474 | self.strdispatchers['complete_command'] = sdisp | |
1475 | self.Completer.custom_completers = sdisp |
|
1475 | self.Completer.custom_completers = sdisp | |
1476 | # Platform-specific configuration |
|
1476 | # Platform-specific configuration | |
1477 | if os.name == 'nt': |
|
1477 | if os.name == 'nt': | |
1478 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1478 | self.readline_startup_hook = readline.set_pre_input_hook | |
1479 | else: |
|
1479 | else: | |
1480 | self.readline_startup_hook = readline.set_startup_hook |
|
1480 | self.readline_startup_hook = readline.set_startup_hook | |
1481 |
|
1481 | |||
1482 | # Load user's initrc file (readline config) |
|
1482 | # Load user's initrc file (readline config) | |
1483 | # Or if libedit is used, load editrc. |
|
1483 | # Or if libedit is used, load editrc. | |
1484 | inputrc_name = os.environ.get('INPUTRC') |
|
1484 | inputrc_name = os.environ.get('INPUTRC') | |
1485 | if inputrc_name is None: |
|
1485 | if inputrc_name is None: | |
1486 | home_dir = get_home_dir() |
|
1486 | home_dir = get_home_dir() | |
1487 | if home_dir is not None: |
|
1487 | if home_dir is not None: | |
1488 | inputrc_name = '.inputrc' |
|
1488 | inputrc_name = '.inputrc' | |
1489 | if readline.uses_libedit: |
|
1489 | if readline.uses_libedit: | |
1490 | inputrc_name = '.editrc' |
|
1490 | inputrc_name = '.editrc' | |
1491 | inputrc_name = os.path.join(home_dir, inputrc_name) |
|
1491 | inputrc_name = os.path.join(home_dir, inputrc_name) | |
1492 | if os.path.isfile(inputrc_name): |
|
1492 | if os.path.isfile(inputrc_name): | |
1493 | try: |
|
1493 | try: | |
1494 | readline.read_init_file(inputrc_name) |
|
1494 | readline.read_init_file(inputrc_name) | |
1495 | except: |
|
1495 | except: | |
1496 | warn('Problems reading readline initialization file <%s>' |
|
1496 | warn('Problems reading readline initialization file <%s>' | |
1497 | % inputrc_name) |
|
1497 | % inputrc_name) | |
1498 |
|
1498 | |||
1499 | self.has_readline = 1 |
|
1499 | self.has_readline = 1 | |
1500 | self.readline = readline |
|
1500 | self.readline = readline | |
1501 | # save this in sys so embedded copies can restore it properly |
|
1501 | # save this in sys so embedded copies can restore it properly | |
1502 | sys.ipcompleter = self.Completer.complete |
|
1502 | sys.ipcompleter = self.Completer.complete | |
1503 | self.set_completer() |
|
1503 | self.set_completer() | |
1504 |
|
1504 | |||
1505 | # Configure readline according to user's prefs |
|
1505 | # Configure readline according to user's prefs | |
1506 | # This is only done if GNU readline is being used. If libedit |
|
1506 | # This is only done if GNU readline is being used. If libedit | |
1507 | # is being used (as on Leopard) the readline config is |
|
1507 | # is being used (as on Leopard) the readline config is | |
1508 | # not run as the syntax for libedit is different. |
|
1508 | # not run as the syntax for libedit is different. | |
1509 | if not readline.uses_libedit: |
|
1509 | if not readline.uses_libedit: | |
1510 | for rlcommand in self.readline_parse_and_bind: |
|
1510 | for rlcommand in self.readline_parse_and_bind: | |
1511 | #print "loading rl:",rlcommand # dbg |
|
1511 | #print "loading rl:",rlcommand # dbg | |
1512 | readline.parse_and_bind(rlcommand) |
|
1512 | readline.parse_and_bind(rlcommand) | |
1513 |
|
1513 | |||
1514 | # Remove some chars from the delimiters list. If we encounter |
|
1514 | # Remove some chars from the delimiters list. If we encounter | |
1515 | # unicode chars, discard them. |
|
1515 | # unicode chars, discard them. | |
1516 | delims = readline.get_completer_delims().encode("ascii", "ignore") |
|
1516 | delims = readline.get_completer_delims().encode("ascii", "ignore") | |
1517 | delims = delims.translate(string._idmap, |
|
1517 | delims = delims.translate(string._idmap, | |
1518 | self.readline_remove_delims) |
|
1518 | self.readline_remove_delims) | |
1519 | readline.set_completer_delims(delims) |
|
1519 | readline.set_completer_delims(delims) | |
1520 | # otherwise we end up with a monster history after a while: |
|
1520 | # otherwise we end up with a monster history after a while: | |
1521 | readline.set_history_length(1000) |
|
1521 | readline.set_history_length(1000) | |
1522 | try: |
|
1522 | try: | |
1523 | #print '*** Reading readline history' # dbg |
|
1523 | #print '*** Reading readline history' # dbg | |
1524 | readline.read_history_file(self.histfile) |
|
1524 | readline.read_history_file(self.histfile) | |
1525 | except IOError: |
|
1525 | except IOError: | |
1526 | pass # It doesn't exist yet. |
|
1526 | pass # It doesn't exist yet. | |
1527 |
|
1527 | |||
1528 | atexit.register(self.atexit_operations) |
|
1528 | atexit.register(self.atexit_operations) | |
1529 | del atexit |
|
1529 | del atexit | |
1530 |
|
1530 | |||
1531 | # Configure auto-indent for all platforms |
|
1531 | # Configure auto-indent for all platforms | |
1532 | self.set_autoindent(self.autoindent) |
|
1532 | self.set_autoindent(self.autoindent) | |
1533 |
|
1533 | |||
1534 | def set_next_input(self, s): |
|
1534 | def set_next_input(self, s): | |
1535 | """ Sets the 'default' input string for the next command line. |
|
1535 | """ Sets the 'default' input string for the next command line. | |
1536 |
|
1536 | |||
1537 | Requires readline. |
|
1537 | Requires readline. | |
1538 |
|
1538 | |||
1539 | Example: |
|
1539 | Example: | |
1540 |
|
1540 | |||
1541 | [D:\ipython]|1> _ip.set_next_input("Hello Word") |
|
1541 | [D:\ipython]|1> _ip.set_next_input("Hello Word") | |
1542 | [D:\ipython]|2> Hello Word_ # cursor is here |
|
1542 | [D:\ipython]|2> Hello Word_ # cursor is here | |
1543 | """ |
|
1543 | """ | |
1544 |
|
1544 | |||
1545 | self.rl_next_input = s |
|
1545 | self.rl_next_input = s | |
1546 |
|
1546 | |||
1547 | def pre_readline(self): |
|
1547 | def pre_readline(self): | |
1548 | """readline hook to be used at the start of each line. |
|
1548 | """readline hook to be used at the start of each line. | |
1549 |
|
1549 | |||
1550 | Currently it handles auto-indent only.""" |
|
1550 | Currently it handles auto-indent only.""" | |
1551 |
|
1551 | |||
1552 | #debugx('self.indent_current_nsp','pre_readline:') |
|
1552 | #debugx('self.indent_current_nsp','pre_readline:') | |
1553 |
|
1553 | |||
1554 | if self.rl_do_indent: |
|
1554 | if self.rl_do_indent: | |
1555 | self.readline.insert_text(self._indent_current_str()) |
|
1555 | self.readline.insert_text(self._indent_current_str()) | |
1556 | if self.rl_next_input is not None: |
|
1556 | if self.rl_next_input is not None: | |
1557 | self.readline.insert_text(self.rl_next_input) |
|
1557 | self.readline.insert_text(self.rl_next_input) | |
1558 | self.rl_next_input = None |
|
1558 | self.rl_next_input = None | |
1559 |
|
1559 | |||
1560 | def _indent_current_str(self): |
|
1560 | def _indent_current_str(self): | |
1561 | """return the current level of indentation as a string""" |
|
1561 | """return the current level of indentation as a string""" | |
1562 | return self.indent_current_nsp * ' ' |
|
1562 | return self.indent_current_nsp * ' ' | |
1563 |
|
1563 | |||
1564 | #------------------------------------------------------------------------- |
|
1564 | #------------------------------------------------------------------------- | |
1565 | # Things related to magics |
|
1565 | # Things related to magics | |
1566 | #------------------------------------------------------------------------- |
|
1566 | #------------------------------------------------------------------------- | |
1567 |
|
1567 | |||
1568 | def init_magics(self): |
|
1568 | def init_magics(self): | |
1569 | # Set user colors (don't do it in the constructor above so that it |
|
1569 | # Set user colors (don't do it in the constructor above so that it | |
1570 | # doesn't crash if colors option is invalid) |
|
1570 | # doesn't crash if colors option is invalid) | |
1571 | self.magic_colors(self.colors) |
|
1571 | self.magic_colors(self.colors) | |
1572 |
|
1572 | |||
1573 | def magic(self,arg_s): |
|
1573 | def magic(self,arg_s): | |
1574 | """Call a magic function by name. |
|
1574 | """Call a magic function by name. | |
1575 |
|
1575 | |||
1576 | Input: a string containing the name of the magic function to call and any |
|
1576 | Input: a string containing the name of the magic function to call and any | |
1577 | additional arguments to be passed to the magic. |
|
1577 | additional arguments to be passed to the magic. | |
1578 |
|
1578 | |||
1579 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
1579 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
1580 | prompt: |
|
1580 | prompt: | |
1581 |
|
1581 | |||
1582 | In[1]: %name -opt foo bar |
|
1582 | In[1]: %name -opt foo bar | |
1583 |
|
1583 | |||
1584 | To call a magic without arguments, simply use magic('name'). |
|
1584 | To call a magic without arguments, simply use magic('name'). | |
1585 |
|
1585 | |||
1586 | This provides a proper Python function to call IPython's magics in any |
|
1586 | This provides a proper Python function to call IPython's magics in any | |
1587 | valid Python code you can type at the interpreter, including loops and |
|
1587 | valid Python code you can type at the interpreter, including loops and | |
1588 | compound statements. |
|
1588 | compound statements. | |
1589 | """ |
|
1589 | """ | |
1590 |
|
1590 | |||
1591 | args = arg_s.split(' ',1) |
|
1591 | args = arg_s.split(' ',1) | |
1592 | magic_name = args[0] |
|
1592 | magic_name = args[0] | |
1593 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
1593 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
1594 |
|
1594 | |||
1595 | try: |
|
1595 | try: | |
1596 | magic_args = args[1] |
|
1596 | magic_args = args[1] | |
1597 | except IndexError: |
|
1597 | except IndexError: | |
1598 | magic_args = '' |
|
1598 | magic_args = '' | |
1599 | fn = getattr(self,'magic_'+magic_name,None) |
|
1599 | fn = getattr(self,'magic_'+magic_name,None) | |
1600 | if fn is None: |
|
1600 | if fn is None: | |
1601 | error("Magic function `%s` not found." % magic_name) |
|
1601 | error("Magic function `%s` not found." % magic_name) | |
1602 | else: |
|
1602 | else: | |
1603 | magic_args = self.var_expand(magic_args,1) |
|
1603 | magic_args = self.var_expand(magic_args,1) | |
1604 | with nested(self.builtin_trap,): |
|
1604 | with nested(self.builtin_trap,): | |
1605 |
re |
|
1605 | return fn(magic_args) | |
1606 | # Unfortunately, the return statement is what will trigger |
|
1606 | # Unfortunately, the return statement is what will trigger | |
1607 | # the displayhook, but it is no longer set! |
|
1607 | # the displayhook, but it is no longer set! | |
1608 | return result |
|
1608 | # return result | |
1609 |
|
1609 | |||
1610 | def define_magic(self, magicname, func): |
|
1610 | def define_magic(self, magicname, func): | |
1611 | """Expose own function as magic function for ipython |
|
1611 | """Expose own function as magic function for ipython | |
1612 |
|
1612 | |||
1613 | def foo_impl(self,parameter_s=''): |
|
1613 | def foo_impl(self,parameter_s=''): | |
1614 | 'My very own magic!. (Use docstrings, IPython reads them).' |
|
1614 | 'My very own magic!. (Use docstrings, IPython reads them).' | |
1615 | print 'Magic function. Passed parameter is between < >:' |
|
1615 | print 'Magic function. Passed parameter is between < >:' | |
1616 | print '<%s>' % parameter_s |
|
1616 | print '<%s>' % parameter_s | |
1617 | print 'The self object is:',self |
|
1617 | print 'The self object is:',self | |
1618 |
|
1618 | |||
1619 | self.define_magic('foo',foo_impl) |
|
1619 | self.define_magic('foo',foo_impl) | |
1620 | """ |
|
1620 | """ | |
1621 |
|
1621 | |||
1622 | import new |
|
1622 | import new | |
1623 | im = new.instancemethod(func,self, self.__class__) |
|
1623 | im = new.instancemethod(func,self, self.__class__) | |
1624 | old = getattr(self, "magic_" + magicname, None) |
|
1624 | old = getattr(self, "magic_" + magicname, None) | |
1625 | setattr(self, "magic_" + magicname, im) |
|
1625 | setattr(self, "magic_" + magicname, im) | |
1626 | return old |
|
1626 | return old | |
1627 |
|
1627 | |||
1628 | #------------------------------------------------------------------------- |
|
1628 | #------------------------------------------------------------------------- | |
1629 | # Things related to macros |
|
1629 | # Things related to macros | |
1630 | #------------------------------------------------------------------------- |
|
1630 | #------------------------------------------------------------------------- | |
1631 |
|
1631 | |||
1632 | def define_macro(self, name, themacro): |
|
1632 | def define_macro(self, name, themacro): | |
1633 | """Define a new macro |
|
1633 | """Define a new macro | |
1634 |
|
1634 | |||
1635 | Parameters |
|
1635 | Parameters | |
1636 | ---------- |
|
1636 | ---------- | |
1637 | name : str |
|
1637 | name : str | |
1638 | The name of the macro. |
|
1638 | The name of the macro. | |
1639 | themacro : str or Macro |
|
1639 | themacro : str or Macro | |
1640 | The action to do upon invoking the macro. If a string, a new |
|
1640 | The action to do upon invoking the macro. If a string, a new | |
1641 | Macro object is created by passing the string to it. |
|
1641 | Macro object is created by passing the string to it. | |
1642 | """ |
|
1642 | """ | |
1643 |
|
1643 | |||
1644 | from IPython.core import macro |
|
1644 | from IPython.core import macro | |
1645 |
|
1645 | |||
1646 | if isinstance(themacro, basestring): |
|
1646 | if isinstance(themacro, basestring): | |
1647 | themacro = macro.Macro(themacro) |
|
1647 | themacro = macro.Macro(themacro) | |
1648 | if not isinstance(themacro, macro.Macro): |
|
1648 | if not isinstance(themacro, macro.Macro): | |
1649 | raise ValueError('A macro must be a string or a Macro instance.') |
|
1649 | raise ValueError('A macro must be a string or a Macro instance.') | |
1650 | self.user_ns[name] = themacro |
|
1650 | self.user_ns[name] = themacro | |
1651 |
|
1651 | |||
1652 | #------------------------------------------------------------------------- |
|
1652 | #------------------------------------------------------------------------- | |
1653 | # Things related to the running of system commands |
|
1653 | # Things related to the running of system commands | |
1654 | #------------------------------------------------------------------------- |
|
1654 | #------------------------------------------------------------------------- | |
1655 |
|
1655 | |||
1656 | def system(self, cmd): |
|
1656 | def system(self, cmd): | |
1657 | """Make a system call, using IPython.""" |
|
1657 | """Make a system call, using IPython.""" | |
1658 | return self.hooks.shell_hook(self.var_expand(cmd, depth=2)) |
|
1658 | return self.hooks.shell_hook(self.var_expand(cmd, depth=2)) | |
1659 |
|
1659 | |||
1660 | #------------------------------------------------------------------------- |
|
1660 | #------------------------------------------------------------------------- | |
1661 | # Things related to aliases |
|
1661 | # Things related to aliases | |
1662 | #------------------------------------------------------------------------- |
|
1662 | #------------------------------------------------------------------------- | |
1663 |
|
1663 | |||
1664 | def init_alias(self): |
|
1664 | def init_alias(self): | |
1665 | self.alias_manager = AliasManager(self, config=self.config) |
|
1665 | self.alias_manager = AliasManager(self, config=self.config) | |
1666 | self.ns_table['alias'] = self.alias_manager.alias_table, |
|
1666 | self.ns_table['alias'] = self.alias_manager.alias_table, | |
1667 |
|
1667 | |||
1668 | #------------------------------------------------------------------------- |
|
1668 | #------------------------------------------------------------------------- | |
1669 | # Things related to the running of code |
|
1669 | # Things related to the running of code | |
1670 | #------------------------------------------------------------------------- |
|
1670 | #------------------------------------------------------------------------- | |
1671 |
|
1671 | |||
1672 | def ex(self, cmd): |
|
1672 | def ex(self, cmd): | |
1673 | """Execute a normal python statement in user namespace.""" |
|
1673 | """Execute a normal python statement in user namespace.""" | |
1674 | with nested(self.builtin_trap,): |
|
1674 | with nested(self.builtin_trap,): | |
1675 | exec cmd in self.user_global_ns, self.user_ns |
|
1675 | exec cmd in self.user_global_ns, self.user_ns | |
1676 |
|
1676 | |||
1677 | def ev(self, expr): |
|
1677 | def ev(self, expr): | |
1678 | """Evaluate python expression expr in user namespace. |
|
1678 | """Evaluate python expression expr in user namespace. | |
1679 |
|
1679 | |||
1680 | Returns the result of evaluation |
|
1680 | Returns the result of evaluation | |
1681 | """ |
|
1681 | """ | |
1682 | with nested(self.builtin_trap,): |
|
1682 | with nested(self.builtin_trap,): | |
1683 | return eval(expr, self.user_global_ns, self.user_ns) |
|
1683 | return eval(expr, self.user_global_ns, self.user_ns) | |
1684 |
|
1684 | |||
1685 | def mainloop(self, display_banner=None): |
|
1685 | def mainloop(self, display_banner=None): | |
1686 | """Start the mainloop. |
|
1686 | """Start the mainloop. | |
1687 |
|
1687 | |||
1688 | If an optional banner argument is given, it will override the |
|
1688 | If an optional banner argument is given, it will override the | |
1689 | internally created default banner. |
|
1689 | internally created default banner. | |
1690 | """ |
|
1690 | """ | |
1691 |
|
1691 | |||
1692 | with nested(self.builtin_trap, self.display_trap): |
|
1692 | with nested(self.builtin_trap, self.display_trap): | |
1693 |
|
1693 | |||
1694 | # if you run stuff with -c <cmd>, raw hist is not updated |
|
1694 | # if you run stuff with -c <cmd>, raw hist is not updated | |
1695 | # ensure that it's in sync |
|
1695 | # ensure that it's in sync | |
1696 | if len(self.input_hist) != len (self.input_hist_raw): |
|
1696 | if len(self.input_hist) != len (self.input_hist_raw): | |
1697 | self.input_hist_raw = InputList(self.input_hist) |
|
1697 | self.input_hist_raw = InputList(self.input_hist) | |
1698 |
|
1698 | |||
1699 | while 1: |
|
1699 | while 1: | |
1700 | try: |
|
1700 | try: | |
1701 | self.interact(display_banner=display_banner) |
|
1701 | self.interact(display_banner=display_banner) | |
1702 | #self.interact_with_readline() |
|
1702 | #self.interact_with_readline() | |
1703 | # XXX for testing of a readline-decoupled repl loop, call |
|
1703 | # XXX for testing of a readline-decoupled repl loop, call | |
1704 | # interact_with_readline above |
|
1704 | # interact_with_readline above | |
1705 | break |
|
1705 | break | |
1706 | except KeyboardInterrupt: |
|
1706 | except KeyboardInterrupt: | |
1707 | # this should not be necessary, but KeyboardInterrupt |
|
1707 | # this should not be necessary, but KeyboardInterrupt | |
1708 | # handling seems rather unpredictable... |
|
1708 | # handling seems rather unpredictable... | |
1709 | self.write("\nKeyboardInterrupt in interact()\n") |
|
1709 | self.write("\nKeyboardInterrupt in interact()\n") | |
1710 |
|
1710 | |||
1711 | def interact_prompt(self): |
|
1711 | def interact_prompt(self): | |
1712 | """ Print the prompt (in read-eval-print loop) |
|
1712 | """ Print the prompt (in read-eval-print loop) | |
1713 |
|
1713 | |||
1714 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1714 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1715 | used in standard IPython flow. |
|
1715 | used in standard IPython flow. | |
1716 | """ |
|
1716 | """ | |
1717 | if self.more: |
|
1717 | if self.more: | |
1718 | try: |
|
1718 | try: | |
1719 | prompt = self.hooks.generate_prompt(True) |
|
1719 | prompt = self.hooks.generate_prompt(True) | |
1720 | except: |
|
1720 | except: | |
1721 | self.showtraceback() |
|
1721 | self.showtraceback() | |
1722 | if self.autoindent: |
|
1722 | if self.autoindent: | |
1723 | self.rl_do_indent = True |
|
1723 | self.rl_do_indent = True | |
1724 |
|
1724 | |||
1725 | else: |
|
1725 | else: | |
1726 | try: |
|
1726 | try: | |
1727 | prompt = self.hooks.generate_prompt(False) |
|
1727 | prompt = self.hooks.generate_prompt(False) | |
1728 | except: |
|
1728 | except: | |
1729 | self.showtraceback() |
|
1729 | self.showtraceback() | |
1730 | self.write(prompt) |
|
1730 | self.write(prompt) | |
1731 |
|
1731 | |||
1732 | def interact_handle_input(self,line): |
|
1732 | def interact_handle_input(self,line): | |
1733 | """ Handle the input line (in read-eval-print loop) |
|
1733 | """ Handle the input line (in read-eval-print loop) | |
1734 |
|
1734 | |||
1735 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not |
|
1735 | Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not | |
1736 | used in standard IPython flow. |
|
1736 | used in standard IPython flow. | |
1737 | """ |
|
1737 | """ | |
1738 | if line.lstrip() == line: |
|
1738 | if line.lstrip() == line: | |
1739 | self.shadowhist.add(line.strip()) |
|
1739 | self.shadowhist.add(line.strip()) | |
1740 | lineout = self.prefilter_manager.prefilter_lines(line,self.more) |
|
1740 | lineout = self.prefilter_manager.prefilter_lines(line,self.more) | |
1741 |
|
1741 | |||
1742 | if line.strip(): |
|
1742 | if line.strip(): | |
1743 | if self.more: |
|
1743 | if self.more: | |
1744 | self.input_hist_raw[-1] += '%s\n' % line |
|
1744 | self.input_hist_raw[-1] += '%s\n' % line | |
1745 | else: |
|
1745 | else: | |
1746 | self.input_hist_raw.append('%s\n' % line) |
|
1746 | self.input_hist_raw.append('%s\n' % line) | |
1747 |
|
1747 | |||
1748 |
|
1748 | |||
1749 | self.more = self.push_line(lineout) |
|
1749 | self.more = self.push_line(lineout) | |
1750 | if (self.SyntaxTB.last_syntax_error and |
|
1750 | if (self.SyntaxTB.last_syntax_error and | |
1751 | self.autoedit_syntax): |
|
1751 | self.autoedit_syntax): | |
1752 | self.edit_syntax_error() |
|
1752 | self.edit_syntax_error() | |
1753 |
|
1753 | |||
1754 | def interact_with_readline(self): |
|
1754 | def interact_with_readline(self): | |
1755 | """ Demo of using interact_handle_input, interact_prompt |
|
1755 | """ Demo of using interact_handle_input, interact_prompt | |
1756 |
|
1756 | |||
1757 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), |
|
1757 | This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI), | |
1758 | it should work like this. |
|
1758 | it should work like this. | |
1759 | """ |
|
1759 | """ | |
1760 | self.readline_startup_hook(self.pre_readline) |
|
1760 | self.readline_startup_hook(self.pre_readline) | |
1761 | while not self.exit_now: |
|
1761 | while not self.exit_now: | |
1762 | self.interact_prompt() |
|
1762 | self.interact_prompt() | |
1763 | if self.more: |
|
1763 | if self.more: | |
1764 | self.rl_do_indent = True |
|
1764 | self.rl_do_indent = True | |
1765 | else: |
|
1765 | else: | |
1766 | self.rl_do_indent = False |
|
1766 | self.rl_do_indent = False | |
1767 | line = raw_input_original().decode(self.stdin_encoding) |
|
1767 | line = raw_input_original().decode(self.stdin_encoding) | |
1768 | self.interact_handle_input(line) |
|
1768 | self.interact_handle_input(line) | |
1769 |
|
1769 | |||
1770 | def interact(self, display_banner=None): |
|
1770 | def interact(self, display_banner=None): | |
1771 | """Closely emulate the interactive Python console.""" |
|
1771 | """Closely emulate the interactive Python console.""" | |
1772 |
|
1772 | |||
1773 | # batch run -> do not interact |
|
1773 | # batch run -> do not interact | |
1774 | if self.exit_now: |
|
1774 | if self.exit_now: | |
1775 | return |
|
1775 | return | |
1776 |
|
1776 | |||
1777 | if display_banner is None: |
|
1777 | if display_banner is None: | |
1778 | display_banner = self.display_banner |
|
1778 | display_banner = self.display_banner | |
1779 | if display_banner: |
|
1779 | if display_banner: | |
1780 | self.show_banner() |
|
1780 | self.show_banner() | |
1781 |
|
1781 | |||
1782 | more = 0 |
|
1782 | more = 0 | |
1783 |
|
1783 | |||
1784 | # Mark activity in the builtins |
|
1784 | # Mark activity in the builtins | |
1785 | __builtin__.__dict__['__IPYTHON__active'] += 1 |
|
1785 | __builtin__.__dict__['__IPYTHON__active'] += 1 | |
1786 |
|
1786 | |||
1787 | if self.has_readline: |
|
1787 | if self.has_readline: | |
1788 | self.readline_startup_hook(self.pre_readline) |
|
1788 | self.readline_startup_hook(self.pre_readline) | |
1789 | # exit_now is set by a call to %Exit or %Quit, through the |
|
1789 | # exit_now is set by a call to %Exit or %Quit, through the | |
1790 | # ask_exit callback. |
|
1790 | # ask_exit callback. | |
1791 |
|
1791 | |||
1792 | while not self.exit_now: |
|
1792 | while not self.exit_now: | |
1793 | self.hooks.pre_prompt_hook() |
|
1793 | self.hooks.pre_prompt_hook() | |
1794 | if more: |
|
1794 | if more: | |
1795 | try: |
|
1795 | try: | |
1796 | prompt = self.hooks.generate_prompt(True) |
|
1796 | prompt = self.hooks.generate_prompt(True) | |
1797 | except: |
|
1797 | except: | |
1798 | self.showtraceback() |
|
1798 | self.showtraceback() | |
1799 | if self.autoindent: |
|
1799 | if self.autoindent: | |
1800 | self.rl_do_indent = True |
|
1800 | self.rl_do_indent = True | |
1801 |
|
1801 | |||
1802 | else: |
|
1802 | else: | |
1803 | try: |
|
1803 | try: | |
1804 | prompt = self.hooks.generate_prompt(False) |
|
1804 | prompt = self.hooks.generate_prompt(False) | |
1805 | except: |
|
1805 | except: | |
1806 | self.showtraceback() |
|
1806 | self.showtraceback() | |
1807 | try: |
|
1807 | try: | |
1808 | line = self.raw_input(prompt, more) |
|
1808 | line = self.raw_input(prompt, more) | |
1809 | if self.exit_now: |
|
1809 | if self.exit_now: | |
1810 | # quick exit on sys.std[in|out] close |
|
1810 | # quick exit on sys.std[in|out] close | |
1811 | break |
|
1811 | break | |
1812 | if self.autoindent: |
|
1812 | if self.autoindent: | |
1813 | self.rl_do_indent = False |
|
1813 | self.rl_do_indent = False | |
1814 |
|
1814 | |||
1815 | except KeyboardInterrupt: |
|
1815 | except KeyboardInterrupt: | |
1816 | #double-guard against keyboardinterrupts during kbdint handling |
|
1816 | #double-guard against keyboardinterrupts during kbdint handling | |
1817 | try: |
|
1817 | try: | |
1818 | self.write('\nKeyboardInterrupt\n') |
|
1818 | self.write('\nKeyboardInterrupt\n') | |
1819 | self.resetbuffer() |
|
1819 | self.resetbuffer() | |
1820 | # keep cache in sync with the prompt counter: |
|
1820 | # keep cache in sync with the prompt counter: | |
1821 | self.outputcache.prompt_count -= 1 |
|
1821 | self.outputcache.prompt_count -= 1 | |
1822 |
|
1822 | |||
1823 | if self.autoindent: |
|
1823 | if self.autoindent: | |
1824 | self.indent_current_nsp = 0 |
|
1824 | self.indent_current_nsp = 0 | |
1825 | more = 0 |
|
1825 | more = 0 | |
1826 | except KeyboardInterrupt: |
|
1826 | except KeyboardInterrupt: | |
1827 | pass |
|
1827 | pass | |
1828 | except EOFError: |
|
1828 | except EOFError: | |
1829 | if self.autoindent: |
|
1829 | if self.autoindent: | |
1830 | self.rl_do_indent = False |
|
1830 | self.rl_do_indent = False | |
1831 | self.readline_startup_hook(None) |
|
1831 | self.readline_startup_hook(None) | |
1832 | self.write('\n') |
|
1832 | self.write('\n') | |
1833 | self.exit() |
|
1833 | self.exit() | |
1834 | except bdb.BdbQuit: |
|
1834 | except bdb.BdbQuit: | |
1835 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
1835 | warn('The Python debugger has exited with a BdbQuit exception.\n' | |
1836 | 'Because of how pdb handles the stack, it is impossible\n' |
|
1836 | 'Because of how pdb handles the stack, it is impossible\n' | |
1837 | 'for IPython to properly format this particular exception.\n' |
|
1837 | 'for IPython to properly format this particular exception.\n' | |
1838 | 'IPython will resume normal operation.') |
|
1838 | 'IPython will resume normal operation.') | |
1839 | except: |
|
1839 | except: | |
1840 | # exceptions here are VERY RARE, but they can be triggered |
|
1840 | # exceptions here are VERY RARE, but they can be triggered | |
1841 | # asynchronously by signal handlers, for example. |
|
1841 | # asynchronously by signal handlers, for example. | |
1842 | self.showtraceback() |
|
1842 | self.showtraceback() | |
1843 | else: |
|
1843 | else: | |
1844 | more = self.push_line(line) |
|
1844 | more = self.push_line(line) | |
1845 | if (self.SyntaxTB.last_syntax_error and |
|
1845 | if (self.SyntaxTB.last_syntax_error and | |
1846 | self.autoedit_syntax): |
|
1846 | self.autoedit_syntax): | |
1847 | self.edit_syntax_error() |
|
1847 | self.edit_syntax_error() | |
1848 |
|
1848 | |||
1849 | # We are off again... |
|
1849 | # We are off again... | |
1850 | __builtin__.__dict__['__IPYTHON__active'] -= 1 |
|
1850 | __builtin__.__dict__['__IPYTHON__active'] -= 1 | |
1851 |
|
1851 | |||
1852 | def safe_execfile(self, fname, *where, **kw): |
|
1852 | def safe_execfile(self, fname, *where, **kw): | |
1853 | """A safe version of the builtin execfile(). |
|
1853 | """A safe version of the builtin execfile(). | |
1854 |
|
1854 | |||
1855 | This version will never throw an exception, but instead print |
|
1855 | This version will never throw an exception, but instead print | |
1856 | helpful error messages to the screen. This only works on pure |
|
1856 | helpful error messages to the screen. This only works on pure | |
1857 | Python files with the .py extension. |
|
1857 | Python files with the .py extension. | |
1858 |
|
1858 | |||
1859 | Parameters |
|
1859 | Parameters | |
1860 | ---------- |
|
1860 | ---------- | |
1861 | fname : string |
|
1861 | fname : string | |
1862 | The name of the file to be executed. |
|
1862 | The name of the file to be executed. | |
1863 | where : tuple |
|
1863 | where : tuple | |
1864 | One or two namespaces, passed to execfile() as (globals,locals). |
|
1864 | One or two namespaces, passed to execfile() as (globals,locals). | |
1865 | If only one is given, it is passed as both. |
|
1865 | If only one is given, it is passed as both. | |
1866 | exit_ignore : bool (False) |
|
1866 | exit_ignore : bool (False) | |
1867 | If True, then don't print errors for non-zero exit statuses. |
|
1867 | If True, then don't print errors for non-zero exit statuses. | |
1868 | """ |
|
1868 | """ | |
1869 | kw.setdefault('exit_ignore', False) |
|
1869 | kw.setdefault('exit_ignore', False) | |
1870 |
|
1870 | |||
1871 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
1871 | fname = os.path.abspath(os.path.expanduser(fname)) | |
1872 |
|
1872 | |||
1873 | # Make sure we have a .py file |
|
1873 | # Make sure we have a .py file | |
1874 | if not fname.endswith('.py'): |
|
1874 | if not fname.endswith('.py'): | |
1875 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
1875 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
1876 |
|
1876 | |||
1877 | # Make sure we can open the file |
|
1877 | # Make sure we can open the file | |
1878 | try: |
|
1878 | try: | |
1879 | with open(fname) as thefile: |
|
1879 | with open(fname) as thefile: | |
1880 | pass |
|
1880 | pass | |
1881 | except: |
|
1881 | except: | |
1882 | warn('Could not open file <%s> for safe execution.' % fname) |
|
1882 | warn('Could not open file <%s> for safe execution.' % fname) | |
1883 | return |
|
1883 | return | |
1884 |
|
1884 | |||
1885 | # Find things also in current directory. This is needed to mimic the |
|
1885 | # Find things also in current directory. This is needed to mimic the | |
1886 | # behavior of running a script from the system command line, where |
|
1886 | # behavior of running a script from the system command line, where | |
1887 | # Python inserts the script's directory into sys.path |
|
1887 | # Python inserts the script's directory into sys.path | |
1888 | dname = os.path.dirname(fname) |
|
1888 | dname = os.path.dirname(fname) | |
1889 |
|
1889 | |||
1890 | with prepended_to_syspath(dname): |
|
1890 | with prepended_to_syspath(dname): | |
1891 | try: |
|
1891 | try: | |
1892 | if sys.platform == 'win32' and sys.version_info < (2,5,1): |
|
1892 | if sys.platform == 'win32' and sys.version_info < (2,5,1): | |
1893 | # Work around a bug in Python for Windows. The bug was |
|
1893 | # Work around a bug in Python for Windows. The bug was | |
1894 | # fixed in in Python 2.5 r54159 and 54158, but that's still |
|
1894 | # fixed in in Python 2.5 r54159 and 54158, but that's still | |
1895 | # SVN Python as of March/07. For details, see: |
|
1895 | # SVN Python as of March/07. For details, see: | |
1896 | # http://projects.scipy.org/ipython/ipython/ticket/123 |
|
1896 | # http://projects.scipy.org/ipython/ipython/ticket/123 | |
1897 | try: |
|
1897 | try: | |
1898 | globs,locs = where[0:2] |
|
1898 | globs,locs = where[0:2] | |
1899 | except: |
|
1899 | except: | |
1900 | try: |
|
1900 | try: | |
1901 | globs = locs = where[0] |
|
1901 | globs = locs = where[0] | |
1902 | except: |
|
1902 | except: | |
1903 | globs = locs = globals() |
|
1903 | globs = locs = globals() | |
1904 | exec file(fname) in globs,locs |
|
1904 | exec file(fname) in globs,locs | |
1905 | else: |
|
1905 | else: | |
1906 | execfile(fname,*where) |
|
1906 | execfile(fname,*where) | |
1907 | except SyntaxError: |
|
1907 | except SyntaxError: | |
1908 | self.showsyntaxerror() |
|
1908 | self.showsyntaxerror() | |
1909 | warn('Failure executing file: <%s>' % fname) |
|
1909 | warn('Failure executing file: <%s>' % fname) | |
1910 | except SystemExit, status: |
|
1910 | except SystemExit, status: | |
1911 | # Code that correctly sets the exit status flag to success (0) |
|
1911 | # Code that correctly sets the exit status flag to success (0) | |
1912 | # shouldn't be bothered with a traceback. Note that a plain |
|
1912 | # shouldn't be bothered with a traceback. Note that a plain | |
1913 | # sys.exit() does NOT set the message to 0 (it's empty) so that |
|
1913 | # sys.exit() does NOT set the message to 0 (it's empty) so that | |
1914 | # will still get a traceback. Note that the structure of the |
|
1914 | # will still get a traceback. Note that the structure of the | |
1915 | # SystemExit exception changed between Python 2.4 and 2.5, so |
|
1915 | # SystemExit exception changed between Python 2.4 and 2.5, so | |
1916 | # the checks must be done in a version-dependent way. |
|
1916 | # the checks must be done in a version-dependent way. | |
1917 | show = False |
|
1917 | show = False | |
1918 | if status.message!=0 and not kw['exit_ignore']: |
|
1918 | if status.message!=0 and not kw['exit_ignore']: | |
1919 | show = True |
|
1919 | show = True | |
1920 | if show: |
|
1920 | if show: | |
1921 | self.showtraceback() |
|
1921 | self.showtraceback() | |
1922 | warn('Failure executing file: <%s>' % fname) |
|
1922 | warn('Failure executing file: <%s>' % fname) | |
1923 | except: |
|
1923 | except: | |
1924 | self.showtraceback() |
|
1924 | self.showtraceback() | |
1925 | warn('Failure executing file: <%s>' % fname) |
|
1925 | warn('Failure executing file: <%s>' % fname) | |
1926 |
|
1926 | |||
1927 | def safe_execfile_ipy(self, fname): |
|
1927 | def safe_execfile_ipy(self, fname): | |
1928 | """Like safe_execfile, but for .ipy files with IPython syntax. |
|
1928 | """Like safe_execfile, but for .ipy files with IPython syntax. | |
1929 |
|
1929 | |||
1930 | Parameters |
|
1930 | Parameters | |
1931 | ---------- |
|
1931 | ---------- | |
1932 | fname : str |
|
1932 | fname : str | |
1933 | The name of the file to execute. The filename must have a |
|
1933 | The name of the file to execute. The filename must have a | |
1934 | .ipy extension. |
|
1934 | .ipy extension. | |
1935 | """ |
|
1935 | """ | |
1936 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
1936 | fname = os.path.abspath(os.path.expanduser(fname)) | |
1937 |
|
1937 | |||
1938 | # Make sure we have a .py file |
|
1938 | # Make sure we have a .py file | |
1939 | if not fname.endswith('.ipy'): |
|
1939 | if not fname.endswith('.ipy'): | |
1940 | warn('File must end with .py to be run using execfile: <%s>' % fname) |
|
1940 | warn('File must end with .py to be run using execfile: <%s>' % fname) | |
1941 |
|
1941 | |||
1942 | # Make sure we can open the file |
|
1942 | # Make sure we can open the file | |
1943 | try: |
|
1943 | try: | |
1944 | with open(fname) as thefile: |
|
1944 | with open(fname) as thefile: | |
1945 | pass |
|
1945 | pass | |
1946 | except: |
|
1946 | except: | |
1947 | warn('Could not open file <%s> for safe execution.' % fname) |
|
1947 | warn('Could not open file <%s> for safe execution.' % fname) | |
1948 | return |
|
1948 | return | |
1949 |
|
1949 | |||
1950 | # Find things also in current directory. This is needed to mimic the |
|
1950 | # Find things also in current directory. This is needed to mimic the | |
1951 | # behavior of running a script from the system command line, where |
|
1951 | # behavior of running a script from the system command line, where | |
1952 | # Python inserts the script's directory into sys.path |
|
1952 | # Python inserts the script's directory into sys.path | |
1953 | dname = os.path.dirname(fname) |
|
1953 | dname = os.path.dirname(fname) | |
1954 |
|
1954 | |||
1955 | with prepended_to_syspath(dname): |
|
1955 | with prepended_to_syspath(dname): | |
1956 | try: |
|
1956 | try: | |
1957 | with open(fname) as thefile: |
|
1957 | with open(fname) as thefile: | |
1958 | script = thefile.read() |
|
1958 | script = thefile.read() | |
1959 | # self.runlines currently captures all exceptions |
|
1959 | # self.runlines currently captures all exceptions | |
1960 | # raise in user code. It would be nice if there were |
|
1960 | # raise in user code. It would be nice if there were | |
1961 | # versions of runlines, execfile that did raise, so |
|
1961 | # versions of runlines, execfile that did raise, so | |
1962 | # we could catch the errors. |
|
1962 | # we could catch the errors. | |
1963 | self.runlines(script, clean=True) |
|
1963 | self.runlines(script, clean=True) | |
1964 | except: |
|
1964 | except: | |
1965 | self.showtraceback() |
|
1965 | self.showtraceback() | |
1966 | warn('Unknown failure executing file: <%s>' % fname) |
|
1966 | warn('Unknown failure executing file: <%s>' % fname) | |
1967 |
|
1967 | |||
1968 | def _is_secondary_block_start(self, s): |
|
1968 | def _is_secondary_block_start(self, s): | |
1969 | if not s.endswith(':'): |
|
1969 | if not s.endswith(':'): | |
1970 | return False |
|
1970 | return False | |
1971 | if (s.startswith('elif') or |
|
1971 | if (s.startswith('elif') or | |
1972 | s.startswith('else') or |
|
1972 | s.startswith('else') or | |
1973 | s.startswith('except') or |
|
1973 | s.startswith('except') or | |
1974 | s.startswith('finally')): |
|
1974 | s.startswith('finally')): | |
1975 | return True |
|
1975 | return True | |
1976 |
|
1976 | |||
1977 | def cleanup_ipy_script(self, script): |
|
1977 | def cleanup_ipy_script(self, script): | |
1978 | """Make a script safe for self.runlines() |
|
1978 | """Make a script safe for self.runlines() | |
1979 |
|
1979 | |||
1980 | Currently, IPython is lines based, with blocks being detected by |
|
1980 | Currently, IPython is lines based, with blocks being detected by | |
1981 | empty lines. This is a problem for block based scripts that may |
|
1981 | empty lines. This is a problem for block based scripts that may | |
1982 | not have empty lines after blocks. This script adds those empty |
|
1982 | not have empty lines after blocks. This script adds those empty | |
1983 | lines to make scripts safe for running in the current line based |
|
1983 | lines to make scripts safe for running in the current line based | |
1984 | IPython. |
|
1984 | IPython. | |
1985 | """ |
|
1985 | """ | |
1986 | res = [] |
|
1986 | res = [] | |
1987 | lines = script.splitlines() |
|
1987 | lines = script.splitlines() | |
1988 | level = 0 |
|
1988 | level = 0 | |
1989 |
|
1989 | |||
1990 | for l in lines: |
|
1990 | for l in lines: | |
1991 | lstripped = l.lstrip() |
|
1991 | lstripped = l.lstrip() | |
1992 | stripped = l.strip() |
|
1992 | stripped = l.strip() | |
1993 | if not stripped: |
|
1993 | if not stripped: | |
1994 | continue |
|
1994 | continue | |
1995 | newlevel = len(l) - len(lstripped) |
|
1995 | newlevel = len(l) - len(lstripped) | |
1996 | if level > 0 and newlevel == 0 and \ |
|
1996 | if level > 0 and newlevel == 0 and \ | |
1997 | not self._is_secondary_block_start(stripped): |
|
1997 | not self._is_secondary_block_start(stripped): | |
1998 | # add empty line |
|
1998 | # add empty line | |
1999 | res.append('') |
|
1999 | res.append('') | |
2000 | res.append(l) |
|
2000 | res.append(l) | |
2001 | level = newlevel |
|
2001 | level = newlevel | |
2002 |
|
2002 | |||
2003 | return '\n'.join(res) + '\n' |
|
2003 | return '\n'.join(res) + '\n' | |
2004 |
|
2004 | |||
2005 | def runlines(self, lines, clean=False): |
|
2005 | def runlines(self, lines, clean=False): | |
2006 | """Run a string of one or more lines of source. |
|
2006 | """Run a string of one or more lines of source. | |
2007 |
|
2007 | |||
2008 | This method is capable of running a string containing multiple source |
|
2008 | This method is capable of running a string containing multiple source | |
2009 | lines, as if they had been entered at the IPython prompt. Since it |
|
2009 | lines, as if they had been entered at the IPython prompt. Since it | |
2010 | exposes IPython's processing machinery, the given strings can contain |
|
2010 | exposes IPython's processing machinery, the given strings can contain | |
2011 | magic calls (%magic), special shell access (!cmd), etc. |
|
2011 | magic calls (%magic), special shell access (!cmd), etc. | |
2012 | """ |
|
2012 | """ | |
2013 |
|
2013 | |||
2014 | if isinstance(lines, (list, tuple)): |
|
2014 | if isinstance(lines, (list, tuple)): | |
2015 | lines = '\n'.join(lines) |
|
2015 | lines = '\n'.join(lines) | |
2016 |
|
2016 | |||
2017 | if clean: |
|
2017 | if clean: | |
2018 | lines = self.cleanup_ipy_script(lines) |
|
2018 | lines = self.cleanup_ipy_script(lines) | |
2019 |
|
2019 | |||
2020 | # We must start with a clean buffer, in case this is run from an |
|
2020 | # We must start with a clean buffer, in case this is run from an | |
2021 | # interactive IPython session (via a magic, for example). |
|
2021 | # interactive IPython session (via a magic, for example). | |
2022 | self.resetbuffer() |
|
2022 | self.resetbuffer() | |
2023 | lines = lines.splitlines() |
|
2023 | lines = lines.splitlines() | |
2024 | more = 0 |
|
2024 | more = 0 | |
2025 |
|
2025 | |||
2026 | with nested(self.builtin_trap, self.display_trap): |
|
2026 | with nested(self.builtin_trap, self.display_trap): | |
2027 | for line in lines: |
|
2027 | for line in lines: | |
2028 | # skip blank lines so we don't mess up the prompt counter, but do |
|
2028 | # skip blank lines so we don't mess up the prompt counter, but do | |
2029 | # NOT skip even a blank line if we are in a code block (more is |
|
2029 | # NOT skip even a blank line if we are in a code block (more is | |
2030 | # true) |
|
2030 | # true) | |
2031 |
|
2031 | |||
2032 | if line or more: |
|
2032 | if line or more: | |
2033 | # push to raw history, so hist line numbers stay in sync |
|
2033 | # push to raw history, so hist line numbers stay in sync | |
2034 | self.input_hist_raw.append("# " + line + "\n") |
|
2034 | self.input_hist_raw.append("# " + line + "\n") | |
2035 | prefiltered = self.prefilter_manager.prefilter_lines(line,more) |
|
2035 | prefiltered = self.prefilter_manager.prefilter_lines(line,more) | |
2036 | more = self.push_line(prefiltered) |
|
2036 | more = self.push_line(prefiltered) | |
2037 | # IPython's runsource returns None if there was an error |
|
2037 | # IPython's runsource returns None if there was an error | |
2038 | # compiling the code. This allows us to stop processing right |
|
2038 | # compiling the code. This allows us to stop processing right | |
2039 | # away, so the user gets the error message at the right place. |
|
2039 | # away, so the user gets the error message at the right place. | |
2040 | if more is None: |
|
2040 | if more is None: | |
2041 | break |
|
2041 | break | |
2042 | else: |
|
2042 | else: | |
2043 | self.input_hist_raw.append("\n") |
|
2043 | self.input_hist_raw.append("\n") | |
2044 | # final newline in case the input didn't have it, so that the code |
|
2044 | # final newline in case the input didn't have it, so that the code | |
2045 | # actually does get executed |
|
2045 | # actually does get executed | |
2046 | if more: |
|
2046 | if more: | |
2047 | self.push_line('\n') |
|
2047 | self.push_line('\n') | |
2048 |
|
2048 | |||
2049 | def runsource(self, source, filename='<input>', symbol='single'): |
|
2049 | def runsource(self, source, filename='<input>', symbol='single'): | |
2050 | """Compile and run some source in the interpreter. |
|
2050 | """Compile and run some source in the interpreter. | |
2051 |
|
2051 | |||
2052 | Arguments are as for compile_command(). |
|
2052 | Arguments are as for compile_command(). | |
2053 |
|
2053 | |||
2054 | One several things can happen: |
|
2054 | One several things can happen: | |
2055 |
|
2055 | |||
2056 | 1) The input is incorrect; compile_command() raised an |
|
2056 | 1) The input is incorrect; compile_command() raised an | |
2057 | exception (SyntaxError or OverflowError). A syntax traceback |
|
2057 | exception (SyntaxError or OverflowError). A syntax traceback | |
2058 | will be printed by calling the showsyntaxerror() method. |
|
2058 | will be printed by calling the showsyntaxerror() method. | |
2059 |
|
2059 | |||
2060 | 2) The input is incomplete, and more input is required; |
|
2060 | 2) The input is incomplete, and more input is required; | |
2061 | compile_command() returned None. Nothing happens. |
|
2061 | compile_command() returned None. Nothing happens. | |
2062 |
|
2062 | |||
2063 | 3) The input is complete; compile_command() returned a code |
|
2063 | 3) The input is complete; compile_command() returned a code | |
2064 | object. The code is executed by calling self.runcode() (which |
|
2064 | object. The code is executed by calling self.runcode() (which | |
2065 | also handles run-time exceptions, except for SystemExit). |
|
2065 | also handles run-time exceptions, except for SystemExit). | |
2066 |
|
2066 | |||
2067 | The return value is: |
|
2067 | The return value is: | |
2068 |
|
2068 | |||
2069 | - True in case 2 |
|
2069 | - True in case 2 | |
2070 |
|
2070 | |||
2071 | - False in the other cases, unless an exception is raised, where |
|
2071 | - False in the other cases, unless an exception is raised, where | |
2072 | None is returned instead. This can be used by external callers to |
|
2072 | None is returned instead. This can be used by external callers to | |
2073 | know whether to continue feeding input or not. |
|
2073 | know whether to continue feeding input or not. | |
2074 |
|
2074 | |||
2075 | The return value can be used to decide whether to use sys.ps1 or |
|
2075 | The return value can be used to decide whether to use sys.ps1 or | |
2076 | sys.ps2 to prompt the next line.""" |
|
2076 | sys.ps2 to prompt the next line.""" | |
2077 |
|
2077 | |||
2078 | # if the source code has leading blanks, add 'if 1:\n' to it |
|
2078 | # if the source code has leading blanks, add 'if 1:\n' to it | |
2079 | # this allows execution of indented pasted code. It is tempting |
|
2079 | # this allows execution of indented pasted code. It is tempting | |
2080 | # to add '\n' at the end of source to run commands like ' a=1' |
|
2080 | # to add '\n' at the end of source to run commands like ' a=1' | |
2081 | # directly, but this fails for more complicated scenarios |
|
2081 | # directly, but this fails for more complicated scenarios | |
2082 | source=source.encode(self.stdin_encoding) |
|
2082 | source=source.encode(self.stdin_encoding) | |
2083 | if source[:1] in [' ', '\t']: |
|
2083 | if source[:1] in [' ', '\t']: | |
2084 | source = 'if 1:\n%s' % source |
|
2084 | source = 'if 1:\n%s' % source | |
2085 |
|
2085 | |||
2086 | try: |
|
2086 | try: | |
2087 | code = self.compile(source,filename,symbol) |
|
2087 | code = self.compile(source,filename,symbol) | |
2088 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): |
|
2088 | except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError): | |
2089 | # Case 1 |
|
2089 | # Case 1 | |
2090 | self.showsyntaxerror(filename) |
|
2090 | self.showsyntaxerror(filename) | |
2091 | return None |
|
2091 | return None | |
2092 |
|
2092 | |||
2093 | if code is None: |
|
2093 | if code is None: | |
2094 | # Case 2 |
|
2094 | # Case 2 | |
2095 | return True |
|
2095 | return True | |
2096 |
|
2096 | |||
2097 | # Case 3 |
|
2097 | # Case 3 | |
2098 | # We store the code object so that threaded shells and |
|
2098 | # We store the code object so that threaded shells and | |
2099 | # custom exception handlers can access all this info if needed. |
|
2099 | # custom exception handlers can access all this info if needed. | |
2100 | # The source corresponding to this can be obtained from the |
|
2100 | # The source corresponding to this can be obtained from the | |
2101 | # buffer attribute as '\n'.join(self.buffer). |
|
2101 | # buffer attribute as '\n'.join(self.buffer). | |
2102 | self.code_to_run = code |
|
2102 | self.code_to_run = code | |
2103 | # now actually execute the code object |
|
2103 | # now actually execute the code object | |
2104 | if self.runcode(code) == 0: |
|
2104 | if self.runcode(code) == 0: | |
2105 | return False |
|
2105 | return False | |
2106 | else: |
|
2106 | else: | |
2107 | return None |
|
2107 | return None | |
2108 |
|
2108 | |||
2109 | def runcode(self,code_obj): |
|
2109 | def runcode(self,code_obj): | |
2110 | """Execute a code object. |
|
2110 | """Execute a code object. | |
2111 |
|
2111 | |||
2112 | When an exception occurs, self.showtraceback() is called to display a |
|
2112 | When an exception occurs, self.showtraceback() is called to display a | |
2113 | traceback. |
|
2113 | traceback. | |
2114 |
|
2114 | |||
2115 | Return value: a flag indicating whether the code to be run completed |
|
2115 | Return value: a flag indicating whether the code to be run completed | |
2116 | successfully: |
|
2116 | successfully: | |
2117 |
|
2117 | |||
2118 | - 0: successful execution. |
|
2118 | - 0: successful execution. | |
2119 | - 1: an error occurred. |
|
2119 | - 1: an error occurred. | |
2120 | """ |
|
2120 | """ | |
2121 |
|
2121 | |||
2122 | # Set our own excepthook in case the user code tries to call it |
|
2122 | # Set our own excepthook in case the user code tries to call it | |
2123 | # directly, so that the IPython crash handler doesn't get triggered |
|
2123 | # directly, so that the IPython crash handler doesn't get triggered | |
2124 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook |
|
2124 | old_excepthook,sys.excepthook = sys.excepthook, self.excepthook | |
2125 |
|
2125 | |||
2126 | # we save the original sys.excepthook in the instance, in case config |
|
2126 | # we save the original sys.excepthook in the instance, in case config | |
2127 | # code (such as magics) needs access to it. |
|
2127 | # code (such as magics) needs access to it. | |
2128 | self.sys_excepthook = old_excepthook |
|
2128 | self.sys_excepthook = old_excepthook | |
2129 | outflag = 1 # happens in more places, so it's easier as default |
|
2129 | outflag = 1 # happens in more places, so it's easier as default | |
2130 | try: |
|
2130 | try: | |
2131 | try: |
|
2131 | try: | |
2132 | self.hooks.pre_runcode_hook() |
|
2132 | self.hooks.pre_runcode_hook() | |
2133 | exec code_obj in self.user_global_ns, self.user_ns |
|
2133 | exec code_obj in self.user_global_ns, self.user_ns | |
2134 | finally: |
|
2134 | finally: | |
2135 | # Reset our crash handler in place |
|
2135 | # Reset our crash handler in place | |
2136 | sys.excepthook = old_excepthook |
|
2136 | sys.excepthook = old_excepthook | |
2137 | except SystemExit: |
|
2137 | except SystemExit: | |
2138 | self.resetbuffer() |
|
2138 | self.resetbuffer() | |
2139 | self.showtraceback() |
|
2139 | self.showtraceback() | |
2140 | warn("Type %exit or %quit to exit IPython " |
|
2140 | warn("Type %exit or %quit to exit IPython " | |
2141 | "(%Exit or %Quit do so unconditionally).",level=1) |
|
2141 | "(%Exit or %Quit do so unconditionally).",level=1) | |
2142 | except self.custom_exceptions: |
|
2142 | except self.custom_exceptions: | |
2143 | etype,value,tb = sys.exc_info() |
|
2143 | etype,value,tb = sys.exc_info() | |
2144 | self.CustomTB(etype,value,tb) |
|
2144 | self.CustomTB(etype,value,tb) | |
2145 | except: |
|
2145 | except: | |
2146 | self.showtraceback() |
|
2146 | self.showtraceback() | |
2147 | else: |
|
2147 | else: | |
2148 | outflag = 0 |
|
2148 | outflag = 0 | |
2149 | if softspace(sys.stdout, 0): |
|
2149 | if softspace(sys.stdout, 0): | |
2150 |
|
2150 | |||
2151 | # Flush out code object which has been run (and source) |
|
2151 | # Flush out code object which has been run (and source) | |
2152 | self.code_to_run = None |
|
2152 | self.code_to_run = None | |
2153 | return outflag |
|
2153 | return outflag | |
2154 |
|
2154 | |||
2155 | def push_line(self, line): |
|
2155 | def push_line(self, line): | |
2156 | """Push a line to the interpreter. |
|
2156 | """Push a line to the interpreter. | |
2157 |
|
2157 | |||
2158 | The line should not have a trailing newline; it may have |
|
2158 | The line should not have a trailing newline; it may have | |
2159 | internal newlines. The line is appended to a buffer and the |
|
2159 | internal newlines. The line is appended to a buffer and the | |
2160 | interpreter's runsource() method is called with the |
|
2160 | interpreter's runsource() method is called with the | |
2161 | concatenated contents of the buffer as source. If this |
|
2161 | concatenated contents of the buffer as source. If this | |
2162 | indicates that the command was executed or invalid, the buffer |
|
2162 | indicates that the command was executed or invalid, the buffer | |
2163 | is reset; otherwise, the command is incomplete, and the buffer |
|
2163 | is reset; otherwise, the command is incomplete, and the buffer | |
2164 | is left as it was after the line was appended. The return |
|
2164 | is left as it was after the line was appended. The return | |
2165 | value is 1 if more input is required, 0 if the line was dealt |
|
2165 | value is 1 if more input is required, 0 if the line was dealt | |
2166 | with in some way (this is the same as runsource()). |
|
2166 | with in some way (this is the same as runsource()). | |
2167 | """ |
|
2167 | """ | |
2168 |
|
2168 | |||
2169 | # autoindent management should be done here, and not in the |
|
2169 | # autoindent management should be done here, and not in the | |
2170 | # interactive loop, since that one is only seen by keyboard input. We |
|
2170 | # interactive loop, since that one is only seen by keyboard input. We | |
2171 | # need this done correctly even for code run via runlines (which uses |
|
2171 | # need this done correctly even for code run via runlines (which uses | |
2172 | # push). |
|
2172 | # push). | |
2173 |
|
2173 | |||
2174 | #print 'push line: <%s>' % line # dbg |
|
2174 | #print 'push line: <%s>' % line # dbg | |
2175 | for subline in line.splitlines(): |
|
2175 | for subline in line.splitlines(): | |
2176 | self._autoindent_update(subline) |
|
2176 | self._autoindent_update(subline) | |
2177 | self.buffer.append(line) |
|
2177 | self.buffer.append(line) | |
2178 | more = self.runsource('\n'.join(self.buffer), self.filename) |
|
2178 | more = self.runsource('\n'.join(self.buffer), self.filename) | |
2179 | if not more: |
|
2179 | if not more: | |
2180 | self.resetbuffer() |
|
2180 | self.resetbuffer() | |
2181 | return more |
|
2181 | return more | |
2182 |
|
2182 | |||
2183 | def _autoindent_update(self,line): |
|
2183 | def _autoindent_update(self,line): | |
2184 | """Keep track of the indent level.""" |
|
2184 | """Keep track of the indent level.""" | |
2185 |
|
2185 | |||
2186 | #debugx('line') |
|
2186 | #debugx('line') | |
2187 | #debugx('self.indent_current_nsp') |
|
2187 | #debugx('self.indent_current_nsp') | |
2188 | if self.autoindent: |
|
2188 | if self.autoindent: | |
2189 | if line: |
|
2189 | if line: | |
2190 | inisp = num_ini_spaces(line) |
|
2190 | inisp = num_ini_spaces(line) | |
2191 | if inisp < self.indent_current_nsp: |
|
2191 | if inisp < self.indent_current_nsp: | |
2192 | self.indent_current_nsp = inisp |
|
2192 | self.indent_current_nsp = inisp | |
2193 |
|
2193 | |||
2194 | if line[-1] == ':': |
|
2194 | if line[-1] == ':': | |
2195 | self.indent_current_nsp += 4 |
|
2195 | self.indent_current_nsp += 4 | |
2196 | elif dedent_re.match(line): |
|
2196 | elif dedent_re.match(line): | |
2197 | self.indent_current_nsp -= 4 |
|
2197 | self.indent_current_nsp -= 4 | |
2198 | else: |
|
2198 | else: | |
2199 | self.indent_current_nsp = 0 |
|
2199 | self.indent_current_nsp = 0 | |
2200 |
|
2200 | |||
2201 | def resetbuffer(self): |
|
2201 | def resetbuffer(self): | |
2202 | """Reset the input buffer.""" |
|
2202 | """Reset the input buffer.""" | |
2203 | self.buffer[:] = [] |
|
2203 | self.buffer[:] = [] | |
2204 |
|
2204 | |||
2205 | def raw_input(self,prompt='',continue_prompt=False): |
|
2205 | def raw_input(self,prompt='',continue_prompt=False): | |
2206 | """Write a prompt and read a line. |
|
2206 | """Write a prompt and read a line. | |
2207 |
|
2207 | |||
2208 | The returned line does not include the trailing newline. |
|
2208 | The returned line does not include the trailing newline. | |
2209 | When the user enters the EOF key sequence, EOFError is raised. |
|
2209 | When the user enters the EOF key sequence, EOFError is raised. | |
2210 |
|
2210 | |||
2211 | Optional inputs: |
|
2211 | Optional inputs: | |
2212 |
|
2212 | |||
2213 | - prompt(''): a string to be printed to prompt the user. |
|
2213 | - prompt(''): a string to be printed to prompt the user. | |
2214 |
|
2214 | |||
2215 | - continue_prompt(False): whether this line is the first one or a |
|
2215 | - continue_prompt(False): whether this line is the first one or a | |
2216 | continuation in a sequence of inputs. |
|
2216 | continuation in a sequence of inputs. | |
2217 | """ |
|
2217 | """ | |
2218 | # growl.notify("raw_input: ", "prompt = %r\ncontinue_prompt = %s" % (prompt, continue_prompt)) |
|
2218 | # growl.notify("raw_input: ", "prompt = %r\ncontinue_prompt = %s" % (prompt, continue_prompt)) | |
2219 |
|
2219 | |||
2220 | # Code run by the user may have modified the readline completer state. |
|
2220 | # Code run by the user may have modified the readline completer state. | |
2221 | # We must ensure that our completer is back in place. |
|
2221 | # We must ensure that our completer is back in place. | |
2222 |
|
2222 | |||
2223 | if self.has_readline: |
|
2223 | if self.has_readline: | |
2224 | self.set_completer() |
|
2224 | self.set_completer() | |
2225 |
|
2225 | |||
2226 | try: |
|
2226 | try: | |
2227 | line = raw_input_original(prompt).decode(self.stdin_encoding) |
|
2227 | line = raw_input_original(prompt).decode(self.stdin_encoding) | |
2228 | except ValueError: |
|
2228 | except ValueError: | |
2229 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
2229 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" | |
2230 | " or sys.stdout.close()!\nExiting IPython!") |
|
2230 | " or sys.stdout.close()!\nExiting IPython!") | |
2231 | self.ask_exit() |
|
2231 | self.ask_exit() | |
2232 | return "" |
|
2232 | return "" | |
2233 |
|
2233 | |||
2234 | # Try to be reasonably smart about not re-indenting pasted input more |
|
2234 | # Try to be reasonably smart about not re-indenting pasted input more | |
2235 | # than necessary. We do this by trimming out the auto-indent initial |
|
2235 | # than necessary. We do this by trimming out the auto-indent initial | |
2236 | # spaces, if the user's actual input started itself with whitespace. |
|
2236 | # spaces, if the user's actual input started itself with whitespace. | |
2237 | #debugx('self.buffer[-1]') |
|
2237 | #debugx('self.buffer[-1]') | |
2238 |
|
2238 | |||
2239 | if self.autoindent: |
|
2239 | if self.autoindent: | |
2240 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
2240 | if num_ini_spaces(line) > self.indent_current_nsp: | |
2241 | line = line[self.indent_current_nsp:] |
|
2241 | line = line[self.indent_current_nsp:] | |
2242 | self.indent_current_nsp = 0 |
|
2242 | self.indent_current_nsp = 0 | |
2243 |
|
2243 | |||
2244 | # store the unfiltered input before the user has any chance to modify |
|
2244 | # store the unfiltered input before the user has any chance to modify | |
2245 | # it. |
|
2245 | # it. | |
2246 | if line.strip(): |
|
2246 | if line.strip(): | |
2247 | if continue_prompt: |
|
2247 | if continue_prompt: | |
2248 | self.input_hist_raw[-1] += '%s\n' % line |
|
2248 | self.input_hist_raw[-1] += '%s\n' % line | |
2249 | if self.has_readline and self.readline_use: |
|
2249 | if self.has_readline and self.readline_use: | |
2250 | try: |
|
2250 | try: | |
2251 | histlen = self.readline.get_current_history_length() |
|
2251 | histlen = self.readline.get_current_history_length() | |
2252 | if histlen > 1: |
|
2252 | if histlen > 1: | |
2253 | newhist = self.input_hist_raw[-1].rstrip() |
|
2253 | newhist = self.input_hist_raw[-1].rstrip() | |
2254 | self.readline.remove_history_item(histlen-1) |
|
2254 | self.readline.remove_history_item(histlen-1) | |
2255 | self.readline.replace_history_item(histlen-2, |
|
2255 | self.readline.replace_history_item(histlen-2, | |
2256 | newhist.encode(self.stdin_encoding)) |
|
2256 | newhist.encode(self.stdin_encoding)) | |
2257 | except AttributeError: |
|
2257 | except AttributeError: | |
2258 | pass # re{move,place}_history_item are new in 2.4. |
|
2258 | pass # re{move,place}_history_item are new in 2.4. | |
2259 | else: |
|
2259 | else: | |
2260 | self.input_hist_raw.append('%s\n' % line) |
|
2260 | self.input_hist_raw.append('%s\n' % line) | |
2261 | # only entries starting at first column go to shadow history |
|
2261 | # only entries starting at first column go to shadow history | |
2262 | if line.lstrip() == line: |
|
2262 | if line.lstrip() == line: | |
2263 | self.shadowhist.add(line.strip()) |
|
2263 | self.shadowhist.add(line.strip()) | |
2264 | elif not continue_prompt: |
|
2264 | elif not continue_prompt: | |
2265 | self.input_hist_raw.append('\n') |
|
2265 | self.input_hist_raw.append('\n') | |
2266 | try: |
|
2266 | try: | |
2267 | lineout = self.prefilter_manager.prefilter_lines(line,continue_prompt) |
|
2267 | lineout = self.prefilter_manager.prefilter_lines(line,continue_prompt) | |
2268 | except: |
|
2268 | except: | |
2269 | # blanket except, in case a user-defined prefilter crashes, so it |
|
2269 | # blanket except, in case a user-defined prefilter crashes, so it | |
2270 | # can't take all of ipython with it. |
|
2270 | # can't take all of ipython with it. | |
2271 | self.showtraceback() |
|
2271 | self.showtraceback() | |
2272 | return '' |
|
2272 | return '' | |
2273 | else: |
|
2273 | else: | |
2274 | return lineout |
|
2274 | return lineout | |
2275 |
|
2275 | |||
2276 | #------------------------------------------------------------------------- |
|
2276 | #------------------------------------------------------------------------- | |
2277 | # IPython extensions |
|
2277 | # IPython extensions | |
2278 | #------------------------------------------------------------------------- |
|
2278 | #------------------------------------------------------------------------- | |
2279 |
|
2279 | |||
2280 | def load_extension(self, module_str): |
|
2280 | def load_extension(self, module_str): | |
2281 | """Load an IPython extension. |
|
2281 | """Load an IPython extension. | |
2282 |
|
2282 | |||
2283 | An IPython extension is an importable Python module that has |
|
2283 | An IPython extension is an importable Python module that has | |
2284 | a function with the signature:: |
|
2284 | a function with the signature:: | |
2285 |
|
2285 | |||
2286 | def load_in_ipython(ipython): |
|
2286 | def load_in_ipython(ipython): | |
2287 | # Do things with ipython |
|
2287 | # Do things with ipython | |
2288 |
|
2288 | |||
2289 | This function is called after your extension is imported and the |
|
2289 | This function is called after your extension is imported and the | |
2290 | currently active :class:`InteractiveShell` instance is passed as |
|
2290 | currently active :class:`InteractiveShell` instance is passed as | |
2291 | the only argument. You can do anything you want with IPython at |
|
2291 | the only argument. You can do anything you want with IPython at | |
2292 | that point, including defining new magic and aliases, adding new |
|
2292 | that point, including defining new magic and aliases, adding new | |
2293 | components, etc. |
|
2293 | components, etc. | |
2294 |
|
2294 | |||
2295 | You can put your extension modules anywhere you want, as long as |
|
2295 | You can put your extension modules anywhere you want, as long as | |
2296 | they can be imported by Python's standard import mechanism. However, |
|
2296 | they can be imported by Python's standard import mechanism. However, | |
2297 | to make it easy to write extensions, you can also put your extensions |
|
2297 | to make it easy to write extensions, you can also put your extensions | |
2298 | in ``os.path.join(self.ipythondir, 'extensions')``. This directory |
|
2298 | in ``os.path.join(self.ipythondir, 'extensions')``. This directory | |
2299 | is added to ``sys.path`` automatically. |
|
2299 | is added to ``sys.path`` automatically. | |
2300 | """ |
|
2300 | """ | |
2301 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
2301 | from IPython.utils.syspathcontext import prepended_to_syspath | |
2302 |
|
2302 | |||
2303 | if module_str in sys.modules: |
|
2303 | if module_str in sys.modules: | |
2304 | return |
|
2304 | return | |
2305 |
|
2305 | |||
2306 | with prepended_to_syspath(self.ipython_extension_dir): |
|
2306 | with prepended_to_syspath(self.ipython_extension_dir): | |
2307 | __import__(module_str) |
|
2307 | __import__(module_str) | |
2308 | mod = sys.modules[module_str] |
|
2308 | mod = sys.modules[module_str] | |
2309 | self._call_load_in_ipython(mod) |
|
2309 | self._call_load_in_ipython(mod) | |
2310 |
|
2310 | |||
2311 | def reload_extension(self, module_str): |
|
2311 | def reload_extension(self, module_str): | |
2312 | """Reload an IPython extension by doing reload.""" |
|
2312 | """Reload an IPython extension by doing reload.""" | |
2313 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
2313 | from IPython.utils.syspathcontext import prepended_to_syspath | |
2314 |
|
2314 | |||
2315 | with prepended_to_syspath(self.ipython_extension_dir): |
|
2315 | with prepended_to_syspath(self.ipython_extension_dir): | |
2316 | if module_str in sys.modules: |
|
2316 | if module_str in sys.modules: | |
2317 | mod = sys.modules[module_str] |
|
2317 | mod = sys.modules[module_str] | |
2318 | reload(mod) |
|
2318 | reload(mod) | |
2319 | self._call_load_in_ipython(mod) |
|
2319 | self._call_load_in_ipython(mod) | |
2320 | else: |
|
2320 | else: | |
2321 | self.load_extension(self, module_str) |
|
2321 | self.load_extension(self, module_str) | |
2322 |
|
2322 | |||
2323 | def _call_load_in_ipython(self, mod): |
|
2323 | def _call_load_in_ipython(self, mod): | |
2324 | if hasattr(mod, 'load_in_ipython'): |
|
2324 | if hasattr(mod, 'load_in_ipython'): | |
2325 | mod.load_in_ipython(self) |
|
2325 | mod.load_in_ipython(self) | |
2326 |
|
2326 | |||
2327 | #------------------------------------------------------------------------- |
|
2327 | #------------------------------------------------------------------------- | |
2328 | # Things related to the prefilter |
|
2328 | # Things related to the prefilter | |
2329 | #------------------------------------------------------------------------- |
|
2329 | #------------------------------------------------------------------------- | |
2330 |
|
2330 | |||
2331 | def init_prefilter(self): |
|
2331 | def init_prefilter(self): | |
2332 | self.prefilter_manager = PrefilterManager(self, config=self.config) |
|
2332 | self.prefilter_manager = PrefilterManager(self, config=self.config) | |
2333 |
|
2333 | |||
2334 | #------------------------------------------------------------------------- |
|
2334 | #------------------------------------------------------------------------- | |
2335 | # Utilities |
|
2335 | # Utilities | |
2336 | #------------------------------------------------------------------------- |
|
2336 | #------------------------------------------------------------------------- | |
2337 |
|
2337 | |||
2338 | def getoutput(self, cmd): |
|
2338 | def getoutput(self, cmd): | |
2339 | return getoutput(self.var_expand(cmd,depth=2), |
|
2339 | return getoutput(self.var_expand(cmd,depth=2), | |
2340 | header=self.system_header, |
|
2340 | header=self.system_header, | |
2341 | verbose=self.system_verbose) |
|
2341 | verbose=self.system_verbose) | |
2342 |
|
2342 | |||
2343 | def getoutputerror(self, cmd): |
|
2343 | def getoutputerror(self, cmd): | |
2344 | return getoutputerror(self.var_expand(cmd,depth=2), |
|
2344 | return getoutputerror(self.var_expand(cmd,depth=2), | |
2345 | header=self.system_header, |
|
2345 | header=self.system_header, | |
2346 | verbose=self.system_verbose) |
|
2346 | verbose=self.system_verbose) | |
2347 |
|
2347 | |||
2348 | def var_expand(self,cmd,depth=0): |
|
2348 | def var_expand(self,cmd,depth=0): | |
2349 | """Expand python variables in a string. |
|
2349 | """Expand python variables in a string. | |
2350 |
|
2350 | |||
2351 | The depth argument indicates how many frames above the caller should |
|
2351 | The depth argument indicates how many frames above the caller should | |
2352 | be walked to look for the local namespace where to expand variables. |
|
2352 | be walked to look for the local namespace where to expand variables. | |
2353 |
|
2353 | |||
2354 | The global namespace for expansion is always the user's interactive |
|
2354 | The global namespace for expansion is always the user's interactive | |
2355 | namespace. |
|
2355 | namespace. | |
2356 | """ |
|
2356 | """ | |
2357 |
|
2357 | |||
2358 | return str(ItplNS(cmd, |
|
2358 | return str(ItplNS(cmd, | |
2359 | self.user_ns, # globals |
|
2359 | self.user_ns, # globals | |
2360 | # Skip our own frame in searching for locals: |
|
2360 | # Skip our own frame in searching for locals: | |
2361 | sys._getframe(depth+1).f_locals # locals |
|
2361 | sys._getframe(depth+1).f_locals # locals | |
2362 | )) |
|
2362 | )) | |
2363 |
|
2363 | |||
2364 | def mktempfile(self,data=None): |
|
2364 | def mktempfile(self,data=None): | |
2365 | """Make a new tempfile and return its filename. |
|
2365 | """Make a new tempfile and return its filename. | |
2366 |
|
2366 | |||
2367 | This makes a call to tempfile.mktemp, but it registers the created |
|
2367 | This makes a call to tempfile.mktemp, but it registers the created | |
2368 | filename internally so ipython cleans it up at exit time. |
|
2368 | filename internally so ipython cleans it up at exit time. | |
2369 |
|
2369 | |||
2370 | Optional inputs: |
|
2370 | Optional inputs: | |
2371 |
|
2371 | |||
2372 | - data(None): if data is given, it gets written out to the temp file |
|
2372 | - data(None): if data is given, it gets written out to the temp file | |
2373 | immediately, and the file is closed again.""" |
|
2373 | immediately, and the file is closed again.""" | |
2374 |
|
2374 | |||
2375 | filename = tempfile.mktemp('.py','ipython_edit_') |
|
2375 | filename = tempfile.mktemp('.py','ipython_edit_') | |
2376 | self.tempfiles.append(filename) |
|
2376 | self.tempfiles.append(filename) | |
2377 |
|
2377 | |||
2378 | if data: |
|
2378 | if data: | |
2379 | tmp_file = open(filename,'w') |
|
2379 | tmp_file = open(filename,'w') | |
2380 | tmp_file.write(data) |
|
2380 | tmp_file.write(data) | |
2381 | tmp_file.close() |
|
2381 | tmp_file.close() | |
2382 | return filename |
|
2382 | return filename | |
2383 |
|
2383 | |||
2384 | def write(self,data): |
|
2384 | def write(self,data): | |
2385 | """Write a string to the default output""" |
|
2385 | """Write a string to the default output""" | |
2386 | Term.cout.write(data) |
|
2386 | Term.cout.write(data) | |
2387 |
|
2387 | |||
2388 | def write_err(self,data): |
|
2388 | def write_err(self,data): | |
2389 | """Write a string to the default error output""" |
|
2389 | """Write a string to the default error output""" | |
2390 | Term.cerr.write(data) |
|
2390 | Term.cerr.write(data) | |
2391 |
|
2391 | |||
2392 | def ask_yes_no(self,prompt,default=True): |
|
2392 | def ask_yes_no(self,prompt,default=True): | |
2393 | if self.quiet: |
|
2393 | if self.quiet: | |
2394 | return True |
|
2394 | return True | |
2395 | return ask_yes_no(prompt,default) |
|
2395 | return ask_yes_no(prompt,default) | |
2396 |
|
2396 | |||
2397 | #------------------------------------------------------------------------- |
|
2397 | #------------------------------------------------------------------------- | |
2398 | # Things related to IPython exiting |
|
2398 | # Things related to IPython exiting | |
2399 | #------------------------------------------------------------------------- |
|
2399 | #------------------------------------------------------------------------- | |
2400 |
|
2400 | |||
2401 | def ask_exit(self): |
|
2401 | def ask_exit(self): | |
2402 | """ Call for exiting. Can be overiden and used as a callback. """ |
|
2402 | """ Call for exiting. Can be overiden and used as a callback. """ | |
2403 | self.exit_now = True |
|
2403 | self.exit_now = True | |
2404 |
|
2404 | |||
2405 | def exit(self): |
|
2405 | def exit(self): | |
2406 | """Handle interactive exit. |
|
2406 | """Handle interactive exit. | |
2407 |
|
2407 | |||
2408 | This method calls the ask_exit callback.""" |
|
2408 | This method calls the ask_exit callback.""" | |
2409 | if self.confirm_exit: |
|
2409 | if self.confirm_exit: | |
2410 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
2410 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): | |
2411 | self.ask_exit() |
|
2411 | self.ask_exit() | |
2412 | else: |
|
2412 | else: | |
2413 | self.ask_exit() |
|
2413 | self.ask_exit() | |
2414 |
|
2414 | |||
2415 | def atexit_operations(self): |
|
2415 | def atexit_operations(self): | |
2416 | """This will be executed at the time of exit. |
|
2416 | """This will be executed at the time of exit. | |
2417 |
|
2417 | |||
2418 | Saving of persistent data should be performed here. |
|
2418 | Saving of persistent data should be performed here. | |
2419 | """ |
|
2419 | """ | |
2420 | self.savehist() |
|
2420 | self.savehist() | |
2421 |
|
2421 | |||
2422 | # Cleanup all tempfiles left around |
|
2422 | # Cleanup all tempfiles left around | |
2423 | for tfile in self.tempfiles: |
|
2423 | for tfile in self.tempfiles: | |
2424 | try: |
|
2424 | try: | |
2425 | os.unlink(tfile) |
|
2425 | os.unlink(tfile) | |
2426 | except OSError: |
|
2426 | except OSError: | |
2427 | pass |
|
2427 | pass | |
2428 |
|
2428 | |||
2429 | # Clear all user namespaces to release all references cleanly. |
|
2429 | # Clear all user namespaces to release all references cleanly. | |
2430 | self.reset() |
|
2430 | self.reset() | |
2431 |
|
2431 | |||
2432 | # Run user hooks |
|
2432 | # Run user hooks | |
2433 | self.hooks.shutdown_hook() |
|
2433 | self.hooks.shutdown_hook() | |
2434 |
|
2434 | |||
2435 | def cleanup(self): |
|
2435 | def cleanup(self): | |
2436 | self.restore_sys_module_state() |
|
2436 | self.restore_sys_module_state() | |
2437 |
|
2437 | |||
2438 |
|
2438 |
1 | NO CONTENT: modified file |
|
NO CONTENT: modified file | ||
The requested commit or file is too big and content was truncated. Show full diff |
@@ -1,69 +1,209 b'' | |||||
|
1 | #!/usr/bin/env python | |||
1 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
|
3 | """ | |||
|
4 | Foolscap related utilities. | |||
|
5 | """ | |||
2 |
|
6 | |||
3 | """Foolscap related utilities.""" |
|
7 | #----------------------------------------------------------------------------- | |
4 |
|
8 | # Copyright (C) 2008-2009 The IPython Development Team | ||
5 | __docformat__ = "restructuredtext en" |
|
|||
6 |
|
||||
7 | #------------------------------------------------------------------------------- |
|
|||
8 | # Copyright (C) 2008 The IPython Development Team |
|
|||
9 | # |
|
9 | # | |
10 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | # Distributed under the terms of the BSD License. The full license is in | |
11 | # the file COPYING, distributed as part of this software. |
|
11 | # the file COPYING, distributed as part of this software. | |
12 |
#----------------------------------------------------------------------------- |
|
12 | #----------------------------------------------------------------------------- | |
13 |
|
13 | |||
14 |
#----------------------------------------------------------------------------- |
|
14 | #----------------------------------------------------------------------------- | |
15 | # Imports |
|
15 | # Imports | |
16 |
#----------------------------------------------------------------------------- |
|
16 | #----------------------------------------------------------------------------- | |
17 |
|
17 | |||
18 | import os |
|
18 | import os | |
|
19 | import tempfile | |||
|
20 | ||||
|
21 | from twisted.internet import reactor, defer | |||
|
22 | from twisted.python import log | |||
19 |
|
23 | |||
20 | from foolscap import Tub, UnauthenticatedTub |
|
24 | from foolscap import Tub, UnauthenticatedTub | |
21 |
|
25 | |||
|
26 | from IPython.config.loader import Config | |||
|
27 | ||||
|
28 | from IPython.kernel.configobjfactory import AdaptedConfiguredObjectFactory | |||
|
29 | ||||
|
30 | from IPython.kernel.error import SecurityError | |||
|
31 | ||||
|
32 | from IPython.utils.traitlets import Int, Str, Bool, Instance | |||
|
33 | from IPython.utils.importstring import import_item | |||
|
34 | ||||
|
35 | #----------------------------------------------------------------------------- | |||
|
36 | # Code | |||
|
37 | #----------------------------------------------------------------------------- | |||
|
38 | ||||
|
39 | ||||
|
40 | # We do this so if a user doesn't have OpenSSL installed, it will try to use | |||
|
41 | # an UnauthenticatedTub. But, they will still run into problems if they | |||
|
42 | # try to use encrypted furls. | |||
|
43 | try: | |||
|
44 | import OpenSSL | |||
|
45 | except: | |||
|
46 | Tub = UnauthenticatedTub | |||
|
47 | have_crypto = False | |||
|
48 | else: | |||
|
49 | have_crypto = True | |||
|
50 | ||||
|
51 | ||||
22 | def check_furl_file_security(furl_file, secure): |
|
52 | def check_furl_file_security(furl_file, secure): | |
23 | """Remove the old furl_file if changing security modes.""" |
|
53 | """Remove the old furl_file if changing security modes.""" | |
24 |
|
||||
25 | if os.path.isfile(furl_file): |
|
54 | if os.path.isfile(furl_file): | |
26 | f = open(furl_file, 'r') |
|
55 | f = open(furl_file, 'r') | |
27 | oldfurl = f.read().strip() |
|
56 | oldfurl = f.read().strip() | |
28 | f.close() |
|
57 | f.close() | |
29 | if (oldfurl.startswith('pb://') and not secure) or (oldfurl.startswith('pbu://') and secure): |
|
58 | if (oldfurl.startswith('pb://') and not secure) or (oldfurl.startswith('pbu://') and secure): | |
30 | os.remove(furl_file) |
|
59 | os.remove(furl_file) | |
31 |
|
60 | |||
|
61 | ||||
32 | def is_secure(furl): |
|
62 | def is_secure(furl): | |
|
63 | """Is the given FURL secure or not.""" | |||
33 | if is_valid(furl): |
|
64 | if is_valid(furl): | |
34 | if furl.startswith("pb://"): |
|
65 | if furl.startswith("pb://"): | |
35 | return True |
|
66 | return True | |
36 | elif furl.startswith("pbu://"): |
|
67 | elif furl.startswith("pbu://"): | |
37 | return False |
|
68 | return False | |
38 | else: |
|
69 | else: | |
39 | raise ValueError("invalid furl: %s" % furl) |
|
70 | raise ValueError("invalid furl: %s" % furl) | |
40 |
|
71 | |||
|
72 | ||||
41 | def is_valid(furl): |
|
73 | def is_valid(furl): | |
|
74 | """Is the str a valid furl or not.""" | |||
42 | if isinstance(furl, str): |
|
75 | if isinstance(furl, str): | |
43 | if furl.startswith("pb://") or furl.startswith("pbu://"): |
|
76 | if furl.startswith("pb://") or furl.startswith("pbu://"): | |
44 | return True |
|
77 | return True | |
45 | else: |
|
78 | else: | |
46 | return False |
|
79 | return False | |
47 |
|
80 | |||
|
81 | ||||
48 | def find_furl(furl_or_file): |
|
82 | def find_furl(furl_or_file): | |
|
83 | """Find, validate and return a FURL in a string or file.""" | |||
49 | if isinstance(furl_or_file, str): |
|
84 | if isinstance(furl_or_file, str): | |
50 | if is_valid(furl_or_file): |
|
85 | if is_valid(furl_or_file): | |
51 | return furl_or_file |
|
86 | return furl_or_file | |
52 | if os.path.isfile(furl_or_file): |
|
87 | if os.path.isfile(furl_or_file): | |
53 | furl = open(furl_or_file, 'r').read().strip() |
|
88 | furl = open(furl_or_file, 'r').read().strip() | |
54 | if is_valid(furl): |
|
89 | if is_valid(furl): | |
55 | return furl |
|
90 | return furl | |
56 | raise ValueError("not a furl or a file containing a furl: %s" % furl_or_file) |
|
91 | raise ValueError("not a furl or a file containing a furl: %s" % furl_or_file) | |
57 |
|
92 | |||
58 | # We do this so if a user doesn't have OpenSSL installed, it will try to use |
|
|||
59 | # an UnauthenticatedTub. But, they will still run into problems if they |
|
|||
60 | # try to use encrypted furls. |
|
|||
61 | try: |
|
|||
62 | import OpenSSL |
|
|||
63 | except: |
|
|||
64 | Tub = UnauthenticatedTub |
|
|||
65 | have_crypto = False |
|
|||
66 | else: |
|
|||
67 | have_crypto = True |
|
|||
68 |
|
93 | |||
|
94 | def get_temp_furlfile(filename): | |||
|
95 | """Return a temporary furl file.""" | |||
|
96 | return tempfile.mktemp(dir=os.path.dirname(filename), | |||
|
97 | prefix=os.path.basename(filename)) | |||
|
98 | ||||
|
99 | ||||
|
100 | def make_tub(ip, port, secure, cert_file): | |||
|
101 | """Create a listening tub given an ip, port, and cert_file location. | |||
|
102 | ||||
|
103 | Parameters | |||
|
104 | ---------- | |||
|
105 | ip : str | |||
|
106 | The ip address or hostname that the tub should listen on. | |||
|
107 | Empty means all interfaces. | |||
|
108 | port : int | |||
|
109 | The port that the tub should listen on. A value of 0 means | |||
|
110 | pick a random port | |||
|
111 | secure: bool | |||
|
112 | Will the connection be secure (in the Foolscap sense). | |||
|
113 | cert_file: str | |||
|
114 | A filename of a file to be used for theSSL certificate. | |||
|
115 | ||||
|
116 | Returns | |||
|
117 | ------- | |||
|
118 | A tub, listener tuple. | |||
|
119 | """ | |||
|
120 | if secure: | |||
|
121 | if have_crypto: | |||
|
122 | tub = Tub(certFile=cert_file) | |||
|
123 | else: | |||
|
124 | raise SecurityError("OpenSSL/pyOpenSSL is not available, so we " | |||
|
125 | "can't run in secure mode. Try running without " | |||
|
126 | "security using 'ipcontroller -xy'.") | |||
|
127 | else: | |||
|
128 | tub = UnauthenticatedTub() | |||
|
129 | ||||
|
130 | # Set the strport based on the ip and port and start listening | |||
|
131 | if ip == '': | |||
|
132 | strport = "tcp:%i" % port | |||
|
133 | else: | |||
|
134 | strport = "tcp:%i:interface=%s" % (port, ip) | |||
|
135 | listener = tub.listenOn(strport) | |||
|
136 | ||||
|
137 | return tub, listener | |||
|
138 | ||||
|
139 | ||||
|
140 | class FCServiceFactory(AdaptedConfiguredObjectFactory): | |||
|
141 | """This class creates a tub with various services running in it. | |||
|
142 | ||||
|
143 | The basic idea is that :meth:`create` returns a running :class:`Tub` | |||
|
144 | instance that has a number of Foolscap references registered in it. | |||
|
145 | This class is a subclass of :class:`IPython.core.component.Component` | |||
|
146 | so the IPython configuration and component system are used. | |||
|
147 | ||||
|
148 | Attributes | |||
|
149 | ---------- | |||
|
150 | Interfaces : Config | |||
|
151 | A Config instance whose values are sub-Config objects having two | |||
|
152 | keys: furl_file and interface_chain. | |||
|
153 | ||||
|
154 | The other attributes are the standard ones for Foolscap. | |||
|
155 | """ | |||
|
156 | ||||
|
157 | ip = Str('', config=True) | |||
|
158 | port = Int(0, config=True) | |||
|
159 | secure = Bool(True, config=True) | |||
|
160 | cert_file = Str('', config=True) | |||
|
161 | location = Str('', config=True) | |||
|
162 | Interfaces = Instance(klass=Config, kw={}, allow_none=False, config=True) | |||
|
163 | ||||
|
164 | def _ip_changed(self, name, old, new): | |||
|
165 | if new == 'localhost' or new == '127.0.0.1': | |||
|
166 | self.location = '127.0.0.1' | |||
|
167 | ||||
|
168 | def create(self): | |||
|
169 | """Create and return the Foolscap tub with everything running.""" | |||
|
170 | ||||
|
171 | self.tub, self.listener = make_tub( | |||
|
172 | self.ip, self.port, self.secure, self.cert_file) | |||
|
173 | if not self.secure: | |||
|
174 | log.msg("WARNING: running with no security: %s" % self.__class__.__name__) | |||
|
175 | reactor.callWhenRunning(self.set_location_and_register) | |||
|
176 | return self.tub | |||
|
177 | ||||
|
178 | def set_location_and_register(self): | |||
|
179 | """Set the location for the tub and return a deferred.""" | |||
|
180 | ||||
|
181 | if self.location == '': | |||
|
182 | d = self.tub.setLocationAutomatically() | |||
|
183 | else: | |||
|
184 | d = defer.maybeDeferred(self.tub.setLocation, | |||
|
185 | "%s:%i" % (self.location, self.listener.getPortnum())) | |||
|
186 | self.adapt_to_interfaces(d) | |||
|
187 | ||||
|
188 | def adapt_to_interfaces(self, d): | |||
|
189 | """Run through the interfaces, adapt and register.""" | |||
|
190 | ||||
|
191 | for ifname, ifconfig in self.Interfaces.iteritems(): | |||
|
192 | log.msg("Adapting %r to interface: %s" % (self.adaptee, ifname)) | |||
|
193 | log.msg("Saving furl for interface [%s] to file: %s" % (ifname, ifconfig.furl_file)) | |||
|
194 | check_furl_file_security(ifconfig.furl_file, self.secure) | |||
|
195 | adaptee = self.adaptee | |||
|
196 | for i in ifconfig.interface_chain: | |||
|
197 | adaptee = import_item(i)(adaptee) | |||
|
198 | d.addCallback(self.register, adaptee, furl_file=ifconfig.furl_file) | |||
|
199 | ||||
|
200 | def register(self, empty, ref, furl_file): | |||
|
201 | """Register the reference with the FURL file. | |||
|
202 | ||||
|
203 | The FURL file is created and then moved to make sure that when the | |||
|
204 | file appears, the buffer has been flushed and the file closed. | |||
|
205 | """ | |||
|
206 | temp_furl_file = get_temp_furlfile(furl_file) | |||
|
207 | self.tub.registerReference(ref, furlFile=temp_furl_file) | |||
|
208 | os.rename(temp_furl_file, furl_file) | |||
69 |
|
209 |
@@ -1,983 +1,1013 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # encoding: utf-8 |
|
2 | # encoding: utf-8 | |
3 | """ |
|
3 | """ | |
4 | A lightweight Traits like module. |
|
4 | A lightweight Traits like module. | |
5 |
|
5 | |||
6 | This is designed to provide a lightweight, simple, pure Python version of |
|
6 | This is designed to provide a lightweight, simple, pure Python version of | |
7 | many of the capabilities of enthought.traits. This includes: |
|
7 | many of the capabilities of enthought.traits. This includes: | |
8 |
|
8 | |||
9 | * Validation |
|
9 | * Validation | |
10 | * Type specification with defaults |
|
10 | * Type specification with defaults | |
11 | * Static and dynamic notification |
|
11 | * Static and dynamic notification | |
12 | * Basic predefined types |
|
12 | * Basic predefined types | |
13 | * An API that is similar to enthought.traits |
|
13 | * An API that is similar to enthought.traits | |
14 |
|
14 | |||
15 | We don't support: |
|
15 | We don't support: | |
16 |
|
16 | |||
17 | * Delegation |
|
17 | * Delegation | |
18 | * Automatic GUI generation |
|
18 | * Automatic GUI generation | |
19 | * A full set of trait types. Most importantly, we don't provide container |
|
19 | * A full set of trait types. Most importantly, we don't provide container | |
20 | traitlets (list, dict, tuple) that can trigger notifications if their |
|
20 | traitlets (list, dict, tuple) that can trigger notifications if their | |
21 | contents change. |
|
21 | contents change. | |
22 | * API compatibility with enthought.traits |
|
22 | * API compatibility with enthought.traits | |
23 |
|
23 | |||
24 | There are also some important difference in our design: |
|
24 | There are also some important difference in our design: | |
25 |
|
25 | |||
26 | * enthought.traits does not validate default values. We do. |
|
26 | * enthought.traits does not validate default values. We do. | |
27 |
|
27 | |||
28 | We choose to create this module because we need these capabilities, but |
|
28 | We choose to create this module because we need these capabilities, but | |
29 | we need them to be pure Python so they work in all Python implementations, |
|
29 | we need them to be pure Python so they work in all Python implementations, | |
30 | including Jython and IronPython. |
|
30 | including Jython and IronPython. | |
31 |
|
31 | |||
32 | Authors: |
|
32 | Authors: | |
33 |
|
33 | |||
34 | * Brian Granger |
|
34 | * Brian Granger | |
35 | * Enthought, Inc. Some of the code in this file comes from enthought.traits |
|
35 | * Enthought, Inc. Some of the code in this file comes from enthought.traits | |
36 | and is licensed under the BSD license. Also, many of the ideas also come |
|
36 | and is licensed under the BSD license. Also, many of the ideas also come | |
37 | from enthought.traits even though our implementation is very different. |
|
37 | from enthought.traits even though our implementation is very different. | |
38 | """ |
|
38 | """ | |
39 |
|
39 | |||
40 | #----------------------------------------------------------------------------- |
|
40 | #----------------------------------------------------------------------------- | |
41 | # Copyright (C) 2008-2009 The IPython Development Team |
|
41 | # Copyright (C) 2008-2009 The IPython Development Team | |
42 | # |
|
42 | # | |
43 | # Distributed under the terms of the BSD License. The full license is in |
|
43 | # Distributed under the terms of the BSD License. The full license is in | |
44 | # the file COPYING, distributed as part of this software. |
|
44 | # the file COPYING, distributed as part of this software. | |
45 | #----------------------------------------------------------------------------- |
|
45 | #----------------------------------------------------------------------------- | |
46 |
|
46 | |||
47 | #----------------------------------------------------------------------------- |
|
47 | #----------------------------------------------------------------------------- | |
48 | # Imports |
|
48 | # Imports | |
49 | #----------------------------------------------------------------------------- |
|
49 | #----------------------------------------------------------------------------- | |
50 |
|
50 | |||
51 |
|
51 | |||
52 | import inspect |
|
52 | import inspect | |
53 | import sys |
|
53 | import sys | |
54 | import types |
|
54 | import types | |
55 | from types import ( |
|
55 | from types import ( | |
56 | InstanceType, ClassType, FunctionType, |
|
56 | InstanceType, ClassType, FunctionType, | |
57 | ListType, TupleType |
|
57 | ListType, TupleType | |
58 | ) |
|
58 | ) | |
59 |
|
59 | |||
60 | from IPython.utils.importstring import import_item |
|
60 | from IPython.utils.importstring import import_item | |
61 |
|
61 | |||
62 | ClassTypes = (ClassType, type) |
|
62 | ClassTypes = (ClassType, type) | |
63 |
|
63 | |||
64 | SequenceTypes = (ListType, TupleType) |
|
64 | SequenceTypes = (ListType, TupleType) | |
65 |
|
65 | |||
66 | #----------------------------------------------------------------------------- |
|
66 | #----------------------------------------------------------------------------- | |
67 | # Basic classes |
|
67 | # Basic classes | |
68 | #----------------------------------------------------------------------------- |
|
68 | #----------------------------------------------------------------------------- | |
69 |
|
69 | |||
70 |
|
70 | |||
71 | class NoDefaultSpecified ( object ): pass |
|
71 | class NoDefaultSpecified ( object ): pass | |
72 | NoDefaultSpecified = NoDefaultSpecified() |
|
72 | NoDefaultSpecified = NoDefaultSpecified() | |
73 |
|
73 | |||
74 |
|
74 | |||
75 | class Undefined ( object ): pass |
|
75 | class Undefined ( object ): pass | |
76 | Undefined = Undefined() |
|
76 | Undefined = Undefined() | |
77 |
|
77 | |||
78 |
|
78 | |||
79 | class TraitletError(Exception): |
|
79 | class TraitletError(Exception): | |
80 | pass |
|
80 | pass | |
81 |
|
81 | |||
82 |
|
82 | |||
83 | #----------------------------------------------------------------------------- |
|
83 | #----------------------------------------------------------------------------- | |
84 | # Utilities |
|
84 | # Utilities | |
85 | #----------------------------------------------------------------------------- |
|
85 | #----------------------------------------------------------------------------- | |
86 |
|
86 | |||
87 |
|
87 | |||
88 | def class_of ( object ): |
|
88 | def class_of ( object ): | |
89 | """ Returns a string containing the class name of an object with the |
|
89 | """ Returns a string containing the class name of an object with the | |
90 | correct indefinite article ('a' or 'an') preceding it (e.g., 'an Image', |
|
90 | correct indefinite article ('a' or 'an') preceding it (e.g., 'an Image', | |
91 | 'a PlotValue'). |
|
91 | 'a PlotValue'). | |
92 | """ |
|
92 | """ | |
93 | if isinstance( object, basestring ): |
|
93 | if isinstance( object, basestring ): | |
94 | return add_article( object ) |
|
94 | return add_article( object ) | |
95 |
|
95 | |||
96 | return add_article( object.__class__.__name__ ) |
|
96 | return add_article( object.__class__.__name__ ) | |
97 |
|
97 | |||
98 |
|
98 | |||
99 | def add_article ( name ): |
|
99 | def add_article ( name ): | |
100 | """ Returns a string containing the correct indefinite article ('a' or 'an') |
|
100 | """ Returns a string containing the correct indefinite article ('a' or 'an') | |
101 | prefixed to the specified string. |
|
101 | prefixed to the specified string. | |
102 | """ |
|
102 | """ | |
103 | if name[:1].lower() in 'aeiou': |
|
103 | if name[:1].lower() in 'aeiou': | |
104 | return 'an ' + name |
|
104 | return 'an ' + name | |
105 |
|
105 | |||
106 | return 'a ' + name |
|
106 | return 'a ' + name | |
107 |
|
107 | |||
108 |
|
108 | |||
109 | def repr_type(obj): |
|
109 | def repr_type(obj): | |
110 | """ Return a string representation of a value and its type for readable |
|
110 | """ Return a string representation of a value and its type for readable | |
111 | error messages. |
|
111 | error messages. | |
112 | """ |
|
112 | """ | |
113 | the_type = type(obj) |
|
113 | the_type = type(obj) | |
114 | if the_type is InstanceType: |
|
114 | if the_type is InstanceType: | |
115 | # Old-style class. |
|
115 | # Old-style class. | |
116 | the_type = obj.__class__ |
|
116 | the_type = obj.__class__ | |
117 | msg = '%r %r' % (obj, the_type) |
|
117 | msg = '%r %r' % (obj, the_type) | |
118 | return msg |
|
118 | return msg | |
119 |
|
119 | |||
120 |
|
120 | |||
121 | def parse_notifier_name(name): |
|
121 | def parse_notifier_name(name): | |
122 | """Convert the name argument to a list of names. |
|
122 | """Convert the name argument to a list of names. | |
123 |
|
123 | |||
124 | Examples |
|
124 | Examples | |
125 | -------- |
|
125 | -------- | |
126 |
|
126 | |||
127 | >>> parse_notifier_name('a') |
|
127 | >>> parse_notifier_name('a') | |
128 | ['a'] |
|
128 | ['a'] | |
129 | >>> parse_notifier_name(['a','b']) |
|
129 | >>> parse_notifier_name(['a','b']) | |
130 | ['a', 'b'] |
|
130 | ['a', 'b'] | |
131 | >>> parse_notifier_name(None) |
|
131 | >>> parse_notifier_name(None) | |
132 | ['anytraitlet'] |
|
132 | ['anytraitlet'] | |
133 | """ |
|
133 | """ | |
134 | if isinstance(name, str): |
|
134 | if isinstance(name, str): | |
135 | return [name] |
|
135 | return [name] | |
136 | elif name is None: |
|
136 | elif name is None: | |
137 | return ['anytraitlet'] |
|
137 | return ['anytraitlet'] | |
138 | elif isinstance(name, (list, tuple)): |
|
138 | elif isinstance(name, (list, tuple)): | |
139 | for n in name: |
|
139 | for n in name: | |
140 | assert isinstance(n, str), "names must be strings" |
|
140 | assert isinstance(n, str), "names must be strings" | |
141 | return name |
|
141 | return name | |
142 |
|
142 | |||
143 |
|
143 | |||
144 | class _SimpleTest: |
|
144 | class _SimpleTest: | |
145 | def __init__ ( self, value ): self.value = value |
|
145 | def __init__ ( self, value ): self.value = value | |
146 | def __call__ ( self, test ): |
|
146 | def __call__ ( self, test ): | |
147 | return test == self.value |
|
147 | return test == self.value | |
148 | def __repr__(self): |
|
148 | def __repr__(self): | |
149 | return "<SimpleTest(%r)" % self.value |
|
149 | return "<SimpleTest(%r)" % self.value | |
150 | def __str__(self): |
|
150 | def __str__(self): | |
151 | return self.__repr__() |
|
151 | return self.__repr__() | |
152 |
|
152 | |||
153 |
|
153 | |||
|
154 | def getmembers(object, predicate=None): | |||
|
155 | """A safe version of inspect.getmembers that handles missing attributes. | |||
|
156 | ||||
|
157 | This is useful when there are descriptor based attributes that for | |||
|
158 | some reason raise AttributeError even though they exist. This happens | |||
|
159 | in zope.inteface with the __provides__ attribute. | |||
|
160 | """ | |||
|
161 | results = [] | |||
|
162 | for key in dir(object): | |||
|
163 | try: | |||
|
164 | value = getattr(object, key) | |||
|
165 | except AttributeError: | |||
|
166 | pass | |||
|
167 | else: | |||
|
168 | if not predicate or predicate(value): | |||
|
169 | results.append((key, value)) | |||
|
170 | results.sort() | |||
|
171 | return results | |||
|
172 | ||||
|
173 | ||||
154 | #----------------------------------------------------------------------------- |
|
174 | #----------------------------------------------------------------------------- | |
155 | # Base TraitletType for all traitlets |
|
175 | # Base TraitletType for all traitlets | |
156 | #----------------------------------------------------------------------------- |
|
176 | #----------------------------------------------------------------------------- | |
157 |
|
177 | |||
158 |
|
178 | |||
159 | class TraitletType(object): |
|
179 | class TraitletType(object): | |
160 | """A base class for all traitlet descriptors. |
|
180 | """A base class for all traitlet descriptors. | |
161 |
|
181 | |||
162 | Notes |
|
182 | Notes | |
163 | ----- |
|
183 | ----- | |
164 | Our implementation of traitlets is based on Python's descriptor |
|
184 | Our implementation of traitlets is based on Python's descriptor | |
165 | prototol. This class is the base class for all such descriptors. The |
|
185 | prototol. This class is the base class for all such descriptors. The | |
166 | only magic we use is a custom metaclass for the main :class:`HasTraitlets` |
|
186 | only magic we use is a custom metaclass for the main :class:`HasTraitlets` | |
167 | class that does the following: |
|
187 | class that does the following: | |
168 |
|
188 | |||
169 | 1. Sets the :attr:`name` attribute of every :class:`TraitletType` |
|
189 | 1. Sets the :attr:`name` attribute of every :class:`TraitletType` | |
170 | instance in the class dict to the name of the attribute. |
|
190 | instance in the class dict to the name of the attribute. | |
171 | 2. Sets the :attr:`this_class` attribute of every :class:`TraitletType` |
|
191 | 2. Sets the :attr:`this_class` attribute of every :class:`TraitletType` | |
172 | instance in the class dict to the *class* that declared the traitlet. |
|
192 | instance in the class dict to the *class* that declared the traitlet. | |
173 | This is used by the :class:`This` traitlet to allow subclasses to |
|
193 | This is used by the :class:`This` traitlet to allow subclasses to | |
174 | accept superclasses for :class:`This` values. |
|
194 | accept superclasses for :class:`This` values. | |
175 | """ |
|
195 | """ | |
176 |
|
196 | |||
177 |
|
197 | |||
178 | metadata = {} |
|
198 | metadata = {} | |
179 | default_value = Undefined |
|
199 | default_value = Undefined | |
180 | info_text = 'any value' |
|
200 | info_text = 'any value' | |
181 |
|
201 | |||
182 | def __init__(self, default_value=NoDefaultSpecified, **metadata): |
|
202 | def __init__(self, default_value=NoDefaultSpecified, **metadata): | |
183 | """Create a TraitletType. |
|
203 | """Create a TraitletType. | |
184 | """ |
|
204 | """ | |
185 | if default_value is not NoDefaultSpecified: |
|
205 | if default_value is not NoDefaultSpecified: | |
186 | self.default_value = default_value |
|
206 | self.default_value = default_value | |
187 |
|
207 | |||
188 | if len(metadata) > 0: |
|
208 | if len(metadata) > 0: | |
189 | if len(self.metadata) > 0: |
|
209 | if len(self.metadata) > 0: | |
190 | self._metadata = self.metadata.copy() |
|
210 | self._metadata = self.metadata.copy() | |
191 | self._metadata.update(metadata) |
|
211 | self._metadata.update(metadata) | |
192 | else: |
|
212 | else: | |
193 | self._metadata = metadata |
|
213 | self._metadata = metadata | |
194 | else: |
|
214 | else: | |
195 | self._metadata = self.metadata |
|
215 | self._metadata = self.metadata | |
196 |
|
216 | |||
197 | self.init() |
|
217 | self.init() | |
198 |
|
218 | |||
199 | def init(self): |
|
219 | def init(self): | |
200 | pass |
|
220 | pass | |
201 |
|
221 | |||
202 | def get_default_value(self): |
|
222 | def get_default_value(self): | |
203 | """Create a new instance of the default value.""" |
|
223 | """Create a new instance of the default value.""" | |
204 | dv = self.default_value |
|
224 | dv = self.default_value | |
205 | return dv |
|
225 | return dv | |
206 |
|
226 | |||
207 | def instance_init(self, obj): |
|
227 | def instance_init(self, obj): | |
208 | """This is called by :meth:`HasTraitlets.__new__` to finish init'ing. |
|
228 | """This is called by :meth:`HasTraitlets.__new__` to finish init'ing. | |
209 |
|
229 | |||
210 | Some stages of initialization must be delayed until the parent |
|
230 | Some stages of initialization must be delayed until the parent | |
211 | :class:`HasTraitlets` instance has been created. This method is |
|
231 | :class:`HasTraitlets` instance has been created. This method is | |
212 | called in :meth:`HasTraitlets.__new__` after the instance has been |
|
232 | called in :meth:`HasTraitlets.__new__` after the instance has been | |
213 | created. |
|
233 | created. | |
214 |
|
234 | |||
215 | This method trigger the creation and validation of default values |
|
235 | This method trigger the creation and validation of default values | |
216 | and also things like the resolution of str given class names in |
|
236 | and also things like the resolution of str given class names in | |
217 | :class:`Type` and :class`Instance`. |
|
237 | :class:`Type` and :class`Instance`. | |
218 |
|
238 | |||
219 | Parameters |
|
239 | Parameters | |
220 | ---------- |
|
240 | ---------- | |
221 | obj : :class:`HasTraitlets` instance |
|
241 | obj : :class:`HasTraitlets` instance | |
222 | The parent :class:`HasTraitlets` instance that has just been |
|
242 | The parent :class:`HasTraitlets` instance that has just been | |
223 | created. |
|
243 | created. | |
224 | """ |
|
244 | """ | |
225 | self.set_default_value(obj) |
|
245 | self.set_default_value(obj) | |
226 |
|
246 | |||
227 | def set_default_value(self, obj): |
|
247 | def set_default_value(self, obj): | |
228 | """Set the default value on a per instance basis. |
|
248 | """Set the default value on a per instance basis. | |
229 |
|
249 | |||
230 | This method is called by :meth:`instance_init` to create and |
|
250 | This method is called by :meth:`instance_init` to create and | |
231 | validate the default value. The creation and validation of |
|
251 | validate the default value. The creation and validation of | |
232 | default values must be delayed until the parent :class:`HasTraitlets` |
|
252 | default values must be delayed until the parent :class:`HasTraitlets` | |
233 | class has been instantiated. |
|
253 | class has been instantiated. | |
234 | """ |
|
254 | """ | |
235 | dv = self.get_default_value() |
|
255 | dv = self.get_default_value() | |
236 | newdv = self._validate(obj, dv) |
|
256 | newdv = self._validate(obj, dv) | |
237 | obj._traitlet_values[self.name] = newdv |
|
257 | obj._traitlet_values[self.name] = newdv | |
238 |
|
258 | |||
239 | def __get__(self, obj, cls=None): |
|
259 | def __get__(self, obj, cls=None): | |
240 | """Get the value of the traitlet by self.name for the instance. |
|
260 | """Get the value of the traitlet by self.name for the instance. | |
241 |
|
261 | |||
242 | Default values are instantiated when :meth:`HasTraitlets.__new__` |
|
262 | Default values are instantiated when :meth:`HasTraitlets.__new__` | |
243 | is called. Thus by the time this method gets called either the |
|
263 | is called. Thus by the time this method gets called either the | |
244 | default value or a user defined value (they called :meth:`__set__`) |
|
264 | default value or a user defined value (they called :meth:`__set__`) | |
245 | is in the :class:`HasTraitlets` instance. |
|
265 | is in the :class:`HasTraitlets` instance. | |
246 | """ |
|
266 | """ | |
247 | if obj is None: |
|
267 | if obj is None: | |
248 | return self |
|
268 | return self | |
249 | else: |
|
269 | else: | |
250 | try: |
|
270 | try: | |
251 | value = obj._traitlet_values[self.name] |
|
271 | value = obj._traitlet_values[self.name] | |
252 | except: |
|
272 | except: | |
253 | # HasTraitlets should call set_default_value to populate |
|
273 | # HasTraitlets should call set_default_value to populate | |
254 | # this. So this should never be reached. |
|
274 | # this. So this should never be reached. | |
255 | raise TraitletError('Unexpected error in TraitletType: ' |
|
275 | raise TraitletError('Unexpected error in TraitletType: ' | |
256 | 'default value not set properly') |
|
276 | 'default value not set properly') | |
257 | else: |
|
277 | else: | |
258 | return value |
|
278 | return value | |
259 |
|
279 | |||
260 | def __set__(self, obj, value): |
|
280 | def __set__(self, obj, value): | |
261 | new_value = self._validate(obj, value) |
|
281 | new_value = self._validate(obj, value) | |
262 | old_value = self.__get__(obj) |
|
282 | old_value = self.__get__(obj) | |
263 | if old_value != new_value: |
|
283 | if old_value != new_value: | |
264 | obj._traitlet_values[self.name] = new_value |
|
284 | obj._traitlet_values[self.name] = new_value | |
265 | obj._notify_traitlet(self.name, old_value, new_value) |
|
285 | obj._notify_traitlet(self.name, old_value, new_value) | |
266 |
|
286 | |||
267 | def _validate(self, obj, value): |
|
287 | def _validate(self, obj, value): | |
268 | if hasattr(self, 'validate'): |
|
288 | if hasattr(self, 'validate'): | |
269 | return self.validate(obj, value) |
|
289 | return self.validate(obj, value) | |
270 | elif hasattr(self, 'is_valid_for'): |
|
290 | elif hasattr(self, 'is_valid_for'): | |
271 | valid = self.is_valid_for(value) |
|
291 | valid = self.is_valid_for(value) | |
272 | if valid: |
|
292 | if valid: | |
273 | return value |
|
293 | return value | |
274 | else: |
|
294 | else: | |
275 | raise TraitletError('invalid value for type: %r' % value) |
|
295 | raise TraitletError('invalid value for type: %r' % value) | |
276 | elif hasattr(self, 'value_for'): |
|
296 | elif hasattr(self, 'value_for'): | |
277 | return self.value_for(value) |
|
297 | return self.value_for(value) | |
278 | else: |
|
298 | else: | |
279 | return value |
|
299 | return value | |
280 |
|
300 | |||
281 | def info(self): |
|
301 | def info(self): | |
282 | return self.info_text |
|
302 | return self.info_text | |
283 |
|
303 | |||
284 | def error(self, obj, value): |
|
304 | def error(self, obj, value): | |
285 | if obj is not None: |
|
305 | if obj is not None: | |
286 | e = "The '%s' traitlet of %s instance must be %s, but a value of %s was specified." \ |
|
306 | e = "The '%s' traitlet of %s instance must be %s, but a value of %s was specified." \ | |
287 | % (self.name, class_of(obj), |
|
307 | % (self.name, class_of(obj), | |
288 | self.info(), repr_type(value)) |
|
308 | self.info(), repr_type(value)) | |
289 | else: |
|
309 | else: | |
290 | e = "The '%s' traitlet must be %s, but a value of %r was specified." \ |
|
310 | e = "The '%s' traitlet must be %s, but a value of %r was specified." \ | |
291 | % (self.name, self.info(), repr_type(value)) |
|
311 | % (self.name, self.info(), repr_type(value)) | |
292 | raise TraitletError(e) |
|
312 | raise TraitletError(e) | |
293 |
|
313 | |||
294 | def get_metadata(self, key): |
|
314 | def get_metadata(self, key): | |
295 | return getattr(self, '_metadata', {}).get(key, None) |
|
315 | return getattr(self, '_metadata', {}).get(key, None) | |
296 |
|
316 | |||
297 | def set_metadata(self, key, value): |
|
317 | def set_metadata(self, key, value): | |
298 | getattr(self, '_metadata', {})[key] = value |
|
318 | getattr(self, '_metadata', {})[key] = value | |
299 |
|
319 | |||
300 |
|
320 | |||
301 | #----------------------------------------------------------------------------- |
|
321 | #----------------------------------------------------------------------------- | |
302 | # The HasTraitlets implementation |
|
322 | # The HasTraitlets implementation | |
303 | #----------------------------------------------------------------------------- |
|
323 | #----------------------------------------------------------------------------- | |
304 |
|
324 | |||
305 |
|
325 | |||
306 | class MetaHasTraitlets(type): |
|
326 | class MetaHasTraitlets(type): | |
307 | """A metaclass for HasTraitlets. |
|
327 | """A metaclass for HasTraitlets. | |
308 |
|
328 | |||
309 | This metaclass makes sure that any TraitletType class attributes are |
|
329 | This metaclass makes sure that any TraitletType class attributes are | |
310 | instantiated and sets their name attribute. |
|
330 | instantiated and sets their name attribute. | |
311 | """ |
|
331 | """ | |
312 |
|
332 | |||
313 | def __new__(mcls, name, bases, classdict): |
|
333 | def __new__(mcls, name, bases, classdict): | |
314 | """Create the HasTraitlets class. |
|
334 | """Create the HasTraitlets class. | |
315 |
|
335 | |||
316 | This instantiates all TraitletTypes in the class dict and sets their |
|
336 | This instantiates all TraitletTypes in the class dict and sets their | |
317 | :attr:`name` attribute. |
|
337 | :attr:`name` attribute. | |
318 | """ |
|
338 | """ | |
|
339 | # print "MetaHasTraitlets (mcls, name): ", mcls, name | |||
|
340 | # print "MetaHasTraitlets (bases): ", bases | |||
|
341 | # print "MetaHasTraitlets (classdict): ", classdict | |||
319 | for k,v in classdict.iteritems(): |
|
342 | for k,v in classdict.iteritems(): | |
320 | if isinstance(v, TraitletType): |
|
343 | if isinstance(v, TraitletType): | |
321 | v.name = k |
|
344 | v.name = k | |
322 | elif inspect.isclass(v): |
|
345 | elif inspect.isclass(v): | |
323 | if issubclass(v, TraitletType): |
|
346 | if issubclass(v, TraitletType): | |
324 | vinst = v() |
|
347 | vinst = v() | |
325 | vinst.name = k |
|
348 | vinst.name = k | |
326 | classdict[k] = vinst |
|
349 | classdict[k] = vinst | |
327 | return super(MetaHasTraitlets, mcls).__new__(mcls, name, bases, classdict) |
|
350 | return super(MetaHasTraitlets, mcls).__new__(mcls, name, bases, classdict) | |
328 |
|
351 | |||
329 | def __init__(cls, name, bases, classdict): |
|
352 | def __init__(cls, name, bases, classdict): | |
330 | """Finish initializing the HasTraitlets class. |
|
353 | """Finish initializing the HasTraitlets class. | |
331 |
|
354 | |||
332 | This sets the :attr:`this_class` attribute of each TraitletType in the |
|
355 | This sets the :attr:`this_class` attribute of each TraitletType in the | |
333 | class dict to the newly created class ``cls``. |
|
356 | class dict to the newly created class ``cls``. | |
334 | """ |
|
357 | """ | |
335 | for k, v in classdict.iteritems(): |
|
358 | for k, v in classdict.iteritems(): | |
336 | if isinstance(v, TraitletType): |
|
359 | if isinstance(v, TraitletType): | |
337 | v.this_class = cls |
|
360 | v.this_class = cls | |
338 | super(MetaHasTraitlets, cls).__init__(name, bases, classdict) |
|
361 | super(MetaHasTraitlets, cls).__init__(name, bases, classdict) | |
339 |
|
362 | |||
340 | class HasTraitlets(object): |
|
363 | class HasTraitlets(object): | |
341 |
|
364 | |||
342 | __metaclass__ = MetaHasTraitlets |
|
365 | __metaclass__ = MetaHasTraitlets | |
343 |
|
366 | |||
344 | def __new__(cls, *args, **kw): |
|
367 | def __new__(cls, *args, **kw): | |
345 | # This is needed because in Python 2.6 object.__new__ only accepts |
|
368 | # This is needed because in Python 2.6 object.__new__ only accepts | |
346 | # the cls argument. |
|
369 | # the cls argument. | |
347 | new_meth = super(HasTraitlets, cls).__new__ |
|
370 | new_meth = super(HasTraitlets, cls).__new__ | |
348 | if new_meth is object.__new__: |
|
371 | if new_meth is object.__new__: | |
349 | inst = new_meth(cls) |
|
372 | inst = new_meth(cls) | |
350 | else: |
|
373 | else: | |
351 | inst = new_meth(cls, *args, **kw) |
|
374 | inst = new_meth(cls, *args, **kw) | |
352 | inst._traitlet_values = {} |
|
375 | inst._traitlet_values = {} | |
353 | inst._traitlet_notifiers = {} |
|
376 | inst._traitlet_notifiers = {} | |
354 | # Here we tell all the TraitletType instances to set their default |
|
377 | # Here we tell all the TraitletType instances to set their default | |
355 | # values on the instance. |
|
378 | # values on the instance. | |
356 | for key in dir(cls): |
|
379 | for key in dir(cls): | |
357 | value = getattr(cls, key) |
|
380 | # Some descriptors raise AttributeError like zope.interface's | |
358 | if isinstance(value, TraitletType): |
|
381 | # __provides__ attributes even though they exist. This causes | |
359 | value.instance_init(inst) |
|
382 | # AttributeErrors even though they are listed in dir(cls). | |
|
383 | try: | |||
|
384 | value = getattr(cls, key) | |||
|
385 | except AttributeError: | |||
|
386 | pass | |||
|
387 | else: | |||
|
388 | if isinstance(value, TraitletType): | |||
|
389 | value.instance_init(inst) | |||
360 | return inst |
|
390 | return inst | |
361 |
|
391 | |||
362 | # def __init__(self): |
|
392 | # def __init__(self): | |
363 | # self._traitlet_values = {} |
|
393 | # self._traitlet_values = {} | |
364 | # self._traitlet_notifiers = {} |
|
394 | # self._traitlet_notifiers = {} | |
365 |
|
395 | |||
366 | def _notify_traitlet(self, name, old_value, new_value): |
|
396 | def _notify_traitlet(self, name, old_value, new_value): | |
367 |
|
397 | |||
368 | # First dynamic ones |
|
398 | # First dynamic ones | |
369 | callables = self._traitlet_notifiers.get(name,[]) |
|
399 | callables = self._traitlet_notifiers.get(name,[]) | |
370 | more_callables = self._traitlet_notifiers.get('anytraitlet',[]) |
|
400 | more_callables = self._traitlet_notifiers.get('anytraitlet',[]) | |
371 | callables.extend(more_callables) |
|
401 | callables.extend(more_callables) | |
372 |
|
402 | |||
373 | # Now static ones |
|
403 | # Now static ones | |
374 | try: |
|
404 | try: | |
375 | cb = getattr(self, '_%s_changed' % name) |
|
405 | cb = getattr(self, '_%s_changed' % name) | |
376 | except: |
|
406 | except: | |
377 | pass |
|
407 | pass | |
378 | else: |
|
408 | else: | |
379 | callables.append(cb) |
|
409 | callables.append(cb) | |
380 |
|
410 | |||
381 | # Call them all now |
|
411 | # Call them all now | |
382 | for c in callables: |
|
412 | for c in callables: | |
383 | # Traits catches and logs errors here. I allow them to raise |
|
413 | # Traits catches and logs errors here. I allow them to raise | |
384 | if callable(c): |
|
414 | if callable(c): | |
385 | argspec = inspect.getargspec(c) |
|
415 | argspec = inspect.getargspec(c) | |
386 | nargs = len(argspec[0]) |
|
416 | nargs = len(argspec[0]) | |
387 | # Bound methods have an additional 'self' argument |
|
417 | # Bound methods have an additional 'self' argument | |
388 | # I don't know how to treat unbound methods, but they |
|
418 | # I don't know how to treat unbound methods, but they | |
389 | # can't really be used for callbacks. |
|
419 | # can't really be used for callbacks. | |
390 | if isinstance(c, types.MethodType): |
|
420 | if isinstance(c, types.MethodType): | |
391 | offset = -1 |
|
421 | offset = -1 | |
392 | else: |
|
422 | else: | |
393 | offset = 0 |
|
423 | offset = 0 | |
394 | if nargs + offset == 0: |
|
424 | if nargs + offset == 0: | |
395 | c() |
|
425 | c() | |
396 | elif nargs + offset == 1: |
|
426 | elif nargs + offset == 1: | |
397 | c(name) |
|
427 | c(name) | |
398 | elif nargs + offset == 2: |
|
428 | elif nargs + offset == 2: | |
399 | c(name, new_value) |
|
429 | c(name, new_value) | |
400 | elif nargs + offset == 3: |
|
430 | elif nargs + offset == 3: | |
401 | c(name, old_value, new_value) |
|
431 | c(name, old_value, new_value) | |
402 | else: |
|
432 | else: | |
403 | raise TraitletError('a traitlet changed callback ' |
|
433 | raise TraitletError('a traitlet changed callback ' | |
404 | 'must have 0-3 arguments.') |
|
434 | 'must have 0-3 arguments.') | |
405 | else: |
|
435 | else: | |
406 | raise TraitletError('a traitlet changed callback ' |
|
436 | raise TraitletError('a traitlet changed callback ' | |
407 | 'must be callable.') |
|
437 | 'must be callable.') | |
408 |
|
438 | |||
409 |
|
439 | |||
410 | def _add_notifiers(self, handler, name): |
|
440 | def _add_notifiers(self, handler, name): | |
411 | if not self._traitlet_notifiers.has_key(name): |
|
441 | if not self._traitlet_notifiers.has_key(name): | |
412 | nlist = [] |
|
442 | nlist = [] | |
413 | self._traitlet_notifiers[name] = nlist |
|
443 | self._traitlet_notifiers[name] = nlist | |
414 | else: |
|
444 | else: | |
415 | nlist = self._traitlet_notifiers[name] |
|
445 | nlist = self._traitlet_notifiers[name] | |
416 | if handler not in nlist: |
|
446 | if handler not in nlist: | |
417 | nlist.append(handler) |
|
447 | nlist.append(handler) | |
418 |
|
448 | |||
419 | def _remove_notifiers(self, handler, name): |
|
449 | def _remove_notifiers(self, handler, name): | |
420 | if self._traitlet_notifiers.has_key(name): |
|
450 | if self._traitlet_notifiers.has_key(name): | |
421 | nlist = self._traitlet_notifiers[name] |
|
451 | nlist = self._traitlet_notifiers[name] | |
422 | try: |
|
452 | try: | |
423 | index = nlist.index(handler) |
|
453 | index = nlist.index(handler) | |
424 | except ValueError: |
|
454 | except ValueError: | |
425 | pass |
|
455 | pass | |
426 | else: |
|
456 | else: | |
427 | del nlist[index] |
|
457 | del nlist[index] | |
428 |
|
458 | |||
429 | def on_traitlet_change(self, handler, name=None, remove=False): |
|
459 | def on_traitlet_change(self, handler, name=None, remove=False): | |
430 | """Setup a handler to be called when a traitlet changes. |
|
460 | """Setup a handler to be called when a traitlet changes. | |
431 |
|
461 | |||
432 | This is used to setup dynamic notifications of traitlet changes. |
|
462 | This is used to setup dynamic notifications of traitlet changes. | |
433 |
|
463 | |||
434 | Static handlers can be created by creating methods on a HasTraitlets |
|
464 | Static handlers can be created by creating methods on a HasTraitlets | |
435 | subclass with the naming convention '_[traitletname]_changed'. Thus, |
|
465 | subclass with the naming convention '_[traitletname]_changed'. Thus, | |
436 | to create static handler for the traitlet 'a', create the method |
|
466 | to create static handler for the traitlet 'a', create the method | |
437 | _a_changed(self, name, old, new) (fewer arguments can be used, see |
|
467 | _a_changed(self, name, old, new) (fewer arguments can be used, see | |
438 | below). |
|
468 | below). | |
439 |
|
469 | |||
440 | Parameters |
|
470 | Parameters | |
441 | ---------- |
|
471 | ---------- | |
442 | handler : callable |
|
472 | handler : callable | |
443 | A callable that is called when a traitlet changes. Its |
|
473 | A callable that is called when a traitlet changes. Its | |
444 | signature can be handler(), handler(name), handler(name, new) |
|
474 | signature can be handler(), handler(name), handler(name, new) | |
445 | or handler(name, old, new). |
|
475 | or handler(name, old, new). | |
446 | name : list, str, None |
|
476 | name : list, str, None | |
447 | If None, the handler will apply to all traitlets. If a list |
|
477 | If None, the handler will apply to all traitlets. If a list | |
448 | of str, handler will apply to all names in the list. If a |
|
478 | of str, handler will apply to all names in the list. If a | |
449 | str, the handler will apply just to that name. |
|
479 | str, the handler will apply just to that name. | |
450 | remove : bool |
|
480 | remove : bool | |
451 | If False (the default), then install the handler. If True |
|
481 | If False (the default), then install the handler. If True | |
452 | then unintall it. |
|
482 | then unintall it. | |
453 | """ |
|
483 | """ | |
454 | if remove: |
|
484 | if remove: | |
455 | names = parse_notifier_name(name) |
|
485 | names = parse_notifier_name(name) | |
456 | for n in names: |
|
486 | for n in names: | |
457 | self._remove_notifiers(handler, n) |
|
487 | self._remove_notifiers(handler, n) | |
458 | else: |
|
488 | else: | |
459 | names = parse_notifier_name(name) |
|
489 | names = parse_notifier_name(name) | |
460 | for n in names: |
|
490 | for n in names: | |
461 | self._add_notifiers(handler, n) |
|
491 | self._add_notifiers(handler, n) | |
462 |
|
492 | |||
463 | def traitlet_names(self, **metadata): |
|
493 | def traitlet_names(self, **metadata): | |
464 | """Get a list of all the names of this classes traitlets.""" |
|
494 | """Get a list of all the names of this classes traitlets.""" | |
465 | return self.traitlets(**metadata).keys() |
|
495 | return self.traitlets(**metadata).keys() | |
466 |
|
496 | |||
467 | def traitlets(self, **metadata): |
|
497 | def traitlets(self, **metadata): | |
468 | """Get a list of all the traitlets of this class. |
|
498 | """Get a list of all the traitlets of this class. | |
469 |
|
499 | |||
470 | The TraitletTypes returned don't know anything about the values |
|
500 | The TraitletTypes returned don't know anything about the values | |
471 | that the various HasTraitlet's instances are holding. |
|
501 | that the various HasTraitlet's instances are holding. | |
472 |
|
502 | |||
473 | This follows the same algorithm as traits does and does not allow |
|
503 | This follows the same algorithm as traits does and does not allow | |
474 | for any simple way of specifying merely that a metadata name |
|
504 | for any simple way of specifying merely that a metadata name | |
475 | exists, but has any value. This is because get_metadata returns |
|
505 | exists, but has any value. This is because get_metadata returns | |
476 | None if a metadata key doesn't exist. |
|
506 | None if a metadata key doesn't exist. | |
477 | """ |
|
507 | """ | |
478 |
traitlets = dict([memb for memb in |
|
508 | traitlets = dict([memb for memb in getmembers(self.__class__) if \ | |
479 | isinstance(memb[1], TraitletType)]) |
|
509 | isinstance(memb[1], TraitletType)]) | |
480 |
|
510 | |||
481 | if len(metadata) == 0: |
|
511 | if len(metadata) == 0: | |
482 | return traitlets |
|
512 | return traitlets | |
483 |
|
513 | |||
484 | for meta_name, meta_eval in metadata.items(): |
|
514 | for meta_name, meta_eval in metadata.items(): | |
485 | if type(meta_eval) is not FunctionType: |
|
515 | if type(meta_eval) is not FunctionType: | |
486 | metadata[meta_name] = _SimpleTest(meta_eval) |
|
516 | metadata[meta_name] = _SimpleTest(meta_eval) | |
487 |
|
517 | |||
488 | result = {} |
|
518 | result = {} | |
489 | for name, traitlet in traitlets.items(): |
|
519 | for name, traitlet in traitlets.items(): | |
490 | for meta_name, meta_eval in metadata.items(): |
|
520 | for meta_name, meta_eval in metadata.items(): | |
491 | if not meta_eval(traitlet.get_metadata(meta_name)): |
|
521 | if not meta_eval(traitlet.get_metadata(meta_name)): | |
492 | break |
|
522 | break | |
493 | else: |
|
523 | else: | |
494 | result[name] = traitlet |
|
524 | result[name] = traitlet | |
495 |
|
525 | |||
496 | return result |
|
526 | return result | |
497 |
|
527 | |||
498 | def traitlet_metadata(self, traitletname, key): |
|
528 | def traitlet_metadata(self, traitletname, key): | |
499 | """Get metadata values for traitlet by key.""" |
|
529 | """Get metadata values for traitlet by key.""" | |
500 | try: |
|
530 | try: | |
501 | traitlet = getattr(self.__class__, traitletname) |
|
531 | traitlet = getattr(self.__class__, traitletname) | |
502 | except AttributeError: |
|
532 | except AttributeError: | |
503 | raise TraitletError("Class %s does not have a traitlet named %s" % |
|
533 | raise TraitletError("Class %s does not have a traitlet named %s" % | |
504 | (self.__class__.__name__, traitletname)) |
|
534 | (self.__class__.__name__, traitletname)) | |
505 | else: |
|
535 | else: | |
506 | return traitlet.get_metadata(key) |
|
536 | return traitlet.get_metadata(key) | |
507 |
|
537 | |||
508 | #----------------------------------------------------------------------------- |
|
538 | #----------------------------------------------------------------------------- | |
509 | # Actual TraitletTypes implementations/subclasses |
|
539 | # Actual TraitletTypes implementations/subclasses | |
510 | #----------------------------------------------------------------------------- |
|
540 | #----------------------------------------------------------------------------- | |
511 |
|
541 | |||
512 | #----------------------------------------------------------------------------- |
|
542 | #----------------------------------------------------------------------------- | |
513 | # TraitletTypes subclasses for handling classes and instances of classes |
|
543 | # TraitletTypes subclasses for handling classes and instances of classes | |
514 | #----------------------------------------------------------------------------- |
|
544 | #----------------------------------------------------------------------------- | |
515 |
|
545 | |||
516 |
|
546 | |||
517 | class ClassBasedTraitletType(TraitletType): |
|
547 | class ClassBasedTraitletType(TraitletType): | |
518 | """A traitlet with error reporting for Type, Instance and This.""" |
|
548 | """A traitlet with error reporting for Type, Instance and This.""" | |
519 |
|
549 | |||
520 | def error(self, obj, value): |
|
550 | def error(self, obj, value): | |
521 | kind = type(value) |
|
551 | kind = type(value) | |
522 | if kind is InstanceType: |
|
552 | if kind is InstanceType: | |
523 | msg = 'class %s' % value.__class__.__name__ |
|
553 | msg = 'class %s' % value.__class__.__name__ | |
524 | else: |
|
554 | else: | |
525 | msg = '%s (i.e. %s)' % ( str( kind )[1:-1], repr( value ) ) |
|
555 | msg = '%s (i.e. %s)' % ( str( kind )[1:-1], repr( value ) ) | |
526 |
|
556 | |||
527 | super(ClassBasedTraitletType, self).error(obj, msg) |
|
557 | super(ClassBasedTraitletType, self).error(obj, msg) | |
528 |
|
558 | |||
529 |
|
559 | |||
530 | class Type(ClassBasedTraitletType): |
|
560 | class Type(ClassBasedTraitletType): | |
531 | """A traitlet whose value must be a subclass of a specified class.""" |
|
561 | """A traitlet whose value must be a subclass of a specified class.""" | |
532 |
|
562 | |||
533 | def __init__ (self, default_value=None, klass=None, allow_none=True, **metadata ): |
|
563 | def __init__ (self, default_value=None, klass=None, allow_none=True, **metadata ): | |
534 | """Construct a Type traitlet |
|
564 | """Construct a Type traitlet | |
535 |
|
565 | |||
536 | A Type traitlet specifies that its values must be subclasses of |
|
566 | A Type traitlet specifies that its values must be subclasses of | |
537 | a particular class. |
|
567 | a particular class. | |
538 |
|
568 | |||
539 | If only ``default_value`` is given, it is used for the ``klass`` as |
|
569 | If only ``default_value`` is given, it is used for the ``klass`` as | |
540 | well. |
|
570 | well. | |
541 |
|
571 | |||
542 | Parameters |
|
572 | Parameters | |
543 | ---------- |
|
573 | ---------- | |
544 | default_value : class, str or None |
|
574 | default_value : class, str or None | |
545 | The default value must be a subclass of klass. If an str, |
|
575 | The default value must be a subclass of klass. If an str, | |
546 | the str must be a fully specified class name, like 'foo.bar.Bah'. |
|
576 | the str must be a fully specified class name, like 'foo.bar.Bah'. | |
547 | The string is resolved into real class, when the parent |
|
577 | The string is resolved into real class, when the parent | |
548 | :class:`HasTraitlets` class is instantiated. |
|
578 | :class:`HasTraitlets` class is instantiated. | |
549 | klass : class, str, None |
|
579 | klass : class, str, None | |
550 | Values of this traitlet must be a subclass of klass. The klass |
|
580 | Values of this traitlet must be a subclass of klass. The klass | |
551 | may be specified in a string like: 'foo.bar.MyClass'. |
|
581 | may be specified in a string like: 'foo.bar.MyClass'. | |
552 | The string is resolved into real class, when the parent |
|
582 | The string is resolved into real class, when the parent | |
553 | :class:`HasTraitlets` class is instantiated. |
|
583 | :class:`HasTraitlets` class is instantiated. | |
554 | allow_none : boolean |
|
584 | allow_none : boolean | |
555 | Indicates whether None is allowed as an assignable value. Even if |
|
585 | Indicates whether None is allowed as an assignable value. Even if | |
556 | ``False``, the default value may be ``None``. |
|
586 | ``False``, the default value may be ``None``. | |
557 | """ |
|
587 | """ | |
558 | if default_value is None: |
|
588 | if default_value is None: | |
559 | if klass is None: |
|
589 | if klass is None: | |
560 | klass = object |
|
590 | klass = object | |
561 | elif klass is None: |
|
591 | elif klass is None: | |
562 | klass = default_value |
|
592 | klass = default_value | |
563 |
|
593 | |||
564 | if not (inspect.isclass(klass) or isinstance(klass, basestring)): |
|
594 | if not (inspect.isclass(klass) or isinstance(klass, basestring)): | |
565 | raise TraitletError("A Type traitlet must specify a class.") |
|
595 | raise TraitletError("A Type traitlet must specify a class.") | |
566 |
|
596 | |||
567 | self.klass = klass |
|
597 | self.klass = klass | |
568 | self._allow_none = allow_none |
|
598 | self._allow_none = allow_none | |
569 |
|
599 | |||
570 | super(Type, self).__init__(default_value, **metadata) |
|
600 | super(Type, self).__init__(default_value, **metadata) | |
571 |
|
601 | |||
572 | def validate(self, obj, value): |
|
602 | def validate(self, obj, value): | |
573 | """Validates that the value is a valid object instance.""" |
|
603 | """Validates that the value is a valid object instance.""" | |
574 | try: |
|
604 | try: | |
575 | if issubclass(value, self.klass): |
|
605 | if issubclass(value, self.klass): | |
576 | return value |
|
606 | return value | |
577 | except: |
|
607 | except: | |
578 | if (value is None) and (self._allow_none): |
|
608 | if (value is None) and (self._allow_none): | |
579 | return value |
|
609 | return value | |
580 |
|
610 | |||
581 | self.error(obj, value) |
|
611 | self.error(obj, value) | |
582 |
|
612 | |||
583 | def info(self): |
|
613 | def info(self): | |
584 | """ Returns a description of the trait.""" |
|
614 | """ Returns a description of the trait.""" | |
585 | if isinstance(self.klass, basestring): |
|
615 | if isinstance(self.klass, basestring): | |
586 | klass = self.klass |
|
616 | klass = self.klass | |
587 | else: |
|
617 | else: | |
588 | klass = self.klass.__name__ |
|
618 | klass = self.klass.__name__ | |
589 | result = 'a subclass of ' + klass |
|
619 | result = 'a subclass of ' + klass | |
590 | if self._allow_none: |
|
620 | if self._allow_none: | |
591 | return result + ' or None' |
|
621 | return result + ' or None' | |
592 | return result |
|
622 | return result | |
593 |
|
623 | |||
594 | def instance_init(self, obj): |
|
624 | def instance_init(self, obj): | |
595 | self._resolve_classes() |
|
625 | self._resolve_classes() | |
596 | super(Type, self).instance_init(obj) |
|
626 | super(Type, self).instance_init(obj) | |
597 |
|
627 | |||
598 | def _resolve_classes(self): |
|
628 | def _resolve_classes(self): | |
599 | if isinstance(self.klass, basestring): |
|
629 | if isinstance(self.klass, basestring): | |
600 | self.klass = import_item(self.klass) |
|
630 | self.klass = import_item(self.klass) | |
601 | if isinstance(self.default_value, basestring): |
|
631 | if isinstance(self.default_value, basestring): | |
602 | self.default_value = import_item(self.default_value) |
|
632 | self.default_value = import_item(self.default_value) | |
603 |
|
633 | |||
604 | def get_default_value(self): |
|
634 | def get_default_value(self): | |
605 | return self.default_value |
|
635 | return self.default_value | |
606 |
|
636 | |||
607 |
|
637 | |||
608 | class DefaultValueGenerator(object): |
|
638 | class DefaultValueGenerator(object): | |
609 | """A class for generating new default value instances.""" |
|
639 | """A class for generating new default value instances.""" | |
610 |
|
640 | |||
611 | def __init__(self, *args, **kw): |
|
641 | def __init__(self, *args, **kw): | |
612 | self.args = args |
|
642 | self.args = args | |
613 | self.kw = kw |
|
643 | self.kw = kw | |
614 |
|
644 | |||
615 | def generate(self, klass): |
|
645 | def generate(self, klass): | |
616 | return klass(*self.args, **self.kw) |
|
646 | return klass(*self.args, **self.kw) | |
617 |
|
647 | |||
618 |
|
648 | |||
619 | class Instance(ClassBasedTraitletType): |
|
649 | class Instance(ClassBasedTraitletType): | |
620 | """A trait whose value must be an instance of a specified class. |
|
650 | """A trait whose value must be an instance of a specified class. | |
621 |
|
651 | |||
622 | The value can also be an instance of a subclass of the specified class. |
|
652 | The value can also be an instance of a subclass of the specified class. | |
623 | """ |
|
653 | """ | |
624 |
|
654 | |||
625 | def __init__(self, klass=None, args=None, kw=None, |
|
655 | def __init__(self, klass=None, args=None, kw=None, | |
626 | allow_none=True, **metadata ): |
|
656 | allow_none=True, **metadata ): | |
627 | """Construct an Instance traitlet. |
|
657 | """Construct an Instance traitlet. | |
628 |
|
658 | |||
629 | This traitlet allows values that are instances of a particular |
|
659 | This traitlet allows values that are instances of a particular | |
630 | class or its sublclasses. Our implementation is quite different |
|
660 | class or its sublclasses. Our implementation is quite different | |
631 | from that of enthough.traits as we don't allow instances to be used |
|
661 | from that of enthough.traits as we don't allow instances to be used | |
632 | for klass and we handle the ``args`` and ``kw`` arguments differently. |
|
662 | for klass and we handle the ``args`` and ``kw`` arguments differently. | |
633 |
|
663 | |||
634 | Parameters |
|
664 | Parameters | |
635 | ---------- |
|
665 | ---------- | |
636 | klass : class, str |
|
666 | klass : class, str | |
637 | The class that forms the basis for the traitlet. Class names |
|
667 | The class that forms the basis for the traitlet. Class names | |
638 | can also be specified as strings, like 'foo.bar.Bar'. |
|
668 | can also be specified as strings, like 'foo.bar.Bar'. | |
639 | args : tuple |
|
669 | args : tuple | |
640 | Positional arguments for generating the default value. |
|
670 | Positional arguments for generating the default value. | |
641 | kw : dict |
|
671 | kw : dict | |
642 | Keyword arguments for generating the default value. |
|
672 | Keyword arguments for generating the default value. | |
643 | allow_none : bool |
|
673 | allow_none : bool | |
644 | Indicates whether None is allowed as a value. |
|
674 | Indicates whether None is allowed as a value. | |
645 |
|
675 | |||
646 | Default Value |
|
676 | Default Value | |
647 | ------------- |
|
677 | ------------- | |
648 | If both ``args`` and ``kw`` are None, then the default value is None. |
|
678 | If both ``args`` and ``kw`` are None, then the default value is None. | |
649 | If ``args`` is a tuple and ``kw`` is a dict, then the default is |
|
679 | If ``args`` is a tuple and ``kw`` is a dict, then the default is | |
650 | created as ``klass(*args, **kw)``. If either ``args`` or ``kw`` is |
|
680 | created as ``klass(*args, **kw)``. If either ``args`` or ``kw`` is | |
651 | not (but not both), None is replace by ``()`` or ``{}``. |
|
681 | not (but not both), None is replace by ``()`` or ``{}``. | |
652 | """ |
|
682 | """ | |
653 |
|
683 | |||
654 | self._allow_none = allow_none |
|
684 | self._allow_none = allow_none | |
655 |
|
685 | |||
656 | if (klass is None) or (not (inspect.isclass(klass) or isinstance(klass, basestring))): |
|
686 | if (klass is None) or (not (inspect.isclass(klass) or isinstance(klass, basestring))): | |
657 | raise TraitletError('The klass argument must be a class' |
|
687 | raise TraitletError('The klass argument must be a class' | |
658 | ' you gave: %r' % klass) |
|
688 | ' you gave: %r' % klass) | |
659 | self.klass = klass |
|
689 | self.klass = klass | |
660 |
|
690 | |||
661 | # self.klass is a class, so handle default_value |
|
691 | # self.klass is a class, so handle default_value | |
662 | if args is None and kw is None: |
|
692 | if args is None and kw is None: | |
663 | default_value = None |
|
693 | default_value = None | |
664 | else: |
|
694 | else: | |
665 | if args is None: |
|
695 | if args is None: | |
666 | # kw is not None |
|
696 | # kw is not None | |
667 | args = () |
|
697 | args = () | |
668 | elif kw is None: |
|
698 | elif kw is None: | |
669 | # args is not None |
|
699 | # args is not None | |
670 | kw = {} |
|
700 | kw = {} | |
671 |
|
701 | |||
672 | if not isinstance(kw, dict): |
|
702 | if not isinstance(kw, dict): | |
673 | raise TraitletError("The 'kw' argument must be a dict or None.") |
|
703 | raise TraitletError("The 'kw' argument must be a dict or None.") | |
674 | if not isinstance(args, tuple): |
|
704 | if not isinstance(args, tuple): | |
675 | raise TraitletError("The 'args' argument must be a tuple or None.") |
|
705 | raise TraitletError("The 'args' argument must be a tuple or None.") | |
676 |
|
706 | |||
677 | default_value = DefaultValueGenerator(*args, **kw) |
|
707 | default_value = DefaultValueGenerator(*args, **kw) | |
678 |
|
708 | |||
679 | super(Instance, self).__init__(default_value, **metadata) |
|
709 | super(Instance, self).__init__(default_value, **metadata) | |
680 |
|
710 | |||
681 | def validate(self, obj, value): |
|
711 | def validate(self, obj, value): | |
682 | if value is None: |
|
712 | if value is None: | |
683 | if self._allow_none: |
|
713 | if self._allow_none: | |
684 | return value |
|
714 | return value | |
685 | self.error(obj, value) |
|
715 | self.error(obj, value) | |
686 |
|
716 | |||
687 | if isinstance(value, self.klass): |
|
717 | if isinstance(value, self.klass): | |
688 | return value |
|
718 | return value | |
689 | else: |
|
719 | else: | |
690 | self.error(obj, value) |
|
720 | self.error(obj, value) | |
691 |
|
721 | |||
692 | def info(self): |
|
722 | def info(self): | |
693 | if isinstance(self.klass, basestring): |
|
723 | if isinstance(self.klass, basestring): | |
694 | klass = self.klass |
|
724 | klass = self.klass | |
695 | else: |
|
725 | else: | |
696 | klass = self.klass.__name__ |
|
726 | klass = self.klass.__name__ | |
697 | result = class_of(klass) |
|
727 | result = class_of(klass) | |
698 | if self._allow_none: |
|
728 | if self._allow_none: | |
699 | return result + ' or None' |
|
729 | return result + ' or None' | |
700 |
|
730 | |||
701 | return result |
|
731 | return result | |
702 |
|
732 | |||
703 | def instance_init(self, obj): |
|
733 | def instance_init(self, obj): | |
704 | self._resolve_classes() |
|
734 | self._resolve_classes() | |
705 | super(Instance, self).instance_init(obj) |
|
735 | super(Instance, self).instance_init(obj) | |
706 |
|
736 | |||
707 | def _resolve_classes(self): |
|
737 | def _resolve_classes(self): | |
708 | if isinstance(self.klass, basestring): |
|
738 | if isinstance(self.klass, basestring): | |
709 | self.klass = import_item(self.klass) |
|
739 | self.klass = import_item(self.klass) | |
710 |
|
740 | |||
711 | def get_default_value(self): |
|
741 | def get_default_value(self): | |
712 | """Instantiate a default value instance. |
|
742 | """Instantiate a default value instance. | |
713 |
|
743 | |||
714 | This is called when the containing HasTraitlets classes' |
|
744 | This is called when the containing HasTraitlets classes' | |
715 | :meth:`__new__` method is called to ensure that a unique instance |
|
745 | :meth:`__new__` method is called to ensure that a unique instance | |
716 | is created for each HasTraitlets instance. |
|
746 | is created for each HasTraitlets instance. | |
717 | """ |
|
747 | """ | |
718 | dv = self.default_value |
|
748 | dv = self.default_value | |
719 | if isinstance(dv, DefaultValueGenerator): |
|
749 | if isinstance(dv, DefaultValueGenerator): | |
720 | return dv.generate(self.klass) |
|
750 | return dv.generate(self.klass) | |
721 | else: |
|
751 | else: | |
722 | return dv |
|
752 | return dv | |
723 |
|
753 | |||
724 |
|
754 | |||
725 | class This(ClassBasedTraitletType): |
|
755 | class This(ClassBasedTraitletType): | |
726 | """A traitlet for instances of the class containing this trait. |
|
756 | """A traitlet for instances of the class containing this trait. | |
727 |
|
757 | |||
728 | Because how how and when class bodies are executed, the ``This`` |
|
758 | Because how how and when class bodies are executed, the ``This`` | |
729 | traitlet can only have a default value of None. This, and because we |
|
759 | traitlet can only have a default value of None. This, and because we | |
730 | always validate default values, ``allow_none`` is *always* true. |
|
760 | always validate default values, ``allow_none`` is *always* true. | |
731 | """ |
|
761 | """ | |
732 |
|
762 | |||
733 | info_text = 'an instance of the same type as the receiver or None' |
|
763 | info_text = 'an instance of the same type as the receiver or None' | |
734 |
|
764 | |||
735 | def __init__(self, **metadata): |
|
765 | def __init__(self, **metadata): | |
736 | super(This, self).__init__(None, **metadata) |
|
766 | super(This, self).__init__(None, **metadata) | |
737 |
|
767 | |||
738 | def validate(self, obj, value): |
|
768 | def validate(self, obj, value): | |
739 | # What if value is a superclass of obj.__class__? This is |
|
769 | # What if value is a superclass of obj.__class__? This is | |
740 | # complicated if it was the superclass that defined the This |
|
770 | # complicated if it was the superclass that defined the This | |
741 | # traitlet. |
|
771 | # traitlet. | |
742 | if isinstance(value, self.this_class) or (value is None): |
|
772 | if isinstance(value, self.this_class) or (value is None): | |
743 | return value |
|
773 | return value | |
744 | else: |
|
774 | else: | |
745 | self.error(obj, value) |
|
775 | self.error(obj, value) | |
746 |
|
776 | |||
747 |
|
777 | |||
748 | #----------------------------------------------------------------------------- |
|
778 | #----------------------------------------------------------------------------- | |
749 | # Basic TraitletTypes implementations/subclasses |
|
779 | # Basic TraitletTypes implementations/subclasses | |
750 | #----------------------------------------------------------------------------- |
|
780 | #----------------------------------------------------------------------------- | |
751 |
|
781 | |||
752 |
|
782 | |||
753 | class Any(TraitletType): |
|
783 | class Any(TraitletType): | |
754 | default_value = None |
|
784 | default_value = None | |
755 | info_text = 'any value' |
|
785 | info_text = 'any value' | |
756 |
|
786 | |||
757 |
|
787 | |||
758 | class Int(TraitletType): |
|
788 | class Int(TraitletType): | |
759 | """A integer traitlet.""" |
|
789 | """A integer traitlet.""" | |
760 |
|
790 | |||
761 | evaluate = int |
|
791 | evaluate = int | |
762 | default_value = 0 |
|
792 | default_value = 0 | |
763 | info_text = 'an integer' |
|
793 | info_text = 'an integer' | |
764 |
|
794 | |||
765 | def validate(self, obj, value): |
|
795 | def validate(self, obj, value): | |
766 | if isinstance(value, int): |
|
796 | if isinstance(value, int): | |
767 | return value |
|
797 | return value | |
768 | self.error(obj, value) |
|
798 | self.error(obj, value) | |
769 |
|
799 | |||
770 | class CInt(Int): |
|
800 | class CInt(Int): | |
771 | """A casting version of the int traitlet.""" |
|
801 | """A casting version of the int traitlet.""" | |
772 |
|
802 | |||
773 | def validate(self, obj, value): |
|
803 | def validate(self, obj, value): | |
774 | try: |
|
804 | try: | |
775 | return int(value) |
|
805 | return int(value) | |
776 | except: |
|
806 | except: | |
777 | self.error(obj, value) |
|
807 | self.error(obj, value) | |
778 |
|
808 | |||
779 |
|
809 | |||
780 | class Long(TraitletType): |
|
810 | class Long(TraitletType): | |
781 | """A long integer traitlet.""" |
|
811 | """A long integer traitlet.""" | |
782 |
|
812 | |||
783 | evaluate = long |
|
813 | evaluate = long | |
784 | default_value = 0L |
|
814 | default_value = 0L | |
785 | info_text = 'a long' |
|
815 | info_text = 'a long' | |
786 |
|
816 | |||
787 | def validate(self, obj, value): |
|
817 | def validate(self, obj, value): | |
788 | if isinstance(value, long): |
|
818 | if isinstance(value, long): | |
789 | return value |
|
819 | return value | |
790 | if isinstance(value, int): |
|
820 | if isinstance(value, int): | |
791 | return long(value) |
|
821 | return long(value) | |
792 | self.error(obj, value) |
|
822 | self.error(obj, value) | |
793 |
|
823 | |||
794 |
|
824 | |||
795 | class CLong(Long): |
|
825 | class CLong(Long): | |
796 | """A casting version of the long integer traitlet.""" |
|
826 | """A casting version of the long integer traitlet.""" | |
797 |
|
827 | |||
798 | def validate(self, obj, value): |
|
828 | def validate(self, obj, value): | |
799 | try: |
|
829 | try: | |
800 | return long(value) |
|
830 | return long(value) | |
801 | except: |
|
831 | except: | |
802 | self.error(obj, value) |
|
832 | self.error(obj, value) | |
803 |
|
833 | |||
804 |
|
834 | |||
805 | class Float(TraitletType): |
|
835 | class Float(TraitletType): | |
806 | """A float traitlet.""" |
|
836 | """A float traitlet.""" | |
807 |
|
837 | |||
808 | evaluate = float |
|
838 | evaluate = float | |
809 | default_value = 0.0 |
|
839 | default_value = 0.0 | |
810 | info_text = 'a float' |
|
840 | info_text = 'a float' | |
811 |
|
841 | |||
812 | def validate(self, obj, value): |
|
842 | def validate(self, obj, value): | |
813 | if isinstance(value, float): |
|
843 | if isinstance(value, float): | |
814 | return value |
|
844 | return value | |
815 | if isinstance(value, int): |
|
845 | if isinstance(value, int): | |
816 | return float(value) |
|
846 | return float(value) | |
817 | self.error(obj, value) |
|
847 | self.error(obj, value) | |
818 |
|
848 | |||
819 |
|
849 | |||
820 | class CFloat(Float): |
|
850 | class CFloat(Float): | |
821 | """A casting version of the float traitlet.""" |
|
851 | """A casting version of the float traitlet.""" | |
822 |
|
852 | |||
823 | def validate(self, obj, value): |
|
853 | def validate(self, obj, value): | |
824 | try: |
|
854 | try: | |
825 | return float(value) |
|
855 | return float(value) | |
826 | except: |
|
856 | except: | |
827 | self.error(obj, value) |
|
857 | self.error(obj, value) | |
828 |
|
858 | |||
829 | class Complex(TraitletType): |
|
859 | class Complex(TraitletType): | |
830 | """A traitlet for complex numbers.""" |
|
860 | """A traitlet for complex numbers.""" | |
831 |
|
861 | |||
832 | evaluate = complex |
|
862 | evaluate = complex | |
833 | default_value = 0.0 + 0.0j |
|
863 | default_value = 0.0 + 0.0j | |
834 | info_text = 'a complex number' |
|
864 | info_text = 'a complex number' | |
835 |
|
865 | |||
836 | def validate(self, obj, value): |
|
866 | def validate(self, obj, value): | |
837 | if isinstance(value, complex): |
|
867 | if isinstance(value, complex): | |
838 | return value |
|
868 | return value | |
839 | if isinstance(value, (float, int)): |
|
869 | if isinstance(value, (float, int)): | |
840 | return complex(value) |
|
870 | return complex(value) | |
841 | self.error(obj, value) |
|
871 | self.error(obj, value) | |
842 |
|
872 | |||
843 |
|
873 | |||
844 | class CComplex(Complex): |
|
874 | class CComplex(Complex): | |
845 | """A casting version of the complex number traitlet.""" |
|
875 | """A casting version of the complex number traitlet.""" | |
846 |
|
876 | |||
847 | def validate (self, obj, value): |
|
877 | def validate (self, obj, value): | |
848 | try: |
|
878 | try: | |
849 | return complex(value) |
|
879 | return complex(value) | |
850 | except: |
|
880 | except: | |
851 | self.error(obj, value) |
|
881 | self.error(obj, value) | |
852 |
|
882 | |||
853 |
|
883 | |||
854 | class Str(TraitletType): |
|
884 | class Str(TraitletType): | |
855 | """A traitlet for strings.""" |
|
885 | """A traitlet for strings.""" | |
856 |
|
886 | |||
857 | evaluate = lambda x: x |
|
887 | evaluate = lambda x: x | |
858 | default_value = '' |
|
888 | default_value = '' | |
859 | info_text = 'a string' |
|
889 | info_text = 'a string' | |
860 |
|
890 | |||
861 | def validate(self, obj, value): |
|
891 | def validate(self, obj, value): | |
862 | if isinstance(value, str): |
|
892 | if isinstance(value, str): | |
863 | return value |
|
893 | return value | |
864 | self.error(obj, value) |
|
894 | self.error(obj, value) | |
865 |
|
895 | |||
866 |
|
896 | |||
867 | class CStr(Str): |
|
897 | class CStr(Str): | |
868 | """A casting version of the string traitlet.""" |
|
898 | """A casting version of the string traitlet.""" | |
869 |
|
899 | |||
870 | def validate(self, obj, value): |
|
900 | def validate(self, obj, value): | |
871 | try: |
|
901 | try: | |
872 | return str(value) |
|
902 | return str(value) | |
873 | except: |
|
903 | except: | |
874 | try: |
|
904 | try: | |
875 | return unicode(value) |
|
905 | return unicode(value) | |
876 | except: |
|
906 | except: | |
877 | self.error(obj, value) |
|
907 | self.error(obj, value) | |
878 |
|
908 | |||
879 |
|
909 | |||
880 | class Unicode(TraitletType): |
|
910 | class Unicode(TraitletType): | |
881 | """A traitlet for unicode strings.""" |
|
911 | """A traitlet for unicode strings.""" | |
882 |
|
912 | |||
883 | evaluate = unicode |
|
913 | evaluate = unicode | |
884 | default_value = u'' |
|
914 | default_value = u'' | |
885 | info_text = 'a unicode string' |
|
915 | info_text = 'a unicode string' | |
886 |
|
916 | |||
887 | def validate(self, obj, value): |
|
917 | def validate(self, obj, value): | |
888 | if isinstance(value, unicode): |
|
918 | if isinstance(value, unicode): | |
889 | return value |
|
919 | return value | |
890 | if isinstance(value, str): |
|
920 | if isinstance(value, str): | |
891 | return unicode(value) |
|
921 | return unicode(value) | |
892 | self.error(obj, value) |
|
922 | self.error(obj, value) | |
893 |
|
923 | |||
894 |
|
924 | |||
895 | class CUnicode(Unicode): |
|
925 | class CUnicode(Unicode): | |
896 | """A casting version of the unicode traitlet.""" |
|
926 | """A casting version of the unicode traitlet.""" | |
897 |
|
927 | |||
898 | def validate(self, obj, value): |
|
928 | def validate(self, obj, value): | |
899 | try: |
|
929 | try: | |
900 | return unicode(value) |
|
930 | return unicode(value) | |
901 | except: |
|
931 | except: | |
902 | self.error(obj, value) |
|
932 | self.error(obj, value) | |
903 |
|
933 | |||
904 |
|
934 | |||
905 | class Bool(TraitletType): |
|
935 | class Bool(TraitletType): | |
906 | """A boolean (True, False) traitlet.""" |
|
936 | """A boolean (True, False) traitlet.""" | |
907 | evaluate = bool |
|
937 | evaluate = bool | |
908 | default_value = False |
|
938 | default_value = False | |
909 | info_text = 'a boolean' |
|
939 | info_text = 'a boolean' | |
910 |
|
940 | |||
911 | def validate(self, obj, value): |
|
941 | def validate(self, obj, value): | |
912 | if isinstance(value, bool): |
|
942 | if isinstance(value, bool): | |
913 | return value |
|
943 | return value | |
914 | self.error(obj, value) |
|
944 | self.error(obj, value) | |
915 |
|
945 | |||
916 |
|
946 | |||
917 | class CBool(Bool): |
|
947 | class CBool(Bool): | |
918 | """A casting version of the boolean traitlet.""" |
|
948 | """A casting version of the boolean traitlet.""" | |
919 |
|
949 | |||
920 | def validate(self, obj, value): |
|
950 | def validate(self, obj, value): | |
921 | try: |
|
951 | try: | |
922 | return bool(value) |
|
952 | return bool(value) | |
923 | except: |
|
953 | except: | |
924 | self.error(obj, value) |
|
954 | self.error(obj, value) | |
925 |
|
955 | |||
926 |
|
956 | |||
927 | class Enum(TraitletType): |
|
957 | class Enum(TraitletType): | |
928 | """An enum that whose value must be in a given sequence.""" |
|
958 | """An enum that whose value must be in a given sequence.""" | |
929 |
|
959 | |||
930 | def __init__(self, values, default_value=None, allow_none=True, **metadata): |
|
960 | def __init__(self, values, default_value=None, allow_none=True, **metadata): | |
931 | self.values = values |
|
961 | self.values = values | |
932 | self._allow_none = allow_none |
|
962 | self._allow_none = allow_none | |
933 | super(Enum, self).__init__(default_value, **metadata) |
|
963 | super(Enum, self).__init__(default_value, **metadata) | |
934 |
|
964 | |||
935 | def validate(self, obj, value): |
|
965 | def validate(self, obj, value): | |
936 | if value is None: |
|
966 | if value is None: | |
937 | if self._allow_none: |
|
967 | if self._allow_none: | |
938 | return value |
|
968 | return value | |
939 |
|
969 | |||
940 | if value in self.values: |
|
970 | if value in self.values: | |
941 | return value |
|
971 | return value | |
942 | self.error(obj, value) |
|
972 | self.error(obj, value) | |
943 |
|
973 | |||
944 | def info(self): |
|
974 | def info(self): | |
945 | """ Returns a description of the trait.""" |
|
975 | """ Returns a description of the trait.""" | |
946 | result = 'any of ' + repr(self.values) |
|
976 | result = 'any of ' + repr(self.values) | |
947 | if self._allow_none: |
|
977 | if self._allow_none: | |
948 | return result + ' or None' |
|
978 | return result + ' or None' | |
949 | return result |
|
979 | return result | |
950 |
|
980 | |||
951 | class CaselessStrEnum(Enum): |
|
981 | class CaselessStrEnum(Enum): | |
952 | """An enum of strings that are caseless in validate.""" |
|
982 | """An enum of strings that are caseless in validate.""" | |
953 |
|
983 | |||
954 | def validate(self, obj, value): |
|
984 | def validate(self, obj, value): | |
955 | if value is None: |
|
985 | if value is None: | |
956 | if self._allow_none: |
|
986 | if self._allow_none: | |
957 | return value |
|
987 | return value | |
958 |
|
988 | |||
959 | if not isinstance(value, str): |
|
989 | if not isinstance(value, str): | |
960 | self.error(obj, value) |
|
990 | self.error(obj, value) | |
961 |
|
991 | |||
962 | for v in self.values: |
|
992 | for v in self.values: | |
963 | if v.lower() == value.lower(): |
|
993 | if v.lower() == value.lower(): | |
964 | return v |
|
994 | return v | |
965 | self.error(obj, value) |
|
995 | self.error(obj, value) | |
966 |
|
996 | |||
967 |
|
997 | |||
968 | class List(Instance): |
|
998 | class List(Instance): | |
969 | """An instance of a Python list.""" |
|
999 | """An instance of a Python list.""" | |
970 |
|
1000 | |||
971 | def __init__(self, default_value=None, allow_none=True, **metadata): |
|
1001 | def __init__(self, default_value=None, allow_none=True, **metadata): | |
972 | """Create a list traitlet type from a list or tuple. |
|
1002 | """Create a list traitlet type from a list or tuple. | |
973 |
|
1003 | |||
974 | The default value is created by doing ``list(default_value)``, |
|
1004 | The default value is created by doing ``list(default_value)``, | |
975 | which creates a copy of the ``default_value``. |
|
1005 | which creates a copy of the ``default_value``. | |
976 | """ |
|
1006 | """ | |
977 | if default_value is None: |
|
1007 | if default_value is None: | |
978 | args = ((),) |
|
1008 | args = ((),) | |
979 | elif isinstance(default_value, SequenceTypes): |
|
1009 | elif isinstance(default_value, SequenceTypes): | |
980 | args = (default_value,) |
|
1010 | args = (default_value,) | |
981 |
|
1011 | |||
982 | super(List,self).__init__(klass=list, args=args, |
|
1012 | super(List,self).__init__(klass=list, args=args, | |
983 | allow_none=allow_none, **metadata) |
|
1013 | allow_none=allow_none, **metadata) |
General Comments 0
You need to be logged in to leave comments.
Login now