hgbook
annotate en/examples/run-example @ 70:365b41b6a15e
bash is not necessarily in /bin.
Original patch against an earlier rev from Guy Brand <gb@isis.u-strasbg.fr>.
Original patch against an earlier rev from Guy Brand <gb@isis.u-strasbg.fr>.
author | Bryan O'Sullivan <bos@serpentine.com> |
---|---|
date | Tue Aug 08 14:13:28 2006 -0700 (2006-08-08) |
parents | c574ce277a2b |
children | ddf533d41c09 |
rev | line source |
---|---|
bos@67 | 1 #!/usr/bin/env python |
bos@4 | 2 # |
bos@4 | 3 # This program takes something that resembles a shell script and runs |
bos@4 | 4 # it, spitting input (commands from the script) and output into text |
bos@4 | 5 # files, for use in examples. |
bos@3 | 6 |
bos@3 | 7 import cStringIO |
bos@3 | 8 import os |
bos@3 | 9 import pty |
bos@3 | 10 import re |
bos@4 | 11 import shutil |
bos@6 | 12 import signal |
bos@36 | 13 import stat |
bos@3 | 14 import sys |
bos@4 | 15 import tempfile |
bos@4 | 16 import time |
bos@3 | 17 |
bos@4 | 18 def tex_escape(s): |
bos@4 | 19 if '\\' in s: |
bos@4 | 20 s = s.replace('\\', '\\\\') |
bos@4 | 21 if '{' in s: |
bos@4 | 22 s = s.replace('{', '\\{') |
bos@4 | 23 if '}' in s: |
bos@4 | 24 s = s.replace('}', '\\}') |
bos@4 | 25 return s |
bos@4 | 26 |
bos@3 | 27 class example: |
bos@70 | 28 shell = '/usr/bin/env bash' |
bos@6 | 29 prompt = '__run_example_prompt__\n' |
bos@4 | 30 pi_re = re.compile('#\$\s*(name):\s*(.*)$') |
bos@4 | 31 |
bos@3 | 32 def __init__(self, name): |
bos@3 | 33 self.name = name |
bos@3 | 34 |
bos@3 | 35 def parse(self): |
bos@4 | 36 '''yield each hunk of input from the file.''' |
bos@3 | 37 fp = open(self.name) |
bos@3 | 38 cfp = cStringIO.StringIO() |
bos@3 | 39 for line in fp: |
bos@3 | 40 cfp.write(line) |
bos@3 | 41 if not line.rstrip().endswith('\\'): |
bos@3 | 42 yield cfp.getvalue() |
bos@3 | 43 cfp.seek(0) |
bos@3 | 44 cfp.truncate() |
bos@3 | 45 |
bos@3 | 46 def status(self, s): |
bos@3 | 47 sys.stdout.write(s) |
bos@3 | 48 if not s.endswith('\n'): |
bos@3 | 49 sys.stdout.flush() |
bos@3 | 50 |
bos@6 | 51 def send(self, s): |
bos@6 | 52 self.cfp.write(s) |
bos@6 | 53 self.cfp.flush() |
bos@6 | 54 |
bos@6 | 55 def receive(self): |
bos@6 | 56 out = cStringIO.StringIO() |
bos@4 | 57 while True: |
bos@6 | 58 s = self.cfp.readline().replace('\r\n', '\n') |
bos@6 | 59 if not s or s == self.prompt: |
bos@6 | 60 break |
bos@6 | 61 out.write(s) |
bos@6 | 62 return out.getvalue() |
bos@4 | 63 |
bos@6 | 64 def sendreceive(self, s): |
bos@6 | 65 self.send(s) |
bos@6 | 66 r = self.receive() |
bos@6 | 67 if r.startswith(s): |
bos@6 | 68 r = r[len(s):] |
bos@6 | 69 return r |
bos@6 | 70 |
bos@3 | 71 def run(self): |
bos@3 | 72 ofp = None |
bos@4 | 73 basename = os.path.basename(self.name) |
bos@4 | 74 self.status('running %s ' % basename) |
bos@4 | 75 tmpdir = tempfile.mkdtemp(prefix=basename) |
bos@6 | 76 rcfile = os.path.join(tmpdir, '.bashrc') |
bos@6 | 77 rcfp = open(rcfile, 'w') |
bos@6 | 78 print >> rcfp, 'PS1="%s"' % self.prompt |
bos@6 | 79 print >> rcfp, 'unset HISTFILE' |
bos@19 | 80 print >> rcfp, 'export EXAMPLE_DIR="%s"' % os.getcwd() |
bos@6 | 81 print >> rcfp, 'export LANG=C' |
bos@6 | 82 print >> rcfp, 'export LC_ALL=C' |
bos@6 | 83 print >> rcfp, 'export TZ=GMT' |
bos@6 | 84 print >> rcfp, 'export HGRC="%s/.hgrc"' % tmpdir |
bos@6 | 85 print >> rcfp, 'export HGRCPATH=$HGRC' |
bos@6 | 86 print >> rcfp, 'cd %s' % tmpdir |
bos@6 | 87 rcfp.close() |
bos@68 | 88 sys.stdout.flush() |
bos@68 | 89 sys.stderr.flush() |
bos@6 | 90 pid, fd = pty.fork() |
bos@6 | 91 if pid == 0: |
bos@70 | 92 cmdline = ['/usr/bin/env', 'bash', '--noediting', '--noprofile', |
bos@70 | 93 '--norc'] |
bos@68 | 94 try: |
bos@68 | 95 os.execv(cmdline[0], cmdline) |
bos@68 | 96 except OSError, err: |
bos@68 | 97 print >> sys.stderr, '%s: %s' % (cmdline[0], err.strerror) |
bos@68 | 98 sys.stderr.flush() |
bos@68 | 99 os._exit(0) |
bos@6 | 100 self.cfp = os.fdopen(fd, 'w+') |
bos@4 | 101 try: |
benoit@22 | 102 # setup env and prompt |
benoit@22 | 103 self.sendreceive('source %s\n\n' % rcfile) |
bos@4 | 104 for hunk in self.parse(): |
bos@4 | 105 # is this line a processing instruction? |
bos@4 | 106 m = self.pi_re.match(hunk) |
bos@4 | 107 if m: |
bos@4 | 108 pi, rest = m.groups() |
bos@4 | 109 if pi == 'name': |
bos@4 | 110 self.status('.') |
bos@4 | 111 out = rest |
bos@4 | 112 assert os.sep not in out |
bos@4 | 113 if out: |
bos@4 | 114 ofp = open('%s.%s.out' % (self.name, out), 'w') |
bos@4 | 115 else: |
bos@4 | 116 ofp = None |
bos@6 | 117 elif hunk.strip(): |
bos@4 | 118 # it's something we should execute |
bos@6 | 119 output = self.sendreceive(hunk) |
bos@6 | 120 if not ofp: |
bos@6 | 121 continue |
bos@6 | 122 # first, print the command we ran |
bos@6 | 123 if not hunk.startswith('#'): |
bos@6 | 124 nl = hunk.endswith('\n') |
bos@6 | 125 hunk = ('$ \\textbf{%s}' % |
bos@6 | 126 tex_escape(hunk.rstrip('\n'))) |
bos@6 | 127 if nl: hunk += '\n' |
bos@6 | 128 ofp.write(hunk) |
bos@4 | 129 # then its output |
bos@19 | 130 ofp.write(tex_escape(output)) |
bos@4 | 131 self.status('\n') |
bos@45 | 132 open(self.name + '.run', 'w') |
bos@4 | 133 finally: |
bos@6 | 134 try: |
bos@6 | 135 output = self.sendreceive('exit\n') |
bos@6 | 136 if ofp: |
bos@6 | 137 ofp.write(output) |
bos@6 | 138 self.cfp.close() |
bos@6 | 139 except IOError: |
bos@6 | 140 pass |
bos@6 | 141 os.kill(pid, signal.SIGTERM) |
bos@4 | 142 os.wait() |
bos@4 | 143 shutil.rmtree(tmpdir) |
bos@3 | 144 |
bos@3 | 145 def main(path='.'): |
bos@3 | 146 args = sys.argv[1:] |
bos@3 | 147 if args: |
bos@3 | 148 for a in args: |
bos@3 | 149 example(a).run() |
bos@3 | 150 return |
bos@3 | 151 for name in os.listdir(path): |
bos@3 | 152 if name == 'run-example' or name.startswith('.'): continue |
bos@3 | 153 if name.endswith('.out') or name.endswith('~'): continue |
bos@45 | 154 if name.endswith('.run'): continue |
bos@19 | 155 pathname = os.path.join(path, name) |
bos@36 | 156 st = os.lstat(pathname) |
bos@36 | 157 if stat.S_ISREG(st.st_mode) and st.st_mode & 0111: |
bos@19 | 158 example(pathname).run() |
bos@4 | 159 print >> open(os.path.join(path, '.run'), 'w'), time.asctime() |
bos@3 | 160 |
bos@3 | 161 if __name__ == '__main__': |
bos@3 | 162 main() |