demo.py
201 lines
| 7.5 KiB
| text/x-python
|
PythonLexer
/ IPython / demo.py
fperez
|
r22 | """Module for interactive demos using IPython. | ||
fperez
|
r23 | |||
Sorry, but this uses Python 2.3 features, so it won't work in 2.2 environments. | ||||
fperez
|
r22 | """ | ||
#***************************************************************************** | ||||
# Copyright (C) 2005 Fernando Perez. <Fernando.Perez@colorado.edu> | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
# | ||||
#***************************************************************************** | ||||
fperez
|
r24 | import sys | ||
fperez
|
r22 | import exceptions | ||
fperez
|
r23 | import re | ||
fperez
|
r22 | |||
from IPython.PyColorize import Parser | ||||
fperez
|
r24 | from IPython.genutils import marquee, shlex_split | ||
fperez
|
r22 | |||
class DemoError(exceptions.Exception): pass | ||||
class Demo: | ||||
fperez
|
r24 | def __init__(self,fname,arg_str='',mark_pause='# pause', | ||
fperez
|
r30 | mark_silent='# silent',mark_auto='# auto',auto=False): | ||
fperez
|
r24 | """Make a new demo object. To run the demo, simply call the object. | ||
Inputs: | ||||
- fname = filename. | ||||
Optional inputs: | ||||
- arg_str(''): a string of arguments, internally converted to a list | ||||
just like sys.argv, so the demo script can see a similar | ||||
environment. | ||||
fperez
|
r30 | - mark_pause ('# pause'): marks for pausing (block boundaries). The | ||
marks are turned into regexps which match them as standalone in a | ||||
line, with all leading/trailing whitespace ignored. | ||||
- mark_silent('# silent'): mark blocks as silent, which means that | ||||
they are executed without printing their content to screen. Silent | ||||
blocks are always automatically executed. | ||||
- mark_auto ('# auto'): mark individual blocks as automatically | ||||
executed (without asking for confirmation). | ||||
- auto(False): global flag to run all blocks automatically without | ||||
confirmation. This attribute overrides the block-level tags and | ||||
applies to the whole demo. It is an attribute of the object, and | ||||
can be changed at runtime simply by reassigning it to a boolean | ||||
value. | ||||
fperez
|
r24 | """ | ||
fperez
|
r22 | |||
fperez
|
r30 | self.fname = fname | ||
self.sys_argv = [fname] + shlex_split(arg_str) | ||||
self.mark_pause = mark_pause | ||||
fperez
|
r23 | self.mark_silent = mark_silent | ||
fperez
|
r30 | self.re_pause = re.compile(r'^\s*%s\s*$' % mark_pause,re.MULTILINE) | ||
self.re_silent = re.compile(r'^\s*%s\s*$' % mark_silent,re.MULTILINE) | ||||
self.re_auto = re.compile(r'^\s*%s\s*$' % mark_auto,re.MULTILINE) | ||||
self.auto = auto | ||||
fperez
|
r22 | |||
# get a few things from ipython. While it's a bit ugly design-wise, | ||||
# it ensures that things like color scheme and the like are always in | ||||
# sync with the ipython mode being used. This class is only meant to | ||||
# be used inside ipython anyways, so it's OK. | ||||
fperez
|
r30 | self.ip_showtb = __IPYTHON__.showtraceback | ||
self.ip_ns = __IPYTHON__.user_ns | ||||
fperez
|
r22 | self.ip_colors = __IPYTHON__.rc['colors'] | ||
fperez
|
r30 | self.colorize = Parser().format | ||
# load user data and initialize data structures | ||||
self.reload() | ||||
fperez
|
r22 | |||
fperez
|
r30 | def reload(self): | ||
"""Reload source from disk and initialize state.""" | ||||
fperez
|
r22 | # read data and parse into blocks | ||
fperez
|
r30 | fobj = file(self.fname,'r') | ||
fperez
|
r22 | self.src = fobj.read() | ||
fobj.close() | ||||
fperez
|
r30 | src_blocks = [b.strip() for b in self.re_pause.split(self.src) if b] | ||
self._silent = [bool(self.re_silent.findall(b)) for b in src_blocks] | ||||
self._auto = [bool(self.re_auto.findall(b)) for b in src_blocks] | ||||
# strip out the 'auto' markers | ||||
src_b = [] | ||||
auto_strip = lambda s: self.re_auto.sub('',s) | ||||
for i,b in enumerate(src_blocks): | ||||
if self._auto[i]: | ||||
src_b.append(auto_strip(b)) | ||||
else: | ||||
src_b.append(b) | ||||
self.nblocks = len(src_b) | ||||
self.src_blocks = src_b | ||||
fperez
|
r22 | |||
# try to colorize blocks | ||||
col_scheme = self.ip_colors | ||||
fperez
|
r30 | self.src_blocks_colored = [self.colorize(s_blk,'str',col_scheme) | ||
fperez
|
r22 | for s_blk in self.src_blocks] | ||
fperez
|
r30 | # ensure clean namespace and seek offset | ||
fperez
|
r22 | self.reset() | ||
def reset(self): | ||||
fperez
|
r23 | """Reset the namespace and seek pointer to restart the demo""" | ||
fperez
|
r22 | self.user_ns = {} | ||
self.finished = False | ||||
self.block_index = 0 | ||||
def again(self): | ||||
fperez
|
r23 | """Repeat the last block""" | ||
fperez
|
r22 | self.block_index -= 1 | ||
fperez
|
r26 | self.finished = False | ||
fperez
|
r22 | self() | ||
def _validate_index(self,index): | ||||
if index<0 or index>=self.nblocks: | ||||
raise ValueError('invalid block index %s' % index) | ||||
def seek(self,index): | ||||
fperez
|
r23 | """Move the current seek pointer to the given block""" | ||
fperez
|
r22 | self._validate_index(index) | ||
fperez
|
r30 | self.block_index = index | ||
fperez
|
r22 | self.finished = False | ||
fperez
|
r30 | def show(self,index=None): | ||
fperez
|
r23 | """Show a single block on screen""" | ||
fperez
|
r22 | if index is None: | ||
fperez
|
r23 | if self.finished: | ||
print 'Demo finished. Use reset() if you want to rerun it.' | ||||
return | ||||
fperez
|
r22 | index = self.block_index | ||
else: | ||||
self._validate_index(index) | ||||
fperez
|
r26 | print marquee('<%s> block # %s (%s remaining)' % | ||
(self.fname,index,self.nblocks-index-1)) | ||||
fperez
|
r22 | print self.src_blocks_colored[index], | ||
fperez
|
r23 | |||
fperez
|
r30 | def show_all(self): | ||
fperez
|
r23 | """Show entire demo on screen, block by block""" | ||
fname = self.fname | ||||
nblocks = self.nblocks | ||||
fperez
|
r30 | silent = self._silent | ||
fperez
|
r23 | for index,block in enumerate(self.src_blocks_colored): | ||
if silent[index]: | ||||
fperez
|
r26 | print marquee('<%s> SILENT block # %s (%s remaining)' % | ||
(fname,index,nblocks-index-1)) | ||||
fperez
|
r23 | else: | ||
fperez
|
r26 | print marquee('<%s> block # %s (%s remaining)' % | ||
(fname,index,nblocks-index-1)) | ||||
fperez
|
r23 | print block, | ||
fperez
|
r22 | def __call__(self,index=None): | ||
"""run a block of the demo. | ||||
If index is given, it should be an integer >=1 and <= nblocks. This | ||||
means that the calling convention is one off from typical Python | ||||
lists. The reason for the inconsistency is that the demo always | ||||
prints 'Block n/N, and N is the total, so it would be very odd to use | ||||
zero-indexing here.""" | ||||
if index is None and self.finished: | ||||
print 'Demo finished. Use reset() if you want to rerun it.' | ||||
return | ||||
if index is None: | ||||
index = self.block_index | ||||
self._validate_index(index) | ||||
try: | ||||
next_block = self.src_blocks[index] | ||||
self.block_index += 1 | ||||
fperez
|
r30 | if self._silent[index]: | ||
fperez
|
r26 | print marquee('Executing silent block # %s (%s remaining)' % | ||
(index,self.nblocks-index-1)) | ||||
fperez
|
r23 | else: | ||
fperez
|
r30 | self.show(index) | ||
if self.auto or self._auto[index]: | ||||
fperez
|
r26 | print marquee('output') | ||
else: | ||||
fperez
|
r23 | print marquee('Press <q> to quit, <Enter> to execute...'), | ||
ans = raw_input().strip() | ||||
if ans: | ||||
print marquee('Block NOT executed') | ||||
return | ||||
fperez
|
r24 | try: | ||
save_argv = sys.argv | ||||
sys.argv = self.sys_argv | ||||
exec next_block in self.user_ns | ||||
finally: | ||||
sys.argv = save_argv | ||||
fperez
|
r22 | |||
except: | ||||
fperez
|
r30 | self.ip_showtb(filename=self.fname) | ||
fperez
|
r22 | else: | ||
self.ip_ns.update(self.user_ns) | ||||
if self.block_index == self.nblocks: | ||||
print marquee(' END OF DEMO ') | ||||
print marquee('Use reset() if you want to rerun it.') | ||||
self.finished = True | ||||
fperez
|
r30 | |||