Show More
@@ -0,0 +1,54 b'' | |||
|
1 | # coding: utf-8 | |
|
2 | """ | |
|
3 | Utilities for dealing with text encodings | |
|
4 | """ | |
|
5 | ||
|
6 | #----------------------------------------------------------------------------- | |
|
7 | # Copyright (C) 2008-2012 The IPython Development Team | |
|
8 | # | |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
|
10 | # the file COPYING, distributed as part of this software. | |
|
11 | #----------------------------------------------------------------------------- | |
|
12 | ||
|
13 | #----------------------------------------------------------------------------- | |
|
14 | # Imports | |
|
15 | #----------------------------------------------------------------------------- | |
|
16 | import sys | |
|
17 | import locale | |
|
18 | ||
|
19 | # to deal with the possibility of sys.std* not being a stream at all | |
|
20 | def get_stream_enc(stream, default=None): | |
|
21 | """Return the given stream's encoding or a default. | |
|
22 | ||
|
23 | There are cases where sys.std* might not actually be a stream, so | |
|
24 | check for the encoding attribute prior to returning it, and return | |
|
25 | a default if it doesn't exist or evaluates as False. `default' | |
|
26 | is None if not provided. | |
|
27 | """ | |
|
28 | if not hasattr(stream, 'encoding') or not stream.encoding: | |
|
29 | return default | |
|
30 | else: | |
|
31 | return stream.encoding | |
|
32 | ||
|
33 | # Less conservative replacement for sys.getdefaultencoding, that will try | |
|
34 | # to match the environment. | |
|
35 | # Defined here as central function, so if we find better choices, we | |
|
36 | # won't need to make changes all over IPython. | |
|
37 | def getdefaultencoding(): | |
|
38 | """Return IPython's guess for the default encoding for bytes as text. | |
|
39 | ||
|
40 | Asks for stdin.encoding first, to match the calling Terminal, but that | |
|
41 | is often None for subprocesses. Fall back on locale.getpreferredencoding() | |
|
42 | which should be a sensible platform default (that respects LANG environment), | |
|
43 | and finally to sys.getdefaultencoding() which is the most conservative option, | |
|
44 | and usually ASCII. | |
|
45 | """ | |
|
46 | enc = get_stream_enc(sys.stdin) | |
|
47 | if not enc or enc=='ascii': | |
|
48 | try: | |
|
49 | # There are reports of getpreferredencoding raising errors | |
|
50 | # in some cases, which may well be fixed, but let's be conservative here. | |
|
51 | enc = locale.getpreferredencoding() | |
|
52 | except Exception: | |
|
53 | pass | |
|
54 | return enc or sys.getdefaultencoding() |
@@ -1,702 +1,703 b'' | |||
|
1 | 1 | """A simple configuration system. |
|
2 | 2 | |
|
3 | 3 | Authors |
|
4 | 4 | ------- |
|
5 | 5 | * Brian Granger |
|
6 | 6 | * Fernando Perez |
|
7 | 7 | * Min RK |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | # Copyright (C) 2008-2011 The IPython Development Team |
|
12 | 12 | # |
|
13 | 13 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | 14 | # the file COPYING, distributed as part of this software. |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Imports |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | import __builtin__ as builtin_mod |
|
22 | 22 | import os |
|
23 | 23 | import re |
|
24 | 24 | import sys |
|
25 | 25 | |
|
26 | 26 | from IPython.external import argparse |
|
27 | 27 | from IPython.utils.path import filefind, get_ipython_dir |
|
28 | 28 | from IPython.utils import py3compat, text, warn |
|
29 | from IPython.utils.encoding import getdefaultencoding | |
|
29 | 30 | |
|
30 | 31 | #----------------------------------------------------------------------------- |
|
31 | 32 | # Exceptions |
|
32 | 33 | #----------------------------------------------------------------------------- |
|
33 | 34 | |
|
34 | 35 | |
|
35 | 36 | class ConfigError(Exception): |
|
36 | 37 | pass |
|
37 | 38 | |
|
38 | 39 | class ConfigLoaderError(ConfigError): |
|
39 | 40 | pass |
|
40 | 41 | |
|
41 | 42 | class ConfigFileNotFound(ConfigError): |
|
42 | 43 | pass |
|
43 | 44 | |
|
44 | 45 | class ArgumentError(ConfigLoaderError): |
|
45 | 46 | pass |
|
46 | 47 | |
|
47 | 48 | #----------------------------------------------------------------------------- |
|
48 | 49 | # Argparse fix |
|
49 | 50 | #----------------------------------------------------------------------------- |
|
50 | 51 | |
|
51 | 52 | # Unfortunately argparse by default prints help messages to stderr instead of |
|
52 | 53 | # stdout. This makes it annoying to capture long help screens at the command |
|
53 | 54 | # line, since one must know how to pipe stderr, which many users don't know how |
|
54 | 55 | # to do. So we override the print_help method with one that defaults to |
|
55 | 56 | # stdout and use our class instead. |
|
56 | 57 | |
|
57 | 58 | class ArgumentParser(argparse.ArgumentParser): |
|
58 | 59 | """Simple argparse subclass that prints help to stdout by default.""" |
|
59 | 60 | |
|
60 | 61 | def print_help(self, file=None): |
|
61 | 62 | if file is None: |
|
62 | 63 | file = sys.stdout |
|
63 | 64 | return super(ArgumentParser, self).print_help(file) |
|
64 | 65 | |
|
65 | 66 | print_help.__doc__ = argparse.ArgumentParser.print_help.__doc__ |
|
66 | 67 | |
|
67 | 68 | #----------------------------------------------------------------------------- |
|
68 | 69 | # Config class for holding config information |
|
69 | 70 | #----------------------------------------------------------------------------- |
|
70 | 71 | |
|
71 | 72 | |
|
72 | 73 | class Config(dict): |
|
73 | 74 | """An attribute based dict that can do smart merges.""" |
|
74 | 75 | |
|
75 | 76 | def __init__(self, *args, **kwds): |
|
76 | 77 | dict.__init__(self, *args, **kwds) |
|
77 | 78 | # This sets self.__dict__ = self, but it has to be done this way |
|
78 | 79 | # because we are also overriding __setattr__. |
|
79 | 80 | dict.__setattr__(self, '__dict__', self) |
|
80 | 81 | |
|
81 | 82 | def _merge(self, other): |
|
82 | 83 | to_update = {} |
|
83 | 84 | for k, v in other.iteritems(): |
|
84 | 85 | if not self.has_key(k): |
|
85 | 86 | to_update[k] = v |
|
86 | 87 | else: # I have this key |
|
87 | 88 | if isinstance(v, Config): |
|
88 | 89 | # Recursively merge common sub Configs |
|
89 | 90 | self[k]._merge(v) |
|
90 | 91 | else: |
|
91 | 92 | # Plain updates for non-Configs |
|
92 | 93 | to_update[k] = v |
|
93 | 94 | |
|
94 | 95 | self.update(to_update) |
|
95 | 96 | |
|
96 | 97 | def _is_section_key(self, key): |
|
97 | 98 | if key[0].upper()==key[0] and not key.startswith('_'): |
|
98 | 99 | return True |
|
99 | 100 | else: |
|
100 | 101 | return False |
|
101 | 102 | |
|
102 | 103 | def __contains__(self, key): |
|
103 | 104 | if self._is_section_key(key): |
|
104 | 105 | return True |
|
105 | 106 | else: |
|
106 | 107 | return super(Config, self).__contains__(key) |
|
107 | 108 | # .has_key is deprecated for dictionaries. |
|
108 | 109 | has_key = __contains__ |
|
109 | 110 | |
|
110 | 111 | def _has_section(self, key): |
|
111 | 112 | if self._is_section_key(key): |
|
112 | 113 | if super(Config, self).__contains__(key): |
|
113 | 114 | return True |
|
114 | 115 | return False |
|
115 | 116 | |
|
116 | 117 | def copy(self): |
|
117 | 118 | return type(self)(dict.copy(self)) |
|
118 | 119 | |
|
119 | 120 | def __copy__(self): |
|
120 | 121 | return self.copy() |
|
121 | 122 | |
|
122 | 123 | def __deepcopy__(self, memo): |
|
123 | 124 | import copy |
|
124 | 125 | return type(self)(copy.deepcopy(self.items())) |
|
125 | 126 | |
|
126 | 127 | def __getitem__(self, key): |
|
127 | 128 | # We cannot use directly self._is_section_key, because it triggers |
|
128 | 129 | # infinite recursion on top of PyPy. Instead, we manually fish the |
|
129 | 130 | # bound method. |
|
130 | 131 | is_section_key = self.__class__._is_section_key.__get__(self) |
|
131 | 132 | |
|
132 | 133 | # Because we use this for an exec namespace, we need to delegate |
|
133 | 134 | # the lookup of names in __builtin__ to itself. This means |
|
134 | 135 | # that you can't have section or attribute names that are |
|
135 | 136 | # builtins. |
|
136 | 137 | try: |
|
137 | 138 | return getattr(builtin_mod, key) |
|
138 | 139 | except AttributeError: |
|
139 | 140 | pass |
|
140 | 141 | if is_section_key(key): |
|
141 | 142 | try: |
|
142 | 143 | return dict.__getitem__(self, key) |
|
143 | 144 | except KeyError: |
|
144 | 145 | c = Config() |
|
145 | 146 | dict.__setitem__(self, key, c) |
|
146 | 147 | return c |
|
147 | 148 | else: |
|
148 | 149 | return dict.__getitem__(self, key) |
|
149 | 150 | |
|
150 | 151 | def __setitem__(self, key, value): |
|
151 | 152 | # Don't allow names in __builtin__ to be modified. |
|
152 | 153 | if hasattr(builtin_mod, key): |
|
153 | 154 | raise ConfigError('Config variable names cannot have the same name ' |
|
154 | 155 | 'as a Python builtin: %s' % key) |
|
155 | 156 | if self._is_section_key(key): |
|
156 | 157 | if not isinstance(value, Config): |
|
157 | 158 | raise ValueError('values whose keys begin with an uppercase ' |
|
158 | 159 | 'char must be Config instances: %r, %r' % (key, value)) |
|
159 | 160 | else: |
|
160 | 161 | dict.__setitem__(self, key, value) |
|
161 | 162 | |
|
162 | 163 | def __getattr__(self, key): |
|
163 | 164 | try: |
|
164 | 165 | return self.__getitem__(key) |
|
165 | 166 | except KeyError, e: |
|
166 | 167 | raise AttributeError(e) |
|
167 | 168 | |
|
168 | 169 | def __setattr__(self, key, value): |
|
169 | 170 | try: |
|
170 | 171 | self.__setitem__(key, value) |
|
171 | 172 | except KeyError, e: |
|
172 | 173 | raise AttributeError(e) |
|
173 | 174 | |
|
174 | 175 | def __delattr__(self, key): |
|
175 | 176 | try: |
|
176 | 177 | dict.__delitem__(self, key) |
|
177 | 178 | except KeyError, e: |
|
178 | 179 | raise AttributeError(e) |
|
179 | 180 | |
|
180 | 181 | |
|
181 | 182 | #----------------------------------------------------------------------------- |
|
182 | 183 | # Config loading classes |
|
183 | 184 | #----------------------------------------------------------------------------- |
|
184 | 185 | |
|
185 | 186 | |
|
186 | 187 | class ConfigLoader(object): |
|
187 | 188 | """A object for loading configurations from just about anywhere. |
|
188 | 189 | |
|
189 | 190 | The resulting configuration is packaged as a :class:`Struct`. |
|
190 | 191 | |
|
191 | 192 | Notes |
|
192 | 193 | ----- |
|
193 | 194 | A :class:`ConfigLoader` does one thing: load a config from a source |
|
194 | 195 | (file, command line arguments) and returns the data as a :class:`Struct`. |
|
195 | 196 | There are lots of things that :class:`ConfigLoader` does not do. It does |
|
196 | 197 | not implement complex logic for finding config files. It does not handle |
|
197 | 198 | default values or merge multiple configs. These things need to be |
|
198 | 199 | handled elsewhere. |
|
199 | 200 | """ |
|
200 | 201 | |
|
201 | 202 | def __init__(self): |
|
202 | 203 | """A base class for config loaders. |
|
203 | 204 | |
|
204 | 205 | Examples |
|
205 | 206 | -------- |
|
206 | 207 | |
|
207 | 208 | >>> cl = ConfigLoader() |
|
208 | 209 | >>> config = cl.load_config() |
|
209 | 210 | >>> config |
|
210 | 211 | {} |
|
211 | 212 | """ |
|
212 | 213 | self.clear() |
|
213 | 214 | |
|
214 | 215 | def clear(self): |
|
215 | 216 | self.config = Config() |
|
216 | 217 | |
|
217 | 218 | def load_config(self): |
|
218 | 219 | """Load a config from somewhere, return a :class:`Config` instance. |
|
219 | 220 | |
|
220 | 221 | Usually, this will cause self.config to be set and then returned. |
|
221 | 222 | However, in most cases, :meth:`ConfigLoader.clear` should be called |
|
222 | 223 | to erase any previous state. |
|
223 | 224 | """ |
|
224 | 225 | self.clear() |
|
225 | 226 | return self.config |
|
226 | 227 | |
|
227 | 228 | |
|
228 | 229 | class FileConfigLoader(ConfigLoader): |
|
229 | 230 | """A base class for file based configurations. |
|
230 | 231 | |
|
231 | 232 | As we add more file based config loaders, the common logic should go |
|
232 | 233 | here. |
|
233 | 234 | """ |
|
234 | 235 | pass |
|
235 | 236 | |
|
236 | 237 | |
|
237 | 238 | class PyFileConfigLoader(FileConfigLoader): |
|
238 | 239 | """A config loader for pure python files. |
|
239 | 240 | |
|
240 | 241 | This calls execfile on a plain python file and looks for attributes |
|
241 | 242 | that are all caps. These attribute are added to the config Struct. |
|
242 | 243 | """ |
|
243 | 244 | |
|
244 | 245 | def __init__(self, filename, path=None): |
|
245 | 246 | """Build a config loader for a filename and path. |
|
246 | 247 | |
|
247 | 248 | Parameters |
|
248 | 249 | ---------- |
|
249 | 250 | filename : str |
|
250 | 251 | The file name of the config file. |
|
251 | 252 | path : str, list, tuple |
|
252 | 253 | The path to search for the config file on, or a sequence of |
|
253 | 254 | paths to try in order. |
|
254 | 255 | """ |
|
255 | 256 | super(PyFileConfigLoader, self).__init__() |
|
256 | 257 | self.filename = filename |
|
257 | 258 | self.path = path |
|
258 | 259 | self.full_filename = '' |
|
259 | 260 | self.data = None |
|
260 | 261 | |
|
261 | 262 | def load_config(self): |
|
262 | 263 | """Load the config from a file and return it as a Struct.""" |
|
263 | 264 | self.clear() |
|
264 | 265 | try: |
|
265 | 266 | self._find_file() |
|
266 | 267 | except IOError as e: |
|
267 | 268 | raise ConfigFileNotFound(str(e)) |
|
268 | 269 | self._read_file_as_dict() |
|
269 | 270 | self._convert_to_config() |
|
270 | 271 | return self.config |
|
271 | 272 | |
|
272 | 273 | def _find_file(self): |
|
273 | 274 | """Try to find the file by searching the paths.""" |
|
274 | 275 | self.full_filename = filefind(self.filename, self.path) |
|
275 | 276 | |
|
276 | 277 | def _read_file_as_dict(self): |
|
277 | 278 | """Load the config file into self.config, with recursive loading.""" |
|
278 | 279 | # This closure is made available in the namespace that is used |
|
279 | 280 | # to exec the config file. It allows users to call |
|
280 | 281 | # load_subconfig('myconfig.py') to load config files recursively. |
|
281 | 282 | # It needs to be a closure because it has references to self.path |
|
282 | 283 | # and self.config. The sub-config is loaded with the same path |
|
283 | 284 | # as the parent, but it uses an empty config which is then merged |
|
284 | 285 | # with the parents. |
|
285 | 286 | |
|
286 | 287 | # If a profile is specified, the config file will be loaded |
|
287 | 288 | # from that profile |
|
288 | 289 | |
|
289 | 290 | def load_subconfig(fname, profile=None): |
|
290 | 291 | # import here to prevent circular imports |
|
291 | 292 | from IPython.core.profiledir import ProfileDir, ProfileDirError |
|
292 | 293 | if profile is not None: |
|
293 | 294 | try: |
|
294 | 295 | profile_dir = ProfileDir.find_profile_dir_by_name( |
|
295 | 296 | get_ipython_dir(), |
|
296 | 297 | profile, |
|
297 | 298 | ) |
|
298 | 299 | except ProfileDirError: |
|
299 | 300 | return |
|
300 | 301 | path = profile_dir.location |
|
301 | 302 | else: |
|
302 | 303 | path = self.path |
|
303 | 304 | loader = PyFileConfigLoader(fname, path) |
|
304 | 305 | try: |
|
305 | 306 | sub_config = loader.load_config() |
|
306 | 307 | except ConfigFileNotFound: |
|
307 | 308 | # Pass silently if the sub config is not there. This happens |
|
308 | 309 | # when a user s using a profile, but not the default config. |
|
309 | 310 | pass |
|
310 | 311 | else: |
|
311 | 312 | self.config._merge(sub_config) |
|
312 | 313 | |
|
313 | 314 | # Again, this needs to be a closure and should be used in config |
|
314 | 315 | # files to get the config being loaded. |
|
315 | 316 | def get_config(): |
|
316 | 317 | return self.config |
|
317 | 318 | |
|
318 | 319 | namespace = dict(load_subconfig=load_subconfig, get_config=get_config) |
|
319 | 320 | fs_encoding = sys.getfilesystemencoding() or 'ascii' |
|
320 | 321 | conf_filename = self.full_filename.encode(fs_encoding) |
|
321 | 322 | py3compat.execfile(conf_filename, namespace) |
|
322 | 323 | |
|
323 | 324 | def _convert_to_config(self): |
|
324 | 325 | if self.data is None: |
|
325 | 326 | ConfigLoaderError('self.data does not exist') |
|
326 | 327 | |
|
327 | 328 | |
|
328 | 329 | class CommandLineConfigLoader(ConfigLoader): |
|
329 | 330 | """A config loader for command line arguments. |
|
330 | 331 | |
|
331 | 332 | As we add more command line based loaders, the common logic should go |
|
332 | 333 | here. |
|
333 | 334 | """ |
|
334 | 335 | |
|
335 | 336 | def _exec_config_str(self, lhs, rhs): |
|
336 | 337 | """execute self.config.<lhs>=<rhs> |
|
337 | 338 | |
|
338 | 339 | * expands ~ with expanduser |
|
339 | 340 | * tries to assign with raw exec, otherwise assigns with just the string, |
|
340 | 341 | allowing `--C.a=foobar` and `--C.a="foobar"` to be equivalent. *Not* |
|
341 | 342 | equivalent are `--C.a=4` and `--C.a='4'`. |
|
342 | 343 | """ |
|
343 | 344 | rhs = os.path.expanduser(rhs) |
|
344 | 345 | exec_str = 'self.config.' + lhs + '=' + rhs |
|
345 | 346 | try: |
|
346 | 347 | # Try to see if regular Python syntax will work. This |
|
347 | 348 | # won't handle strings as the quote marks are removed |
|
348 | 349 | # by the system shell. |
|
349 | 350 | exec exec_str in locals(), globals() |
|
350 | 351 | except (NameError, SyntaxError): |
|
351 | 352 | # This case happens if the rhs is a string but without |
|
352 | 353 | # the quote marks. Use repr, to get quote marks, and |
|
353 | 354 | # 'u' prefix and see if |
|
354 | 355 | # it succeeds. If it still fails, we let it raise. |
|
355 | 356 | exec_str = u'self.config.' + lhs + '= rhs' |
|
356 | 357 | exec exec_str in locals(), globals() |
|
357 | 358 | |
|
358 | 359 | def _load_flag(self, cfg): |
|
359 | 360 | """update self.config from a flag, which can be a dict or Config""" |
|
360 | 361 | if isinstance(cfg, (dict, Config)): |
|
361 | 362 | # don't clobber whole config sections, update |
|
362 | 363 | # each section from config: |
|
363 | 364 | for sec,c in cfg.iteritems(): |
|
364 | 365 | self.config[sec].update(c) |
|
365 | 366 | else: |
|
366 | 367 | raise TypeError("Invalid flag: %r" % cfg) |
|
367 | 368 | |
|
368 | 369 | # raw --identifier=value pattern |
|
369 | 370 | # but *also* accept '-' as wordsep, for aliases |
|
370 | 371 | # accepts: --foo=a |
|
371 | 372 | # --Class.trait=value |
|
372 | 373 | # --alias-name=value |
|
373 | 374 | # rejects: -foo=value |
|
374 | 375 | # --foo |
|
375 | 376 | # --Class.trait |
|
376 | 377 | kv_pattern = re.compile(r'\-\-[A-Za-z][\w\-]*(\.[\w\-]+)*\=.*') |
|
377 | 378 | |
|
378 | 379 | # just flags, no assignments, with two *or one* leading '-' |
|
379 | 380 | # accepts: --foo |
|
380 | 381 | # -foo-bar-again |
|
381 | 382 | # rejects: --anything=anything |
|
382 | 383 | # --two.word |
|
383 | 384 | |
|
384 | 385 | flag_pattern = re.compile(r'\-\-?\w+[\-\w]*$') |
|
385 | 386 | |
|
386 | 387 | class KeyValueConfigLoader(CommandLineConfigLoader): |
|
387 | 388 | """A config loader that loads key value pairs from the command line. |
|
388 | 389 | |
|
389 | 390 | This allows command line options to be gives in the following form:: |
|
390 | 391 | |
|
391 | 392 | ipython --profile="foo" --InteractiveShell.autocall=False |
|
392 | 393 | """ |
|
393 | 394 | |
|
394 | 395 | def __init__(self, argv=None, aliases=None, flags=None): |
|
395 | 396 | """Create a key value pair config loader. |
|
396 | 397 | |
|
397 | 398 | Parameters |
|
398 | 399 | ---------- |
|
399 | 400 | argv : list |
|
400 | 401 | A list that has the form of sys.argv[1:] which has unicode |
|
401 | 402 | elements of the form u"key=value". If this is None (default), |
|
402 | 403 | then sys.argv[1:] will be used. |
|
403 | 404 | aliases : dict |
|
404 | 405 | A dict of aliases for configurable traits. |
|
405 | 406 | Keys are the short aliases, Values are the resolved trait. |
|
406 | 407 | Of the form: `{'alias' : 'Configurable.trait'}` |
|
407 | 408 | flags : dict |
|
408 | 409 | A dict of flags, keyed by str name. Vaues can be Config objects, |
|
409 | 410 | dicts, or "key=value" strings. If Config or dict, when the flag |
|
410 | 411 | is triggered, The flag is loaded as `self.config.update(m)`. |
|
411 | 412 | |
|
412 | 413 | Returns |
|
413 | 414 | ------- |
|
414 | 415 | config : Config |
|
415 | 416 | The resulting Config object. |
|
416 | 417 | |
|
417 | 418 | Examples |
|
418 | 419 | -------- |
|
419 | 420 | |
|
420 | 421 | >>> from IPython.config.loader import KeyValueConfigLoader |
|
421 | 422 | >>> cl = KeyValueConfigLoader() |
|
422 | 423 | >>> cl.load_config(["--A.name='brian'","--B.number=0"]) |
|
423 | 424 | {'A': {'name': 'brian'}, 'B': {'number': 0}} |
|
424 | 425 | """ |
|
425 | 426 | self.clear() |
|
426 | 427 | if argv is None: |
|
427 | 428 | argv = sys.argv[1:] |
|
428 | 429 | self.argv = argv |
|
429 | 430 | self.aliases = aliases or {} |
|
430 | 431 | self.flags = flags or {} |
|
431 | 432 | |
|
432 | 433 | |
|
433 | 434 | def clear(self): |
|
434 | 435 | super(KeyValueConfigLoader, self).clear() |
|
435 | 436 | self.extra_args = [] |
|
436 | 437 | |
|
437 | 438 | |
|
438 | 439 | def _decode_argv(self, argv, enc=None): |
|
439 | 440 | """decode argv if bytes, using stin.encoding, falling back on default enc""" |
|
440 | 441 | uargv = [] |
|
441 | 442 | if enc is None: |
|
442 |
enc = |
|
|
443 | enc = getdefaultencoding() | |
|
443 | 444 | for arg in argv: |
|
444 | 445 | if not isinstance(arg, unicode): |
|
445 | 446 | # only decode if not already decoded |
|
446 | 447 | arg = arg.decode(enc) |
|
447 | 448 | uargv.append(arg) |
|
448 | 449 | return uargv |
|
449 | 450 | |
|
450 | 451 | |
|
451 | 452 | def load_config(self, argv=None, aliases=None, flags=None): |
|
452 | 453 | """Parse the configuration and generate the Config object. |
|
453 | 454 | |
|
454 | 455 | After loading, any arguments that are not key-value or |
|
455 | 456 | flags will be stored in self.extra_args - a list of |
|
456 | 457 | unparsed command-line arguments. This is used for |
|
457 | 458 | arguments such as input files or subcommands. |
|
458 | 459 | |
|
459 | 460 | Parameters |
|
460 | 461 | ---------- |
|
461 | 462 | argv : list, optional |
|
462 | 463 | A list that has the form of sys.argv[1:] which has unicode |
|
463 | 464 | elements of the form u"key=value". If this is None (default), |
|
464 | 465 | then self.argv will be used. |
|
465 | 466 | aliases : dict |
|
466 | 467 | A dict of aliases for configurable traits. |
|
467 | 468 | Keys are the short aliases, Values are the resolved trait. |
|
468 | 469 | Of the form: `{'alias' : 'Configurable.trait'}` |
|
469 | 470 | flags : dict |
|
470 | 471 | A dict of flags, keyed by str name. Values can be Config objects |
|
471 | 472 | or dicts. When the flag is triggered, The config is loaded as |
|
472 | 473 | `self.config.update(cfg)`. |
|
473 | 474 | """ |
|
474 | 475 | from IPython.config.configurable import Configurable |
|
475 | 476 | |
|
476 | 477 | self.clear() |
|
477 | 478 | if argv is None: |
|
478 | 479 | argv = self.argv |
|
479 | 480 | if aliases is None: |
|
480 | 481 | aliases = self.aliases |
|
481 | 482 | if flags is None: |
|
482 | 483 | flags = self.flags |
|
483 | 484 | |
|
484 | 485 | # ensure argv is a list of unicode strings: |
|
485 | 486 | uargv = self._decode_argv(argv) |
|
486 | 487 | for idx,raw in enumerate(uargv): |
|
487 | 488 | # strip leading '-' |
|
488 | 489 | item = raw.lstrip('-') |
|
489 | 490 | |
|
490 | 491 | if raw == '--': |
|
491 | 492 | # don't parse arguments after '--' |
|
492 | 493 | # this is useful for relaying arguments to scripts, e.g. |
|
493 | 494 | # ipython -i foo.py --pylab=qt -- args after '--' go-to-foo.py |
|
494 | 495 | self.extra_args.extend(uargv[idx+1:]) |
|
495 | 496 | break |
|
496 | 497 | |
|
497 | 498 | if kv_pattern.match(raw): |
|
498 | 499 | lhs,rhs = item.split('=',1) |
|
499 | 500 | # Substitute longnames for aliases. |
|
500 | 501 | if lhs in aliases: |
|
501 | 502 | lhs = aliases[lhs] |
|
502 | 503 | if '.' not in lhs: |
|
503 | 504 | # probably a mistyped alias, but not technically illegal |
|
504 | 505 | warn.warn("Unrecognized alias: '%s', it will probably have no effect."%lhs) |
|
505 | 506 | try: |
|
506 | 507 | self._exec_config_str(lhs, rhs) |
|
507 | 508 | except Exception: |
|
508 | 509 | raise ArgumentError("Invalid argument: '%s'" % raw) |
|
509 | 510 | |
|
510 | 511 | elif flag_pattern.match(raw): |
|
511 | 512 | if item in flags: |
|
512 | 513 | cfg,help = flags[item] |
|
513 | 514 | self._load_flag(cfg) |
|
514 | 515 | else: |
|
515 | 516 | raise ArgumentError("Unrecognized flag: '%s'"%raw) |
|
516 | 517 | elif raw.startswith('-'): |
|
517 | 518 | kv = '--'+item |
|
518 | 519 | if kv_pattern.match(kv): |
|
519 | 520 | raise ArgumentError("Invalid argument: '%s', did you mean '%s'?"%(raw, kv)) |
|
520 | 521 | else: |
|
521 | 522 | raise ArgumentError("Invalid argument: '%s'"%raw) |
|
522 | 523 | else: |
|
523 | 524 | # keep all args that aren't valid in a list, |
|
524 | 525 | # in case our parent knows what to do with them. |
|
525 | 526 | self.extra_args.append(item) |
|
526 | 527 | return self.config |
|
527 | 528 | |
|
528 | 529 | class ArgParseConfigLoader(CommandLineConfigLoader): |
|
529 | 530 | """A loader that uses the argparse module to load from the command line.""" |
|
530 | 531 | |
|
531 | 532 | def __init__(self, argv=None, aliases=None, flags=None, *parser_args, **parser_kw): |
|
532 | 533 | """Create a config loader for use with argparse. |
|
533 | 534 | |
|
534 | 535 | Parameters |
|
535 | 536 | ---------- |
|
536 | 537 | |
|
537 | 538 | argv : optional, list |
|
538 | 539 | If given, used to read command-line arguments from, otherwise |
|
539 | 540 | sys.argv[1:] is used. |
|
540 | 541 | |
|
541 | 542 | parser_args : tuple |
|
542 | 543 | A tuple of positional arguments that will be passed to the |
|
543 | 544 | constructor of :class:`argparse.ArgumentParser`. |
|
544 | 545 | |
|
545 | 546 | parser_kw : dict |
|
546 | 547 | A tuple of keyword arguments that will be passed to the |
|
547 | 548 | constructor of :class:`argparse.ArgumentParser`. |
|
548 | 549 | |
|
549 | 550 | Returns |
|
550 | 551 | ------- |
|
551 | 552 | config : Config |
|
552 | 553 | The resulting Config object. |
|
553 | 554 | """ |
|
554 | 555 | super(CommandLineConfigLoader, self).__init__() |
|
555 | 556 | self.clear() |
|
556 | 557 | if argv is None: |
|
557 | 558 | argv = sys.argv[1:] |
|
558 | 559 | self.argv = argv |
|
559 | 560 | self.aliases = aliases or {} |
|
560 | 561 | self.flags = flags or {} |
|
561 | 562 | |
|
562 | 563 | self.parser_args = parser_args |
|
563 | 564 | self.version = parser_kw.pop("version", None) |
|
564 | 565 | kwargs = dict(argument_default=argparse.SUPPRESS) |
|
565 | 566 | kwargs.update(parser_kw) |
|
566 | 567 | self.parser_kw = kwargs |
|
567 | 568 | |
|
568 | 569 | def load_config(self, argv=None, aliases=None, flags=None): |
|
569 | 570 | """Parse command line arguments and return as a Config object. |
|
570 | 571 | |
|
571 | 572 | Parameters |
|
572 | 573 | ---------- |
|
573 | 574 | |
|
574 | 575 | args : optional, list |
|
575 | 576 | If given, a list with the structure of sys.argv[1:] to parse |
|
576 | 577 | arguments from. If not given, the instance's self.argv attribute |
|
577 | 578 | (given at construction time) is used.""" |
|
578 | 579 | self.clear() |
|
579 | 580 | if argv is None: |
|
580 | 581 | argv = self.argv |
|
581 | 582 | if aliases is None: |
|
582 | 583 | aliases = self.aliases |
|
583 | 584 | if flags is None: |
|
584 | 585 | flags = self.flags |
|
585 | 586 | self._create_parser(aliases, flags) |
|
586 | 587 | self._parse_args(argv) |
|
587 | 588 | self._convert_to_config() |
|
588 | 589 | return self.config |
|
589 | 590 | |
|
590 | 591 | def get_extra_args(self): |
|
591 | 592 | if hasattr(self, 'extra_args'): |
|
592 | 593 | return self.extra_args |
|
593 | 594 | else: |
|
594 | 595 | return [] |
|
595 | 596 | |
|
596 | 597 | def _create_parser(self, aliases=None, flags=None): |
|
597 | 598 | self.parser = ArgumentParser(*self.parser_args, **self.parser_kw) |
|
598 | 599 | self._add_arguments(aliases, flags) |
|
599 | 600 | |
|
600 | 601 | def _add_arguments(self, aliases=None, flags=None): |
|
601 | 602 | raise NotImplementedError("subclasses must implement _add_arguments") |
|
602 | 603 | |
|
603 | 604 | def _parse_args(self, args): |
|
604 | 605 | """self.parser->self.parsed_data""" |
|
605 | 606 | # decode sys.argv to support unicode command-line options |
|
606 |
enc = |
|
|
607 | enc = getdefaultencoding() | |
|
607 | 608 | uargs = [py3compat.cast_unicode(a, enc) for a in args] |
|
608 | 609 | self.parsed_data, self.extra_args = self.parser.parse_known_args(uargs) |
|
609 | 610 | |
|
610 | 611 | def _convert_to_config(self): |
|
611 | 612 | """self.parsed_data->self.config""" |
|
612 | 613 | for k, v in vars(self.parsed_data).iteritems(): |
|
613 | 614 | exec "self.config.%s = v"%k in locals(), globals() |
|
614 | 615 | |
|
615 | 616 | class KVArgParseConfigLoader(ArgParseConfigLoader): |
|
616 | 617 | """A config loader that loads aliases and flags with argparse, |
|
617 | 618 | but will use KVLoader for the rest. This allows better parsing |
|
618 | 619 | of common args, such as `ipython -c 'print 5'`, but still gets |
|
619 | 620 | arbitrary config with `ipython --InteractiveShell.use_readline=False`""" |
|
620 | 621 | |
|
621 | 622 | def _convert_to_config(self): |
|
622 | 623 | """self.parsed_data->self.config""" |
|
623 | 624 | for k, v in vars(self.parsed_data).iteritems(): |
|
624 | 625 | self._exec_config_str(k, v) |
|
625 | 626 | |
|
626 | 627 | def _add_arguments(self, aliases=None, flags=None): |
|
627 | 628 | self.alias_flags = {} |
|
628 | 629 | # print aliases, flags |
|
629 | 630 | if aliases is None: |
|
630 | 631 | aliases = self.aliases |
|
631 | 632 | if flags is None: |
|
632 | 633 | flags = self.flags |
|
633 | 634 | paa = self.parser.add_argument |
|
634 | 635 | for key,value in aliases.iteritems(): |
|
635 | 636 | if key in flags: |
|
636 | 637 | # flags |
|
637 | 638 | nargs = '?' |
|
638 | 639 | else: |
|
639 | 640 | nargs = None |
|
640 | 641 | if len(key) is 1: |
|
641 | 642 | paa('-'+key, '--'+key, type=unicode, dest=value, nargs=nargs) |
|
642 | 643 | else: |
|
643 | 644 | paa('--'+key, type=unicode, dest=value, nargs=nargs) |
|
644 | 645 | for key, (value, help) in flags.iteritems(): |
|
645 | 646 | if key in self.aliases: |
|
646 | 647 | # |
|
647 | 648 | self.alias_flags[self.aliases[key]] = value |
|
648 | 649 | continue |
|
649 | 650 | if len(key) is 1: |
|
650 | 651 | paa('-'+key, '--'+key, action='append_const', dest='_flags', const=value) |
|
651 | 652 | else: |
|
652 | 653 | paa('--'+key, action='append_const', dest='_flags', const=value) |
|
653 | 654 | |
|
654 | 655 | def _convert_to_config(self): |
|
655 | 656 | """self.parsed_data->self.config, parse unrecognized extra args via KVLoader.""" |
|
656 | 657 | # remove subconfigs list from namespace before transforming the Namespace |
|
657 | 658 | if '_flags' in self.parsed_data: |
|
658 | 659 | subcs = self.parsed_data._flags |
|
659 | 660 | del self.parsed_data._flags |
|
660 | 661 | else: |
|
661 | 662 | subcs = [] |
|
662 | 663 | |
|
663 | 664 | for k, v in vars(self.parsed_data).iteritems(): |
|
664 | 665 | if v is None: |
|
665 | 666 | # it was a flag that shares the name of an alias |
|
666 | 667 | subcs.append(self.alias_flags[k]) |
|
667 | 668 | else: |
|
668 | 669 | # eval the KV assignment |
|
669 | 670 | self._exec_config_str(k, v) |
|
670 | 671 | |
|
671 | 672 | for subc in subcs: |
|
672 | 673 | self._load_flag(subc) |
|
673 | 674 | |
|
674 | 675 | if self.extra_args: |
|
675 | 676 | sub_parser = KeyValueConfigLoader() |
|
676 | 677 | sub_parser.load_config(self.extra_args) |
|
677 | 678 | self.config._merge(sub_parser.config) |
|
678 | 679 | self.extra_args = sub_parser.extra_args |
|
679 | 680 | |
|
680 | 681 | |
|
681 | 682 | def load_pyconfig_files(config_files, path): |
|
682 | 683 | """Load multiple Python config files, merging each of them in turn. |
|
683 | 684 | |
|
684 | 685 | Parameters |
|
685 | 686 | ========== |
|
686 | 687 | config_files : list of str |
|
687 | 688 | List of config files names to load and merge into the config. |
|
688 | 689 | path : unicode |
|
689 | 690 | The full path to the location of the config files. |
|
690 | 691 | """ |
|
691 | 692 | config = Config() |
|
692 | 693 | for cf in config_files: |
|
693 | 694 | loader = PyFileConfigLoader(cf, path=path) |
|
694 | 695 | try: |
|
695 | 696 | next_config = loader.load_config() |
|
696 | 697 | except ConfigFileNotFound: |
|
697 | 698 | pass |
|
698 | 699 | except: |
|
699 | 700 | raise |
|
700 | 701 | else: |
|
701 | 702 | config._merge(next_config) |
|
702 | 703 | return config |
@@ -1,59 +1,60 b'' | |||
|
1 | 1 | """Support for interactive macros in IPython""" |
|
2 | 2 | |
|
3 | 3 | #***************************************************************************** |
|
4 | 4 | # Copyright (C) 2001-2005 Fernando Perez <fperez@colorado.edu> |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the BSD License. The full license is in |
|
7 | 7 | # the file COPYING, distributed as part of this software. |
|
8 | 8 | #***************************************************************************** |
|
9 | 9 | |
|
10 | 10 | import re |
|
11 | 11 | import sys |
|
12 | 12 | |
|
13 | 13 | from IPython.utils import py3compat |
|
14 | from IPython.utils.encoding import getdefaultencoding | |
|
14 | 15 | |
|
15 | 16 | coding_declaration = re.compile(r"#\s*coding[:=]\s*([-\w.]+)") |
|
16 | 17 | |
|
17 | 18 | class Macro(object): |
|
18 | 19 | """Simple class to store the value of macros as strings. |
|
19 | 20 | |
|
20 | 21 | Macro is just a callable that executes a string of IPython |
|
21 | 22 | input when called. |
|
22 | 23 | |
|
23 | 24 | Args to macro are available in _margv list if you need them. |
|
24 | 25 | """ |
|
25 | 26 | |
|
26 | 27 | def __init__(self,code): |
|
27 | 28 | """store the macro value, as a single string which can be executed""" |
|
28 | 29 | lines = [] |
|
29 | 30 | enc = None |
|
30 | 31 | for line in code.splitlines(): |
|
31 | 32 | coding_match = coding_declaration.match(line) |
|
32 | 33 | if coding_match: |
|
33 | 34 | enc = coding_match.group(1) |
|
34 | 35 | else: |
|
35 | 36 | lines.append(line) |
|
36 | 37 | code = "\n".join(lines) |
|
37 | 38 | if isinstance(code, bytes): |
|
38 |
code = code.decode(enc or |
|
|
39 | code = code.decode(enc or getdefaultencoding()) | |
|
39 | 40 | self.value = code + '\n' |
|
40 | 41 | |
|
41 | 42 | def __str__(self): |
|
42 | 43 | return py3compat.unicode_to_str(self.value) |
|
43 | 44 | |
|
44 | 45 | def __unicode__(self): |
|
45 | 46 | return self.value |
|
46 | 47 | |
|
47 | 48 | def __repr__(self): |
|
48 | 49 | return 'IPython.macro.Macro(%s)' % repr(self.value) |
|
49 | 50 | |
|
50 | 51 | def __getstate__(self): |
|
51 | 52 | """ needed for safe pickling via %store """ |
|
52 | 53 | return {'value': self.value} |
|
53 | 54 | |
|
54 | 55 | def __add__(self, other): |
|
55 | 56 | if isinstance(other, Macro): |
|
56 | 57 | return Macro(self.value + other.value) |
|
57 | 58 | elif isinstance(other, basestring): |
|
58 | 59 | return Macro(self.value + other) |
|
59 | 60 | raise TypeError |
@@ -1,3798 +1,3799 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """Magic functions for InteractiveShell. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
7 | 7 | # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu> |
|
8 | 8 | # Copyright (C) 2008-2011 The IPython Development Team |
|
9 | 9 | |
|
10 | 10 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | 11 | # the file COPYING, distributed as part of this software. |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | # Imports |
|
16 | 16 | #----------------------------------------------------------------------------- |
|
17 | 17 | |
|
18 | 18 | import __builtin__ as builtin_mod |
|
19 | 19 | import __future__ |
|
20 | 20 | import bdb |
|
21 | 21 | import inspect |
|
22 | 22 | import imp |
|
23 | 23 | import io |
|
24 | 24 | import os |
|
25 | 25 | import sys |
|
26 | 26 | import shutil |
|
27 | 27 | import re |
|
28 | 28 | import time |
|
29 | 29 | import gc |
|
30 | 30 | from StringIO import StringIO |
|
31 | 31 | from getopt import getopt,GetoptError |
|
32 | 32 | from pprint import pformat |
|
33 | 33 | from xmlrpclib import ServerProxy |
|
34 | 34 | |
|
35 | 35 | # cProfile was added in Python2.5 |
|
36 | 36 | try: |
|
37 | 37 | import cProfile as profile |
|
38 | 38 | import pstats |
|
39 | 39 | except ImportError: |
|
40 | 40 | # profile isn't bundled by default in Debian for license reasons |
|
41 | 41 | try: |
|
42 | 42 | import profile,pstats |
|
43 | 43 | except ImportError: |
|
44 | 44 | profile = pstats = None |
|
45 | 45 | |
|
46 | 46 | import IPython |
|
47 | 47 | from IPython.core import debugger, oinspect |
|
48 | 48 | from IPython.core.error import TryNext |
|
49 | 49 | from IPython.core.error import UsageError |
|
50 | 50 | from IPython.core.error import StdinNotImplementedError |
|
51 | 51 | from IPython.core.fakemodule import FakeModule |
|
52 | 52 | from IPython.core.profiledir import ProfileDir |
|
53 | 53 | from IPython.core.macro import Macro |
|
54 | 54 | from IPython.core import magic_arguments, page |
|
55 | 55 | from IPython.core.prefilter import ESC_MAGIC |
|
56 | 56 | from IPython.core.pylabtools import mpl_runner |
|
57 | 57 | from IPython.testing.skipdoctest import skip_doctest |
|
58 | 58 | from IPython.utils import py3compat |
|
59 | 59 | from IPython.utils import openpy |
|
60 | from IPython.utils.encoding import getdefaultencoding | |
|
60 | 61 | from IPython.utils.io import file_read, nlprint |
|
61 | 62 | from IPython.utils.module_paths import find_mod |
|
62 | 63 | from IPython.utils.path import get_py_filename, unquote_filename |
|
63 | 64 | from IPython.utils.process import arg_split, abbrev_cwd |
|
64 | 65 | from IPython.utils.terminal import set_term_title |
|
65 | 66 | from IPython.utils.text import LSString, SList, format_screen |
|
66 | 67 | from IPython.utils.timing import clock, clock2 |
|
67 | 68 | from IPython.utils.warn import warn, error |
|
68 | 69 | from IPython.utils.ipstruct import Struct |
|
69 | 70 | from IPython.config.application import Application |
|
70 | 71 | |
|
71 | 72 | #----------------------------------------------------------------------------- |
|
72 | 73 | # Utility functions |
|
73 | 74 | #----------------------------------------------------------------------------- |
|
74 | 75 | |
|
75 | 76 | def on_off(tag): |
|
76 | 77 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
77 | 78 | return ['OFF','ON'][tag] |
|
78 | 79 | |
|
79 | 80 | class Bunch: pass |
|
80 | 81 | |
|
81 | 82 | def compress_dhist(dh): |
|
82 | 83 | head, tail = dh[:-10], dh[-10:] |
|
83 | 84 | |
|
84 | 85 | newhead = [] |
|
85 | 86 | done = set() |
|
86 | 87 | for h in head: |
|
87 | 88 | if h in done: |
|
88 | 89 | continue |
|
89 | 90 | newhead.append(h) |
|
90 | 91 | done.add(h) |
|
91 | 92 | |
|
92 | 93 | return newhead + tail |
|
93 | 94 | |
|
94 | 95 | def needs_local_scope(func): |
|
95 | 96 | """Decorator to mark magic functions which need to local scope to run.""" |
|
96 | 97 | func.needs_local_scope = True |
|
97 | 98 | return func |
|
98 | 99 | |
|
99 | 100 | |
|
100 | 101 | # Used for exception handling in magic_edit |
|
101 | 102 | class MacroToEdit(ValueError): pass |
|
102 | 103 | |
|
103 | 104 | #*************************************************************************** |
|
104 | 105 | # Main class implementing Magic functionality |
|
105 | 106 | |
|
106 | 107 | # XXX - for some odd reason, if Magic is made a new-style class, we get errors |
|
107 | 108 | # on construction of the main InteractiveShell object. Something odd is going |
|
108 | 109 | # on with super() calls, Configurable and the MRO... For now leave it as-is, but |
|
109 | 110 | # eventually this needs to be clarified. |
|
110 | 111 | # BG: This is because InteractiveShell inherits from this, but is itself a |
|
111 | 112 | # Configurable. This messes up the MRO in some way. The fix is that we need to |
|
112 | 113 | # make Magic a configurable that InteractiveShell does not subclass. |
|
113 | 114 | |
|
114 | 115 | class Magic: |
|
115 | 116 | """Magic functions for InteractiveShell. |
|
116 | 117 | |
|
117 | 118 | Shell functions which can be reached as %function_name. All magic |
|
118 | 119 | functions should accept a string, which they can parse for their own |
|
119 | 120 | needs. This can make some functions easier to type, eg `%cd ../` |
|
120 | 121 | vs. `%cd("../")` |
|
121 | 122 | |
|
122 | 123 | ALL definitions MUST begin with the prefix magic_. The user won't need it |
|
123 | 124 | at the command line, but it is is needed in the definition. """ |
|
124 | 125 | |
|
125 | 126 | # class globals |
|
126 | 127 | auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.', |
|
127 | 128 | 'Automagic is ON, % prefix NOT needed for magic functions.'] |
|
128 | 129 | |
|
129 | 130 | |
|
130 | 131 | configurables = None |
|
131 | 132 | #...................................................................... |
|
132 | 133 | # some utility functions |
|
133 | 134 | |
|
134 | 135 | def __init__(self,shell): |
|
135 | 136 | |
|
136 | 137 | self.options_table = {} |
|
137 | 138 | if profile is None: |
|
138 | 139 | self.magic_prun = self.profile_missing_notice |
|
139 | 140 | self.shell = shell |
|
140 | 141 | if self.configurables is None: |
|
141 | 142 | self.configurables = [] |
|
142 | 143 | |
|
143 | 144 | # namespace for holding state we may need |
|
144 | 145 | self._magic_state = Bunch() |
|
145 | 146 | |
|
146 | 147 | def profile_missing_notice(self, *args, **kwargs): |
|
147 | 148 | error("""\ |
|
148 | 149 | The profile module could not be found. It has been removed from the standard |
|
149 | 150 | python packages because of its non-free license. To use profiling, install the |
|
150 | 151 | python-profiler package from non-free.""") |
|
151 | 152 | |
|
152 | 153 | def default_option(self,fn,optstr): |
|
153 | 154 | """Make an entry in the options_table for fn, with value optstr""" |
|
154 | 155 | |
|
155 | 156 | if fn not in self.lsmagic(): |
|
156 | 157 | error("%s is not a magic function" % fn) |
|
157 | 158 | self.options_table[fn] = optstr |
|
158 | 159 | |
|
159 | 160 | def lsmagic(self): |
|
160 | 161 | """Return a list of currently available magic functions. |
|
161 | 162 | |
|
162 | 163 | Gives a list of the bare names after mangling (['ls','cd', ...], not |
|
163 | 164 | ['magic_ls','magic_cd',...]""" |
|
164 | 165 | |
|
165 | 166 | # FIXME. This needs a cleanup, in the way the magics list is built. |
|
166 | 167 | |
|
167 | 168 | # magics in class definition |
|
168 | 169 | class_magic = lambda fn: fn.startswith('magic_') and \ |
|
169 | 170 | callable(Magic.__dict__[fn]) |
|
170 | 171 | # in instance namespace (run-time user additions) |
|
171 | 172 | inst_magic = lambda fn: fn.startswith('magic_') and \ |
|
172 | 173 | callable(self.__dict__[fn]) |
|
173 | 174 | # and bound magics by user (so they can access self): |
|
174 | 175 | inst_bound_magic = lambda fn: fn.startswith('magic_') and \ |
|
175 | 176 | callable(self.__class__.__dict__[fn]) |
|
176 | 177 | magics = filter(class_magic,Magic.__dict__.keys()) + \ |
|
177 | 178 | filter(inst_magic,self.__dict__.keys()) + \ |
|
178 | 179 | filter(inst_bound_magic,self.__class__.__dict__.keys()) |
|
179 | 180 | out = [] |
|
180 | 181 | for fn in set(magics): |
|
181 | 182 | out.append(fn.replace('magic_','',1)) |
|
182 | 183 | out.sort() |
|
183 | 184 | return out |
|
184 | 185 | |
|
185 | 186 | def extract_input_lines(self, range_str, raw=False): |
|
186 | 187 | """Return as a string a set of input history slices. |
|
187 | 188 | |
|
188 | 189 | Parameters |
|
189 | 190 | ---------- |
|
190 | 191 | range_str : string |
|
191 | 192 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
192 | 193 | since this function is for use by magic functions which get their |
|
193 | 194 | arguments as strings. The number before the / is the session |
|
194 | 195 | number: ~n goes n back from the current session. |
|
195 | 196 | |
|
196 | 197 | Optional Parameters: |
|
197 | 198 | - raw(False): by default, the processed input is used. If this is |
|
198 | 199 | true, the raw input history is used instead. |
|
199 | 200 | |
|
200 | 201 | Note that slices can be called with two notations: |
|
201 | 202 | |
|
202 | 203 | N:M -> standard python form, means including items N...(M-1). |
|
203 | 204 | |
|
204 | 205 | N-M -> include items N..M (closed endpoint).""" |
|
205 | 206 | lines = self.shell.history_manager.\ |
|
206 | 207 | get_range_by_str(range_str, raw=raw) |
|
207 | 208 | return "\n".join(x for _, _, x in lines) |
|
208 | 209 | |
|
209 | 210 | def arg_err(self,func): |
|
210 | 211 | """Print docstring if incorrect arguments were passed""" |
|
211 | 212 | print 'Error in arguments:' |
|
212 | 213 | print oinspect.getdoc(func) |
|
213 | 214 | |
|
214 | 215 | def format_latex(self,strng): |
|
215 | 216 | """Format a string for latex inclusion.""" |
|
216 | 217 | |
|
217 | 218 | # Characters that need to be escaped for latex: |
|
218 | 219 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
219 | 220 | # Magic command names as headers: |
|
220 | 221 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, |
|
221 | 222 | re.MULTILINE) |
|
222 | 223 | # Magic commands |
|
223 | 224 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, |
|
224 | 225 | re.MULTILINE) |
|
225 | 226 | # Paragraph continue |
|
226 | 227 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
227 | 228 | |
|
228 | 229 | # The "\n" symbol |
|
229 | 230 | newline_re = re.compile(r'\\n') |
|
230 | 231 | |
|
231 | 232 | # Now build the string for output: |
|
232 | 233 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
233 | 234 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
234 | 235 | strng) |
|
235 | 236 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
236 | 237 | strng = par_re.sub(r'\\\\',strng) |
|
237 | 238 | strng = escape_re.sub(r'\\\1',strng) |
|
238 | 239 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
239 | 240 | return strng |
|
240 | 241 | |
|
241 | 242 | def parse_options(self,arg_str,opt_str,*long_opts,**kw): |
|
242 | 243 | """Parse options passed to an argument string. |
|
243 | 244 | |
|
244 | 245 | The interface is similar to that of getopt(), but it returns back a |
|
245 | 246 | Struct with the options as keys and the stripped argument string still |
|
246 | 247 | as a string. |
|
247 | 248 | |
|
248 | 249 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
249 | 250 | This allows us to easily expand variables, glob files, quote |
|
250 | 251 | arguments, etc. |
|
251 | 252 | |
|
252 | 253 | Options: |
|
253 | 254 | -mode: default 'string'. If given as 'list', the argument string is |
|
254 | 255 | returned as a list (split on whitespace) instead of a string. |
|
255 | 256 | |
|
256 | 257 | -list_all: put all option values in lists. Normally only options |
|
257 | 258 | appearing more than once are put in a list. |
|
258 | 259 | |
|
259 | 260 | -posix (True): whether to split the input line in POSIX mode or not, |
|
260 | 261 | as per the conventions outlined in the shlex module from the |
|
261 | 262 | standard library.""" |
|
262 | 263 | |
|
263 | 264 | # inject default options at the beginning of the input line |
|
264 | 265 | caller = sys._getframe(1).f_code.co_name.replace('magic_','') |
|
265 | 266 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
266 | 267 | |
|
267 | 268 | mode = kw.get('mode','string') |
|
268 | 269 | if mode not in ['string','list']: |
|
269 | 270 | raise ValueError,'incorrect mode given: %s' % mode |
|
270 | 271 | # Get options |
|
271 | 272 | list_all = kw.get('list_all',0) |
|
272 | 273 | posix = kw.get('posix', os.name == 'posix') |
|
273 | 274 | strict = kw.get('strict', True) |
|
274 | 275 | |
|
275 | 276 | # Check if we have more than one argument to warrant extra processing: |
|
276 | 277 | odict = {} # Dictionary with options |
|
277 | 278 | args = arg_str.split() |
|
278 | 279 | if len(args) >= 1: |
|
279 | 280 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
280 | 281 | # need to look for options |
|
281 | 282 | argv = arg_split(arg_str, posix, strict) |
|
282 | 283 | # Do regular option processing |
|
283 | 284 | try: |
|
284 | 285 | opts,args = getopt(argv,opt_str,*long_opts) |
|
285 | 286 | except GetoptError,e: |
|
286 | 287 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
287 | 288 | " ".join(long_opts))) |
|
288 | 289 | for o,a in opts: |
|
289 | 290 | if o.startswith('--'): |
|
290 | 291 | o = o[2:] |
|
291 | 292 | else: |
|
292 | 293 | o = o[1:] |
|
293 | 294 | try: |
|
294 | 295 | odict[o].append(a) |
|
295 | 296 | except AttributeError: |
|
296 | 297 | odict[o] = [odict[o],a] |
|
297 | 298 | except KeyError: |
|
298 | 299 | if list_all: |
|
299 | 300 | odict[o] = [a] |
|
300 | 301 | else: |
|
301 | 302 | odict[o] = a |
|
302 | 303 | |
|
303 | 304 | # Prepare opts,args for return |
|
304 | 305 | opts = Struct(odict) |
|
305 | 306 | if mode == 'string': |
|
306 | 307 | args = ' '.join(args) |
|
307 | 308 | |
|
308 | 309 | return opts,args |
|
309 | 310 | |
|
310 | 311 | #...................................................................... |
|
311 | 312 | # And now the actual magic functions |
|
312 | 313 | |
|
313 | 314 | # Functions for IPython shell work (vars,funcs, config, etc) |
|
314 | 315 | def magic_lsmagic(self, parameter_s = ''): |
|
315 | 316 | """List currently available magic functions.""" |
|
316 | 317 | mesc = ESC_MAGIC |
|
317 | 318 | print 'Available magic functions:\n'+mesc+\ |
|
318 | 319 | (' '+mesc).join(self.lsmagic()) |
|
319 | 320 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
320 | 321 | return None |
|
321 | 322 | |
|
322 | 323 | def magic_magic(self, parameter_s = ''): |
|
323 | 324 | """Print information about the magic function system. |
|
324 | 325 | |
|
325 | 326 | Supported formats: -latex, -brief, -rest |
|
326 | 327 | """ |
|
327 | 328 | |
|
328 | 329 | mode = '' |
|
329 | 330 | try: |
|
330 | 331 | if parameter_s.split()[0] == '-latex': |
|
331 | 332 | mode = 'latex' |
|
332 | 333 | if parameter_s.split()[0] == '-brief': |
|
333 | 334 | mode = 'brief' |
|
334 | 335 | if parameter_s.split()[0] == '-rest': |
|
335 | 336 | mode = 'rest' |
|
336 | 337 | rest_docs = [] |
|
337 | 338 | except: |
|
338 | 339 | pass |
|
339 | 340 | |
|
340 | 341 | magic_docs = [] |
|
341 | 342 | for fname in self.lsmagic(): |
|
342 | 343 | mname = 'magic_' + fname |
|
343 | 344 | for space in (Magic,self,self.__class__): |
|
344 | 345 | try: |
|
345 | 346 | fn = space.__dict__[mname] |
|
346 | 347 | except KeyError: |
|
347 | 348 | pass |
|
348 | 349 | else: |
|
349 | 350 | break |
|
350 | 351 | if mode == 'brief': |
|
351 | 352 | # only first line |
|
352 | 353 | if fn.__doc__: |
|
353 | 354 | fndoc = fn.__doc__.split('\n',1)[0] |
|
354 | 355 | else: |
|
355 | 356 | fndoc = 'No documentation' |
|
356 | 357 | else: |
|
357 | 358 | if fn.__doc__: |
|
358 | 359 | fndoc = fn.__doc__.rstrip() |
|
359 | 360 | else: |
|
360 | 361 | fndoc = 'No documentation' |
|
361 | 362 | |
|
362 | 363 | |
|
363 | 364 | if mode == 'rest': |
|
364 | 365 | rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC, |
|
365 | 366 | fname,fndoc)) |
|
366 | 367 | |
|
367 | 368 | else: |
|
368 | 369 | magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC, |
|
369 | 370 | fname,fndoc)) |
|
370 | 371 | |
|
371 | 372 | magic_docs = ''.join(magic_docs) |
|
372 | 373 | |
|
373 | 374 | if mode == 'rest': |
|
374 | 375 | return "".join(rest_docs) |
|
375 | 376 | |
|
376 | 377 | if mode == 'latex': |
|
377 | 378 | print self.format_latex(magic_docs) |
|
378 | 379 | return |
|
379 | 380 | else: |
|
380 | 381 | magic_docs = format_screen(magic_docs) |
|
381 | 382 | if mode == 'brief': |
|
382 | 383 | return magic_docs |
|
383 | 384 | |
|
384 | 385 | outmsg = """ |
|
385 | 386 | IPython's 'magic' functions |
|
386 | 387 | =========================== |
|
387 | 388 | |
|
388 | 389 | The magic function system provides a series of functions which allow you to |
|
389 | 390 | control the behavior of IPython itself, plus a lot of system-type |
|
390 | 391 | features. All these functions are prefixed with a % character, but parameters |
|
391 | 392 | are given without parentheses or quotes. |
|
392 | 393 | |
|
393 | 394 | NOTE: If you have 'automagic' enabled (via the command line option or with the |
|
394 | 395 | %automagic function), you don't need to type in the % explicitly. By default, |
|
395 | 396 | IPython ships with automagic on, so you should only rarely need the % escape. |
|
396 | 397 | |
|
397 | 398 | Example: typing '%cd mydir' (without the quotes) changes you working directory |
|
398 | 399 | to 'mydir', if it exists. |
|
399 | 400 | |
|
400 | 401 | For a list of the available magic functions, use %lsmagic. For a description |
|
401 | 402 | of any of them, type %magic_name?, e.g. '%cd?'. |
|
402 | 403 | |
|
403 | 404 | Currently the magic system has the following functions:\n""" |
|
404 | 405 | |
|
405 | 406 | mesc = ESC_MAGIC |
|
406 | 407 | outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):" |
|
407 | 408 | "\n\n%s%s\n\n%s" % (outmsg, |
|
408 | 409 | magic_docs,mesc,mesc, |
|
409 | 410 | (' '+mesc).join(self.lsmagic()), |
|
410 | 411 | Magic.auto_status[self.shell.automagic] ) ) |
|
411 | 412 | page.page(outmsg) |
|
412 | 413 | |
|
413 | 414 | def magic_automagic(self, parameter_s = ''): |
|
414 | 415 | """Make magic functions callable without having to type the initial %. |
|
415 | 416 | |
|
416 | 417 | Without argumentsl toggles on/off (when off, you must call it as |
|
417 | 418 | %automagic, of course). With arguments it sets the value, and you can |
|
418 | 419 | use any of (case insensitive): |
|
419 | 420 | |
|
420 | 421 | - on,1,True: to activate |
|
421 | 422 | |
|
422 | 423 | - off,0,False: to deactivate. |
|
423 | 424 | |
|
424 | 425 | Note that magic functions have lowest priority, so if there's a |
|
425 | 426 | variable whose name collides with that of a magic fn, automagic won't |
|
426 | 427 | work for that function (you get the variable instead). However, if you |
|
427 | 428 | delete the variable (del var), the previously shadowed magic function |
|
428 | 429 | becomes visible to automagic again.""" |
|
429 | 430 | |
|
430 | 431 | arg = parameter_s.lower() |
|
431 | 432 | if parameter_s in ('on','1','true'): |
|
432 | 433 | self.shell.automagic = True |
|
433 | 434 | elif parameter_s in ('off','0','false'): |
|
434 | 435 | self.shell.automagic = False |
|
435 | 436 | else: |
|
436 | 437 | self.shell.automagic = not self.shell.automagic |
|
437 | 438 | print '\n' + Magic.auto_status[self.shell.automagic] |
|
438 | 439 | |
|
439 | 440 | @skip_doctest |
|
440 | 441 | def magic_autocall(self, parameter_s = ''): |
|
441 | 442 | """Make functions callable without having to type parentheses. |
|
442 | 443 | |
|
443 | 444 | Usage: |
|
444 | 445 | |
|
445 | 446 | %autocall [mode] |
|
446 | 447 | |
|
447 | 448 | The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the |
|
448 | 449 | value is toggled on and off (remembering the previous state). |
|
449 | 450 | |
|
450 | 451 | In more detail, these values mean: |
|
451 | 452 | |
|
452 | 453 | 0 -> fully disabled |
|
453 | 454 | |
|
454 | 455 | 1 -> active, but do not apply if there are no arguments on the line. |
|
455 | 456 | |
|
456 | 457 | In this mode, you get:: |
|
457 | 458 | |
|
458 | 459 | In [1]: callable |
|
459 | 460 | Out[1]: <built-in function callable> |
|
460 | 461 | |
|
461 | 462 | In [2]: callable 'hello' |
|
462 | 463 | ------> callable('hello') |
|
463 | 464 | Out[2]: False |
|
464 | 465 | |
|
465 | 466 | 2 -> Active always. Even if no arguments are present, the callable |
|
466 | 467 | object is called:: |
|
467 | 468 | |
|
468 | 469 | In [2]: float |
|
469 | 470 | ------> float() |
|
470 | 471 | Out[2]: 0.0 |
|
471 | 472 | |
|
472 | 473 | Note that even with autocall off, you can still use '/' at the start of |
|
473 | 474 | a line to treat the first argument on the command line as a function |
|
474 | 475 | and add parentheses to it:: |
|
475 | 476 | |
|
476 | 477 | In [8]: /str 43 |
|
477 | 478 | ------> str(43) |
|
478 | 479 | Out[8]: '43' |
|
479 | 480 | |
|
480 | 481 | # all-random (note for auto-testing) |
|
481 | 482 | """ |
|
482 | 483 | |
|
483 | 484 | if parameter_s: |
|
484 | 485 | arg = int(parameter_s) |
|
485 | 486 | else: |
|
486 | 487 | arg = 'toggle' |
|
487 | 488 | |
|
488 | 489 | if not arg in (0,1,2,'toggle'): |
|
489 | 490 | error('Valid modes: (0->Off, 1->Smart, 2->Full') |
|
490 | 491 | return |
|
491 | 492 | |
|
492 | 493 | if arg in (0,1,2): |
|
493 | 494 | self.shell.autocall = arg |
|
494 | 495 | else: # toggle |
|
495 | 496 | if self.shell.autocall: |
|
496 | 497 | self._magic_state.autocall_save = self.shell.autocall |
|
497 | 498 | self.shell.autocall = 0 |
|
498 | 499 | else: |
|
499 | 500 | try: |
|
500 | 501 | self.shell.autocall = self._magic_state.autocall_save |
|
501 | 502 | except AttributeError: |
|
502 | 503 | self.shell.autocall = self._magic_state.autocall_save = 1 |
|
503 | 504 | |
|
504 | 505 | print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall] |
|
505 | 506 | |
|
506 | 507 | |
|
507 | 508 | def magic_page(self, parameter_s=''): |
|
508 | 509 | """Pretty print the object and display it through a pager. |
|
509 | 510 | |
|
510 | 511 | %page [options] OBJECT |
|
511 | 512 | |
|
512 | 513 | If no object is given, use _ (last output). |
|
513 | 514 | |
|
514 | 515 | Options: |
|
515 | 516 | |
|
516 | 517 | -r: page str(object), don't pretty-print it.""" |
|
517 | 518 | |
|
518 | 519 | # After a function contributed by Olivier Aubert, slightly modified. |
|
519 | 520 | |
|
520 | 521 | # Process options/args |
|
521 | 522 | opts,args = self.parse_options(parameter_s,'r') |
|
522 | 523 | raw = 'r' in opts |
|
523 | 524 | |
|
524 | 525 | oname = args and args or '_' |
|
525 | 526 | info = self._ofind(oname) |
|
526 | 527 | if info['found']: |
|
527 | 528 | txt = (raw and str or pformat)( info['obj'] ) |
|
528 | 529 | page.page(txt) |
|
529 | 530 | else: |
|
530 | 531 | print 'Object `%s` not found' % oname |
|
531 | 532 | |
|
532 | 533 | def magic_profile(self, parameter_s=''): |
|
533 | 534 | """Print your currently active IPython profile.""" |
|
534 | 535 | from IPython.core.application import BaseIPythonApplication |
|
535 | 536 | if BaseIPythonApplication.initialized(): |
|
536 | 537 | print BaseIPythonApplication.instance().profile |
|
537 | 538 | else: |
|
538 | 539 | error("profile is an application-level value, but you don't appear to be in an IPython application") |
|
539 | 540 | |
|
540 | 541 | def magic_pinfo(self, parameter_s='', namespaces=None): |
|
541 | 542 | """Provide detailed information about an object. |
|
542 | 543 | |
|
543 | 544 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
544 | 545 | |
|
545 | 546 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
546 | 547 | |
|
547 | 548 | |
|
548 | 549 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
549 | 550 | detail_level = 0 |
|
550 | 551 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
551 | 552 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
552 | 553 | pinfo,qmark1,oname,qmark2 = \ |
|
553 | 554 | re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
554 | 555 | if pinfo or qmark1 or qmark2: |
|
555 | 556 | detail_level = 1 |
|
556 | 557 | if "*" in oname: |
|
557 | 558 | self.magic_psearch(oname) |
|
558 | 559 | else: |
|
559 | 560 | self.shell._inspect('pinfo', oname, detail_level=detail_level, |
|
560 | 561 | namespaces=namespaces) |
|
561 | 562 | |
|
562 | 563 | def magic_pinfo2(self, parameter_s='', namespaces=None): |
|
563 | 564 | """Provide extra detailed information about an object. |
|
564 | 565 | |
|
565 | 566 | '%pinfo2 object' is just a synonym for object?? or ??object.""" |
|
566 | 567 | self.shell._inspect('pinfo', parameter_s, detail_level=1, |
|
567 | 568 | namespaces=namespaces) |
|
568 | 569 | |
|
569 | 570 | @skip_doctest |
|
570 | 571 | def magic_pdef(self, parameter_s='', namespaces=None): |
|
571 | 572 | """Print the definition header for any callable object. |
|
572 | 573 | |
|
573 | 574 | If the object is a class, print the constructor information. |
|
574 | 575 | |
|
575 | 576 | Examples |
|
576 | 577 | -------- |
|
577 | 578 | :: |
|
578 | 579 | |
|
579 | 580 | In [3]: %pdef urllib.urlopen |
|
580 | 581 | urllib.urlopen(url, data=None, proxies=None) |
|
581 | 582 | """ |
|
582 | 583 | self._inspect('pdef',parameter_s, namespaces) |
|
583 | 584 | |
|
584 | 585 | def magic_pdoc(self, parameter_s='', namespaces=None): |
|
585 | 586 | """Print the docstring for an object. |
|
586 | 587 | |
|
587 | 588 | If the given object is a class, it will print both the class and the |
|
588 | 589 | constructor docstrings.""" |
|
589 | 590 | self._inspect('pdoc',parameter_s, namespaces) |
|
590 | 591 | |
|
591 | 592 | def magic_psource(self, parameter_s='', namespaces=None): |
|
592 | 593 | """Print (or run through pager) the source code for an object.""" |
|
593 | 594 | self._inspect('psource',parameter_s, namespaces) |
|
594 | 595 | |
|
595 | 596 | def magic_pfile(self, parameter_s=''): |
|
596 | 597 | """Print (or run through pager) the file where an object is defined. |
|
597 | 598 | |
|
598 | 599 | The file opens at the line where the object definition begins. IPython |
|
599 | 600 | will honor the environment variable PAGER if set, and otherwise will |
|
600 | 601 | do its best to print the file in a convenient form. |
|
601 | 602 | |
|
602 | 603 | If the given argument is not an object currently defined, IPython will |
|
603 | 604 | try to interpret it as a filename (automatically adding a .py extension |
|
604 | 605 | if needed). You can thus use %pfile as a syntax highlighting code |
|
605 | 606 | viewer.""" |
|
606 | 607 | |
|
607 | 608 | # first interpret argument as an object name |
|
608 | 609 | out = self._inspect('pfile',parameter_s) |
|
609 | 610 | # if not, try the input as a filename |
|
610 | 611 | if out == 'not found': |
|
611 | 612 | try: |
|
612 | 613 | filename = get_py_filename(parameter_s) |
|
613 | 614 | except IOError,msg: |
|
614 | 615 | print msg |
|
615 | 616 | return |
|
616 | 617 | page.page(self.shell.inspector.format(open(filename).read())) |
|
617 | 618 | |
|
618 | 619 | def magic_psearch(self, parameter_s=''): |
|
619 | 620 | """Search for object in namespaces by wildcard. |
|
620 | 621 | |
|
621 | 622 | %psearch [options] PATTERN [OBJECT TYPE] |
|
622 | 623 | |
|
623 | 624 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
624 | 625 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
625 | 626 | rest of the command line must be unchanged (options come first), so |
|
626 | 627 | for example the following forms are equivalent |
|
627 | 628 | |
|
628 | 629 | %psearch -i a* function |
|
629 | 630 | -i a* function? |
|
630 | 631 | ?-i a* function |
|
631 | 632 | |
|
632 | 633 | Arguments: |
|
633 | 634 | |
|
634 | 635 | PATTERN |
|
635 | 636 | |
|
636 | 637 | where PATTERN is a string containing * as a wildcard similar to its |
|
637 | 638 | use in a shell. The pattern is matched in all namespaces on the |
|
638 | 639 | search path. By default objects starting with a single _ are not |
|
639 | 640 | matched, many IPython generated objects have a single |
|
640 | 641 | underscore. The default is case insensitive matching. Matching is |
|
641 | 642 | also done on the attributes of objects and not only on the objects |
|
642 | 643 | in a module. |
|
643 | 644 | |
|
644 | 645 | [OBJECT TYPE] |
|
645 | 646 | |
|
646 | 647 | Is the name of a python type from the types module. The name is |
|
647 | 648 | given in lowercase without the ending type, ex. StringType is |
|
648 | 649 | written string. By adding a type here only objects matching the |
|
649 | 650 | given type are matched. Using all here makes the pattern match all |
|
650 | 651 | types (this is the default). |
|
651 | 652 | |
|
652 | 653 | Options: |
|
653 | 654 | |
|
654 | 655 | -a: makes the pattern match even objects whose names start with a |
|
655 | 656 | single underscore. These names are normally omitted from the |
|
656 | 657 | search. |
|
657 | 658 | |
|
658 | 659 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
659 | 660 | these options are given, the default is read from your configuration |
|
660 | 661 | file, with the option ``InteractiveShell.wildcards_case_sensitive``. |
|
661 | 662 | If this option is not specified in your configuration file, IPython's |
|
662 | 663 | internal default is to do a case sensitive search. |
|
663 | 664 | |
|
664 | 665 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
665 | 666 | specify can be searched in any of the following namespaces: |
|
666 | 667 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
667 | 668 | 'builtin' and 'user' are the search defaults. Note that you should |
|
668 | 669 | not use quotes when specifying namespaces. |
|
669 | 670 | |
|
670 | 671 | 'Builtin' contains the python module builtin, 'user' contains all |
|
671 | 672 | user data, 'alias' only contain the shell aliases and no python |
|
672 | 673 | objects, 'internal' contains objects used by IPython. The |
|
673 | 674 | 'user_global' namespace is only used by embedded IPython instances, |
|
674 | 675 | and it contains module-level globals. You can add namespaces to the |
|
675 | 676 | search with -s or exclude them with -e (these options can be given |
|
676 | 677 | more than once). |
|
677 | 678 | |
|
678 | 679 | Examples |
|
679 | 680 | -------- |
|
680 | 681 | :: |
|
681 | 682 | |
|
682 | 683 | %psearch a* -> objects beginning with an a |
|
683 | 684 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
684 | 685 | %psearch a* function -> all functions beginning with an a |
|
685 | 686 | %psearch re.e* -> objects beginning with an e in module re |
|
686 | 687 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
687 | 688 | %psearch r*.* string -> all strings in modules beginning with r |
|
688 | 689 | |
|
689 | 690 | Case sensitive search:: |
|
690 | 691 | |
|
691 | 692 | %psearch -c a* list all object beginning with lower case a |
|
692 | 693 | |
|
693 | 694 | Show objects beginning with a single _:: |
|
694 | 695 | |
|
695 | 696 | %psearch -a _* list objects beginning with a single underscore""" |
|
696 | 697 | try: |
|
697 | 698 | parameter_s.encode('ascii') |
|
698 | 699 | except UnicodeEncodeError: |
|
699 | 700 | print 'Python identifiers can only contain ascii characters.' |
|
700 | 701 | return |
|
701 | 702 | |
|
702 | 703 | # default namespaces to be searched |
|
703 | 704 | def_search = ['user_local', 'user_global', 'builtin'] |
|
704 | 705 | |
|
705 | 706 | # Process options/args |
|
706 | 707 | opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True) |
|
707 | 708 | opt = opts.get |
|
708 | 709 | shell = self.shell |
|
709 | 710 | psearch = shell.inspector.psearch |
|
710 | 711 | |
|
711 | 712 | # select case options |
|
712 | 713 | if opts.has_key('i'): |
|
713 | 714 | ignore_case = True |
|
714 | 715 | elif opts.has_key('c'): |
|
715 | 716 | ignore_case = False |
|
716 | 717 | else: |
|
717 | 718 | ignore_case = not shell.wildcards_case_sensitive |
|
718 | 719 | |
|
719 | 720 | # Build list of namespaces to search from user options |
|
720 | 721 | def_search.extend(opt('s',[])) |
|
721 | 722 | ns_exclude = ns_exclude=opt('e',[]) |
|
722 | 723 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
723 | 724 | |
|
724 | 725 | # Call the actual search |
|
725 | 726 | try: |
|
726 | 727 | psearch(args,shell.ns_table,ns_search, |
|
727 | 728 | show_all=opt('a'),ignore_case=ignore_case) |
|
728 | 729 | except: |
|
729 | 730 | shell.showtraceback() |
|
730 | 731 | |
|
731 | 732 | @skip_doctest |
|
732 | 733 | def magic_who_ls(self, parameter_s=''): |
|
733 | 734 | """Return a sorted list of all interactive variables. |
|
734 | 735 | |
|
735 | 736 | If arguments are given, only variables of types matching these |
|
736 | 737 | arguments are returned. |
|
737 | 738 | |
|
738 | 739 | Examples |
|
739 | 740 | -------- |
|
740 | 741 | |
|
741 | 742 | Define two variables and list them with who_ls:: |
|
742 | 743 | |
|
743 | 744 | In [1]: alpha = 123 |
|
744 | 745 | |
|
745 | 746 | In [2]: beta = 'test' |
|
746 | 747 | |
|
747 | 748 | In [3]: %who_ls |
|
748 | 749 | Out[3]: ['alpha', 'beta'] |
|
749 | 750 | |
|
750 | 751 | In [4]: %who_ls int |
|
751 | 752 | Out[4]: ['alpha'] |
|
752 | 753 | |
|
753 | 754 | In [5]: %who_ls str |
|
754 | 755 | Out[5]: ['beta'] |
|
755 | 756 | """ |
|
756 | 757 | |
|
757 | 758 | user_ns = self.shell.user_ns |
|
758 | 759 | user_ns_hidden = self.shell.user_ns_hidden |
|
759 | 760 | out = [ i for i in user_ns |
|
760 | 761 | if not i.startswith('_') \ |
|
761 | 762 | and not i in user_ns_hidden ] |
|
762 | 763 | |
|
763 | 764 | typelist = parameter_s.split() |
|
764 | 765 | if typelist: |
|
765 | 766 | typeset = set(typelist) |
|
766 | 767 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] |
|
767 | 768 | |
|
768 | 769 | out.sort() |
|
769 | 770 | return out |
|
770 | 771 | |
|
771 | 772 | @skip_doctest |
|
772 | 773 | def magic_who(self, parameter_s=''): |
|
773 | 774 | """Print all interactive variables, with some minimal formatting. |
|
774 | 775 | |
|
775 | 776 | If any arguments are given, only variables whose type matches one of |
|
776 | 777 | these are printed. For example:: |
|
777 | 778 | |
|
778 | 779 | %who function str |
|
779 | 780 | |
|
780 | 781 | will only list functions and strings, excluding all other types of |
|
781 | 782 | variables. To find the proper type names, simply use type(var) at a |
|
782 | 783 | command line to see how python prints type names. For example: |
|
783 | 784 | |
|
784 | 785 | :: |
|
785 | 786 | |
|
786 | 787 | In [1]: type('hello')\\ |
|
787 | 788 | Out[1]: <type 'str'> |
|
788 | 789 | |
|
789 | 790 | indicates that the type name for strings is 'str'. |
|
790 | 791 | |
|
791 | 792 | ``%who`` always excludes executed names loaded through your configuration |
|
792 | 793 | file and things which are internal to IPython. |
|
793 | 794 | |
|
794 | 795 | This is deliberate, as typically you may load many modules and the |
|
795 | 796 | purpose of %who is to show you only what you've manually defined. |
|
796 | 797 | |
|
797 | 798 | Examples |
|
798 | 799 | -------- |
|
799 | 800 | |
|
800 | 801 | Define two variables and list them with who:: |
|
801 | 802 | |
|
802 | 803 | In [1]: alpha = 123 |
|
803 | 804 | |
|
804 | 805 | In [2]: beta = 'test' |
|
805 | 806 | |
|
806 | 807 | In [3]: %who |
|
807 | 808 | alpha beta |
|
808 | 809 | |
|
809 | 810 | In [4]: %who int |
|
810 | 811 | alpha |
|
811 | 812 | |
|
812 | 813 | In [5]: %who str |
|
813 | 814 | beta |
|
814 | 815 | """ |
|
815 | 816 | |
|
816 | 817 | varlist = self.magic_who_ls(parameter_s) |
|
817 | 818 | if not varlist: |
|
818 | 819 | if parameter_s: |
|
819 | 820 | print 'No variables match your requested type.' |
|
820 | 821 | else: |
|
821 | 822 | print 'Interactive namespace is empty.' |
|
822 | 823 | return |
|
823 | 824 | |
|
824 | 825 | # if we have variables, move on... |
|
825 | 826 | count = 0 |
|
826 | 827 | for i in varlist: |
|
827 | 828 | print i+'\t', |
|
828 | 829 | count += 1 |
|
829 | 830 | if count > 8: |
|
830 | 831 | count = 0 |
|
831 | 832 | |
|
832 | 833 | |
|
833 | 834 | |
|
834 | 835 | @skip_doctest |
|
835 | 836 | def magic_whos(self, parameter_s=''): |
|
836 | 837 | """Like %who, but gives some extra information about each variable. |
|
837 | 838 | |
|
838 | 839 | The same type filtering of %who can be applied here. |
|
839 | 840 | |
|
840 | 841 | For all variables, the type is printed. Additionally it prints: |
|
841 | 842 | |
|
842 | 843 | - For {},[],(): their length. |
|
843 | 844 | |
|
844 | 845 | - For numpy arrays, a summary with shape, number of |
|
845 | 846 | elements, typecode and size in memory. |
|
846 | 847 | |
|
847 | 848 | - Everything else: a string representation, snipping their middle if |
|
848 | 849 | too long. |
|
849 | 850 | |
|
850 | 851 | Examples |
|
851 | 852 | -------- |
|
852 | 853 | |
|
853 | 854 | Define two variables and list them with whos:: |
|
854 | 855 | |
|
855 | 856 | In [1]: alpha = 123 |
|
856 | 857 | |
|
857 | 858 | In [2]: beta = 'test' |
|
858 | 859 | |
|
859 | 860 | In [3]: %whos |
|
860 | 861 | Variable Type Data/Info |
|
861 | 862 | -------------------------------- |
|
862 | 863 | alpha int 123 |
|
863 | 864 | beta str test |
|
864 | 865 | """ |
|
865 | 866 | |
|
866 | 867 | varnames = self.magic_who_ls(parameter_s) |
|
867 | 868 | if not varnames: |
|
868 | 869 | if parameter_s: |
|
869 | 870 | print 'No variables match your requested type.' |
|
870 | 871 | else: |
|
871 | 872 | print 'Interactive namespace is empty.' |
|
872 | 873 | return |
|
873 | 874 | |
|
874 | 875 | # if we have variables, move on... |
|
875 | 876 | |
|
876 | 877 | # for these types, show len() instead of data: |
|
877 | 878 | seq_types = ['dict', 'list', 'tuple'] |
|
878 | 879 | |
|
879 | 880 | # for numpy arrays, display summary info |
|
880 | 881 | ndarray_type = None |
|
881 | 882 | if 'numpy' in sys.modules: |
|
882 | 883 | try: |
|
883 | 884 | from numpy import ndarray |
|
884 | 885 | except ImportError: |
|
885 | 886 | pass |
|
886 | 887 | else: |
|
887 | 888 | ndarray_type = ndarray.__name__ |
|
888 | 889 | |
|
889 | 890 | # Find all variable names and types so we can figure out column sizes |
|
890 | 891 | def get_vars(i): |
|
891 | 892 | return self.shell.user_ns[i] |
|
892 | 893 | |
|
893 | 894 | # some types are well known and can be shorter |
|
894 | 895 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} |
|
895 | 896 | def type_name(v): |
|
896 | 897 | tn = type(v).__name__ |
|
897 | 898 | return abbrevs.get(tn,tn) |
|
898 | 899 | |
|
899 | 900 | varlist = map(get_vars,varnames) |
|
900 | 901 | |
|
901 | 902 | typelist = [] |
|
902 | 903 | for vv in varlist: |
|
903 | 904 | tt = type_name(vv) |
|
904 | 905 | |
|
905 | 906 | if tt=='instance': |
|
906 | 907 | typelist.append( abbrevs.get(str(vv.__class__), |
|
907 | 908 | str(vv.__class__))) |
|
908 | 909 | else: |
|
909 | 910 | typelist.append(tt) |
|
910 | 911 | |
|
911 | 912 | # column labels and # of spaces as separator |
|
912 | 913 | varlabel = 'Variable' |
|
913 | 914 | typelabel = 'Type' |
|
914 | 915 | datalabel = 'Data/Info' |
|
915 | 916 | colsep = 3 |
|
916 | 917 | # variable format strings |
|
917 | 918 | vformat = "{0:<{varwidth}}{1:<{typewidth}}" |
|
918 | 919 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
919 | 920 | # find the size of the columns to format the output nicely |
|
920 | 921 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
921 | 922 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
922 | 923 | # table header |
|
923 | 924 | print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
924 | 925 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1) |
|
925 | 926 | # and the table itself |
|
926 | 927 | kb = 1024 |
|
927 | 928 | Mb = 1048576 # kb**2 |
|
928 | 929 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
929 | 930 | print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth), |
|
930 | 931 | if vtype in seq_types: |
|
931 | 932 | print "n="+str(len(var)) |
|
932 | 933 | elif vtype == ndarray_type: |
|
933 | 934 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
934 | 935 | if vtype==ndarray_type: |
|
935 | 936 | # numpy |
|
936 | 937 | vsize = var.size |
|
937 | 938 | vbytes = vsize*var.itemsize |
|
938 | 939 | vdtype = var.dtype |
|
939 | 940 | |
|
940 | 941 | if vbytes < 100000: |
|
941 | 942 | print aformat % (vshape,vsize,vdtype,vbytes) |
|
942 | 943 | else: |
|
943 | 944 | print aformat % (vshape,vsize,vdtype,vbytes), |
|
944 | 945 | if vbytes < Mb: |
|
945 | 946 | print '(%s kb)' % (vbytes/kb,) |
|
946 | 947 | else: |
|
947 | 948 | print '(%s Mb)' % (vbytes/Mb,) |
|
948 | 949 | else: |
|
949 | 950 | try: |
|
950 | 951 | vstr = str(var) |
|
951 | 952 | except UnicodeEncodeError: |
|
952 |
vstr = unicode(var).encode( |
|
|
953 | vstr = unicode(var).encode(getdefaultencoding(), | |
|
953 | 954 | 'backslashreplace') |
|
954 | 955 | vstr = vstr.replace('\n','\\n') |
|
955 | 956 | if len(vstr) < 50: |
|
956 | 957 | print vstr |
|
957 | 958 | else: |
|
958 | 959 | print vstr[:25] + "<...>" + vstr[-25:] |
|
959 | 960 | |
|
960 | 961 | def magic_reset(self, parameter_s=''): |
|
961 | 962 | """Resets the namespace by removing all names defined by the user, if |
|
962 | 963 | called without arguments, or by removing some types of objects, such |
|
963 | 964 | as everything currently in IPython's In[] and Out[] containers (see |
|
964 | 965 | the parameters for details). |
|
965 | 966 | |
|
966 | 967 | Parameters |
|
967 | 968 | ---------- |
|
968 | 969 | -f : force reset without asking for confirmation. |
|
969 | 970 | |
|
970 | 971 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. |
|
971 | 972 | References to objects may be kept. By default (without this option), |
|
972 | 973 | we do a 'hard' reset, giving you a new session and removing all |
|
973 | 974 | references to objects from the current session. |
|
974 | 975 | |
|
975 | 976 | in : reset input history |
|
976 | 977 | |
|
977 | 978 | out : reset output history |
|
978 | 979 | |
|
979 | 980 | dhist : reset directory history |
|
980 | 981 | |
|
981 | 982 | array : reset only variables that are NumPy arrays |
|
982 | 983 | |
|
983 | 984 | See Also |
|
984 | 985 | -------- |
|
985 | 986 | magic_reset_selective : invoked as ``%reset_selective`` |
|
986 | 987 | |
|
987 | 988 | Examples |
|
988 | 989 | -------- |
|
989 | 990 | :: |
|
990 | 991 | |
|
991 | 992 | In [6]: a = 1 |
|
992 | 993 | |
|
993 | 994 | In [7]: a |
|
994 | 995 | Out[7]: 1 |
|
995 | 996 | |
|
996 | 997 | In [8]: 'a' in _ip.user_ns |
|
997 | 998 | Out[8]: True |
|
998 | 999 | |
|
999 | 1000 | In [9]: %reset -f |
|
1000 | 1001 | |
|
1001 | 1002 | In [1]: 'a' in _ip.user_ns |
|
1002 | 1003 | Out[1]: False |
|
1003 | 1004 | |
|
1004 | 1005 | In [2]: %reset -f in |
|
1005 | 1006 | Flushing input history |
|
1006 | 1007 | |
|
1007 | 1008 | In [3]: %reset -f dhist in |
|
1008 | 1009 | Flushing directory history |
|
1009 | 1010 | Flushing input history |
|
1010 | 1011 | |
|
1011 | 1012 | Notes |
|
1012 | 1013 | ----- |
|
1013 | 1014 | Calling this magic from clients that do not implement standard input, |
|
1014 | 1015 | such as the ipython notebook interface, will reset the namespace |
|
1015 | 1016 | without confirmation. |
|
1016 | 1017 | """ |
|
1017 | 1018 | opts, args = self.parse_options(parameter_s,'sf', mode='list') |
|
1018 | 1019 | if 'f' in opts: |
|
1019 | 1020 | ans = True |
|
1020 | 1021 | else: |
|
1021 | 1022 | try: |
|
1022 | 1023 | ans = self.shell.ask_yes_no( |
|
1023 | 1024 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n') |
|
1024 | 1025 | except StdinNotImplementedError: |
|
1025 | 1026 | ans = True |
|
1026 | 1027 | if not ans: |
|
1027 | 1028 | print 'Nothing done.' |
|
1028 | 1029 | return |
|
1029 | 1030 | |
|
1030 | 1031 | if 's' in opts: # Soft reset |
|
1031 | 1032 | user_ns = self.shell.user_ns |
|
1032 | 1033 | for i in self.magic_who_ls(): |
|
1033 | 1034 | del(user_ns[i]) |
|
1034 | 1035 | elif len(args) == 0: # Hard reset |
|
1035 | 1036 | self.shell.reset(new_session = False) |
|
1036 | 1037 | |
|
1037 | 1038 | # reset in/out/dhist/array: previously extensinions/clearcmd.py |
|
1038 | 1039 | ip = self.shell |
|
1039 | 1040 | user_ns = self.user_ns # local lookup, heavily used |
|
1040 | 1041 | |
|
1041 | 1042 | for target in args: |
|
1042 | 1043 | target = target.lower() # make matches case insensitive |
|
1043 | 1044 | if target == 'out': |
|
1044 | 1045 | print "Flushing output cache (%d entries)" % len(user_ns['_oh']) |
|
1045 | 1046 | self.displayhook.flush() |
|
1046 | 1047 | |
|
1047 | 1048 | elif target == 'in': |
|
1048 | 1049 | print "Flushing input history" |
|
1049 | 1050 | pc = self.displayhook.prompt_count + 1 |
|
1050 | 1051 | for n in range(1, pc): |
|
1051 | 1052 | key = '_i'+repr(n) |
|
1052 | 1053 | user_ns.pop(key,None) |
|
1053 | 1054 | user_ns.update(dict(_i=u'',_ii=u'',_iii=u'')) |
|
1054 | 1055 | hm = ip.history_manager |
|
1055 | 1056 | # don't delete these, as %save and %macro depending on the length |
|
1056 | 1057 | # of these lists to be preserved |
|
1057 | 1058 | hm.input_hist_parsed[:] = [''] * pc |
|
1058 | 1059 | hm.input_hist_raw[:] = [''] * pc |
|
1059 | 1060 | # hm has internal machinery for _i,_ii,_iii, clear it out |
|
1060 | 1061 | hm._i = hm._ii = hm._iii = hm._i00 = u'' |
|
1061 | 1062 | |
|
1062 | 1063 | elif target == 'array': |
|
1063 | 1064 | # Support cleaning up numpy arrays |
|
1064 | 1065 | try: |
|
1065 | 1066 | from numpy import ndarray |
|
1066 | 1067 | # This must be done with items and not iteritems because we're |
|
1067 | 1068 | # going to modify the dict in-place. |
|
1068 | 1069 | for x,val in user_ns.items(): |
|
1069 | 1070 | if isinstance(val,ndarray): |
|
1070 | 1071 | del user_ns[x] |
|
1071 | 1072 | except ImportError: |
|
1072 | 1073 | print "reset array only works if Numpy is available." |
|
1073 | 1074 | |
|
1074 | 1075 | elif target == 'dhist': |
|
1075 | 1076 | print "Flushing directory history" |
|
1076 | 1077 | del user_ns['_dh'][:] |
|
1077 | 1078 | |
|
1078 | 1079 | else: |
|
1079 | 1080 | print "Don't know how to reset ", |
|
1080 | 1081 | print target + ", please run `%reset?` for details" |
|
1081 | 1082 | |
|
1082 | 1083 | gc.collect() |
|
1083 | 1084 | |
|
1084 | 1085 | def magic_reset_selective(self, parameter_s=''): |
|
1085 | 1086 | """Resets the namespace by removing names defined by the user. |
|
1086 | 1087 | |
|
1087 | 1088 | Input/Output history are left around in case you need them. |
|
1088 | 1089 | |
|
1089 | 1090 | %reset_selective [-f] regex |
|
1090 | 1091 | |
|
1091 | 1092 | No action is taken if regex is not included |
|
1092 | 1093 | |
|
1093 | 1094 | Options |
|
1094 | 1095 | -f : force reset without asking for confirmation. |
|
1095 | 1096 | |
|
1096 | 1097 | See Also |
|
1097 | 1098 | -------- |
|
1098 | 1099 | magic_reset : invoked as ``%reset`` |
|
1099 | 1100 | |
|
1100 | 1101 | Examples |
|
1101 | 1102 | -------- |
|
1102 | 1103 | |
|
1103 | 1104 | We first fully reset the namespace so your output looks identical to |
|
1104 | 1105 | this example for pedagogical reasons; in practice you do not need a |
|
1105 | 1106 | full reset:: |
|
1106 | 1107 | |
|
1107 | 1108 | In [1]: %reset -f |
|
1108 | 1109 | |
|
1109 | 1110 | Now, with a clean namespace we can make a few variables and use |
|
1110 | 1111 | ``%reset_selective`` to only delete names that match our regexp:: |
|
1111 | 1112 | |
|
1112 | 1113 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 |
|
1113 | 1114 | |
|
1114 | 1115 | In [3]: who_ls |
|
1115 | 1116 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] |
|
1116 | 1117 | |
|
1117 | 1118 | In [4]: %reset_selective -f b[2-3]m |
|
1118 | 1119 | |
|
1119 | 1120 | In [5]: who_ls |
|
1120 | 1121 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1121 | 1122 | |
|
1122 | 1123 | In [6]: %reset_selective -f d |
|
1123 | 1124 | |
|
1124 | 1125 | In [7]: who_ls |
|
1125 | 1126 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
1126 | 1127 | |
|
1127 | 1128 | In [8]: %reset_selective -f c |
|
1128 | 1129 | |
|
1129 | 1130 | In [9]: who_ls |
|
1130 | 1131 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] |
|
1131 | 1132 | |
|
1132 | 1133 | In [10]: %reset_selective -f b |
|
1133 | 1134 | |
|
1134 | 1135 | In [11]: who_ls |
|
1135 | 1136 | Out[11]: ['a'] |
|
1136 | 1137 | |
|
1137 | 1138 | Notes |
|
1138 | 1139 | ----- |
|
1139 | 1140 | Calling this magic from clients that do not implement standard input, |
|
1140 | 1141 | such as the ipython notebook interface, will reset the namespace |
|
1141 | 1142 | without confirmation. |
|
1142 | 1143 | """ |
|
1143 | 1144 | |
|
1144 | 1145 | opts, regex = self.parse_options(parameter_s,'f') |
|
1145 | 1146 | |
|
1146 | 1147 | if opts.has_key('f'): |
|
1147 | 1148 | ans = True |
|
1148 | 1149 | else: |
|
1149 | 1150 | try: |
|
1150 | 1151 | ans = self.shell.ask_yes_no( |
|
1151 | 1152 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", |
|
1152 | 1153 | default='n') |
|
1153 | 1154 | except StdinNotImplementedError: |
|
1154 | 1155 | ans = True |
|
1155 | 1156 | if not ans: |
|
1156 | 1157 | print 'Nothing done.' |
|
1157 | 1158 | return |
|
1158 | 1159 | user_ns = self.shell.user_ns |
|
1159 | 1160 | if not regex: |
|
1160 | 1161 | print 'No regex pattern specified. Nothing done.' |
|
1161 | 1162 | return |
|
1162 | 1163 | else: |
|
1163 | 1164 | try: |
|
1164 | 1165 | m = re.compile(regex) |
|
1165 | 1166 | except TypeError: |
|
1166 | 1167 | raise TypeError('regex must be a string or compiled pattern') |
|
1167 | 1168 | for i in self.magic_who_ls(): |
|
1168 | 1169 | if m.search(i): |
|
1169 | 1170 | del(user_ns[i]) |
|
1170 | 1171 | |
|
1171 | 1172 | def magic_xdel(self, parameter_s=''): |
|
1172 | 1173 | """Delete a variable, trying to clear it from anywhere that |
|
1173 | 1174 | IPython's machinery has references to it. By default, this uses |
|
1174 | 1175 | the identity of the named object in the user namespace to remove |
|
1175 | 1176 | references held under other names. The object is also removed |
|
1176 | 1177 | from the output history. |
|
1177 | 1178 | |
|
1178 | 1179 | Options |
|
1179 | 1180 | -n : Delete the specified name from all namespaces, without |
|
1180 | 1181 | checking their identity. |
|
1181 | 1182 | """ |
|
1182 | 1183 | opts, varname = self.parse_options(parameter_s,'n') |
|
1183 | 1184 | try: |
|
1184 | 1185 | self.shell.del_var(varname, ('n' in opts)) |
|
1185 | 1186 | except (NameError, ValueError) as e: |
|
1186 | 1187 | print type(e).__name__ +": "+ str(e) |
|
1187 | 1188 | |
|
1188 | 1189 | def magic_logstart(self,parameter_s=''): |
|
1189 | 1190 | """Start logging anywhere in a session. |
|
1190 | 1191 | |
|
1191 | 1192 | %logstart [-o|-r|-t] [log_name [log_mode]] |
|
1192 | 1193 | |
|
1193 | 1194 | If no name is given, it defaults to a file named 'ipython_log.py' in your |
|
1194 | 1195 | current directory, in 'rotate' mode (see below). |
|
1195 | 1196 | |
|
1196 | 1197 | '%logstart name' saves to file 'name' in 'backup' mode. It saves your |
|
1197 | 1198 | history up to that point and then continues logging. |
|
1198 | 1199 | |
|
1199 | 1200 | %logstart takes a second optional parameter: logging mode. This can be one |
|
1200 | 1201 | of (note that the modes are given unquoted):\\ |
|
1201 | 1202 | append: well, that says it.\\ |
|
1202 | 1203 | backup: rename (if exists) to name~ and start name.\\ |
|
1203 | 1204 | global: single logfile in your home dir, appended to.\\ |
|
1204 | 1205 | over : overwrite existing log.\\ |
|
1205 | 1206 | rotate: create rotating logs name.1~, name.2~, etc. |
|
1206 | 1207 | |
|
1207 | 1208 | Options: |
|
1208 | 1209 | |
|
1209 | 1210 | -o: log also IPython's output. In this mode, all commands which |
|
1210 | 1211 | generate an Out[NN] prompt are recorded to the logfile, right after |
|
1211 | 1212 | their corresponding input line. The output lines are always |
|
1212 | 1213 | prepended with a '#[Out]# ' marker, so that the log remains valid |
|
1213 | 1214 | Python code. |
|
1214 | 1215 | |
|
1215 | 1216 | Since this marker is always the same, filtering only the output from |
|
1216 | 1217 | a log is very easy, using for example a simple awk call:: |
|
1217 | 1218 | |
|
1218 | 1219 | awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py |
|
1219 | 1220 | |
|
1220 | 1221 | -r: log 'raw' input. Normally, IPython's logs contain the processed |
|
1221 | 1222 | input, so that user lines are logged in their final form, converted |
|
1222 | 1223 | into valid Python. For example, %Exit is logged as |
|
1223 | 1224 | _ip.magic("Exit"). If the -r flag is given, all input is logged |
|
1224 | 1225 | exactly as typed, with no transformations applied. |
|
1225 | 1226 | |
|
1226 | 1227 | -t: put timestamps before each input line logged (these are put in |
|
1227 | 1228 | comments).""" |
|
1228 | 1229 | |
|
1229 | 1230 | opts,par = self.parse_options(parameter_s,'ort') |
|
1230 | 1231 | log_output = 'o' in opts |
|
1231 | 1232 | log_raw_input = 'r' in opts |
|
1232 | 1233 | timestamp = 't' in opts |
|
1233 | 1234 | |
|
1234 | 1235 | logger = self.shell.logger |
|
1235 | 1236 | |
|
1236 | 1237 | # if no args are given, the defaults set in the logger constructor by |
|
1237 | 1238 | # ipython remain valid |
|
1238 | 1239 | if par: |
|
1239 | 1240 | try: |
|
1240 | 1241 | logfname,logmode = par.split() |
|
1241 | 1242 | except: |
|
1242 | 1243 | logfname = par |
|
1243 | 1244 | logmode = 'backup' |
|
1244 | 1245 | else: |
|
1245 | 1246 | logfname = logger.logfname |
|
1246 | 1247 | logmode = logger.logmode |
|
1247 | 1248 | # put logfname into rc struct as if it had been called on the command |
|
1248 | 1249 | # line, so it ends up saved in the log header Save it in case we need |
|
1249 | 1250 | # to restore it... |
|
1250 | 1251 | old_logfile = self.shell.logfile |
|
1251 | 1252 | if logfname: |
|
1252 | 1253 | logfname = os.path.expanduser(logfname) |
|
1253 | 1254 | self.shell.logfile = logfname |
|
1254 | 1255 | |
|
1255 | 1256 | loghead = '# IPython log file\n\n' |
|
1256 | 1257 | try: |
|
1257 | 1258 | started = logger.logstart(logfname,loghead,logmode, |
|
1258 | 1259 | log_output,timestamp,log_raw_input) |
|
1259 | 1260 | except: |
|
1260 | 1261 | self.shell.logfile = old_logfile |
|
1261 | 1262 | warn("Couldn't start log: %s" % sys.exc_info()[1]) |
|
1262 | 1263 | else: |
|
1263 | 1264 | # log input history up to this point, optionally interleaving |
|
1264 | 1265 | # output if requested |
|
1265 | 1266 | |
|
1266 | 1267 | if timestamp: |
|
1267 | 1268 | # disable timestamping for the previous history, since we've |
|
1268 | 1269 | # lost those already (no time machine here). |
|
1269 | 1270 | logger.timestamp = False |
|
1270 | 1271 | |
|
1271 | 1272 | if log_raw_input: |
|
1272 | 1273 | input_hist = self.shell.history_manager.input_hist_raw |
|
1273 | 1274 | else: |
|
1274 | 1275 | input_hist = self.shell.history_manager.input_hist_parsed |
|
1275 | 1276 | |
|
1276 | 1277 | if log_output: |
|
1277 | 1278 | log_write = logger.log_write |
|
1278 | 1279 | output_hist = self.shell.history_manager.output_hist |
|
1279 | 1280 | for n in range(1,len(input_hist)-1): |
|
1280 | 1281 | log_write(input_hist[n].rstrip() + '\n') |
|
1281 | 1282 | if n in output_hist: |
|
1282 | 1283 | log_write(repr(output_hist[n]),'output') |
|
1283 | 1284 | else: |
|
1284 | 1285 | logger.log_write('\n'.join(input_hist[1:])) |
|
1285 | 1286 | logger.log_write('\n') |
|
1286 | 1287 | if timestamp: |
|
1287 | 1288 | # re-enable timestamping |
|
1288 | 1289 | logger.timestamp = True |
|
1289 | 1290 | |
|
1290 | 1291 | print ('Activating auto-logging. ' |
|
1291 | 1292 | 'Current session state plus future input saved.') |
|
1292 | 1293 | logger.logstate() |
|
1293 | 1294 | |
|
1294 | 1295 | def magic_logstop(self,parameter_s=''): |
|
1295 | 1296 | """Fully stop logging and close log file. |
|
1296 | 1297 | |
|
1297 | 1298 | In order to start logging again, a new %logstart call needs to be made, |
|
1298 | 1299 | possibly (though not necessarily) with a new filename, mode and other |
|
1299 | 1300 | options.""" |
|
1300 | 1301 | self.logger.logstop() |
|
1301 | 1302 | |
|
1302 | 1303 | def magic_logoff(self,parameter_s=''): |
|
1303 | 1304 | """Temporarily stop logging. |
|
1304 | 1305 | |
|
1305 | 1306 | You must have previously started logging.""" |
|
1306 | 1307 | self.shell.logger.switch_log(0) |
|
1307 | 1308 | |
|
1308 | 1309 | def magic_logon(self,parameter_s=''): |
|
1309 | 1310 | """Restart logging. |
|
1310 | 1311 | |
|
1311 | 1312 | This function is for restarting logging which you've temporarily |
|
1312 | 1313 | stopped with %logoff. For starting logging for the first time, you |
|
1313 | 1314 | must use the %logstart function, which allows you to specify an |
|
1314 | 1315 | optional log filename.""" |
|
1315 | 1316 | |
|
1316 | 1317 | self.shell.logger.switch_log(1) |
|
1317 | 1318 | |
|
1318 | 1319 | def magic_logstate(self,parameter_s=''): |
|
1319 | 1320 | """Print the status of the logging system.""" |
|
1320 | 1321 | |
|
1321 | 1322 | self.shell.logger.logstate() |
|
1322 | 1323 | |
|
1323 | 1324 | def magic_pdb(self, parameter_s=''): |
|
1324 | 1325 | """Control the automatic calling of the pdb interactive debugger. |
|
1325 | 1326 | |
|
1326 | 1327 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
1327 | 1328 | argument it works as a toggle. |
|
1328 | 1329 | |
|
1329 | 1330 | When an exception is triggered, IPython can optionally call the |
|
1330 | 1331 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
1331 | 1332 | this feature on and off. |
|
1332 | 1333 | |
|
1333 | 1334 | The initial state of this feature is set in your configuration |
|
1334 | 1335 | file (the option is ``InteractiveShell.pdb``). |
|
1335 | 1336 | |
|
1336 | 1337 | If you want to just activate the debugger AFTER an exception has fired, |
|
1337 | 1338 | without having to type '%pdb on' and rerunning your code, you can use |
|
1338 | 1339 | the %debug magic.""" |
|
1339 | 1340 | |
|
1340 | 1341 | par = parameter_s.strip().lower() |
|
1341 | 1342 | |
|
1342 | 1343 | if par: |
|
1343 | 1344 | try: |
|
1344 | 1345 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
1345 | 1346 | except KeyError: |
|
1346 | 1347 | print ('Incorrect argument. Use on/1, off/0, ' |
|
1347 | 1348 | 'or nothing for a toggle.') |
|
1348 | 1349 | return |
|
1349 | 1350 | else: |
|
1350 | 1351 | # toggle |
|
1351 | 1352 | new_pdb = not self.shell.call_pdb |
|
1352 | 1353 | |
|
1353 | 1354 | # set on the shell |
|
1354 | 1355 | self.shell.call_pdb = new_pdb |
|
1355 | 1356 | print 'Automatic pdb calling has been turned',on_off(new_pdb) |
|
1356 | 1357 | |
|
1357 | 1358 | def magic_debug(self, parameter_s=''): |
|
1358 | 1359 | """Activate the interactive debugger in post-mortem mode. |
|
1359 | 1360 | |
|
1360 | 1361 | If an exception has just occurred, this lets you inspect its stack |
|
1361 | 1362 | frames interactively. Note that this will always work only on the last |
|
1362 | 1363 | traceback that occurred, so you must call this quickly after an |
|
1363 | 1364 | exception that you wish to inspect has fired, because if another one |
|
1364 | 1365 | occurs, it clobbers the previous one. |
|
1365 | 1366 | |
|
1366 | 1367 | If you want IPython to automatically do this on every exception, see |
|
1367 | 1368 | the %pdb magic for more details. |
|
1368 | 1369 | """ |
|
1369 | 1370 | self.shell.debugger(force=True) |
|
1370 | 1371 | |
|
1371 | 1372 | @skip_doctest |
|
1372 | 1373 | def magic_prun(self, parameter_s ='',user_mode=1, |
|
1373 | 1374 | opts=None,arg_lst=None,prog_ns=None): |
|
1374 | 1375 | |
|
1375 | 1376 | """Run a statement through the python code profiler. |
|
1376 | 1377 | |
|
1377 | 1378 | Usage: |
|
1378 | 1379 | %prun [options] statement |
|
1379 | 1380 | |
|
1380 | 1381 | The given statement (which doesn't require quote marks) is run via the |
|
1381 | 1382 | python profiler in a manner similar to the profile.run() function. |
|
1382 | 1383 | Namespaces are internally managed to work correctly; profile.run |
|
1383 | 1384 | cannot be used in IPython because it makes certain assumptions about |
|
1384 | 1385 | namespaces which do not hold under IPython. |
|
1385 | 1386 | |
|
1386 | 1387 | Options: |
|
1387 | 1388 | |
|
1388 | 1389 | -l <limit>: you can place restrictions on what or how much of the |
|
1389 | 1390 | profile gets printed. The limit value can be: |
|
1390 | 1391 | |
|
1391 | 1392 | * A string: only information for function names containing this string |
|
1392 | 1393 | is printed. |
|
1393 | 1394 | |
|
1394 | 1395 | * An integer: only these many lines are printed. |
|
1395 | 1396 | |
|
1396 | 1397 | * A float (between 0 and 1): this fraction of the report is printed |
|
1397 | 1398 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
1398 | 1399 | |
|
1399 | 1400 | You can combine several limits with repeated use of the option. For |
|
1400 | 1401 | example, '-l __init__ -l 5' will print only the topmost 5 lines of |
|
1401 | 1402 | information about class constructors. |
|
1402 | 1403 | |
|
1403 | 1404 | -r: return the pstats.Stats object generated by the profiling. This |
|
1404 | 1405 | object has all the information about the profile in it, and you can |
|
1405 | 1406 | later use it for further analysis or in other functions. |
|
1406 | 1407 | |
|
1407 | 1408 | -s <key>: sort profile by given key. You can provide more than one key |
|
1408 | 1409 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
1409 | 1410 | default sorting key is 'time'. |
|
1410 | 1411 | |
|
1411 | 1412 | The following is copied verbatim from the profile documentation |
|
1412 | 1413 | referenced below: |
|
1413 | 1414 | |
|
1414 | 1415 | When more than one key is provided, additional keys are used as |
|
1415 | 1416 | secondary criteria when the there is equality in all keys selected |
|
1416 | 1417 | before them. |
|
1417 | 1418 | |
|
1418 | 1419 | Abbreviations can be used for any key names, as long as the |
|
1419 | 1420 | abbreviation is unambiguous. The following are the keys currently |
|
1420 | 1421 | defined: |
|
1421 | 1422 | |
|
1422 | 1423 | Valid Arg Meaning |
|
1423 | 1424 | "calls" call count |
|
1424 | 1425 | "cumulative" cumulative time |
|
1425 | 1426 | "file" file name |
|
1426 | 1427 | "module" file name |
|
1427 | 1428 | "pcalls" primitive call count |
|
1428 | 1429 | "line" line number |
|
1429 | 1430 | "name" function name |
|
1430 | 1431 | "nfl" name/file/line |
|
1431 | 1432 | "stdname" standard name |
|
1432 | 1433 | "time" internal time |
|
1433 | 1434 | |
|
1434 | 1435 | Note that all sorts on statistics are in descending order (placing |
|
1435 | 1436 | most time consuming items first), where as name, file, and line number |
|
1436 | 1437 | searches are in ascending order (i.e., alphabetical). The subtle |
|
1437 | 1438 | distinction between "nfl" and "stdname" is that the standard name is a |
|
1438 | 1439 | sort of the name as printed, which means that the embedded line |
|
1439 | 1440 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
1440 | 1441 | would (if the file names were the same) appear in the string order |
|
1441 | 1442 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
1442 | 1443 | line numbers. In fact, sort_stats("nfl") is the same as |
|
1443 | 1444 | sort_stats("name", "file", "line"). |
|
1444 | 1445 | |
|
1445 | 1446 | -T <filename>: save profile results as shown on screen to a text |
|
1446 | 1447 | file. The profile is still shown on screen. |
|
1447 | 1448 | |
|
1448 | 1449 | -D <filename>: save (via dump_stats) profile statistics to given |
|
1449 | 1450 | filename. This data is in a format understood by the pstats module, and |
|
1450 | 1451 | is generated by a call to the dump_stats() method of profile |
|
1451 | 1452 | objects. The profile is still shown on screen. |
|
1452 | 1453 | |
|
1453 | 1454 | -q: suppress output to the pager. Best used with -T and/or -D above. |
|
1454 | 1455 | |
|
1455 | 1456 | If you want to run complete programs under the profiler's control, use |
|
1456 | 1457 | '%run -p [prof_opts] filename.py [args to program]' where prof_opts |
|
1457 | 1458 | contains profiler specific options as described here. |
|
1458 | 1459 | |
|
1459 | 1460 | You can read the complete documentation for the profile module with:: |
|
1460 | 1461 | |
|
1461 | 1462 | In [1]: import profile; profile.help() |
|
1462 | 1463 | """ |
|
1463 | 1464 | |
|
1464 | 1465 | opts_def = Struct(D=[''],l=[],s=['time'],T=['']) |
|
1465 | 1466 | |
|
1466 | 1467 | if user_mode: # regular user call |
|
1467 | 1468 | opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q', |
|
1468 | 1469 | list_all=1, posix=False) |
|
1469 | 1470 | namespace = self.shell.user_ns |
|
1470 | 1471 | else: # called to run a program by %run -p |
|
1471 | 1472 | try: |
|
1472 | 1473 | filename = get_py_filename(arg_lst[0]) |
|
1473 | 1474 | except IOError as e: |
|
1474 | 1475 | try: |
|
1475 | 1476 | msg = str(e) |
|
1476 | 1477 | except UnicodeError: |
|
1477 | 1478 | msg = e.message |
|
1478 | 1479 | error(msg) |
|
1479 | 1480 | return |
|
1480 | 1481 | |
|
1481 | 1482 | arg_str = 'execfile(filename,prog_ns)' |
|
1482 | 1483 | namespace = { |
|
1483 | 1484 | 'execfile': self.shell.safe_execfile, |
|
1484 | 1485 | 'prog_ns': prog_ns, |
|
1485 | 1486 | 'filename': filename |
|
1486 | 1487 | } |
|
1487 | 1488 | |
|
1488 | 1489 | opts.merge(opts_def) |
|
1489 | 1490 | |
|
1490 | 1491 | prof = profile.Profile() |
|
1491 | 1492 | try: |
|
1492 | 1493 | prof = prof.runctx(arg_str,namespace,namespace) |
|
1493 | 1494 | sys_exit = '' |
|
1494 | 1495 | except SystemExit: |
|
1495 | 1496 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
1496 | 1497 | |
|
1497 | 1498 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
1498 | 1499 | |
|
1499 | 1500 | lims = opts.l |
|
1500 | 1501 | if lims: |
|
1501 | 1502 | lims = [] # rebuild lims with ints/floats/strings |
|
1502 | 1503 | for lim in opts.l: |
|
1503 | 1504 | try: |
|
1504 | 1505 | lims.append(int(lim)) |
|
1505 | 1506 | except ValueError: |
|
1506 | 1507 | try: |
|
1507 | 1508 | lims.append(float(lim)) |
|
1508 | 1509 | except ValueError: |
|
1509 | 1510 | lims.append(lim) |
|
1510 | 1511 | |
|
1511 | 1512 | # Trap output. |
|
1512 | 1513 | stdout_trap = StringIO() |
|
1513 | 1514 | |
|
1514 | 1515 | if hasattr(stats,'stream'): |
|
1515 | 1516 | # In newer versions of python, the stats object has a 'stream' |
|
1516 | 1517 | # attribute to write into. |
|
1517 | 1518 | stats.stream = stdout_trap |
|
1518 | 1519 | stats.print_stats(*lims) |
|
1519 | 1520 | else: |
|
1520 | 1521 | # For older versions, we manually redirect stdout during printing |
|
1521 | 1522 | sys_stdout = sys.stdout |
|
1522 | 1523 | try: |
|
1523 | 1524 | sys.stdout = stdout_trap |
|
1524 | 1525 | stats.print_stats(*lims) |
|
1525 | 1526 | finally: |
|
1526 | 1527 | sys.stdout = sys_stdout |
|
1527 | 1528 | |
|
1528 | 1529 | output = stdout_trap.getvalue() |
|
1529 | 1530 | output = output.rstrip() |
|
1530 | 1531 | |
|
1531 | 1532 | if 'q' not in opts: |
|
1532 | 1533 | page.page(output) |
|
1533 | 1534 | print sys_exit, |
|
1534 | 1535 | |
|
1535 | 1536 | dump_file = opts.D[0] |
|
1536 | 1537 | text_file = opts.T[0] |
|
1537 | 1538 | if dump_file: |
|
1538 | 1539 | dump_file = unquote_filename(dump_file) |
|
1539 | 1540 | prof.dump_stats(dump_file) |
|
1540 | 1541 | print '\n*** Profile stats marshalled to file',\ |
|
1541 | 1542 | `dump_file`+'.',sys_exit |
|
1542 | 1543 | if text_file: |
|
1543 | 1544 | text_file = unquote_filename(text_file) |
|
1544 | 1545 | pfile = open(text_file,'w') |
|
1545 | 1546 | pfile.write(output) |
|
1546 | 1547 | pfile.close() |
|
1547 | 1548 | print '\n*** Profile printout saved to text file',\ |
|
1548 | 1549 | `text_file`+'.',sys_exit |
|
1549 | 1550 | |
|
1550 | 1551 | if opts.has_key('r'): |
|
1551 | 1552 | return stats |
|
1552 | 1553 | else: |
|
1553 | 1554 | return None |
|
1554 | 1555 | |
|
1555 | 1556 | @skip_doctest |
|
1556 | 1557 | def magic_run(self, parameter_s ='', runner=None, |
|
1557 | 1558 | file_finder=get_py_filename): |
|
1558 | 1559 | """Run the named file inside IPython as a program. |
|
1559 | 1560 | |
|
1560 | 1561 | Usage:\\ |
|
1561 | 1562 | %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args] |
|
1562 | 1563 | |
|
1563 | 1564 | Parameters after the filename are passed as command-line arguments to |
|
1564 | 1565 | the program (put in sys.argv). Then, control returns to IPython's |
|
1565 | 1566 | prompt. |
|
1566 | 1567 | |
|
1567 | 1568 | This is similar to running at a system prompt:\\ |
|
1568 | 1569 | $ python file args\\ |
|
1569 | 1570 | but with the advantage of giving you IPython's tracebacks, and of |
|
1570 | 1571 | loading all variables into your interactive namespace for further use |
|
1571 | 1572 | (unless -p is used, see below). |
|
1572 | 1573 | |
|
1573 | 1574 | The file is executed in a namespace initially consisting only of |
|
1574 | 1575 | __name__=='__main__' and sys.argv constructed as indicated. It thus |
|
1575 | 1576 | sees its environment as if it were being run as a stand-alone program |
|
1576 | 1577 | (except for sharing global objects such as previously imported |
|
1577 | 1578 | modules). But after execution, the IPython interactive namespace gets |
|
1578 | 1579 | updated with all variables defined in the program (except for __name__ |
|
1579 | 1580 | and sys.argv). This allows for very convenient loading of code for |
|
1580 | 1581 | interactive work, while giving each program a 'clean sheet' to run in. |
|
1581 | 1582 | |
|
1582 | 1583 | Options: |
|
1583 | 1584 | |
|
1584 | 1585 | -n: __name__ is NOT set to '__main__', but to the running file's name |
|
1585 | 1586 | without extension (as python does under import). This allows running |
|
1586 | 1587 | scripts and reloading the definitions in them without calling code |
|
1587 | 1588 | protected by an ' if __name__ == "__main__" ' clause. |
|
1588 | 1589 | |
|
1589 | 1590 | -i: run the file in IPython's namespace instead of an empty one. This |
|
1590 | 1591 | is useful if you are experimenting with code written in a text editor |
|
1591 | 1592 | which depends on variables defined interactively. |
|
1592 | 1593 | |
|
1593 | 1594 | -e: ignore sys.exit() calls or SystemExit exceptions in the script |
|
1594 | 1595 | being run. This is particularly useful if IPython is being used to |
|
1595 | 1596 | run unittests, which always exit with a sys.exit() call. In such |
|
1596 | 1597 | cases you are interested in the output of the test results, not in |
|
1597 | 1598 | seeing a traceback of the unittest module. |
|
1598 | 1599 | |
|
1599 | 1600 | -t: print timing information at the end of the run. IPython will give |
|
1600 | 1601 | you an estimated CPU time consumption for your script, which under |
|
1601 | 1602 | Unix uses the resource module to avoid the wraparound problems of |
|
1602 | 1603 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
1603 | 1604 | is also given (for Windows platforms this is reported as 0.0). |
|
1604 | 1605 | |
|
1605 | 1606 | If -t is given, an additional -N<N> option can be given, where <N> |
|
1606 | 1607 | must be an integer indicating how many times you want the script to |
|
1607 | 1608 | run. The final timing report will include total and per run results. |
|
1608 | 1609 | |
|
1609 | 1610 | For example (testing the script uniq_stable.py):: |
|
1610 | 1611 | |
|
1611 | 1612 | In [1]: run -t uniq_stable |
|
1612 | 1613 | |
|
1613 | 1614 | IPython CPU timings (estimated):\\ |
|
1614 | 1615 | User : 0.19597 s.\\ |
|
1615 | 1616 | System: 0.0 s.\\ |
|
1616 | 1617 | |
|
1617 | 1618 | In [2]: run -t -N5 uniq_stable |
|
1618 | 1619 | |
|
1619 | 1620 | IPython CPU timings (estimated):\\ |
|
1620 | 1621 | Total runs performed: 5\\ |
|
1621 | 1622 | Times : Total Per run\\ |
|
1622 | 1623 | User : 0.910862 s, 0.1821724 s.\\ |
|
1623 | 1624 | System: 0.0 s, 0.0 s. |
|
1624 | 1625 | |
|
1625 | 1626 | -d: run your program under the control of pdb, the Python debugger. |
|
1626 | 1627 | This allows you to execute your program step by step, watch variables, |
|
1627 | 1628 | etc. Internally, what IPython does is similar to calling: |
|
1628 | 1629 | |
|
1629 | 1630 | pdb.run('execfile("YOURFILENAME")') |
|
1630 | 1631 | |
|
1631 | 1632 | with a breakpoint set on line 1 of your file. You can change the line |
|
1632 | 1633 | number for this automatic breakpoint to be <N> by using the -bN option |
|
1633 | 1634 | (where N must be an integer). For example:: |
|
1634 | 1635 | |
|
1635 | 1636 | %run -d -b40 myscript |
|
1636 | 1637 | |
|
1637 | 1638 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
1638 | 1639 | the first breakpoint must be set on a line which actually does |
|
1639 | 1640 | something (not a comment or docstring) for it to stop execution. |
|
1640 | 1641 | |
|
1641 | 1642 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
1642 | 1643 | first enter 'c' (without quotes) to start execution up to the first |
|
1643 | 1644 | breakpoint. |
|
1644 | 1645 | |
|
1645 | 1646 | Entering 'help' gives information about the use of the debugger. You |
|
1646 | 1647 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
1647 | 1648 | at a prompt. |
|
1648 | 1649 | |
|
1649 | 1650 | -p: run program under the control of the Python profiler module (which |
|
1650 | 1651 | prints a detailed report of execution times, function calls, etc). |
|
1651 | 1652 | |
|
1652 | 1653 | You can pass other options after -p which affect the behavior of the |
|
1653 | 1654 | profiler itself. See the docs for %prun for details. |
|
1654 | 1655 | |
|
1655 | 1656 | In this mode, the program's variables do NOT propagate back to the |
|
1656 | 1657 | IPython interactive namespace (because they remain in the namespace |
|
1657 | 1658 | where the profiler executes them). |
|
1658 | 1659 | |
|
1659 | 1660 | Internally this triggers a call to %prun, see its documentation for |
|
1660 | 1661 | details on the options available specifically for profiling. |
|
1661 | 1662 | |
|
1662 | 1663 | There is one special usage for which the text above doesn't apply: |
|
1663 | 1664 | if the filename ends with .ipy, the file is run as ipython script, |
|
1664 | 1665 | just as if the commands were written on IPython prompt. |
|
1665 | 1666 | |
|
1666 | 1667 | -m: specify module name to load instead of script path. Similar to |
|
1667 | 1668 | the -m option for the python interpreter. Use this option last if you |
|
1668 | 1669 | want to combine with other %run options. Unlike the python interpreter |
|
1669 | 1670 | only source modules are allowed no .pyc or .pyo files. |
|
1670 | 1671 | For example:: |
|
1671 | 1672 | |
|
1672 | 1673 | %run -m example |
|
1673 | 1674 | |
|
1674 | 1675 | will run the example module. |
|
1675 | 1676 | |
|
1676 | 1677 | """ |
|
1677 | 1678 | |
|
1678 | 1679 | # get arguments and set sys.argv for program to be run. |
|
1679 | 1680 | opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:', |
|
1680 | 1681 | mode='list', list_all=1) |
|
1681 | 1682 | if "m" in opts: |
|
1682 | 1683 | modulename = opts["m"][0] |
|
1683 | 1684 | modpath = find_mod(modulename) |
|
1684 | 1685 | if modpath is None: |
|
1685 | 1686 | warn('%r is not a valid modulename on sys.path'%modulename) |
|
1686 | 1687 | return |
|
1687 | 1688 | arg_lst = [modpath] + arg_lst |
|
1688 | 1689 | try: |
|
1689 | 1690 | filename = file_finder(arg_lst[0]) |
|
1690 | 1691 | except IndexError: |
|
1691 | 1692 | warn('you must provide at least a filename.') |
|
1692 | 1693 | print '\n%run:\n', oinspect.getdoc(self.magic_run) |
|
1693 | 1694 | return |
|
1694 | 1695 | except IOError as e: |
|
1695 | 1696 | try: |
|
1696 | 1697 | msg = str(e) |
|
1697 | 1698 | except UnicodeError: |
|
1698 | 1699 | msg = e.message |
|
1699 | 1700 | error(msg) |
|
1700 | 1701 | return |
|
1701 | 1702 | |
|
1702 | 1703 | if filename.lower().endswith('.ipy'): |
|
1703 | 1704 | self.shell.safe_execfile_ipy(filename) |
|
1704 | 1705 | return |
|
1705 | 1706 | |
|
1706 | 1707 | # Control the response to exit() calls made by the script being run |
|
1707 | 1708 | exit_ignore = 'e' in opts |
|
1708 | 1709 | |
|
1709 | 1710 | # Make sure that the running script gets a proper sys.argv as if it |
|
1710 | 1711 | # were run from a system shell. |
|
1711 | 1712 | save_argv = sys.argv # save it for later restoring |
|
1712 | 1713 | |
|
1713 | 1714 | # simulate shell expansion on arguments, at least tilde expansion |
|
1714 | 1715 | args = [ os.path.expanduser(a) for a in arg_lst[1:] ] |
|
1715 | 1716 | |
|
1716 | 1717 | sys.argv = [filename] + args # put in the proper filename |
|
1717 | 1718 | # protect sys.argv from potential unicode strings on Python 2: |
|
1718 | 1719 | if not py3compat.PY3: |
|
1719 | 1720 | sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ] |
|
1720 | 1721 | |
|
1721 | 1722 | if 'i' in opts: |
|
1722 | 1723 | # Run in user's interactive namespace |
|
1723 | 1724 | prog_ns = self.shell.user_ns |
|
1724 | 1725 | __name__save = self.shell.user_ns['__name__'] |
|
1725 | 1726 | prog_ns['__name__'] = '__main__' |
|
1726 | 1727 | main_mod = self.shell.new_main_mod(prog_ns) |
|
1727 | 1728 | else: |
|
1728 | 1729 | # Run in a fresh, empty namespace |
|
1729 | 1730 | if 'n' in opts: |
|
1730 | 1731 | name = os.path.splitext(os.path.basename(filename))[0] |
|
1731 | 1732 | else: |
|
1732 | 1733 | name = '__main__' |
|
1733 | 1734 | |
|
1734 | 1735 | main_mod = self.shell.new_main_mod() |
|
1735 | 1736 | prog_ns = main_mod.__dict__ |
|
1736 | 1737 | prog_ns['__name__'] = name |
|
1737 | 1738 | |
|
1738 | 1739 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
1739 | 1740 | # set the __file__ global in the script's namespace |
|
1740 | 1741 | prog_ns['__file__'] = filename |
|
1741 | 1742 | |
|
1742 | 1743 | # pickle fix. See interactiveshell for an explanation. But we need to make sure |
|
1743 | 1744 | # that, if we overwrite __main__, we replace it at the end |
|
1744 | 1745 | main_mod_name = prog_ns['__name__'] |
|
1745 | 1746 | |
|
1746 | 1747 | if main_mod_name == '__main__': |
|
1747 | 1748 | restore_main = sys.modules['__main__'] |
|
1748 | 1749 | else: |
|
1749 | 1750 | restore_main = False |
|
1750 | 1751 | |
|
1751 | 1752 | # This needs to be undone at the end to prevent holding references to |
|
1752 | 1753 | # every single object ever created. |
|
1753 | 1754 | sys.modules[main_mod_name] = main_mod |
|
1754 | 1755 | |
|
1755 | 1756 | try: |
|
1756 | 1757 | stats = None |
|
1757 | 1758 | with self.readline_no_record: |
|
1758 | 1759 | if 'p' in opts: |
|
1759 | 1760 | stats = self.magic_prun('', 0, opts, arg_lst, prog_ns) |
|
1760 | 1761 | else: |
|
1761 | 1762 | if 'd' in opts: |
|
1762 | 1763 | deb = debugger.Pdb(self.shell.colors) |
|
1763 | 1764 | # reset Breakpoint state, which is moronically kept |
|
1764 | 1765 | # in a class |
|
1765 | 1766 | bdb.Breakpoint.next = 1 |
|
1766 | 1767 | bdb.Breakpoint.bplist = {} |
|
1767 | 1768 | bdb.Breakpoint.bpbynumber = [None] |
|
1768 | 1769 | # Set an initial breakpoint to stop execution |
|
1769 | 1770 | maxtries = 10 |
|
1770 | 1771 | bp = int(opts.get('b', [1])[0]) |
|
1771 | 1772 | checkline = deb.checkline(filename, bp) |
|
1772 | 1773 | if not checkline: |
|
1773 | 1774 | for bp in range(bp + 1, bp + maxtries + 1): |
|
1774 | 1775 | if deb.checkline(filename, bp): |
|
1775 | 1776 | break |
|
1776 | 1777 | else: |
|
1777 | 1778 | msg = ("\nI failed to find a valid line to set " |
|
1778 | 1779 | "a breakpoint\n" |
|
1779 | 1780 | "after trying up to line: %s.\n" |
|
1780 | 1781 | "Please set a valid breakpoint manually " |
|
1781 | 1782 | "with the -b option." % bp) |
|
1782 | 1783 | error(msg) |
|
1783 | 1784 | return |
|
1784 | 1785 | # if we find a good linenumber, set the breakpoint |
|
1785 | 1786 | deb.do_break('%s:%s' % (filename, bp)) |
|
1786 | 1787 | # Start file run |
|
1787 | 1788 | print "NOTE: Enter 'c' at the", |
|
1788 | 1789 | print "%s prompt to start your script." % deb.prompt |
|
1789 | 1790 | ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns} |
|
1790 | 1791 | try: |
|
1791 | 1792 | deb.run('execfile("%s", prog_ns)' % filename, ns) |
|
1792 | 1793 | |
|
1793 | 1794 | except: |
|
1794 | 1795 | etype, value, tb = sys.exc_info() |
|
1795 | 1796 | # Skip three frames in the traceback: the %run one, |
|
1796 | 1797 | # one inside bdb.py, and the command-line typed by the |
|
1797 | 1798 | # user (run by exec in pdb itself). |
|
1798 | 1799 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) |
|
1799 | 1800 | else: |
|
1800 | 1801 | if runner is None: |
|
1801 | 1802 | runner = self.shell.safe_execfile |
|
1802 | 1803 | if 't' in opts: |
|
1803 | 1804 | # timed execution |
|
1804 | 1805 | try: |
|
1805 | 1806 | nruns = int(opts['N'][0]) |
|
1806 | 1807 | if nruns < 1: |
|
1807 | 1808 | error('Number of runs must be >=1') |
|
1808 | 1809 | return |
|
1809 | 1810 | except (KeyError): |
|
1810 | 1811 | nruns = 1 |
|
1811 | 1812 | twall0 = time.time() |
|
1812 | 1813 | if nruns == 1: |
|
1813 | 1814 | t0 = clock2() |
|
1814 | 1815 | runner(filename, prog_ns, prog_ns, |
|
1815 | 1816 | exit_ignore=exit_ignore) |
|
1816 | 1817 | t1 = clock2() |
|
1817 | 1818 | t_usr = t1[0] - t0[0] |
|
1818 | 1819 | t_sys = t1[1] - t0[1] |
|
1819 | 1820 | print "\nIPython CPU timings (estimated):" |
|
1820 | 1821 | print " User : %10.2f s." % t_usr |
|
1821 | 1822 | print " System : %10.2f s." % t_sys |
|
1822 | 1823 | else: |
|
1823 | 1824 | runs = range(nruns) |
|
1824 | 1825 | t0 = clock2() |
|
1825 | 1826 | for nr in runs: |
|
1826 | 1827 | runner(filename, prog_ns, prog_ns, |
|
1827 | 1828 | exit_ignore=exit_ignore) |
|
1828 | 1829 | t1 = clock2() |
|
1829 | 1830 | t_usr = t1[0] - t0[0] |
|
1830 | 1831 | t_sys = t1[1] - t0[1] |
|
1831 | 1832 | print "\nIPython CPU timings (estimated):" |
|
1832 | 1833 | print "Total runs performed:", nruns |
|
1833 | 1834 | print " Times : %10.2f %10.2f" % ('Total', 'Per run') |
|
1834 | 1835 | print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns) |
|
1835 | 1836 | print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns) |
|
1836 | 1837 | twall1 = time.time() |
|
1837 | 1838 | print "Wall time: %10.2f s." % (twall1 - twall0) |
|
1838 | 1839 | |
|
1839 | 1840 | else: |
|
1840 | 1841 | # regular execution |
|
1841 | 1842 | runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore) |
|
1842 | 1843 | |
|
1843 | 1844 | if 'i' in opts: |
|
1844 | 1845 | self.shell.user_ns['__name__'] = __name__save |
|
1845 | 1846 | else: |
|
1846 | 1847 | # The shell MUST hold a reference to prog_ns so after %run |
|
1847 | 1848 | # exits, the python deletion mechanism doesn't zero it out |
|
1848 | 1849 | # (leaving dangling references). |
|
1849 | 1850 | self.shell.cache_main_mod(prog_ns, filename) |
|
1850 | 1851 | # update IPython interactive namespace |
|
1851 | 1852 | |
|
1852 | 1853 | # Some forms of read errors on the file may mean the |
|
1853 | 1854 | # __name__ key was never set; using pop we don't have to |
|
1854 | 1855 | # worry about a possible KeyError. |
|
1855 | 1856 | prog_ns.pop('__name__', None) |
|
1856 | 1857 | |
|
1857 | 1858 | self.shell.user_ns.update(prog_ns) |
|
1858 | 1859 | finally: |
|
1859 | 1860 | # It's a bit of a mystery why, but __builtins__ can change from |
|
1860 | 1861 | # being a module to becoming a dict missing some key data after |
|
1861 | 1862 | # %run. As best I can see, this is NOT something IPython is doing |
|
1862 | 1863 | # at all, and similar problems have been reported before: |
|
1863 | 1864 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
1864 | 1865 | # Since this seems to be done by the interpreter itself, the best |
|
1865 | 1866 | # we can do is to at least restore __builtins__ for the user on |
|
1866 | 1867 | # exit. |
|
1867 | 1868 | self.shell.user_ns['__builtins__'] = builtin_mod |
|
1868 | 1869 | |
|
1869 | 1870 | # Ensure key global structures are restored |
|
1870 | 1871 | sys.argv = save_argv |
|
1871 | 1872 | if restore_main: |
|
1872 | 1873 | sys.modules['__main__'] = restore_main |
|
1873 | 1874 | else: |
|
1874 | 1875 | # Remove from sys.modules the reference to main_mod we'd |
|
1875 | 1876 | # added. Otherwise it will trap references to objects |
|
1876 | 1877 | # contained therein. |
|
1877 | 1878 | del sys.modules[main_mod_name] |
|
1878 | 1879 | |
|
1879 | 1880 | return stats |
|
1880 | 1881 | |
|
1881 | 1882 | @skip_doctest |
|
1882 | 1883 | def magic_timeit(self, parameter_s =''): |
|
1883 | 1884 | """Time execution of a Python statement or expression |
|
1884 | 1885 | |
|
1885 | 1886 | Usage:\\ |
|
1886 | 1887 | %timeit [-n<N> -r<R> [-t|-c]] statement |
|
1887 | 1888 | |
|
1888 | 1889 | Time execution of a Python statement or expression using the timeit |
|
1889 | 1890 | module. |
|
1890 | 1891 | |
|
1891 | 1892 | Options: |
|
1892 | 1893 | -n<N>: execute the given statement <N> times in a loop. If this value |
|
1893 | 1894 | is not given, a fitting value is chosen. |
|
1894 | 1895 | |
|
1895 | 1896 | -r<R>: repeat the loop iteration <R> times and take the best result. |
|
1896 | 1897 | Default: 3 |
|
1897 | 1898 | |
|
1898 | 1899 | -t: use time.time to measure the time, which is the default on Unix. |
|
1899 | 1900 | This function measures wall time. |
|
1900 | 1901 | |
|
1901 | 1902 | -c: use time.clock to measure the time, which is the default on |
|
1902 | 1903 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1903 | 1904 | instead and returns the CPU user time. |
|
1904 | 1905 | |
|
1905 | 1906 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1906 | 1907 | Default: 3 |
|
1907 | 1908 | |
|
1908 | 1909 | |
|
1909 | 1910 | Examples |
|
1910 | 1911 | -------- |
|
1911 | 1912 | :: |
|
1912 | 1913 | |
|
1913 | 1914 | In [1]: %timeit pass |
|
1914 | 1915 | 10000000 loops, best of 3: 53.3 ns per loop |
|
1915 | 1916 | |
|
1916 | 1917 | In [2]: u = None |
|
1917 | 1918 | |
|
1918 | 1919 | In [3]: %timeit u is None |
|
1919 | 1920 | 10000000 loops, best of 3: 184 ns per loop |
|
1920 | 1921 | |
|
1921 | 1922 | In [4]: %timeit -r 4 u == None |
|
1922 | 1923 | 1000000 loops, best of 4: 242 ns per loop |
|
1923 | 1924 | |
|
1924 | 1925 | In [5]: import time |
|
1925 | 1926 | |
|
1926 | 1927 | In [6]: %timeit -n1 time.sleep(2) |
|
1927 | 1928 | 1 loops, best of 3: 2 s per loop |
|
1928 | 1929 | |
|
1929 | 1930 | |
|
1930 | 1931 | The times reported by %timeit will be slightly higher than those |
|
1931 | 1932 | reported by the timeit.py script when variables are accessed. This is |
|
1932 | 1933 | due to the fact that %timeit executes the statement in the namespace |
|
1933 | 1934 | of the shell, compared with timeit.py, which uses a single setup |
|
1934 | 1935 | statement to import function or create variables. Generally, the bias |
|
1935 | 1936 | does not matter as long as results from timeit.py are not mixed with |
|
1936 | 1937 | those from %timeit.""" |
|
1937 | 1938 | |
|
1938 | 1939 | import timeit |
|
1939 | 1940 | import math |
|
1940 | 1941 | |
|
1941 | 1942 | # XXX: Unfortunately the unicode 'micro' symbol can cause problems in |
|
1942 | 1943 | # certain terminals. Until we figure out a robust way of |
|
1943 | 1944 | # auto-detecting if the terminal can deal with it, use plain 'us' for |
|
1944 | 1945 | # microseconds. I am really NOT happy about disabling the proper |
|
1945 | 1946 | # 'micro' prefix, but crashing is worse... If anyone knows what the |
|
1946 | 1947 | # right solution for this is, I'm all ears... |
|
1947 | 1948 | # |
|
1948 | 1949 | # Note: using |
|
1949 | 1950 | # |
|
1950 | 1951 | # s = u'\xb5' |
|
1951 | 1952 | # s.encode(sys.getdefaultencoding()) |
|
1952 | 1953 | # |
|
1953 | 1954 | # is not sufficient, as I've seen terminals where that fails but |
|
1954 | 1955 | # print s |
|
1955 | 1956 | # |
|
1956 | 1957 | # succeeds |
|
1957 | 1958 | # |
|
1958 | 1959 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1959 | 1960 | |
|
1960 | 1961 | #units = [u"s", u"ms",u'\xb5',"ns"] |
|
1961 | 1962 | units = [u"s", u"ms",u'us',"ns"] |
|
1962 | 1963 | |
|
1963 | 1964 | scaling = [1, 1e3, 1e6, 1e9] |
|
1964 | 1965 | |
|
1965 | 1966 | opts, stmt = self.parse_options(parameter_s,'n:r:tcp:', |
|
1966 | 1967 | posix=False, strict=False) |
|
1967 | 1968 | if stmt == "": |
|
1968 | 1969 | return |
|
1969 | 1970 | timefunc = timeit.default_timer |
|
1970 | 1971 | number = int(getattr(opts, "n", 0)) |
|
1971 | 1972 | repeat = int(getattr(opts, "r", timeit.default_repeat)) |
|
1972 | 1973 | precision = int(getattr(opts, "p", 3)) |
|
1973 | 1974 | if hasattr(opts, "t"): |
|
1974 | 1975 | timefunc = time.time |
|
1975 | 1976 | if hasattr(opts, "c"): |
|
1976 | 1977 | timefunc = clock |
|
1977 | 1978 | |
|
1978 | 1979 | timer = timeit.Timer(timer=timefunc) |
|
1979 | 1980 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1980 | 1981 | # but is there a better way to achieve that the code stmt has access |
|
1981 | 1982 | # to the shell namespace? |
|
1982 | 1983 | |
|
1983 | 1984 | src = timeit.template % {'stmt': timeit.reindent(stmt, 8), |
|
1984 | 1985 | 'setup': "pass"} |
|
1985 | 1986 | # Track compilation time so it can be reported if too long |
|
1986 | 1987 | # Minimum time above which compilation time will be reported |
|
1987 | 1988 | tc_min = 0.1 |
|
1988 | 1989 | |
|
1989 | 1990 | t0 = clock() |
|
1990 | 1991 | code = compile(src, "<magic-timeit>", "exec") |
|
1991 | 1992 | tc = clock()-t0 |
|
1992 | 1993 | |
|
1993 | 1994 | ns = {} |
|
1994 | 1995 | exec code in self.shell.user_ns, ns |
|
1995 | 1996 | timer.inner = ns["inner"] |
|
1996 | 1997 | |
|
1997 | 1998 | if number == 0: |
|
1998 | 1999 | # determine number so that 0.2 <= total time < 2.0 |
|
1999 | 2000 | number = 1 |
|
2000 | 2001 | for i in range(1, 10): |
|
2001 | 2002 | if timer.timeit(number) >= 0.2: |
|
2002 | 2003 | break |
|
2003 | 2004 | number *= 10 |
|
2004 | 2005 | |
|
2005 | 2006 | best = min(timer.repeat(repeat, number)) / number |
|
2006 | 2007 | |
|
2007 | 2008 | if best > 0.0 and best < 1000.0: |
|
2008 | 2009 | order = min(-int(math.floor(math.log10(best)) // 3), 3) |
|
2009 | 2010 | elif best >= 1000.0: |
|
2010 | 2011 | order = 0 |
|
2011 | 2012 | else: |
|
2012 | 2013 | order = 3 |
|
2013 | 2014 | print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat, |
|
2014 | 2015 | precision, |
|
2015 | 2016 | best * scaling[order], |
|
2016 | 2017 | units[order]) |
|
2017 | 2018 | if tc > tc_min: |
|
2018 | 2019 | print "Compiler time: %.2f s" % tc |
|
2019 | 2020 | |
|
2020 | 2021 | @skip_doctest |
|
2021 | 2022 | @needs_local_scope |
|
2022 | 2023 | def magic_time(self,parameter_s = ''): |
|
2023 | 2024 | """Time execution of a Python statement or expression. |
|
2024 | 2025 | |
|
2025 | 2026 | The CPU and wall clock times are printed, and the value of the |
|
2026 | 2027 | expression (if any) is returned. Note that under Win32, system time |
|
2027 | 2028 | is always reported as 0, since it can not be measured. |
|
2028 | 2029 | |
|
2029 | 2030 | This function provides very basic timing functionality. In Python |
|
2030 | 2031 | 2.3, the timeit module offers more control and sophistication, so this |
|
2031 | 2032 | could be rewritten to use it (patches welcome). |
|
2032 | 2033 | |
|
2033 | 2034 | Examples |
|
2034 | 2035 | -------- |
|
2035 | 2036 | :: |
|
2036 | 2037 | |
|
2037 | 2038 | In [1]: time 2**128 |
|
2038 | 2039 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
2039 | 2040 | Wall time: 0.00 |
|
2040 | 2041 | Out[1]: 340282366920938463463374607431768211456L |
|
2041 | 2042 | |
|
2042 | 2043 | In [2]: n = 1000000 |
|
2043 | 2044 | |
|
2044 | 2045 | In [3]: time sum(range(n)) |
|
2045 | 2046 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
2046 | 2047 | Wall time: 1.37 |
|
2047 | 2048 | Out[3]: 499999500000L |
|
2048 | 2049 | |
|
2049 | 2050 | In [4]: time print 'hello world' |
|
2050 | 2051 | hello world |
|
2051 | 2052 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
2052 | 2053 | Wall time: 0.00 |
|
2053 | 2054 | |
|
2054 | 2055 | Note that the time needed by Python to compile the given expression |
|
2055 | 2056 | will be reported if it is more than 0.1s. In this example, the |
|
2056 | 2057 | actual exponentiation is done by Python at compilation time, so while |
|
2057 | 2058 | the expression can take a noticeable amount of time to compute, that |
|
2058 | 2059 | time is purely due to the compilation: |
|
2059 | 2060 | |
|
2060 | 2061 | In [5]: time 3**9999; |
|
2061 | 2062 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
2062 | 2063 | Wall time: 0.00 s |
|
2063 | 2064 | |
|
2064 | 2065 | In [6]: time 3**999999; |
|
2065 | 2066 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
2066 | 2067 | Wall time: 0.00 s |
|
2067 | 2068 | Compiler : 0.78 s |
|
2068 | 2069 | """ |
|
2069 | 2070 | |
|
2070 | 2071 | # fail immediately if the given expression can't be compiled |
|
2071 | 2072 | |
|
2072 | 2073 | expr = self.shell.prefilter(parameter_s,False) |
|
2073 | 2074 | |
|
2074 | 2075 | # Minimum time above which compilation time will be reported |
|
2075 | 2076 | tc_min = 0.1 |
|
2076 | 2077 | |
|
2077 | 2078 | try: |
|
2078 | 2079 | mode = 'eval' |
|
2079 | 2080 | t0 = clock() |
|
2080 | 2081 | code = compile(expr,'<timed eval>',mode) |
|
2081 | 2082 | tc = clock()-t0 |
|
2082 | 2083 | except SyntaxError: |
|
2083 | 2084 | mode = 'exec' |
|
2084 | 2085 | t0 = clock() |
|
2085 | 2086 | code = compile(expr,'<timed exec>',mode) |
|
2086 | 2087 | tc = clock()-t0 |
|
2087 | 2088 | # skew measurement as little as possible |
|
2088 | 2089 | glob = self.shell.user_ns |
|
2089 | 2090 | locs = self._magic_locals |
|
2090 | 2091 | clk = clock2 |
|
2091 | 2092 | wtime = time.time |
|
2092 | 2093 | # time execution |
|
2093 | 2094 | wall_st = wtime() |
|
2094 | 2095 | if mode=='eval': |
|
2095 | 2096 | st = clk() |
|
2096 | 2097 | out = eval(code, glob, locs) |
|
2097 | 2098 | end = clk() |
|
2098 | 2099 | else: |
|
2099 | 2100 | st = clk() |
|
2100 | 2101 | exec code in glob, locs |
|
2101 | 2102 | end = clk() |
|
2102 | 2103 | out = None |
|
2103 | 2104 | wall_end = wtime() |
|
2104 | 2105 | # Compute actual times and report |
|
2105 | 2106 | wall_time = wall_end-wall_st |
|
2106 | 2107 | cpu_user = end[0]-st[0] |
|
2107 | 2108 | cpu_sys = end[1]-st[1] |
|
2108 | 2109 | cpu_tot = cpu_user+cpu_sys |
|
2109 | 2110 | print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \ |
|
2110 | 2111 | (cpu_user,cpu_sys,cpu_tot) |
|
2111 | 2112 | print "Wall time: %.2f s" % wall_time |
|
2112 | 2113 | if tc > tc_min: |
|
2113 | 2114 | print "Compiler : %.2f s" % tc |
|
2114 | 2115 | return out |
|
2115 | 2116 | |
|
2116 | 2117 | @skip_doctest |
|
2117 | 2118 | def magic_macro(self,parameter_s = ''): |
|
2118 | 2119 | """Define a macro for future re-execution. It accepts ranges of history, |
|
2119 | 2120 | filenames or string objects. |
|
2120 | 2121 | |
|
2121 | 2122 | Usage:\\ |
|
2122 | 2123 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
2123 | 2124 | |
|
2124 | 2125 | Options: |
|
2125 | 2126 | |
|
2126 | 2127 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2127 | 2128 | so that magics are loaded in their transformed version to valid |
|
2128 | 2129 | Python. If this option is given, the raw input as typed as the |
|
2129 | 2130 | command line is used instead. |
|
2130 | 2131 | |
|
2131 | 2132 | This will define a global variable called `name` which is a string |
|
2132 | 2133 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
2133 | 2134 | above) from your input history into a single string. This variable |
|
2134 | 2135 | acts like an automatic function which re-executes those lines as if |
|
2135 | 2136 | you had typed them. You just type 'name' at the prompt and the code |
|
2136 | 2137 | executes. |
|
2137 | 2138 | |
|
2138 | 2139 | The syntax for indicating input ranges is described in %history. |
|
2139 | 2140 | |
|
2140 | 2141 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
2141 | 2142 | notation, where N:M means numbers N through M-1. |
|
2142 | 2143 | |
|
2143 | 2144 | For example, if your history contains (%hist prints it):: |
|
2144 | 2145 | |
|
2145 | 2146 | 44: x=1 |
|
2146 | 2147 | 45: y=3 |
|
2147 | 2148 | 46: z=x+y |
|
2148 | 2149 | 47: print x |
|
2149 | 2150 | 48: a=5 |
|
2150 | 2151 | 49: print 'x',x,'y',y |
|
2151 | 2152 | |
|
2152 | 2153 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
2153 | 2154 | called my_macro with:: |
|
2154 | 2155 | |
|
2155 | 2156 | In [55]: %macro my_macro 44-47 49 |
|
2156 | 2157 | |
|
2157 | 2158 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
2158 | 2159 | in one pass. |
|
2159 | 2160 | |
|
2160 | 2161 | You don't need to give the line-numbers in order, and any given line |
|
2161 | 2162 | number can appear multiple times. You can assemble macros with any |
|
2162 | 2163 | lines from your input history in any order. |
|
2163 | 2164 | |
|
2164 | 2165 | The macro is a simple object which holds its value in an attribute, |
|
2165 | 2166 | but IPython's display system checks for macros and executes them as |
|
2166 | 2167 | code instead of printing them when you type their name. |
|
2167 | 2168 | |
|
2168 | 2169 | You can view a macro's contents by explicitly printing it with:: |
|
2169 | 2170 | |
|
2170 | 2171 | print macro_name |
|
2171 | 2172 | |
|
2172 | 2173 | """ |
|
2173 | 2174 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2174 | 2175 | if not args: # List existing macros |
|
2175 | 2176 | return sorted(k for k,v in self.shell.user_ns.iteritems() if\ |
|
2176 | 2177 | isinstance(v, Macro)) |
|
2177 | 2178 | if len(args) == 1: |
|
2178 | 2179 | raise UsageError( |
|
2179 | 2180 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
2180 | 2181 | name, codefrom = args[0], " ".join(args[1:]) |
|
2181 | 2182 | |
|
2182 | 2183 | #print 'rng',ranges # dbg |
|
2183 | 2184 | try: |
|
2184 | 2185 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2185 | 2186 | except (ValueError, TypeError) as e: |
|
2186 | 2187 | print e.args[0] |
|
2187 | 2188 | return |
|
2188 | 2189 | macro = Macro(lines) |
|
2189 | 2190 | self.shell.define_macro(name, macro) |
|
2190 | 2191 | print 'Macro `%s` created. To execute, type its name (without quotes).' % name |
|
2191 | 2192 | print '=== Macro contents: ===' |
|
2192 | 2193 | print macro, |
|
2193 | 2194 | |
|
2194 | 2195 | def magic_save(self,parameter_s = ''): |
|
2195 | 2196 | """Save a set of lines or a macro to a given filename. |
|
2196 | 2197 | |
|
2197 | 2198 | Usage:\\ |
|
2198 | 2199 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
2199 | 2200 | |
|
2200 | 2201 | Options: |
|
2201 | 2202 | |
|
2202 | 2203 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
2203 | 2204 | so that magics are loaded in their transformed version to valid |
|
2204 | 2205 | Python. If this option is given, the raw input as typed as the |
|
2205 | 2206 | command line is used instead. |
|
2206 | 2207 | |
|
2207 | 2208 | This function uses the same syntax as %history for input ranges, |
|
2208 | 2209 | then saves the lines to the filename you specify. |
|
2209 | 2210 | |
|
2210 | 2211 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
2211 | 2212 | it asks for confirmation before overwriting existing files.""" |
|
2212 | 2213 | |
|
2213 | 2214 | opts,args = self.parse_options(parameter_s,'r',mode='list') |
|
2214 | 2215 | fname, codefrom = unquote_filename(args[0]), " ".join(args[1:]) |
|
2215 | 2216 | if not fname.endswith('.py'): |
|
2216 | 2217 | fname += '.py' |
|
2217 | 2218 | if os.path.isfile(fname): |
|
2218 | 2219 | ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname) |
|
2219 | 2220 | if ans.lower() not in ['y','yes']: |
|
2220 | 2221 | print 'Operation cancelled.' |
|
2221 | 2222 | return |
|
2222 | 2223 | try: |
|
2223 | 2224 | cmds = self.shell.find_user_code(codefrom, 'r' in opts) |
|
2224 | 2225 | except (TypeError, ValueError) as e: |
|
2225 | 2226 | print e.args[0] |
|
2226 | 2227 | return |
|
2227 | 2228 | with io.open(fname,'w', encoding="utf-8") as f: |
|
2228 | 2229 | f.write(u"# coding: utf-8\n") |
|
2229 | 2230 | f.write(py3compat.cast_unicode(cmds)) |
|
2230 | 2231 | print 'The following commands were written to file `%s`:' % fname |
|
2231 | 2232 | print cmds |
|
2232 | 2233 | |
|
2233 | 2234 | def magic_pastebin(self, parameter_s = ''): |
|
2234 | 2235 | """Upload code to the 'Lodge it' paste bin, returning the URL.""" |
|
2235 | 2236 | try: |
|
2236 | 2237 | code = self.shell.find_user_code(parameter_s) |
|
2237 | 2238 | except (ValueError, TypeError) as e: |
|
2238 | 2239 | print e.args[0] |
|
2239 | 2240 | return |
|
2240 | 2241 | pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/') |
|
2241 | 2242 | id = pbserver.pastes.newPaste("python", code) |
|
2242 | 2243 | return "http://paste.pocoo.org/show/" + id |
|
2243 | 2244 | |
|
2244 | 2245 | def magic_loadpy(self, arg_s): |
|
2245 | 2246 | """Load a .py python script into the GUI console. |
|
2246 | 2247 | |
|
2247 | 2248 | This magic command can either take a local filename or a url:: |
|
2248 | 2249 | |
|
2249 | 2250 | %loadpy myscript.py |
|
2250 | 2251 | %loadpy http://www.example.com/myscript.py |
|
2251 | 2252 | """ |
|
2252 | 2253 | arg_s = unquote_filename(arg_s) |
|
2253 | 2254 | remote_url = arg_s.startswith(('http://', 'https://')) |
|
2254 | 2255 | local_url = not remote_url |
|
2255 | 2256 | if local_url and not arg_s.endswith('.py'): |
|
2256 | 2257 | # Local files must be .py; for remote URLs it's possible that the |
|
2257 | 2258 | # fetch URL doesn't have a .py in it (many servers have an opaque |
|
2258 | 2259 | # URL, such as scipy-central.org). |
|
2259 | 2260 | raise ValueError('%%loadpy only works with .py files: %s' % arg_s) |
|
2260 | 2261 | |
|
2261 | 2262 | # openpy takes care of finding the source encoding (per PEP 263) |
|
2262 | 2263 | if remote_url: |
|
2263 | 2264 | contents = openpy.read_py_url(arg_s, skip_encoding_cookie=True) |
|
2264 | 2265 | else: |
|
2265 | 2266 | contents = openpy.read_py_file(arg_s, skip_encoding_cookie=True) |
|
2266 | 2267 | |
|
2267 | 2268 | self.set_next_input(contents) |
|
2268 | 2269 | |
|
2269 | 2270 | def _find_edit_target(self, args, opts, last_call): |
|
2270 | 2271 | """Utility method used by magic_edit to find what to edit.""" |
|
2271 | 2272 | |
|
2272 | 2273 | def make_filename(arg): |
|
2273 | 2274 | "Make a filename from the given args" |
|
2274 | 2275 | arg = unquote_filename(arg) |
|
2275 | 2276 | try: |
|
2276 | 2277 | filename = get_py_filename(arg) |
|
2277 | 2278 | except IOError: |
|
2278 | 2279 | # If it ends with .py but doesn't already exist, assume we want |
|
2279 | 2280 | # a new file. |
|
2280 | 2281 | if arg.endswith('.py'): |
|
2281 | 2282 | filename = arg |
|
2282 | 2283 | else: |
|
2283 | 2284 | filename = None |
|
2284 | 2285 | return filename |
|
2285 | 2286 | |
|
2286 | 2287 | # Set a few locals from the options for convenience: |
|
2287 | 2288 | opts_prev = 'p' in opts |
|
2288 | 2289 | opts_raw = 'r' in opts |
|
2289 | 2290 | |
|
2290 | 2291 | # custom exceptions |
|
2291 | 2292 | class DataIsObject(Exception): pass |
|
2292 | 2293 | |
|
2293 | 2294 | # Default line number value |
|
2294 | 2295 | lineno = opts.get('n',None) |
|
2295 | 2296 | |
|
2296 | 2297 | if opts_prev: |
|
2297 | 2298 | args = '_%s' % last_call[0] |
|
2298 | 2299 | if not self.shell.user_ns.has_key(args): |
|
2299 | 2300 | args = last_call[1] |
|
2300 | 2301 | |
|
2301 | 2302 | # use last_call to remember the state of the previous call, but don't |
|
2302 | 2303 | # let it be clobbered by successive '-p' calls. |
|
2303 | 2304 | try: |
|
2304 | 2305 | last_call[0] = self.shell.displayhook.prompt_count |
|
2305 | 2306 | if not opts_prev: |
|
2306 | 2307 | last_call[1] = args |
|
2307 | 2308 | except: |
|
2308 | 2309 | pass |
|
2309 | 2310 | |
|
2310 | 2311 | # by default this is done with temp files, except when the given |
|
2311 | 2312 | # arg is a filename |
|
2312 | 2313 | use_temp = True |
|
2313 | 2314 | |
|
2314 | 2315 | data = '' |
|
2315 | 2316 | |
|
2316 | 2317 | # First, see if the arguments should be a filename. |
|
2317 | 2318 | filename = make_filename(args) |
|
2318 | 2319 | if filename: |
|
2319 | 2320 | use_temp = False |
|
2320 | 2321 | elif args: |
|
2321 | 2322 | # Mode where user specifies ranges of lines, like in %macro. |
|
2322 | 2323 | data = self.extract_input_lines(args, opts_raw) |
|
2323 | 2324 | if not data: |
|
2324 | 2325 | try: |
|
2325 | 2326 | # Load the parameter given as a variable. If not a string, |
|
2326 | 2327 | # process it as an object instead (below) |
|
2327 | 2328 | |
|
2328 | 2329 | #print '*** args',args,'type',type(args) # dbg |
|
2329 | 2330 | data = eval(args, self.shell.user_ns) |
|
2330 | 2331 | if not isinstance(data, basestring): |
|
2331 | 2332 | raise DataIsObject |
|
2332 | 2333 | |
|
2333 | 2334 | except (NameError,SyntaxError): |
|
2334 | 2335 | # given argument is not a variable, try as a filename |
|
2335 | 2336 | filename = make_filename(args) |
|
2336 | 2337 | if filename is None: |
|
2337 | 2338 | warn("Argument given (%s) can't be found as a variable " |
|
2338 | 2339 | "or as a filename." % args) |
|
2339 | 2340 | return |
|
2340 | 2341 | use_temp = False |
|
2341 | 2342 | |
|
2342 | 2343 | except DataIsObject: |
|
2343 | 2344 | # macros have a special edit function |
|
2344 | 2345 | if isinstance(data, Macro): |
|
2345 | 2346 | raise MacroToEdit(data) |
|
2346 | 2347 | |
|
2347 | 2348 | # For objects, try to edit the file where they are defined |
|
2348 | 2349 | try: |
|
2349 | 2350 | filename = inspect.getabsfile(data) |
|
2350 | 2351 | if 'fakemodule' in filename.lower() and inspect.isclass(data): |
|
2351 | 2352 | # class created by %edit? Try to find source |
|
2352 | 2353 | # by looking for method definitions instead, the |
|
2353 | 2354 | # __module__ in those classes is FakeModule. |
|
2354 | 2355 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
2355 | 2356 | for attr in attrs: |
|
2356 | 2357 | if not inspect.ismethod(attr): |
|
2357 | 2358 | continue |
|
2358 | 2359 | filename = inspect.getabsfile(attr) |
|
2359 | 2360 | if filename and 'fakemodule' not in filename.lower(): |
|
2360 | 2361 | # change the attribute to be the edit target instead |
|
2361 | 2362 | data = attr |
|
2362 | 2363 | break |
|
2363 | 2364 | |
|
2364 | 2365 | datafile = 1 |
|
2365 | 2366 | except TypeError: |
|
2366 | 2367 | filename = make_filename(args) |
|
2367 | 2368 | datafile = 1 |
|
2368 | 2369 | warn('Could not find file where `%s` is defined.\n' |
|
2369 | 2370 | 'Opening a file named `%s`' % (args,filename)) |
|
2370 | 2371 | # Now, make sure we can actually read the source (if it was in |
|
2371 | 2372 | # a temp file it's gone by now). |
|
2372 | 2373 | if datafile: |
|
2373 | 2374 | try: |
|
2374 | 2375 | if lineno is None: |
|
2375 | 2376 | lineno = inspect.getsourcelines(data)[1] |
|
2376 | 2377 | except IOError: |
|
2377 | 2378 | filename = make_filename(args) |
|
2378 | 2379 | if filename is None: |
|
2379 | 2380 | warn('The file `%s` where `%s` was defined cannot ' |
|
2380 | 2381 | 'be read.' % (filename,data)) |
|
2381 | 2382 | return |
|
2382 | 2383 | use_temp = False |
|
2383 | 2384 | |
|
2384 | 2385 | if use_temp: |
|
2385 | 2386 | filename = self.shell.mktempfile(data) |
|
2386 | 2387 | print 'IPython will make a temporary file named:',filename |
|
2387 | 2388 | |
|
2388 | 2389 | return filename, lineno, use_temp |
|
2389 | 2390 | |
|
2390 | 2391 | def _edit_macro(self,mname,macro): |
|
2391 | 2392 | """open an editor with the macro data in a file""" |
|
2392 | 2393 | filename = self.shell.mktempfile(macro.value) |
|
2393 | 2394 | self.shell.hooks.editor(filename) |
|
2394 | 2395 | |
|
2395 | 2396 | # and make a new macro object, to replace the old one |
|
2396 | 2397 | mfile = open(filename) |
|
2397 | 2398 | mvalue = mfile.read() |
|
2398 | 2399 | mfile.close() |
|
2399 | 2400 | self.shell.user_ns[mname] = Macro(mvalue) |
|
2400 | 2401 | |
|
2401 | 2402 | def magic_ed(self,parameter_s=''): |
|
2402 | 2403 | """Alias to %edit.""" |
|
2403 | 2404 | return self.magic_edit(parameter_s) |
|
2404 | 2405 | |
|
2405 | 2406 | @skip_doctest |
|
2406 | 2407 | def magic_edit(self,parameter_s='',last_call=['','']): |
|
2407 | 2408 | """Bring up an editor and execute the resulting code. |
|
2408 | 2409 | |
|
2409 | 2410 | Usage: |
|
2410 | 2411 | %edit [options] [args] |
|
2411 | 2412 | |
|
2412 | 2413 | %edit runs IPython's editor hook. The default version of this hook is |
|
2413 | 2414 | set to call the editor specified by your $EDITOR environment variable. |
|
2414 | 2415 | If this isn't found, it will default to vi under Linux/Unix and to |
|
2415 | 2416 | notepad under Windows. See the end of this docstring for how to change |
|
2416 | 2417 | the editor hook. |
|
2417 | 2418 | |
|
2418 | 2419 | You can also set the value of this editor via the |
|
2419 | 2420 | ``TerminalInteractiveShell.editor`` option in your configuration file. |
|
2420 | 2421 | This is useful if you wish to use a different editor from your typical |
|
2421 | 2422 | default with IPython (and for Windows users who typically don't set |
|
2422 | 2423 | environment variables). |
|
2423 | 2424 | |
|
2424 | 2425 | This command allows you to conveniently edit multi-line code right in |
|
2425 | 2426 | your IPython session. |
|
2426 | 2427 | |
|
2427 | 2428 | If called without arguments, %edit opens up an empty editor with a |
|
2428 | 2429 | temporary file and will execute the contents of this file when you |
|
2429 | 2430 | close it (don't forget to save it!). |
|
2430 | 2431 | |
|
2431 | 2432 | |
|
2432 | 2433 | Options: |
|
2433 | 2434 | |
|
2434 | 2435 | -n <number>: open the editor at a specified line number. By default, |
|
2435 | 2436 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
2436 | 2437 | you can configure this by providing your own modified hook if your |
|
2437 | 2438 | favorite editor supports line-number specifications with a different |
|
2438 | 2439 | syntax. |
|
2439 | 2440 | |
|
2440 | 2441 | -p: this will call the editor with the same data as the previous time |
|
2441 | 2442 | it was used, regardless of how long ago (in your current session) it |
|
2442 | 2443 | was. |
|
2443 | 2444 | |
|
2444 | 2445 | -r: use 'raw' input. This option only applies to input taken from the |
|
2445 | 2446 | user's history. By default, the 'processed' history is used, so that |
|
2446 | 2447 | magics are loaded in their transformed version to valid Python. If |
|
2447 | 2448 | this option is given, the raw input as typed as the command line is |
|
2448 | 2449 | used instead. When you exit the editor, it will be executed by |
|
2449 | 2450 | IPython's own processor. |
|
2450 | 2451 | |
|
2451 | 2452 | -x: do not execute the edited code immediately upon exit. This is |
|
2452 | 2453 | mainly useful if you are editing programs which need to be called with |
|
2453 | 2454 | command line arguments, which you can then do using %run. |
|
2454 | 2455 | |
|
2455 | 2456 | |
|
2456 | 2457 | Arguments: |
|
2457 | 2458 | |
|
2458 | 2459 | If arguments are given, the following possibilities exist: |
|
2459 | 2460 | |
|
2460 | 2461 | - If the argument is a filename, IPython will load that into the |
|
2461 | 2462 | editor. It will execute its contents with execfile() when you exit, |
|
2462 | 2463 | loading any code in the file into your interactive namespace. |
|
2463 | 2464 | |
|
2464 | 2465 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". |
|
2465 | 2466 | The syntax is the same as in the %history magic. |
|
2466 | 2467 | |
|
2467 | 2468 | - If the argument is a string variable, its contents are loaded |
|
2468 | 2469 | into the editor. You can thus edit any string which contains |
|
2469 | 2470 | python code (including the result of previous edits). |
|
2470 | 2471 | |
|
2471 | 2472 | - If the argument is the name of an object (other than a string), |
|
2472 | 2473 | IPython will try to locate the file where it was defined and open the |
|
2473 | 2474 | editor at the point where it is defined. You can use `%edit function` |
|
2474 | 2475 | to load an editor exactly at the point where 'function' is defined, |
|
2475 | 2476 | edit it and have the file be executed automatically. |
|
2476 | 2477 | |
|
2477 | 2478 | - If the object is a macro (see %macro for details), this opens up your |
|
2478 | 2479 | specified editor with a temporary file containing the macro's data. |
|
2479 | 2480 | Upon exit, the macro is reloaded with the contents of the file. |
|
2480 | 2481 | |
|
2481 | 2482 | Note: opening at an exact line is only supported under Unix, and some |
|
2482 | 2483 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
2483 | 2484 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
2484 | 2485 | (X)Emacs, vi, jed, pico and joe all do. |
|
2485 | 2486 | |
|
2486 | 2487 | After executing your code, %edit will return as output the code you |
|
2487 | 2488 | typed in the editor (except when it was an existing file). This way |
|
2488 | 2489 | you can reload the code in further invocations of %edit as a variable, |
|
2489 | 2490 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
2490 | 2491 | the output. |
|
2491 | 2492 | |
|
2492 | 2493 | Note that %edit is also available through the alias %ed. |
|
2493 | 2494 | |
|
2494 | 2495 | This is an example of creating a simple function inside the editor and |
|
2495 | 2496 | then modifying it. First, start up the editor:: |
|
2496 | 2497 | |
|
2497 | 2498 | In [1]: ed |
|
2498 | 2499 | Editing... done. Executing edited code... |
|
2499 | 2500 | Out[1]: 'def foo():\\n print "foo() was defined in an editing |
|
2500 | 2501 | session"\\n' |
|
2501 | 2502 | |
|
2502 | 2503 | We can then call the function foo():: |
|
2503 | 2504 | |
|
2504 | 2505 | In [2]: foo() |
|
2505 | 2506 | foo() was defined in an editing session |
|
2506 | 2507 | |
|
2507 | 2508 | Now we edit foo. IPython automatically loads the editor with the |
|
2508 | 2509 | (temporary) file where foo() was previously defined:: |
|
2509 | 2510 | |
|
2510 | 2511 | In [3]: ed foo |
|
2511 | 2512 | Editing... done. Executing edited code... |
|
2512 | 2513 | |
|
2513 | 2514 | And if we call foo() again we get the modified version:: |
|
2514 | 2515 | |
|
2515 | 2516 | In [4]: foo() |
|
2516 | 2517 | foo() has now been changed! |
|
2517 | 2518 | |
|
2518 | 2519 | Here is an example of how to edit a code snippet successive |
|
2519 | 2520 | times. First we call the editor:: |
|
2520 | 2521 | |
|
2521 | 2522 | In [5]: ed |
|
2522 | 2523 | Editing... done. Executing edited code... |
|
2523 | 2524 | hello |
|
2524 | 2525 | Out[5]: "print 'hello'\\n" |
|
2525 | 2526 | |
|
2526 | 2527 | Now we call it again with the previous output (stored in _):: |
|
2527 | 2528 | |
|
2528 | 2529 | In [6]: ed _ |
|
2529 | 2530 | Editing... done. Executing edited code... |
|
2530 | 2531 | hello world |
|
2531 | 2532 | Out[6]: "print 'hello world'\\n" |
|
2532 | 2533 | |
|
2533 | 2534 | Now we call it with the output #8 (stored in _8, also as Out[8]):: |
|
2534 | 2535 | |
|
2535 | 2536 | In [7]: ed _8 |
|
2536 | 2537 | Editing... done. Executing edited code... |
|
2537 | 2538 | hello again |
|
2538 | 2539 | Out[7]: "print 'hello again'\\n" |
|
2539 | 2540 | |
|
2540 | 2541 | |
|
2541 | 2542 | Changing the default editor hook: |
|
2542 | 2543 | |
|
2543 | 2544 | If you wish to write your own editor hook, you can put it in a |
|
2544 | 2545 | configuration file which you load at startup time. The default hook |
|
2545 | 2546 | is defined in the IPython.core.hooks module, and you can use that as a |
|
2546 | 2547 | starting example for further modifications. That file also has |
|
2547 | 2548 | general instructions on how to set a new hook for use once you've |
|
2548 | 2549 | defined it.""" |
|
2549 | 2550 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
2550 | 2551 | |
|
2551 | 2552 | try: |
|
2552 | 2553 | filename, lineno, is_temp = self._find_edit_target(args, opts, last_call) |
|
2553 | 2554 | except MacroToEdit as e: |
|
2554 | 2555 | self._edit_macro(args, e.args[0]) |
|
2555 | 2556 | return |
|
2556 | 2557 | |
|
2557 | 2558 | # do actual editing here |
|
2558 | 2559 | print 'Editing...', |
|
2559 | 2560 | sys.stdout.flush() |
|
2560 | 2561 | try: |
|
2561 | 2562 | # Quote filenames that may have spaces in them |
|
2562 | 2563 | if ' ' in filename: |
|
2563 | 2564 | filename = "'%s'" % filename |
|
2564 | 2565 | self.shell.hooks.editor(filename,lineno) |
|
2565 | 2566 | except TryNext: |
|
2566 | 2567 | warn('Could not open editor') |
|
2567 | 2568 | return |
|
2568 | 2569 | |
|
2569 | 2570 | # XXX TODO: should this be generalized for all string vars? |
|
2570 | 2571 | # For now, this is special-cased to blocks created by cpaste |
|
2571 | 2572 | if args.strip() == 'pasted_block': |
|
2572 | 2573 | self.shell.user_ns['pasted_block'] = file_read(filename) |
|
2573 | 2574 | |
|
2574 | 2575 | if 'x' in opts: # -x prevents actual execution |
|
2575 | 2576 | |
|
2576 | 2577 | else: |
|
2577 | 2578 | print 'done. Executing edited code...' |
|
2578 | 2579 | if 'r' in opts: # Untranslated IPython code |
|
2579 | 2580 | self.shell.run_cell(file_read(filename), |
|
2580 | 2581 | store_history=False) |
|
2581 | 2582 | else: |
|
2582 | 2583 | self.shell.safe_execfile(filename,self.shell.user_ns, |
|
2583 | 2584 | self.shell.user_ns) |
|
2584 | 2585 | |
|
2585 | 2586 | if is_temp: |
|
2586 | 2587 | try: |
|
2587 | 2588 | return open(filename).read() |
|
2588 | 2589 | except IOError,msg: |
|
2589 | 2590 | if msg.filename == filename: |
|
2590 | 2591 | warn('File not found. Did you forget to save?') |
|
2591 | 2592 | return |
|
2592 | 2593 | else: |
|
2593 | 2594 | self.shell.showtraceback() |
|
2594 | 2595 | |
|
2595 | 2596 | def magic_xmode(self,parameter_s = ''): |
|
2596 | 2597 | """Switch modes for the exception handlers. |
|
2597 | 2598 | |
|
2598 | 2599 | Valid modes: Plain, Context and Verbose. |
|
2599 | 2600 | |
|
2600 | 2601 | If called without arguments, acts as a toggle.""" |
|
2601 | 2602 | |
|
2602 | 2603 | def xmode_switch_err(name): |
|
2603 | 2604 | warn('Error changing %s exception modes.\n%s' % |
|
2604 | 2605 | (name,sys.exc_info()[1])) |
|
2605 | 2606 | |
|
2606 | 2607 | shell = self.shell |
|
2607 | 2608 | new_mode = parameter_s.strip().capitalize() |
|
2608 | 2609 | try: |
|
2609 | 2610 | shell.InteractiveTB.set_mode(mode=new_mode) |
|
2610 | 2611 | print 'Exception reporting mode:',shell.InteractiveTB.mode |
|
2611 | 2612 | except: |
|
2612 | 2613 | xmode_switch_err('user') |
|
2613 | 2614 | |
|
2614 | 2615 | def magic_colors(self,parameter_s = ''): |
|
2615 | 2616 | """Switch color scheme for prompts, info system and exception handlers. |
|
2616 | 2617 | |
|
2617 | 2618 | Currently implemented schemes: NoColor, Linux, LightBG. |
|
2618 | 2619 | |
|
2619 | 2620 | Color scheme names are not case-sensitive. |
|
2620 | 2621 | |
|
2621 | 2622 | Examples |
|
2622 | 2623 | -------- |
|
2623 | 2624 | To get a plain black and white terminal:: |
|
2624 | 2625 | |
|
2625 | 2626 | %colors nocolor |
|
2626 | 2627 | """ |
|
2627 | 2628 | |
|
2628 | 2629 | def color_switch_err(name): |
|
2629 | 2630 | warn('Error changing %s color schemes.\n%s' % |
|
2630 | 2631 | (name,sys.exc_info()[1])) |
|
2631 | 2632 | |
|
2632 | 2633 | |
|
2633 | 2634 | new_scheme = parameter_s.strip() |
|
2634 | 2635 | if not new_scheme: |
|
2635 | 2636 | raise UsageError( |
|
2636 | 2637 | "%colors: you must specify a color scheme. See '%colors?'") |
|
2637 | 2638 | return |
|
2638 | 2639 | # local shortcut |
|
2639 | 2640 | shell = self.shell |
|
2640 | 2641 | |
|
2641 | 2642 | import IPython.utils.rlineimpl as readline |
|
2642 | 2643 | |
|
2643 | 2644 | if not shell.colors_force and \ |
|
2644 | 2645 | not readline.have_readline and sys.platform == "win32": |
|
2645 | 2646 | msg = """\ |
|
2646 | 2647 | Proper color support under MS Windows requires the pyreadline library. |
|
2647 | 2648 | You can find it at: |
|
2648 | 2649 | http://ipython.org/pyreadline.html |
|
2649 | 2650 | Gary's readline needs the ctypes module, from: |
|
2650 | 2651 | http://starship.python.net/crew/theller/ctypes |
|
2651 | 2652 | (Note that ctypes is already part of Python versions 2.5 and newer). |
|
2652 | 2653 | |
|
2653 | 2654 | Defaulting color scheme to 'NoColor'""" |
|
2654 | 2655 | new_scheme = 'NoColor' |
|
2655 | 2656 | warn(msg) |
|
2656 | 2657 | |
|
2657 | 2658 | # readline option is 0 |
|
2658 | 2659 | if not shell.colors_force and not shell.has_readline: |
|
2659 | 2660 | new_scheme = 'NoColor' |
|
2660 | 2661 | |
|
2661 | 2662 | # Set prompt colors |
|
2662 | 2663 | try: |
|
2663 | 2664 | shell.prompt_manager.color_scheme = new_scheme |
|
2664 | 2665 | except: |
|
2665 | 2666 | color_switch_err('prompt') |
|
2666 | 2667 | else: |
|
2667 | 2668 | shell.colors = \ |
|
2668 | 2669 | shell.prompt_manager.color_scheme_table.active_scheme_name |
|
2669 | 2670 | # Set exception colors |
|
2670 | 2671 | try: |
|
2671 | 2672 | shell.InteractiveTB.set_colors(scheme = new_scheme) |
|
2672 | 2673 | shell.SyntaxTB.set_colors(scheme = new_scheme) |
|
2673 | 2674 | except: |
|
2674 | 2675 | color_switch_err('exception') |
|
2675 | 2676 | |
|
2676 | 2677 | # Set info (for 'object?') colors |
|
2677 | 2678 | if shell.color_info: |
|
2678 | 2679 | try: |
|
2679 | 2680 | shell.inspector.set_active_scheme(new_scheme) |
|
2680 | 2681 | except: |
|
2681 | 2682 | color_switch_err('object inspector') |
|
2682 | 2683 | else: |
|
2683 | 2684 | shell.inspector.set_active_scheme('NoColor') |
|
2684 | 2685 | |
|
2685 | 2686 | def magic_pprint(self, parameter_s=''): |
|
2686 | 2687 | """Toggle pretty printing on/off.""" |
|
2687 | 2688 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
2688 | 2689 | ptformatter.pprint = bool(1 - ptformatter.pprint) |
|
2689 | 2690 | print 'Pretty printing has been turned', \ |
|
2690 | 2691 | ['OFF','ON'][ptformatter.pprint] |
|
2691 | 2692 | |
|
2692 | 2693 | #...................................................................... |
|
2693 | 2694 | # Functions to implement unix shell-type things |
|
2694 | 2695 | |
|
2695 | 2696 | @skip_doctest |
|
2696 | 2697 | def magic_alias(self, parameter_s = ''): |
|
2697 | 2698 | """Define an alias for a system command. |
|
2698 | 2699 | |
|
2699 | 2700 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
2700 | 2701 | |
|
2701 | 2702 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
2702 | 2703 | params' (from your underlying operating system). |
|
2703 | 2704 | |
|
2704 | 2705 | Aliases have lower precedence than magic functions and Python normal |
|
2705 | 2706 | variables, so if 'foo' is both a Python variable and an alias, the |
|
2706 | 2707 | alias can not be executed until 'del foo' removes the Python variable. |
|
2707 | 2708 | |
|
2708 | 2709 | You can use the %l specifier in an alias definition to represent the |
|
2709 | 2710 | whole line when the alias is called. For example:: |
|
2710 | 2711 | |
|
2711 | 2712 | In [2]: alias bracket echo "Input in brackets: <%l>" |
|
2712 | 2713 | In [3]: bracket hello world |
|
2713 | 2714 | Input in brackets: <hello world> |
|
2714 | 2715 | |
|
2715 | 2716 | You can also define aliases with parameters using %s specifiers (one |
|
2716 | 2717 | per parameter):: |
|
2717 | 2718 | |
|
2718 | 2719 | In [1]: alias parts echo first %s second %s |
|
2719 | 2720 | In [2]: %parts A B |
|
2720 | 2721 | first A second B |
|
2721 | 2722 | In [3]: %parts A |
|
2722 | 2723 | Incorrect number of arguments: 2 expected. |
|
2723 | 2724 | parts is an alias to: 'echo first %s second %s' |
|
2724 | 2725 | |
|
2725 | 2726 | Note that %l and %s are mutually exclusive. You can only use one or |
|
2726 | 2727 | the other in your aliases. |
|
2727 | 2728 | |
|
2728 | 2729 | Aliases expand Python variables just like system calls using ! or !! |
|
2729 | 2730 | do: all expressions prefixed with '$' get expanded. For details of |
|
2730 | 2731 | the semantic rules, see PEP-215: |
|
2731 | 2732 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
2732 | 2733 | IPython for variable expansion. If you want to access a true shell |
|
2733 | 2734 | variable, an extra $ is necessary to prevent its expansion by |
|
2734 | 2735 | IPython:: |
|
2735 | 2736 | |
|
2736 | 2737 | In [6]: alias show echo |
|
2737 | 2738 | In [7]: PATH='A Python string' |
|
2738 | 2739 | In [8]: show $PATH |
|
2739 | 2740 | A Python string |
|
2740 | 2741 | In [9]: show $$PATH |
|
2741 | 2742 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
2742 | 2743 | |
|
2743 | 2744 | You can use the alias facility to acess all of $PATH. See the %rehash |
|
2744 | 2745 | and %rehashx functions, which automatically create aliases for the |
|
2745 | 2746 | contents of your $PATH. |
|
2746 | 2747 | |
|
2747 | 2748 | If called with no parameters, %alias prints the current alias table.""" |
|
2748 | 2749 | |
|
2749 | 2750 | par = parameter_s.strip() |
|
2750 | 2751 | if not par: |
|
2751 | 2752 | stored = self.db.get('stored_aliases', {} ) |
|
2752 | 2753 | aliases = sorted(self.shell.alias_manager.aliases) |
|
2753 | 2754 | # for k, v in stored: |
|
2754 | 2755 | # atab.append(k, v[0]) |
|
2755 | 2756 | |
|
2756 | 2757 | print "Total number of aliases:", len(aliases) |
|
2757 | 2758 | sys.stdout.flush() |
|
2758 | 2759 | return aliases |
|
2759 | 2760 | |
|
2760 | 2761 | # Now try to define a new one |
|
2761 | 2762 | try: |
|
2762 | 2763 | alias,cmd = par.split(None, 1) |
|
2763 | 2764 | except: |
|
2764 | 2765 | print oinspect.getdoc(self.magic_alias) |
|
2765 | 2766 | else: |
|
2766 | 2767 | self.shell.alias_manager.soft_define_alias(alias, cmd) |
|
2767 | 2768 | # end magic_alias |
|
2768 | 2769 | |
|
2769 | 2770 | def magic_unalias(self, parameter_s = ''): |
|
2770 | 2771 | """Remove an alias""" |
|
2771 | 2772 | |
|
2772 | 2773 | aname = parameter_s.strip() |
|
2773 | 2774 | self.shell.alias_manager.undefine_alias(aname) |
|
2774 | 2775 | stored = self.db.get('stored_aliases', {} ) |
|
2775 | 2776 | if aname in stored: |
|
2776 | 2777 | print "Removing %stored alias",aname |
|
2777 | 2778 | del stored[aname] |
|
2778 | 2779 | self.db['stored_aliases'] = stored |
|
2779 | 2780 | |
|
2780 | 2781 | def magic_rehashx(self, parameter_s = ''): |
|
2781 | 2782 | """Update the alias table with all executable files in $PATH. |
|
2782 | 2783 | |
|
2783 | 2784 | This version explicitly checks that every entry in $PATH is a file |
|
2784 | 2785 | with execute access (os.X_OK), so it is much slower than %rehash. |
|
2785 | 2786 | |
|
2786 | 2787 | Under Windows, it checks executability as a match against a |
|
2787 | 2788 | '|'-separated string of extensions, stored in the IPython config |
|
2788 | 2789 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
2789 | 2790 | |
|
2790 | 2791 | This function also resets the root module cache of module completer, |
|
2791 | 2792 | used on slow filesystems. |
|
2792 | 2793 | """ |
|
2793 | 2794 | from IPython.core.alias import InvalidAliasError |
|
2794 | 2795 | |
|
2795 | 2796 | # for the benefit of module completer in ipy_completers.py |
|
2796 | 2797 | del self.shell.db['rootmodules'] |
|
2797 | 2798 | |
|
2798 | 2799 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
2799 | 2800 | os.environ.get('PATH','').split(os.pathsep)] |
|
2800 | 2801 | path = filter(os.path.isdir,path) |
|
2801 | 2802 | |
|
2802 | 2803 | syscmdlist = [] |
|
2803 | 2804 | # Now define isexec in a cross platform manner. |
|
2804 | 2805 | if os.name == 'posix': |
|
2805 | 2806 | isexec = lambda fname:os.path.isfile(fname) and \ |
|
2806 | 2807 | os.access(fname,os.X_OK) |
|
2807 | 2808 | else: |
|
2808 | 2809 | try: |
|
2809 | 2810 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
2810 | 2811 | except KeyError: |
|
2811 | 2812 | winext = 'exe|com|bat|py' |
|
2812 | 2813 | if 'py' not in winext: |
|
2813 | 2814 | winext += '|py' |
|
2814 | 2815 | execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
2815 | 2816 | isexec = lambda fname:os.path.isfile(fname) and execre.match(fname) |
|
2816 | 2817 | savedir = os.getcwdu() |
|
2817 | 2818 | |
|
2818 | 2819 | # Now walk the paths looking for executables to alias. |
|
2819 | 2820 | try: |
|
2820 | 2821 | # write the whole loop for posix/Windows so we don't have an if in |
|
2821 | 2822 | # the innermost part |
|
2822 | 2823 | if os.name == 'posix': |
|
2823 | 2824 | for pdir in path: |
|
2824 | 2825 | os.chdir(pdir) |
|
2825 | 2826 | for ff in os.listdir(pdir): |
|
2826 | 2827 | if isexec(ff): |
|
2827 | 2828 | try: |
|
2828 | 2829 | # Removes dots from the name since ipython |
|
2829 | 2830 | # will assume names with dots to be python. |
|
2830 | 2831 | self.shell.alias_manager.define_alias( |
|
2831 | 2832 | ff.replace('.',''), ff) |
|
2832 | 2833 | except InvalidAliasError: |
|
2833 | 2834 | pass |
|
2834 | 2835 | else: |
|
2835 | 2836 | syscmdlist.append(ff) |
|
2836 | 2837 | else: |
|
2837 | 2838 | no_alias = self.shell.alias_manager.no_alias |
|
2838 | 2839 | for pdir in path: |
|
2839 | 2840 | os.chdir(pdir) |
|
2840 | 2841 | for ff in os.listdir(pdir): |
|
2841 | 2842 | base, ext = os.path.splitext(ff) |
|
2842 | 2843 | if isexec(ff) and base.lower() not in no_alias: |
|
2843 | 2844 | if ext.lower() == '.exe': |
|
2844 | 2845 | ff = base |
|
2845 | 2846 | try: |
|
2846 | 2847 | # Removes dots from the name since ipython |
|
2847 | 2848 | # will assume names with dots to be python. |
|
2848 | 2849 | self.shell.alias_manager.define_alias( |
|
2849 | 2850 | base.lower().replace('.',''), ff) |
|
2850 | 2851 | except InvalidAliasError: |
|
2851 | 2852 | pass |
|
2852 | 2853 | syscmdlist.append(ff) |
|
2853 | 2854 | self.shell.db['syscmdlist'] = syscmdlist |
|
2854 | 2855 | finally: |
|
2855 | 2856 | os.chdir(savedir) |
|
2856 | 2857 | |
|
2857 | 2858 | @skip_doctest |
|
2858 | 2859 | def magic_pwd(self, parameter_s = ''): |
|
2859 | 2860 | """Return the current working directory path. |
|
2860 | 2861 | |
|
2861 | 2862 | Examples |
|
2862 | 2863 | -------- |
|
2863 | 2864 | :: |
|
2864 | 2865 | |
|
2865 | 2866 | In [9]: pwd |
|
2866 | 2867 | Out[9]: '/home/tsuser/sprint/ipython' |
|
2867 | 2868 | """ |
|
2868 | 2869 | return os.getcwdu() |
|
2869 | 2870 | |
|
2870 | 2871 | @skip_doctest |
|
2871 | 2872 | def magic_cd(self, parameter_s=''): |
|
2872 | 2873 | """Change the current working directory. |
|
2873 | 2874 | |
|
2874 | 2875 | This command automatically maintains an internal list of directories |
|
2875 | 2876 | you visit during your IPython session, in the variable _dh. The |
|
2876 | 2877 | command %dhist shows this history nicely formatted. You can also |
|
2877 | 2878 | do 'cd -<tab>' to see directory history conveniently. |
|
2878 | 2879 | |
|
2879 | 2880 | Usage: |
|
2880 | 2881 | |
|
2881 | 2882 | cd 'dir': changes to directory 'dir'. |
|
2882 | 2883 | |
|
2883 | 2884 | cd -: changes to the last visited directory. |
|
2884 | 2885 | |
|
2885 | 2886 | cd -<n>: changes to the n-th directory in the directory history. |
|
2886 | 2887 | |
|
2887 | 2888 | cd --foo: change to directory that matches 'foo' in history |
|
2888 | 2889 | |
|
2889 | 2890 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
2890 | 2891 | (note: cd <bookmark_name> is enough if there is no |
|
2891 | 2892 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
2892 | 2893 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
2893 | 2894 | |
|
2894 | 2895 | Options: |
|
2895 | 2896 | |
|
2896 | 2897 | -q: quiet. Do not print the working directory after the cd command is |
|
2897 | 2898 | executed. By default IPython's cd command does print this directory, |
|
2898 | 2899 | since the default prompts do not display path information. |
|
2899 | 2900 | |
|
2900 | 2901 | Note that !cd doesn't work for this purpose because the shell where |
|
2901 | 2902 | !command runs is immediately discarded after executing 'command'. |
|
2902 | 2903 | |
|
2903 | 2904 | Examples |
|
2904 | 2905 | -------- |
|
2905 | 2906 | :: |
|
2906 | 2907 | |
|
2907 | 2908 | In [10]: cd parent/child |
|
2908 | 2909 | /home/tsuser/parent/child |
|
2909 | 2910 | """ |
|
2910 | 2911 | |
|
2911 | 2912 | parameter_s = parameter_s.strip() |
|
2912 | 2913 | #bkms = self.shell.persist.get("bookmarks",{}) |
|
2913 | 2914 | |
|
2914 | 2915 | oldcwd = os.getcwdu() |
|
2915 | 2916 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
2916 | 2917 | # jump in directory history by number |
|
2917 | 2918 | if numcd: |
|
2918 | 2919 | nn = int(numcd.group(2)) |
|
2919 | 2920 | try: |
|
2920 | 2921 | ps = self.shell.user_ns['_dh'][nn] |
|
2921 | 2922 | except IndexError: |
|
2922 | 2923 | print 'The requested directory does not exist in history.' |
|
2923 | 2924 | return |
|
2924 | 2925 | else: |
|
2925 | 2926 | opts = {} |
|
2926 | 2927 | elif parameter_s.startswith('--'): |
|
2927 | 2928 | ps = None |
|
2928 | 2929 | fallback = None |
|
2929 | 2930 | pat = parameter_s[2:] |
|
2930 | 2931 | dh = self.shell.user_ns['_dh'] |
|
2931 | 2932 | # first search only by basename (last component) |
|
2932 | 2933 | for ent in reversed(dh): |
|
2933 | 2934 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
2934 | 2935 | ps = ent |
|
2935 | 2936 | break |
|
2936 | 2937 | |
|
2937 | 2938 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
2938 | 2939 | fallback = ent |
|
2939 | 2940 | |
|
2940 | 2941 | # if we have no last part match, pick the first full path match |
|
2941 | 2942 | if ps is None: |
|
2942 | 2943 | ps = fallback |
|
2943 | 2944 | |
|
2944 | 2945 | if ps is None: |
|
2945 | 2946 | print "No matching entry in directory history" |
|
2946 | 2947 | return |
|
2947 | 2948 | else: |
|
2948 | 2949 | opts = {} |
|
2949 | 2950 | |
|
2950 | 2951 | |
|
2951 | 2952 | else: |
|
2952 | 2953 | #turn all non-space-escaping backslashes to slashes, |
|
2953 | 2954 | # for c:\windows\directory\names\ |
|
2954 | 2955 | parameter_s = re.sub(r'\\(?! )','/', parameter_s) |
|
2955 | 2956 | opts,ps = self.parse_options(parameter_s,'qb',mode='string') |
|
2956 | 2957 | # jump to previous |
|
2957 | 2958 | if ps == '-': |
|
2958 | 2959 | try: |
|
2959 | 2960 | ps = self.shell.user_ns['_dh'][-2] |
|
2960 | 2961 | except IndexError: |
|
2961 | 2962 | raise UsageError('%cd -: No previous directory to change to.') |
|
2962 | 2963 | # jump to bookmark if needed |
|
2963 | 2964 | else: |
|
2964 | 2965 | if not os.path.isdir(ps) or opts.has_key('b'): |
|
2965 | 2966 | bkms = self.db.get('bookmarks', {}) |
|
2966 | 2967 | |
|
2967 | 2968 | if bkms.has_key(ps): |
|
2968 | 2969 | target = bkms[ps] |
|
2969 | 2970 | print '(bookmark:%s) -> %s' % (ps,target) |
|
2970 | 2971 | ps = target |
|
2971 | 2972 | else: |
|
2972 | 2973 | if opts.has_key('b'): |
|
2973 | 2974 | raise UsageError("Bookmark '%s' not found. " |
|
2974 | 2975 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
2975 | 2976 | |
|
2976 | 2977 | # strip extra quotes on Windows, because os.chdir doesn't like them |
|
2977 | 2978 | ps = unquote_filename(ps) |
|
2978 | 2979 | # at this point ps should point to the target dir |
|
2979 | 2980 | if ps: |
|
2980 | 2981 | try: |
|
2981 | 2982 | os.chdir(os.path.expanduser(ps)) |
|
2982 | 2983 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2983 | 2984 | set_term_title('IPython: ' + abbrev_cwd()) |
|
2984 | 2985 | except OSError: |
|
2985 | 2986 | print sys.exc_info()[1] |
|
2986 | 2987 | else: |
|
2987 | 2988 | cwd = os.getcwdu() |
|
2988 | 2989 | dhist = self.shell.user_ns['_dh'] |
|
2989 | 2990 | if oldcwd != cwd: |
|
2990 | 2991 | dhist.append(cwd) |
|
2991 | 2992 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
2992 | 2993 | |
|
2993 | 2994 | else: |
|
2994 | 2995 | os.chdir(self.shell.home_dir) |
|
2995 | 2996 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
2996 | 2997 | set_term_title('IPython: ' + '~') |
|
2997 | 2998 | cwd = os.getcwdu() |
|
2998 | 2999 | dhist = self.shell.user_ns['_dh'] |
|
2999 | 3000 | |
|
3000 | 3001 | if oldcwd != cwd: |
|
3001 | 3002 | dhist.append(cwd) |
|
3002 | 3003 | self.db['dhist'] = compress_dhist(dhist)[-100:] |
|
3003 | 3004 | if not 'q' in opts and self.shell.user_ns['_dh']: |
|
3004 | 3005 | print self.shell.user_ns['_dh'][-1] |
|
3005 | 3006 | |
|
3006 | 3007 | |
|
3007 | 3008 | def magic_env(self, parameter_s=''): |
|
3008 | 3009 | """List environment variables.""" |
|
3009 | 3010 | |
|
3010 | 3011 | return dict(os.environ) |
|
3011 | 3012 | |
|
3012 | 3013 | def magic_pushd(self, parameter_s=''): |
|
3013 | 3014 | """Place the current dir on stack and change directory. |
|
3014 | 3015 | |
|
3015 | 3016 | Usage:\\ |
|
3016 | 3017 | %pushd ['dirname'] |
|
3017 | 3018 | """ |
|
3018 | 3019 | |
|
3019 | 3020 | dir_s = self.shell.dir_stack |
|
3020 | 3021 | tgt = os.path.expanduser(unquote_filename(parameter_s)) |
|
3021 | 3022 | cwd = os.getcwdu().replace(self.home_dir,'~') |
|
3022 | 3023 | if tgt: |
|
3023 | 3024 | self.magic_cd(parameter_s) |
|
3024 | 3025 | dir_s.insert(0,cwd) |
|
3025 | 3026 | return self.magic_dirs() |
|
3026 | 3027 | |
|
3027 | 3028 | def magic_popd(self, parameter_s=''): |
|
3028 | 3029 | """Change to directory popped off the top of the stack. |
|
3029 | 3030 | """ |
|
3030 | 3031 | if not self.shell.dir_stack: |
|
3031 | 3032 | raise UsageError("%popd on empty stack") |
|
3032 | 3033 | top = self.shell.dir_stack.pop(0) |
|
3033 | 3034 | self.magic_cd(top) |
|
3034 | 3035 | print "popd ->",top |
|
3035 | 3036 | |
|
3036 | 3037 | def magic_dirs(self, parameter_s=''): |
|
3037 | 3038 | """Return the current directory stack.""" |
|
3038 | 3039 | |
|
3039 | 3040 | return self.shell.dir_stack |
|
3040 | 3041 | |
|
3041 | 3042 | def magic_dhist(self, parameter_s=''): |
|
3042 | 3043 | """Print your history of visited directories. |
|
3043 | 3044 | |
|
3044 | 3045 | %dhist -> print full history\\ |
|
3045 | 3046 | %dhist n -> print last n entries only\\ |
|
3046 | 3047 | %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\ |
|
3047 | 3048 | |
|
3048 | 3049 | This history is automatically maintained by the %cd command, and |
|
3049 | 3050 | always available as the global list variable _dh. You can use %cd -<n> |
|
3050 | 3051 | to go to directory number <n>. |
|
3051 | 3052 | |
|
3052 | 3053 | Note that most of time, you should view directory history by entering |
|
3053 | 3054 | cd -<TAB>. |
|
3054 | 3055 | |
|
3055 | 3056 | """ |
|
3056 | 3057 | |
|
3057 | 3058 | dh = self.shell.user_ns['_dh'] |
|
3058 | 3059 | if parameter_s: |
|
3059 | 3060 | try: |
|
3060 | 3061 | args = map(int,parameter_s.split()) |
|
3061 | 3062 | except: |
|
3062 | 3063 | self.arg_err(Magic.magic_dhist) |
|
3063 | 3064 | return |
|
3064 | 3065 | if len(args) == 1: |
|
3065 | 3066 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
3066 | 3067 | elif len(args) == 2: |
|
3067 | 3068 | ini,fin = args |
|
3068 | 3069 | else: |
|
3069 | 3070 | self.arg_err(Magic.magic_dhist) |
|
3070 | 3071 | return |
|
3071 | 3072 | else: |
|
3072 | 3073 | ini,fin = 0,len(dh) |
|
3073 | 3074 | nlprint(dh, |
|
3074 | 3075 | header = 'Directory history (kept in _dh)', |
|
3075 | 3076 | start=ini,stop=fin) |
|
3076 | 3077 | |
|
3077 | 3078 | @skip_doctest |
|
3078 | 3079 | def magic_sc(self, parameter_s=''): |
|
3079 | 3080 | """Shell capture - execute a shell command and capture its output. |
|
3080 | 3081 | |
|
3081 | 3082 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
3082 | 3083 | |
|
3083 | 3084 | You should use the form 'var = !command' instead. Example: |
|
3084 | 3085 | |
|
3085 | 3086 | "%sc -l myfiles = ls ~" should now be written as |
|
3086 | 3087 | |
|
3087 | 3088 | "myfiles = !ls ~" |
|
3088 | 3089 | |
|
3089 | 3090 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
3090 | 3091 | below. |
|
3091 | 3092 | |
|
3092 | 3093 | -- |
|
3093 | 3094 | %sc [options] varname=command |
|
3094 | 3095 | |
|
3095 | 3096 | IPython will run the given command using commands.getoutput(), and |
|
3096 | 3097 | will then update the user's interactive namespace with a variable |
|
3097 | 3098 | called varname, containing the value of the call. Your command can |
|
3098 | 3099 | contain shell wildcards, pipes, etc. |
|
3099 | 3100 | |
|
3100 | 3101 | The '=' sign in the syntax is mandatory, and the variable name you |
|
3101 | 3102 | supply must follow Python's standard conventions for valid names. |
|
3102 | 3103 | |
|
3103 | 3104 | (A special format without variable name exists for internal use) |
|
3104 | 3105 | |
|
3105 | 3106 | Options: |
|
3106 | 3107 | |
|
3107 | 3108 | -l: list output. Split the output on newlines into a list before |
|
3108 | 3109 | assigning it to the given variable. By default the output is stored |
|
3109 | 3110 | as a single string. |
|
3110 | 3111 | |
|
3111 | 3112 | -v: verbose. Print the contents of the variable. |
|
3112 | 3113 | |
|
3113 | 3114 | In most cases you should not need to split as a list, because the |
|
3114 | 3115 | returned value is a special type of string which can automatically |
|
3115 | 3116 | provide its contents either as a list (split on newlines) or as a |
|
3116 | 3117 | space-separated string. These are convenient, respectively, either |
|
3117 | 3118 | for sequential processing or to be passed to a shell command. |
|
3118 | 3119 | |
|
3119 | 3120 | For example:: |
|
3120 | 3121 | |
|
3121 | 3122 | # Capture into variable a |
|
3122 | 3123 | In [1]: sc a=ls *py |
|
3123 | 3124 | |
|
3124 | 3125 | # a is a string with embedded newlines |
|
3125 | 3126 | In [2]: a |
|
3126 | 3127 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
3127 | 3128 | |
|
3128 | 3129 | # which can be seen as a list: |
|
3129 | 3130 | In [3]: a.l |
|
3130 | 3131 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
3131 | 3132 | |
|
3132 | 3133 | # or as a whitespace-separated string: |
|
3133 | 3134 | In [4]: a.s |
|
3134 | 3135 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
3135 | 3136 | |
|
3136 | 3137 | # a.s is useful to pass as a single command line: |
|
3137 | 3138 | In [5]: !wc -l $a.s |
|
3138 | 3139 | 146 setup.py |
|
3139 | 3140 | 130 win32_manual_post_install.py |
|
3140 | 3141 | 276 total |
|
3141 | 3142 | |
|
3142 | 3143 | # while the list form is useful to loop over: |
|
3143 | 3144 | In [6]: for f in a.l: |
|
3144 | 3145 | ...: !wc -l $f |
|
3145 | 3146 | ...: |
|
3146 | 3147 | 146 setup.py |
|
3147 | 3148 | 130 win32_manual_post_install.py |
|
3148 | 3149 | |
|
3149 | 3150 | Similarly, the lists returned by the -l option are also special, in |
|
3150 | 3151 | the sense that you can equally invoke the .s attribute on them to |
|
3151 | 3152 | automatically get a whitespace-separated string from their contents:: |
|
3152 | 3153 | |
|
3153 | 3154 | In [7]: sc -l b=ls *py |
|
3154 | 3155 | |
|
3155 | 3156 | In [8]: b |
|
3156 | 3157 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
3157 | 3158 | |
|
3158 | 3159 | In [9]: b.s |
|
3159 | 3160 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
3160 | 3161 | |
|
3161 | 3162 | In summary, both the lists and strings used for output capture have |
|
3162 | 3163 | the following special attributes:: |
|
3163 | 3164 | |
|
3164 | 3165 | .l (or .list) : value as list. |
|
3165 | 3166 | .n (or .nlstr): value as newline-separated string. |
|
3166 | 3167 | .s (or .spstr): value as space-separated string. |
|
3167 | 3168 | """ |
|
3168 | 3169 | |
|
3169 | 3170 | opts,args = self.parse_options(parameter_s,'lv') |
|
3170 | 3171 | # Try to get a variable name and command to run |
|
3171 | 3172 | try: |
|
3172 | 3173 | # the variable name must be obtained from the parse_options |
|
3173 | 3174 | # output, which uses shlex.split to strip options out. |
|
3174 | 3175 | var,_ = args.split('=',1) |
|
3175 | 3176 | var = var.strip() |
|
3176 | 3177 | # But the command has to be extracted from the original input |
|
3177 | 3178 | # parameter_s, not on what parse_options returns, to avoid the |
|
3178 | 3179 | # quote stripping which shlex.split performs on it. |
|
3179 | 3180 | _,cmd = parameter_s.split('=',1) |
|
3180 | 3181 | except ValueError: |
|
3181 | 3182 | var,cmd = '','' |
|
3182 | 3183 | # If all looks ok, proceed |
|
3183 | 3184 | split = 'l' in opts |
|
3184 | 3185 | out = self.shell.getoutput(cmd, split=split) |
|
3185 | 3186 | if opts.has_key('v'): |
|
3186 | 3187 | print '%s ==\n%s' % (var,pformat(out)) |
|
3187 | 3188 | if var: |
|
3188 | 3189 | self.shell.user_ns.update({var:out}) |
|
3189 | 3190 | else: |
|
3190 | 3191 | return out |
|
3191 | 3192 | |
|
3192 | 3193 | def magic_sx(self, parameter_s=''): |
|
3193 | 3194 | """Shell execute - run a shell command and capture its output. |
|
3194 | 3195 | |
|
3195 | 3196 | %sx command |
|
3196 | 3197 | |
|
3197 | 3198 | IPython will run the given command using commands.getoutput(), and |
|
3198 | 3199 | return the result formatted as a list (split on '\\n'). Since the |
|
3199 | 3200 | output is _returned_, it will be stored in ipython's regular output |
|
3200 | 3201 | cache Out[N] and in the '_N' automatic variables. |
|
3201 | 3202 | |
|
3202 | 3203 | Notes: |
|
3203 | 3204 | |
|
3204 | 3205 | 1) If an input line begins with '!!', then %sx is automatically |
|
3205 | 3206 | invoked. That is, while:: |
|
3206 | 3207 | |
|
3207 | 3208 | !ls |
|
3208 | 3209 | |
|
3209 | 3210 | causes ipython to simply issue system('ls'), typing:: |
|
3210 | 3211 | |
|
3211 | 3212 | !!ls |
|
3212 | 3213 | |
|
3213 | 3214 | is a shorthand equivalent to:: |
|
3214 | 3215 | |
|
3215 | 3216 | %sx ls |
|
3216 | 3217 | |
|
3217 | 3218 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
3218 | 3219 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
3219 | 3220 | to process line-oriented shell output via further python commands. |
|
3220 | 3221 | %sc is meant to provide much finer control, but requires more |
|
3221 | 3222 | typing. |
|
3222 | 3223 | |
|
3223 | 3224 | 3) Just like %sc -l, this is a list with special attributes: |
|
3224 | 3225 | :: |
|
3225 | 3226 | |
|
3226 | 3227 | .l (or .list) : value as list. |
|
3227 | 3228 | .n (or .nlstr): value as newline-separated string. |
|
3228 | 3229 | .s (or .spstr): value as whitespace-separated string. |
|
3229 | 3230 | |
|
3230 | 3231 | This is very useful when trying to use such lists as arguments to |
|
3231 | 3232 | system commands.""" |
|
3232 | 3233 | |
|
3233 | 3234 | if parameter_s: |
|
3234 | 3235 | return self.shell.getoutput(parameter_s) |
|
3235 | 3236 | |
|
3236 | 3237 | |
|
3237 | 3238 | def magic_bookmark(self, parameter_s=''): |
|
3238 | 3239 | """Manage IPython's bookmark system. |
|
3239 | 3240 | |
|
3240 | 3241 | %bookmark <name> - set bookmark to current dir |
|
3241 | 3242 | %bookmark <name> <dir> - set bookmark to <dir> |
|
3242 | 3243 | %bookmark -l - list all bookmarks |
|
3243 | 3244 | %bookmark -d <name> - remove bookmark |
|
3244 | 3245 | %bookmark -r - remove all bookmarks |
|
3245 | 3246 | |
|
3246 | 3247 | You can later on access a bookmarked folder with:: |
|
3247 | 3248 | |
|
3248 | 3249 | %cd -b <name> |
|
3249 | 3250 | |
|
3250 | 3251 | or simply '%cd <name>' if there is no directory called <name> AND |
|
3251 | 3252 | there is such a bookmark defined. |
|
3252 | 3253 | |
|
3253 | 3254 | Your bookmarks persist through IPython sessions, but they are |
|
3254 | 3255 | associated with each profile.""" |
|
3255 | 3256 | |
|
3256 | 3257 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
3257 | 3258 | if len(args) > 2: |
|
3258 | 3259 | raise UsageError("%bookmark: too many arguments") |
|
3259 | 3260 | |
|
3260 | 3261 | bkms = self.db.get('bookmarks',{}) |
|
3261 | 3262 | |
|
3262 | 3263 | if opts.has_key('d'): |
|
3263 | 3264 | try: |
|
3264 | 3265 | todel = args[0] |
|
3265 | 3266 | except IndexError: |
|
3266 | 3267 | raise UsageError( |
|
3267 | 3268 | "%bookmark -d: must provide a bookmark to delete") |
|
3268 | 3269 | else: |
|
3269 | 3270 | try: |
|
3270 | 3271 | del bkms[todel] |
|
3271 | 3272 | except KeyError: |
|
3272 | 3273 | raise UsageError( |
|
3273 | 3274 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) |
|
3274 | 3275 | |
|
3275 | 3276 | elif opts.has_key('r'): |
|
3276 | 3277 | bkms = {} |
|
3277 | 3278 | elif opts.has_key('l'): |
|
3278 | 3279 | bks = bkms.keys() |
|
3279 | 3280 | bks.sort() |
|
3280 | 3281 | if bks: |
|
3281 | 3282 | size = max(map(len,bks)) |
|
3282 | 3283 | else: |
|
3283 | 3284 | size = 0 |
|
3284 | 3285 | fmt = '%-'+str(size)+'s -> %s' |
|
3285 | 3286 | print 'Current bookmarks:' |
|
3286 | 3287 | for bk in bks: |
|
3287 | 3288 | print fmt % (bk,bkms[bk]) |
|
3288 | 3289 | else: |
|
3289 | 3290 | if not args: |
|
3290 | 3291 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
3291 | 3292 | elif len(args)==1: |
|
3292 | 3293 | bkms[args[0]] = os.getcwdu() |
|
3293 | 3294 | elif len(args)==2: |
|
3294 | 3295 | bkms[args[0]] = args[1] |
|
3295 | 3296 | self.db['bookmarks'] = bkms |
|
3296 | 3297 | |
|
3297 | 3298 | def magic_pycat(self, parameter_s=''): |
|
3298 | 3299 | """Show a syntax-highlighted file through a pager. |
|
3299 | 3300 | |
|
3300 | 3301 | This magic is similar to the cat utility, but it will assume the file |
|
3301 | 3302 | to be Python source and will show it with syntax highlighting. """ |
|
3302 | 3303 | |
|
3303 | 3304 | try: |
|
3304 | 3305 | filename = get_py_filename(parameter_s) |
|
3305 | 3306 | cont = file_read(filename) |
|
3306 | 3307 | except IOError: |
|
3307 | 3308 | try: |
|
3308 | 3309 | cont = eval(parameter_s,self.user_ns) |
|
3309 | 3310 | except NameError: |
|
3310 | 3311 | cont = None |
|
3311 | 3312 | if cont is None: |
|
3312 | 3313 | print "Error: no such file or variable" |
|
3313 | 3314 | return |
|
3314 | 3315 | |
|
3315 | 3316 | page.page(self.shell.pycolorize(cont)) |
|
3316 | 3317 | |
|
3317 | 3318 | def magic_quickref(self,arg): |
|
3318 | 3319 | """ Show a quick reference sheet """ |
|
3319 | 3320 | import IPython.core.usage |
|
3320 | 3321 | qr = IPython.core.usage.quick_reference + self.magic_magic('-brief') |
|
3321 | 3322 | |
|
3322 | 3323 | page.page(qr) |
|
3323 | 3324 | |
|
3324 | 3325 | def magic_doctest_mode(self,parameter_s=''): |
|
3325 | 3326 | """Toggle doctest mode on and off. |
|
3326 | 3327 | |
|
3327 | 3328 | This mode is intended to make IPython behave as much as possible like a |
|
3328 | 3329 | plain Python shell, from the perspective of how its prompts, exceptions |
|
3329 | 3330 | and output look. This makes it easy to copy and paste parts of a |
|
3330 | 3331 | session into doctests. It does so by: |
|
3331 | 3332 | |
|
3332 | 3333 | - Changing the prompts to the classic ``>>>`` ones. |
|
3333 | 3334 | - Changing the exception reporting mode to 'Plain'. |
|
3334 | 3335 | - Disabling pretty-printing of output. |
|
3335 | 3336 | |
|
3336 | 3337 | Note that IPython also supports the pasting of code snippets that have |
|
3337 | 3338 | leading '>>>' and '...' prompts in them. This means that you can paste |
|
3338 | 3339 | doctests from files or docstrings (even if they have leading |
|
3339 | 3340 | whitespace), and the code will execute correctly. You can then use |
|
3340 | 3341 | '%history -t' to see the translated history; this will give you the |
|
3341 | 3342 | input after removal of all the leading prompts and whitespace, which |
|
3342 | 3343 | can be pasted back into an editor. |
|
3343 | 3344 | |
|
3344 | 3345 | With these features, you can switch into this mode easily whenever you |
|
3345 | 3346 | need to do testing and changes to doctests, without having to leave |
|
3346 | 3347 | your existing IPython session. |
|
3347 | 3348 | """ |
|
3348 | 3349 | |
|
3349 | 3350 | from IPython.utils.ipstruct import Struct |
|
3350 | 3351 | |
|
3351 | 3352 | # Shorthands |
|
3352 | 3353 | shell = self.shell |
|
3353 | 3354 | pm = shell.prompt_manager |
|
3354 | 3355 | meta = shell.meta |
|
3355 | 3356 | disp_formatter = self.shell.display_formatter |
|
3356 | 3357 | ptformatter = disp_formatter.formatters['text/plain'] |
|
3357 | 3358 | # dstore is a data store kept in the instance metadata bag to track any |
|
3358 | 3359 | # changes we make, so we can undo them later. |
|
3359 | 3360 | dstore = meta.setdefault('doctest_mode',Struct()) |
|
3360 | 3361 | save_dstore = dstore.setdefault |
|
3361 | 3362 | |
|
3362 | 3363 | # save a few values we'll need to recover later |
|
3363 | 3364 | mode = save_dstore('mode',False) |
|
3364 | 3365 | save_dstore('rc_pprint',ptformatter.pprint) |
|
3365 | 3366 | save_dstore('xmode',shell.InteractiveTB.mode) |
|
3366 | 3367 | save_dstore('rc_separate_out',shell.separate_out) |
|
3367 | 3368 | save_dstore('rc_separate_out2',shell.separate_out2) |
|
3368 | 3369 | save_dstore('rc_prompts_pad_left',pm.justify) |
|
3369 | 3370 | save_dstore('rc_separate_in',shell.separate_in) |
|
3370 | 3371 | save_dstore('rc_plain_text_only',disp_formatter.plain_text_only) |
|
3371 | 3372 | save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template)) |
|
3372 | 3373 | |
|
3373 | 3374 | if mode == False: |
|
3374 | 3375 | # turn on |
|
3375 | 3376 | pm.in_template = '>>> ' |
|
3376 | 3377 | pm.in2_template = '... ' |
|
3377 | 3378 | pm.out_template = '' |
|
3378 | 3379 | |
|
3379 | 3380 | # Prompt separators like plain python |
|
3380 | 3381 | shell.separate_in = '' |
|
3381 | 3382 | shell.separate_out = '' |
|
3382 | 3383 | shell.separate_out2 = '' |
|
3383 | 3384 | |
|
3384 | 3385 | pm.justify = False |
|
3385 | 3386 | |
|
3386 | 3387 | ptformatter.pprint = False |
|
3387 | 3388 | disp_formatter.plain_text_only = True |
|
3388 | 3389 | |
|
3389 | 3390 | shell.magic_xmode('Plain') |
|
3390 | 3391 | else: |
|
3391 | 3392 | # turn off |
|
3392 | 3393 | pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates |
|
3393 | 3394 | |
|
3394 | 3395 | shell.separate_in = dstore.rc_separate_in |
|
3395 | 3396 | |
|
3396 | 3397 | shell.separate_out = dstore.rc_separate_out |
|
3397 | 3398 | shell.separate_out2 = dstore.rc_separate_out2 |
|
3398 | 3399 | |
|
3399 | 3400 | pm.justify = dstore.rc_prompts_pad_left |
|
3400 | 3401 | |
|
3401 | 3402 | ptformatter.pprint = dstore.rc_pprint |
|
3402 | 3403 | disp_formatter.plain_text_only = dstore.rc_plain_text_only |
|
3403 | 3404 | |
|
3404 | 3405 | shell.magic_xmode(dstore.xmode) |
|
3405 | 3406 | |
|
3406 | 3407 | # Store new mode and inform |
|
3407 | 3408 | dstore.mode = bool(1-int(mode)) |
|
3408 | 3409 | mode_label = ['OFF','ON'][dstore.mode] |
|
3409 | 3410 | print 'Doctest mode is:', mode_label |
|
3410 | 3411 | |
|
3411 | 3412 | def magic_gui(self, parameter_s=''): |
|
3412 | 3413 | """Enable or disable IPython GUI event loop integration. |
|
3413 | 3414 | |
|
3414 | 3415 | %gui [GUINAME] |
|
3415 | 3416 | |
|
3416 | 3417 | This magic replaces IPython's threaded shells that were activated |
|
3417 | 3418 | using the (pylab/wthread/etc.) command line flags. GUI toolkits |
|
3418 | 3419 | can now be enabled at runtime and keyboard |
|
3419 | 3420 | interrupts should work without any problems. The following toolkits |
|
3420 | 3421 | are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX):: |
|
3421 | 3422 | |
|
3422 | 3423 | %gui wx # enable wxPython event loop integration |
|
3423 | 3424 | %gui qt4|qt # enable PyQt4 event loop integration |
|
3424 | 3425 | %gui gtk # enable PyGTK event loop integration |
|
3425 | 3426 | %gui gtk3 # enable Gtk3 event loop integration |
|
3426 | 3427 | %gui tk # enable Tk event loop integration |
|
3427 | 3428 | %gui OSX # enable Cocoa event loop integration |
|
3428 | 3429 | # (requires %matplotlib 1.1) |
|
3429 | 3430 | %gui # disable all event loop integration |
|
3430 | 3431 | |
|
3431 | 3432 | WARNING: after any of these has been called you can simply create |
|
3432 | 3433 | an application object, but DO NOT start the event loop yourself, as |
|
3433 | 3434 | we have already handled that. |
|
3434 | 3435 | """ |
|
3435 | 3436 | opts, arg = self.parse_options(parameter_s, '') |
|
3436 | 3437 | if arg=='': arg = None |
|
3437 | 3438 | try: |
|
3438 | 3439 | return self.enable_gui(arg) |
|
3439 | 3440 | except Exception as e: |
|
3440 | 3441 | # print simple error message, rather than traceback if we can't |
|
3441 | 3442 | # hook up the GUI |
|
3442 | 3443 | error(str(e)) |
|
3443 | 3444 | |
|
3444 | 3445 | def magic_install_ext(self, parameter_s): |
|
3445 | 3446 | """Download and install an extension from a URL, e.g.:: |
|
3446 | 3447 | |
|
3447 | 3448 | %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py |
|
3448 | 3449 | |
|
3449 | 3450 | The URL should point to an importable Python module - either a .py file |
|
3450 | 3451 | or a .zip file. |
|
3451 | 3452 | |
|
3452 | 3453 | Parameters: |
|
3453 | 3454 | |
|
3454 | 3455 | -n filename : Specify a name for the file, rather than taking it from |
|
3455 | 3456 | the URL. |
|
3456 | 3457 | """ |
|
3457 | 3458 | opts, args = self.parse_options(parameter_s, 'n:') |
|
3458 | 3459 | try: |
|
3459 | 3460 | filename = self.extension_manager.install_extension(args, opts.get('n')) |
|
3460 | 3461 | except ValueError as e: |
|
3461 | 3462 | print e |
|
3462 | 3463 | return |
|
3463 | 3464 | |
|
3464 | 3465 | filename = os.path.basename(filename) |
|
3465 | 3466 | print "Installed %s. To use it, type:" % filename |
|
3466 | 3467 | print " %%load_ext %s" % os.path.splitext(filename)[0] |
|
3467 | 3468 | |
|
3468 | 3469 | |
|
3469 | 3470 | def magic_load_ext(self, module_str): |
|
3470 | 3471 | """Load an IPython extension by its module name.""" |
|
3471 | 3472 | return self.extension_manager.load_extension(module_str) |
|
3472 | 3473 | |
|
3473 | 3474 | def magic_unload_ext(self, module_str): |
|
3474 | 3475 | """Unload an IPython extension by its module name.""" |
|
3475 | 3476 | self.extension_manager.unload_extension(module_str) |
|
3476 | 3477 | |
|
3477 | 3478 | def magic_reload_ext(self, module_str): |
|
3478 | 3479 | """Reload an IPython extension by its module name.""" |
|
3479 | 3480 | self.extension_manager.reload_extension(module_str) |
|
3480 | 3481 | |
|
3481 | 3482 | def magic_install_profiles(self, s): |
|
3482 | 3483 | """%install_profiles has been deprecated.""" |
|
3483 | 3484 | print '\n'.join([ |
|
3484 | 3485 | "%install_profiles has been deprecated.", |
|
3485 | 3486 | "Use `ipython profile list` to view available profiles.", |
|
3486 | 3487 | "Requesting a profile with `ipython profile create <name>`", |
|
3487 | 3488 | "or `ipython --profile=<name>` will start with the bundled", |
|
3488 | 3489 | "profile of that name if it exists." |
|
3489 | 3490 | ]) |
|
3490 | 3491 | |
|
3491 | 3492 | def magic_install_default_config(self, s): |
|
3492 | 3493 | """%install_default_config has been deprecated.""" |
|
3493 | 3494 | print '\n'.join([ |
|
3494 | 3495 | "%install_default_config has been deprecated.", |
|
3495 | 3496 | "Use `ipython profile create <name>` to initialize a profile", |
|
3496 | 3497 | "with the default config files.", |
|
3497 | 3498 | "Add `--reset` to overwrite already existing config files with defaults." |
|
3498 | 3499 | ]) |
|
3499 | 3500 | |
|
3500 | 3501 | # Pylab support: simple wrappers that activate pylab, load gui input |
|
3501 | 3502 | # handling and modify slightly %run |
|
3502 | 3503 | |
|
3503 | 3504 | @skip_doctest |
|
3504 | 3505 | def _pylab_magic_run(self, parameter_s=''): |
|
3505 | 3506 | Magic.magic_run(self, parameter_s, |
|
3506 | 3507 | runner=mpl_runner(self.shell.safe_execfile)) |
|
3507 | 3508 | |
|
3508 | 3509 | _pylab_magic_run.__doc__ = magic_run.__doc__ |
|
3509 | 3510 | |
|
3510 | 3511 | @skip_doctest |
|
3511 | 3512 | def magic_pylab(self, s): |
|
3512 | 3513 | """Load numpy and matplotlib to work interactively. |
|
3513 | 3514 | |
|
3514 | 3515 | %pylab [GUINAME] |
|
3515 | 3516 | |
|
3516 | 3517 | This function lets you activate pylab (matplotlib, numpy and |
|
3517 | 3518 | interactive support) at any point during an IPython session. |
|
3518 | 3519 | |
|
3519 | 3520 | It will import at the top level numpy as np, pyplot as plt, matplotlib, |
|
3520 | 3521 | pylab and mlab, as well as all names from numpy and pylab. |
|
3521 | 3522 | |
|
3522 | 3523 | If you are using the inline matplotlib backend for embedded figures, |
|
3523 | 3524 | you can adjust its behavior via the %config magic:: |
|
3524 | 3525 | |
|
3525 | 3526 | # enable SVG figures, necessary for SVG+XHTML export in the qtconsole |
|
3526 | 3527 | In [1]: %config InlineBackend.figure_format = 'svg' |
|
3527 | 3528 | |
|
3528 | 3529 | # change the behavior of closing all figures at the end of each |
|
3529 | 3530 | # execution (cell), or allowing reuse of active figures across |
|
3530 | 3531 | # cells: |
|
3531 | 3532 | In [2]: %config InlineBackend.close_figures = False |
|
3532 | 3533 | |
|
3533 | 3534 | Parameters |
|
3534 | 3535 | ---------- |
|
3535 | 3536 | guiname : optional |
|
3536 | 3537 | One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', |
|
3537 | 3538 | 'osx' or 'tk'). If given, the corresponding Matplotlib backend is |
|
3538 | 3539 | used, otherwise matplotlib's default (which you can override in your |
|
3539 | 3540 | matplotlib config file) is used. |
|
3540 | 3541 | |
|
3541 | 3542 | Examples |
|
3542 | 3543 | -------- |
|
3543 | 3544 | In this case, where the MPL default is TkAgg:: |
|
3544 | 3545 | |
|
3545 | 3546 | In [2]: %pylab |
|
3546 | 3547 | |
|
3547 | 3548 | Welcome to pylab, a matplotlib-based Python environment. |
|
3548 | 3549 | Backend in use: TkAgg |
|
3549 | 3550 | For more information, type 'help(pylab)'. |
|
3550 | 3551 | |
|
3551 | 3552 | But you can explicitly request a different backend:: |
|
3552 | 3553 | |
|
3553 | 3554 | In [3]: %pylab qt |
|
3554 | 3555 | |
|
3555 | 3556 | Welcome to pylab, a matplotlib-based Python environment. |
|
3556 | 3557 | Backend in use: Qt4Agg |
|
3557 | 3558 | For more information, type 'help(pylab)'. |
|
3558 | 3559 | """ |
|
3559 | 3560 | |
|
3560 | 3561 | if Application.initialized(): |
|
3561 | 3562 | app = Application.instance() |
|
3562 | 3563 | try: |
|
3563 | 3564 | import_all_status = app.pylab_import_all |
|
3564 | 3565 | except AttributeError: |
|
3565 | 3566 | import_all_status = True |
|
3566 | 3567 | else: |
|
3567 | 3568 | import_all_status = True |
|
3568 | 3569 | |
|
3569 | 3570 | self.shell.enable_pylab(s, import_all=import_all_status) |
|
3570 | 3571 | |
|
3571 | 3572 | def magic_tb(self, s): |
|
3572 | 3573 | """Print the last traceback with the currently active exception mode. |
|
3573 | 3574 | |
|
3574 | 3575 | See %xmode for changing exception reporting modes.""" |
|
3575 | 3576 | self.shell.showtraceback() |
|
3576 | 3577 | |
|
3577 | 3578 | @skip_doctest |
|
3578 | 3579 | def magic_precision(self, s=''): |
|
3579 | 3580 | """Set floating point precision for pretty printing. |
|
3580 | 3581 | |
|
3581 | 3582 | Can set either integer precision or a format string. |
|
3582 | 3583 | |
|
3583 | 3584 | If numpy has been imported and precision is an int, |
|
3584 | 3585 | numpy display precision will also be set, via ``numpy.set_printoptions``. |
|
3585 | 3586 | |
|
3586 | 3587 | If no argument is given, defaults will be restored. |
|
3587 | 3588 | |
|
3588 | 3589 | Examples |
|
3589 | 3590 | -------- |
|
3590 | 3591 | :: |
|
3591 | 3592 | |
|
3592 | 3593 | In [1]: from math import pi |
|
3593 | 3594 | |
|
3594 | 3595 | In [2]: %precision 3 |
|
3595 | 3596 | Out[2]: u'%.3f' |
|
3596 | 3597 | |
|
3597 | 3598 | In [3]: pi |
|
3598 | 3599 | Out[3]: 3.142 |
|
3599 | 3600 | |
|
3600 | 3601 | In [4]: %precision %i |
|
3601 | 3602 | Out[4]: u'%i' |
|
3602 | 3603 | |
|
3603 | 3604 | In [5]: pi |
|
3604 | 3605 | Out[5]: 3 |
|
3605 | 3606 | |
|
3606 | 3607 | In [6]: %precision %e |
|
3607 | 3608 | Out[6]: u'%e' |
|
3608 | 3609 | |
|
3609 | 3610 | In [7]: pi**10 |
|
3610 | 3611 | Out[7]: 9.364805e+04 |
|
3611 | 3612 | |
|
3612 | 3613 | In [8]: %precision |
|
3613 | 3614 | Out[8]: u'%r' |
|
3614 | 3615 | |
|
3615 | 3616 | In [9]: pi**10 |
|
3616 | 3617 | Out[9]: 93648.047476082982 |
|
3617 | 3618 | |
|
3618 | 3619 | """ |
|
3619 | 3620 | |
|
3620 | 3621 | ptformatter = self.shell.display_formatter.formatters['text/plain'] |
|
3621 | 3622 | ptformatter.float_precision = s |
|
3622 | 3623 | return ptformatter.float_format |
|
3623 | 3624 | |
|
3624 | 3625 | |
|
3625 | 3626 | @magic_arguments.magic_arguments() |
|
3626 | 3627 | @magic_arguments.argument( |
|
3627 | 3628 | '-e', '--export', action='store_true', default=False, |
|
3628 | 3629 | help='Export IPython history as a notebook. The filename argument ' |
|
3629 | 3630 | 'is used to specify the notebook name and format. For example ' |
|
3630 | 3631 | 'a filename of notebook.ipynb will result in a notebook name ' |
|
3631 | 3632 | 'of "notebook" and a format of "xml". Likewise using a ".json" ' |
|
3632 | 3633 | 'or ".py" file extension will write the notebook in the json ' |
|
3633 | 3634 | 'or py formats.' |
|
3634 | 3635 | ) |
|
3635 | 3636 | @magic_arguments.argument( |
|
3636 | 3637 | '-f', '--format', |
|
3637 | 3638 | help='Convert an existing IPython notebook to a new format. This option ' |
|
3638 | 3639 | 'specifies the new format and can have the values: xml, json, py. ' |
|
3639 | 3640 | 'The target filename is chosen automatically based on the new ' |
|
3640 | 3641 | 'format. The filename argument gives the name of the source file.' |
|
3641 | 3642 | ) |
|
3642 | 3643 | @magic_arguments.argument( |
|
3643 | 3644 | 'filename', type=unicode, |
|
3644 | 3645 | help='Notebook name or filename' |
|
3645 | 3646 | ) |
|
3646 | 3647 | def magic_notebook(self, s): |
|
3647 | 3648 | """Export and convert IPython notebooks. |
|
3648 | 3649 | |
|
3649 | 3650 | This function can export the current IPython history to a notebook file |
|
3650 | 3651 | or can convert an existing notebook file into a different format. For |
|
3651 | 3652 | example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb". |
|
3652 | 3653 | To export the history to "foo.py" do "%notebook -e foo.py". To convert |
|
3653 | 3654 | "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible |
|
3654 | 3655 | formats include (json/ipynb, py). |
|
3655 | 3656 | """ |
|
3656 | 3657 | args = magic_arguments.parse_argstring(self.magic_notebook, s) |
|
3657 | 3658 | |
|
3658 | 3659 | from IPython.nbformat import current |
|
3659 | 3660 | args.filename = unquote_filename(args.filename) |
|
3660 | 3661 | if args.export: |
|
3661 | 3662 | fname, name, format = current.parse_filename(args.filename) |
|
3662 | 3663 | cells = [] |
|
3663 | 3664 | hist = list(self.history_manager.get_range()) |
|
3664 | 3665 | for session, prompt_number, input in hist[:-1]: |
|
3665 | 3666 | cells.append(current.new_code_cell(prompt_number=prompt_number, input=input)) |
|
3666 | 3667 | worksheet = current.new_worksheet(cells=cells) |
|
3667 | 3668 | nb = current.new_notebook(name=name,worksheets=[worksheet]) |
|
3668 | 3669 | with io.open(fname, 'w', encoding='utf-8') as f: |
|
3669 | 3670 | current.write(nb, f, format); |
|
3670 | 3671 | elif args.format is not None: |
|
3671 | 3672 | old_fname, old_name, old_format = current.parse_filename(args.filename) |
|
3672 | 3673 | new_format = args.format |
|
3673 | 3674 | if new_format == u'xml': |
|
3674 | 3675 | raise ValueError('Notebooks cannot be written as xml.') |
|
3675 | 3676 | elif new_format == u'ipynb' or new_format == u'json': |
|
3676 | 3677 | new_fname = old_name + u'.ipynb' |
|
3677 | 3678 | new_format = u'json' |
|
3678 | 3679 | elif new_format == u'py': |
|
3679 | 3680 | new_fname = old_name + u'.py' |
|
3680 | 3681 | else: |
|
3681 | 3682 | raise ValueError('Invalid notebook format: %s' % new_format) |
|
3682 | 3683 | with io.open(old_fname, 'r', encoding='utf-8') as f: |
|
3683 | 3684 | nb = current.read(f, old_format) |
|
3684 | 3685 | with io.open(new_fname, 'w', encoding='utf-8') as f: |
|
3685 | 3686 | current.write(nb, f, new_format) |
|
3686 | 3687 | |
|
3687 | 3688 | def magic_config(self, s): |
|
3688 | 3689 | """configure IPython |
|
3689 | 3690 | |
|
3690 | 3691 | %config Class[.trait=value] |
|
3691 | 3692 | |
|
3692 | 3693 | This magic exposes most of the IPython config system. Any |
|
3693 | 3694 | Configurable class should be able to be configured with the simple |
|
3694 | 3695 | line:: |
|
3695 | 3696 | |
|
3696 | 3697 | %config Class.trait=value |
|
3697 | 3698 | |
|
3698 | 3699 | Where `value` will be resolved in the user's namespace, if it is an |
|
3699 | 3700 | expression or variable name. |
|
3700 | 3701 | |
|
3701 | 3702 | Examples |
|
3702 | 3703 | -------- |
|
3703 | 3704 | |
|
3704 | 3705 | To see what classes are available for config, pass no arguments:: |
|
3705 | 3706 | |
|
3706 | 3707 | In [1]: %config |
|
3707 | 3708 | Available objects for config: |
|
3708 | 3709 | TerminalInteractiveShell |
|
3709 | 3710 | HistoryManager |
|
3710 | 3711 | PrefilterManager |
|
3711 | 3712 | AliasManager |
|
3712 | 3713 | IPCompleter |
|
3713 | 3714 | PromptManager |
|
3714 | 3715 | DisplayFormatter |
|
3715 | 3716 | |
|
3716 | 3717 | To view what is configurable on a given class, just pass the class |
|
3717 | 3718 | name:: |
|
3718 | 3719 | |
|
3719 | 3720 | In [2]: %config IPCompleter |
|
3720 | 3721 | IPCompleter options |
|
3721 | 3722 | ----------------- |
|
3722 | 3723 | IPCompleter.omit__names=<Enum> |
|
3723 | 3724 | Current: 2 |
|
3724 | 3725 | Choices: (0, 1, 2) |
|
3725 | 3726 | Instruct the completer to omit private method names |
|
3726 | 3727 | Specifically, when completing on ``object.<tab>``. |
|
3727 | 3728 | When 2 [default]: all names that start with '_' will be excluded. |
|
3728 | 3729 | When 1: all 'magic' names (``__foo__``) will be excluded. |
|
3729 | 3730 | When 0: nothing will be excluded. |
|
3730 | 3731 | IPCompleter.merge_completions=<CBool> |
|
3731 | 3732 | Current: True |
|
3732 | 3733 | Whether to merge completion results into a single list |
|
3733 | 3734 | If False, only the completion results from the first non-empty completer |
|
3734 | 3735 | will be returned. |
|
3735 | 3736 | IPCompleter.limit_to__all__=<CBool> |
|
3736 | 3737 | Current: False |
|
3737 | 3738 | Instruct the completer to use __all__ for the completion |
|
3738 | 3739 | Specifically, when completing on ``object.<tab>``. |
|
3739 | 3740 | When True: only those names in obj.__all__ will be included. |
|
3740 | 3741 | When False [default]: the __all__ attribute is ignored |
|
3741 | 3742 | IPCompleter.greedy=<CBool> |
|
3742 | 3743 | Current: False |
|
3743 | 3744 | Activate greedy completion |
|
3744 | 3745 | This will enable completion on elements of lists, results of function calls, |
|
3745 | 3746 | etc., but can be unsafe because the code is actually evaluated on TAB. |
|
3746 | 3747 | |
|
3747 | 3748 | but the real use is in setting values:: |
|
3748 | 3749 | |
|
3749 | 3750 | In [3]: %config IPCompleter.greedy = True |
|
3750 | 3751 | |
|
3751 | 3752 | and these values are read from the user_ns if they are variables:: |
|
3752 | 3753 | |
|
3753 | 3754 | In [4]: feeling_greedy=False |
|
3754 | 3755 | |
|
3755 | 3756 | In [5]: %config IPCompleter.greedy = feeling_greedy |
|
3756 | 3757 | |
|
3757 | 3758 | """ |
|
3758 | 3759 | from IPython.config.loader import Config |
|
3759 | 3760 | # some IPython objects are Configurable, but do not yet have |
|
3760 | 3761 | # any configurable traits. Exclude them from the effects of |
|
3761 | 3762 | # this magic, as their presence is just noise: |
|
3762 | 3763 | configurables = [ c for c in self.configurables if c.__class__.class_traits(config=True) ] |
|
3763 | 3764 | classnames = [ c.__class__.__name__ for c in configurables ] |
|
3764 | 3765 | |
|
3765 | 3766 | line = s.strip() |
|
3766 | 3767 | if not line: |
|
3767 | 3768 | # print available configurable names |
|
3768 | 3769 | print "Available objects for config:" |
|
3769 | 3770 | for name in classnames: |
|
3770 | 3771 | print " ", name |
|
3771 | 3772 | return |
|
3772 | 3773 | elif line in classnames: |
|
3773 | 3774 | # `%config TerminalInteractiveShell` will print trait info for |
|
3774 | 3775 | # TerminalInteractiveShell |
|
3775 | 3776 | c = configurables[classnames.index(line)] |
|
3776 | 3777 | cls = c.__class__ |
|
3777 | 3778 | help = cls.class_get_help(c) |
|
3778 | 3779 | # strip leading '--' from cl-args: |
|
3779 | 3780 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) |
|
3780 | 3781 | print help |
|
3781 | 3782 | return |
|
3782 | 3783 | elif '=' not in line: |
|
3783 | 3784 | raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line) |
|
3784 | 3785 | |
|
3785 | 3786 | |
|
3786 | 3787 | # otherwise, assume we are setting configurables. |
|
3787 | 3788 | # leave quotes on args when splitting, because we want |
|
3788 | 3789 | # unquoted args to eval in user_ns |
|
3789 | 3790 | cfg = Config() |
|
3790 | 3791 | exec "cfg."+line in locals(), self.user_ns |
|
3791 | 3792 | |
|
3792 | 3793 | for configurable in configurables: |
|
3793 | 3794 | try: |
|
3794 | 3795 | configurable.update_config(cfg) |
|
3795 | 3796 | except Exception as e: |
|
3796 | 3797 | error(e) |
|
3797 | 3798 | |
|
3798 | 3799 | # end Magic |
@@ -1,139 +1,140 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """ |
|
3 | 3 | Simple utility for splitting user input. This is used by both inputsplitter and |
|
4 | 4 | prefilter. |
|
5 | 5 | |
|
6 | 6 | Authors: |
|
7 | 7 | |
|
8 | 8 | * Brian Granger |
|
9 | 9 | * Fernando Perez |
|
10 | 10 | """ |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Copyright (C) 2008-2011 The IPython Development Team |
|
14 | 14 | # |
|
15 | 15 | # Distributed under the terms of the BSD License. The full license is in |
|
16 | 16 | # the file COPYING, distributed as part of this software. |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | # Imports |
|
21 | 21 | #----------------------------------------------------------------------------- |
|
22 | 22 | |
|
23 | 23 | import re |
|
24 | 24 | import sys |
|
25 | 25 | |
|
26 | 26 | from IPython.utils import py3compat |
|
27 | from IPython.utils.encoding import get_stream_enc | |
|
27 | 28 | |
|
28 | 29 | #----------------------------------------------------------------------------- |
|
29 | 30 | # Main function |
|
30 | 31 | #----------------------------------------------------------------------------- |
|
31 | 32 | |
|
32 | 33 | # RegExp for splitting line contents into pre-char//first word-method//rest. |
|
33 | 34 | # For clarity, each group in on one line. |
|
34 | 35 | |
|
35 | 36 | # WARNING: update the regexp if the escapes in interactiveshell are changed, as |
|
36 | 37 | # they are hardwired in. |
|
37 | 38 | |
|
38 | 39 | # Although it's not solely driven by the regex, note that: |
|
39 | 40 | # ,;/% only trigger if they are the first character on the line |
|
40 | 41 | # ! and !! trigger if they are first char(s) *or* follow an indent |
|
41 | 42 | # ? triggers as first or last char. |
|
42 | 43 | |
|
43 | 44 | line_split = re.compile(""" |
|
44 | 45 | ^(\s*) # any leading space |
|
45 | 46 | ([,;/%]|!!?|\?\??)? # escape character or characters |
|
46 | 47 | \s*(%?[\w\.\*]*) # function/method, possibly with leading % |
|
47 | 48 | # to correctly treat things like '?%magic' |
|
48 | 49 | (.*?$|$) # rest of line |
|
49 | 50 | """, re.VERBOSE) |
|
50 | 51 | |
|
51 | 52 | def split_user_input(line, pattern=None): |
|
52 | 53 | """Split user input into initial whitespace, escape character, function part |
|
53 | 54 | and the rest. |
|
54 | 55 | """ |
|
55 | 56 | # We need to ensure that the rest of this routine deals only with unicode |
|
56 |
encoding = |
|
|
57 | encoding = get_stream_enc(sys.stdin, 'utf-8') | |
|
57 | 58 | line = py3compat.cast_unicode(line, encoding) |
|
58 | 59 | |
|
59 | 60 | if pattern is None: |
|
60 | 61 | pattern = line_split |
|
61 | 62 | match = pattern.match(line) |
|
62 | 63 | if not match: |
|
63 | 64 | # print "match failed for line '%s'" % line |
|
64 | 65 | try: |
|
65 | 66 | ifun, the_rest = line.split(None,1) |
|
66 | 67 | except ValueError: |
|
67 | 68 | # print "split failed for line '%s'" % line |
|
68 | 69 | ifun, the_rest = line, u'' |
|
69 | 70 | pre = re.match('^(\s*)(.*)',line).groups()[0] |
|
70 | 71 | esc = "" |
|
71 | 72 | else: |
|
72 | 73 | pre, esc, ifun, the_rest = match.groups() |
|
73 | 74 | |
|
74 | 75 | #print 'line:<%s>' % line # dbg |
|
75 | 76 | #print 'pre <%s> ifun <%s> rest <%s>' % (pre,ifun.strip(),the_rest) # dbg |
|
76 | 77 | return pre, esc or '', ifun.strip(), the_rest.lstrip() |
|
77 | 78 | |
|
78 | 79 | class LineInfo(object): |
|
79 | 80 | """A single line of input and associated info. |
|
80 | 81 | |
|
81 | 82 | Includes the following as properties: |
|
82 | 83 | |
|
83 | 84 | line |
|
84 | 85 | The original, raw line |
|
85 | 86 | |
|
86 | 87 | continue_prompt |
|
87 | 88 | Is this line a continuation in a sequence of multiline input? |
|
88 | 89 | |
|
89 | 90 | pre |
|
90 | 91 | Any leading whitespace. |
|
91 | 92 | |
|
92 | 93 | esc |
|
93 | 94 | The escape character(s) in pre or the empty string if there isn't one. |
|
94 | 95 | Note that '!!' and '??' are possible values for esc. Otherwise it will |
|
95 | 96 | always be a single character. |
|
96 | 97 | |
|
97 | 98 | ifun |
|
98 | 99 | The 'function part', which is basically the maximal initial sequence |
|
99 | 100 | of valid python identifiers and the '.' character. This is what is |
|
100 | 101 | checked for alias and magic transformations, used for auto-calling, |
|
101 | 102 | etc. In contrast to Python identifiers, it may start with "%" and contain |
|
102 | 103 | "*". |
|
103 | 104 | |
|
104 | 105 | the_rest |
|
105 | 106 | Everything else on the line. |
|
106 | 107 | """ |
|
107 | 108 | def __init__(self, line, continue_prompt=False): |
|
108 | 109 | self.line = line |
|
109 | 110 | self.continue_prompt = continue_prompt |
|
110 | 111 | self.pre, self.esc, self.ifun, self.the_rest = split_user_input(line) |
|
111 | 112 | |
|
112 | 113 | self.pre_char = self.pre.strip() |
|
113 | 114 | if self.pre_char: |
|
114 | 115 | self.pre_whitespace = '' # No whitespace allowd before esc chars |
|
115 | 116 | else: |
|
116 | 117 | self.pre_whitespace = self.pre |
|
117 | 118 | |
|
118 | 119 | self._oinfo = None |
|
119 | 120 | |
|
120 | 121 | def ofind(self, ip): |
|
121 | 122 | """Do a full, attribute-walking lookup of the ifun in the various |
|
122 | 123 | namespaces for the given IPython InteractiveShell instance. |
|
123 | 124 | |
|
124 | 125 | Return a dict with keys: found,obj,ospace,ismagic |
|
125 | 126 | |
|
126 | 127 | Note: can cause state changes because of calling getattr, but should |
|
127 | 128 | only be run if autocall is on and if the line hasn't matched any |
|
128 | 129 | other, less dangerous handlers. |
|
129 | 130 | |
|
130 | 131 | Does cache the results of the call, so can be called multiple times |
|
131 | 132 | without worrying about *further* damaging state. |
|
132 | 133 | """ |
|
133 | 134 | if not self._oinfo: |
|
134 | 135 | # ip.shell._ofind is actually on the Magic class! |
|
135 | 136 | self._oinfo = ip.shell._ofind(self.ifun) |
|
136 | 137 | return self._oinfo |
|
137 | 138 | |
|
138 | 139 | def __str__(self): |
|
139 | 140 | return "LineInfo [%s|%s|%s|%s]" %(self.pre, self.esc, self.ifun, self.the_rest) |
@@ -1,75 +1,75 b'' | |||
|
1 | 1 | # coding: utf-8 |
|
2 | 2 | """Tests for the compilerop module. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2010-2011 The IPython Development Team. |
|
6 | 6 | # |
|
7 | 7 | # Distributed under the terms of the BSD License. |
|
8 | 8 | # |
|
9 | 9 | # The full license is in the file COPYING.txt, distributed with this software. |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Imports |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | from __future__ import print_function |
|
16 | 16 | |
|
17 | 17 | # Stdlib imports |
|
18 | 18 | import linecache |
|
19 | 19 | import sys |
|
20 | 20 | |
|
21 | 21 | # Third-party imports |
|
22 | 22 | import nose.tools as nt |
|
23 | 23 | |
|
24 | 24 | # Our own imports |
|
25 | 25 | from IPython.core import compilerop |
|
26 | 26 | from IPython.utils import py3compat |
|
27 | 27 | |
|
28 | 28 | #----------------------------------------------------------------------------- |
|
29 | 29 | # Test functions |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | |
|
32 | 32 | def test_code_name(): |
|
33 | 33 | code = 'x=1' |
|
34 | 34 | name = compilerop.code_name(code) |
|
35 | 35 | nt.assert_true(name.startswith('<ipython-input-0')) |
|
36 | 36 | |
|
37 | 37 | |
|
38 | 38 | def test_code_name2(): |
|
39 | 39 | code = 'x=1' |
|
40 | 40 | name = compilerop.code_name(code, 9) |
|
41 | 41 | nt.assert_true(name.startswith('<ipython-input-9')) |
|
42 | 42 | |
|
43 | 43 | |
|
44 | 44 | def test_cache(): |
|
45 | 45 | """Test the compiler correctly compiles and caches inputs |
|
46 | 46 | """ |
|
47 | 47 | cp = compilerop.CachingCompiler() |
|
48 | 48 | ncache = len(linecache.cache) |
|
49 | 49 | cp.cache('x=1') |
|
50 | 50 | nt.assert_true(len(linecache.cache) > ncache) |
|
51 | 51 | |
|
52 | 52 | def setUp(): |
|
53 | 53 | # Check we're in a proper Python 2 environment (some imports, such |
|
54 | 54 | # as GTK, can change the default encoding, which can hide bugs.) |
|
55 |
nt.assert_equal( |
|
|
55 | nt.assert_equal(sys.getdefaultencoding(), "utf-8" if py3compat.PY3 else "ascii") | |
|
56 | 56 | |
|
57 | 57 | def test_cache_unicode(): |
|
58 | 58 | cp = compilerop.CachingCompiler() |
|
59 | 59 | ncache = len(linecache.cache) |
|
60 | 60 | cp.cache(u"t = 'ΕΎΔΔΕ‘Δ'") |
|
61 | 61 | nt.assert_true(len(linecache.cache) > ncache) |
|
62 | 62 | |
|
63 | 63 | def test_compiler_check_cache(): |
|
64 | 64 | """Test the compiler properly manages the cache. |
|
65 | 65 | """ |
|
66 | 66 | # Rather simple-minded tests that just exercise the API |
|
67 | 67 | cp = compilerop.CachingCompiler() |
|
68 | 68 | cp.cache('x=1', 99) |
|
69 | 69 | # Ensure now that after clearing the cache, our entries survive |
|
70 | 70 | cp.check_cache() |
|
71 | 71 | for k in linecache.cache: |
|
72 | 72 | if k.startswith('<ipython-input-99'): |
|
73 | 73 | break |
|
74 | 74 | else: |
|
75 | 75 | raise AssertionError('Entry for input-99 missing from linecache') |
@@ -1,151 +1,151 b'' | |||
|
1 | 1 | # coding: utf-8 |
|
2 | 2 | """Tests for the IPython tab-completion machinery. |
|
3 | 3 | """ |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Module imports |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | |
|
8 | 8 | # stdlib |
|
9 | 9 | import os |
|
10 | 10 | import shutil |
|
11 | 11 | import sys |
|
12 | 12 | import tempfile |
|
13 | 13 | import unittest |
|
14 | 14 | from datetime import datetime |
|
15 | 15 | |
|
16 | 16 | # third party |
|
17 | 17 | import nose.tools as nt |
|
18 | 18 | |
|
19 | 19 | # our own packages |
|
20 | 20 | from IPython.config.loader import Config |
|
21 | 21 | from IPython.utils.tempdir import TemporaryDirectory |
|
22 | 22 | from IPython.core.history import HistoryManager, extract_hist_ranges |
|
23 | 23 | from IPython.utils import py3compat |
|
24 | 24 | |
|
25 | 25 | def setUp(): |
|
26 |
nt.assert_equal( |
|
|
26 | nt.assert_equal(sys.getdefaultencoding(), "utf-8" if py3compat.PY3 else "ascii") | |
|
27 | 27 | |
|
28 | 28 | def test_history(): |
|
29 | 29 | ip = get_ipython() |
|
30 | 30 | with TemporaryDirectory() as tmpdir: |
|
31 | 31 | hist_manager_ori = ip.history_manager |
|
32 | 32 | hist_file = os.path.join(tmpdir, 'history.sqlite') |
|
33 | 33 | try: |
|
34 | 34 | ip.history_manager = HistoryManager(shell=ip, hist_file=hist_file) |
|
35 | 35 | hist = [u'a=1', u'def f():\n test = 1\n return test', u"b='β¬ΓΒΎΓ·Γ'"] |
|
36 | 36 | for i, h in enumerate(hist, start=1): |
|
37 | 37 | ip.history_manager.store_inputs(i, h) |
|
38 | 38 | |
|
39 | 39 | ip.history_manager.db_log_output = True |
|
40 | 40 | # Doesn't match the input, but we'll just check it's stored. |
|
41 | 41 | ip.history_manager.output_hist_reprs[3] = "spam" |
|
42 | 42 | ip.history_manager.store_output(3) |
|
43 | 43 | |
|
44 | 44 | nt.assert_equal(ip.history_manager.input_hist_raw, [''] + hist) |
|
45 | 45 | |
|
46 | 46 | # Detailed tests for _get_range_session |
|
47 | 47 | grs = ip.history_manager._get_range_session |
|
48 | 48 | nt.assert_equal(list(grs(start=2,stop=-1)), zip([0], [2], hist[1:-1])) |
|
49 | 49 | nt.assert_equal(list(grs(start=-2)), zip([0,0], [2,3], hist[-2:])) |
|
50 | 50 | nt.assert_equal(list(grs(output=True)), zip([0,0,0], [1,2,3], zip(hist, [None,None,'spam']))) |
|
51 | 51 | |
|
52 | 52 | # Check whether specifying a range beyond the end of the current |
|
53 | 53 | # session results in an error (gh-804) |
|
54 | 54 | ip.magic('%hist 2-500') |
|
55 | 55 | |
|
56 | 56 | # Check that we can write non-ascii characters to a file |
|
57 | 57 | ip.magic("%%hist -f %s" % os.path.join(tmpdir, "test1")) |
|
58 | 58 | ip.magic("%%hist -pf %s" % os.path.join(tmpdir, "test2")) |
|
59 | 59 | ip.magic("%%hist -nf %s" % os.path.join(tmpdir, "test3")) |
|
60 | 60 | ip.magic("%%save %s 1-10" % os.path.join(tmpdir, "test4")) |
|
61 | 61 | |
|
62 | 62 | # New session |
|
63 | 63 | ip.history_manager.reset() |
|
64 | 64 | newcmds = ["z=5","class X(object):\n pass", "k='p'"] |
|
65 | 65 | for i, cmd in enumerate(newcmds, start=1): |
|
66 | 66 | ip.history_manager.store_inputs(i, cmd) |
|
67 | 67 | gothist = ip.history_manager.get_range(start=1, stop=4) |
|
68 | 68 | nt.assert_equal(list(gothist), zip([0,0,0],[1,2,3], newcmds)) |
|
69 | 69 | # Previous session: |
|
70 | 70 | gothist = ip.history_manager.get_range(-1, 1, 4) |
|
71 | 71 | nt.assert_equal(list(gothist), zip([1,1,1],[1,2,3], hist)) |
|
72 | 72 | |
|
73 | 73 | # Check get_hist_tail |
|
74 | 74 | gothist = ip.history_manager.get_tail(4, output=True, |
|
75 | 75 | include_latest=True) |
|
76 | 76 | expected = [(1, 3, (hist[-1], "spam")), |
|
77 | 77 | (2, 1, (newcmds[0], None)), |
|
78 | 78 | (2, 2, (newcmds[1], None)), |
|
79 | 79 | (2, 3, (newcmds[2], None)),] |
|
80 | 80 | nt.assert_equal(list(gothist), expected) |
|
81 | 81 | |
|
82 | 82 | gothist = ip.history_manager.get_tail(2) |
|
83 | 83 | expected = [(2, 1, newcmds[0]), |
|
84 | 84 | (2, 2, newcmds[1])] |
|
85 | 85 | nt.assert_equal(list(gothist), expected) |
|
86 | 86 | |
|
87 | 87 | # Check get_hist_search |
|
88 | 88 | gothist = ip.history_manager.search("*test*") |
|
89 | 89 | nt.assert_equal(list(gothist), [(1,2,hist[1])] ) |
|
90 | 90 | gothist = ip.history_manager.search("b*", output=True) |
|
91 | 91 | nt.assert_equal(list(gothist), [(1,3,(hist[2],"spam"))] ) |
|
92 | 92 | |
|
93 | 93 | # Cross testing: check that magic %save can get previous session. |
|
94 | 94 | testfilename = os.path.realpath(os.path.join(tmpdir, "test.py")) |
|
95 | 95 | ip.magic_save(testfilename + " ~1/1-3") |
|
96 | 96 | with py3compat.open(testfilename) as testfile: |
|
97 | 97 | nt.assert_equal(testfile.read(), |
|
98 | 98 | u"# coding: utf-8\n" + u"\n".join(hist)) |
|
99 | 99 | |
|
100 | 100 | # Duplicate line numbers - check that it doesn't crash, and |
|
101 | 101 | # gets a new session |
|
102 | 102 | ip.history_manager.store_inputs(1, "rogue") |
|
103 | 103 | ip.history_manager.writeout_cache() |
|
104 | 104 | nt.assert_equal(ip.history_manager.session_number, 3) |
|
105 | 105 | finally: |
|
106 | 106 | # Restore history manager |
|
107 | 107 | ip.history_manager = hist_manager_ori |
|
108 | 108 | |
|
109 | 109 | |
|
110 | 110 | def test_extract_hist_ranges(): |
|
111 | 111 | instr = "1 2/3 ~4/5-6 ~4/7-~4/9 ~9/2-~7/5" |
|
112 | 112 | expected = [(0, 1, 2), # 0 == current session |
|
113 | 113 | (2, 3, 4), |
|
114 | 114 | (-4, 5, 7), |
|
115 | 115 | (-4, 7, 10), |
|
116 | 116 | (-9, 2, None), # None == to end |
|
117 | 117 | (-8, 1, None), |
|
118 | 118 | (-7, 1, 6)] |
|
119 | 119 | actual = list(extract_hist_ranges(instr)) |
|
120 | 120 | nt.assert_equal(actual, expected) |
|
121 | 121 | |
|
122 | 122 | def test_magic_rerun(): |
|
123 | 123 | """Simple test for %rerun (no args -> rerun last line)""" |
|
124 | 124 | ip = get_ipython() |
|
125 | 125 | ip.run_cell("a = 10", store_history=True) |
|
126 | 126 | ip.run_cell("a += 1", store_history=True) |
|
127 | 127 | nt.assert_equal(ip.user_ns["a"], 11) |
|
128 | 128 | ip.run_cell("%rerun", store_history=True) |
|
129 | 129 | nt.assert_equal(ip.user_ns["a"], 12) |
|
130 | 130 | |
|
131 | 131 | def test_timestamp_type(): |
|
132 | 132 | ip = get_ipython() |
|
133 | 133 | info = ip.history_manager.get_session_info() |
|
134 | 134 | nt.assert_true(isinstance(info[1], datetime)) |
|
135 | 135 | |
|
136 | 136 | def test_hist_file_config(): |
|
137 | 137 | cfg = Config() |
|
138 | 138 | tfile = tempfile.NamedTemporaryFile(delete=False) |
|
139 | 139 | cfg.HistoryManager.hist_file = tfile.name |
|
140 | 140 | try: |
|
141 | 141 | hm = HistoryManager(shell=get_ipython(), config=cfg) |
|
142 | 142 | nt.assert_equals(hm.hist_file, cfg.HistoryManager.hist_file) |
|
143 | 143 | finally: |
|
144 | 144 | try: |
|
145 | 145 | os.remove(tfile.name) |
|
146 | 146 | except OSError: |
|
147 | 147 | # same catch as in testing.tools.TempFileMixin |
|
148 | 148 | # On Windows, even though we close the file, we still can't |
|
149 | 149 | # delete it. I have no clue why |
|
150 | 150 | pass |
|
151 | 151 |
@@ -1,3708 +1,3708 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | # module pyparsing.py |
|
3 | 3 | # |
|
4 | 4 | # Copyright (c) 2003-2009 Paul T. McGuire |
|
5 | 5 | # |
|
6 | 6 | # Permission is hereby granted, free of charge, to any person obtaining |
|
7 | 7 | # a copy of this software and associated documentation files (the |
|
8 | 8 | # "Software"), to deal in the Software without restriction, including |
|
9 | 9 | # without limitation the rights to use, copy, modify, merge, publish, |
|
10 | 10 | # distribute, sublicense, and/or sell copies of the Software, and to |
|
11 | 11 | # permit persons to whom the Software is furnished to do so, subject to |
|
12 | 12 | # the following conditions: |
|
13 | 13 | # |
|
14 | 14 | # The above copyright notice and this permission notice shall be |
|
15 | 15 | # included in all copies or substantial portions of the Software. |
|
16 | 16 | # |
|
17 | 17 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|
18 | 18 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
19 | 19 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
20 | 20 | # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|
21 | 21 | # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|
22 | 22 | # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
23 | 23 | # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
24 | 24 | # |
|
25 | 25 | #from __future__ import generators |
|
26 | 26 | |
|
27 | 27 | __doc__ = \ |
|
28 | 28 | """ |
|
29 | 29 | pyparsing module - Classes and methods to define and execute parsing grammars |
|
30 | 30 | |
|
31 | 31 | The pyparsing module is an alternative approach to creating and executing simple grammars, |
|
32 | 32 | vs. the traditional lex/yacc approach, or the use of regular expressions. With pyparsing, you |
|
33 | 33 | don't need to learn a new syntax for defining grammars or matching expressions - the parsing module |
|
34 | 34 | provides a library of classes that you use to construct the grammar directly in Python. |
|
35 | 35 | |
|
36 | 36 | Here is a program to parse "Hello, World!" (or any greeting of the form "<salutation>, <addressee>!"):: |
|
37 | 37 | |
|
38 | 38 | from pyparsing import Word, alphas |
|
39 | 39 | |
|
40 | 40 | # define grammar of a greeting |
|
41 | 41 | greet = Word( alphas ) + "," + Word( alphas ) + "!" |
|
42 | 42 | |
|
43 | 43 | hello = "Hello, World!" |
|
44 | 44 | print hello, "->", greet.parseString( hello ) |
|
45 | 45 | |
|
46 | 46 | The program outputs the following:: |
|
47 | 47 | |
|
48 | 48 | Hello, World! -> ['Hello', ',', 'World', '!'] |
|
49 | 49 | |
|
50 | 50 | The Python representation of the grammar is quite readable, owing to the self-explanatory |
|
51 | 51 | class names, and the use of '+', '|' and '^' operators. |
|
52 | 52 | |
|
53 | 53 | The parsed results returned from parseString() can be accessed as a nested list, a dictionary, or an |
|
54 | 54 | object with named attributes. |
|
55 | 55 | |
|
56 | 56 | The pyparsing module handles some of the problems that are typically vexing when writing text parsers: |
|
57 | 57 | - extra or missing whitespace (the above program will also handle "Hello,World!", "Hello , World !", etc.) |
|
58 | 58 | - quoted strings |
|
59 | 59 | - embedded comments |
|
60 | 60 | """ |
|
61 | 61 | |
|
62 | 62 | __version__ = "1.5.2" |
|
63 | 63 | __versionTime__ = "17 February 2009 19:45" |
|
64 | 64 | __author__ = "Paul McGuire <ptmcg@users.sourceforge.net>" |
|
65 | 65 | |
|
66 | 66 | import string |
|
67 | 67 | from weakref import ref as wkref |
|
68 | 68 | import copy |
|
69 | 69 | import sys |
|
70 | 70 | import warnings |
|
71 | 71 | import re |
|
72 | 72 | import sre_constants |
|
73 | 73 | #~ sys.stderr.write( "testing pyparsing module, version %s, %s\n" % (__version__,__versionTime__ ) ) |
|
74 | 74 | |
|
75 | 75 | __all__ = [ |
|
76 | 76 | 'And', 'CaselessKeyword', 'CaselessLiteral', 'CharsNotIn', 'Combine', 'Dict', 'Each', 'Empty', |
|
77 | 77 | 'FollowedBy', 'Forward', 'GoToColumn', 'Group', 'Keyword', 'LineEnd', 'LineStart', 'Literal', |
|
78 | 78 | 'MatchFirst', 'NoMatch', 'NotAny', 'OneOrMore', 'OnlyOnce', 'Optional', 'Or', |
|
79 | 79 | 'ParseBaseException', 'ParseElementEnhance', 'ParseException', 'ParseExpression', 'ParseFatalException', |
|
80 | 80 | 'ParseResults', 'ParseSyntaxException', 'ParserElement', 'QuotedString', 'RecursiveGrammarException', |
|
81 | 81 | 'Regex', 'SkipTo', 'StringEnd', 'StringStart', 'Suppress', 'Token', 'TokenConverter', 'Upcase', |
|
82 | 82 | 'White', 'Word', 'WordEnd', 'WordStart', 'ZeroOrMore', |
|
83 | 83 | 'alphanums', 'alphas', 'alphas8bit', 'anyCloseTag', 'anyOpenTag', 'cStyleComment', 'col', |
|
84 | 84 | 'commaSeparatedList', 'commonHTMLEntity', 'countedArray', 'cppStyleComment', 'dblQuotedString', |
|
85 | 85 | 'dblSlashComment', 'delimitedList', 'dictOf', 'downcaseTokens', 'empty', 'getTokensEndLoc', 'hexnums', |
|
86 | 86 | 'htmlComment', 'javaStyleComment', 'keepOriginalText', 'line', 'lineEnd', 'lineStart', 'lineno', |
|
87 | 87 | 'makeHTMLTags', 'makeXMLTags', 'matchOnlyAtCol', 'matchPreviousExpr', 'matchPreviousLiteral', |
|
88 | 88 | 'nestedExpr', 'nullDebugAction', 'nums', 'oneOf', 'opAssoc', 'operatorPrecedence', 'printables', |
|
89 | 89 | 'punc8bit', 'pythonStyleComment', 'quotedString', 'removeQuotes', 'replaceHTMLEntity', |
|
90 | 90 | 'replaceWith', 'restOfLine', 'sglQuotedString', 'srange', 'stringEnd', |
|
91 | 91 | 'stringStart', 'traceParseAction', 'unicodeString', 'upcaseTokens', 'withAttribute', |
|
92 | 92 | 'indentedBlock', 'originalTextFor', |
|
93 | 93 | ] |
|
94 | 94 | |
|
95 | 95 | |
|
96 | 96 | """ |
|
97 | 97 | Detect if we are running version 3.X and make appropriate changes |
|
98 | 98 | Robert A. Clark |
|
99 | 99 | """ |
|
100 | 100 | if sys.version_info[0] > 2: |
|
101 | 101 | _PY3K = True |
|
102 | 102 | _MAX_INT = sys.maxsize |
|
103 | 103 | basestring = str |
|
104 | 104 | else: |
|
105 | 105 | _PY3K = False |
|
106 | 106 | _MAX_INT = sys.maxint |
|
107 | 107 | |
|
108 | 108 | if not _PY3K: |
|
109 | 109 | def _ustr(obj): |
|
110 | 110 | """Drop-in replacement for str(obj) that tries to be Unicode friendly. It first tries |
|
111 | 111 | str(obj). If that fails with a UnicodeEncodeError, then it tries unicode(obj). It |
|
112 | 112 | then < returns the unicode object | encodes it with the default encoding | ... >. |
|
113 | 113 | """ |
|
114 | 114 | if isinstance(obj,unicode): |
|
115 | 115 | return obj |
|
116 | 116 | |
|
117 | 117 | try: |
|
118 | 118 | # If this works, then _ustr(obj) has the same behaviour as str(obj), so |
|
119 | 119 | # it won't break any existing code. |
|
120 | 120 | return str(obj) |
|
121 | 121 | |
|
122 | 122 | except UnicodeEncodeError: |
|
123 | 123 | # The Python docs (http://docs.python.org/ref/customization.html#l2h-182) |
|
124 | 124 | # state that "The return value must be a string object". However, does a |
|
125 | 125 | # unicode object (being a subclass of basestring) count as a "string |
|
126 | 126 | # object"? |
|
127 | 127 | # If so, then return a unicode object: |
|
128 | 128 | return unicode(obj) |
|
129 | 129 | # Else encode it... but how? There are many choices... :) |
|
130 | 130 | # Replace unprintables with escape codes? |
|
131 |
#return unicode(obj).encode( |
|
|
131 | #return unicode(obj).encode(sys.getdefaultencoding(), 'backslashreplace_errors') | |
|
132 | 132 | # Replace unprintables with question marks? |
|
133 |
#return unicode(obj).encode( |
|
|
133 | #return unicode(obj).encode(sys.getdefaultencoding(), 'replace') | |
|
134 | 134 | # ... |
|
135 | 135 | else: |
|
136 | 136 | _ustr = str |
|
137 | 137 | unichr = chr |
|
138 | 138 | |
|
139 | 139 | if not _PY3K: |
|
140 | 140 | def _str2dict(strg): |
|
141 | 141 | return dict( [(c,0) for c in strg] ) |
|
142 | 142 | else: |
|
143 | 143 | _str2dict = set |
|
144 | 144 | |
|
145 | 145 | def _xml_escape(data): |
|
146 | 146 | """Escape &, <, >, ", ', etc. in a string of data.""" |
|
147 | 147 | |
|
148 | 148 | # ampersand must be replaced first |
|
149 | 149 | from_symbols = '&><"\'' |
|
150 | 150 | to_symbols = ['&'+s+';' for s in "amp gt lt quot apos".split()] |
|
151 | 151 | for from_,to_ in zip(from_symbols, to_symbols): |
|
152 | 152 | data = data.replace(from_, to_) |
|
153 | 153 | return data |
|
154 | 154 | |
|
155 | 155 | class _Constants(object): |
|
156 | 156 | pass |
|
157 | 157 | |
|
158 | 158 | if not _PY3K: |
|
159 | 159 | alphas = string.lowercase + string.uppercase |
|
160 | 160 | else: |
|
161 | 161 | alphas = string.ascii_lowercase + string.ascii_uppercase |
|
162 | 162 | nums = string.digits |
|
163 | 163 | hexnums = nums + "ABCDEFabcdef" |
|
164 | 164 | alphanums = alphas + nums |
|
165 | 165 | _bslash = chr(92) |
|
166 | 166 | printables = "".join( [ c for c in string.printable if c not in string.whitespace ] ) |
|
167 | 167 | |
|
168 | 168 | class ParseBaseException(Exception): |
|
169 | 169 | """base exception class for all parsing runtime exceptions""" |
|
170 | 170 | # Performance tuning: we construct a *lot* of these, so keep this |
|
171 | 171 | # constructor as small and fast as possible |
|
172 | 172 | def __init__( self, pstr, loc=0, msg=None, elem=None ): |
|
173 | 173 | self.loc = loc |
|
174 | 174 | if msg is None: |
|
175 | 175 | self.msg = pstr |
|
176 | 176 | self.pstr = "" |
|
177 | 177 | else: |
|
178 | 178 | self.msg = msg |
|
179 | 179 | self.pstr = pstr |
|
180 | 180 | self.parserElement = elem |
|
181 | 181 | |
|
182 | 182 | def __getattr__( self, aname ): |
|
183 | 183 | """supported attributes by name are: |
|
184 | 184 | - lineno - returns the line number of the exception text |
|
185 | 185 | - col - returns the column number of the exception text |
|
186 | 186 | - line - returns the line containing the exception text |
|
187 | 187 | """ |
|
188 | 188 | if( aname == "lineno" ): |
|
189 | 189 | return lineno( self.loc, self.pstr ) |
|
190 | 190 | elif( aname in ("col", "column") ): |
|
191 | 191 | return col( self.loc, self.pstr ) |
|
192 | 192 | elif( aname == "line" ): |
|
193 | 193 | return line( self.loc, self.pstr ) |
|
194 | 194 | else: |
|
195 | 195 | raise AttributeError(aname) |
|
196 | 196 | |
|
197 | 197 | def __str__( self ): |
|
198 | 198 | return "%s (at char %d), (line:%d, col:%d)" % \ |
|
199 | 199 | ( self.msg, self.loc, self.lineno, self.column ) |
|
200 | 200 | def __repr__( self ): |
|
201 | 201 | return _ustr(self) |
|
202 | 202 | def markInputline( self, markerString = ">!<" ): |
|
203 | 203 | """Extracts the exception line from the input string, and marks |
|
204 | 204 | the location of the exception with a special symbol. |
|
205 | 205 | """ |
|
206 | 206 | line_str = self.line |
|
207 | 207 | line_column = self.column - 1 |
|
208 | 208 | if markerString: |
|
209 | 209 | line_str = "".join( [line_str[:line_column], |
|
210 | 210 | markerString, line_str[line_column:]]) |
|
211 | 211 | return line_str.strip() |
|
212 | 212 | def __dir__(self): |
|
213 | 213 | return "loc msg pstr parserElement lineno col line " \ |
|
214 | 214 | "markInputLine __str__ __repr__".split() |
|
215 | 215 | |
|
216 | 216 | class ParseException(ParseBaseException): |
|
217 | 217 | """exception thrown when parse expressions don't match class; |
|
218 | 218 | supported attributes by name are: |
|
219 | 219 | - lineno - returns the line number of the exception text |
|
220 | 220 | - col - returns the column number of the exception text |
|
221 | 221 | - line - returns the line containing the exception text |
|
222 | 222 | """ |
|
223 | 223 | pass |
|
224 | 224 | |
|
225 | 225 | class ParseFatalException(ParseBaseException): |
|
226 | 226 | """user-throwable exception thrown when inconsistent parse content |
|
227 | 227 | is found; stops all parsing immediately""" |
|
228 | 228 | pass |
|
229 | 229 | |
|
230 | 230 | class ParseSyntaxException(ParseFatalException): |
|
231 | 231 | """just like ParseFatalException, but thrown internally when an |
|
232 | 232 | ErrorStop indicates that parsing is to stop immediately because |
|
233 | 233 | an unbacktrackable syntax error has been found""" |
|
234 | 234 | def __init__(self, pe): |
|
235 | 235 | super(ParseSyntaxException, self).__init__( |
|
236 | 236 | pe.pstr, pe.loc, pe.msg, pe.parserElement) |
|
237 | 237 | |
|
238 | 238 | #~ class ReparseException(ParseBaseException): |
|
239 | 239 | #~ """Experimental class - parse actions can raise this exception to cause |
|
240 | 240 | #~ pyparsing to reparse the input string: |
|
241 | 241 | #~ - with a modified input string, and/or |
|
242 | 242 | #~ - with a modified start location |
|
243 | 243 | #~ Set the values of the ReparseException in the constructor, and raise the |
|
244 | 244 | #~ exception in a parse action to cause pyparsing to use the new string/location. |
|
245 | 245 | #~ Setting the values as None causes no change to be made. |
|
246 | 246 | #~ """ |
|
247 | 247 | #~ def __init_( self, newstring, restartLoc ): |
|
248 | 248 | #~ self.newParseText = newstring |
|
249 | 249 | #~ self.reparseLoc = restartLoc |
|
250 | 250 | |
|
251 | 251 | class RecursiveGrammarException(Exception): |
|
252 | 252 | """exception thrown by validate() if the grammar could be improperly recursive""" |
|
253 | 253 | def __init__( self, parseElementList ): |
|
254 | 254 | self.parseElementTrace = parseElementList |
|
255 | 255 | |
|
256 | 256 | def __str__( self ): |
|
257 | 257 | return "RecursiveGrammarException: %s" % self.parseElementTrace |
|
258 | 258 | |
|
259 | 259 | class _ParseResultsWithOffset(object): |
|
260 | 260 | def __init__(self,p1,p2): |
|
261 | 261 | self.tup = (p1,p2) |
|
262 | 262 | def __getitem__(self,i): |
|
263 | 263 | return self.tup[i] |
|
264 | 264 | def __repr__(self): |
|
265 | 265 | return repr(self.tup) |
|
266 | 266 | def setOffset(self,i): |
|
267 | 267 | self.tup = (self.tup[0],i) |
|
268 | 268 | |
|
269 | 269 | class ParseResults(object): |
|
270 | 270 | """Structured parse results, to provide multiple means of access to the parsed data: |
|
271 | 271 | - as a list (len(results)) |
|
272 | 272 | - by list index (results[0], results[1], etc.) |
|
273 | 273 | - by attribute (results.<resultsName>) |
|
274 | 274 | """ |
|
275 | 275 | __slots__ = ( "__toklist", "__tokdict", "__doinit", "__name", "__parent", "__accumNames", "__weakref__" ) |
|
276 | 276 | def __new__(cls, toklist, name=None, asList=True, modal=True ): |
|
277 | 277 | if isinstance(toklist, cls): |
|
278 | 278 | return toklist |
|
279 | 279 | retobj = object.__new__(cls) |
|
280 | 280 | retobj.__doinit = True |
|
281 | 281 | return retobj |
|
282 | 282 | |
|
283 | 283 | # Performance tuning: we construct a *lot* of these, so keep this |
|
284 | 284 | # constructor as small and fast as possible |
|
285 | 285 | def __init__( self, toklist, name=None, asList=True, modal=True ): |
|
286 | 286 | if self.__doinit: |
|
287 | 287 | self.__doinit = False |
|
288 | 288 | self.__name = None |
|
289 | 289 | self.__parent = None |
|
290 | 290 | self.__accumNames = {} |
|
291 | 291 | if isinstance(toklist, list): |
|
292 | 292 | self.__toklist = toklist[:] |
|
293 | 293 | else: |
|
294 | 294 | self.__toklist = [toklist] |
|
295 | 295 | self.__tokdict = dict() |
|
296 | 296 | |
|
297 | 297 | if name: |
|
298 | 298 | if not modal: |
|
299 | 299 | self.__accumNames[name] = 0 |
|
300 | 300 | if isinstance(name,int): |
|
301 | 301 | name = _ustr(name) # will always return a str, but use _ustr for consistency |
|
302 | 302 | self.__name = name |
|
303 | 303 | if not toklist in (None,'',[]): |
|
304 | 304 | if isinstance(toklist,basestring): |
|
305 | 305 | toklist = [ toklist ] |
|
306 | 306 | if asList: |
|
307 | 307 | if isinstance(toklist,ParseResults): |
|
308 | 308 | self[name] = _ParseResultsWithOffset(toklist.copy(),0) |
|
309 | 309 | else: |
|
310 | 310 | self[name] = _ParseResultsWithOffset(ParseResults(toklist[0]),0) |
|
311 | 311 | self[name].__name = name |
|
312 | 312 | else: |
|
313 | 313 | try: |
|
314 | 314 | self[name] = toklist[0] |
|
315 | 315 | except (KeyError,TypeError,IndexError): |
|
316 | 316 | self[name] = toklist |
|
317 | 317 | |
|
318 | 318 | def __getitem__( self, i ): |
|
319 | 319 | if isinstance( i, (int,slice) ): |
|
320 | 320 | return self.__toklist[i] |
|
321 | 321 | else: |
|
322 | 322 | if i not in self.__accumNames: |
|
323 | 323 | return self.__tokdict[i][-1][0] |
|
324 | 324 | else: |
|
325 | 325 | return ParseResults([ v[0] for v in self.__tokdict[i] ]) |
|
326 | 326 | |
|
327 | 327 | def __setitem__( self, k, v ): |
|
328 | 328 | if isinstance(v,_ParseResultsWithOffset): |
|
329 | 329 | self.__tokdict[k] = self.__tokdict.get(k,list()) + [v] |
|
330 | 330 | sub = v[0] |
|
331 | 331 | elif isinstance(k,int): |
|
332 | 332 | self.__toklist[k] = v |
|
333 | 333 | sub = v |
|
334 | 334 | else: |
|
335 | 335 | self.__tokdict[k] = self.__tokdict.get(k,list()) + [_ParseResultsWithOffset(v,0)] |
|
336 | 336 | sub = v |
|
337 | 337 | if isinstance(sub,ParseResults): |
|
338 | 338 | sub.__parent = wkref(self) |
|
339 | 339 | |
|
340 | 340 | def __delitem__( self, i ): |
|
341 | 341 | if isinstance(i,(int,slice)): |
|
342 | 342 | mylen = len( self.__toklist ) |
|
343 | 343 | del self.__toklist[i] |
|
344 | 344 | |
|
345 | 345 | # convert int to slice |
|
346 | 346 | if isinstance(i, int): |
|
347 | 347 | if i < 0: |
|
348 | 348 | i += mylen |
|
349 | 349 | i = slice(i, i+1) |
|
350 | 350 | # get removed indices |
|
351 | 351 | removed = list(range(*i.indices(mylen))) |
|
352 | 352 | removed.reverse() |
|
353 | 353 | # fixup indices in token dictionary |
|
354 | 354 | for name in self.__tokdict: |
|
355 | 355 | occurrences = self.__tokdict[name] |
|
356 | 356 | for j in removed: |
|
357 | 357 | for k, (value, position) in enumerate(occurrences): |
|
358 | 358 | occurrences[k] = _ParseResultsWithOffset(value, position - (position > j)) |
|
359 | 359 | else: |
|
360 | 360 | del self.__tokdict[i] |
|
361 | 361 | |
|
362 | 362 | def __contains__( self, k ): |
|
363 | 363 | return k in self.__tokdict |
|
364 | 364 | |
|
365 | 365 | def __len__( self ): return len( self.__toklist ) |
|
366 | 366 | def __bool__(self): return len( self.__toklist ) > 0 |
|
367 | 367 | __nonzero__ = __bool__ |
|
368 | 368 | def __iter__( self ): return iter( self.__toklist ) |
|
369 | 369 | def __reversed__( self ): return iter( reversed(self.__toklist) ) |
|
370 | 370 | def keys( self ): |
|
371 | 371 | """Returns all named result keys.""" |
|
372 | 372 | return self.__tokdict.keys() |
|
373 | 373 | |
|
374 | 374 | def pop( self, index=-1 ): |
|
375 | 375 | """Removes and returns item at specified index (default=last). |
|
376 | 376 | Will work with either numeric indices or dict-key indicies.""" |
|
377 | 377 | ret = self[index] |
|
378 | 378 | del self[index] |
|
379 | 379 | return ret |
|
380 | 380 | |
|
381 | 381 | def get(self, key, defaultValue=None): |
|
382 | 382 | """Returns named result matching the given key, or if there is no |
|
383 | 383 | such name, then returns the given defaultValue or None if no |
|
384 | 384 | defaultValue is specified.""" |
|
385 | 385 | if key in self: |
|
386 | 386 | return self[key] |
|
387 | 387 | else: |
|
388 | 388 | return defaultValue |
|
389 | 389 | |
|
390 | 390 | def insert( self, index, insStr ): |
|
391 | 391 | self.__toklist.insert(index, insStr) |
|
392 | 392 | # fixup indices in token dictionary |
|
393 | 393 | for name in self.__tokdict: |
|
394 | 394 | occurrences = self.__tokdict[name] |
|
395 | 395 | for k, (value, position) in enumerate(occurrences): |
|
396 | 396 | occurrences[k] = _ParseResultsWithOffset(value, position + (position > index)) |
|
397 | 397 | |
|
398 | 398 | def items( self ): |
|
399 | 399 | """Returns all named result keys and values as a list of tuples.""" |
|
400 | 400 | return [(k,self[k]) for k in self.__tokdict] |
|
401 | 401 | |
|
402 | 402 | def values( self ): |
|
403 | 403 | """Returns all named result values.""" |
|
404 | 404 | return [ v[-1][0] for v in self.__tokdict.itervalues() ] |
|
405 | 405 | |
|
406 | 406 | def __getattr__( self, name ): |
|
407 | 407 | if name not in self.__slots__: |
|
408 | 408 | if name in self.__tokdict: |
|
409 | 409 | if name not in self.__accumNames: |
|
410 | 410 | return self.__tokdict[name][-1][0] |
|
411 | 411 | else: |
|
412 | 412 | return ParseResults([ v[0] for v in self.__tokdict[name] ]) |
|
413 | 413 | else: |
|
414 | 414 | return "" |
|
415 | 415 | return None |
|
416 | 416 | |
|
417 | 417 | def __add__( self, other ): |
|
418 | 418 | ret = self.copy() |
|
419 | 419 | ret += other |
|
420 | 420 | return ret |
|
421 | 421 | |
|
422 | 422 | def __iadd__( self, other ): |
|
423 | 423 | if other.__tokdict: |
|
424 | 424 | offset = len(self.__toklist) |
|
425 | 425 | addoffset = ( lambda a: (a<0 and offset) or (a+offset) ) |
|
426 | 426 | otheritems = other.__tokdict.iteritems() |
|
427 | 427 | otherdictitems = [(k, _ParseResultsWithOffset(v[0],addoffset(v[1])) ) |
|
428 | 428 | for (k,vlist) in otheritems for v in vlist] |
|
429 | 429 | for k,v in otherdictitems: |
|
430 | 430 | self[k] = v |
|
431 | 431 | if isinstance(v[0],ParseResults): |
|
432 | 432 | v[0].__parent = wkref(self) |
|
433 | 433 | |
|
434 | 434 | self.__toklist += other.__toklist |
|
435 | 435 | self.__accumNames.update( other.__accumNames ) |
|
436 | 436 | del other |
|
437 | 437 | return self |
|
438 | 438 | |
|
439 | 439 | def __repr__( self ): |
|
440 | 440 | return "(%s, %s)" % ( repr( self.__toklist ), repr( self.__tokdict ) ) |
|
441 | 441 | |
|
442 | 442 | def __str__( self ): |
|
443 | 443 | out = "[" |
|
444 | 444 | sep = "" |
|
445 | 445 | for i in self.__toklist: |
|
446 | 446 | if isinstance(i, ParseResults): |
|
447 | 447 | out += sep + _ustr(i) |
|
448 | 448 | else: |
|
449 | 449 | out += sep + repr(i) |
|
450 | 450 | sep = ", " |
|
451 | 451 | out += "]" |
|
452 | 452 | return out |
|
453 | 453 | |
|
454 | 454 | def _asStringList( self, sep='' ): |
|
455 | 455 | out = [] |
|
456 | 456 | for item in self.__toklist: |
|
457 | 457 | if out and sep: |
|
458 | 458 | out.append(sep) |
|
459 | 459 | if isinstance( item, ParseResults ): |
|
460 | 460 | out += item._asStringList() |
|
461 | 461 | else: |
|
462 | 462 | out.append( _ustr(item) ) |
|
463 | 463 | return out |
|
464 | 464 | |
|
465 | 465 | def asList( self ): |
|
466 | 466 | """Returns the parse results as a nested list of matching tokens, all converted to strings.""" |
|
467 | 467 | out = [] |
|
468 | 468 | for res in self.__toklist: |
|
469 | 469 | if isinstance(res,ParseResults): |
|
470 | 470 | out.append( res.asList() ) |
|
471 | 471 | else: |
|
472 | 472 | out.append( res ) |
|
473 | 473 | return out |
|
474 | 474 | |
|
475 | 475 | def asDict( self ): |
|
476 | 476 | """Returns the named parse results as dictionary.""" |
|
477 | 477 | return dict( self.items() ) |
|
478 | 478 | |
|
479 | 479 | def copy( self ): |
|
480 | 480 | """Returns a new copy of a ParseResults object.""" |
|
481 | 481 | ret = ParseResults( self.__toklist ) |
|
482 | 482 | ret.__tokdict = self.__tokdict.copy() |
|
483 | 483 | ret.__parent = self.__parent |
|
484 | 484 | ret.__accumNames.update( self.__accumNames ) |
|
485 | 485 | ret.__name = self.__name |
|
486 | 486 | return ret |
|
487 | 487 | |
|
488 | 488 | def asXML( self, doctag=None, namedItemsOnly=False, indent="", formatted=True ): |
|
489 | 489 | """Returns the parse results as XML. Tags are created for tokens and lists that have defined results names.""" |
|
490 | 490 | nl = "\n" |
|
491 | 491 | out = [] |
|
492 | 492 | namedItems = dict([(v[1],k) for (k,vlist) in self.__tokdict.iteritems() |
|
493 | 493 | for v in vlist ] ) |
|
494 | 494 | nextLevelIndent = indent + " " |
|
495 | 495 | |
|
496 | 496 | # collapse out indents if formatting is not desired |
|
497 | 497 | if not formatted: |
|
498 | 498 | indent = "" |
|
499 | 499 | nextLevelIndent = "" |
|
500 | 500 | nl = "" |
|
501 | 501 | |
|
502 | 502 | selfTag = None |
|
503 | 503 | if doctag is not None: |
|
504 | 504 | selfTag = doctag |
|
505 | 505 | else: |
|
506 | 506 | if self.__name: |
|
507 | 507 | selfTag = self.__name |
|
508 | 508 | |
|
509 | 509 | if not selfTag: |
|
510 | 510 | if namedItemsOnly: |
|
511 | 511 | return "" |
|
512 | 512 | else: |
|
513 | 513 | selfTag = "ITEM" |
|
514 | 514 | |
|
515 | 515 | out += [ nl, indent, "<", selfTag, ">" ] |
|
516 | 516 | |
|
517 | 517 | worklist = self.__toklist |
|
518 | 518 | for i,res in enumerate(worklist): |
|
519 | 519 | if isinstance(res,ParseResults): |
|
520 | 520 | if i in namedItems: |
|
521 | 521 | out += [ res.asXML(namedItems[i], |
|
522 | 522 | namedItemsOnly and doctag is None, |
|
523 | 523 | nextLevelIndent, |
|
524 | 524 | formatted)] |
|
525 | 525 | else: |
|
526 | 526 | out += [ res.asXML(None, |
|
527 | 527 | namedItemsOnly and doctag is None, |
|
528 | 528 | nextLevelIndent, |
|
529 | 529 | formatted)] |
|
530 | 530 | else: |
|
531 | 531 | # individual token, see if there is a name for it |
|
532 | 532 | resTag = None |
|
533 | 533 | if i in namedItems: |
|
534 | 534 | resTag = namedItems[i] |
|
535 | 535 | if not resTag: |
|
536 | 536 | if namedItemsOnly: |
|
537 | 537 | continue |
|
538 | 538 | else: |
|
539 | 539 | resTag = "ITEM" |
|
540 | 540 | xmlBodyText = _xml_escape(_ustr(res)) |
|
541 | 541 | out += [ nl, nextLevelIndent, "<", resTag, ">", |
|
542 | 542 | xmlBodyText, |
|
543 | 543 | "</", resTag, ">" ] |
|
544 | 544 | |
|
545 | 545 | out += [ nl, indent, "</", selfTag, ">" ] |
|
546 | 546 | return "".join(out) |
|
547 | 547 | |
|
548 | 548 | def __lookup(self,sub): |
|
549 | 549 | for k,vlist in self.__tokdict.iteritems(): |
|
550 | 550 | for v,loc in vlist: |
|
551 | 551 | if sub is v: |
|
552 | 552 | return k |
|
553 | 553 | return None |
|
554 | 554 | |
|
555 | 555 | def getName(self): |
|
556 | 556 | """Returns the results name for this token expression.""" |
|
557 | 557 | if self.__name: |
|
558 | 558 | return self.__name |
|
559 | 559 | elif self.__parent: |
|
560 | 560 | par = self.__parent() |
|
561 | 561 | if par: |
|
562 | 562 | return par.__lookup(self) |
|
563 | 563 | else: |
|
564 | 564 | return None |
|
565 | 565 | elif (len(self) == 1 and |
|
566 | 566 | len(self.__tokdict) == 1 and |
|
567 | 567 | self.__tokdict.values()[0][0][1] in (0,-1)): |
|
568 | 568 | return self.__tokdict.keys()[0] |
|
569 | 569 | else: |
|
570 | 570 | return None |
|
571 | 571 | |
|
572 | 572 | def dump(self,indent='',depth=0): |
|
573 | 573 | """Diagnostic method for listing out the contents of a ParseResults. |
|
574 | 574 | Accepts an optional indent argument so that this string can be embedded |
|
575 | 575 | in a nested display of other data.""" |
|
576 | 576 | out = [] |
|
577 | 577 | out.append( indent+_ustr(self.asList()) ) |
|
578 | 578 | keys = self.items() |
|
579 | 579 | keys.sort() |
|
580 | 580 | for k,v in keys: |
|
581 | 581 | if out: |
|
582 | 582 | out.append('\n') |
|
583 | 583 | out.append( "%s%s- %s: " % (indent,(' '*depth), k) ) |
|
584 | 584 | if isinstance(v,ParseResults): |
|
585 | 585 | if v.keys(): |
|
586 | 586 | #~ out.append('\n') |
|
587 | 587 | out.append( v.dump(indent,depth+1) ) |
|
588 | 588 | #~ out.append('\n') |
|
589 | 589 | else: |
|
590 | 590 | out.append(_ustr(v)) |
|
591 | 591 | else: |
|
592 | 592 | out.append(_ustr(v)) |
|
593 | 593 | #~ out.append('\n') |
|
594 | 594 | return "".join(out) |
|
595 | 595 | |
|
596 | 596 | # add support for pickle protocol |
|
597 | 597 | def __getstate__(self): |
|
598 | 598 | return ( self.__toklist, |
|
599 | 599 | ( self.__tokdict.copy(), |
|
600 | 600 | self.__parent is not None and self.__parent() or None, |
|
601 | 601 | self.__accumNames, |
|
602 | 602 | self.__name ) ) |
|
603 | 603 | |
|
604 | 604 | def __setstate__(self,state): |
|
605 | 605 | self.__toklist = state[0] |
|
606 | 606 | self.__tokdict, \ |
|
607 | 607 | par, \ |
|
608 | 608 | inAccumNames, \ |
|
609 | 609 | self.__name = state[1] |
|
610 | 610 | self.__accumNames = {} |
|
611 | 611 | self.__accumNames.update(inAccumNames) |
|
612 | 612 | if par is not None: |
|
613 | 613 | self.__parent = wkref(par) |
|
614 | 614 | else: |
|
615 | 615 | self.__parent = None |
|
616 | 616 | |
|
617 | 617 | def __dir__(self): |
|
618 | 618 | return dir(super(ParseResults,self)) + self.keys() |
|
619 | 619 | |
|
620 | 620 | def col (loc,strg): |
|
621 | 621 | """Returns current column within a string, counting newlines as line separators. |
|
622 | 622 | The first column is number 1. |
|
623 | 623 | |
|
624 | 624 | Note: the default parsing behavior is to expand tabs in the input string |
|
625 | 625 | before starting the parsing process. See L{I{ParserElement.parseString}<ParserElement.parseString>} for more information |
|
626 | 626 | on parsing strings containing <TAB>s, and suggested methods to maintain a |
|
627 | 627 | consistent view of the parsed string, the parse location, and line and column |
|
628 | 628 | positions within the parsed string. |
|
629 | 629 | """ |
|
630 | 630 | return (loc<len(strg) and strg[loc] == '\n') and 1 or loc - strg.rfind("\n", 0, loc) |
|
631 | 631 | |
|
632 | 632 | def lineno(loc,strg): |
|
633 | 633 | """Returns current line number within a string, counting newlines as line separators. |
|
634 | 634 | The first line is number 1. |
|
635 | 635 | |
|
636 | 636 | Note: the default parsing behavior is to expand tabs in the input string |
|
637 | 637 | before starting the parsing process. See L{I{ParserElement.parseString}<ParserElement.parseString>} for more information |
|
638 | 638 | on parsing strings containing <TAB>s, and suggested methods to maintain a |
|
639 | 639 | consistent view of the parsed string, the parse location, and line and column |
|
640 | 640 | positions within the parsed string. |
|
641 | 641 | """ |
|
642 | 642 | return strg.count("\n",0,loc) + 1 |
|
643 | 643 | |
|
644 | 644 | def line( loc, strg ): |
|
645 | 645 | """Returns the line of text containing loc within a string, counting newlines as line separators. |
|
646 | 646 | """ |
|
647 | 647 | lastCR = strg.rfind("\n", 0, loc) |
|
648 | 648 | nextCR = strg.find("\n", loc) |
|
649 | 649 | if nextCR > 0: |
|
650 | 650 | return strg[lastCR+1:nextCR] |
|
651 | 651 | else: |
|
652 | 652 | return strg[lastCR+1:] |
|
653 | 653 | |
|
654 | 654 | def _defaultStartDebugAction( instring, loc, expr ): |
|
655 | 655 | print ("Match " + _ustr(expr) + " at loc " + _ustr(loc) + "(%d,%d)" % ( lineno(loc,instring), col(loc,instring) )) |
|
656 | 656 | |
|
657 | 657 | def _defaultSuccessDebugAction( instring, startloc, endloc, expr, toks ): |
|
658 | 658 | print ("Matched " + _ustr(expr) + " -> " + str(toks.asList())) |
|
659 | 659 | |
|
660 | 660 | def _defaultExceptionDebugAction( instring, loc, expr, exc ): |
|
661 | 661 | print ("Exception raised:" + _ustr(exc)) |
|
662 | 662 | |
|
663 | 663 | def nullDebugAction(*args): |
|
664 | 664 | """'Do-nothing' debug action, to suppress debugging output during parsing.""" |
|
665 | 665 | pass |
|
666 | 666 | |
|
667 | 667 | class ParserElement(object): |
|
668 | 668 | """Abstract base level parser element class.""" |
|
669 | 669 | DEFAULT_WHITE_CHARS = " \n\t\r" |
|
670 | 670 | |
|
671 | 671 | def setDefaultWhitespaceChars( chars ): |
|
672 | 672 | """Overrides the default whitespace chars |
|
673 | 673 | """ |
|
674 | 674 | ParserElement.DEFAULT_WHITE_CHARS = chars |
|
675 | 675 | setDefaultWhitespaceChars = staticmethod(setDefaultWhitespaceChars) |
|
676 | 676 | |
|
677 | 677 | def __init__( self, savelist=False ): |
|
678 | 678 | self.parseAction = list() |
|
679 | 679 | self.failAction = None |
|
680 | 680 | #~ self.name = "<unknown>" # don't define self.name, let subclasses try/except upcall |
|
681 | 681 | self.strRepr = None |
|
682 | 682 | self.resultsName = None |
|
683 | 683 | self.saveAsList = savelist |
|
684 | 684 | self.skipWhitespace = True |
|
685 | 685 | self.whiteChars = ParserElement.DEFAULT_WHITE_CHARS |
|
686 | 686 | self.copyDefaultWhiteChars = True |
|
687 | 687 | self.mayReturnEmpty = False # used when checking for left-recursion |
|
688 | 688 | self.keepTabs = False |
|
689 | 689 | self.ignoreExprs = list() |
|
690 | 690 | self.debug = False |
|
691 | 691 | self.streamlined = False |
|
692 | 692 | self.mayIndexError = True # used to optimize exception handling for subclasses that don't advance parse index |
|
693 | 693 | self.errmsg = "" |
|
694 | 694 | self.modalResults = True # used to mark results names as modal (report only last) or cumulative (list all) |
|
695 | 695 | self.debugActions = ( None, None, None ) #custom debug actions |
|
696 | 696 | self.re = None |
|
697 | 697 | self.callPreparse = True # used to avoid redundant calls to preParse |
|
698 | 698 | self.callDuringTry = False |
|
699 | 699 | |
|
700 | 700 | def copy( self ): |
|
701 | 701 | """Make a copy of this ParserElement. Useful for defining different parse actions |
|
702 | 702 | for the same parsing pattern, using copies of the original parse element.""" |
|
703 | 703 | cpy = copy.copy( self ) |
|
704 | 704 | cpy.parseAction = self.parseAction[:] |
|
705 | 705 | cpy.ignoreExprs = self.ignoreExprs[:] |
|
706 | 706 | if self.copyDefaultWhiteChars: |
|
707 | 707 | cpy.whiteChars = ParserElement.DEFAULT_WHITE_CHARS |
|
708 | 708 | return cpy |
|
709 | 709 | |
|
710 | 710 | def setName( self, name ): |
|
711 | 711 | """Define name for this expression, for use in debugging.""" |
|
712 | 712 | self.name = name |
|
713 | 713 | self.errmsg = "Expected " + self.name |
|
714 | 714 | if hasattr(self,"exception"): |
|
715 | 715 | self.exception.msg = self.errmsg |
|
716 | 716 | return self |
|
717 | 717 | |
|
718 | 718 | def setResultsName( self, name, listAllMatches=False ): |
|
719 | 719 | """Define name for referencing matching tokens as a nested attribute |
|
720 | 720 | of the returned parse results. |
|
721 | 721 | NOTE: this returns a *copy* of the original ParserElement object; |
|
722 | 722 | this is so that the client can define a basic element, such as an |
|
723 | 723 | integer, and reference it in multiple places with different names. |
|
724 | 724 | """ |
|
725 | 725 | newself = self.copy() |
|
726 | 726 | newself.resultsName = name |
|
727 | 727 | newself.modalResults = not listAllMatches |
|
728 | 728 | return newself |
|
729 | 729 | |
|
730 | 730 | def setBreak(self,breakFlag = True): |
|
731 | 731 | """Method to invoke the Python pdb debugger when this element is |
|
732 | 732 | about to be parsed. Set breakFlag to True to enable, False to |
|
733 | 733 | disable. |
|
734 | 734 | """ |
|
735 | 735 | if breakFlag: |
|
736 | 736 | _parseMethod = self._parse |
|
737 | 737 | def breaker(instring, loc, doActions=True, callPreParse=True): |
|
738 | 738 | import pdb |
|
739 | 739 | pdb.set_trace() |
|
740 | 740 | return _parseMethod( instring, loc, doActions, callPreParse ) |
|
741 | 741 | breaker._originalParseMethod = _parseMethod |
|
742 | 742 | self._parse = breaker |
|
743 | 743 | else: |
|
744 | 744 | if hasattr(self._parse,"_originalParseMethod"): |
|
745 | 745 | self._parse = self._parse._originalParseMethod |
|
746 | 746 | return self |
|
747 | 747 | |
|
748 | 748 | def _normalizeParseActionArgs( f ): |
|
749 | 749 | """Internal method used to decorate parse actions that take fewer than 3 arguments, |
|
750 | 750 | so that all parse actions can be called as f(s,l,t).""" |
|
751 | 751 | STAR_ARGS = 4 |
|
752 | 752 | |
|
753 | 753 | try: |
|
754 | 754 | restore = None |
|
755 | 755 | if isinstance(f,type): |
|
756 | 756 | restore = f |
|
757 | 757 | f = f.__init__ |
|
758 | 758 | if not _PY3K: |
|
759 | 759 | codeObj = f.func_code |
|
760 | 760 | else: |
|
761 | 761 | codeObj = f.code |
|
762 | 762 | if codeObj.co_flags & STAR_ARGS: |
|
763 | 763 | return f |
|
764 | 764 | numargs = codeObj.co_argcount |
|
765 | 765 | if not _PY3K: |
|
766 | 766 | if hasattr(f,"im_self"): |
|
767 | 767 | numargs -= 1 |
|
768 | 768 | else: |
|
769 | 769 | if hasattr(f,"__self__"): |
|
770 | 770 | numargs -= 1 |
|
771 | 771 | if restore: |
|
772 | 772 | f = restore |
|
773 | 773 | except AttributeError: |
|
774 | 774 | try: |
|
775 | 775 | if not _PY3K: |
|
776 | 776 | call_im_func_code = f.__call__.im_func.func_code |
|
777 | 777 | else: |
|
778 | 778 | call_im_func_code = f.__code__ |
|
779 | 779 | |
|
780 | 780 | # not a function, must be a callable object, get info from the |
|
781 | 781 | # im_func binding of its bound __call__ method |
|
782 | 782 | if call_im_func_code.co_flags & STAR_ARGS: |
|
783 | 783 | return f |
|
784 | 784 | numargs = call_im_func_code.co_argcount |
|
785 | 785 | if not _PY3K: |
|
786 | 786 | if hasattr(f.__call__,"im_self"): |
|
787 | 787 | numargs -= 1 |
|
788 | 788 | else: |
|
789 | 789 | if hasattr(f.__call__,"__self__"): |
|
790 | 790 | numargs -= 0 |
|
791 | 791 | except AttributeError: |
|
792 | 792 | if not _PY3K: |
|
793 | 793 | call_func_code = f.__call__.func_code |
|
794 | 794 | else: |
|
795 | 795 | call_func_code = f.__call__.__code__ |
|
796 | 796 | # not a bound method, get info directly from __call__ method |
|
797 | 797 | if call_func_code.co_flags & STAR_ARGS: |
|
798 | 798 | return f |
|
799 | 799 | numargs = call_func_code.co_argcount |
|
800 | 800 | if not _PY3K: |
|
801 | 801 | if hasattr(f.__call__,"im_self"): |
|
802 | 802 | numargs -= 1 |
|
803 | 803 | else: |
|
804 | 804 | if hasattr(f.__call__,"__self__"): |
|
805 | 805 | numargs -= 1 |
|
806 | 806 | |
|
807 | 807 | |
|
808 | 808 | #~ print ("adding function %s with %d args" % (f.func_name,numargs)) |
|
809 | 809 | if numargs == 3: |
|
810 | 810 | return f |
|
811 | 811 | else: |
|
812 | 812 | if numargs > 3: |
|
813 | 813 | def tmp(s,l,t): |
|
814 | 814 | return f(f.__call__.__self__, s,l,t) |
|
815 | 815 | if numargs == 2: |
|
816 | 816 | def tmp(s,l,t): |
|
817 | 817 | return f(l,t) |
|
818 | 818 | elif numargs == 1: |
|
819 | 819 | def tmp(s,l,t): |
|
820 | 820 | return f(t) |
|
821 | 821 | else: #~ numargs == 0: |
|
822 | 822 | def tmp(s,l,t): |
|
823 | 823 | return f() |
|
824 | 824 | try: |
|
825 | 825 | tmp.__name__ = f.__name__ |
|
826 | 826 | except (AttributeError,TypeError): |
|
827 | 827 | # no need for special handling if attribute doesnt exist |
|
828 | 828 | pass |
|
829 | 829 | try: |
|
830 | 830 | tmp.__doc__ = f.__doc__ |
|
831 | 831 | except (AttributeError,TypeError): |
|
832 | 832 | # no need for special handling if attribute doesnt exist |
|
833 | 833 | pass |
|
834 | 834 | try: |
|
835 | 835 | tmp.__dict__.update(f.__dict__) |
|
836 | 836 | except (AttributeError,TypeError): |
|
837 | 837 | # no need for special handling if attribute doesnt exist |
|
838 | 838 | pass |
|
839 | 839 | return tmp |
|
840 | 840 | _normalizeParseActionArgs = staticmethod(_normalizeParseActionArgs) |
|
841 | 841 | |
|
842 | 842 | def setParseAction( self, *fns, **kwargs ): |
|
843 | 843 | """Define action to perform when successfully matching parse element definition. |
|
844 | 844 | Parse action fn is a callable method with 0-3 arguments, called as fn(s,loc,toks), |
|
845 | 845 | fn(loc,toks), fn(toks), or just fn(), where: |
|
846 | 846 | - s = the original string being parsed (see note below) |
|
847 | 847 | - loc = the location of the matching substring |
|
848 | 848 | - toks = a list of the matched tokens, packaged as a ParseResults object |
|
849 | 849 | If the functions in fns modify the tokens, they can return them as the return |
|
850 | 850 | value from fn, and the modified list of tokens will replace the original. |
|
851 | 851 | Otherwise, fn does not need to return any value. |
|
852 | 852 | |
|
853 | 853 | Note: the default parsing behavior is to expand tabs in the input string |
|
854 | 854 | before starting the parsing process. See L{I{parseString}<parseString>} for more information |
|
855 | 855 | on parsing strings containing <TAB>s, and suggested methods to maintain a |
|
856 | 856 | consistent view of the parsed string, the parse location, and line and column |
|
857 | 857 | positions within the parsed string. |
|
858 | 858 | """ |
|
859 | 859 | self.parseAction = list(map(self._normalizeParseActionArgs, list(fns))) |
|
860 | 860 | self.callDuringTry = ("callDuringTry" in kwargs and kwargs["callDuringTry"]) |
|
861 | 861 | return self |
|
862 | 862 | |
|
863 | 863 | def addParseAction( self, *fns, **kwargs ): |
|
864 | 864 | """Add parse action to expression's list of parse actions. See L{I{setParseAction}<setParseAction>}.""" |
|
865 | 865 | self.parseAction += list(map(self._normalizeParseActionArgs, list(fns))) |
|
866 | 866 | self.callDuringTry = self.callDuringTry or ("callDuringTry" in kwargs and kwargs["callDuringTry"]) |
|
867 | 867 | return self |
|
868 | 868 | |
|
869 | 869 | def setFailAction( self, fn ): |
|
870 | 870 | """Define action to perform if parsing fails at this expression. |
|
871 | 871 | Fail acton fn is a callable function that takes the arguments |
|
872 | 872 | fn(s,loc,expr,err) where: |
|
873 | 873 | - s = string being parsed |
|
874 | 874 | - loc = location where expression match was attempted and failed |
|
875 | 875 | - expr = the parse expression that failed |
|
876 | 876 | - err = the exception thrown |
|
877 | 877 | The function returns no value. It may throw ParseFatalException |
|
878 | 878 | if it is desired to stop parsing immediately.""" |
|
879 | 879 | self.failAction = fn |
|
880 | 880 | return self |
|
881 | 881 | |
|
882 | 882 | def _skipIgnorables( self, instring, loc ): |
|
883 | 883 | exprsFound = True |
|
884 | 884 | while exprsFound: |
|
885 | 885 | exprsFound = False |
|
886 | 886 | for e in self.ignoreExprs: |
|
887 | 887 | try: |
|
888 | 888 | while 1: |
|
889 | 889 | loc,dummy = e._parse( instring, loc ) |
|
890 | 890 | exprsFound = True |
|
891 | 891 | except ParseException: |
|
892 | 892 | pass |
|
893 | 893 | return loc |
|
894 | 894 | |
|
895 | 895 | def preParse( self, instring, loc ): |
|
896 | 896 | if self.ignoreExprs: |
|
897 | 897 | loc = self._skipIgnorables( instring, loc ) |
|
898 | 898 | |
|
899 | 899 | if self.skipWhitespace: |
|
900 | 900 | wt = self.whiteChars |
|
901 | 901 | instrlen = len(instring) |
|
902 | 902 | while loc < instrlen and instring[loc] in wt: |
|
903 | 903 | loc += 1 |
|
904 | 904 | |
|
905 | 905 | return loc |
|
906 | 906 | |
|
907 | 907 | def parseImpl( self, instring, loc, doActions=True ): |
|
908 | 908 | return loc, [] |
|
909 | 909 | |
|
910 | 910 | def postParse( self, instring, loc, tokenlist ): |
|
911 | 911 | return tokenlist |
|
912 | 912 | |
|
913 | 913 | #~ @profile |
|
914 | 914 | def _parseNoCache( self, instring, loc, doActions=True, callPreParse=True ): |
|
915 | 915 | debugging = ( self.debug ) #and doActions ) |
|
916 | 916 | |
|
917 | 917 | if debugging or self.failAction: |
|
918 | 918 | #~ print ("Match",self,"at loc",loc,"(%d,%d)" % ( lineno(loc,instring), col(loc,instring) )) |
|
919 | 919 | if (self.debugActions[0] ): |
|
920 | 920 | self.debugActions[0]( instring, loc, self ) |
|
921 | 921 | if callPreParse and self.callPreparse: |
|
922 | 922 | preloc = self.preParse( instring, loc ) |
|
923 | 923 | else: |
|
924 | 924 | preloc = loc |
|
925 | 925 | tokensStart = loc |
|
926 | 926 | try: |
|
927 | 927 | try: |
|
928 | 928 | loc,tokens = self.parseImpl( instring, preloc, doActions ) |
|
929 | 929 | except IndexError: |
|
930 | 930 | raise ParseException( instring, len(instring), self.errmsg, self ) |
|
931 | 931 | except ParseBaseException, err: |
|
932 | 932 | #~ print ("Exception raised:", err) |
|
933 | 933 | if self.debugActions[2]: |
|
934 | 934 | self.debugActions[2]( instring, tokensStart, self, err ) |
|
935 | 935 | if self.failAction: |
|
936 | 936 | self.failAction( instring, tokensStart, self, err ) |
|
937 | 937 | raise |
|
938 | 938 | else: |
|
939 | 939 | if callPreParse and self.callPreparse: |
|
940 | 940 | preloc = self.preParse( instring, loc ) |
|
941 | 941 | else: |
|
942 | 942 | preloc = loc |
|
943 | 943 | tokensStart = loc |
|
944 | 944 | if self.mayIndexError or loc >= len(instring): |
|
945 | 945 | try: |
|
946 | 946 | loc,tokens = self.parseImpl( instring, preloc, doActions ) |
|
947 | 947 | except IndexError: |
|
948 | 948 | raise ParseException( instring, len(instring), self.errmsg, self ) |
|
949 | 949 | else: |
|
950 | 950 | loc,tokens = self.parseImpl( instring, preloc, doActions ) |
|
951 | 951 | |
|
952 | 952 | tokens = self.postParse( instring, loc, tokens ) |
|
953 | 953 | |
|
954 | 954 | retTokens = ParseResults( tokens, self.resultsName, asList=self.saveAsList, modal=self.modalResults ) |
|
955 | 955 | if self.parseAction and (doActions or self.callDuringTry): |
|
956 | 956 | if debugging: |
|
957 | 957 | try: |
|
958 | 958 | for fn in self.parseAction: |
|
959 | 959 | tokens = fn( instring, tokensStart, retTokens ) |
|
960 | 960 | if tokens is not None: |
|
961 | 961 | retTokens = ParseResults( tokens, |
|
962 | 962 | self.resultsName, |
|
963 | 963 | asList=self.saveAsList and isinstance(tokens,(ParseResults,list)), |
|
964 | 964 | modal=self.modalResults ) |
|
965 | 965 | except ParseBaseException, err: |
|
966 | 966 | #~ print "Exception raised in user parse action:", err |
|
967 | 967 | if (self.debugActions[2] ): |
|
968 | 968 | self.debugActions[2]( instring, tokensStart, self, err ) |
|
969 | 969 | raise |
|
970 | 970 | else: |
|
971 | 971 | for fn in self.parseAction: |
|
972 | 972 | tokens = fn( instring, tokensStart, retTokens ) |
|
973 | 973 | if tokens is not None: |
|
974 | 974 | retTokens = ParseResults( tokens, |
|
975 | 975 | self.resultsName, |
|
976 | 976 | asList=self.saveAsList and isinstance(tokens,(ParseResults,list)), |
|
977 | 977 | modal=self.modalResults ) |
|
978 | 978 | |
|
979 | 979 | if debugging: |
|
980 | 980 | #~ print ("Matched",self,"->",retTokens.asList()) |
|
981 | 981 | if (self.debugActions[1] ): |
|
982 | 982 | self.debugActions[1]( instring, tokensStart, loc, self, retTokens ) |
|
983 | 983 | |
|
984 | 984 | return loc, retTokens |
|
985 | 985 | |
|
986 | 986 | def tryParse( self, instring, loc ): |
|
987 | 987 | try: |
|
988 | 988 | return self._parse( instring, loc, doActions=False )[0] |
|
989 | 989 | except ParseFatalException: |
|
990 | 990 | raise ParseException( instring, loc, self.errmsg, self) |
|
991 | 991 | |
|
992 | 992 | # this method gets repeatedly called during backtracking with the same arguments - |
|
993 | 993 | # we can cache these arguments and save ourselves the trouble of re-parsing the contained expression |
|
994 | 994 | def _parseCache( self, instring, loc, doActions=True, callPreParse=True ): |
|
995 | 995 | lookup = (self,instring,loc,callPreParse,doActions) |
|
996 | 996 | if lookup in ParserElement._exprArgCache: |
|
997 | 997 | value = ParserElement._exprArgCache[ lookup ] |
|
998 | 998 | if isinstance(value,Exception): |
|
999 | 999 | raise value |
|
1000 | 1000 | return value |
|
1001 | 1001 | else: |
|
1002 | 1002 | try: |
|
1003 | 1003 | value = self._parseNoCache( instring, loc, doActions, callPreParse ) |
|
1004 | 1004 | ParserElement._exprArgCache[ lookup ] = (value[0],value[1].copy()) |
|
1005 | 1005 | return value |
|
1006 | 1006 | except ParseBaseException, pe: |
|
1007 | 1007 | ParserElement._exprArgCache[ lookup ] = pe |
|
1008 | 1008 | raise |
|
1009 | 1009 | |
|
1010 | 1010 | _parse = _parseNoCache |
|
1011 | 1011 | |
|
1012 | 1012 | # argument cache for optimizing repeated calls when backtracking through recursive expressions |
|
1013 | 1013 | _exprArgCache = {} |
|
1014 | 1014 | def resetCache(): |
|
1015 | 1015 | ParserElement._exprArgCache.clear() |
|
1016 | 1016 | resetCache = staticmethod(resetCache) |
|
1017 | 1017 | |
|
1018 | 1018 | _packratEnabled = False |
|
1019 | 1019 | def enablePackrat(): |
|
1020 | 1020 | """Enables "packrat" parsing, which adds memoizing to the parsing logic. |
|
1021 | 1021 | Repeated parse attempts at the same string location (which happens |
|
1022 | 1022 | often in many complex grammars) can immediately return a cached value, |
|
1023 | 1023 | instead of re-executing parsing/validating code. Memoizing is done of |
|
1024 | 1024 | both valid results and parsing exceptions. |
|
1025 | 1025 | |
|
1026 | 1026 | This speedup may break existing programs that use parse actions that |
|
1027 | 1027 | have side-effects. For this reason, packrat parsing is disabled when |
|
1028 | 1028 | you first import pyparsing. To activate the packrat feature, your |
|
1029 | 1029 | program must call the class method ParserElement.enablePackrat(). If |
|
1030 | 1030 | your program uses psyco to "compile as you go", you must call |
|
1031 | 1031 | enablePackrat before calling psyco.full(). If you do not do this, |
|
1032 | 1032 | Python will crash. For best results, call enablePackrat() immediately |
|
1033 | 1033 | after importing pyparsing. |
|
1034 | 1034 | """ |
|
1035 | 1035 | if not ParserElement._packratEnabled: |
|
1036 | 1036 | ParserElement._packratEnabled = True |
|
1037 | 1037 | ParserElement._parse = ParserElement._parseCache |
|
1038 | 1038 | enablePackrat = staticmethod(enablePackrat) |
|
1039 | 1039 | |
|
1040 | 1040 | def parseString( self, instring, parseAll=False ): |
|
1041 | 1041 | """Execute the parse expression with the given string. |
|
1042 | 1042 | This is the main interface to the client code, once the complete |
|
1043 | 1043 | expression has been built. |
|
1044 | 1044 | |
|
1045 | 1045 | If you want the grammar to require that the entire input string be |
|
1046 | 1046 | successfully parsed, then set parseAll to True (equivalent to ending |
|
1047 | 1047 | the grammar with StringEnd()). |
|
1048 | 1048 | |
|
1049 | 1049 | Note: parseString implicitly calls expandtabs() on the input string, |
|
1050 | 1050 | in order to report proper column numbers in parse actions. |
|
1051 | 1051 | If the input string contains tabs and |
|
1052 | 1052 | the grammar uses parse actions that use the loc argument to index into the |
|
1053 | 1053 | string being parsed, you can ensure you have a consistent view of the input |
|
1054 | 1054 | string by: |
|
1055 | 1055 | - calling parseWithTabs on your grammar before calling parseString |
|
1056 | 1056 | (see L{I{parseWithTabs}<parseWithTabs>}) |
|
1057 | 1057 | - define your parse action using the full (s,loc,toks) signature, and |
|
1058 | 1058 | reference the input string using the parse action's s argument |
|
1059 | 1059 | - explictly expand the tabs in your input string before calling |
|
1060 | 1060 | parseString |
|
1061 | 1061 | """ |
|
1062 | 1062 | ParserElement.resetCache() |
|
1063 | 1063 | if not self.streamlined: |
|
1064 | 1064 | self.streamline() |
|
1065 | 1065 | #~ self.saveAsList = True |
|
1066 | 1066 | for e in self.ignoreExprs: |
|
1067 | 1067 | e.streamline() |
|
1068 | 1068 | if not self.keepTabs: |
|
1069 | 1069 | instring = instring.expandtabs() |
|
1070 | 1070 | try: |
|
1071 | 1071 | loc, tokens = self._parse( instring, 0 ) |
|
1072 | 1072 | if parseAll: |
|
1073 | 1073 | loc = self.preParse( instring, loc ) |
|
1074 | 1074 | StringEnd()._parse( instring, loc ) |
|
1075 | 1075 | except ParseBaseException, exc: |
|
1076 | 1076 | # catch and re-raise exception from here, clears out pyparsing internal stack trace |
|
1077 | 1077 | raise exc |
|
1078 | 1078 | else: |
|
1079 | 1079 | return tokens |
|
1080 | 1080 | |
|
1081 | 1081 | def scanString( self, instring, maxMatches=_MAX_INT ): |
|
1082 | 1082 | """Scan the input string for expression matches. Each match will return the |
|
1083 | 1083 | matching tokens, start location, and end location. May be called with optional |
|
1084 | 1084 | maxMatches argument, to clip scanning after 'n' matches are found. |
|
1085 | 1085 | |
|
1086 | 1086 | Note that the start and end locations are reported relative to the string |
|
1087 | 1087 | being parsed. See L{I{parseString}<parseString>} for more information on parsing |
|
1088 | 1088 | strings with embedded tabs.""" |
|
1089 | 1089 | if not self.streamlined: |
|
1090 | 1090 | self.streamline() |
|
1091 | 1091 | for e in self.ignoreExprs: |
|
1092 | 1092 | e.streamline() |
|
1093 | 1093 | |
|
1094 | 1094 | if not self.keepTabs: |
|
1095 | 1095 | instring = _ustr(instring).expandtabs() |
|
1096 | 1096 | instrlen = len(instring) |
|
1097 | 1097 | loc = 0 |
|
1098 | 1098 | preparseFn = self.preParse |
|
1099 | 1099 | parseFn = self._parse |
|
1100 | 1100 | ParserElement.resetCache() |
|
1101 | 1101 | matches = 0 |
|
1102 | 1102 | try: |
|
1103 | 1103 | while loc <= instrlen and matches < maxMatches: |
|
1104 | 1104 | try: |
|
1105 | 1105 | preloc = preparseFn( instring, loc ) |
|
1106 | 1106 | nextLoc,tokens = parseFn( instring, preloc, callPreParse=False ) |
|
1107 | 1107 | except ParseException: |
|
1108 | 1108 | loc = preloc+1 |
|
1109 | 1109 | else: |
|
1110 | 1110 | matches += 1 |
|
1111 | 1111 | yield tokens, preloc, nextLoc |
|
1112 | 1112 | loc = nextLoc |
|
1113 | 1113 | except ParseBaseException, pe: |
|
1114 | 1114 | raise pe |
|
1115 | 1115 | |
|
1116 | 1116 | def transformString( self, instring ): |
|
1117 | 1117 | """Extension to scanString, to modify matching text with modified tokens that may |
|
1118 | 1118 | be returned from a parse action. To use transformString, define a grammar and |
|
1119 | 1119 | attach a parse action to it that modifies the returned token list. |
|
1120 | 1120 | Invoking transformString() on a target string will then scan for matches, |
|
1121 | 1121 | and replace the matched text patterns according to the logic in the parse |
|
1122 | 1122 | action. transformString() returns the resulting transformed string.""" |
|
1123 | 1123 | out = [] |
|
1124 | 1124 | lastE = 0 |
|
1125 | 1125 | # force preservation of <TAB>s, to minimize unwanted transformation of string, and to |
|
1126 | 1126 | # keep string locs straight between transformString and scanString |
|
1127 | 1127 | self.keepTabs = True |
|
1128 | 1128 | try: |
|
1129 | 1129 | for t,s,e in self.scanString( instring ): |
|
1130 | 1130 | out.append( instring[lastE:s] ) |
|
1131 | 1131 | if t: |
|
1132 | 1132 | if isinstance(t,ParseResults): |
|
1133 | 1133 | out += t.asList() |
|
1134 | 1134 | elif isinstance(t,list): |
|
1135 | 1135 | out += t |
|
1136 | 1136 | else: |
|
1137 | 1137 | out.append(t) |
|
1138 | 1138 | lastE = e |
|
1139 | 1139 | out.append(instring[lastE:]) |
|
1140 | 1140 | return "".join(map(_ustr,out)) |
|
1141 | 1141 | except ParseBaseException, pe: |
|
1142 | 1142 | raise pe |
|
1143 | 1143 | |
|
1144 | 1144 | def searchString( self, instring, maxMatches=_MAX_INT ): |
|
1145 | 1145 | """Another extension to scanString, simplifying the access to the tokens found |
|
1146 | 1146 | to match the given parse expression. May be called with optional |
|
1147 | 1147 | maxMatches argument, to clip searching after 'n' matches are found. |
|
1148 | 1148 | """ |
|
1149 | 1149 | try: |
|
1150 | 1150 | return ParseResults([ t for t,s,e in self.scanString( instring, maxMatches ) ]) |
|
1151 | 1151 | except ParseBaseException, pe: |
|
1152 | 1152 | raise pe |
|
1153 | 1153 | |
|
1154 | 1154 | def __add__(self, other ): |
|
1155 | 1155 | """Implementation of + operator - returns And""" |
|
1156 | 1156 | if isinstance( other, basestring ): |
|
1157 | 1157 | other = Literal( other ) |
|
1158 | 1158 | if not isinstance( other, ParserElement ): |
|
1159 | 1159 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1160 | 1160 | SyntaxWarning, stacklevel=2) |
|
1161 | 1161 | return None |
|
1162 | 1162 | return And( [ self, other ] ) |
|
1163 | 1163 | |
|
1164 | 1164 | def __radd__(self, other ): |
|
1165 | 1165 | """Implementation of + operator when left operand is not a ParserElement""" |
|
1166 | 1166 | if isinstance( other, basestring ): |
|
1167 | 1167 | other = Literal( other ) |
|
1168 | 1168 | if not isinstance( other, ParserElement ): |
|
1169 | 1169 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1170 | 1170 | SyntaxWarning, stacklevel=2) |
|
1171 | 1171 | return None |
|
1172 | 1172 | return other + self |
|
1173 | 1173 | |
|
1174 | 1174 | def __sub__(self, other): |
|
1175 | 1175 | """Implementation of - operator, returns And with error stop""" |
|
1176 | 1176 | if isinstance( other, basestring ): |
|
1177 | 1177 | other = Literal( other ) |
|
1178 | 1178 | if not isinstance( other, ParserElement ): |
|
1179 | 1179 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1180 | 1180 | SyntaxWarning, stacklevel=2) |
|
1181 | 1181 | return None |
|
1182 | 1182 | return And( [ self, And._ErrorStop(), other ] ) |
|
1183 | 1183 | |
|
1184 | 1184 | def __rsub__(self, other ): |
|
1185 | 1185 | """Implementation of - operator when left operand is not a ParserElement""" |
|
1186 | 1186 | if isinstance( other, basestring ): |
|
1187 | 1187 | other = Literal( other ) |
|
1188 | 1188 | if not isinstance( other, ParserElement ): |
|
1189 | 1189 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1190 | 1190 | SyntaxWarning, stacklevel=2) |
|
1191 | 1191 | return None |
|
1192 | 1192 | return other - self |
|
1193 | 1193 | |
|
1194 | 1194 | def __mul__(self,other): |
|
1195 | 1195 | if isinstance(other,int): |
|
1196 | 1196 | minElements, optElements = other,0 |
|
1197 | 1197 | elif isinstance(other,tuple): |
|
1198 | 1198 | other = (other + (None, None))[:2] |
|
1199 | 1199 | if other[0] is None: |
|
1200 | 1200 | other = (0, other[1]) |
|
1201 | 1201 | if isinstance(other[0],int) and other[1] is None: |
|
1202 | 1202 | if other[0] == 0: |
|
1203 | 1203 | return ZeroOrMore(self) |
|
1204 | 1204 | if other[0] == 1: |
|
1205 | 1205 | return OneOrMore(self) |
|
1206 | 1206 | else: |
|
1207 | 1207 | return self*other[0] + ZeroOrMore(self) |
|
1208 | 1208 | elif isinstance(other[0],int) and isinstance(other[1],int): |
|
1209 | 1209 | minElements, optElements = other |
|
1210 | 1210 | optElements -= minElements |
|
1211 | 1211 | else: |
|
1212 | 1212 | raise TypeError("cannot multiply 'ParserElement' and ('%s','%s') objects", type(other[0]),type(other[1])) |
|
1213 | 1213 | else: |
|
1214 | 1214 | raise TypeError("cannot multiply 'ParserElement' and '%s' objects", type(other)) |
|
1215 | 1215 | |
|
1216 | 1216 | if minElements < 0: |
|
1217 | 1217 | raise ValueError("cannot multiply ParserElement by negative value") |
|
1218 | 1218 | if optElements < 0: |
|
1219 | 1219 | raise ValueError("second tuple value must be greater or equal to first tuple value") |
|
1220 | 1220 | if minElements == optElements == 0: |
|
1221 | 1221 | raise ValueError("cannot multiply ParserElement by 0 or (0,0)") |
|
1222 | 1222 | |
|
1223 | 1223 | if (optElements): |
|
1224 | 1224 | def makeOptionalList(n): |
|
1225 | 1225 | if n>1: |
|
1226 | 1226 | return Optional(self + makeOptionalList(n-1)) |
|
1227 | 1227 | else: |
|
1228 | 1228 | return Optional(self) |
|
1229 | 1229 | if minElements: |
|
1230 | 1230 | if minElements == 1: |
|
1231 | 1231 | ret = self + makeOptionalList(optElements) |
|
1232 | 1232 | else: |
|
1233 | 1233 | ret = And([self]*minElements) + makeOptionalList(optElements) |
|
1234 | 1234 | else: |
|
1235 | 1235 | ret = makeOptionalList(optElements) |
|
1236 | 1236 | else: |
|
1237 | 1237 | if minElements == 1: |
|
1238 | 1238 | ret = self |
|
1239 | 1239 | else: |
|
1240 | 1240 | ret = And([self]*minElements) |
|
1241 | 1241 | return ret |
|
1242 | 1242 | |
|
1243 | 1243 | def __rmul__(self, other): |
|
1244 | 1244 | return self.__mul__(other) |
|
1245 | 1245 | |
|
1246 | 1246 | def __or__(self, other ): |
|
1247 | 1247 | """Implementation of | operator - returns MatchFirst""" |
|
1248 | 1248 | if isinstance( other, basestring ): |
|
1249 | 1249 | other = Literal( other ) |
|
1250 | 1250 | if not isinstance( other, ParserElement ): |
|
1251 | 1251 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1252 | 1252 | SyntaxWarning, stacklevel=2) |
|
1253 | 1253 | return None |
|
1254 | 1254 | return MatchFirst( [ self, other ] ) |
|
1255 | 1255 | |
|
1256 | 1256 | def __ror__(self, other ): |
|
1257 | 1257 | """Implementation of | operator when left operand is not a ParserElement""" |
|
1258 | 1258 | if isinstance( other, basestring ): |
|
1259 | 1259 | other = Literal( other ) |
|
1260 | 1260 | if not isinstance( other, ParserElement ): |
|
1261 | 1261 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1262 | 1262 | SyntaxWarning, stacklevel=2) |
|
1263 | 1263 | return None |
|
1264 | 1264 | return other | self |
|
1265 | 1265 | |
|
1266 | 1266 | def __xor__(self, other ): |
|
1267 | 1267 | """Implementation of ^ operator - returns Or""" |
|
1268 | 1268 | if isinstance( other, basestring ): |
|
1269 | 1269 | other = Literal( other ) |
|
1270 | 1270 | if not isinstance( other, ParserElement ): |
|
1271 | 1271 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1272 | 1272 | SyntaxWarning, stacklevel=2) |
|
1273 | 1273 | return None |
|
1274 | 1274 | return Or( [ self, other ] ) |
|
1275 | 1275 | |
|
1276 | 1276 | def __rxor__(self, other ): |
|
1277 | 1277 | """Implementation of ^ operator when left operand is not a ParserElement""" |
|
1278 | 1278 | if isinstance( other, basestring ): |
|
1279 | 1279 | other = Literal( other ) |
|
1280 | 1280 | if not isinstance( other, ParserElement ): |
|
1281 | 1281 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1282 | 1282 | SyntaxWarning, stacklevel=2) |
|
1283 | 1283 | return None |
|
1284 | 1284 | return other ^ self |
|
1285 | 1285 | |
|
1286 | 1286 | def __and__(self, other ): |
|
1287 | 1287 | """Implementation of & operator - returns Each""" |
|
1288 | 1288 | if isinstance( other, basestring ): |
|
1289 | 1289 | other = Literal( other ) |
|
1290 | 1290 | if not isinstance( other, ParserElement ): |
|
1291 | 1291 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1292 | 1292 | SyntaxWarning, stacklevel=2) |
|
1293 | 1293 | return None |
|
1294 | 1294 | return Each( [ self, other ] ) |
|
1295 | 1295 | |
|
1296 | 1296 | def __rand__(self, other ): |
|
1297 | 1297 | """Implementation of & operator when left operand is not a ParserElement""" |
|
1298 | 1298 | if isinstance( other, basestring ): |
|
1299 | 1299 | other = Literal( other ) |
|
1300 | 1300 | if not isinstance( other, ParserElement ): |
|
1301 | 1301 | warnings.warn("Cannot combine element of type %s with ParserElement" % type(other), |
|
1302 | 1302 | SyntaxWarning, stacklevel=2) |
|
1303 | 1303 | return None |
|
1304 | 1304 | return other & self |
|
1305 | 1305 | |
|
1306 | 1306 | def __invert__( self ): |
|
1307 | 1307 | """Implementation of ~ operator - returns NotAny""" |
|
1308 | 1308 | return NotAny( self ) |
|
1309 | 1309 | |
|
1310 | 1310 | def __call__(self, name): |
|
1311 | 1311 | """Shortcut for setResultsName, with listAllMatches=default:: |
|
1312 | 1312 | userdata = Word(alphas).setResultsName("name") + Word(nums+"-").setResultsName("socsecno") |
|
1313 | 1313 | could be written as:: |
|
1314 | 1314 | userdata = Word(alphas)("name") + Word(nums+"-")("socsecno") |
|
1315 | 1315 | """ |
|
1316 | 1316 | return self.setResultsName(name) |
|
1317 | 1317 | |
|
1318 | 1318 | def suppress( self ): |
|
1319 | 1319 | """Suppresses the output of this ParserElement; useful to keep punctuation from |
|
1320 | 1320 | cluttering up returned output. |
|
1321 | 1321 | """ |
|
1322 | 1322 | return Suppress( self ) |
|
1323 | 1323 | |
|
1324 | 1324 | def leaveWhitespace( self ): |
|
1325 | 1325 | """Disables the skipping of whitespace before matching the characters in the |
|
1326 | 1326 | ParserElement's defined pattern. This is normally only used internally by |
|
1327 | 1327 | the pyparsing module, but may be needed in some whitespace-sensitive grammars. |
|
1328 | 1328 | """ |
|
1329 | 1329 | self.skipWhitespace = False |
|
1330 | 1330 | return self |
|
1331 | 1331 | |
|
1332 | 1332 | def setWhitespaceChars( self, chars ): |
|
1333 | 1333 | """Overrides the default whitespace chars |
|
1334 | 1334 | """ |
|
1335 | 1335 | self.skipWhitespace = True |
|
1336 | 1336 | self.whiteChars = chars |
|
1337 | 1337 | self.copyDefaultWhiteChars = False |
|
1338 | 1338 | return self |
|
1339 | 1339 | |
|
1340 | 1340 | def parseWithTabs( self ): |
|
1341 | 1341 | """Overrides default behavior to expand <TAB>s to spaces before parsing the input string. |
|
1342 | 1342 | Must be called before parseString when the input grammar contains elements that |
|
1343 | 1343 | match <TAB> characters.""" |
|
1344 | 1344 | self.keepTabs = True |
|
1345 | 1345 | return self |
|
1346 | 1346 | |
|
1347 | 1347 | def ignore( self, other ): |
|
1348 | 1348 | """Define expression to be ignored (e.g., comments) while doing pattern |
|
1349 | 1349 | matching; may be called repeatedly, to define multiple comment or other |
|
1350 | 1350 | ignorable patterns. |
|
1351 | 1351 | """ |
|
1352 | 1352 | if isinstance( other, Suppress ): |
|
1353 | 1353 | if other not in self.ignoreExprs: |
|
1354 | 1354 | self.ignoreExprs.append( other ) |
|
1355 | 1355 | else: |
|
1356 | 1356 | self.ignoreExprs.append( Suppress( other ) ) |
|
1357 | 1357 | return self |
|
1358 | 1358 | |
|
1359 | 1359 | def setDebugActions( self, startAction, successAction, exceptionAction ): |
|
1360 | 1360 | """Enable display of debugging messages while doing pattern matching.""" |
|
1361 | 1361 | self.debugActions = (startAction or _defaultStartDebugAction, |
|
1362 | 1362 | successAction or _defaultSuccessDebugAction, |
|
1363 | 1363 | exceptionAction or _defaultExceptionDebugAction) |
|
1364 | 1364 | self.debug = True |
|
1365 | 1365 | return self |
|
1366 | 1366 | |
|
1367 | 1367 | def setDebug( self, flag=True ): |
|
1368 | 1368 | """Enable display of debugging messages while doing pattern matching. |
|
1369 | 1369 | Set flag to True to enable, False to disable.""" |
|
1370 | 1370 | if flag: |
|
1371 | 1371 | self.setDebugActions( _defaultStartDebugAction, _defaultSuccessDebugAction, _defaultExceptionDebugAction ) |
|
1372 | 1372 | else: |
|
1373 | 1373 | self.debug = False |
|
1374 | 1374 | return self |
|
1375 | 1375 | |
|
1376 | 1376 | def __str__( self ): |
|
1377 | 1377 | return self.name |
|
1378 | 1378 | |
|
1379 | 1379 | def __repr__( self ): |
|
1380 | 1380 | return _ustr(self) |
|
1381 | 1381 | |
|
1382 | 1382 | def streamline( self ): |
|
1383 | 1383 | self.streamlined = True |
|
1384 | 1384 | self.strRepr = None |
|
1385 | 1385 | return self |
|
1386 | 1386 | |
|
1387 | 1387 | def checkRecursion( self, parseElementList ): |
|
1388 | 1388 | pass |
|
1389 | 1389 | |
|
1390 | 1390 | def validate( self, validateTrace=[] ): |
|
1391 | 1391 | """Check defined expressions for valid structure, check for infinite recursive definitions.""" |
|
1392 | 1392 | self.checkRecursion( [] ) |
|
1393 | 1393 | |
|
1394 | 1394 | def parseFile( self, file_or_filename, parseAll=False ): |
|
1395 | 1395 | """Execute the parse expression on the given file or filename. |
|
1396 | 1396 | If a filename is specified (instead of a file object), |
|
1397 | 1397 | the entire file is opened, read, and closed before parsing. |
|
1398 | 1398 | """ |
|
1399 | 1399 | try: |
|
1400 | 1400 | file_contents = file_or_filename.read() |
|
1401 | 1401 | except AttributeError: |
|
1402 | 1402 | f = open(file_or_filename, "rb") |
|
1403 | 1403 | file_contents = f.read() |
|
1404 | 1404 | f.close() |
|
1405 | 1405 | try: |
|
1406 | 1406 | return self.parseString(file_contents, parseAll) |
|
1407 | 1407 | except ParseBaseException, exc: |
|
1408 | 1408 | # catch and re-raise exception from here, clears out pyparsing internal stack trace |
|
1409 | 1409 | raise exc |
|
1410 | 1410 | |
|
1411 | 1411 | def getException(self): |
|
1412 | 1412 | return ParseException("",0,self.errmsg,self) |
|
1413 | 1413 | |
|
1414 | 1414 | def __getattr__(self,aname): |
|
1415 | 1415 | if aname == "myException": |
|
1416 | 1416 | self.myException = ret = self.getException(); |
|
1417 | 1417 | return ret; |
|
1418 | 1418 | else: |
|
1419 | 1419 | raise AttributeError("no such attribute " + aname) |
|
1420 | 1420 | |
|
1421 | 1421 | def __eq__(self,other): |
|
1422 | 1422 | if isinstance(other, ParserElement): |
|
1423 | 1423 | return self is other or self.__dict__ == other.__dict__ |
|
1424 | 1424 | elif isinstance(other, basestring): |
|
1425 | 1425 | try: |
|
1426 | 1426 | self.parseString(_ustr(other), parseAll=True) |
|
1427 | 1427 | return True |
|
1428 | 1428 | except ParseBaseException: |
|
1429 | 1429 | return False |
|
1430 | 1430 | else: |
|
1431 | 1431 | return super(ParserElement,self)==other |
|
1432 | 1432 | |
|
1433 | 1433 | def __ne__(self,other): |
|
1434 | 1434 | return not (self == other) |
|
1435 | 1435 | |
|
1436 | 1436 | def __hash__(self): |
|
1437 | 1437 | return hash(id(self)) |
|
1438 | 1438 | |
|
1439 | 1439 | def __req__(self,other): |
|
1440 | 1440 | return self == other |
|
1441 | 1441 | |
|
1442 | 1442 | def __rne__(self,other): |
|
1443 | 1443 | return not (self == other) |
|
1444 | 1444 | |
|
1445 | 1445 | |
|
1446 | 1446 | class Token(ParserElement): |
|
1447 | 1447 | """Abstract ParserElement subclass, for defining atomic matching patterns.""" |
|
1448 | 1448 | def __init__( self ): |
|
1449 | 1449 | super(Token,self).__init__( savelist=False ) |
|
1450 | 1450 | #self.myException = ParseException("",0,"",self) |
|
1451 | 1451 | |
|
1452 | 1452 | def setName(self, name): |
|
1453 | 1453 | s = super(Token,self).setName(name) |
|
1454 | 1454 | self.errmsg = "Expected " + self.name |
|
1455 | 1455 | #s.myException.msg = self.errmsg |
|
1456 | 1456 | return s |
|
1457 | 1457 | |
|
1458 | 1458 | |
|
1459 | 1459 | class Empty(Token): |
|
1460 | 1460 | """An empty token, will always match.""" |
|
1461 | 1461 | def __init__( self ): |
|
1462 | 1462 | super(Empty,self).__init__() |
|
1463 | 1463 | self.name = "Empty" |
|
1464 | 1464 | self.mayReturnEmpty = True |
|
1465 | 1465 | self.mayIndexError = False |
|
1466 | 1466 | |
|
1467 | 1467 | |
|
1468 | 1468 | class NoMatch(Token): |
|
1469 | 1469 | """A token that will never match.""" |
|
1470 | 1470 | def __init__( self ): |
|
1471 | 1471 | super(NoMatch,self).__init__() |
|
1472 | 1472 | self.name = "NoMatch" |
|
1473 | 1473 | self.mayReturnEmpty = True |
|
1474 | 1474 | self.mayIndexError = False |
|
1475 | 1475 | self.errmsg = "Unmatchable token" |
|
1476 | 1476 | #self.myException.msg = self.errmsg |
|
1477 | 1477 | |
|
1478 | 1478 | def parseImpl( self, instring, loc, doActions=True ): |
|
1479 | 1479 | exc = self.myException |
|
1480 | 1480 | exc.loc = loc |
|
1481 | 1481 | exc.pstr = instring |
|
1482 | 1482 | raise exc |
|
1483 | 1483 | |
|
1484 | 1484 | |
|
1485 | 1485 | class Literal(Token): |
|
1486 | 1486 | """Token to exactly match a specified string.""" |
|
1487 | 1487 | def __init__( self, matchString ): |
|
1488 | 1488 | super(Literal,self).__init__() |
|
1489 | 1489 | self.match = matchString |
|
1490 | 1490 | self.matchLen = len(matchString) |
|
1491 | 1491 | try: |
|
1492 | 1492 | self.firstMatchChar = matchString[0] |
|
1493 | 1493 | except IndexError: |
|
1494 | 1494 | warnings.warn("null string passed to Literal; use Empty() instead", |
|
1495 | 1495 | SyntaxWarning, stacklevel=2) |
|
1496 | 1496 | self.__class__ = Empty |
|
1497 | 1497 | self.name = '"%s"' % _ustr(self.match) |
|
1498 | 1498 | self.errmsg = "Expected " + self.name |
|
1499 | 1499 | self.mayReturnEmpty = False |
|
1500 | 1500 | #self.myException.msg = self.errmsg |
|
1501 | 1501 | self.mayIndexError = False |
|
1502 | 1502 | |
|
1503 | 1503 | # Performance tuning: this routine gets called a *lot* |
|
1504 | 1504 | # if this is a single character match string and the first character matches, |
|
1505 | 1505 | # short-circuit as quickly as possible, and avoid calling startswith |
|
1506 | 1506 | #~ @profile |
|
1507 | 1507 | def parseImpl( self, instring, loc, doActions=True ): |
|
1508 | 1508 | if (instring[loc] == self.firstMatchChar and |
|
1509 | 1509 | (self.matchLen==1 or instring.startswith(self.match,loc)) ): |
|
1510 | 1510 | return loc+self.matchLen, self.match |
|
1511 | 1511 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1512 | 1512 | exc = self.myException |
|
1513 | 1513 | exc.loc = loc |
|
1514 | 1514 | exc.pstr = instring |
|
1515 | 1515 | raise exc |
|
1516 | 1516 | _L = Literal |
|
1517 | 1517 | |
|
1518 | 1518 | class Keyword(Token): |
|
1519 | 1519 | """Token to exactly match a specified string as a keyword, that is, it must be |
|
1520 | 1520 | immediately followed by a non-keyword character. Compare with Literal:: |
|
1521 | 1521 | Literal("if") will match the leading 'if' in 'ifAndOnlyIf'. |
|
1522 | 1522 | Keyword("if") will not; it will only match the leading 'if in 'if x=1', or 'if(y==2)' |
|
1523 | 1523 | Accepts two optional constructor arguments in addition to the keyword string: |
|
1524 | 1524 | identChars is a string of characters that would be valid identifier characters, |
|
1525 | 1525 | defaulting to all alphanumerics + "_" and "$"; caseless allows case-insensitive |
|
1526 | 1526 | matching, default is False. |
|
1527 | 1527 | """ |
|
1528 | 1528 | DEFAULT_KEYWORD_CHARS = alphanums+"_$" |
|
1529 | 1529 | |
|
1530 | 1530 | def __init__( self, matchString, identChars=DEFAULT_KEYWORD_CHARS, caseless=False ): |
|
1531 | 1531 | super(Keyword,self).__init__() |
|
1532 | 1532 | self.match = matchString |
|
1533 | 1533 | self.matchLen = len(matchString) |
|
1534 | 1534 | try: |
|
1535 | 1535 | self.firstMatchChar = matchString[0] |
|
1536 | 1536 | except IndexError: |
|
1537 | 1537 | warnings.warn("null string passed to Keyword; use Empty() instead", |
|
1538 | 1538 | SyntaxWarning, stacklevel=2) |
|
1539 | 1539 | self.name = '"%s"' % self.match |
|
1540 | 1540 | self.errmsg = "Expected " + self.name |
|
1541 | 1541 | self.mayReturnEmpty = False |
|
1542 | 1542 | #self.myException.msg = self.errmsg |
|
1543 | 1543 | self.mayIndexError = False |
|
1544 | 1544 | self.caseless = caseless |
|
1545 | 1545 | if caseless: |
|
1546 | 1546 | self.caselessmatch = matchString.upper() |
|
1547 | 1547 | identChars = identChars.upper() |
|
1548 | 1548 | self.identChars = _str2dict(identChars) |
|
1549 | 1549 | |
|
1550 | 1550 | def parseImpl( self, instring, loc, doActions=True ): |
|
1551 | 1551 | if self.caseless: |
|
1552 | 1552 | if ( (instring[ loc:loc+self.matchLen ].upper() == self.caselessmatch) and |
|
1553 | 1553 | (loc >= len(instring)-self.matchLen or instring[loc+self.matchLen].upper() not in self.identChars) and |
|
1554 | 1554 | (loc == 0 or instring[loc-1].upper() not in self.identChars) ): |
|
1555 | 1555 | return loc+self.matchLen, self.match |
|
1556 | 1556 | else: |
|
1557 | 1557 | if (instring[loc] == self.firstMatchChar and |
|
1558 | 1558 | (self.matchLen==1 or instring.startswith(self.match,loc)) and |
|
1559 | 1559 | (loc >= len(instring)-self.matchLen or instring[loc+self.matchLen] not in self.identChars) and |
|
1560 | 1560 | (loc == 0 or instring[loc-1] not in self.identChars) ): |
|
1561 | 1561 | return loc+self.matchLen, self.match |
|
1562 | 1562 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1563 | 1563 | exc = self.myException |
|
1564 | 1564 | exc.loc = loc |
|
1565 | 1565 | exc.pstr = instring |
|
1566 | 1566 | raise exc |
|
1567 | 1567 | |
|
1568 | 1568 | def copy(self): |
|
1569 | 1569 | c = super(Keyword,self).copy() |
|
1570 | 1570 | c.identChars = Keyword.DEFAULT_KEYWORD_CHARS |
|
1571 | 1571 | return c |
|
1572 | 1572 | |
|
1573 | 1573 | def setDefaultKeywordChars( chars ): |
|
1574 | 1574 | """Overrides the default Keyword chars |
|
1575 | 1575 | """ |
|
1576 | 1576 | Keyword.DEFAULT_KEYWORD_CHARS = chars |
|
1577 | 1577 | setDefaultKeywordChars = staticmethod(setDefaultKeywordChars) |
|
1578 | 1578 | |
|
1579 | 1579 | class CaselessLiteral(Literal): |
|
1580 | 1580 | """Token to match a specified string, ignoring case of letters. |
|
1581 | 1581 | Note: the matched results will always be in the case of the given |
|
1582 | 1582 | match string, NOT the case of the input text. |
|
1583 | 1583 | """ |
|
1584 | 1584 | def __init__( self, matchString ): |
|
1585 | 1585 | super(CaselessLiteral,self).__init__( matchString.upper() ) |
|
1586 | 1586 | # Preserve the defining literal. |
|
1587 | 1587 | self.returnString = matchString |
|
1588 | 1588 | self.name = "'%s'" % self.returnString |
|
1589 | 1589 | self.errmsg = "Expected " + self.name |
|
1590 | 1590 | #self.myException.msg = self.errmsg |
|
1591 | 1591 | |
|
1592 | 1592 | def parseImpl( self, instring, loc, doActions=True ): |
|
1593 | 1593 | if instring[ loc:loc+self.matchLen ].upper() == self.match: |
|
1594 | 1594 | return loc+self.matchLen, self.returnString |
|
1595 | 1595 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1596 | 1596 | exc = self.myException |
|
1597 | 1597 | exc.loc = loc |
|
1598 | 1598 | exc.pstr = instring |
|
1599 | 1599 | raise exc |
|
1600 | 1600 | |
|
1601 | 1601 | class CaselessKeyword(Keyword): |
|
1602 | 1602 | def __init__( self, matchString, identChars=Keyword.DEFAULT_KEYWORD_CHARS ): |
|
1603 | 1603 | super(CaselessKeyword,self).__init__( matchString, identChars, caseless=True ) |
|
1604 | 1604 | |
|
1605 | 1605 | def parseImpl( self, instring, loc, doActions=True ): |
|
1606 | 1606 | if ( (instring[ loc:loc+self.matchLen ].upper() == self.caselessmatch) and |
|
1607 | 1607 | (loc >= len(instring)-self.matchLen or instring[loc+self.matchLen].upper() not in self.identChars) ): |
|
1608 | 1608 | return loc+self.matchLen, self.match |
|
1609 | 1609 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1610 | 1610 | exc = self.myException |
|
1611 | 1611 | exc.loc = loc |
|
1612 | 1612 | exc.pstr = instring |
|
1613 | 1613 | raise exc |
|
1614 | 1614 | |
|
1615 | 1615 | class Word(Token): |
|
1616 | 1616 | """Token for matching words composed of allowed character sets. |
|
1617 | 1617 | Defined with string containing all allowed initial characters, |
|
1618 | 1618 | an optional string containing allowed body characters (if omitted, |
|
1619 | 1619 | defaults to the initial character set), and an optional minimum, |
|
1620 | 1620 | maximum, and/or exact length. The default value for min is 1 (a |
|
1621 | 1621 | minimum value < 1 is not valid); the default values for max and exact |
|
1622 | 1622 | are 0, meaning no maximum or exact length restriction. |
|
1623 | 1623 | """ |
|
1624 | 1624 | def __init__( self, initChars, bodyChars=None, min=1, max=0, exact=0, asKeyword=False ): |
|
1625 | 1625 | super(Word,self).__init__() |
|
1626 | 1626 | self.initCharsOrig = initChars |
|
1627 | 1627 | self.initChars = _str2dict(initChars) |
|
1628 | 1628 | if bodyChars : |
|
1629 | 1629 | self.bodyCharsOrig = bodyChars |
|
1630 | 1630 | self.bodyChars = _str2dict(bodyChars) |
|
1631 | 1631 | else: |
|
1632 | 1632 | self.bodyCharsOrig = initChars |
|
1633 | 1633 | self.bodyChars = _str2dict(initChars) |
|
1634 | 1634 | |
|
1635 | 1635 | self.maxSpecified = max > 0 |
|
1636 | 1636 | |
|
1637 | 1637 | if min < 1: |
|
1638 | 1638 | raise ValueError("cannot specify a minimum length < 1; use Optional(Word()) if zero-length word is permitted") |
|
1639 | 1639 | |
|
1640 | 1640 | self.minLen = min |
|
1641 | 1641 | |
|
1642 | 1642 | if max > 0: |
|
1643 | 1643 | self.maxLen = max |
|
1644 | 1644 | else: |
|
1645 | 1645 | self.maxLen = _MAX_INT |
|
1646 | 1646 | |
|
1647 | 1647 | if exact > 0: |
|
1648 | 1648 | self.maxLen = exact |
|
1649 | 1649 | self.minLen = exact |
|
1650 | 1650 | |
|
1651 | 1651 | self.name = _ustr(self) |
|
1652 | 1652 | self.errmsg = "Expected " + self.name |
|
1653 | 1653 | #self.myException.msg = self.errmsg |
|
1654 | 1654 | self.mayIndexError = False |
|
1655 | 1655 | self.asKeyword = asKeyword |
|
1656 | 1656 | |
|
1657 | 1657 | if ' ' not in self.initCharsOrig+self.bodyCharsOrig and (min==1 and max==0 and exact==0): |
|
1658 | 1658 | if self.bodyCharsOrig == self.initCharsOrig: |
|
1659 | 1659 | self.reString = "[%s]+" % _escapeRegexRangeChars(self.initCharsOrig) |
|
1660 | 1660 | elif len(self.bodyCharsOrig) == 1: |
|
1661 | 1661 | self.reString = "%s[%s]*" % \ |
|
1662 | 1662 | (re.escape(self.initCharsOrig), |
|
1663 | 1663 | _escapeRegexRangeChars(self.bodyCharsOrig),) |
|
1664 | 1664 | else: |
|
1665 | 1665 | self.reString = "[%s][%s]*" % \ |
|
1666 | 1666 | (_escapeRegexRangeChars(self.initCharsOrig), |
|
1667 | 1667 | _escapeRegexRangeChars(self.bodyCharsOrig),) |
|
1668 | 1668 | if self.asKeyword: |
|
1669 | 1669 | self.reString = r"\b"+self.reString+r"\b" |
|
1670 | 1670 | try: |
|
1671 | 1671 | self.re = re.compile( self.reString ) |
|
1672 | 1672 | except: |
|
1673 | 1673 | self.re = None |
|
1674 | 1674 | |
|
1675 | 1675 | def parseImpl( self, instring, loc, doActions=True ): |
|
1676 | 1676 | if self.re: |
|
1677 | 1677 | result = self.re.match(instring,loc) |
|
1678 | 1678 | if not result: |
|
1679 | 1679 | exc = self.myException |
|
1680 | 1680 | exc.loc = loc |
|
1681 | 1681 | exc.pstr = instring |
|
1682 | 1682 | raise exc |
|
1683 | 1683 | |
|
1684 | 1684 | loc = result.end() |
|
1685 | 1685 | return loc,result.group() |
|
1686 | 1686 | |
|
1687 | 1687 | if not(instring[ loc ] in self.initChars): |
|
1688 | 1688 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1689 | 1689 | exc = self.myException |
|
1690 | 1690 | exc.loc = loc |
|
1691 | 1691 | exc.pstr = instring |
|
1692 | 1692 | raise exc |
|
1693 | 1693 | start = loc |
|
1694 | 1694 | loc += 1 |
|
1695 | 1695 | instrlen = len(instring) |
|
1696 | 1696 | bodychars = self.bodyChars |
|
1697 | 1697 | maxloc = start + self.maxLen |
|
1698 | 1698 | maxloc = min( maxloc, instrlen ) |
|
1699 | 1699 | while loc < maxloc and instring[loc] in bodychars: |
|
1700 | 1700 | loc += 1 |
|
1701 | 1701 | |
|
1702 | 1702 | throwException = False |
|
1703 | 1703 | if loc - start < self.minLen: |
|
1704 | 1704 | throwException = True |
|
1705 | 1705 | if self.maxSpecified and loc < instrlen and instring[loc] in bodychars: |
|
1706 | 1706 | throwException = True |
|
1707 | 1707 | if self.asKeyword: |
|
1708 | 1708 | if (start>0 and instring[start-1] in bodychars) or (loc<instrlen and instring[loc] in bodychars): |
|
1709 | 1709 | throwException = True |
|
1710 | 1710 | |
|
1711 | 1711 | if throwException: |
|
1712 | 1712 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1713 | 1713 | exc = self.myException |
|
1714 | 1714 | exc.loc = loc |
|
1715 | 1715 | exc.pstr = instring |
|
1716 | 1716 | raise exc |
|
1717 | 1717 | |
|
1718 | 1718 | return loc, instring[start:loc] |
|
1719 | 1719 | |
|
1720 | 1720 | def __str__( self ): |
|
1721 | 1721 | try: |
|
1722 | 1722 | return super(Word,self).__str__() |
|
1723 | 1723 | except: |
|
1724 | 1724 | pass |
|
1725 | 1725 | |
|
1726 | 1726 | |
|
1727 | 1727 | if self.strRepr is None: |
|
1728 | 1728 | |
|
1729 | 1729 | def charsAsStr(s): |
|
1730 | 1730 | if len(s)>4: |
|
1731 | 1731 | return s[:4]+"..." |
|
1732 | 1732 | else: |
|
1733 | 1733 | return s |
|
1734 | 1734 | |
|
1735 | 1735 | if ( self.initCharsOrig != self.bodyCharsOrig ): |
|
1736 | 1736 | self.strRepr = "W:(%s,%s)" % ( charsAsStr(self.initCharsOrig), charsAsStr(self.bodyCharsOrig) ) |
|
1737 | 1737 | else: |
|
1738 | 1738 | self.strRepr = "W:(%s)" % charsAsStr(self.initCharsOrig) |
|
1739 | 1739 | |
|
1740 | 1740 | return self.strRepr |
|
1741 | 1741 | |
|
1742 | 1742 | |
|
1743 | 1743 | class Regex(Token): |
|
1744 | 1744 | """Token for matching strings that match a given regular expression. |
|
1745 | 1745 | Defined with string specifying the regular expression in a form recognized by the inbuilt Python re module. |
|
1746 | 1746 | """ |
|
1747 | 1747 | def __init__( self, pattern, flags=0): |
|
1748 | 1748 | """The parameters pattern and flags are passed to the re.compile() function as-is. See the Python re module for an explanation of the acceptable patterns and flags.""" |
|
1749 | 1749 | super(Regex,self).__init__() |
|
1750 | 1750 | |
|
1751 | 1751 | if len(pattern) == 0: |
|
1752 | 1752 | warnings.warn("null string passed to Regex; use Empty() instead", |
|
1753 | 1753 | SyntaxWarning, stacklevel=2) |
|
1754 | 1754 | |
|
1755 | 1755 | self.pattern = pattern |
|
1756 | 1756 | self.flags = flags |
|
1757 | 1757 | |
|
1758 | 1758 | try: |
|
1759 | 1759 | self.re = re.compile(self.pattern, self.flags) |
|
1760 | 1760 | self.reString = self.pattern |
|
1761 | 1761 | except sre_constants.error: |
|
1762 | 1762 | warnings.warn("invalid pattern (%s) passed to Regex" % pattern, |
|
1763 | 1763 | SyntaxWarning, stacklevel=2) |
|
1764 | 1764 | raise |
|
1765 | 1765 | |
|
1766 | 1766 | self.name = _ustr(self) |
|
1767 | 1767 | self.errmsg = "Expected " + self.name |
|
1768 | 1768 | #self.myException.msg = self.errmsg |
|
1769 | 1769 | self.mayIndexError = False |
|
1770 | 1770 | self.mayReturnEmpty = True |
|
1771 | 1771 | |
|
1772 | 1772 | def parseImpl( self, instring, loc, doActions=True ): |
|
1773 | 1773 | result = self.re.match(instring,loc) |
|
1774 | 1774 | if not result: |
|
1775 | 1775 | exc = self.myException |
|
1776 | 1776 | exc.loc = loc |
|
1777 | 1777 | exc.pstr = instring |
|
1778 | 1778 | raise exc |
|
1779 | 1779 | |
|
1780 | 1780 | loc = result.end() |
|
1781 | 1781 | d = result.groupdict() |
|
1782 | 1782 | ret = ParseResults(result.group()) |
|
1783 | 1783 | if d: |
|
1784 | 1784 | for k in d: |
|
1785 | 1785 | ret[k] = d[k] |
|
1786 | 1786 | return loc,ret |
|
1787 | 1787 | |
|
1788 | 1788 | def __str__( self ): |
|
1789 | 1789 | try: |
|
1790 | 1790 | return super(Regex,self).__str__() |
|
1791 | 1791 | except: |
|
1792 | 1792 | pass |
|
1793 | 1793 | |
|
1794 | 1794 | if self.strRepr is None: |
|
1795 | 1795 | self.strRepr = "Re:(%s)" % repr(self.pattern) |
|
1796 | 1796 | |
|
1797 | 1797 | return self.strRepr |
|
1798 | 1798 | |
|
1799 | 1799 | |
|
1800 | 1800 | class QuotedString(Token): |
|
1801 | 1801 | """Token for matching strings that are delimited by quoting characters. |
|
1802 | 1802 | """ |
|
1803 | 1803 | def __init__( self, quoteChar, escChar=None, escQuote=None, multiline=False, unquoteResults=True, endQuoteChar=None): |
|
1804 | 1804 | """ |
|
1805 | 1805 | Defined with the following parameters: |
|
1806 | 1806 | - quoteChar - string of one or more characters defining the quote delimiting string |
|
1807 | 1807 | - escChar - character to escape quotes, typically backslash (default=None) |
|
1808 | 1808 | - escQuote - special quote sequence to escape an embedded quote string (such as SQL's "" to escape an embedded ") (default=None) |
|
1809 | 1809 | - multiline - boolean indicating whether quotes can span multiple lines (default=False) |
|
1810 | 1810 | - unquoteResults - boolean indicating whether the matched text should be unquoted (default=True) |
|
1811 | 1811 | - endQuoteChar - string of one or more characters defining the end of the quote delimited string (default=None => same as quoteChar) |
|
1812 | 1812 | """ |
|
1813 | 1813 | super(QuotedString,self).__init__() |
|
1814 | 1814 | |
|
1815 | 1815 | # remove white space from quote chars - wont work anyway |
|
1816 | 1816 | quoteChar = quoteChar.strip() |
|
1817 | 1817 | if len(quoteChar) == 0: |
|
1818 | 1818 | warnings.warn("quoteChar cannot be the empty string",SyntaxWarning,stacklevel=2) |
|
1819 | 1819 | raise SyntaxError() |
|
1820 | 1820 | |
|
1821 | 1821 | if endQuoteChar is None: |
|
1822 | 1822 | endQuoteChar = quoteChar |
|
1823 | 1823 | else: |
|
1824 | 1824 | endQuoteChar = endQuoteChar.strip() |
|
1825 | 1825 | if len(endQuoteChar) == 0: |
|
1826 | 1826 | warnings.warn("endQuoteChar cannot be the empty string",SyntaxWarning,stacklevel=2) |
|
1827 | 1827 | raise SyntaxError() |
|
1828 | 1828 | |
|
1829 | 1829 | self.quoteChar = quoteChar |
|
1830 | 1830 | self.quoteCharLen = len(quoteChar) |
|
1831 | 1831 | self.firstQuoteChar = quoteChar[0] |
|
1832 | 1832 | self.endQuoteChar = endQuoteChar |
|
1833 | 1833 | self.endQuoteCharLen = len(endQuoteChar) |
|
1834 | 1834 | self.escChar = escChar |
|
1835 | 1835 | self.escQuote = escQuote |
|
1836 | 1836 | self.unquoteResults = unquoteResults |
|
1837 | 1837 | |
|
1838 | 1838 | if multiline: |
|
1839 | 1839 | self.flags = re.MULTILINE | re.DOTALL |
|
1840 | 1840 | self.pattern = r'%s(?:[^%s%s]' % \ |
|
1841 | 1841 | ( re.escape(self.quoteChar), |
|
1842 | 1842 | _escapeRegexRangeChars(self.endQuoteChar[0]), |
|
1843 | 1843 | (escChar is not None and _escapeRegexRangeChars(escChar) or '') ) |
|
1844 | 1844 | else: |
|
1845 | 1845 | self.flags = 0 |
|
1846 | 1846 | self.pattern = r'%s(?:[^%s\n\r%s]' % \ |
|
1847 | 1847 | ( re.escape(self.quoteChar), |
|
1848 | 1848 | _escapeRegexRangeChars(self.endQuoteChar[0]), |
|
1849 | 1849 | (escChar is not None and _escapeRegexRangeChars(escChar) or '') ) |
|
1850 | 1850 | if len(self.endQuoteChar) > 1: |
|
1851 | 1851 | self.pattern += ( |
|
1852 | 1852 | '|(?:' + ')|(?:'.join(["%s[^%s]" % (re.escape(self.endQuoteChar[:i]), |
|
1853 | 1853 | _escapeRegexRangeChars(self.endQuoteChar[i])) |
|
1854 | 1854 | for i in range(len(self.endQuoteChar)-1,0,-1)]) + ')' |
|
1855 | 1855 | ) |
|
1856 | 1856 | if escQuote: |
|
1857 | 1857 | self.pattern += (r'|(?:%s)' % re.escape(escQuote)) |
|
1858 | 1858 | if escChar: |
|
1859 | 1859 | self.pattern += (r'|(?:%s.)' % re.escape(escChar)) |
|
1860 | 1860 | self.escCharReplacePattern = re.escape(self.escChar)+"(.)" |
|
1861 | 1861 | self.pattern += (r')*%s' % re.escape(self.endQuoteChar)) |
|
1862 | 1862 | |
|
1863 | 1863 | try: |
|
1864 | 1864 | self.re = re.compile(self.pattern, self.flags) |
|
1865 | 1865 | self.reString = self.pattern |
|
1866 | 1866 | except sre_constants.error: |
|
1867 | 1867 | warnings.warn("invalid pattern (%s) passed to Regex" % self.pattern, |
|
1868 | 1868 | SyntaxWarning, stacklevel=2) |
|
1869 | 1869 | raise |
|
1870 | 1870 | |
|
1871 | 1871 | self.name = _ustr(self) |
|
1872 | 1872 | self.errmsg = "Expected " + self.name |
|
1873 | 1873 | #self.myException.msg = self.errmsg |
|
1874 | 1874 | self.mayIndexError = False |
|
1875 | 1875 | self.mayReturnEmpty = True |
|
1876 | 1876 | |
|
1877 | 1877 | def parseImpl( self, instring, loc, doActions=True ): |
|
1878 | 1878 | result = instring[loc] == self.firstQuoteChar and self.re.match(instring,loc) or None |
|
1879 | 1879 | if not result: |
|
1880 | 1880 | exc = self.myException |
|
1881 | 1881 | exc.loc = loc |
|
1882 | 1882 | exc.pstr = instring |
|
1883 | 1883 | raise exc |
|
1884 | 1884 | |
|
1885 | 1885 | loc = result.end() |
|
1886 | 1886 | ret = result.group() |
|
1887 | 1887 | |
|
1888 | 1888 | if self.unquoteResults: |
|
1889 | 1889 | |
|
1890 | 1890 | # strip off quotes |
|
1891 | 1891 | ret = ret[self.quoteCharLen:-self.endQuoteCharLen] |
|
1892 | 1892 | |
|
1893 | 1893 | if isinstance(ret,basestring): |
|
1894 | 1894 | # replace escaped characters |
|
1895 | 1895 | if self.escChar: |
|
1896 | 1896 | ret = re.sub(self.escCharReplacePattern,"\g<1>",ret) |
|
1897 | 1897 | |
|
1898 | 1898 | # replace escaped quotes |
|
1899 | 1899 | if self.escQuote: |
|
1900 | 1900 | ret = ret.replace(self.escQuote, self.endQuoteChar) |
|
1901 | 1901 | |
|
1902 | 1902 | return loc, ret |
|
1903 | 1903 | |
|
1904 | 1904 | def __str__( self ): |
|
1905 | 1905 | try: |
|
1906 | 1906 | return super(QuotedString,self).__str__() |
|
1907 | 1907 | except: |
|
1908 | 1908 | pass |
|
1909 | 1909 | |
|
1910 | 1910 | if self.strRepr is None: |
|
1911 | 1911 | self.strRepr = "quoted string, starting with %s ending with %s" % (self.quoteChar, self.endQuoteChar) |
|
1912 | 1912 | |
|
1913 | 1913 | return self.strRepr |
|
1914 | 1914 | |
|
1915 | 1915 | |
|
1916 | 1916 | class CharsNotIn(Token): |
|
1917 | 1917 | """Token for matching words composed of characters *not* in a given set. |
|
1918 | 1918 | Defined with string containing all disallowed characters, and an optional |
|
1919 | 1919 | minimum, maximum, and/or exact length. The default value for min is 1 (a |
|
1920 | 1920 | minimum value < 1 is not valid); the default values for max and exact |
|
1921 | 1921 | are 0, meaning no maximum or exact length restriction. |
|
1922 | 1922 | """ |
|
1923 | 1923 | def __init__( self, notChars, min=1, max=0, exact=0 ): |
|
1924 | 1924 | super(CharsNotIn,self).__init__() |
|
1925 | 1925 | self.skipWhitespace = False |
|
1926 | 1926 | self.notChars = notChars |
|
1927 | 1927 | |
|
1928 | 1928 | if min < 1: |
|
1929 | 1929 | raise ValueError("cannot specify a minimum length < 1; use Optional(CharsNotIn()) if zero-length char group is permitted") |
|
1930 | 1930 | |
|
1931 | 1931 | self.minLen = min |
|
1932 | 1932 | |
|
1933 | 1933 | if max > 0: |
|
1934 | 1934 | self.maxLen = max |
|
1935 | 1935 | else: |
|
1936 | 1936 | self.maxLen = _MAX_INT |
|
1937 | 1937 | |
|
1938 | 1938 | if exact > 0: |
|
1939 | 1939 | self.maxLen = exact |
|
1940 | 1940 | self.minLen = exact |
|
1941 | 1941 | |
|
1942 | 1942 | self.name = _ustr(self) |
|
1943 | 1943 | self.errmsg = "Expected " + self.name |
|
1944 | 1944 | self.mayReturnEmpty = ( self.minLen == 0 ) |
|
1945 | 1945 | #self.myException.msg = self.errmsg |
|
1946 | 1946 | self.mayIndexError = False |
|
1947 | 1947 | |
|
1948 | 1948 | def parseImpl( self, instring, loc, doActions=True ): |
|
1949 | 1949 | if instring[loc] in self.notChars: |
|
1950 | 1950 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1951 | 1951 | exc = self.myException |
|
1952 | 1952 | exc.loc = loc |
|
1953 | 1953 | exc.pstr = instring |
|
1954 | 1954 | raise exc |
|
1955 | 1955 | |
|
1956 | 1956 | start = loc |
|
1957 | 1957 | loc += 1 |
|
1958 | 1958 | notchars = self.notChars |
|
1959 | 1959 | maxlen = min( start+self.maxLen, len(instring) ) |
|
1960 | 1960 | while loc < maxlen and \ |
|
1961 | 1961 | (instring[loc] not in notchars): |
|
1962 | 1962 | loc += 1 |
|
1963 | 1963 | |
|
1964 | 1964 | if loc - start < self.minLen: |
|
1965 | 1965 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
1966 | 1966 | exc = self.myException |
|
1967 | 1967 | exc.loc = loc |
|
1968 | 1968 | exc.pstr = instring |
|
1969 | 1969 | raise exc |
|
1970 | 1970 | |
|
1971 | 1971 | return loc, instring[start:loc] |
|
1972 | 1972 | |
|
1973 | 1973 | def __str__( self ): |
|
1974 | 1974 | try: |
|
1975 | 1975 | return super(CharsNotIn, self).__str__() |
|
1976 | 1976 | except: |
|
1977 | 1977 | pass |
|
1978 | 1978 | |
|
1979 | 1979 | if self.strRepr is None: |
|
1980 | 1980 | if len(self.notChars) > 4: |
|
1981 | 1981 | self.strRepr = "!W:(%s...)" % self.notChars[:4] |
|
1982 | 1982 | else: |
|
1983 | 1983 | self.strRepr = "!W:(%s)" % self.notChars |
|
1984 | 1984 | |
|
1985 | 1985 | return self.strRepr |
|
1986 | 1986 | |
|
1987 | 1987 | class White(Token): |
|
1988 | 1988 | """Special matching class for matching whitespace. Normally, whitespace is ignored |
|
1989 | 1989 | by pyparsing grammars. This class is included when some whitespace structures |
|
1990 | 1990 | are significant. Define with a string containing the whitespace characters to be |
|
1991 | 1991 | matched; default is " \\t\\r\\n". Also takes optional min, max, and exact arguments, |
|
1992 | 1992 | as defined for the Word class.""" |
|
1993 | 1993 | whiteStrs = { |
|
1994 | 1994 | " " : "<SPC>", |
|
1995 | 1995 | "\t": "<TAB>", |
|
1996 | 1996 | "\n": "<LF>", |
|
1997 | 1997 | "\r": "<CR>", |
|
1998 | 1998 | "\f": "<FF>", |
|
1999 | 1999 | } |
|
2000 | 2000 | def __init__(self, ws=" \t\r\n", min=1, max=0, exact=0): |
|
2001 | 2001 | super(White,self).__init__() |
|
2002 | 2002 | self.matchWhite = ws |
|
2003 | 2003 | self.setWhitespaceChars( "".join([c for c in self.whiteChars if c not in self.matchWhite]) ) |
|
2004 | 2004 | #~ self.leaveWhitespace() |
|
2005 | 2005 | self.name = ("".join([White.whiteStrs[c] for c in self.matchWhite])) |
|
2006 | 2006 | self.mayReturnEmpty = True |
|
2007 | 2007 | self.errmsg = "Expected " + self.name |
|
2008 | 2008 | #self.myException.msg = self.errmsg |
|
2009 | 2009 | |
|
2010 | 2010 | self.minLen = min |
|
2011 | 2011 | |
|
2012 | 2012 | if max > 0: |
|
2013 | 2013 | self.maxLen = max |
|
2014 | 2014 | else: |
|
2015 | 2015 | self.maxLen = _MAX_INT |
|
2016 | 2016 | |
|
2017 | 2017 | if exact > 0: |
|
2018 | 2018 | self.maxLen = exact |
|
2019 | 2019 | self.minLen = exact |
|
2020 | 2020 | |
|
2021 | 2021 | def parseImpl( self, instring, loc, doActions=True ): |
|
2022 | 2022 | if not(instring[ loc ] in self.matchWhite): |
|
2023 | 2023 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
2024 | 2024 | exc = self.myException |
|
2025 | 2025 | exc.loc = loc |
|
2026 | 2026 | exc.pstr = instring |
|
2027 | 2027 | raise exc |
|
2028 | 2028 | start = loc |
|
2029 | 2029 | loc += 1 |
|
2030 | 2030 | maxloc = start + self.maxLen |
|
2031 | 2031 | maxloc = min( maxloc, len(instring) ) |
|
2032 | 2032 | while loc < maxloc and instring[loc] in self.matchWhite: |
|
2033 | 2033 | loc += 1 |
|
2034 | 2034 | |
|
2035 | 2035 | if loc - start < self.minLen: |
|
2036 | 2036 | #~ raise ParseException( instring, loc, self.errmsg ) |
|
2037 | 2037 | exc = self.myException |
|
2038 | 2038 | exc.loc = loc |
|
2039 | 2039 | exc.pstr = instring |
|
2040 | 2040 | raise exc |
|
2041 | 2041 | |
|
2042 | 2042 | return loc, instring[start:loc] |
|
2043 | 2043 | |
|
2044 | 2044 | |
|
2045 | 2045 | class _PositionToken(Token): |
|
2046 | 2046 | def __init__( self ): |
|
2047 | 2047 | super(_PositionToken,self).__init__() |
|
2048 | 2048 | self.name=self.__class__.__name__ |
|
2049 | 2049 | self.mayReturnEmpty = True |
|
2050 | 2050 | self.mayIndexError = False |
|
2051 | 2051 | |
|
2052 | 2052 | class GoToColumn(_PositionToken): |
|
2053 | 2053 | """Token to advance to a specific column of input text; useful for tabular report scraping.""" |
|
2054 | 2054 | def __init__( self, colno ): |
|
2055 | 2055 | super(GoToColumn,self).__init__() |
|
2056 | 2056 | self.col = colno |
|
2057 | 2057 | |
|
2058 | 2058 | def preParse( self, instring, loc ): |
|
2059 | 2059 | if col(loc,instring) != self.col: |
|
2060 | 2060 | instrlen = len(instring) |
|
2061 | 2061 | if self.ignoreExprs: |
|
2062 | 2062 | loc = self._skipIgnorables( instring, loc ) |
|
2063 | 2063 | while loc < instrlen and instring[loc].isspace() and col( loc, instring ) != self.col : |
|
2064 | 2064 | loc += 1 |
|
2065 | 2065 | return loc |
|
2066 | 2066 | |
|
2067 | 2067 | def parseImpl( self, instring, loc, doActions=True ): |
|
2068 | 2068 | thiscol = col( loc, instring ) |
|
2069 | 2069 | if thiscol > self.col: |
|
2070 | 2070 | raise ParseException( instring, loc, "Text not in expected column", self ) |
|
2071 | 2071 | newloc = loc + self.col - thiscol |
|
2072 | 2072 | ret = instring[ loc: newloc ] |
|
2073 | 2073 | return newloc, ret |
|
2074 | 2074 | |
|
2075 | 2075 | class LineStart(_PositionToken): |
|
2076 | 2076 | """Matches if current position is at the beginning of a line within the parse string""" |
|
2077 | 2077 | def __init__( self ): |
|
2078 | 2078 | super(LineStart,self).__init__() |
|
2079 | 2079 | self.setWhitespaceChars( ParserElement.DEFAULT_WHITE_CHARS.replace("\n","") ) |
|
2080 | 2080 | self.errmsg = "Expected start of line" |
|
2081 | 2081 | #self.myException.msg = self.errmsg |
|
2082 | 2082 | |
|
2083 | 2083 | def preParse( self, instring, loc ): |
|
2084 | 2084 | preloc = super(LineStart,self).preParse(instring,loc) |
|
2085 | 2085 | if instring[preloc] == "\n": |
|
2086 | 2086 | loc += 1 |
|
2087 | 2087 | return loc |
|
2088 | 2088 | |
|
2089 | 2089 | def parseImpl( self, instring, loc, doActions=True ): |
|
2090 | 2090 | if not( loc==0 or |
|
2091 | 2091 | (loc == self.preParse( instring, 0 )) or |
|
2092 | 2092 | (instring[loc-1] == "\n") ): #col(loc, instring) != 1: |
|
2093 | 2093 | #~ raise ParseException( instring, loc, "Expected start of line" ) |
|
2094 | 2094 | exc = self.myException |
|
2095 | 2095 | exc.loc = loc |
|
2096 | 2096 | exc.pstr = instring |
|
2097 | 2097 | raise exc |
|
2098 | 2098 | return loc, [] |
|
2099 | 2099 | |
|
2100 | 2100 | class LineEnd(_PositionToken): |
|
2101 | 2101 | """Matches if current position is at the end of a line within the parse string""" |
|
2102 | 2102 | def __init__( self ): |
|
2103 | 2103 | super(LineEnd,self).__init__() |
|
2104 | 2104 | self.setWhitespaceChars( ParserElement.DEFAULT_WHITE_CHARS.replace("\n","") ) |
|
2105 | 2105 | self.errmsg = "Expected end of line" |
|
2106 | 2106 | #self.myException.msg = self.errmsg |
|
2107 | 2107 | |
|
2108 | 2108 | def parseImpl( self, instring, loc, doActions=True ): |
|
2109 | 2109 | if loc<len(instring): |
|
2110 | 2110 | if instring[loc] == "\n": |
|
2111 | 2111 | return loc+1, "\n" |
|
2112 | 2112 | else: |
|
2113 | 2113 | #~ raise ParseException( instring, loc, "Expected end of line" ) |
|
2114 | 2114 | exc = self.myException |
|
2115 | 2115 | exc.loc = loc |
|
2116 | 2116 | exc.pstr = instring |
|
2117 | 2117 | raise exc |
|
2118 | 2118 | elif loc == len(instring): |
|
2119 | 2119 | return loc+1, [] |
|
2120 | 2120 | else: |
|
2121 | 2121 | exc = self.myException |
|
2122 | 2122 | exc.loc = loc |
|
2123 | 2123 | exc.pstr = instring |
|
2124 | 2124 | raise exc |
|
2125 | 2125 | |
|
2126 | 2126 | class StringStart(_PositionToken): |
|
2127 | 2127 | """Matches if current position is at the beginning of the parse string""" |
|
2128 | 2128 | def __init__( self ): |
|
2129 | 2129 | super(StringStart,self).__init__() |
|
2130 | 2130 | self.errmsg = "Expected start of text" |
|
2131 | 2131 | #self.myException.msg = self.errmsg |
|
2132 | 2132 | |
|
2133 | 2133 | def parseImpl( self, instring, loc, doActions=True ): |
|
2134 | 2134 | if loc != 0: |
|
2135 | 2135 | # see if entire string up to here is just whitespace and ignoreables |
|
2136 | 2136 | if loc != self.preParse( instring, 0 ): |
|
2137 | 2137 | #~ raise ParseException( instring, loc, "Expected start of text" ) |
|
2138 | 2138 | exc = self.myException |
|
2139 | 2139 | exc.loc = loc |
|
2140 | 2140 | exc.pstr = instring |
|
2141 | 2141 | raise exc |
|
2142 | 2142 | return loc, [] |
|
2143 | 2143 | |
|
2144 | 2144 | class StringEnd(_PositionToken): |
|
2145 | 2145 | """Matches if current position is at the end of the parse string""" |
|
2146 | 2146 | def __init__( self ): |
|
2147 | 2147 | super(StringEnd,self).__init__() |
|
2148 | 2148 | self.errmsg = "Expected end of text" |
|
2149 | 2149 | #self.myException.msg = self.errmsg |
|
2150 | 2150 | |
|
2151 | 2151 | def parseImpl( self, instring, loc, doActions=True ): |
|
2152 | 2152 | if loc < len(instring): |
|
2153 | 2153 | #~ raise ParseException( instring, loc, "Expected end of text" ) |
|
2154 | 2154 | exc = self.myException |
|
2155 | 2155 | exc.loc = loc |
|
2156 | 2156 | exc.pstr = instring |
|
2157 | 2157 | raise exc |
|
2158 | 2158 | elif loc == len(instring): |
|
2159 | 2159 | return loc+1, [] |
|
2160 | 2160 | elif loc > len(instring): |
|
2161 | 2161 | return loc, [] |
|
2162 | 2162 | else: |
|
2163 | 2163 | exc = self.myException |
|
2164 | 2164 | exc.loc = loc |
|
2165 | 2165 | exc.pstr = instring |
|
2166 | 2166 | raise exc |
|
2167 | 2167 | |
|
2168 | 2168 | class WordStart(_PositionToken): |
|
2169 | 2169 | """Matches if the current position is at the beginning of a Word, and |
|
2170 | 2170 | is not preceded by any character in a given set of wordChars |
|
2171 | 2171 | (default=printables). To emulate the \b behavior of regular expressions, |
|
2172 | 2172 | use WordStart(alphanums). WordStart will also match at the beginning of |
|
2173 | 2173 | the string being parsed, or at the beginning of a line. |
|
2174 | 2174 | """ |
|
2175 | 2175 | def __init__(self, wordChars = printables): |
|
2176 | 2176 | super(WordStart,self).__init__() |
|
2177 | 2177 | self.wordChars = _str2dict(wordChars) |
|
2178 | 2178 | self.errmsg = "Not at the start of a word" |
|
2179 | 2179 | |
|
2180 | 2180 | def parseImpl(self, instring, loc, doActions=True ): |
|
2181 | 2181 | if loc != 0: |
|
2182 | 2182 | if (instring[loc-1] in self.wordChars or |
|
2183 | 2183 | instring[loc] not in self.wordChars): |
|
2184 | 2184 | exc = self.myException |
|
2185 | 2185 | exc.loc = loc |
|
2186 | 2186 | exc.pstr = instring |
|
2187 | 2187 | raise exc |
|
2188 | 2188 | return loc, [] |
|
2189 | 2189 | |
|
2190 | 2190 | class WordEnd(_PositionToken): |
|
2191 | 2191 | """Matches if the current position is at the end of a Word, and |
|
2192 | 2192 | is not followed by any character in a given set of wordChars |
|
2193 | 2193 | (default=printables). To emulate the \b behavior of regular expressions, |
|
2194 | 2194 | use WordEnd(alphanums). WordEnd will also match at the end of |
|
2195 | 2195 | the string being parsed, or at the end of a line. |
|
2196 | 2196 | """ |
|
2197 | 2197 | def __init__(self, wordChars = printables): |
|
2198 | 2198 | super(WordEnd,self).__init__() |
|
2199 | 2199 | self.wordChars = _str2dict(wordChars) |
|
2200 | 2200 | self.skipWhitespace = False |
|
2201 | 2201 | self.errmsg = "Not at the end of a word" |
|
2202 | 2202 | |
|
2203 | 2203 | def parseImpl(self, instring, loc, doActions=True ): |
|
2204 | 2204 | instrlen = len(instring) |
|
2205 | 2205 | if instrlen>0 and loc<instrlen: |
|
2206 | 2206 | if (instring[loc] in self.wordChars or |
|
2207 | 2207 | instring[loc-1] not in self.wordChars): |
|
2208 | 2208 | #~ raise ParseException( instring, loc, "Expected end of word" ) |
|
2209 | 2209 | exc = self.myException |
|
2210 | 2210 | exc.loc = loc |
|
2211 | 2211 | exc.pstr = instring |
|
2212 | 2212 | raise exc |
|
2213 | 2213 | return loc, [] |
|
2214 | 2214 | |
|
2215 | 2215 | |
|
2216 | 2216 | class ParseExpression(ParserElement): |
|
2217 | 2217 | """Abstract subclass of ParserElement, for combining and post-processing parsed tokens.""" |
|
2218 | 2218 | def __init__( self, exprs, savelist = False ): |
|
2219 | 2219 | super(ParseExpression,self).__init__(savelist) |
|
2220 | 2220 | if isinstance( exprs, list ): |
|
2221 | 2221 | self.exprs = exprs |
|
2222 | 2222 | elif isinstance( exprs, basestring ): |
|
2223 | 2223 | self.exprs = [ Literal( exprs ) ] |
|
2224 | 2224 | else: |
|
2225 | 2225 | try: |
|
2226 | 2226 | self.exprs = list( exprs ) |
|
2227 | 2227 | except TypeError: |
|
2228 | 2228 | self.exprs = [ exprs ] |
|
2229 | 2229 | self.callPreparse = False |
|
2230 | 2230 | |
|
2231 | 2231 | def __getitem__( self, i ): |
|
2232 | 2232 | return self.exprs[i] |
|
2233 | 2233 | |
|
2234 | 2234 | def append( self, other ): |
|
2235 | 2235 | self.exprs.append( other ) |
|
2236 | 2236 | self.strRepr = None |
|
2237 | 2237 | return self |
|
2238 | 2238 | |
|
2239 | 2239 | def leaveWhitespace( self ): |
|
2240 | 2240 | """Extends leaveWhitespace defined in base class, and also invokes leaveWhitespace on |
|
2241 | 2241 | all contained expressions.""" |
|
2242 | 2242 | self.skipWhitespace = False |
|
2243 | 2243 | self.exprs = [ e.copy() for e in self.exprs ] |
|
2244 | 2244 | for e in self.exprs: |
|
2245 | 2245 | e.leaveWhitespace() |
|
2246 | 2246 | return self |
|
2247 | 2247 | |
|
2248 | 2248 | def ignore( self, other ): |
|
2249 | 2249 | if isinstance( other, Suppress ): |
|
2250 | 2250 | if other not in self.ignoreExprs: |
|
2251 | 2251 | super( ParseExpression, self).ignore( other ) |
|
2252 | 2252 | for e in self.exprs: |
|
2253 | 2253 | e.ignore( self.ignoreExprs[-1] ) |
|
2254 | 2254 | else: |
|
2255 | 2255 | super( ParseExpression, self).ignore( other ) |
|
2256 | 2256 | for e in self.exprs: |
|
2257 | 2257 | e.ignore( self.ignoreExprs[-1] ) |
|
2258 | 2258 | return self |
|
2259 | 2259 | |
|
2260 | 2260 | def __str__( self ): |
|
2261 | 2261 | try: |
|
2262 | 2262 | return super(ParseExpression,self).__str__() |
|
2263 | 2263 | except: |
|
2264 | 2264 | pass |
|
2265 | 2265 | |
|
2266 | 2266 | if self.strRepr is None: |
|
2267 | 2267 | self.strRepr = "%s:(%s)" % ( self.__class__.__name__, _ustr(self.exprs) ) |
|
2268 | 2268 | return self.strRepr |
|
2269 | 2269 | |
|
2270 | 2270 | def streamline( self ): |
|
2271 | 2271 | super(ParseExpression,self).streamline() |
|
2272 | 2272 | |
|
2273 | 2273 | for e in self.exprs: |
|
2274 | 2274 | e.streamline() |
|
2275 | 2275 | |
|
2276 | 2276 | # collapse nested And's of the form And( And( And( a,b), c), d) to And( a,b,c,d ) |
|
2277 | 2277 | # but only if there are no parse actions or resultsNames on the nested And's |
|
2278 | 2278 | # (likewise for Or's and MatchFirst's) |
|
2279 | 2279 | if ( len(self.exprs) == 2 ): |
|
2280 | 2280 | other = self.exprs[0] |
|
2281 | 2281 | if ( isinstance( other, self.__class__ ) and |
|
2282 | 2282 | not(other.parseAction) and |
|
2283 | 2283 | other.resultsName is None and |
|
2284 | 2284 | not other.debug ): |
|
2285 | 2285 | self.exprs = other.exprs[:] + [ self.exprs[1] ] |
|
2286 | 2286 | self.strRepr = None |
|
2287 | 2287 | self.mayReturnEmpty |= other.mayReturnEmpty |
|
2288 | 2288 | self.mayIndexError |= other.mayIndexError |
|
2289 | 2289 | |
|
2290 | 2290 | other = self.exprs[-1] |
|
2291 | 2291 | if ( isinstance( other, self.__class__ ) and |
|
2292 | 2292 | not(other.parseAction) and |
|
2293 | 2293 | other.resultsName is None and |
|
2294 | 2294 | not other.debug ): |
|
2295 | 2295 | self.exprs = self.exprs[:-1] + other.exprs[:] |
|
2296 | 2296 | self.strRepr = None |
|
2297 | 2297 | self.mayReturnEmpty |= other.mayReturnEmpty |
|
2298 | 2298 | self.mayIndexError |= other.mayIndexError |
|
2299 | 2299 | |
|
2300 | 2300 | return self |
|
2301 | 2301 | |
|
2302 | 2302 | def setResultsName( self, name, listAllMatches=False ): |
|
2303 | 2303 | ret = super(ParseExpression,self).setResultsName(name,listAllMatches) |
|
2304 | 2304 | return ret |
|
2305 | 2305 | |
|
2306 | 2306 | def validate( self, validateTrace=[] ): |
|
2307 | 2307 | tmp = validateTrace[:]+[self] |
|
2308 | 2308 | for e in self.exprs: |
|
2309 | 2309 | e.validate(tmp) |
|
2310 | 2310 | self.checkRecursion( [] ) |
|
2311 | 2311 | |
|
2312 | 2312 | class And(ParseExpression): |
|
2313 | 2313 | """Requires all given ParseExpressions to be found in the given order. |
|
2314 | 2314 | Expressions may be separated by whitespace. |
|
2315 | 2315 | May be constructed using the '+' operator. |
|
2316 | 2316 | """ |
|
2317 | 2317 | |
|
2318 | 2318 | class _ErrorStop(Empty): |
|
2319 | 2319 | def __init__(self, *args, **kwargs): |
|
2320 | 2320 | super(Empty,self).__init__(*args, **kwargs) |
|
2321 | 2321 | self.leaveWhitespace() |
|
2322 | 2322 | |
|
2323 | 2323 | def __init__( self, exprs, savelist = True ): |
|
2324 | 2324 | super(And,self).__init__(exprs, savelist) |
|
2325 | 2325 | self.mayReturnEmpty = True |
|
2326 | 2326 | for e in self.exprs: |
|
2327 | 2327 | if not e.mayReturnEmpty: |
|
2328 | 2328 | self.mayReturnEmpty = False |
|
2329 | 2329 | break |
|
2330 | 2330 | self.setWhitespaceChars( exprs[0].whiteChars ) |
|
2331 | 2331 | self.skipWhitespace = exprs[0].skipWhitespace |
|
2332 | 2332 | self.callPreparse = True |
|
2333 | 2333 | |
|
2334 | 2334 | def parseImpl( self, instring, loc, doActions=True ): |
|
2335 | 2335 | # pass False as last arg to _parse for first element, since we already |
|
2336 | 2336 | # pre-parsed the string as part of our And pre-parsing |
|
2337 | 2337 | loc, resultlist = self.exprs[0]._parse( instring, loc, doActions, callPreParse=False ) |
|
2338 | 2338 | errorStop = False |
|
2339 | 2339 | for e in self.exprs[1:]: |
|
2340 | 2340 | if isinstance(e, And._ErrorStop): |
|
2341 | 2341 | errorStop = True |
|
2342 | 2342 | continue |
|
2343 | 2343 | if errorStop: |
|
2344 | 2344 | try: |
|
2345 | 2345 | loc, exprtokens = e._parse( instring, loc, doActions ) |
|
2346 | 2346 | except ParseSyntaxException: |
|
2347 | 2347 | raise |
|
2348 | 2348 | except ParseBaseException, pe: |
|
2349 | 2349 | raise ParseSyntaxException(pe) |
|
2350 | 2350 | except IndexError, ie: |
|
2351 | 2351 | raise ParseSyntaxException( ParseException(instring, len(instring), self.errmsg, self) ) |
|
2352 | 2352 | else: |
|
2353 | 2353 | loc, exprtokens = e._parse( instring, loc, doActions ) |
|
2354 | 2354 | if exprtokens or exprtokens.keys(): |
|
2355 | 2355 | resultlist += exprtokens |
|
2356 | 2356 | return loc, resultlist |
|
2357 | 2357 | |
|
2358 | 2358 | def __iadd__(self, other ): |
|
2359 | 2359 | if isinstance( other, basestring ): |
|
2360 | 2360 | other = Literal( other ) |
|
2361 | 2361 | return self.append( other ) #And( [ self, other ] ) |
|
2362 | 2362 | |
|
2363 | 2363 | def checkRecursion( self, parseElementList ): |
|
2364 | 2364 | subRecCheckList = parseElementList[:] + [ self ] |
|
2365 | 2365 | for e in self.exprs: |
|
2366 | 2366 | e.checkRecursion( subRecCheckList ) |
|
2367 | 2367 | if not e.mayReturnEmpty: |
|
2368 | 2368 | break |
|
2369 | 2369 | |
|
2370 | 2370 | def __str__( self ): |
|
2371 | 2371 | if hasattr(self,"name"): |
|
2372 | 2372 | return self.name |
|
2373 | 2373 | |
|
2374 | 2374 | if self.strRepr is None: |
|
2375 | 2375 | self.strRepr = "{" + " ".join( [ _ustr(e) for e in self.exprs ] ) + "}" |
|
2376 | 2376 | |
|
2377 | 2377 | return self.strRepr |
|
2378 | 2378 | |
|
2379 | 2379 | |
|
2380 | 2380 | class Or(ParseExpression): |
|
2381 | 2381 | """Requires that at least one ParseExpression is found. |
|
2382 | 2382 | If two expressions match, the expression that matches the longest string will be used. |
|
2383 | 2383 | May be constructed using the '^' operator. |
|
2384 | 2384 | """ |
|
2385 | 2385 | def __init__( self, exprs, savelist = False ): |
|
2386 | 2386 | super(Or,self).__init__(exprs, savelist) |
|
2387 | 2387 | self.mayReturnEmpty = False |
|
2388 | 2388 | for e in self.exprs: |
|
2389 | 2389 | if e.mayReturnEmpty: |
|
2390 | 2390 | self.mayReturnEmpty = True |
|
2391 | 2391 | break |
|
2392 | 2392 | |
|
2393 | 2393 | def parseImpl( self, instring, loc, doActions=True ): |
|
2394 | 2394 | maxExcLoc = -1 |
|
2395 | 2395 | maxMatchLoc = -1 |
|
2396 | 2396 | maxException = None |
|
2397 | 2397 | for e in self.exprs: |
|
2398 | 2398 | try: |
|
2399 | 2399 | loc2 = e.tryParse( instring, loc ) |
|
2400 | 2400 | except ParseException, err: |
|
2401 | 2401 | if err.loc > maxExcLoc: |
|
2402 | 2402 | maxException = err |
|
2403 | 2403 | maxExcLoc = err.loc |
|
2404 | 2404 | except IndexError: |
|
2405 | 2405 | if len(instring) > maxExcLoc: |
|
2406 | 2406 | maxException = ParseException(instring,len(instring),e.errmsg,self) |
|
2407 | 2407 | maxExcLoc = len(instring) |
|
2408 | 2408 | else: |
|
2409 | 2409 | if loc2 > maxMatchLoc: |
|
2410 | 2410 | maxMatchLoc = loc2 |
|
2411 | 2411 | maxMatchExp = e |
|
2412 | 2412 | |
|
2413 | 2413 | if maxMatchLoc < 0: |
|
2414 | 2414 | if maxException is not None: |
|
2415 | 2415 | raise maxException |
|
2416 | 2416 | else: |
|
2417 | 2417 | raise ParseException(instring, loc, "no defined alternatives to match", self) |
|
2418 | 2418 | |
|
2419 | 2419 | return maxMatchExp._parse( instring, loc, doActions ) |
|
2420 | 2420 | |
|
2421 | 2421 | def __ixor__(self, other ): |
|
2422 | 2422 | if isinstance( other, basestring ): |
|
2423 | 2423 | other = Literal( other ) |
|
2424 | 2424 | return self.append( other ) #Or( [ self, other ] ) |
|
2425 | 2425 | |
|
2426 | 2426 | def __str__( self ): |
|
2427 | 2427 | if hasattr(self,"name"): |
|
2428 | 2428 | return self.name |
|
2429 | 2429 | |
|
2430 | 2430 | if self.strRepr is None: |
|
2431 | 2431 | self.strRepr = "{" + " ^ ".join( [ _ustr(e) for e in self.exprs ] ) + "}" |
|
2432 | 2432 | |
|
2433 | 2433 | return self.strRepr |
|
2434 | 2434 | |
|
2435 | 2435 | def checkRecursion( self, parseElementList ): |
|
2436 | 2436 | subRecCheckList = parseElementList[:] + [ self ] |
|
2437 | 2437 | for e in self.exprs: |
|
2438 | 2438 | e.checkRecursion( subRecCheckList ) |
|
2439 | 2439 | |
|
2440 | 2440 | |
|
2441 | 2441 | class MatchFirst(ParseExpression): |
|
2442 | 2442 | """Requires that at least one ParseExpression is found. |
|
2443 | 2443 | If two expressions match, the first one listed is the one that will match. |
|
2444 | 2444 | May be constructed using the '|' operator. |
|
2445 | 2445 | """ |
|
2446 | 2446 | def __init__( self, exprs, savelist = False ): |
|
2447 | 2447 | super(MatchFirst,self).__init__(exprs, savelist) |
|
2448 | 2448 | if exprs: |
|
2449 | 2449 | self.mayReturnEmpty = False |
|
2450 | 2450 | for e in self.exprs: |
|
2451 | 2451 | if e.mayReturnEmpty: |
|
2452 | 2452 | self.mayReturnEmpty = True |
|
2453 | 2453 | break |
|
2454 | 2454 | else: |
|
2455 | 2455 | self.mayReturnEmpty = True |
|
2456 | 2456 | |
|
2457 | 2457 | def parseImpl( self, instring, loc, doActions=True ): |
|
2458 | 2458 | maxExcLoc = -1 |
|
2459 | 2459 | maxException = None |
|
2460 | 2460 | for e in self.exprs: |
|
2461 | 2461 | try: |
|
2462 | 2462 | ret = e._parse( instring, loc, doActions ) |
|
2463 | 2463 | return ret |
|
2464 | 2464 | except ParseException, err: |
|
2465 | 2465 | if err.loc > maxExcLoc: |
|
2466 | 2466 | maxException = err |
|
2467 | 2467 | maxExcLoc = err.loc |
|
2468 | 2468 | except IndexError: |
|
2469 | 2469 | if len(instring) > maxExcLoc: |
|
2470 | 2470 | maxException = ParseException(instring,len(instring),e.errmsg,self) |
|
2471 | 2471 | maxExcLoc = len(instring) |
|
2472 | 2472 | |
|
2473 | 2473 | # only got here if no expression matched, raise exception for match that made it the furthest |
|
2474 | 2474 | else: |
|
2475 | 2475 | if maxException is not None: |
|
2476 | 2476 | raise maxException |
|
2477 | 2477 | else: |
|
2478 | 2478 | raise ParseException(instring, loc, "no defined alternatives to match", self) |
|
2479 | 2479 | |
|
2480 | 2480 | def __ior__(self, other ): |
|
2481 | 2481 | if isinstance( other, basestring ): |
|
2482 | 2482 | other = Literal( other ) |
|
2483 | 2483 | return self.append( other ) #MatchFirst( [ self, other ] ) |
|
2484 | 2484 | |
|
2485 | 2485 | def __str__( self ): |
|
2486 | 2486 | if hasattr(self,"name"): |
|
2487 | 2487 | return self.name |
|
2488 | 2488 | |
|
2489 | 2489 | if self.strRepr is None: |
|
2490 | 2490 | self.strRepr = "{" + " | ".join( [ _ustr(e) for e in self.exprs ] ) + "}" |
|
2491 | 2491 | |
|
2492 | 2492 | return self.strRepr |
|
2493 | 2493 | |
|
2494 | 2494 | def checkRecursion( self, parseElementList ): |
|
2495 | 2495 | subRecCheckList = parseElementList[:] + [ self ] |
|
2496 | 2496 | for e in self.exprs: |
|
2497 | 2497 | e.checkRecursion( subRecCheckList ) |
|
2498 | 2498 | |
|
2499 | 2499 | |
|
2500 | 2500 | class Each(ParseExpression): |
|
2501 | 2501 | """Requires all given ParseExpressions to be found, but in any order. |
|
2502 | 2502 | Expressions may be separated by whitespace. |
|
2503 | 2503 | May be constructed using the '&' operator. |
|
2504 | 2504 | """ |
|
2505 | 2505 | def __init__( self, exprs, savelist = True ): |
|
2506 | 2506 | super(Each,self).__init__(exprs, savelist) |
|
2507 | 2507 | self.mayReturnEmpty = True |
|
2508 | 2508 | for e in self.exprs: |
|
2509 | 2509 | if not e.mayReturnEmpty: |
|
2510 | 2510 | self.mayReturnEmpty = False |
|
2511 | 2511 | break |
|
2512 | 2512 | self.skipWhitespace = True |
|
2513 | 2513 | self.initExprGroups = True |
|
2514 | 2514 | |
|
2515 | 2515 | def parseImpl( self, instring, loc, doActions=True ): |
|
2516 | 2516 | if self.initExprGroups: |
|
2517 | 2517 | self.optionals = [ e.expr for e in self.exprs if isinstance(e,Optional) ] |
|
2518 | 2518 | self.multioptionals = [ e.expr for e in self.exprs if isinstance(e,ZeroOrMore) ] |
|
2519 | 2519 | self.multirequired = [ e.expr for e in self.exprs if isinstance(e,OneOrMore) ] |
|
2520 | 2520 | self.required = [ e for e in self.exprs if not isinstance(e,(Optional,ZeroOrMore,OneOrMore)) ] |
|
2521 | 2521 | self.required += self.multirequired |
|
2522 | 2522 | self.initExprGroups = False |
|
2523 | 2523 | tmpLoc = loc |
|
2524 | 2524 | tmpReqd = self.required[:] |
|
2525 | 2525 | tmpOpt = self.optionals[:] |
|
2526 | 2526 | matchOrder = [] |
|
2527 | 2527 | |
|
2528 | 2528 | keepMatching = True |
|
2529 | 2529 | while keepMatching: |
|
2530 | 2530 | tmpExprs = tmpReqd + tmpOpt + self.multioptionals + self.multirequired |
|
2531 | 2531 | failed = [] |
|
2532 | 2532 | for e in tmpExprs: |
|
2533 | 2533 | try: |
|
2534 | 2534 | tmpLoc = e.tryParse( instring, tmpLoc ) |
|
2535 | 2535 | except ParseException: |
|
2536 | 2536 | failed.append(e) |
|
2537 | 2537 | else: |
|
2538 | 2538 | matchOrder.append(e) |
|
2539 | 2539 | if e in tmpReqd: |
|
2540 | 2540 | tmpReqd.remove(e) |
|
2541 | 2541 | elif e in tmpOpt: |
|
2542 | 2542 | tmpOpt.remove(e) |
|
2543 | 2543 | if len(failed) == len(tmpExprs): |
|
2544 | 2544 | keepMatching = False |
|
2545 | 2545 | |
|
2546 | 2546 | if tmpReqd: |
|
2547 | 2547 | missing = ", ".join( [ _ustr(e) for e in tmpReqd ] ) |
|
2548 | 2548 | raise ParseException(instring,loc,"Missing one or more required elements (%s)" % missing ) |
|
2549 | 2549 | |
|
2550 | 2550 | # add any unmatched Optionals, in case they have default values defined |
|
2551 | 2551 | matchOrder += list(e for e in self.exprs if isinstance(e,Optional) and e.expr in tmpOpt) |
|
2552 | 2552 | |
|
2553 | 2553 | resultlist = [] |
|
2554 | 2554 | for e in matchOrder: |
|
2555 | 2555 | loc,results = e._parse(instring,loc,doActions) |
|
2556 | 2556 | resultlist.append(results) |
|
2557 | 2557 | |
|
2558 | 2558 | finalResults = ParseResults([]) |
|
2559 | 2559 | for r in resultlist: |
|
2560 | 2560 | dups = {} |
|
2561 | 2561 | for k in r.keys(): |
|
2562 | 2562 | if k in finalResults.keys(): |
|
2563 | 2563 | tmp = ParseResults(finalResults[k]) |
|
2564 | 2564 | tmp += ParseResults(r[k]) |
|
2565 | 2565 | dups[k] = tmp |
|
2566 | 2566 | finalResults += ParseResults(r) |
|
2567 | 2567 | for k,v in dups.iteritems(): |
|
2568 | 2568 | finalResults[k] = v |
|
2569 | 2569 | return loc, finalResults |
|
2570 | 2570 | |
|
2571 | 2571 | def __str__( self ): |
|
2572 | 2572 | if hasattr(self,"name"): |
|
2573 | 2573 | return self.name |
|
2574 | 2574 | |
|
2575 | 2575 | if self.strRepr is None: |
|
2576 | 2576 | self.strRepr = "{" + " & ".join( [ _ustr(e) for e in self.exprs ] ) + "}" |
|
2577 | 2577 | |
|
2578 | 2578 | return self.strRepr |
|
2579 | 2579 | |
|
2580 | 2580 | def checkRecursion( self, parseElementList ): |
|
2581 | 2581 | subRecCheckList = parseElementList[:] + [ self ] |
|
2582 | 2582 | for e in self.exprs: |
|
2583 | 2583 | e.checkRecursion( subRecCheckList ) |
|
2584 | 2584 | |
|
2585 | 2585 | |
|
2586 | 2586 | class ParseElementEnhance(ParserElement): |
|
2587 | 2587 | """Abstract subclass of ParserElement, for combining and post-processing parsed tokens.""" |
|
2588 | 2588 | def __init__( self, expr, savelist=False ): |
|
2589 | 2589 | super(ParseElementEnhance,self).__init__(savelist) |
|
2590 | 2590 | if isinstance( expr, basestring ): |
|
2591 | 2591 | expr = Literal(expr) |
|
2592 | 2592 | self.expr = expr |
|
2593 | 2593 | self.strRepr = None |
|
2594 | 2594 | if expr is not None: |
|
2595 | 2595 | self.mayIndexError = expr.mayIndexError |
|
2596 | 2596 | self.mayReturnEmpty = expr.mayReturnEmpty |
|
2597 | 2597 | self.setWhitespaceChars( expr.whiteChars ) |
|
2598 | 2598 | self.skipWhitespace = expr.skipWhitespace |
|
2599 | 2599 | self.saveAsList = expr.saveAsList |
|
2600 | 2600 | self.callPreparse = expr.callPreparse |
|
2601 | 2601 | self.ignoreExprs.extend(expr.ignoreExprs) |
|
2602 | 2602 | |
|
2603 | 2603 | def parseImpl( self, instring, loc, doActions=True ): |
|
2604 | 2604 | if self.expr is not None: |
|
2605 | 2605 | return self.expr._parse( instring, loc, doActions, callPreParse=False ) |
|
2606 | 2606 | else: |
|
2607 | 2607 | raise ParseException("",loc,self.errmsg,self) |
|
2608 | 2608 | |
|
2609 | 2609 | def leaveWhitespace( self ): |
|
2610 | 2610 | self.skipWhitespace = False |
|
2611 | 2611 | self.expr = self.expr.copy() |
|
2612 | 2612 | if self.expr is not None: |
|
2613 | 2613 | self.expr.leaveWhitespace() |
|
2614 | 2614 | return self |
|
2615 | 2615 | |
|
2616 | 2616 | def ignore( self, other ): |
|
2617 | 2617 | if isinstance( other, Suppress ): |
|
2618 | 2618 | if other not in self.ignoreExprs: |
|
2619 | 2619 | super( ParseElementEnhance, self).ignore( other ) |
|
2620 | 2620 | if self.expr is not None: |
|
2621 | 2621 | self.expr.ignore( self.ignoreExprs[-1] ) |
|
2622 | 2622 | else: |
|
2623 | 2623 | super( ParseElementEnhance, self).ignore( other ) |
|
2624 | 2624 | if self.expr is not None: |
|
2625 | 2625 | self.expr.ignore( self.ignoreExprs[-1] ) |
|
2626 | 2626 | return self |
|
2627 | 2627 | |
|
2628 | 2628 | def streamline( self ): |
|
2629 | 2629 | super(ParseElementEnhance,self).streamline() |
|
2630 | 2630 | if self.expr is not None: |
|
2631 | 2631 | self.expr.streamline() |
|
2632 | 2632 | return self |
|
2633 | 2633 | |
|
2634 | 2634 | def checkRecursion( self, parseElementList ): |
|
2635 | 2635 | if self in parseElementList: |
|
2636 | 2636 | raise RecursiveGrammarException( parseElementList+[self] ) |
|
2637 | 2637 | subRecCheckList = parseElementList[:] + [ self ] |
|
2638 | 2638 | if self.expr is not None: |
|
2639 | 2639 | self.expr.checkRecursion( subRecCheckList ) |
|
2640 | 2640 | |
|
2641 | 2641 | def validate( self, validateTrace=[] ): |
|
2642 | 2642 | tmp = validateTrace[:]+[self] |
|
2643 | 2643 | if self.expr is not None: |
|
2644 | 2644 | self.expr.validate(tmp) |
|
2645 | 2645 | self.checkRecursion( [] ) |
|
2646 | 2646 | |
|
2647 | 2647 | def __str__( self ): |
|
2648 | 2648 | try: |
|
2649 | 2649 | return super(ParseElementEnhance,self).__str__() |
|
2650 | 2650 | except: |
|
2651 | 2651 | pass |
|
2652 | 2652 | |
|
2653 | 2653 | if self.strRepr is None and self.expr is not None: |
|
2654 | 2654 | self.strRepr = "%s:(%s)" % ( self.__class__.__name__, _ustr(self.expr) ) |
|
2655 | 2655 | return self.strRepr |
|
2656 | 2656 | |
|
2657 | 2657 | |
|
2658 | 2658 | class FollowedBy(ParseElementEnhance): |
|
2659 | 2659 | """Lookahead matching of the given parse expression. FollowedBy |
|
2660 | 2660 | does *not* advance the parsing position within the input string, it only |
|
2661 | 2661 | verifies that the specified parse expression matches at the current |
|
2662 | 2662 | position. FollowedBy always returns a null token list.""" |
|
2663 | 2663 | def __init__( self, expr ): |
|
2664 | 2664 | super(FollowedBy,self).__init__(expr) |
|
2665 | 2665 | self.mayReturnEmpty = True |
|
2666 | 2666 | |
|
2667 | 2667 | def parseImpl( self, instring, loc, doActions=True ): |
|
2668 | 2668 | self.expr.tryParse( instring, loc ) |
|
2669 | 2669 | return loc, [] |
|
2670 | 2670 | |
|
2671 | 2671 | |
|
2672 | 2672 | class NotAny(ParseElementEnhance): |
|
2673 | 2673 | """Lookahead to disallow matching with the given parse expression. NotAny |
|
2674 | 2674 | does *not* advance the parsing position within the input string, it only |
|
2675 | 2675 | verifies that the specified parse expression does *not* match at the current |
|
2676 | 2676 | position. Also, NotAny does *not* skip over leading whitespace. NotAny |
|
2677 | 2677 | always returns a null token list. May be constructed using the '~' operator.""" |
|
2678 | 2678 | def __init__( self, expr ): |
|
2679 | 2679 | super(NotAny,self).__init__(expr) |
|
2680 | 2680 | #~ self.leaveWhitespace() |
|
2681 | 2681 | self.skipWhitespace = False # do NOT use self.leaveWhitespace(), don't want to propagate to exprs |
|
2682 | 2682 | self.mayReturnEmpty = True |
|
2683 | 2683 | self.errmsg = "Found unwanted token, "+_ustr(self.expr) |
|
2684 | 2684 | #self.myException = ParseException("",0,self.errmsg,self) |
|
2685 | 2685 | |
|
2686 | 2686 | def parseImpl( self, instring, loc, doActions=True ): |
|
2687 | 2687 | try: |
|
2688 | 2688 | self.expr.tryParse( instring, loc ) |
|
2689 | 2689 | except (ParseException,IndexError): |
|
2690 | 2690 | pass |
|
2691 | 2691 | else: |
|
2692 | 2692 | #~ raise ParseException(instring, loc, self.errmsg ) |
|
2693 | 2693 | exc = self.myException |
|
2694 | 2694 | exc.loc = loc |
|
2695 | 2695 | exc.pstr = instring |
|
2696 | 2696 | raise exc |
|
2697 | 2697 | return loc, [] |
|
2698 | 2698 | |
|
2699 | 2699 | def __str__( self ): |
|
2700 | 2700 | if hasattr(self,"name"): |
|
2701 | 2701 | return self.name |
|
2702 | 2702 | |
|
2703 | 2703 | if self.strRepr is None: |
|
2704 | 2704 | self.strRepr = "~{" + _ustr(self.expr) + "}" |
|
2705 | 2705 | |
|
2706 | 2706 | return self.strRepr |
|
2707 | 2707 | |
|
2708 | 2708 | |
|
2709 | 2709 | class ZeroOrMore(ParseElementEnhance): |
|
2710 | 2710 | """Optional repetition of zero or more of the given expression.""" |
|
2711 | 2711 | def __init__( self, expr ): |
|
2712 | 2712 | super(ZeroOrMore,self).__init__(expr) |
|
2713 | 2713 | self.mayReturnEmpty = True |
|
2714 | 2714 | |
|
2715 | 2715 | def parseImpl( self, instring, loc, doActions=True ): |
|
2716 | 2716 | tokens = [] |
|
2717 | 2717 | try: |
|
2718 | 2718 | loc, tokens = self.expr._parse( instring, loc, doActions, callPreParse=False ) |
|
2719 | 2719 | hasIgnoreExprs = ( len(self.ignoreExprs) > 0 ) |
|
2720 | 2720 | while 1: |
|
2721 | 2721 | if hasIgnoreExprs: |
|
2722 | 2722 | preloc = self._skipIgnorables( instring, loc ) |
|
2723 | 2723 | else: |
|
2724 | 2724 | preloc = loc |
|
2725 | 2725 | loc, tmptokens = self.expr._parse( instring, preloc, doActions ) |
|
2726 | 2726 | if tmptokens or tmptokens.keys(): |
|
2727 | 2727 | tokens += tmptokens |
|
2728 | 2728 | except (ParseException,IndexError): |
|
2729 | 2729 | pass |
|
2730 | 2730 | |
|
2731 | 2731 | return loc, tokens |
|
2732 | 2732 | |
|
2733 | 2733 | def __str__( self ): |
|
2734 | 2734 | if hasattr(self,"name"): |
|
2735 | 2735 | return self.name |
|
2736 | 2736 | |
|
2737 | 2737 | if self.strRepr is None: |
|
2738 | 2738 | self.strRepr = "[" + _ustr(self.expr) + "]..." |
|
2739 | 2739 | |
|
2740 | 2740 | return self.strRepr |
|
2741 | 2741 | |
|
2742 | 2742 | def setResultsName( self, name, listAllMatches=False ): |
|
2743 | 2743 | ret = super(ZeroOrMore,self).setResultsName(name,listAllMatches) |
|
2744 | 2744 | ret.saveAsList = True |
|
2745 | 2745 | return ret |
|
2746 | 2746 | |
|
2747 | 2747 | |
|
2748 | 2748 | class OneOrMore(ParseElementEnhance): |
|
2749 | 2749 | """Repetition of one or more of the given expression.""" |
|
2750 | 2750 | def parseImpl( self, instring, loc, doActions=True ): |
|
2751 | 2751 | # must be at least one |
|
2752 | 2752 | loc, tokens = self.expr._parse( instring, loc, doActions, callPreParse=False ) |
|
2753 | 2753 | try: |
|
2754 | 2754 | hasIgnoreExprs = ( len(self.ignoreExprs) > 0 ) |
|
2755 | 2755 | while 1: |
|
2756 | 2756 | if hasIgnoreExprs: |
|
2757 | 2757 | preloc = self._skipIgnorables( instring, loc ) |
|
2758 | 2758 | else: |
|
2759 | 2759 | preloc = loc |
|
2760 | 2760 | loc, tmptokens = self.expr._parse( instring, preloc, doActions ) |
|
2761 | 2761 | if tmptokens or tmptokens.keys(): |
|
2762 | 2762 | tokens += tmptokens |
|
2763 | 2763 | except (ParseException,IndexError): |
|
2764 | 2764 | pass |
|
2765 | 2765 | |
|
2766 | 2766 | return loc, tokens |
|
2767 | 2767 | |
|
2768 | 2768 | def __str__( self ): |
|
2769 | 2769 | if hasattr(self,"name"): |
|
2770 | 2770 | return self.name |
|
2771 | 2771 | |
|
2772 | 2772 | if self.strRepr is None: |
|
2773 | 2773 | self.strRepr = "{" + _ustr(self.expr) + "}..." |
|
2774 | 2774 | |
|
2775 | 2775 | return self.strRepr |
|
2776 | 2776 | |
|
2777 | 2777 | def setResultsName( self, name, listAllMatches=False ): |
|
2778 | 2778 | ret = super(OneOrMore,self).setResultsName(name,listAllMatches) |
|
2779 | 2779 | ret.saveAsList = True |
|
2780 | 2780 | return ret |
|
2781 | 2781 | |
|
2782 | 2782 | class _NullToken(object): |
|
2783 | 2783 | def __bool__(self): |
|
2784 | 2784 | return False |
|
2785 | 2785 | __nonzero__ = __bool__ |
|
2786 | 2786 | def __str__(self): |
|
2787 | 2787 | return "" |
|
2788 | 2788 | |
|
2789 | 2789 | _optionalNotMatched = _NullToken() |
|
2790 | 2790 | class Optional(ParseElementEnhance): |
|
2791 | 2791 | """Optional matching of the given expression. |
|
2792 | 2792 | A default return string can also be specified, if the optional expression |
|
2793 | 2793 | is not found. |
|
2794 | 2794 | """ |
|
2795 | 2795 | def __init__( self, exprs, default=_optionalNotMatched ): |
|
2796 | 2796 | super(Optional,self).__init__( exprs, savelist=False ) |
|
2797 | 2797 | self.defaultValue = default |
|
2798 | 2798 | self.mayReturnEmpty = True |
|
2799 | 2799 | |
|
2800 | 2800 | def parseImpl( self, instring, loc, doActions=True ): |
|
2801 | 2801 | try: |
|
2802 | 2802 | loc, tokens = self.expr._parse( instring, loc, doActions, callPreParse=False ) |
|
2803 | 2803 | except (ParseException,IndexError): |
|
2804 | 2804 | if self.defaultValue is not _optionalNotMatched: |
|
2805 | 2805 | if self.expr.resultsName: |
|
2806 | 2806 | tokens = ParseResults([ self.defaultValue ]) |
|
2807 | 2807 | tokens[self.expr.resultsName] = self.defaultValue |
|
2808 | 2808 | else: |
|
2809 | 2809 | tokens = [ self.defaultValue ] |
|
2810 | 2810 | else: |
|
2811 | 2811 | tokens = [] |
|
2812 | 2812 | return loc, tokens |
|
2813 | 2813 | |
|
2814 | 2814 | def __str__( self ): |
|
2815 | 2815 | if hasattr(self,"name"): |
|
2816 | 2816 | return self.name |
|
2817 | 2817 | |
|
2818 | 2818 | if self.strRepr is None: |
|
2819 | 2819 | self.strRepr = "[" + _ustr(self.expr) + "]" |
|
2820 | 2820 | |
|
2821 | 2821 | return self.strRepr |
|
2822 | 2822 | |
|
2823 | 2823 | |
|
2824 | 2824 | class SkipTo(ParseElementEnhance): |
|
2825 | 2825 | """Token for skipping over all undefined text until the matched expression is found. |
|
2826 | 2826 | If include is set to true, the matched expression is also parsed (the skipped text |
|
2827 | 2827 | and matched expression are returned as a 2-element list). The ignore |
|
2828 | 2828 | argument is used to define grammars (typically quoted strings and comments) that |
|
2829 | 2829 | might contain false matches. |
|
2830 | 2830 | """ |
|
2831 | 2831 | def __init__( self, other, include=False, ignore=None, failOn=None ): |
|
2832 | 2832 | super( SkipTo, self ).__init__( other ) |
|
2833 | 2833 | self.ignoreExpr = ignore |
|
2834 | 2834 | self.mayReturnEmpty = True |
|
2835 | 2835 | self.mayIndexError = False |
|
2836 | 2836 | self.includeMatch = include |
|
2837 | 2837 | self.asList = False |
|
2838 | 2838 | if failOn is not None and isinstance(failOn, basestring): |
|
2839 | 2839 | self.failOn = Literal(failOn) |
|
2840 | 2840 | else: |
|
2841 | 2841 | self.failOn = failOn |
|
2842 | 2842 | self.errmsg = "No match found for "+_ustr(self.expr) |
|
2843 | 2843 | #self.myException = ParseException("",0,self.errmsg,self) |
|
2844 | 2844 | |
|
2845 | 2845 | def parseImpl( self, instring, loc, doActions=True ): |
|
2846 | 2846 | startLoc = loc |
|
2847 | 2847 | instrlen = len(instring) |
|
2848 | 2848 | expr = self.expr |
|
2849 | 2849 | failParse = False |
|
2850 | 2850 | while loc <= instrlen: |
|
2851 | 2851 | try: |
|
2852 | 2852 | if self.failOn: |
|
2853 | 2853 | try: |
|
2854 | 2854 | self.failOn.tryParse(instring, loc) |
|
2855 | 2855 | except ParseBaseException: |
|
2856 | 2856 | pass |
|
2857 | 2857 | else: |
|
2858 | 2858 | failParse = True |
|
2859 | 2859 | raise ParseException(instring, loc, "Found expression " + str(self.failOn)) |
|
2860 | 2860 | failParse = False |
|
2861 | 2861 | if self.ignoreExpr is not None: |
|
2862 | 2862 | while 1: |
|
2863 | 2863 | try: |
|
2864 | 2864 | loc = self.ignoreExpr.tryParse(instring,loc) |
|
2865 | 2865 | print "found ignoreExpr, advance to", loc |
|
2866 | 2866 | except ParseBaseException: |
|
2867 | 2867 | break |
|
2868 | 2868 | expr._parse( instring, loc, doActions=False, callPreParse=False ) |
|
2869 | 2869 | skipText = instring[startLoc:loc] |
|
2870 | 2870 | if self.includeMatch: |
|
2871 | 2871 | loc,mat = expr._parse(instring,loc,doActions,callPreParse=False) |
|
2872 | 2872 | if mat: |
|
2873 | 2873 | skipRes = ParseResults( skipText ) |
|
2874 | 2874 | skipRes += mat |
|
2875 | 2875 | return loc, [ skipRes ] |
|
2876 | 2876 | else: |
|
2877 | 2877 | return loc, [ skipText ] |
|
2878 | 2878 | else: |
|
2879 | 2879 | return loc, [ skipText ] |
|
2880 | 2880 | except (ParseException,IndexError): |
|
2881 | 2881 | if failParse: |
|
2882 | 2882 | raise |
|
2883 | 2883 | else: |
|
2884 | 2884 | loc += 1 |
|
2885 | 2885 | exc = self.myException |
|
2886 | 2886 | exc.loc = loc |
|
2887 | 2887 | exc.pstr = instring |
|
2888 | 2888 | raise exc |
|
2889 | 2889 | |
|
2890 | 2890 | class Forward(ParseElementEnhance): |
|
2891 | 2891 | """Forward declaration of an expression to be defined later - |
|
2892 | 2892 | used for recursive grammars, such as algebraic infix notation. |
|
2893 | 2893 | When the expression is known, it is assigned to the Forward variable using the '<<' operator. |
|
2894 | 2894 | |
|
2895 | 2895 | Note: take care when assigning to Forward not to overlook precedence of operators. |
|
2896 | 2896 | Specifically, '|' has a lower precedence than '<<', so that:: |
|
2897 | 2897 | fwdExpr << a | b | c |
|
2898 | 2898 | will actually be evaluated as:: |
|
2899 | 2899 | (fwdExpr << a) | b | c |
|
2900 | 2900 | thereby leaving b and c out as parseable alternatives. It is recommended that you |
|
2901 | 2901 | explicitly group the values inserted into the Forward:: |
|
2902 | 2902 | fwdExpr << (a | b | c) |
|
2903 | 2903 | """ |
|
2904 | 2904 | def __init__( self, other=None ): |
|
2905 | 2905 | super(Forward,self).__init__( other, savelist=False ) |
|
2906 | 2906 | |
|
2907 | 2907 | def __lshift__( self, other ): |
|
2908 | 2908 | if isinstance( other, basestring ): |
|
2909 | 2909 | other = Literal(other) |
|
2910 | 2910 | self.expr = other |
|
2911 | 2911 | self.mayReturnEmpty = other.mayReturnEmpty |
|
2912 | 2912 | self.strRepr = None |
|
2913 | 2913 | self.mayIndexError = self.expr.mayIndexError |
|
2914 | 2914 | self.mayReturnEmpty = self.expr.mayReturnEmpty |
|
2915 | 2915 | self.setWhitespaceChars( self.expr.whiteChars ) |
|
2916 | 2916 | self.skipWhitespace = self.expr.skipWhitespace |
|
2917 | 2917 | self.saveAsList = self.expr.saveAsList |
|
2918 | 2918 | self.ignoreExprs.extend(self.expr.ignoreExprs) |
|
2919 | 2919 | return None |
|
2920 | 2920 | |
|
2921 | 2921 | def leaveWhitespace( self ): |
|
2922 | 2922 | self.skipWhitespace = False |
|
2923 | 2923 | return self |
|
2924 | 2924 | |
|
2925 | 2925 | def streamline( self ): |
|
2926 | 2926 | if not self.streamlined: |
|
2927 | 2927 | self.streamlined = True |
|
2928 | 2928 | if self.expr is not None: |
|
2929 | 2929 | self.expr.streamline() |
|
2930 | 2930 | return self |
|
2931 | 2931 | |
|
2932 | 2932 | def validate( self, validateTrace=[] ): |
|
2933 | 2933 | if self not in validateTrace: |
|
2934 | 2934 | tmp = validateTrace[:]+[self] |
|
2935 | 2935 | if self.expr is not None: |
|
2936 | 2936 | self.expr.validate(tmp) |
|
2937 | 2937 | self.checkRecursion([]) |
|
2938 | 2938 | |
|
2939 | 2939 | def __str__( self ): |
|
2940 | 2940 | if hasattr(self,"name"): |
|
2941 | 2941 | return self.name |
|
2942 | 2942 | |
|
2943 | 2943 | self._revertClass = self.__class__ |
|
2944 | 2944 | self.__class__ = _ForwardNoRecurse |
|
2945 | 2945 | try: |
|
2946 | 2946 | if self.expr is not None: |
|
2947 | 2947 | retString = _ustr(self.expr) |
|
2948 | 2948 | else: |
|
2949 | 2949 | retString = "None" |
|
2950 | 2950 | finally: |
|
2951 | 2951 | self.__class__ = self._revertClass |
|
2952 | 2952 | return self.__class__.__name__ + ": " + retString |
|
2953 | 2953 | |
|
2954 | 2954 | def copy(self): |
|
2955 | 2955 | if self.expr is not None: |
|
2956 | 2956 | return super(Forward,self).copy() |
|
2957 | 2957 | else: |
|
2958 | 2958 | ret = Forward() |
|
2959 | 2959 | ret << self |
|
2960 | 2960 | return ret |
|
2961 | 2961 | |
|
2962 | 2962 | class _ForwardNoRecurse(Forward): |
|
2963 | 2963 | def __str__( self ): |
|
2964 | 2964 | return "..." |
|
2965 | 2965 | |
|
2966 | 2966 | class TokenConverter(ParseElementEnhance): |
|
2967 | 2967 | """Abstract subclass of ParseExpression, for converting parsed results.""" |
|
2968 | 2968 | def __init__( self, expr, savelist=False ): |
|
2969 | 2969 | super(TokenConverter,self).__init__( expr )#, savelist ) |
|
2970 | 2970 | self.saveAsList = False |
|
2971 | 2971 | |
|
2972 | 2972 | class Upcase(TokenConverter): |
|
2973 | 2973 | """Converter to upper case all matching tokens.""" |
|
2974 | 2974 | def __init__(self, *args): |
|
2975 | 2975 | super(Upcase,self).__init__(*args) |
|
2976 | 2976 | warnings.warn("Upcase class is deprecated, use upcaseTokens parse action instead", |
|
2977 | 2977 | DeprecationWarning,stacklevel=2) |
|
2978 | 2978 | |
|
2979 | 2979 | def postParse( self, instring, loc, tokenlist ): |
|
2980 | 2980 | return list(map( string.upper, tokenlist )) |
|
2981 | 2981 | |
|
2982 | 2982 | |
|
2983 | 2983 | class Combine(TokenConverter): |
|
2984 | 2984 | """Converter to concatenate all matching tokens to a single string. |
|
2985 | 2985 | By default, the matching patterns must also be contiguous in the input string; |
|
2986 | 2986 | this can be disabled by specifying 'adjacent=False' in the constructor. |
|
2987 | 2987 | """ |
|
2988 | 2988 | def __init__( self, expr, joinString="", adjacent=True ): |
|
2989 | 2989 | super(Combine,self).__init__( expr ) |
|
2990 | 2990 | # suppress whitespace-stripping in contained parse expressions, but re-enable it on the Combine itself |
|
2991 | 2991 | if adjacent: |
|
2992 | 2992 | self.leaveWhitespace() |
|
2993 | 2993 | self.adjacent = adjacent |
|
2994 | 2994 | self.skipWhitespace = True |
|
2995 | 2995 | self.joinString = joinString |
|
2996 | 2996 | |
|
2997 | 2997 | def ignore( self, other ): |
|
2998 | 2998 | if self.adjacent: |
|
2999 | 2999 | ParserElement.ignore(self, other) |
|
3000 | 3000 | else: |
|
3001 | 3001 | super( Combine, self).ignore( other ) |
|
3002 | 3002 | return self |
|
3003 | 3003 | |
|
3004 | 3004 | def postParse( self, instring, loc, tokenlist ): |
|
3005 | 3005 | retToks = tokenlist.copy() |
|
3006 | 3006 | del retToks[:] |
|
3007 | 3007 | retToks += ParseResults([ "".join(tokenlist._asStringList(self.joinString)) ], modal=self.modalResults) |
|
3008 | 3008 | |
|
3009 | 3009 | if self.resultsName and len(retToks.keys())>0: |
|
3010 | 3010 | return [ retToks ] |
|
3011 | 3011 | else: |
|
3012 | 3012 | return retToks |
|
3013 | 3013 | |
|
3014 | 3014 | class Group(TokenConverter): |
|
3015 | 3015 | """Converter to return the matched tokens as a list - useful for returning tokens of ZeroOrMore and OneOrMore expressions.""" |
|
3016 | 3016 | def __init__( self, expr ): |
|
3017 | 3017 | super(Group,self).__init__( expr ) |
|
3018 | 3018 | self.saveAsList = True |
|
3019 | 3019 | |
|
3020 | 3020 | def postParse( self, instring, loc, tokenlist ): |
|
3021 | 3021 | return [ tokenlist ] |
|
3022 | 3022 | |
|
3023 | 3023 | class Dict(TokenConverter): |
|
3024 | 3024 | """Converter to return a repetitive expression as a list, but also as a dictionary. |
|
3025 | 3025 | Each element can also be referenced using the first token in the expression as its key. |
|
3026 | 3026 | Useful for tabular report scraping when the first column can be used as a item key. |
|
3027 | 3027 | """ |
|
3028 | 3028 | def __init__( self, exprs ): |
|
3029 | 3029 | super(Dict,self).__init__( exprs ) |
|
3030 | 3030 | self.saveAsList = True |
|
3031 | 3031 | |
|
3032 | 3032 | def postParse( self, instring, loc, tokenlist ): |
|
3033 | 3033 | for i,tok in enumerate(tokenlist): |
|
3034 | 3034 | if len(tok) == 0: |
|
3035 | 3035 | continue |
|
3036 | 3036 | ikey = tok[0] |
|
3037 | 3037 | if isinstance(ikey,int): |
|
3038 | 3038 | ikey = _ustr(tok[0]).strip() |
|
3039 | 3039 | if len(tok)==1: |
|
3040 | 3040 | tokenlist[ikey] = _ParseResultsWithOffset("",i) |
|
3041 | 3041 | elif len(tok)==2 and not isinstance(tok[1],ParseResults): |
|
3042 | 3042 | tokenlist[ikey] = _ParseResultsWithOffset(tok[1],i) |
|
3043 | 3043 | else: |
|
3044 | 3044 | dictvalue = tok.copy() #ParseResults(i) |
|
3045 | 3045 | del dictvalue[0] |
|
3046 | 3046 | if len(dictvalue)!= 1 or (isinstance(dictvalue,ParseResults) and dictvalue.keys()): |
|
3047 | 3047 | tokenlist[ikey] = _ParseResultsWithOffset(dictvalue,i) |
|
3048 | 3048 | else: |
|
3049 | 3049 | tokenlist[ikey] = _ParseResultsWithOffset(dictvalue[0],i) |
|
3050 | 3050 | |
|
3051 | 3051 | if self.resultsName: |
|
3052 | 3052 | return [ tokenlist ] |
|
3053 | 3053 | else: |
|
3054 | 3054 | return tokenlist |
|
3055 | 3055 | |
|
3056 | 3056 | |
|
3057 | 3057 | class Suppress(TokenConverter): |
|
3058 | 3058 | """Converter for ignoring the results of a parsed expression.""" |
|
3059 | 3059 | def postParse( self, instring, loc, tokenlist ): |
|
3060 | 3060 | return [] |
|
3061 | 3061 | |
|
3062 | 3062 | def suppress( self ): |
|
3063 | 3063 | return self |
|
3064 | 3064 | |
|
3065 | 3065 | |
|
3066 | 3066 | class OnlyOnce(object): |
|
3067 | 3067 | """Wrapper for parse actions, to ensure they are only called once.""" |
|
3068 | 3068 | def __init__(self, methodCall): |
|
3069 | 3069 | self.callable = ParserElement._normalizeParseActionArgs(methodCall) |
|
3070 | 3070 | self.called = False |
|
3071 | 3071 | def __call__(self,s,l,t): |
|
3072 | 3072 | if not self.called: |
|
3073 | 3073 | results = self.callable(s,l,t) |
|
3074 | 3074 | self.called = True |
|
3075 | 3075 | return results |
|
3076 | 3076 | raise ParseException(s,l,"") |
|
3077 | 3077 | def reset(self): |
|
3078 | 3078 | self.called = False |
|
3079 | 3079 | |
|
3080 | 3080 | def traceParseAction(f): |
|
3081 | 3081 | """Decorator for debugging parse actions.""" |
|
3082 | 3082 | f = ParserElement._normalizeParseActionArgs(f) |
|
3083 | 3083 | def z(*paArgs): |
|
3084 | 3084 | thisFunc = f.func_name |
|
3085 | 3085 | s,l,t = paArgs[-3:] |
|
3086 | 3086 | if len(paArgs)>3: |
|
3087 | 3087 | thisFunc = paArgs[0].__class__.__name__ + '.' + thisFunc |
|
3088 | 3088 | sys.stderr.write( ">>entering %s(line: '%s', %d, %s)\n" % (thisFunc,line(l,s),l,t) ) |
|
3089 | 3089 | try: |
|
3090 | 3090 | ret = f(*paArgs) |
|
3091 | 3091 | except Exception, exc: |
|
3092 | 3092 | sys.stderr.write( "<<leaving %s (exception: %s)\n" % (thisFunc,exc) ) |
|
3093 | 3093 | raise |
|
3094 | 3094 | sys.stderr.write( "<<leaving %s (ret: %s)\n" % (thisFunc,ret) ) |
|
3095 | 3095 | return ret |
|
3096 | 3096 | try: |
|
3097 | 3097 | z.__name__ = f.__name__ |
|
3098 | 3098 | except AttributeError: |
|
3099 | 3099 | pass |
|
3100 | 3100 | return z |
|
3101 | 3101 | |
|
3102 | 3102 | # |
|
3103 | 3103 | # global helpers |
|
3104 | 3104 | # |
|
3105 | 3105 | def delimitedList( expr, delim=",", combine=False ): |
|
3106 | 3106 | """Helper to define a delimited list of expressions - the delimiter defaults to ','. |
|
3107 | 3107 | By default, the list elements and delimiters can have intervening whitespace, and |
|
3108 | 3108 | comments, but this can be overridden by passing 'combine=True' in the constructor. |
|
3109 | 3109 | If combine is set to True, the matching tokens are returned as a single token |
|
3110 | 3110 | string, with the delimiters included; otherwise, the matching tokens are returned |
|
3111 | 3111 | as a list of tokens, with the delimiters suppressed. |
|
3112 | 3112 | """ |
|
3113 | 3113 | dlName = _ustr(expr)+" ["+_ustr(delim)+" "+_ustr(expr)+"]..." |
|
3114 | 3114 | if combine: |
|
3115 | 3115 | return Combine( expr + ZeroOrMore( delim + expr ) ).setName(dlName) |
|
3116 | 3116 | else: |
|
3117 | 3117 | return ( expr + ZeroOrMore( Suppress( delim ) + expr ) ).setName(dlName) |
|
3118 | 3118 | |
|
3119 | 3119 | def countedArray( expr ): |
|
3120 | 3120 | """Helper to define a counted list of expressions. |
|
3121 | 3121 | This helper defines a pattern of the form:: |
|
3122 | 3122 | integer expr expr expr... |
|
3123 | 3123 | where the leading integer tells how many expr expressions follow. |
|
3124 | 3124 | The matched tokens returns the array of expr tokens as a list - the leading count token is suppressed. |
|
3125 | 3125 | """ |
|
3126 | 3126 | arrayExpr = Forward() |
|
3127 | 3127 | def countFieldParseAction(s,l,t): |
|
3128 | 3128 | n = int(t[0]) |
|
3129 | 3129 | arrayExpr << (n and Group(And([expr]*n)) or Group(empty)) |
|
3130 | 3130 | return [] |
|
3131 | 3131 | return ( Word(nums).setName("arrayLen").setParseAction(countFieldParseAction, callDuringTry=True) + arrayExpr ) |
|
3132 | 3132 | |
|
3133 | 3133 | def _flatten(L): |
|
3134 | 3134 | if type(L) is not list: return [L] |
|
3135 | 3135 | if L == []: return L |
|
3136 | 3136 | return _flatten(L[0]) + _flatten(L[1:]) |
|
3137 | 3137 | |
|
3138 | 3138 | def matchPreviousLiteral(expr): |
|
3139 | 3139 | """Helper to define an expression that is indirectly defined from |
|
3140 | 3140 | the tokens matched in a previous expression, that is, it looks |
|
3141 | 3141 | for a 'repeat' of a previous expression. For example:: |
|
3142 | 3142 | first = Word(nums) |
|
3143 | 3143 | second = matchPreviousLiteral(first) |
|
3144 | 3144 | matchExpr = first + ":" + second |
|
3145 | 3145 | will match "1:1", but not "1:2". Because this matches a |
|
3146 | 3146 | previous literal, will also match the leading "1:1" in "1:10". |
|
3147 | 3147 | If this is not desired, use matchPreviousExpr. |
|
3148 | 3148 | Do *not* use with packrat parsing enabled. |
|
3149 | 3149 | """ |
|
3150 | 3150 | rep = Forward() |
|
3151 | 3151 | def copyTokenToRepeater(s,l,t): |
|
3152 | 3152 | if t: |
|
3153 | 3153 | if len(t) == 1: |
|
3154 | 3154 | rep << t[0] |
|
3155 | 3155 | else: |
|
3156 | 3156 | # flatten t tokens |
|
3157 | 3157 | tflat = _flatten(t.asList()) |
|
3158 | 3158 | rep << And( [ Literal(tt) for tt in tflat ] ) |
|
3159 | 3159 | else: |
|
3160 | 3160 | rep << Empty() |
|
3161 | 3161 | expr.addParseAction(copyTokenToRepeater, callDuringTry=True) |
|
3162 | 3162 | return rep |
|
3163 | 3163 | |
|
3164 | 3164 | def matchPreviousExpr(expr): |
|
3165 | 3165 | """Helper to define an expression that is indirectly defined from |
|
3166 | 3166 | the tokens matched in a previous expression, that is, it looks |
|
3167 | 3167 | for a 'repeat' of a previous expression. For example:: |
|
3168 | 3168 | first = Word(nums) |
|
3169 | 3169 | second = matchPreviousExpr(first) |
|
3170 | 3170 | matchExpr = first + ":" + second |
|
3171 | 3171 | will match "1:1", but not "1:2". Because this matches by |
|
3172 | 3172 | expressions, will *not* match the leading "1:1" in "1:10"; |
|
3173 | 3173 | the expressions are evaluated first, and then compared, so |
|
3174 | 3174 | "1" is compared with "10". |
|
3175 | 3175 | Do *not* use with packrat parsing enabled. |
|
3176 | 3176 | """ |
|
3177 | 3177 | rep = Forward() |
|
3178 | 3178 | e2 = expr.copy() |
|
3179 | 3179 | rep << e2 |
|
3180 | 3180 | def copyTokenToRepeater(s,l,t): |
|
3181 | 3181 | matchTokens = _flatten(t.asList()) |
|
3182 | 3182 | def mustMatchTheseTokens(s,l,t): |
|
3183 | 3183 | theseTokens = _flatten(t.asList()) |
|
3184 | 3184 | if theseTokens != matchTokens: |
|
3185 | 3185 | raise ParseException("",0,"") |
|
3186 | 3186 | rep.setParseAction( mustMatchTheseTokens, callDuringTry=True ) |
|
3187 | 3187 | expr.addParseAction(copyTokenToRepeater, callDuringTry=True) |
|
3188 | 3188 | return rep |
|
3189 | 3189 | |
|
3190 | 3190 | def _escapeRegexRangeChars(s): |
|
3191 | 3191 | #~ escape these chars: ^-] |
|
3192 | 3192 | for c in r"\^-]": |
|
3193 | 3193 | s = s.replace(c,_bslash+c) |
|
3194 | 3194 | s = s.replace("\n",r"\n") |
|
3195 | 3195 | s = s.replace("\t",r"\t") |
|
3196 | 3196 | return _ustr(s) |
|
3197 | 3197 | |
|
3198 | 3198 | def oneOf( strs, caseless=False, useRegex=True ): |
|
3199 | 3199 | """Helper to quickly define a set of alternative Literals, and makes sure to do |
|
3200 | 3200 | longest-first testing when there is a conflict, regardless of the input order, |
|
3201 | 3201 | but returns a MatchFirst for best performance. |
|
3202 | 3202 | |
|
3203 | 3203 | Parameters: |
|
3204 | 3204 | - strs - a string of space-delimited literals, or a list of string literals |
|
3205 | 3205 | - caseless - (default=False) - treat all literals as caseless |
|
3206 | 3206 | - useRegex - (default=True) - as an optimization, will generate a Regex |
|
3207 | 3207 | object; otherwise, will generate a MatchFirst object (if caseless=True, or |
|
3208 | 3208 | if creating a Regex raises an exception) |
|
3209 | 3209 | """ |
|
3210 | 3210 | if caseless: |
|
3211 | 3211 | isequal = ( lambda a,b: a.upper() == b.upper() ) |
|
3212 | 3212 | masks = ( lambda a,b: b.upper().startswith(a.upper()) ) |
|
3213 | 3213 | parseElementClass = CaselessLiteral |
|
3214 | 3214 | else: |
|
3215 | 3215 | isequal = ( lambda a,b: a == b ) |
|
3216 | 3216 | masks = ( lambda a,b: b.startswith(a) ) |
|
3217 | 3217 | parseElementClass = Literal |
|
3218 | 3218 | |
|
3219 | 3219 | if isinstance(strs,(list,tuple)): |
|
3220 | 3220 | symbols = list(strs[:]) |
|
3221 | 3221 | elif isinstance(strs,basestring): |
|
3222 | 3222 | symbols = strs.split() |
|
3223 | 3223 | else: |
|
3224 | 3224 | warnings.warn("Invalid argument to oneOf, expected string or list", |
|
3225 | 3225 | SyntaxWarning, stacklevel=2) |
|
3226 | 3226 | |
|
3227 | 3227 | i = 0 |
|
3228 | 3228 | while i < len(symbols)-1: |
|
3229 | 3229 | cur = symbols[i] |
|
3230 | 3230 | for j,other in enumerate(symbols[i+1:]): |
|
3231 | 3231 | if ( isequal(other, cur) ): |
|
3232 | 3232 | del symbols[i+j+1] |
|
3233 | 3233 | break |
|
3234 | 3234 | elif ( masks(cur, other) ): |
|
3235 | 3235 | del symbols[i+j+1] |
|
3236 | 3236 | symbols.insert(i,other) |
|
3237 | 3237 | cur = other |
|
3238 | 3238 | break |
|
3239 | 3239 | else: |
|
3240 | 3240 | i += 1 |
|
3241 | 3241 | |
|
3242 | 3242 | if not caseless and useRegex: |
|
3243 | 3243 | #~ print (strs,"->", "|".join( [ _escapeRegexChars(sym) for sym in symbols] )) |
|
3244 | 3244 | try: |
|
3245 | 3245 | if len(symbols)==len("".join(symbols)): |
|
3246 | 3246 | return Regex( "[%s]" % "".join( [ _escapeRegexRangeChars(sym) for sym in symbols] ) ) |
|
3247 | 3247 | else: |
|
3248 | 3248 | return Regex( "|".join( [ re.escape(sym) for sym in symbols] ) ) |
|
3249 | 3249 | except: |
|
3250 | 3250 | warnings.warn("Exception creating Regex for oneOf, building MatchFirst", |
|
3251 | 3251 | SyntaxWarning, stacklevel=2) |
|
3252 | 3252 | |
|
3253 | 3253 | |
|
3254 | 3254 | # last resort, just use MatchFirst |
|
3255 | 3255 | return MatchFirst( [ parseElementClass(sym) for sym in symbols ] ) |
|
3256 | 3256 | |
|
3257 | 3257 | def dictOf( key, value ): |
|
3258 | 3258 | """Helper to easily and clearly define a dictionary by specifying the respective patterns |
|
3259 | 3259 | for the key and value. Takes care of defining the Dict, ZeroOrMore, and Group tokens |
|
3260 | 3260 | in the proper order. The key pattern can include delimiting markers or punctuation, |
|
3261 | 3261 | as long as they are suppressed, thereby leaving the significant key text. The value |
|
3262 | 3262 | pattern can include named results, so that the Dict results can include named token |
|
3263 | 3263 | fields. |
|
3264 | 3264 | """ |
|
3265 | 3265 | return Dict( ZeroOrMore( Group ( key + value ) ) ) |
|
3266 | 3266 | |
|
3267 | 3267 | def originalTextFor(expr, asString=True): |
|
3268 | 3268 | """Helper to return the original, untokenized text for a given expression. Useful to |
|
3269 | 3269 | restore the parsed fields of an HTML start tag into the raw tag text itself, or to |
|
3270 | 3270 | revert separate tokens with intervening whitespace back to the original matching |
|
3271 | 3271 | input text. Simpler to use than the parse action keepOriginalText, and does not |
|
3272 | 3272 | require the inspect module to chase up the call stack. By default, returns a |
|
3273 | 3273 | string containing the original parsed text. |
|
3274 | 3274 | |
|
3275 | 3275 | If the optional asString argument is passed as False, then the return value is a |
|
3276 | 3276 | ParseResults containing any results names that were originally matched, and a |
|
3277 | 3277 | single token containing the original matched text from the input string. So if |
|
3278 | 3278 | the expression passed to originalTextFor contains expressions with defined |
|
3279 | 3279 | results names, you must set asString to False if you want to preserve those |
|
3280 | 3280 | results name values.""" |
|
3281 | 3281 | locMarker = Empty().setParseAction(lambda s,loc,t: loc) |
|
3282 | 3282 | matchExpr = locMarker("_original_start") + expr + locMarker("_original_end") |
|
3283 | 3283 | if asString: |
|
3284 | 3284 | extractText = lambda s,l,t: s[t._original_start:t._original_end] |
|
3285 | 3285 | else: |
|
3286 | 3286 | def extractText(s,l,t): |
|
3287 | 3287 | del t[:] |
|
3288 | 3288 | t.insert(0, s[t._original_start:t._original_end]) |
|
3289 | 3289 | del t["_original_start"] |
|
3290 | 3290 | del t["_original_end"] |
|
3291 | 3291 | matchExpr.setParseAction(extractText) |
|
3292 | 3292 | return matchExpr |
|
3293 | 3293 | |
|
3294 | 3294 | # convenience constants for positional expressions |
|
3295 | 3295 | empty = Empty().setName("empty") |
|
3296 | 3296 | lineStart = LineStart().setName("lineStart") |
|
3297 | 3297 | lineEnd = LineEnd().setName("lineEnd") |
|
3298 | 3298 | stringStart = StringStart().setName("stringStart") |
|
3299 | 3299 | stringEnd = StringEnd().setName("stringEnd") |
|
3300 | 3300 | |
|
3301 | 3301 | _escapedPunc = Word( _bslash, r"\[]-*.$+^?()~ ", exact=2 ).setParseAction(lambda s,l,t:t[0][1]) |
|
3302 | 3302 | _printables_less_backslash = "".join([ c for c in printables if c not in r"\]" ]) |
|
3303 | 3303 | _escapedHexChar = Combine( Suppress(_bslash + "0x") + Word(hexnums) ).setParseAction(lambda s,l,t:unichr(int(t[0],16))) |
|
3304 | 3304 | _escapedOctChar = Combine( Suppress(_bslash) + Word("0","01234567") ).setParseAction(lambda s,l,t:unichr(int(t[0],8))) |
|
3305 | 3305 | _singleChar = _escapedPunc | _escapedHexChar | _escapedOctChar | Word(_printables_less_backslash,exact=1) |
|
3306 | 3306 | _charRange = Group(_singleChar + Suppress("-") + _singleChar) |
|
3307 | 3307 | _reBracketExpr = Literal("[") + Optional("^").setResultsName("negate") + Group( OneOrMore( _charRange | _singleChar ) ).setResultsName("body") + "]" |
|
3308 | 3308 | |
|
3309 | 3309 | _expanded = lambda p: (isinstance(p,ParseResults) and ''.join([ unichr(c) for c in range(ord(p[0]),ord(p[1])+1) ]) or p) |
|
3310 | 3310 | |
|
3311 | 3311 | def srange(s): |
|
3312 | 3312 | r"""Helper to easily define string ranges for use in Word construction. Borrows |
|
3313 | 3313 | syntax from regexp '[]' string range definitions:: |
|
3314 | 3314 | srange("[0-9]") -> "0123456789" |
|
3315 | 3315 | srange("[a-z]") -> "abcdefghijklmnopqrstuvwxyz" |
|
3316 | 3316 | srange("[a-z$_]") -> "abcdefghijklmnopqrstuvwxyz$_" |
|
3317 | 3317 | The input string must be enclosed in []'s, and the returned string is the expanded |
|
3318 | 3318 | character set joined into a single string. |
|
3319 | 3319 | The values enclosed in the []'s may be:: |
|
3320 | 3320 | a single character |
|
3321 | 3321 | an escaped character with a leading backslash (such as \- or \]) |
|
3322 | 3322 | an escaped hex character with a leading '\0x' (\0x21, which is a '!' character) |
|
3323 | 3323 | an escaped octal character with a leading '\0' (\041, which is a '!' character) |
|
3324 | 3324 | a range of any of the above, separated by a dash ('a-z', etc.) |
|
3325 | 3325 | any combination of the above ('aeiouy', 'a-zA-Z0-9_$', etc.) |
|
3326 | 3326 | """ |
|
3327 | 3327 | try: |
|
3328 | 3328 | return "".join([_expanded(part) for part in _reBracketExpr.parseString(s).body]) |
|
3329 | 3329 | except: |
|
3330 | 3330 | return "" |
|
3331 | 3331 | |
|
3332 | 3332 | def matchOnlyAtCol(n): |
|
3333 | 3333 | """Helper method for defining parse actions that require matching at a specific |
|
3334 | 3334 | column in the input text. |
|
3335 | 3335 | """ |
|
3336 | 3336 | def verifyCol(strg,locn,toks): |
|
3337 | 3337 | if col(locn,strg) != n: |
|
3338 | 3338 | raise ParseException(strg,locn,"matched token not at column %d" % n) |
|
3339 | 3339 | return verifyCol |
|
3340 | 3340 | |
|
3341 | 3341 | def replaceWith(replStr): |
|
3342 | 3342 | """Helper method for common parse actions that simply return a literal value. Especially |
|
3343 | 3343 | useful when used with transformString(). |
|
3344 | 3344 | """ |
|
3345 | 3345 | def _replFunc(*args): |
|
3346 | 3346 | return [replStr] |
|
3347 | 3347 | return _replFunc |
|
3348 | 3348 | |
|
3349 | 3349 | def removeQuotes(s,l,t): |
|
3350 | 3350 | """Helper parse action for removing quotation marks from parsed quoted strings. |
|
3351 | 3351 | To use, add this parse action to quoted string using:: |
|
3352 | 3352 | quotedString.setParseAction( removeQuotes ) |
|
3353 | 3353 | """ |
|
3354 | 3354 | return t[0][1:-1] |
|
3355 | 3355 | |
|
3356 | 3356 | def upcaseTokens(s,l,t): |
|
3357 | 3357 | """Helper parse action to convert tokens to upper case.""" |
|
3358 | 3358 | return [ tt.upper() for tt in map(_ustr,t) ] |
|
3359 | 3359 | |
|
3360 | 3360 | def downcaseTokens(s,l,t): |
|
3361 | 3361 | """Helper parse action to convert tokens to lower case.""" |
|
3362 | 3362 | return [ tt.lower() for tt in map(_ustr,t) ] |
|
3363 | 3363 | |
|
3364 | 3364 | def keepOriginalText(s,startLoc,t): |
|
3365 | 3365 | """Helper parse action to preserve original parsed text, |
|
3366 | 3366 | overriding any nested parse actions.""" |
|
3367 | 3367 | try: |
|
3368 | 3368 | endloc = getTokensEndLoc() |
|
3369 | 3369 | except ParseException: |
|
3370 | 3370 | raise ParseFatalException("incorrect usage of keepOriginalText - may only be called as a parse action") |
|
3371 | 3371 | del t[:] |
|
3372 | 3372 | t += ParseResults(s[startLoc:endloc]) |
|
3373 | 3373 | return t |
|
3374 | 3374 | |
|
3375 | 3375 | def getTokensEndLoc(): |
|
3376 | 3376 | """Method to be called from within a parse action to determine the end |
|
3377 | 3377 | location of the parsed tokens.""" |
|
3378 | 3378 | import inspect |
|
3379 | 3379 | fstack = inspect.stack() |
|
3380 | 3380 | try: |
|
3381 | 3381 | # search up the stack (through intervening argument normalizers) for correct calling routine |
|
3382 | 3382 | for f in fstack[2:]: |
|
3383 | 3383 | if f[3] == "_parseNoCache": |
|
3384 | 3384 | endloc = f[0].f_locals["loc"] |
|
3385 | 3385 | return endloc |
|
3386 | 3386 | else: |
|
3387 | 3387 | raise ParseFatalException("incorrect usage of getTokensEndLoc - may only be called from within a parse action") |
|
3388 | 3388 | finally: |
|
3389 | 3389 | del fstack |
|
3390 | 3390 | |
|
3391 | 3391 | def _makeTags(tagStr, xml): |
|
3392 | 3392 | """Internal helper to construct opening and closing tag expressions, given a tag name""" |
|
3393 | 3393 | if isinstance(tagStr,basestring): |
|
3394 | 3394 | resname = tagStr |
|
3395 | 3395 | tagStr = Keyword(tagStr, caseless=not xml) |
|
3396 | 3396 | else: |
|
3397 | 3397 | resname = tagStr.name |
|
3398 | 3398 | |
|
3399 | 3399 | tagAttrName = Word(alphas,alphanums+"_-:") |
|
3400 | 3400 | if (xml): |
|
3401 | 3401 | tagAttrValue = dblQuotedString.copy().setParseAction( removeQuotes ) |
|
3402 | 3402 | openTag = Suppress("<") + tagStr + \ |
|
3403 | 3403 | Dict(ZeroOrMore(Group( tagAttrName + Suppress("=") + tagAttrValue ))) + \ |
|
3404 | 3404 | Optional("/",default=[False]).setResultsName("empty").setParseAction(lambda s,l,t:t[0]=='/') + Suppress(">") |
|
3405 | 3405 | else: |
|
3406 | 3406 | printablesLessRAbrack = "".join( [ c for c in printables if c not in ">" ] ) |
|
3407 | 3407 | tagAttrValue = quotedString.copy().setParseAction( removeQuotes ) | Word(printablesLessRAbrack) |
|
3408 | 3408 | openTag = Suppress("<") + tagStr + \ |
|
3409 | 3409 | Dict(ZeroOrMore(Group( tagAttrName.setParseAction(downcaseTokens) + \ |
|
3410 | 3410 | Optional( Suppress("=") + tagAttrValue ) ))) + \ |
|
3411 | 3411 | Optional("/",default=[False]).setResultsName("empty").setParseAction(lambda s,l,t:t[0]=='/') + Suppress(">") |
|
3412 | 3412 | closeTag = Combine(_L("</") + tagStr + ">") |
|
3413 | 3413 | |
|
3414 | 3414 | openTag = openTag.setResultsName("start"+"".join(resname.replace(":"," ").title().split())).setName("<%s>" % tagStr) |
|
3415 | 3415 | closeTag = closeTag.setResultsName("end"+"".join(resname.replace(":"," ").title().split())).setName("</%s>" % tagStr) |
|
3416 | 3416 | |
|
3417 | 3417 | return openTag, closeTag |
|
3418 | 3418 | |
|
3419 | 3419 | def makeHTMLTags(tagStr): |
|
3420 | 3420 | """Helper to construct opening and closing tag expressions for HTML, given a tag name""" |
|
3421 | 3421 | return _makeTags( tagStr, False ) |
|
3422 | 3422 | |
|
3423 | 3423 | def makeXMLTags(tagStr): |
|
3424 | 3424 | """Helper to construct opening and closing tag expressions for XML, given a tag name""" |
|
3425 | 3425 | return _makeTags( tagStr, True ) |
|
3426 | 3426 | |
|
3427 | 3427 | def withAttribute(*args,**attrDict): |
|
3428 | 3428 | """Helper to create a validating parse action to be used with start tags created |
|
3429 | 3429 | with makeXMLTags or makeHTMLTags. Use withAttribute to qualify a starting tag |
|
3430 | 3430 | with a required attribute value, to avoid false matches on common tags such as |
|
3431 | 3431 | <TD> or <DIV>. |
|
3432 | 3432 | |
|
3433 | 3433 | Call withAttribute with a series of attribute names and values. Specify the list |
|
3434 | 3434 | of filter attributes names and values as: |
|
3435 | 3435 | - keyword arguments, as in (class="Customer",align="right"), or |
|
3436 | 3436 | - a list of name-value tuples, as in ( ("ns1:class", "Customer"), ("ns2:align","right") ) |
|
3437 | 3437 | For attribute names with a namespace prefix, you must use the second form. Attribute |
|
3438 | 3438 | names are matched insensitive to upper/lower case. |
|
3439 | 3439 | |
|
3440 | 3440 | To verify that the attribute exists, but without specifying a value, pass |
|
3441 | 3441 | withAttribute.ANY_VALUE as the value. |
|
3442 | 3442 | """ |
|
3443 | 3443 | if args: |
|
3444 | 3444 | attrs = args[:] |
|
3445 | 3445 | else: |
|
3446 | 3446 | attrs = attrDict.iteritems() |
|
3447 | 3447 | attrs = [(k,v) for k,v in attrs] |
|
3448 | 3448 | def pa(s,l,tokens): |
|
3449 | 3449 | for attrName,attrValue in attrs: |
|
3450 | 3450 | if attrName not in tokens: |
|
3451 | 3451 | raise ParseException(s,l,"no matching attribute " + attrName) |
|
3452 | 3452 | if attrValue != withAttribute.ANY_VALUE and tokens[attrName] != attrValue: |
|
3453 | 3453 | raise ParseException(s,l,"attribute '%s' has value '%s', must be '%s'" % |
|
3454 | 3454 | (attrName, tokens[attrName], attrValue)) |
|
3455 | 3455 | return pa |
|
3456 | 3456 | withAttribute.ANY_VALUE = object() |
|
3457 | 3457 | |
|
3458 | 3458 | opAssoc = _Constants() |
|
3459 | 3459 | opAssoc.LEFT = object() |
|
3460 | 3460 | opAssoc.RIGHT = object() |
|
3461 | 3461 | |
|
3462 | 3462 | def operatorPrecedence( baseExpr, opList ): |
|
3463 | 3463 | """Helper method for constructing grammars of expressions made up of |
|
3464 | 3464 | operators working in a precedence hierarchy. Operators may be unary or |
|
3465 | 3465 | binary, left- or right-associative. Parse actions can also be attached |
|
3466 | 3466 | to operator expressions. |
|
3467 | 3467 | |
|
3468 | 3468 | Parameters: |
|
3469 | 3469 | - baseExpr - expression representing the most basic element for the nested |
|
3470 | 3470 | - opList - list of tuples, one for each operator precedence level in the |
|
3471 | 3471 | expression grammar; each tuple is of the form |
|
3472 | 3472 | (opExpr, numTerms, rightLeftAssoc, parseAction), where: |
|
3473 | 3473 | - opExpr is the pyparsing expression for the operator; |
|
3474 | 3474 | may also be a string, which will be converted to a Literal; |
|
3475 | 3475 | if numTerms is 3, opExpr is a tuple of two expressions, for the |
|
3476 | 3476 | two operators separating the 3 terms |
|
3477 | 3477 | - numTerms is the number of terms for this operator (must |
|
3478 | 3478 | be 1, 2, or 3) |
|
3479 | 3479 | - rightLeftAssoc is the indicator whether the operator is |
|
3480 | 3480 | right or left associative, using the pyparsing-defined |
|
3481 | 3481 | constants opAssoc.RIGHT and opAssoc.LEFT. |
|
3482 | 3482 | - parseAction is the parse action to be associated with |
|
3483 | 3483 | expressions matching this operator expression (the |
|
3484 | 3484 | parse action tuple member may be omitted) |
|
3485 | 3485 | """ |
|
3486 | 3486 | ret = Forward() |
|
3487 | 3487 | lastExpr = baseExpr | ( Suppress('(') + ret + Suppress(')') ) |
|
3488 | 3488 | for i,operDef in enumerate(opList): |
|
3489 | 3489 | opExpr,arity,rightLeftAssoc,pa = (operDef + (None,))[:4] |
|
3490 | 3490 | if arity == 3: |
|
3491 | 3491 | if opExpr is None or len(opExpr) != 2: |
|
3492 | 3492 | raise ValueError("if numterms=3, opExpr must be a tuple or list of two expressions") |
|
3493 | 3493 | opExpr1, opExpr2 = opExpr |
|
3494 | 3494 | thisExpr = Forward()#.setName("expr%d" % i) |
|
3495 | 3495 | if rightLeftAssoc == opAssoc.LEFT: |
|
3496 | 3496 | if arity == 1: |
|
3497 | 3497 | matchExpr = FollowedBy(lastExpr + opExpr) + Group( lastExpr + OneOrMore( opExpr ) ) |
|
3498 | 3498 | elif arity == 2: |
|
3499 | 3499 | if opExpr is not None: |
|
3500 | 3500 | matchExpr = FollowedBy(lastExpr + opExpr + lastExpr) + Group( lastExpr + OneOrMore( opExpr + lastExpr ) ) |
|
3501 | 3501 | else: |
|
3502 | 3502 | matchExpr = FollowedBy(lastExpr+lastExpr) + Group( lastExpr + OneOrMore(lastExpr) ) |
|
3503 | 3503 | elif arity == 3: |
|
3504 | 3504 | matchExpr = FollowedBy(lastExpr + opExpr1 + lastExpr + opExpr2 + lastExpr) + \ |
|
3505 | 3505 | Group( lastExpr + opExpr1 + lastExpr + opExpr2 + lastExpr ) |
|
3506 | 3506 | else: |
|
3507 | 3507 | raise ValueError("operator must be unary (1), binary (2), or ternary (3)") |
|
3508 | 3508 | elif rightLeftAssoc == opAssoc.RIGHT: |
|
3509 | 3509 | if arity == 1: |
|
3510 | 3510 | # try to avoid LR with this extra test |
|
3511 | 3511 | if not isinstance(opExpr, Optional): |
|
3512 | 3512 | opExpr = Optional(opExpr) |
|
3513 | 3513 | matchExpr = FollowedBy(opExpr.expr + thisExpr) + Group( opExpr + thisExpr ) |
|
3514 | 3514 | elif arity == 2: |
|
3515 | 3515 | if opExpr is not None: |
|
3516 | 3516 | matchExpr = FollowedBy(lastExpr + opExpr + thisExpr) + Group( lastExpr + OneOrMore( opExpr + thisExpr ) ) |
|
3517 | 3517 | else: |
|
3518 | 3518 | matchExpr = FollowedBy(lastExpr + thisExpr) + Group( lastExpr + OneOrMore( thisExpr ) ) |
|
3519 | 3519 | elif arity == 3: |
|
3520 | 3520 | matchExpr = FollowedBy(lastExpr + opExpr1 + thisExpr + opExpr2 + thisExpr) + \ |
|
3521 | 3521 | Group( lastExpr + opExpr1 + thisExpr + opExpr2 + thisExpr ) |
|
3522 | 3522 | else: |
|
3523 | 3523 | raise ValueError("operator must be unary (1), binary (2), or ternary (3)") |
|
3524 | 3524 | else: |
|
3525 | 3525 | raise ValueError("operator must indicate right or left associativity") |
|
3526 | 3526 | if pa: |
|
3527 | 3527 | matchExpr.setParseAction( pa ) |
|
3528 | 3528 | thisExpr << ( matchExpr | lastExpr ) |
|
3529 | 3529 | lastExpr = thisExpr |
|
3530 | 3530 | ret << lastExpr |
|
3531 | 3531 | return ret |
|
3532 | 3532 | |
|
3533 | 3533 | dblQuotedString = Regex(r'"(?:[^"\n\r\\]|(?:"")|(?:\\x[0-9a-fA-F]+)|(?:\\.))*"').setName("string enclosed in double quotes") |
|
3534 | 3534 | sglQuotedString = Regex(r"'(?:[^'\n\r\\]|(?:'')|(?:\\x[0-9a-fA-F]+)|(?:\\.))*'").setName("string enclosed in single quotes") |
|
3535 | 3535 | quotedString = Regex(r'''(?:"(?:[^"\n\r\\]|(?:"")|(?:\\x[0-9a-fA-F]+)|(?:\\.))*")|(?:'(?:[^'\n\r\\]|(?:'')|(?:\\x[0-9a-fA-F]+)|(?:\\.))*')''').setName("quotedString using single or double quotes") |
|
3536 | 3536 | unicodeString = Combine(_L('u') + quotedString.copy()) |
|
3537 | 3537 | |
|
3538 | 3538 | def nestedExpr(opener="(", closer=")", content=None, ignoreExpr=quotedString): |
|
3539 | 3539 | """Helper method for defining nested lists enclosed in opening and closing |
|
3540 | 3540 | delimiters ("(" and ")" are the default). |
|
3541 | 3541 | |
|
3542 | 3542 | Parameters: |
|
3543 | 3543 | - opener - opening character for a nested list (default="("); can also be a pyparsing expression |
|
3544 | 3544 | - closer - closing character for a nested list (default=")"); can also be a pyparsing expression |
|
3545 | 3545 | - content - expression for items within the nested lists (default=None) |
|
3546 | 3546 | - ignoreExpr - expression for ignoring opening and closing delimiters (default=quotedString) |
|
3547 | 3547 | |
|
3548 | 3548 | If an expression is not provided for the content argument, the nested |
|
3549 | 3549 | expression will capture all whitespace-delimited content between delimiters |
|
3550 | 3550 | as a list of separate values. |
|
3551 | 3551 | |
|
3552 | 3552 | Use the ignoreExpr argument to define expressions that may contain |
|
3553 | 3553 | opening or closing characters that should not be treated as opening |
|
3554 | 3554 | or closing characters for nesting, such as quotedString or a comment |
|
3555 | 3555 | expression. Specify multiple expressions using an Or or MatchFirst. |
|
3556 | 3556 | The default is quotedString, but if no expressions are to be ignored, |
|
3557 | 3557 | then pass None for this argument. |
|
3558 | 3558 | """ |
|
3559 | 3559 | if opener == closer: |
|
3560 | 3560 | raise ValueError("opening and closing strings cannot be the same") |
|
3561 | 3561 | if content is None: |
|
3562 | 3562 | if isinstance(opener,basestring) and isinstance(closer,basestring): |
|
3563 | 3563 | if len(opener) == 1 and len(closer)==1: |
|
3564 | 3564 | if ignoreExpr is not None: |
|
3565 | 3565 | content = (Combine(OneOrMore(~ignoreExpr + |
|
3566 | 3566 | CharsNotIn(opener+closer+ParserElement.DEFAULT_WHITE_CHARS,exact=1)) |
|
3567 | 3567 | ).setParseAction(lambda t:t[0].strip())) |
|
3568 | 3568 | else: |
|
3569 | 3569 | content = (empty+CharsNotIn(opener+closer+ParserElement.DEFAULT_WHITE_CHARS |
|
3570 | 3570 | ).setParseAction(lambda t:t[0].strip())) |
|
3571 | 3571 | else: |
|
3572 | 3572 | if ignoreExpr is not None: |
|
3573 | 3573 | content = (Combine(OneOrMore(~ignoreExpr + |
|
3574 | 3574 | ~Literal(opener) + ~Literal(closer) + |
|
3575 | 3575 | CharsNotIn(ParserElement.DEFAULT_WHITE_CHARS,exact=1)) |
|
3576 | 3576 | ).setParseAction(lambda t:t[0].strip())) |
|
3577 | 3577 | else: |
|
3578 | 3578 | content = (Combine(OneOrMore(~Literal(opener) + ~Literal(closer) + |
|
3579 | 3579 | CharsNotIn(ParserElement.DEFAULT_WHITE_CHARS,exact=1)) |
|
3580 | 3580 | ).setParseAction(lambda t:t[0].strip())) |
|
3581 | 3581 | else: |
|
3582 | 3582 | raise ValueError("opening and closing arguments must be strings if no content expression is given") |
|
3583 | 3583 | ret = Forward() |
|
3584 | 3584 | if ignoreExpr is not None: |
|
3585 | 3585 | ret << Group( Suppress(opener) + ZeroOrMore( ignoreExpr | ret | content ) + Suppress(closer) ) |
|
3586 | 3586 | else: |
|
3587 | 3587 | ret << Group( Suppress(opener) + ZeroOrMore( ret | content ) + Suppress(closer) ) |
|
3588 | 3588 | return ret |
|
3589 | 3589 | |
|
3590 | 3590 | def indentedBlock(blockStatementExpr, indentStack, indent=True): |
|
3591 | 3591 | """Helper method for defining space-delimited indentation blocks, such as |
|
3592 | 3592 | those used to define block statements in Python source code. |
|
3593 | 3593 | |
|
3594 | 3594 | Parameters: |
|
3595 | 3595 | - blockStatementExpr - expression defining syntax of statement that |
|
3596 | 3596 | is repeated within the indented block |
|
3597 | 3597 | - indentStack - list created by caller to manage indentation stack |
|
3598 | 3598 | (multiple statementWithIndentedBlock expressions within a single grammar |
|
3599 | 3599 | should share a common indentStack) |
|
3600 | 3600 | - indent - boolean indicating whether block must be indented beyond the |
|
3601 | 3601 | the current level; set to False for block of left-most statements |
|
3602 | 3602 | (default=True) |
|
3603 | 3603 | |
|
3604 | 3604 | A valid block must contain at least one blockStatement. |
|
3605 | 3605 | """ |
|
3606 | 3606 | def checkPeerIndent(s,l,t): |
|
3607 | 3607 | if l >= len(s): return |
|
3608 | 3608 | curCol = col(l,s) |
|
3609 | 3609 | if curCol != indentStack[-1]: |
|
3610 | 3610 | if curCol > indentStack[-1]: |
|
3611 | 3611 | raise ParseFatalException(s,l,"illegal nesting") |
|
3612 | 3612 | raise ParseException(s,l,"not a peer entry") |
|
3613 | 3613 | |
|
3614 | 3614 | def checkSubIndent(s,l,t): |
|
3615 | 3615 | curCol = col(l,s) |
|
3616 | 3616 | if curCol > indentStack[-1]: |
|
3617 | 3617 | indentStack.append( curCol ) |
|
3618 | 3618 | else: |
|
3619 | 3619 | raise ParseException(s,l,"not a subentry") |
|
3620 | 3620 | |
|
3621 | 3621 | def checkUnindent(s,l,t): |
|
3622 | 3622 | if l >= len(s): return |
|
3623 | 3623 | curCol = col(l,s) |
|
3624 | 3624 | if not(indentStack and curCol < indentStack[-1] and curCol <= indentStack[-2]): |
|
3625 | 3625 | raise ParseException(s,l,"not an unindent") |
|
3626 | 3626 | indentStack.pop() |
|
3627 | 3627 | |
|
3628 | 3628 | NL = OneOrMore(LineEnd().setWhitespaceChars("\t ").suppress()) |
|
3629 | 3629 | INDENT = Empty() + Empty().setParseAction(checkSubIndent) |
|
3630 | 3630 | PEER = Empty().setParseAction(checkPeerIndent) |
|
3631 | 3631 | UNDENT = Empty().setParseAction(checkUnindent) |
|
3632 | 3632 | if indent: |
|
3633 | 3633 | smExpr = Group( Optional(NL) + |
|
3634 | 3634 | FollowedBy(blockStatementExpr) + |
|
3635 | 3635 | INDENT + (OneOrMore( PEER + Group(blockStatementExpr) + Optional(NL) )) + UNDENT) |
|
3636 | 3636 | else: |
|
3637 | 3637 | smExpr = Group( Optional(NL) + |
|
3638 | 3638 | (OneOrMore( PEER + Group(blockStatementExpr) + Optional(NL) )) ) |
|
3639 | 3639 | blockStatementExpr.ignore(_bslash + LineEnd()) |
|
3640 | 3640 | return smExpr |
|
3641 | 3641 | |
|
3642 | 3642 | alphas8bit = srange(r"[\0xc0-\0xd6\0xd8-\0xf6\0xf8-\0xff]") |
|
3643 | 3643 | punc8bit = srange(r"[\0xa1-\0xbf\0xd7\0xf7]") |
|
3644 | 3644 | |
|
3645 | 3645 | anyOpenTag,anyCloseTag = makeHTMLTags(Word(alphas,alphanums+"_:")) |
|
3646 | 3646 | commonHTMLEntity = Combine(_L("&") + oneOf("gt lt amp nbsp quot").setResultsName("entity") +";").streamline() |
|
3647 | 3647 | _htmlEntityMap = dict(zip("gt lt amp nbsp quot".split(),'><& "')) |
|
3648 | 3648 | replaceHTMLEntity = lambda t : t.entity in _htmlEntityMap and _htmlEntityMap[t.entity] or None |
|
3649 | 3649 | |
|
3650 | 3650 | # it's easy to get these comment structures wrong - they're very common, so may as well make them available |
|
3651 | 3651 | cStyleComment = Regex(r"/\*(?:[^*]*\*+)+?/").setName("C style comment") |
|
3652 | 3652 | |
|
3653 | 3653 | htmlComment = Regex(r"<!--[\s\S]*?-->") |
|
3654 | 3654 | restOfLine = Regex(r".*").leaveWhitespace() |
|
3655 | 3655 | dblSlashComment = Regex(r"\/\/(\\\n|.)*").setName("// comment") |
|
3656 | 3656 | cppStyleComment = Regex(r"/(?:\*(?:[^*]*\*+)+?/|/[^\n]*(?:\n[^\n]*)*?(?:(?<!\\)|\Z))").setName("C++ style comment") |
|
3657 | 3657 | |
|
3658 | 3658 | javaStyleComment = cppStyleComment |
|
3659 | 3659 | pythonStyleComment = Regex(r"#.*").setName("Python style comment") |
|
3660 | 3660 | _noncomma = "".join( [ c for c in printables if c != "," ] ) |
|
3661 | 3661 | _commasepitem = Combine(OneOrMore(Word(_noncomma) + |
|
3662 | 3662 | Optional( Word(" \t") + |
|
3663 | 3663 | ~Literal(",") + ~LineEnd() ) ) ).streamline().setName("commaItem") |
|
3664 | 3664 | commaSeparatedList = delimitedList( Optional( quotedString | _commasepitem, default="") ).setName("commaSeparatedList") |
|
3665 | 3665 | |
|
3666 | 3666 | |
|
3667 | 3667 | if __name__ == "__main__": |
|
3668 | 3668 | |
|
3669 | 3669 | def test( teststring ): |
|
3670 | 3670 | try: |
|
3671 | 3671 | tokens = simpleSQL.parseString( teststring ) |
|
3672 | 3672 | tokenlist = tokens.asList() |
|
3673 | 3673 | print (teststring + "->" + str(tokenlist)) |
|
3674 | 3674 | print ("tokens = " + str(tokens)) |
|
3675 | 3675 | print ("tokens.columns = " + str(tokens.columns)) |
|
3676 | 3676 | print ("tokens.tables = " + str(tokens.tables)) |
|
3677 | 3677 | print (tokens.asXML("SQL",True)) |
|
3678 | 3678 | except ParseBaseException,err: |
|
3679 | 3679 | print (teststring + "->") |
|
3680 | 3680 | print (err.line) |
|
3681 | 3681 | print (" "*(err.column-1) + "^") |
|
3682 | 3682 | print (err) |
|
3683 | 3683 | print() |
|
3684 | 3684 | |
|
3685 | 3685 | selectToken = CaselessLiteral( "select" ) |
|
3686 | 3686 | fromToken = CaselessLiteral( "from" ) |
|
3687 | 3687 | |
|
3688 | 3688 | ident = Word( alphas, alphanums + "_$" ) |
|
3689 | 3689 | columnName = delimitedList( ident, ".", combine=True ).setParseAction( upcaseTokens ) |
|
3690 | 3690 | columnNameList = Group( delimitedList( columnName ) )#.setName("columns") |
|
3691 | 3691 | tableName = delimitedList( ident, ".", combine=True ).setParseAction( upcaseTokens ) |
|
3692 | 3692 | tableNameList = Group( delimitedList( tableName ) )#.setName("tables") |
|
3693 | 3693 | simpleSQL = ( selectToken + \ |
|
3694 | 3694 | ( '*' | columnNameList ).setResultsName( "columns" ) + \ |
|
3695 | 3695 | fromToken + \ |
|
3696 | 3696 | tableNameList.setResultsName( "tables" ) ) |
|
3697 | 3697 | |
|
3698 | 3698 | test( "SELECT * from XYZZY, ABC" ) |
|
3699 | 3699 | test( "select * from SYS.XYZZY" ) |
|
3700 | 3700 | test( "Select A from Sys.dual" ) |
|
3701 | 3701 | test( "Select AA,BB,CC from Sys.dual" ) |
|
3702 | 3702 | test( "Select A, B, C from Sys.dual" ) |
|
3703 | 3703 | test( "Select A, B, C from Sys.dual" ) |
|
3704 | 3704 | test( "Xelect A, B, C from Sys.dual" ) |
|
3705 | 3705 | test( "Select A, B, C frox Sys.dual" ) |
|
3706 | 3706 | test( "Select" ) |
|
3707 | 3707 | test( "Select ^^^ frox Sys.dual" ) |
|
3708 | 3708 | test( "Select A, B, C from Sys.dual, Table2 " ) |
@@ -1,668 +1,669 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Subclass of InteractiveShell for terminal based frontends.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | import __builtin__ |
|
18 | 18 | import bdb |
|
19 | 19 | import os |
|
20 | 20 | import re |
|
21 | 21 | import sys |
|
22 | 22 | import textwrap |
|
23 | 23 | |
|
24 | 24 | try: |
|
25 | 25 | from contextlib import nested |
|
26 | 26 | except: |
|
27 | 27 | from IPython.utils.nested_context import nested |
|
28 | 28 | |
|
29 | 29 | from IPython.core.error import TryNext, UsageError |
|
30 | 30 | from IPython.core.usage import interactive_usage, default_banner |
|
31 | 31 | from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC |
|
32 | 32 | from IPython.core.pylabtools import pylab_activate |
|
33 | 33 | from IPython.testing.skipdoctest import skip_doctest |
|
34 | from IPython.utils.encoding import get_stream_enc | |
|
34 | 35 | from IPython.utils import py3compat |
|
35 | 36 | from IPython.utils.terminal import toggle_set_term_title, set_term_title |
|
36 | 37 | from IPython.utils.process import abbrev_cwd |
|
37 | 38 | from IPython.utils.warn import warn, error |
|
38 | 39 | from IPython.utils.text import num_ini_spaces, SList |
|
39 | 40 | from IPython.utils.traitlets import Integer, CBool, Unicode |
|
40 | 41 | |
|
41 | 42 | #----------------------------------------------------------------------------- |
|
42 | 43 | # Utilities |
|
43 | 44 | #----------------------------------------------------------------------------- |
|
44 | 45 | |
|
45 | 46 | def get_default_editor(): |
|
46 | 47 | try: |
|
47 | 48 | ed = os.environ['EDITOR'] |
|
48 | 49 | except KeyError: |
|
49 | 50 | if os.name == 'posix': |
|
50 | 51 | ed = 'vi' # the only one guaranteed to be there! |
|
51 | 52 | else: |
|
52 | 53 | ed = 'notepad' # same in Windows! |
|
53 | 54 | return ed |
|
54 | 55 | |
|
55 | 56 | |
|
56 | 57 | def get_pasted_lines(sentinel, l_input=py3compat.input): |
|
57 | 58 | """ Yield pasted lines until the user enters the given sentinel value. |
|
58 | 59 | """ |
|
59 | 60 | print "Pasting code; enter '%s' alone on the line to stop or use Ctrl-D." \ |
|
60 | 61 | % sentinel |
|
61 | 62 | while True: |
|
62 | 63 | try: |
|
63 | 64 | l = l_input(':') |
|
64 | 65 | if l == sentinel: |
|
65 | 66 | return |
|
66 | 67 | else: |
|
67 | 68 | yield l |
|
68 | 69 | except EOFError: |
|
69 | 70 | print '<EOF>' |
|
70 | 71 | return |
|
71 | 72 | |
|
72 | 73 | |
|
73 | 74 | def strip_email_quotes(raw_lines): |
|
74 | 75 | """ Strip email quotation marks at the beginning of each line. |
|
75 | 76 | |
|
76 | 77 | We don't do any more input transofrmations here because the main shell's |
|
77 | 78 | prefiltering handles other cases. |
|
78 | 79 | """ |
|
79 | 80 | lines = [re.sub(r'^\s*(\s?>)+', '', l) for l in raw_lines] |
|
80 | 81 | return '\n'.join(lines) + '\n' |
|
81 | 82 | |
|
82 | 83 | |
|
83 | 84 | # These two functions are needed by the %paste/%cpaste magics. In practice |
|
84 | 85 | # they are basically methods (they take the shell as their first argument), but |
|
85 | 86 | # we leave them as standalone functions because eventually the magics |
|
86 | 87 | # themselves will become separate objects altogether. At that point, the |
|
87 | 88 | # magics will have access to the shell object, and these functions can be made |
|
88 | 89 | # methods of the magic object, but not of the shell. |
|
89 | 90 | |
|
90 | 91 | def store_or_execute(shell, block, name): |
|
91 | 92 | """ Execute a block, or store it in a variable, per the user's request. |
|
92 | 93 | """ |
|
93 | 94 | # Dedent and prefilter so what we store matches what is executed by |
|
94 | 95 | # run_cell. |
|
95 | 96 | b = shell.prefilter(textwrap.dedent(block)) |
|
96 | 97 | |
|
97 | 98 | if name: |
|
98 | 99 | # If storing it for further editing, run the prefilter on it |
|
99 | 100 | shell.user_ns[name] = SList(b.splitlines()) |
|
100 | 101 | print "Block assigned to '%s'" % name |
|
101 | 102 | else: |
|
102 | 103 | shell.user_ns['pasted_block'] = b |
|
103 | 104 | shell.run_cell(b) |
|
104 | 105 | |
|
105 | 106 | |
|
106 | 107 | def rerun_pasted(shell, name='pasted_block'): |
|
107 | 108 | """ Rerun a previously pasted command. |
|
108 | 109 | """ |
|
109 | 110 | b = shell.user_ns.get(name) |
|
110 | 111 | |
|
111 | 112 | # Sanity checks |
|
112 | 113 | if b is None: |
|
113 | 114 | raise UsageError('No previous pasted block available') |
|
114 | 115 | if not isinstance(b, basestring): |
|
115 | 116 | raise UsageError( |
|
116 | 117 | "Variable 'pasted_block' is not a string, can't execute") |
|
117 | 118 | |
|
118 | 119 | print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b)) |
|
119 | 120 | shell.run_cell(b) |
|
120 | 121 | |
|
121 | 122 | |
|
122 | 123 | #----------------------------------------------------------------------------- |
|
123 | 124 | # Main class |
|
124 | 125 | #----------------------------------------------------------------------------- |
|
125 | 126 | |
|
126 | 127 | class TerminalInteractiveShell(InteractiveShell): |
|
127 | 128 | |
|
128 | 129 | autoedit_syntax = CBool(False, config=True, |
|
129 | 130 | help="auto editing of files with syntax errors.") |
|
130 | 131 | banner = Unicode('') |
|
131 | 132 | banner1 = Unicode(default_banner, config=True, |
|
132 | 133 | help="""The part of the banner to be printed before the profile""" |
|
133 | 134 | ) |
|
134 | 135 | banner2 = Unicode('', config=True, |
|
135 | 136 | help="""The part of the banner to be printed after the profile""" |
|
136 | 137 | ) |
|
137 | 138 | confirm_exit = CBool(True, config=True, |
|
138 | 139 | help=""" |
|
139 | 140 | Set to confirm when you try to exit IPython with an EOF (Control-D |
|
140 | 141 | in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit', |
|
141 | 142 | you can force a direct exit without any confirmation.""", |
|
142 | 143 | ) |
|
143 | 144 | # This display_banner only controls whether or not self.show_banner() |
|
144 | 145 | # is called when mainloop/interact are called. The default is False |
|
145 | 146 | # because for the terminal based application, the banner behavior |
|
146 | 147 | # is controlled by Global.display_banner, which IPythonApp looks at |
|
147 | 148 | # to determine if *it* should call show_banner() by hand or not. |
|
148 | 149 | display_banner = CBool(False) # This isn't configurable! |
|
149 | 150 | embedded = CBool(False) |
|
150 | 151 | embedded_active = CBool(False) |
|
151 | 152 | editor = Unicode(get_default_editor(), config=True, |
|
152 | 153 | help="Set the editor used by IPython (default to $EDITOR/vi/notepad)." |
|
153 | 154 | ) |
|
154 | 155 | pager = Unicode('less', config=True, |
|
155 | 156 | help="The shell program to be used for paging.") |
|
156 | 157 | |
|
157 | 158 | screen_length = Integer(0, config=True, |
|
158 | 159 | help= |
|
159 | 160 | """Number of lines of your screen, used to control printing of very |
|
160 | 161 | long strings. Strings longer than this number of lines will be sent |
|
161 | 162 | through a pager instead of directly printed. The default value for |
|
162 | 163 | this is 0, which means IPython will auto-detect your screen size every |
|
163 | 164 | time it needs to print certain potentially long strings (this doesn't |
|
164 | 165 | change the behavior of the 'print' keyword, it's only triggered |
|
165 | 166 | internally). If for some reason this isn't working well (it needs |
|
166 | 167 | curses support), specify it yourself. Otherwise don't change the |
|
167 | 168 | default.""", |
|
168 | 169 | ) |
|
169 | 170 | term_title = CBool(False, config=True, |
|
170 | 171 | help="Enable auto setting the terminal title." |
|
171 | 172 | ) |
|
172 | 173 | |
|
173 | 174 | # In the terminal, GUI control is done via PyOS_InputHook |
|
174 | 175 | from IPython.lib.inputhook import enable_gui |
|
175 | 176 | enable_gui = staticmethod(enable_gui) |
|
176 | 177 | |
|
177 | 178 | def __init__(self, config=None, ipython_dir=None, profile_dir=None, |
|
178 | 179 | user_ns=None, user_module=None, custom_exceptions=((),None), |
|
179 | 180 | usage=None, banner1=None, banner2=None, display_banner=None): |
|
180 | 181 | |
|
181 | 182 | super(TerminalInteractiveShell, self).__init__( |
|
182 | 183 | config=config, profile_dir=profile_dir, user_ns=user_ns, |
|
183 | 184 | user_module=user_module, custom_exceptions=custom_exceptions |
|
184 | 185 | ) |
|
185 | 186 | # use os.system instead of utils.process.system by default, |
|
186 | 187 | # because piped system doesn't make sense in the Terminal: |
|
187 | 188 | self.system = self.system_raw |
|
188 | 189 | |
|
189 | 190 | self.init_term_title() |
|
190 | 191 | self.init_usage(usage) |
|
191 | 192 | self.init_banner(banner1, banner2, display_banner) |
|
192 | 193 | |
|
193 | 194 | #------------------------------------------------------------------------- |
|
194 | 195 | # Things related to the terminal |
|
195 | 196 | #------------------------------------------------------------------------- |
|
196 | 197 | |
|
197 | 198 | @property |
|
198 | 199 | def usable_screen_length(self): |
|
199 | 200 | if self.screen_length == 0: |
|
200 | 201 | return 0 |
|
201 | 202 | else: |
|
202 | 203 | num_lines_bot = self.separate_in.count('\n')+1 |
|
203 | 204 | return self.screen_length - num_lines_bot |
|
204 | 205 | |
|
205 | 206 | def init_term_title(self): |
|
206 | 207 | # Enable or disable the terminal title. |
|
207 | 208 | if self.term_title: |
|
208 | 209 | toggle_set_term_title(True) |
|
209 | 210 | set_term_title('IPython: ' + abbrev_cwd()) |
|
210 | 211 | else: |
|
211 | 212 | toggle_set_term_title(False) |
|
212 | 213 | |
|
213 | 214 | #------------------------------------------------------------------------- |
|
214 | 215 | # Things related to aliases |
|
215 | 216 | #------------------------------------------------------------------------- |
|
216 | 217 | |
|
217 | 218 | def init_alias(self): |
|
218 | 219 | # The parent class defines aliases that can be safely used with any |
|
219 | 220 | # frontend. |
|
220 | 221 | super(TerminalInteractiveShell, self).init_alias() |
|
221 | 222 | |
|
222 | 223 | # Now define aliases that only make sense on the terminal, because they |
|
223 | 224 | # need direct access to the console in a way that we can't emulate in |
|
224 | 225 | # GUI or web frontend |
|
225 | 226 | if os.name == 'posix': |
|
226 | 227 | aliases = [('clear', 'clear'), ('more', 'more'), ('less', 'less'), |
|
227 | 228 | ('man', 'man')] |
|
228 | 229 | elif os.name == 'nt': |
|
229 | 230 | aliases = [('cls', 'cls')] |
|
230 | 231 | |
|
231 | 232 | |
|
232 | 233 | for name, cmd in aliases: |
|
233 | 234 | self.alias_manager.define_alias(name, cmd) |
|
234 | 235 | |
|
235 | 236 | #------------------------------------------------------------------------- |
|
236 | 237 | # Things related to the banner and usage |
|
237 | 238 | #------------------------------------------------------------------------- |
|
238 | 239 | |
|
239 | 240 | def _banner1_changed(self): |
|
240 | 241 | self.compute_banner() |
|
241 | 242 | |
|
242 | 243 | def _banner2_changed(self): |
|
243 | 244 | self.compute_banner() |
|
244 | 245 | |
|
245 | 246 | def _term_title_changed(self, name, new_value): |
|
246 | 247 | self.init_term_title() |
|
247 | 248 | |
|
248 | 249 | def init_banner(self, banner1, banner2, display_banner): |
|
249 | 250 | if banner1 is not None: |
|
250 | 251 | self.banner1 = banner1 |
|
251 | 252 | if banner2 is not None: |
|
252 | 253 | self.banner2 = banner2 |
|
253 | 254 | if display_banner is not None: |
|
254 | 255 | self.display_banner = display_banner |
|
255 | 256 | self.compute_banner() |
|
256 | 257 | |
|
257 | 258 | def show_banner(self, banner=None): |
|
258 | 259 | if banner is None: |
|
259 | 260 | banner = self.banner |
|
260 | 261 | self.write(banner) |
|
261 | 262 | |
|
262 | 263 | def compute_banner(self): |
|
263 | 264 | self.banner = self.banner1 |
|
264 | 265 | if self.profile and self.profile != 'default': |
|
265 | 266 | self.banner += '\nIPython profile: %s\n' % self.profile |
|
266 | 267 | if self.banner2: |
|
267 | 268 | self.banner += '\n' + self.banner2 |
|
268 | 269 | |
|
269 | 270 | def init_usage(self, usage=None): |
|
270 | 271 | if usage is None: |
|
271 | 272 | self.usage = interactive_usage |
|
272 | 273 | else: |
|
273 | 274 | self.usage = usage |
|
274 | 275 | |
|
275 | 276 | #------------------------------------------------------------------------- |
|
276 | 277 | # Mainloop and code execution logic |
|
277 | 278 | #------------------------------------------------------------------------- |
|
278 | 279 | |
|
279 | 280 | def mainloop(self, display_banner=None): |
|
280 | 281 | """Start the mainloop. |
|
281 | 282 | |
|
282 | 283 | If an optional banner argument is given, it will override the |
|
283 | 284 | internally created default banner. |
|
284 | 285 | """ |
|
285 | 286 | |
|
286 | 287 | with nested(self.builtin_trap, self.display_trap): |
|
287 | 288 | |
|
288 | 289 | while 1: |
|
289 | 290 | try: |
|
290 | 291 | self.interact(display_banner=display_banner) |
|
291 | 292 | #self.interact_with_readline() |
|
292 | 293 | # XXX for testing of a readline-decoupled repl loop, call |
|
293 | 294 | # interact_with_readline above |
|
294 | 295 | break |
|
295 | 296 | except KeyboardInterrupt: |
|
296 | 297 | # this should not be necessary, but KeyboardInterrupt |
|
297 | 298 | # handling seems rather unpredictable... |
|
298 | 299 | self.write("\nKeyboardInterrupt in interact()\n") |
|
299 | 300 | |
|
300 | 301 | def _replace_rlhist_multiline(self, source_raw, hlen_before_cell): |
|
301 | 302 | """Store multiple lines as a single entry in history""" |
|
302 | 303 | |
|
303 | 304 | # do nothing without readline or disabled multiline |
|
304 | 305 | if not self.has_readline or not self.multiline_history: |
|
305 | 306 | return hlen_before_cell |
|
306 | 307 | |
|
307 | 308 | # windows rl has no remove_history_item |
|
308 | 309 | if not hasattr(self.readline, "remove_history_item"): |
|
309 | 310 | return hlen_before_cell |
|
310 | 311 | |
|
311 | 312 | # skip empty cells |
|
312 | 313 | if not source_raw.rstrip(): |
|
313 | 314 | return hlen_before_cell |
|
314 | 315 | |
|
315 | 316 | # nothing changed do nothing, e.g. when rl removes consecutive dups |
|
316 | 317 | hlen = self.readline.get_current_history_length() |
|
317 | 318 | if hlen == hlen_before_cell: |
|
318 | 319 | return hlen_before_cell |
|
319 | 320 | |
|
320 | 321 | for i in range(hlen - hlen_before_cell): |
|
321 | 322 | self.readline.remove_history_item(hlen - i - 1) |
|
322 |
stdin_encoding = |
|
|
323 | stdin_encoding = get_stream_enc(sys.stdin, 'utf-8') | |
|
323 | 324 | self.readline.add_history(py3compat.unicode_to_str(source_raw.rstrip(), |
|
324 | 325 | stdin_encoding)) |
|
325 | 326 | return self.readline.get_current_history_length() |
|
326 | 327 | |
|
327 | 328 | def interact(self, display_banner=None): |
|
328 | 329 | """Closely emulate the interactive Python console.""" |
|
329 | 330 | |
|
330 | 331 | # batch run -> do not interact |
|
331 | 332 | if self.exit_now: |
|
332 | 333 | return |
|
333 | 334 | |
|
334 | 335 | if display_banner is None: |
|
335 | 336 | display_banner = self.display_banner |
|
336 | 337 | |
|
337 | 338 | if isinstance(display_banner, basestring): |
|
338 | 339 | self.show_banner(display_banner) |
|
339 | 340 | elif display_banner: |
|
340 | 341 | self.show_banner() |
|
341 | 342 | |
|
342 | 343 | more = False |
|
343 | 344 | |
|
344 | 345 | if self.has_readline: |
|
345 | 346 | self.readline_startup_hook(self.pre_readline) |
|
346 | 347 | hlen_b4_cell = self.readline.get_current_history_length() |
|
347 | 348 | else: |
|
348 | 349 | hlen_b4_cell = 0 |
|
349 | 350 | # exit_now is set by a call to %Exit or %Quit, through the |
|
350 | 351 | # ask_exit callback. |
|
351 | 352 | |
|
352 | 353 | while not self.exit_now: |
|
353 | 354 | self.hooks.pre_prompt_hook() |
|
354 | 355 | if more: |
|
355 | 356 | try: |
|
356 | 357 | prompt = self.prompt_manager.render('in2') |
|
357 | 358 | except: |
|
358 | 359 | self.showtraceback() |
|
359 | 360 | if self.autoindent: |
|
360 | 361 | self.rl_do_indent = True |
|
361 | 362 | |
|
362 | 363 | else: |
|
363 | 364 | try: |
|
364 | 365 | prompt = self.separate_in + self.prompt_manager.render('in') |
|
365 | 366 | except: |
|
366 | 367 | self.showtraceback() |
|
367 | 368 | try: |
|
368 | 369 | line = self.raw_input(prompt) |
|
369 | 370 | if self.exit_now: |
|
370 | 371 | # quick exit on sys.std[in|out] close |
|
371 | 372 | break |
|
372 | 373 | if self.autoindent: |
|
373 | 374 | self.rl_do_indent = False |
|
374 | 375 | |
|
375 | 376 | except KeyboardInterrupt: |
|
376 | 377 | #double-guard against keyboardinterrupts during kbdint handling |
|
377 | 378 | try: |
|
378 | 379 | self.write('\nKeyboardInterrupt\n') |
|
379 | 380 | source_raw = self.input_splitter.source_raw_reset()[1] |
|
380 | 381 | hlen_b4_cell = \ |
|
381 | 382 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) |
|
382 | 383 | more = False |
|
383 | 384 | except KeyboardInterrupt: |
|
384 | 385 | pass |
|
385 | 386 | except EOFError: |
|
386 | 387 | if self.autoindent: |
|
387 | 388 | self.rl_do_indent = False |
|
388 | 389 | if self.has_readline: |
|
389 | 390 | self.readline_startup_hook(None) |
|
390 | 391 | self.write('\n') |
|
391 | 392 | self.exit() |
|
392 | 393 | except bdb.BdbQuit: |
|
393 | 394 | warn('The Python debugger has exited with a BdbQuit exception.\n' |
|
394 | 395 | 'Because of how pdb handles the stack, it is impossible\n' |
|
395 | 396 | 'for IPython to properly format this particular exception.\n' |
|
396 | 397 | 'IPython will resume normal operation.') |
|
397 | 398 | except: |
|
398 | 399 | # exceptions here are VERY RARE, but they can be triggered |
|
399 | 400 | # asynchronously by signal handlers, for example. |
|
400 | 401 | self.showtraceback() |
|
401 | 402 | else: |
|
402 | 403 | self.input_splitter.push(line) |
|
403 | 404 | more = self.input_splitter.push_accepts_more() |
|
404 | 405 | if (self.SyntaxTB.last_syntax_error and |
|
405 | 406 | self.autoedit_syntax): |
|
406 | 407 | self.edit_syntax_error() |
|
407 | 408 | if not more: |
|
408 | 409 | source_raw = self.input_splitter.source_raw_reset()[1] |
|
409 | 410 | self.run_cell(source_raw, store_history=True) |
|
410 | 411 | hlen_b4_cell = \ |
|
411 | 412 | self._replace_rlhist_multiline(source_raw, hlen_b4_cell) |
|
412 | 413 | |
|
413 | 414 | # Turn off the exit flag, so the mainloop can be restarted if desired |
|
414 | 415 | self.exit_now = False |
|
415 | 416 | |
|
416 | 417 | def raw_input(self, prompt=''): |
|
417 | 418 | """Write a prompt and read a line. |
|
418 | 419 | |
|
419 | 420 | The returned line does not include the trailing newline. |
|
420 | 421 | When the user enters the EOF key sequence, EOFError is raised. |
|
421 | 422 | |
|
422 | 423 | Optional inputs: |
|
423 | 424 | |
|
424 | 425 | - prompt(''): a string to be printed to prompt the user. |
|
425 | 426 | |
|
426 | 427 | - continue_prompt(False): whether this line is the first one or a |
|
427 | 428 | continuation in a sequence of inputs. |
|
428 | 429 | """ |
|
429 | 430 | # Code run by the user may have modified the readline completer state. |
|
430 | 431 | # We must ensure that our completer is back in place. |
|
431 | 432 | |
|
432 | 433 | if self.has_readline: |
|
433 | 434 | self.set_readline_completer() |
|
434 | 435 | |
|
435 | 436 | try: |
|
436 | 437 | line = py3compat.str_to_unicode(self.raw_input_original(prompt)) |
|
437 | 438 | except ValueError: |
|
438 | 439 | warn("\n********\nYou or a %run:ed script called sys.stdin.close()" |
|
439 | 440 | " or sys.stdout.close()!\nExiting IPython!") |
|
440 | 441 | self.ask_exit() |
|
441 | 442 | return "" |
|
442 | 443 | |
|
443 | 444 | # Try to be reasonably smart about not re-indenting pasted input more |
|
444 | 445 | # than necessary. We do this by trimming out the auto-indent initial |
|
445 | 446 | # spaces, if the user's actual input started itself with whitespace. |
|
446 | 447 | if self.autoindent: |
|
447 | 448 | if num_ini_spaces(line) > self.indent_current_nsp: |
|
448 | 449 | line = line[self.indent_current_nsp:] |
|
449 | 450 | self.indent_current_nsp = 0 |
|
450 | 451 | |
|
451 | 452 | return line |
|
452 | 453 | |
|
453 | 454 | #------------------------------------------------------------------------- |
|
454 | 455 | # Methods to support auto-editing of SyntaxErrors. |
|
455 | 456 | #------------------------------------------------------------------------- |
|
456 | 457 | |
|
457 | 458 | def edit_syntax_error(self): |
|
458 | 459 | """The bottom half of the syntax error handler called in the main loop. |
|
459 | 460 | |
|
460 | 461 | Loop until syntax error is fixed or user cancels. |
|
461 | 462 | """ |
|
462 | 463 | |
|
463 | 464 | while self.SyntaxTB.last_syntax_error: |
|
464 | 465 | # copy and clear last_syntax_error |
|
465 | 466 | err = self.SyntaxTB.clear_err_state() |
|
466 | 467 | if not self._should_recompile(err): |
|
467 | 468 | return |
|
468 | 469 | try: |
|
469 | 470 | # may set last_syntax_error again if a SyntaxError is raised |
|
470 | 471 | self.safe_execfile(err.filename,self.user_ns) |
|
471 | 472 | except: |
|
472 | 473 | self.showtraceback() |
|
473 | 474 | else: |
|
474 | 475 | try: |
|
475 | 476 | f = open(err.filename) |
|
476 | 477 | try: |
|
477 | 478 | # This should be inside a display_trap block and I |
|
478 | 479 | # think it is. |
|
479 | 480 | sys.displayhook(f.read()) |
|
480 | 481 | finally: |
|
481 | 482 | f.close() |
|
482 | 483 | except: |
|
483 | 484 | self.showtraceback() |
|
484 | 485 | |
|
485 | 486 | def _should_recompile(self,e): |
|
486 | 487 | """Utility routine for edit_syntax_error""" |
|
487 | 488 | |
|
488 | 489 | if e.filename in ('<ipython console>','<input>','<string>', |
|
489 | 490 | '<console>','<BackgroundJob compilation>', |
|
490 | 491 | None): |
|
491 | 492 | |
|
492 | 493 | return False |
|
493 | 494 | try: |
|
494 | 495 | if (self.autoedit_syntax and |
|
495 | 496 | not self.ask_yes_no('Return to editor to correct syntax error? ' |
|
496 | 497 | '[Y/n] ','y')): |
|
497 | 498 | return False |
|
498 | 499 | except EOFError: |
|
499 | 500 | return False |
|
500 | 501 | |
|
501 | 502 | def int0(x): |
|
502 | 503 | try: |
|
503 | 504 | return int(x) |
|
504 | 505 | except TypeError: |
|
505 | 506 | return 0 |
|
506 | 507 | # always pass integer line and offset values to editor hook |
|
507 | 508 | try: |
|
508 | 509 | self.hooks.fix_error_editor(e.filename, |
|
509 | 510 | int0(e.lineno),int0(e.offset),e.msg) |
|
510 | 511 | except TryNext: |
|
511 | 512 | warn('Could not open editor') |
|
512 | 513 | return False |
|
513 | 514 | return True |
|
514 | 515 | |
|
515 | 516 | #------------------------------------------------------------------------- |
|
516 | 517 | # Things related to exiting |
|
517 | 518 | #------------------------------------------------------------------------- |
|
518 | 519 | |
|
519 | 520 | def ask_exit(self): |
|
520 | 521 | """ Ask the shell to exit. Can be overiden and used as a callback. """ |
|
521 | 522 | self.exit_now = True |
|
522 | 523 | |
|
523 | 524 | def exit(self): |
|
524 | 525 | """Handle interactive exit. |
|
525 | 526 | |
|
526 | 527 | This method calls the ask_exit callback.""" |
|
527 | 528 | if self.confirm_exit: |
|
528 | 529 | if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'): |
|
529 | 530 | self.ask_exit() |
|
530 | 531 | else: |
|
531 | 532 | self.ask_exit() |
|
532 | 533 | |
|
533 | 534 | #------------------------------------------------------------------------ |
|
534 | 535 | # Magic overrides |
|
535 | 536 | #------------------------------------------------------------------------ |
|
536 | 537 | # Once the base class stops inheriting from magic, this code needs to be |
|
537 | 538 | # moved into a separate machinery as well. For now, at least isolate here |
|
538 | 539 | # the magics which this class needs to implement differently from the base |
|
539 | 540 | # class, or that are unique to it. |
|
540 | 541 | |
|
541 | 542 | def magic_autoindent(self, parameter_s = ''): |
|
542 | 543 | """Toggle autoindent on/off (if available).""" |
|
543 | 544 | |
|
544 | 545 | self.shell.set_autoindent() |
|
545 | 546 | print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent] |
|
546 | 547 | |
|
547 | 548 | @skip_doctest |
|
548 | 549 | def magic_cpaste(self, parameter_s=''): |
|
549 | 550 | """Paste & execute a pre-formatted code block from clipboard. |
|
550 | 551 | |
|
551 | 552 | You must terminate the block with '--' (two minus-signs) or Ctrl-D |
|
552 | 553 | alone on the line. You can also provide your own sentinel with '%paste |
|
553 | 554 | -s %%' ('%%' is the new sentinel for this operation) |
|
554 | 555 | |
|
555 | 556 | The block is dedented prior to execution to enable execution of method |
|
556 | 557 | definitions. '>' and '+' characters at the beginning of a line are |
|
557 | 558 | ignored, to allow pasting directly from e-mails, diff files and |
|
558 | 559 | doctests (the '...' continuation prompt is also stripped). The |
|
559 | 560 | executed block is also assigned to variable named 'pasted_block' for |
|
560 | 561 | later editing with '%edit pasted_block'. |
|
561 | 562 | |
|
562 | 563 | You can also pass a variable name as an argument, e.g. '%cpaste foo'. |
|
563 | 564 | This assigns the pasted block to variable 'foo' as string, without |
|
564 | 565 | dedenting or executing it (preceding >>> and + is still stripped) |
|
565 | 566 | |
|
566 | 567 | '%cpaste -r' re-executes the block previously entered by cpaste. |
|
567 | 568 | |
|
568 | 569 | Do not be alarmed by garbled output on Windows (it's a readline bug). |
|
569 | 570 | Just press enter and type -- (and press enter again) and the block |
|
570 | 571 | will be what was just pasted. |
|
571 | 572 | |
|
572 | 573 | IPython statements (magics, shell escapes) are not supported (yet). |
|
573 | 574 | |
|
574 | 575 | See also |
|
575 | 576 | -------- |
|
576 | 577 | paste: automatically pull code from clipboard. |
|
577 | 578 | |
|
578 | 579 | Examples |
|
579 | 580 | -------- |
|
580 | 581 | :: |
|
581 | 582 | |
|
582 | 583 | In [8]: %cpaste |
|
583 | 584 | Pasting code; enter '--' alone on the line to stop. |
|
584 | 585 | :>>> a = ["world!", "Hello"] |
|
585 | 586 | :>>> print " ".join(sorted(a)) |
|
586 | 587 | :-- |
|
587 | 588 | Hello world! |
|
588 | 589 | """ |
|
589 | 590 | |
|
590 | 591 | opts, name = self.parse_options(parameter_s, 'rs:', mode='string') |
|
591 | 592 | if 'r' in opts: |
|
592 | 593 | rerun_pasted(self.shell) |
|
593 | 594 | return |
|
594 | 595 | |
|
595 | 596 | sentinel = opts.get('s', '--') |
|
596 | 597 | block = strip_email_quotes(get_pasted_lines(sentinel)) |
|
597 | 598 | store_or_execute(self.shell, block, name) |
|
598 | 599 | |
|
599 | 600 | def magic_paste(self, parameter_s=''): |
|
600 | 601 | """Paste & execute a pre-formatted code block from clipboard. |
|
601 | 602 | |
|
602 | 603 | The text is pulled directly from the clipboard without user |
|
603 | 604 | intervention and printed back on the screen before execution (unless |
|
604 | 605 | the -q flag is given to force quiet mode). |
|
605 | 606 | |
|
606 | 607 | The block is dedented prior to execution to enable execution of method |
|
607 | 608 | definitions. '>' and '+' characters at the beginning of a line are |
|
608 | 609 | ignored, to allow pasting directly from e-mails, diff files and |
|
609 | 610 | doctests (the '...' continuation prompt is also stripped). The |
|
610 | 611 | executed block is also assigned to variable named 'pasted_block' for |
|
611 | 612 | later editing with '%edit pasted_block'. |
|
612 | 613 | |
|
613 | 614 | You can also pass a variable name as an argument, e.g. '%paste foo'. |
|
614 | 615 | This assigns the pasted block to variable 'foo' as string, without |
|
615 | 616 | dedenting or executing it (preceding >>> and + is still stripped) |
|
616 | 617 | |
|
617 | 618 | Options |
|
618 | 619 | ------- |
|
619 | 620 | |
|
620 | 621 | -r: re-executes the block previously entered by cpaste. |
|
621 | 622 | |
|
622 | 623 | -q: quiet mode: do not echo the pasted text back to the terminal. |
|
623 | 624 | |
|
624 | 625 | IPython statements (magics, shell escapes) are not supported (yet). |
|
625 | 626 | |
|
626 | 627 | See also |
|
627 | 628 | -------- |
|
628 | 629 | cpaste: manually paste code into terminal until you mark its end. |
|
629 | 630 | """ |
|
630 | 631 | opts, name = self.parse_options(parameter_s, 'rq', mode='string') |
|
631 | 632 | if 'r' in opts: |
|
632 | 633 | rerun_pasted(self.shell) |
|
633 | 634 | return |
|
634 | 635 | try: |
|
635 | 636 | text = self.shell.hooks.clipboard_get() |
|
636 | 637 | block = strip_email_quotes(text.splitlines()) |
|
637 | 638 | except TryNext as clipboard_exc: |
|
638 | 639 | message = getattr(clipboard_exc, 'args') |
|
639 | 640 | if message: |
|
640 | 641 | error(message[0]) |
|
641 | 642 | else: |
|
642 | 643 | error('Could not get text from the clipboard.') |
|
643 | 644 | return |
|
644 | 645 | |
|
645 | 646 | # By default, echo back to terminal unless quiet mode is requested |
|
646 | 647 | if 'q' not in opts: |
|
647 | 648 | write = self.shell.write |
|
648 | 649 | write(self.shell.pycolorize(block)) |
|
649 | 650 | if not block.endswith('\n'): |
|
650 | 651 | write('\n') |
|
651 | 652 | write("## -- End pasted text --\n") |
|
652 | 653 | |
|
653 | 654 | store_or_execute(self.shell, block, name) |
|
654 | 655 | |
|
655 | 656 | # Class-level: add a '%cls' magic only on Windows |
|
656 | 657 | if sys.platform == 'win32': |
|
657 | 658 | def magic_cls(self, s): |
|
658 | 659 | """Clear screen. |
|
659 | 660 | """ |
|
660 | 661 | os.system("cls") |
|
661 | 662 | |
|
662 | 663 | def showindentationerror(self): |
|
663 | 664 | super(TerminalInteractiveShell, self).showindentationerror() |
|
664 | 665 | print("If you want to paste code into IPython, try the " |
|
665 | 666 | "%paste and %cpaste magic functions.") |
|
666 | 667 | |
|
667 | 668 | |
|
668 | 669 | InteractiveShellABC.register(TerminalInteractiveShell) |
@@ -1,391 +1,392 b'' | |||
|
1 | 1 | """Generic testing tools. |
|
2 | 2 | |
|
3 | 3 | In particular, this module exposes a set of top-level assert* functions that |
|
4 | 4 | can be used in place of nose.tools.assert* in method generators (the ones in |
|
5 | 5 | nose can not, at least as of nose 0.10.4). |
|
6 | 6 | |
|
7 | 7 | |
|
8 | 8 | Authors |
|
9 | 9 | ------- |
|
10 | 10 | - Fernando Perez <Fernando.Perez@berkeley.edu> |
|
11 | 11 | """ |
|
12 | 12 | |
|
13 | 13 | from __future__ import absolute_import |
|
14 | 14 | |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | # Copyright (C) 2009-2011 The IPython Development Team |
|
17 | 17 | # |
|
18 | 18 | # Distributed under the terms of the BSD License. The full license is in |
|
19 | 19 | # the file COPYING, distributed as part of this software. |
|
20 | 20 | #----------------------------------------------------------------------------- |
|
21 | 21 | |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | # Imports |
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | |
|
26 | 26 | import os |
|
27 | 27 | import re |
|
28 | 28 | import sys |
|
29 | 29 | import tempfile |
|
30 | 30 | |
|
31 | 31 | from contextlib import contextmanager |
|
32 | 32 | from io import StringIO |
|
33 | 33 | |
|
34 | 34 | try: |
|
35 | 35 | # These tools are used by parts of the runtime, so we make the nose |
|
36 | 36 | # dependency optional at this point. Nose is a hard dependency to run the |
|
37 | 37 | # test suite, but NOT to use ipython itself. |
|
38 | 38 | import nose.tools as nt |
|
39 | 39 | has_nose = True |
|
40 | 40 | except ImportError: |
|
41 | 41 | has_nose = False |
|
42 | 42 | |
|
43 | 43 | from IPython.config.loader import Config |
|
44 | 44 | from IPython.utils.process import find_cmd, getoutputerror |
|
45 | 45 | from IPython.utils.text import list_strings |
|
46 | 46 | from IPython.utils.io import temp_pyfile, Tee |
|
47 | 47 | from IPython.utils import py3compat |
|
48 | from IPython.utils.encoding import getdefaultencoding | |
|
48 | 49 | |
|
49 | 50 | from . import decorators as dec |
|
50 | 51 | from . import skipdoctest |
|
51 | 52 | |
|
52 | 53 | #----------------------------------------------------------------------------- |
|
53 | 54 | # Globals |
|
54 | 55 | #----------------------------------------------------------------------------- |
|
55 | 56 | |
|
56 | 57 | # Make a bunch of nose.tools assert wrappers that can be used in test |
|
57 | 58 | # generators. This will expose an assert* function for each one in nose.tools. |
|
58 | 59 | |
|
59 | 60 | _tpl = """ |
|
60 | 61 | def %(name)s(*a,**kw): |
|
61 | 62 | return nt.%(name)s(*a,**kw) |
|
62 | 63 | """ |
|
63 | 64 | |
|
64 | 65 | if has_nose: |
|
65 | 66 | for _x in [a for a in dir(nt) if a.startswith('assert')]: |
|
66 | 67 | exec _tpl % dict(name=_x) |
|
67 | 68 | |
|
68 | 69 | #----------------------------------------------------------------------------- |
|
69 | 70 | # Functions and classes |
|
70 | 71 | #----------------------------------------------------------------------------- |
|
71 | 72 | |
|
72 | 73 | # The docstring for full_path doctests differently on win32 (different path |
|
73 | 74 | # separator) so just skip the doctest there. The example remains informative. |
|
74 | 75 | doctest_deco = skipdoctest.skip_doctest if sys.platform == 'win32' else dec.null_deco |
|
75 | 76 | |
|
76 | 77 | @doctest_deco |
|
77 | 78 | def full_path(startPath,files): |
|
78 | 79 | """Make full paths for all the listed files, based on startPath. |
|
79 | 80 | |
|
80 | 81 | Only the base part of startPath is kept, since this routine is typically |
|
81 | 82 | used with a script's __file__ variable as startPath. The base of startPath |
|
82 | 83 | is then prepended to all the listed files, forming the output list. |
|
83 | 84 | |
|
84 | 85 | Parameters |
|
85 | 86 | ---------- |
|
86 | 87 | startPath : string |
|
87 | 88 | Initial path to use as the base for the results. This path is split |
|
88 | 89 | using os.path.split() and only its first component is kept. |
|
89 | 90 | |
|
90 | 91 | files : string or list |
|
91 | 92 | One or more files. |
|
92 | 93 | |
|
93 | 94 | Examples |
|
94 | 95 | -------- |
|
95 | 96 | |
|
96 | 97 | >>> full_path('/foo/bar.py',['a.txt','b.txt']) |
|
97 | 98 | ['/foo/a.txt', '/foo/b.txt'] |
|
98 | 99 | |
|
99 | 100 | >>> full_path('/foo',['a.txt','b.txt']) |
|
100 | 101 | ['/a.txt', '/b.txt'] |
|
101 | 102 | |
|
102 | 103 | If a single file is given, the output is still a list: |
|
103 | 104 | >>> full_path('/foo','a.txt') |
|
104 | 105 | ['/a.txt'] |
|
105 | 106 | """ |
|
106 | 107 | |
|
107 | 108 | files = list_strings(files) |
|
108 | 109 | base = os.path.split(startPath)[0] |
|
109 | 110 | return [ os.path.join(base,f) for f in files ] |
|
110 | 111 | |
|
111 | 112 | |
|
112 | 113 | def parse_test_output(txt): |
|
113 | 114 | """Parse the output of a test run and return errors, failures. |
|
114 | 115 | |
|
115 | 116 | Parameters |
|
116 | 117 | ---------- |
|
117 | 118 | txt : str |
|
118 | 119 | Text output of a test run, assumed to contain a line of one of the |
|
119 | 120 | following forms:: |
|
120 | 121 | 'FAILED (errors=1)' |
|
121 | 122 | 'FAILED (failures=1)' |
|
122 | 123 | 'FAILED (errors=1, failures=1)' |
|
123 | 124 | |
|
124 | 125 | Returns |
|
125 | 126 | ------- |
|
126 | 127 | nerr, nfail: number of errors and failures. |
|
127 | 128 | """ |
|
128 | 129 | |
|
129 | 130 | err_m = re.search(r'^FAILED \(errors=(\d+)\)', txt, re.MULTILINE) |
|
130 | 131 | if err_m: |
|
131 | 132 | nerr = int(err_m.group(1)) |
|
132 | 133 | nfail = 0 |
|
133 | 134 | return nerr, nfail |
|
134 | 135 | |
|
135 | 136 | fail_m = re.search(r'^FAILED \(failures=(\d+)\)', txt, re.MULTILINE) |
|
136 | 137 | if fail_m: |
|
137 | 138 | nerr = 0 |
|
138 | 139 | nfail = int(fail_m.group(1)) |
|
139 | 140 | return nerr, nfail |
|
140 | 141 | |
|
141 | 142 | both_m = re.search(r'^FAILED \(errors=(\d+), failures=(\d+)\)', txt, |
|
142 | 143 | re.MULTILINE) |
|
143 | 144 | if both_m: |
|
144 | 145 | nerr = int(both_m.group(1)) |
|
145 | 146 | nfail = int(both_m.group(2)) |
|
146 | 147 | return nerr, nfail |
|
147 | 148 | |
|
148 | 149 | # If the input didn't match any of these forms, assume no error/failures |
|
149 | 150 | return 0, 0 |
|
150 | 151 | |
|
151 | 152 | |
|
152 | 153 | # So nose doesn't think this is a test |
|
153 | 154 | parse_test_output.__test__ = False |
|
154 | 155 | |
|
155 | 156 | |
|
156 | 157 | def default_argv(): |
|
157 | 158 | """Return a valid default argv for creating testing instances of ipython""" |
|
158 | 159 | |
|
159 | 160 | return ['--quick', # so no config file is loaded |
|
160 | 161 | # Other defaults to minimize side effects on stdout |
|
161 | 162 | '--colors=NoColor', '--no-term-title','--no-banner', |
|
162 | 163 | '--autocall=0'] |
|
163 | 164 | |
|
164 | 165 | |
|
165 | 166 | def default_config(): |
|
166 | 167 | """Return a config object with good defaults for testing.""" |
|
167 | 168 | config = Config() |
|
168 | 169 | config.TerminalInteractiveShell.colors = 'NoColor' |
|
169 | 170 | config.TerminalTerminalInteractiveShell.term_title = False, |
|
170 | 171 | config.TerminalInteractiveShell.autocall = 0 |
|
171 | 172 | config.HistoryManager.hist_file = tempfile.mktemp(u'test_hist.sqlite') |
|
172 | 173 | config.HistoryManager.db_cache_size = 10000 |
|
173 | 174 | return config |
|
174 | 175 | |
|
175 | 176 | |
|
176 | 177 | def ipexec(fname, options=None): |
|
177 | 178 | """Utility to call 'ipython filename'. |
|
178 | 179 | |
|
179 | 180 | Starts IPython witha minimal and safe configuration to make startup as fast |
|
180 | 181 | as possible. |
|
181 | 182 | |
|
182 | 183 | Note that this starts IPython in a subprocess! |
|
183 | 184 | |
|
184 | 185 | Parameters |
|
185 | 186 | ---------- |
|
186 | 187 | fname : str |
|
187 | 188 | Name of file to be executed (should have .py or .ipy extension). |
|
188 | 189 | |
|
189 | 190 | options : optional, list |
|
190 | 191 | Extra command-line flags to be passed to IPython. |
|
191 | 192 | |
|
192 | 193 | Returns |
|
193 | 194 | ------- |
|
194 | 195 | (stdout, stderr) of ipython subprocess. |
|
195 | 196 | """ |
|
196 | 197 | if options is None: options = [] |
|
197 | 198 | |
|
198 | 199 | # For these subprocess calls, eliminate all prompt printing so we only see |
|
199 | 200 | # output from script execution |
|
200 | 201 | prompt_opts = [ '--PromptManager.in_template=""', |
|
201 | 202 | '--PromptManager.in2_template=""', |
|
202 | 203 | '--PromptManager.out_template=""' |
|
203 | 204 | ] |
|
204 | 205 | cmdargs = ' '.join(default_argv() + prompt_opts + options) |
|
205 | 206 | |
|
206 | 207 | _ip = get_ipython() |
|
207 | 208 | test_dir = os.path.dirname(__file__) |
|
208 | 209 | |
|
209 | 210 | ipython_cmd = find_cmd('ipython3' if py3compat.PY3 else 'ipython') |
|
210 | 211 | # Absolute path for filename |
|
211 | 212 | full_fname = os.path.join(test_dir, fname) |
|
212 | 213 | full_cmd = '%s %s %s' % (ipython_cmd, cmdargs, full_fname) |
|
213 | 214 | #print >> sys.stderr, 'FULL CMD:', full_cmd # dbg |
|
214 | 215 | out, err = getoutputerror(full_cmd) |
|
215 | 216 | # `import readline` causes 'ESC[?1034h' to be output sometimes, |
|
216 | 217 | # so strip that out before doing comparisons |
|
217 | 218 | if out: |
|
218 | 219 | out = re.sub(r'\x1b\[[^h]+h', '', out) |
|
219 | 220 | return out, err |
|
220 | 221 | |
|
221 | 222 | |
|
222 | 223 | def ipexec_validate(fname, expected_out, expected_err='', |
|
223 | 224 | options=None): |
|
224 | 225 | """Utility to call 'ipython filename' and validate output/error. |
|
225 | 226 | |
|
226 | 227 | This function raises an AssertionError if the validation fails. |
|
227 | 228 | |
|
228 | 229 | Note that this starts IPython in a subprocess! |
|
229 | 230 | |
|
230 | 231 | Parameters |
|
231 | 232 | ---------- |
|
232 | 233 | fname : str |
|
233 | 234 | Name of the file to be executed (should have .py or .ipy extension). |
|
234 | 235 | |
|
235 | 236 | expected_out : str |
|
236 | 237 | Expected stdout of the process. |
|
237 | 238 | |
|
238 | 239 | expected_err : optional, str |
|
239 | 240 | Expected stderr of the process. |
|
240 | 241 | |
|
241 | 242 | options : optional, list |
|
242 | 243 | Extra command-line flags to be passed to IPython. |
|
243 | 244 | |
|
244 | 245 | Returns |
|
245 | 246 | ------- |
|
246 | 247 | None |
|
247 | 248 | """ |
|
248 | 249 | |
|
249 | 250 | import nose.tools as nt |
|
250 | 251 | |
|
251 | 252 | out, err = ipexec(fname, options) |
|
252 | 253 | #print 'OUT', out # dbg |
|
253 | 254 | #print 'ERR', err # dbg |
|
254 | 255 | # If there are any errors, we must check those befor stdout, as they may be |
|
255 | 256 | # more informative than simply having an empty stdout. |
|
256 | 257 | if err: |
|
257 | 258 | if expected_err: |
|
258 | 259 | nt.assert_equals(err.strip(), expected_err.strip()) |
|
259 | 260 | else: |
|
260 | 261 | raise ValueError('Running file %r produced error: %r' % |
|
261 | 262 | (fname, err)) |
|
262 | 263 | # If no errors or output on stderr was expected, match stdout |
|
263 | 264 | nt.assert_equals(out.strip(), expected_out.strip()) |
|
264 | 265 | |
|
265 | 266 | |
|
266 | 267 | class TempFileMixin(object): |
|
267 | 268 | """Utility class to create temporary Python/IPython files. |
|
268 | 269 | |
|
269 | 270 | Meant as a mixin class for test cases.""" |
|
270 | 271 | |
|
271 | 272 | def mktmp(self, src, ext='.py'): |
|
272 | 273 | """Make a valid python temp file.""" |
|
273 | 274 | fname, f = temp_pyfile(src, ext) |
|
274 | 275 | self.tmpfile = f |
|
275 | 276 | self.fname = fname |
|
276 | 277 | |
|
277 | 278 | def tearDown(self): |
|
278 | 279 | if hasattr(self, 'tmpfile'): |
|
279 | 280 | # If the tmpfile wasn't made because of skipped tests, like in |
|
280 | 281 | # win32, there's nothing to cleanup. |
|
281 | 282 | self.tmpfile.close() |
|
282 | 283 | try: |
|
283 | 284 | os.unlink(self.fname) |
|
284 | 285 | except: |
|
285 | 286 | # On Windows, even though we close the file, we still can't |
|
286 | 287 | # delete it. I have no clue why |
|
287 | 288 | pass |
|
288 | 289 | |
|
289 | 290 | pair_fail_msg = ("Testing {0}\n\n" |
|
290 | 291 | "In:\n" |
|
291 | 292 | " {1!r}\n" |
|
292 | 293 | "Expected:\n" |
|
293 | 294 | " {2!r}\n" |
|
294 | 295 | "Got:\n" |
|
295 | 296 | " {3!r}\n") |
|
296 | 297 | def check_pairs(func, pairs): |
|
297 | 298 | """Utility function for the common case of checking a function with a |
|
298 | 299 | sequence of input/output pairs. |
|
299 | 300 | |
|
300 | 301 | Parameters |
|
301 | 302 | ---------- |
|
302 | 303 | func : callable |
|
303 | 304 | The function to be tested. Should accept a single argument. |
|
304 | 305 | pairs : iterable |
|
305 | 306 | A list of (input, expected_output) tuples. |
|
306 | 307 | |
|
307 | 308 | Returns |
|
308 | 309 | ------- |
|
309 | 310 | None. Raises an AssertionError if any output does not match the expected |
|
310 | 311 | value. |
|
311 | 312 | """ |
|
312 | 313 | name = getattr(func, "func_name", getattr(func, "__name__", "<unknown>")) |
|
313 | 314 | for inp, expected in pairs: |
|
314 | 315 | out = func(inp) |
|
315 | 316 | assert out == expected, pair_fail_msg.format(name, inp, expected, out) |
|
316 | 317 | |
|
317 | 318 | |
|
318 | 319 | if py3compat.PY3: |
|
319 | 320 | MyStringIO = StringIO |
|
320 | 321 | else: |
|
321 | 322 | # In Python 2, stdout/stderr can have either bytes or unicode written to them, |
|
322 | 323 | # so we need a class that can handle both. |
|
323 | 324 | class MyStringIO(StringIO): |
|
324 | 325 | def write(self, s): |
|
325 |
s = py3compat.cast_unicode(s, encoding= |
|
|
326 | s = py3compat.cast_unicode(s, encoding=getdefaultencoding()) | |
|
326 | 327 | super(MyStringIO, self).write(s) |
|
327 | 328 | |
|
328 | 329 | notprinted_msg = """Did not find {0!r} in printed output (on {1}): |
|
329 | 330 | {2!r}""" |
|
330 | 331 | |
|
331 | 332 | class AssertPrints(object): |
|
332 | 333 | """Context manager for testing that code prints certain text. |
|
333 | 334 | |
|
334 | 335 | Examples |
|
335 | 336 | -------- |
|
336 | 337 | >>> with AssertPrints("abc", suppress=False): |
|
337 | 338 | ... print "abcd" |
|
338 | 339 | ... print "def" |
|
339 | 340 | ... |
|
340 | 341 | abcd |
|
341 | 342 | def |
|
342 | 343 | """ |
|
343 | 344 | def __init__(self, s, channel='stdout', suppress=True): |
|
344 | 345 | self.s = s |
|
345 | 346 | self.channel = channel |
|
346 | 347 | self.suppress = suppress |
|
347 | 348 | |
|
348 | 349 | def __enter__(self): |
|
349 | 350 | self.orig_stream = getattr(sys, self.channel) |
|
350 | 351 | self.buffer = MyStringIO() |
|
351 | 352 | self.tee = Tee(self.buffer, channel=self.channel) |
|
352 | 353 | setattr(sys, self.channel, self.buffer if self.suppress else self.tee) |
|
353 | 354 | |
|
354 | 355 | def __exit__(self, etype, value, traceback): |
|
355 | 356 | self.tee.flush() |
|
356 | 357 | setattr(sys, self.channel, self.orig_stream) |
|
357 | 358 | printed = self.buffer.getvalue() |
|
358 | 359 | assert self.s in printed, notprinted_msg.format(self.s, self.channel, printed) |
|
359 | 360 | return False |
|
360 | 361 | |
|
361 | 362 | class AssertNotPrints(AssertPrints): |
|
362 | 363 | """Context manager for checking that certain output *isn't* produced. |
|
363 | 364 | |
|
364 | 365 | Counterpart of AssertPrints""" |
|
365 | 366 | def __exit__(self, etype, value, traceback): |
|
366 | 367 | self.tee.flush() |
|
367 | 368 | setattr(sys, self.channel, self.orig_stream) |
|
368 | 369 | printed = self.buffer.getvalue() |
|
369 | 370 | assert self.s not in printed, notprinted_msg.format(self.s, self.channel, printed) |
|
370 | 371 | return False |
|
371 | 372 | |
|
372 | 373 | @contextmanager |
|
373 | 374 | def mute_warn(): |
|
374 | 375 | from IPython.utils import warn |
|
375 | 376 | save_warn = warn.warn |
|
376 | 377 | warn.warn = lambda *a, **kw: None |
|
377 | 378 | try: |
|
378 | 379 | yield |
|
379 | 380 | finally: |
|
380 | 381 | warn.warn = save_warn |
|
381 | 382 | |
|
382 | 383 | @contextmanager |
|
383 | 384 | def make_tempfile(name): |
|
384 | 385 | """ Create an empty, named, temporary file for the duration of the context. |
|
385 | 386 | """ |
|
386 | 387 | f = open(name, 'w') |
|
387 | 388 | f.close() |
|
388 | 389 | try: |
|
389 | 390 | yield |
|
390 | 391 | finally: |
|
391 | 392 | os.unlink(name) |
@@ -1,197 +1,198 b'' | |||
|
1 | 1 | """Posix-specific implementation of process utilities. |
|
2 | 2 | |
|
3 | 3 | This file is only meant to be imported by process.py, not by end-users. |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | 6 | #----------------------------------------------------------------------------- |
|
7 | 7 | # Copyright (C) 2010-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Imports |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | from __future__ import print_function |
|
17 | 17 | |
|
18 | 18 | # Stdlib |
|
19 | 19 | import subprocess as sp |
|
20 | 20 | import sys |
|
21 | 21 | |
|
22 | 22 | from IPython.external import pexpect |
|
23 | 23 | |
|
24 | 24 | # Our own |
|
25 | 25 | from .autoattr import auto_attr |
|
26 | 26 | from ._process_common import getoutput, arg_split |
|
27 | 27 | from IPython.utils import text |
|
28 | 28 | from IPython.utils import py3compat |
|
29 | from IPython.utils.encoding import getdefaultencoding | |
|
29 | 30 | |
|
30 | 31 | #----------------------------------------------------------------------------- |
|
31 | 32 | # Function definitions |
|
32 | 33 | #----------------------------------------------------------------------------- |
|
33 | 34 | |
|
34 | 35 | def _find_cmd(cmd): |
|
35 | 36 | """Find the full path to a command using which.""" |
|
36 | 37 | |
|
37 | 38 | path = sp.Popen(['/usr/bin/env', 'which', cmd], |
|
38 | 39 | stdout=sp.PIPE).communicate()[0] |
|
39 | 40 | return py3compat.bytes_to_str(path) |
|
40 | 41 | |
|
41 | 42 | |
|
42 | 43 | class ProcessHandler(object): |
|
43 | 44 | """Execute subprocesses under the control of pexpect. |
|
44 | 45 | """ |
|
45 | 46 | # Timeout in seconds to wait on each reading of the subprocess' output. |
|
46 | 47 | # This should not be set too low to avoid cpu overusage from our side, |
|
47 | 48 | # since we read in a loop whose period is controlled by this timeout. |
|
48 | 49 | read_timeout = 0.05 |
|
49 | 50 | |
|
50 | 51 | # Timeout to give a process if we receive SIGINT, between sending the |
|
51 | 52 | # SIGINT to the process and forcefully terminating it. |
|
52 | 53 | terminate_timeout = 0.2 |
|
53 | 54 | |
|
54 | 55 | # File object where stdout and stderr of the subprocess will be written |
|
55 | 56 | logfile = None |
|
56 | 57 | |
|
57 | 58 | # Shell to call for subprocesses to execute |
|
58 | 59 | sh = None |
|
59 | 60 | |
|
60 | 61 | @auto_attr |
|
61 | 62 | def sh(self): |
|
62 | 63 | sh = pexpect.which('sh') |
|
63 | 64 | if sh is None: |
|
64 | 65 | raise OSError('"sh" shell not found') |
|
65 | 66 | return sh |
|
66 | 67 | |
|
67 | 68 | def __init__(self, logfile=None, read_timeout=None, terminate_timeout=None): |
|
68 | 69 | """Arguments are used for pexpect calls.""" |
|
69 | 70 | self.read_timeout = (ProcessHandler.read_timeout if read_timeout is |
|
70 | 71 | None else read_timeout) |
|
71 | 72 | self.terminate_timeout = (ProcessHandler.terminate_timeout if |
|
72 | 73 | terminate_timeout is None else |
|
73 | 74 | terminate_timeout) |
|
74 | 75 | self.logfile = sys.stdout if logfile is None else logfile |
|
75 | 76 | |
|
76 | 77 | def getoutput(self, cmd): |
|
77 | 78 | """Run a command and return its stdout/stderr as a string. |
|
78 | 79 | |
|
79 | 80 | Parameters |
|
80 | 81 | ---------- |
|
81 | 82 | cmd : str |
|
82 | 83 | A command to be executed in the system shell. |
|
83 | 84 | |
|
84 | 85 | Returns |
|
85 | 86 | ------- |
|
86 | 87 | output : str |
|
87 | 88 | A string containing the combination of stdout and stderr from the |
|
88 | 89 | subprocess, in whatever order the subprocess originally wrote to its |
|
89 | 90 | file descriptors (so the order of the information in this string is the |
|
90 | 91 | correct order as would be seen if running the command in a terminal). |
|
91 | 92 | """ |
|
92 | 93 | try: |
|
93 | 94 | return pexpect.run(self.sh, args=['-c', cmd]).replace('\r\n', '\n') |
|
94 | 95 | except KeyboardInterrupt: |
|
95 | 96 | print('^C', file=sys.stderr, end='') |
|
96 | 97 | |
|
97 | 98 | def getoutput_pexpect(self, cmd): |
|
98 | 99 | """Run a command and return its stdout/stderr as a string. |
|
99 | 100 | |
|
100 | 101 | Parameters |
|
101 | 102 | ---------- |
|
102 | 103 | cmd : str |
|
103 | 104 | A command to be executed in the system shell. |
|
104 | 105 | |
|
105 | 106 | Returns |
|
106 | 107 | ------- |
|
107 | 108 | output : str |
|
108 | 109 | A string containing the combination of stdout and stderr from the |
|
109 | 110 | subprocess, in whatever order the subprocess originally wrote to its |
|
110 | 111 | file descriptors (so the order of the information in this string is the |
|
111 | 112 | correct order as would be seen if running the command in a terminal). |
|
112 | 113 | """ |
|
113 | 114 | try: |
|
114 | 115 | return pexpect.run(self.sh, args=['-c', cmd]).replace('\r\n', '\n') |
|
115 | 116 | except KeyboardInterrupt: |
|
116 | 117 | print('^C', file=sys.stderr, end='') |
|
117 | 118 | |
|
118 | 119 | def system(self, cmd): |
|
119 | 120 | """Execute a command in a subshell. |
|
120 | 121 | |
|
121 | 122 | Parameters |
|
122 | 123 | ---------- |
|
123 | 124 | cmd : str |
|
124 | 125 | A command to be executed in the system shell. |
|
125 | 126 | |
|
126 | 127 | Returns |
|
127 | 128 | ------- |
|
128 | 129 | int : child's exitstatus |
|
129 | 130 | """ |
|
130 | 131 | # Get likely encoding for the output. |
|
131 |
enc = |
|
|
132 | enc = getdefaultencoding() | |
|
132 | 133 | |
|
133 | 134 | # Patterns to match on the output, for pexpect. We read input and |
|
134 | 135 | # allow either a short timeout or EOF |
|
135 | 136 | patterns = [pexpect.TIMEOUT, pexpect.EOF] |
|
136 | 137 | # the index of the EOF pattern in the list. |
|
137 | 138 | # even though we know it's 1, this call means we don't have to worry if |
|
138 | 139 | # we change the above list, and forget to change this value: |
|
139 | 140 | EOF_index = patterns.index(pexpect.EOF) |
|
140 | 141 | # The size of the output stored so far in the process output buffer. |
|
141 | 142 | # Since pexpect only appends to this buffer, each time we print we |
|
142 | 143 | # record how far we've printed, so that next time we only print *new* |
|
143 | 144 | # content from the buffer. |
|
144 | 145 | out_size = 0 |
|
145 | 146 | try: |
|
146 | 147 | # Since we're not really searching the buffer for text patterns, we |
|
147 | 148 | # can set pexpect's search window to be tiny and it won't matter. |
|
148 | 149 | # We only search for the 'patterns' timeout or EOF, which aren't in |
|
149 | 150 | # the text itself. |
|
150 | 151 | #child = pexpect.spawn(pcmd, searchwindowsize=1) |
|
151 | 152 | if hasattr(pexpect, 'spawnb'): |
|
152 | 153 | child = pexpect.spawnb(self.sh, args=['-c', cmd]) # Pexpect-U |
|
153 | 154 | else: |
|
154 | 155 | child = pexpect.spawn(self.sh, args=['-c', cmd]) # Vanilla Pexpect |
|
155 | 156 | flush = sys.stdout.flush |
|
156 | 157 | while True: |
|
157 | 158 | # res is the index of the pattern that caused the match, so we |
|
158 | 159 | # know whether we've finished (if we matched EOF) or not |
|
159 | 160 | res_idx = child.expect_list(patterns, self.read_timeout) |
|
160 | 161 | print(child.before[out_size:].decode(enc, 'replace'), end='') |
|
161 | 162 | flush() |
|
162 | 163 | if res_idx==EOF_index: |
|
163 | 164 | break |
|
164 | 165 | # Update the pointer to what we've already printed |
|
165 | 166 | out_size = len(child.before) |
|
166 | 167 | except KeyboardInterrupt: |
|
167 | 168 | # We need to send ^C to the process. The ascii code for '^C' is 3 |
|
168 | 169 | # (the character is known as ETX for 'End of Text', see |
|
169 | 170 | # curses.ascii.ETX). |
|
170 | 171 | child.sendline(chr(3)) |
|
171 | 172 | # Read and print any more output the program might produce on its |
|
172 | 173 | # way out. |
|
173 | 174 | try: |
|
174 | 175 | out_size = len(child.before) |
|
175 | 176 | child.expect_list(patterns, self.terminate_timeout) |
|
176 | 177 | print(child.before[out_size:].decode(enc, 'replace'), end='') |
|
177 | 178 | sys.stdout.flush() |
|
178 | 179 | except KeyboardInterrupt: |
|
179 | 180 | # Impatient users tend to type it multiple times |
|
180 | 181 | pass |
|
181 | 182 | finally: |
|
182 | 183 | # Ensure the subprocess really is terminated |
|
183 | 184 | child.terminate(force=True) |
|
184 | 185 | # add isalive check, to ensure exitstatus is set: |
|
185 | 186 | child.isalive() |
|
186 | 187 | return child.exitstatus |
|
187 | 188 | |
|
188 | 189 | |
|
189 | 190 | # Make system() with a functional interface for outside use. Note that we use |
|
190 | 191 | # getoutput() from the _common utils, which is built on top of popen(). Using |
|
191 | 192 | # pexpect to get subprocess output produces difficult to parse output, since |
|
192 | 193 | # programs think they are talking to a tty and produce highly formatted output |
|
193 | 194 | # (ls is a good example) that makes them hard. |
|
194 | 195 | system = ProcessHandler().system |
|
195 | 196 | |
|
196 | 197 | |
|
197 | 198 |
@@ -1,165 +1,166 b'' | |||
|
1 | 1 | """Utilities to manipulate JSON objects. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (C) 2010-2011 The IPython Development Team |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the BSD License. The full license is in |
|
7 | 7 | # the file COPYING.txt, distributed as part of this software. |
|
8 | 8 | #----------------------------------------------------------------------------- |
|
9 | 9 | |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | # Imports |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # stdlib |
|
14 | 14 | import re |
|
15 | 15 | import sys |
|
16 | 16 | import types |
|
17 | 17 | from datetime import datetime |
|
18 | 18 | |
|
19 | 19 | from IPython.utils import py3compat |
|
20 | from IPython.utils.encoding import getdefaultencoding | |
|
20 | 21 | from IPython.utils import text |
|
21 | 22 | next_attr_name = '__next__' if py3compat.PY3 else 'next' |
|
22 | 23 | |
|
23 | 24 | #----------------------------------------------------------------------------- |
|
24 | 25 | # Globals and constants |
|
25 | 26 | #----------------------------------------------------------------------------- |
|
26 | 27 | |
|
27 | 28 | # timestamp formats |
|
28 | 29 | ISO8601="%Y-%m-%dT%H:%M:%S.%f" |
|
29 | 30 | ISO8601_PAT=re.compile(r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+$") |
|
30 | 31 | |
|
31 | 32 | #----------------------------------------------------------------------------- |
|
32 | 33 | # Classes and functions |
|
33 | 34 | #----------------------------------------------------------------------------- |
|
34 | 35 | |
|
35 | 36 | def rekey(dikt): |
|
36 | 37 | """Rekey a dict that has been forced to use str keys where there should be |
|
37 | 38 | ints by json.""" |
|
38 | 39 | for k in dikt.iterkeys(): |
|
39 | 40 | if isinstance(k, basestring): |
|
40 | 41 | ik=fk=None |
|
41 | 42 | try: |
|
42 | 43 | ik = int(k) |
|
43 | 44 | except ValueError: |
|
44 | 45 | try: |
|
45 | 46 | fk = float(k) |
|
46 | 47 | except ValueError: |
|
47 | 48 | continue |
|
48 | 49 | if ik is not None: |
|
49 | 50 | nk = ik |
|
50 | 51 | else: |
|
51 | 52 | nk = fk |
|
52 | 53 | if nk in dikt: |
|
53 | 54 | raise KeyError("already have key %r"%nk) |
|
54 | 55 | dikt[nk] = dikt.pop(k) |
|
55 | 56 | return dikt |
|
56 | 57 | |
|
57 | 58 | |
|
58 | 59 | def extract_dates(obj): |
|
59 | 60 | """extract ISO8601 dates from unpacked JSON""" |
|
60 | 61 | if isinstance(obj, dict): |
|
61 | 62 | obj = dict(obj) # don't clobber |
|
62 | 63 | for k,v in obj.iteritems(): |
|
63 | 64 | obj[k] = extract_dates(v) |
|
64 | 65 | elif isinstance(obj, (list, tuple)): |
|
65 | 66 | obj = [ extract_dates(o) for o in obj ] |
|
66 | 67 | elif isinstance(obj, basestring): |
|
67 | 68 | if ISO8601_PAT.match(obj): |
|
68 | 69 | obj = datetime.strptime(obj, ISO8601) |
|
69 | 70 | return obj |
|
70 | 71 | |
|
71 | 72 | def squash_dates(obj): |
|
72 | 73 | """squash datetime objects into ISO8601 strings""" |
|
73 | 74 | if isinstance(obj, dict): |
|
74 | 75 | obj = dict(obj) # don't clobber |
|
75 | 76 | for k,v in obj.iteritems(): |
|
76 | 77 | obj[k] = squash_dates(v) |
|
77 | 78 | elif isinstance(obj, (list, tuple)): |
|
78 | 79 | obj = [ squash_dates(o) for o in obj ] |
|
79 | 80 | elif isinstance(obj, datetime): |
|
80 | 81 | obj = obj.strftime(ISO8601) |
|
81 | 82 | return obj |
|
82 | 83 | |
|
83 | 84 | def date_default(obj): |
|
84 | 85 | """default function for packing datetime objects in JSON.""" |
|
85 | 86 | if isinstance(obj, datetime): |
|
86 | 87 | return obj.strftime(ISO8601) |
|
87 | 88 | else: |
|
88 | 89 | raise TypeError("%r is not JSON serializable"%obj) |
|
89 | 90 | |
|
90 | 91 | |
|
91 | 92 | |
|
92 | 93 | def json_clean(obj): |
|
93 | 94 | """Clean an object to ensure it's safe to encode in JSON. |
|
94 | 95 | |
|
95 | 96 | Atomic, immutable objects are returned unmodified. Sets and tuples are |
|
96 | 97 | converted to lists, lists are copied and dicts are also copied. |
|
97 | 98 | |
|
98 | 99 | Note: dicts whose keys could cause collisions upon encoding (such as a dict |
|
99 | 100 | with both the number 1 and the string '1' as keys) will cause a ValueError |
|
100 | 101 | to be raised. |
|
101 | 102 | |
|
102 | 103 | Parameters |
|
103 | 104 | ---------- |
|
104 | 105 | obj : any python object |
|
105 | 106 | |
|
106 | 107 | Returns |
|
107 | 108 | ------- |
|
108 | 109 | out : object |
|
109 | 110 | |
|
110 | 111 | A version of the input which will not cause an encoding error when |
|
111 | 112 | encoded as JSON. Note that this function does not *encode* its inputs, |
|
112 | 113 | it simply sanitizes it so that there will be no encoding errors later. |
|
113 | 114 | |
|
114 | 115 | Examples |
|
115 | 116 | -------- |
|
116 | 117 | >>> json_clean(4) |
|
117 | 118 | 4 |
|
118 | 119 | >>> json_clean(range(10)) |
|
119 | 120 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
|
120 | 121 | >>> json_clean(dict(x=1, y=2)) |
|
121 | 122 | {'y': 2, 'x': 1} |
|
122 | 123 | >>> json_clean(dict(x=1, y=2, z=[1,2,3])) |
|
123 | 124 | {'y': 2, 'x': 1, 'z': [1, 2, 3]} |
|
124 | 125 | >>> json_clean(True) |
|
125 | 126 | True |
|
126 | 127 | """ |
|
127 | 128 | # types that are 'atomic' and ok in json as-is. bool doesn't need to be |
|
128 | 129 | # listed explicitly because bools pass as int instances |
|
129 | 130 | atomic_ok = (unicode, int, float, types.NoneType) |
|
130 | 131 | |
|
131 | 132 | # containers that we need to convert into lists |
|
132 | 133 | container_to_list = (tuple, set, types.GeneratorType) |
|
133 | 134 | |
|
134 | 135 | if isinstance(obj, atomic_ok): |
|
135 | 136 | return obj |
|
136 | 137 | |
|
137 | 138 | if isinstance(obj, bytes): |
|
138 |
return obj.decode( |
|
|
139 | return obj.decode(getdefaultencoding(), 'replace') | |
|
139 | 140 | |
|
140 | 141 | if isinstance(obj, container_to_list) or ( |
|
141 | 142 | hasattr(obj, '__iter__') and hasattr(obj, next_attr_name)): |
|
142 | 143 | obj = list(obj) |
|
143 | 144 | |
|
144 | 145 | if isinstance(obj, list): |
|
145 | 146 | return [json_clean(x) for x in obj] |
|
146 | 147 | |
|
147 | 148 | if isinstance(obj, dict): |
|
148 | 149 | # First, validate that the dict won't lose data in conversion due to |
|
149 | 150 | # key collisions after stringification. This can happen with keys like |
|
150 | 151 | # True and 'true' or 1 and '1', which collide in JSON. |
|
151 | 152 | nkeys = len(obj) |
|
152 | 153 | nkeys_collapsed = len(set(map(str, obj))) |
|
153 | 154 | if nkeys != nkeys_collapsed: |
|
154 | 155 | raise ValueError('dict can not be safely converted to JSON: ' |
|
155 | 156 | 'key collision would lead to dropped values') |
|
156 | 157 | # If all OK, proceed by making the new dict that will be json-safe |
|
157 | 158 | out = {} |
|
158 | 159 | for k,v in obj.iteritems(): |
|
159 | 160 | out[str(k)] = json_clean(v) |
|
160 | 161 | return out |
|
161 | 162 | |
|
162 | 163 | # If we get here, we don't know how to handle the object, so we just get |
|
163 | 164 | # its repr and return that. This will catch lambdas, open sockets, class |
|
164 | 165 | # objects, and any other complicated contraption that json can't encode |
|
165 | 166 | return repr(obj) |
@@ -1,207 +1,178 b'' | |||
|
1 | 1 | # coding: utf-8 |
|
2 | 2 | """Compatibility tricks for Python 3. Mainly to do with unicode.""" |
|
3 | 3 | import __builtin__ |
|
4 | 4 | import functools |
|
5 | 5 | import sys |
|
6 | 6 | import re |
|
7 | 7 | import types |
|
8 | import locale | |
|
8 | ||
|
9 | from IPython.utils.encoding import getdefaultencoding | |
|
9 | 10 | |
|
10 | 11 | orig_open = open |
|
11 | 12 | |
|
12 | 13 | def no_code(x, encoding=None): |
|
13 | 14 | return x |
|
14 | 15 | |
|
15 | # to deal with the possibility of sys.std* not being a stream at all | |
|
16 | def get_stream_enc(stream, default=None): | |
|
17 | if not hasattr(stream, 'encoding') or not stream.encoding: | |
|
18 | return default | |
|
19 | else: | |
|
20 | return stream.encoding | |
|
21 | ||
|
22 | # Less conservative replacement for sys.getdefaultencoding, that will try | |
|
23 | # to match the environment. | |
|
24 | # Defined here as central function, so if we find better choices, we | |
|
25 | # won't need to make changes all over IPython. | |
|
26 | def getdefaultencoding(): | |
|
27 | """Return IPython's guess for the default encoding for bytes as text. | |
|
28 | ||
|
29 | Asks for stdin.encoding first, to match the calling Terminal, but that | |
|
30 | is often None for subprocesses. Fall back on locale.getpreferredencoding() | |
|
31 | which should be a sensible platform default (that respects LANG environment), | |
|
32 | and finally to sys.getdefaultencoding() which is the most conservative option, | |
|
33 | and usually ASCII. | |
|
34 | """ | |
|
35 | enc = get_stream_enc(sys.stdin) | |
|
36 | if not enc or enc=='ascii': | |
|
37 | try: | |
|
38 | # There are reports of getpreferredencoding raising errors | |
|
39 | # in some cases, which may well be fixed, but let's be conservative here. | |
|
40 | enc = locale.getpreferredencoding() | |
|
41 | except Exception: | |
|
42 | pass | |
|
43 | return enc or sys.getdefaultencoding() | |
|
44 | ||
|
45 | 16 | def decode(s, encoding=None): |
|
46 | 17 | encoding = encoding or getdefaultencoding() |
|
47 | 18 | return s.decode(encoding, "replace") |
|
48 | 19 | |
|
49 | 20 | def encode(u, encoding=None): |
|
50 | 21 | encoding = encoding or getdefaultencoding() |
|
51 | 22 | return u.encode(encoding, "replace") |
|
52 | 23 | |
|
53 | 24 | |
|
54 | 25 | def cast_unicode(s, encoding=None): |
|
55 | 26 | if isinstance(s, bytes): |
|
56 | 27 | return decode(s, encoding) |
|
57 | 28 | return s |
|
58 | 29 | |
|
59 | 30 | def cast_bytes(s, encoding=None): |
|
60 | 31 | if not isinstance(s, bytes): |
|
61 | 32 | return encode(s, encoding) |
|
62 | 33 | return s |
|
63 | 34 | |
|
64 | 35 | def _modify_str_or_docstring(str_change_func): |
|
65 | 36 | @functools.wraps(str_change_func) |
|
66 | 37 | def wrapper(func_or_str): |
|
67 | 38 | if isinstance(func_or_str, basestring): |
|
68 | 39 | func = None |
|
69 | 40 | doc = func_or_str |
|
70 | 41 | else: |
|
71 | 42 | func = func_or_str |
|
72 | 43 | doc = func.__doc__ |
|
73 | 44 | |
|
74 | 45 | doc = str_change_func(doc) |
|
75 | 46 | |
|
76 | 47 | if func: |
|
77 | 48 | func.__doc__ = doc |
|
78 | 49 | return func |
|
79 | 50 | return doc |
|
80 | 51 | return wrapper |
|
81 | 52 | |
|
82 | 53 | if sys.version_info[0] >= 3: |
|
83 | 54 | PY3 = True |
|
84 | 55 | |
|
85 | 56 | input = input |
|
86 | 57 | builtin_mod_name = "builtins" |
|
87 | 58 | |
|
88 | 59 | str_to_unicode = no_code |
|
89 | 60 | unicode_to_str = no_code |
|
90 | 61 | str_to_bytes = encode |
|
91 | 62 | bytes_to_str = decode |
|
92 | 63 | cast_bytes_py2 = no_code |
|
93 | 64 | |
|
94 | 65 | def isidentifier(s, dotted=False): |
|
95 | 66 | if dotted: |
|
96 | 67 | return all(isidentifier(a) for a in s.split(".")) |
|
97 | 68 | return s.isidentifier() |
|
98 | 69 | |
|
99 | 70 | open = orig_open |
|
100 | 71 | |
|
101 | 72 | MethodType = types.MethodType |
|
102 | 73 | |
|
103 | 74 | def execfile(fname, glob, loc=None): |
|
104 | 75 | loc = loc if (loc is not None) else glob |
|
105 | 76 | exec compile(open(fname, 'rb').read(), fname, 'exec') in glob, loc |
|
106 | 77 | |
|
107 | 78 | # Refactor print statements in doctests. |
|
108 | 79 | _print_statement_re = re.compile(r"\bprint (?P<expr>.*)$", re.MULTILINE) |
|
109 | 80 | def _print_statement_sub(match): |
|
110 | 81 | expr = match.groups('expr') |
|
111 | 82 | return "print(%s)" % expr |
|
112 | 83 | |
|
113 | 84 | @_modify_str_or_docstring |
|
114 | 85 | def doctest_refactor_print(doc): |
|
115 | 86 | """Refactor 'print x' statements in a doctest to print(x) style. 2to3 |
|
116 | 87 | unfortunately doesn't pick up on our doctests. |
|
117 | 88 | |
|
118 | 89 | Can accept a string or a function, so it can be used as a decorator.""" |
|
119 | 90 | return _print_statement_re.sub(_print_statement_sub, doc) |
|
120 | 91 | |
|
121 | 92 | # Abstract u'abc' syntax: |
|
122 | 93 | @_modify_str_or_docstring |
|
123 | 94 | def u_format(s): |
|
124 | 95 | """"{u}'abc'" --> "'abc'" (Python 3) |
|
125 | 96 | |
|
126 | 97 | Accepts a string or a function, so it can be used as a decorator.""" |
|
127 | 98 | return s.format(u='') |
|
128 | 99 | |
|
129 | 100 | else: |
|
130 | 101 | PY3 = False |
|
131 | 102 | |
|
132 | 103 | input = raw_input |
|
133 | 104 | builtin_mod_name = "__builtin__" |
|
134 | 105 | |
|
135 | 106 | str_to_unicode = decode |
|
136 | 107 | unicode_to_str = encode |
|
137 | 108 | str_to_bytes = no_code |
|
138 | 109 | bytes_to_str = no_code |
|
139 | 110 | cast_bytes_py2 = cast_bytes |
|
140 | 111 | |
|
141 | 112 | import re |
|
142 | 113 | _name_re = re.compile(r"[a-zA-Z_][a-zA-Z0-9_]*$") |
|
143 | 114 | def isidentifier(s, dotted=False): |
|
144 | 115 | if dotted: |
|
145 | 116 | return all(isidentifier(a) for a in s.split(".")) |
|
146 | 117 | return bool(_name_re.match(s)) |
|
147 | 118 | |
|
148 | 119 | class open(object): |
|
149 | 120 | """Wrapper providing key part of Python 3 open() interface.""" |
|
150 | 121 | def __init__(self, fname, mode="r", encoding="utf-8"): |
|
151 | 122 | self.f = orig_open(fname, mode) |
|
152 | 123 | self.enc = encoding |
|
153 | 124 | |
|
154 | 125 | def write(self, s): |
|
155 | 126 | return self.f.write(s.encode(self.enc)) |
|
156 | 127 | |
|
157 | 128 | def read(self, size=-1): |
|
158 | 129 | return self.f.read(size).decode(self.enc) |
|
159 | 130 | |
|
160 | 131 | def close(self): |
|
161 | 132 | return self.f.close() |
|
162 | 133 | |
|
163 | 134 | def __enter__(self): |
|
164 | 135 | return self |
|
165 | 136 | |
|
166 | 137 | def __exit__(self, etype, value, traceback): |
|
167 | 138 | self.f.close() |
|
168 | 139 | |
|
169 | 140 | def MethodType(func, instance): |
|
170 | 141 | return types.MethodType(func, instance, type(instance)) |
|
171 | 142 | |
|
172 | 143 | # don't override system execfile on 2.x: |
|
173 | 144 | execfile = execfile |
|
174 | 145 | |
|
175 | 146 | def doctest_refactor_print(func_or_str): |
|
176 | 147 | return func_or_str |
|
177 | 148 | |
|
178 | 149 | |
|
179 | 150 | # Abstract u'abc' syntax: |
|
180 | 151 | @_modify_str_or_docstring |
|
181 | 152 | def u_format(s): |
|
182 | 153 | """"{u}'abc'" --> "u'abc'" (Python 2) |
|
183 | 154 | |
|
184 | 155 | Accepts a string or a function, so it can be used as a decorator.""" |
|
185 | 156 | return s.format(u='u') |
|
186 | 157 | |
|
187 | 158 | if sys.platform == 'win32': |
|
188 | 159 | def execfile(fname, glob=None, loc=None): |
|
189 | 160 | loc = loc if (loc is not None) else glob |
|
190 | 161 | # The rstrip() is necessary b/c trailing whitespace in files will |
|
191 | 162 | # cause an IndentationError in Python 2.6 (this was fixed in 2.7, |
|
192 | 163 | # but we still support 2.6). See issue 1027. |
|
193 | 164 | scripttext = __builtin__.open(fname).read().rstrip() + '\n' |
|
194 | 165 | # compile converts unicode filename to str assuming |
|
195 | 166 | # ascii. Let's do the conversion before calling compile |
|
196 | 167 | if isinstance(fname, unicode): |
|
197 | 168 | filename = unicode_to_str(fname) |
|
198 | 169 | else: |
|
199 | 170 | filename = fname |
|
200 | 171 | exec compile(scripttext, filename, 'exec') in glob, loc |
|
201 | 172 | else: |
|
202 | 173 | def execfile(fname, *where): |
|
203 | 174 | if isinstance(fname, unicode): |
|
204 | 175 | filename = fname.encode(sys.getfilesystemencoding()) |
|
205 | 176 | else: |
|
206 | 177 | filename = fname |
|
207 | 178 | __builtin__.execfile(filename, *where) |
@@ -1,91 +1,91 b'' | |||
|
1 | 1 | import sys |
|
2 | 2 | import time |
|
3 | 3 | from io import StringIO |
|
4 | 4 | |
|
5 | 5 | from session import extract_header, Message |
|
6 | 6 | |
|
7 |
from IPython.utils import io, text, |
|
|
7 | from IPython.utils import io, text, encoding | |
|
8 | 8 | |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | # Globals |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | # Stream classes |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | class OutStream(object): |
|
18 | 18 | """A file like object that publishes the stream to a 0MQ PUB socket.""" |
|
19 | 19 | |
|
20 | 20 | # The time interval between automatic flushes, in seconds. |
|
21 | 21 | flush_interval = 0.05 |
|
22 | 22 | topic=None |
|
23 | 23 | |
|
24 | 24 | def __init__(self, session, pub_socket, name): |
|
25 | 25 | self.session = session |
|
26 | 26 | self.pub_socket = pub_socket |
|
27 | 27 | self.name = name |
|
28 | 28 | self.parent_header = {} |
|
29 | 29 | self._new_buffer() |
|
30 | 30 | |
|
31 | 31 | def set_parent(self, parent): |
|
32 | 32 | self.parent_header = extract_header(parent) |
|
33 | 33 | |
|
34 | 34 | def close(self): |
|
35 | 35 | self.pub_socket = None |
|
36 | 36 | |
|
37 | 37 | def flush(self): |
|
38 | 38 | #io.rprint('>>>flushing output buffer: %s<<<' % self.name) # dbg |
|
39 | 39 | if self.pub_socket is None: |
|
40 | 40 | raise ValueError(u'I/O operation on closed file') |
|
41 | 41 | else: |
|
42 | 42 | data = self._buffer.getvalue() |
|
43 | 43 | if data: |
|
44 | 44 | content = {u'name':self.name, u'data':data} |
|
45 | 45 | msg = self.session.send(self.pub_socket, u'stream', content=content, |
|
46 | 46 | parent=self.parent_header, ident=self.topic) |
|
47 | 47 | |
|
48 | 48 | if hasattr(self.pub_socket, 'flush'): |
|
49 | 49 | # socket itself has flush (presumably ZMQStream) |
|
50 | 50 | self.pub_socket.flush() |
|
51 | 51 | self._buffer.close() |
|
52 | 52 | self._new_buffer() |
|
53 | 53 | |
|
54 | 54 | def isatty(self): |
|
55 | 55 | return False |
|
56 | 56 | |
|
57 | 57 | def next(self): |
|
58 | 58 | raise IOError('Read not supported on a write only stream.') |
|
59 | 59 | |
|
60 | 60 | def read(self, size=-1): |
|
61 | 61 | raise IOError('Read not supported on a write only stream.') |
|
62 | 62 | |
|
63 | 63 | def readline(self, size=-1): |
|
64 | 64 | raise IOError('Read not supported on a write only stream.') |
|
65 | 65 | |
|
66 | 66 | def write(self, string): |
|
67 | 67 | if self.pub_socket is None: |
|
68 | 68 | raise ValueError('I/O operation on closed file') |
|
69 | 69 | else: |
|
70 | 70 | # Make sure that we're handling unicode |
|
71 | 71 | if not isinstance(string, unicode): |
|
72 |
enc = |
|
|
72 | enc = encoding.getdefaultencoding() | |
|
73 | 73 | string = string.decode(enc, 'replace') |
|
74 | 74 | |
|
75 | 75 | self._buffer.write(string) |
|
76 | 76 | current_time = time.time() |
|
77 | 77 | if self._start <= 0: |
|
78 | 78 | self._start = current_time |
|
79 | 79 | elif current_time - self._start > self.flush_interval: |
|
80 | 80 | self.flush() |
|
81 | 81 | |
|
82 | 82 | def writelines(self, sequence): |
|
83 | 83 | if self.pub_socket is None: |
|
84 | 84 | raise ValueError('I/O operation on closed file') |
|
85 | 85 | else: |
|
86 | 86 | for string in sequence: |
|
87 | 87 | self.write(string) |
|
88 | 88 | |
|
89 | 89 | def _new_buffer(self): |
|
90 | 90 | self._buffer = StringIO() |
|
91 | 91 | self._start = -1 |
General Comments 0
You need to be logged in to leave comments.
Login now