1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
|
"""Variant on standard library's cmd with extra features.
To use, simply import cmd2.Cmd instead of cmd.Cmd; use precisely as though you
were using the standard library's cmd, while enjoying the extra features.
Searchable command history (commands: "hi", "li", "run")
Load commands from file, save to file, edit commands in file
Multi-line commands
Case-insensitive commands
Special-character shortcut commands (beyond cmd's "@" and "!")
Settable environment parameters
Parsing commands with `optparse` options (flags)
Redirection to file with >, >>; input from file with <
- Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
CHANGES:
As of 0.3.0, options should be specified as `optparse` options. See README.txt.
flagReader.py options are still supported for backward compatibility
"""
import cmd, re, os, sys, optparse, subprocess, tempfile
from optparse import make_option
class OptionParser(optparse.OptionParser):
def exit(self, status=0, msg=None):
if msg:
print msg
def error(self, msg):
"""error(msg : string)
Print a usage message incorporating 'msg' to stderr and exit.
If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
"""
#print msg
#print self.format_help()
raise
def options(option_list):
def option_setup(func):
optionParser = OptionParser()
for opt in option_list:
optionParser.add_option(opt)
optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
def newFunc(instance, arg):
try:
opts, arg = optionParser.parse_args(arg.split())
except (optparse.OptionValueError, optparse.BadOptionError,
optparse.OptionError, optparse.AmbiguousOptionError,
optparse.OptionConflictError), e:
print e
optionParser.print_help()
return
result = func(instance, arg, opts)
return result
newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
return newFunc
return option_setup
class PasteBufferError(EnvironmentError):
if sys.platform[:3] == 'win':
errmsg = """Redirecting to or from paste buffer requires pywin32
to be installed on operating system.
Download from http://sourceforge.net/projects/pywin32/"""
else:
errmsg = """Redirecting to or from paste buffer requires xclip
to be installed on operating system.
On Debian/Ubuntu, 'sudo apt-get install xclip' will install it."""
def __init__(self):
Exception.__init__(self, self.errmsg)
'''check here if functions exist; otherwise, stub out'''
pastebufferr = """Redirecting to or from paste buffer requires %s
to be installed on operating system.
%s"""
if subprocess.mswindows:
try:
import win32clipboard
def getPasteBuffer():
win32clipboard.OpenClipboard(0)
try:
result = win32clipboard.GetClipboardData()
except TypeError:
result = '' #non-text
win32clipboard.CloseClipboard()
return result
def writeToPasteBuffer(txt):
win32clipboard.OpenClipboard(0)
win32clipboard.EmptyClipboard()
win32clipboard.SetClipboardText(txt)
win32clipboard.CloseClipboard()
except ImportError:
def getPasteBuffer():
raise OSError, pastebufferr % ('pywin32', 'Download from http://sourceforge.net/projects/pywin32/')
setPasteBuffer = getPasteBuffer
else:
can_clip = False
try:
subprocess.check_call('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
can_clip = True
except AttributeError: # check_call not defined, Python < 2.5
teststring = 'Testing for presence of xclip.'
xclipproc = subprocess.check_call('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
xclipproc.stdin.write(teststring)
if xclipproc.stdout.read() == teststring:
can_clip = True
except (subprocess.CalledProcessError, OSError):
pass
if can_clip:
def getPasteBuffer():
xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
return xclipproc.stdout.read()
def writeToPasteBuffer(txt):
xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
xclipproc.stdin.write(txt)
xclipproc.stdin.close()
else:
def getPasteBuffer():
raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"')
setPasteBuffer = getPasteBuffer
class Cmd(cmd.Cmd):
caseInsensitive = True
multilineCommands = []
continuationPrompt = '> '
shortcuts = {'?': 'help', '!': 'shell', '@': 'load'}
excludeFromHistory = '''run r list l history hi ed li eof'''.split()
defaultExtension = 'txt'
defaultFileName = 'command.txt'
editor = os.environ.get('EDITOR')
if not editor:
if sys.platform[:3] == 'win':
editor = 'notepad'
else:
for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
if os.system('which %s' % (editor)):
break
settable = ['prompt', 'continuationPrompt', 'defaultFileName', 'editor', 'caseInsensitive']
terminators = ';\n'
_TO_PASTE_BUFFER = 1
def do_cmdenvironment(self, args):
self.stdout.write("""
Commands are %(casesensitive)scase-sensitive.
Commands may be terminated with: %(terminators)s
Settable parameters: %(settable)s
""" %
{ 'casesensitive': ('not ' and self.caseInsensitive) or '',
'terminators': ' '.join(self.terminators),
'settable': ' '.join(self.settable)
})
def do_help(self, arg):
cmd.Cmd.do_help(self, arg)
try:
fn = getattr(self, 'do_' + arg)
if fn and fn.optionParser:
fn.optionParser.print_help(file=self.stdout)
except AttributeError:
pass
def __init__(self, *args, **kwargs):
cmd.Cmd.__init__(self, *args, **kwargs)
self.history = History()
def do_shortcuts(self, args):
"""Lists single-key shortcuts available."""
result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in self.shortcuts.items())
self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
legalFileName = re.compile(r'''^[^"'\s]+$''')
def parseRedirector(self, statement, symbol, mustBeTerminated=False):
parts = statement.split(symbol)
if (len(parts) < 2):
return statement, None
if mustBeTerminated and (parts[-2].strip()[-1] not in self.terminators):
return statement, None
(newStatement, redirect) = (symbol.join(parts[:-1]), parts[-1].strip())
if redirect:
if not self.legalFileName.search(redirect):
return statement, None
else:
redirect = self._TO_PASTE_BUFFER
return newStatement, redirect
def extractCommand(self, statement):
try:
(command, args) = statement.split(None,1)
except ValueError:
(command, args) = statement, ''
if self.caseInsensitive:
command = command.lower()
return command, args
def parseRedirectors(self, statement):
mustBeTerminated = self.extractCommand(statement)[0] in self.multilineCommands
newStatement, redirect = self.parseRedirector(statement, '>>', mustBeTerminated)
if redirect:
return newStatement, redirect, 'a'
newStatement, redirect = self.parseRedirector(statement, '>', mustBeTerminated)
if redirect:
return newStatement, redirect, 'w'
newStatement, redirect = self.parseRedirector(statement, '<', mustBeTerminated)
if redirect:
return newStatement, redirect, 'r'
return statement, '', ''
def onecmd(self, line):
"""Interpret the argument as though it had been typed in response
to the prompt.
This may be overridden, but should not normally need to be;
see the precmd() and postcmd() methods for useful execution hooks.
The return value is a flag indicating whether interpretation of
commands by the interpreter should stop.
"""
command, args = self.extractCommand(line)
statement = ' '.join([command, args])
if command in self.multilineCommands:
statement = self.finishStatement(statement)
statekeeper = None
stop = 0
statement, redirect, mode = self.parseRedirectors(statement)
if redirect == self._TO_PASTE_BUFFER:
try:
clipcontents = getPasteBuffer()
if mode in ('w', 'a'):
statekeeper = Statekeeper(self, ('stdout',))
self.stdout = tempfile.TemporaryFile()
if mode == 'a':
self.stdout.write(clipcontents)
else:
statement = '%s %s' % (statement, clipcontents)
except OSError, e:
print e
return 0
elif redirect:
if mode in ('w','a'):
statekeeper = Statekeeper(self, ('stdout',))
self.stdout = open(redirect, mode)
else:
statement = '%s %s' % (statement, self.fileimport(statement=statement, source=redirect))
stop = cmd.Cmd.onecmd(self, statement)
try:
if command not in self.excludeFromHistory:
self.history.append(statement)
finally:
if statekeeper:
if redirect == self._TO_PASTE_BUFFER:
self.stdout.seek(0)
writeToPasteBuffer(self.stdout.read())
self.stdout.close()
statekeeper.restore()
return stop
statementEndPattern = re.compile(r'[%s]\s*$' % terminators)
def statementHasEnded(self, lines):
#import pdb; pdb.set_trace()
return bool(self.statementEndPattern.search(lines)) \
or lines[-3:] == 'EOF' \
or self.parseRedirectors(lines)[1]
def finishStatement(self, firstline):
statement = firstline
while not self.statementHasEnded(statement):
inp = self.pseudo_raw_input(self.continuationPrompt)
statement = '%s\n%s' % (statement, inp)
return statement
# assembling a list of lines and joining them at the end would be faster,
# but statementHasEnded needs a string arg; anyway, we're getting
# user input and users are slow.
def pseudo_raw_input(self, prompt):
"""copied from cmd's cmdloop; like raw_input, but accounts for changed stdin, stdout"""
if self.use_rawinput:
try:
line = raw_input(prompt)
except EOFError:
line = 'EOF'
else:
self.stdout.write(prompt)
self.stdout.flush()
line = self.stdin.readline()
if not len(line):
line = 'EOF'
else:
if line[-1] == '\n': # this was always true in Cmd
line = line[:-1]
return line
def cmdloop(self, intro=None):
"""Repeatedly issue a prompt, accept input, parse an initial prefix
off the received input, and dispatch to action methods, passing them
the remainder of the line as argument.
"""
# An almost perfect copy from Cmd; however, the pseudo_raw_input portion
# has been split out so that it can be called separately
self.preloop()
if self.use_rawinput and self.completekey:
try:
import readline
self.old_completer = readline.get_completer()
readline.set_completer(self.complete)
readline.parse_and_bind(self.completekey+": complete")
except ImportError:
pass
try:
if intro is not None:
self.intro = intro
if self.intro:
self.stdout.write(str(self.intro)+"\n")
stop = None
while not stop:
if self.cmdqueue:
line = self.cmdqueue.pop(0)
else:
line = self.pseudo_raw_input(self.prompt)
line = self.precmd(line)
stop = self.onecmd(line)
stop = self.postcmd(stop, line)
self.postloop()
finally:
if self.use_rawinput and self.completekey:
try:
import readline
readline.set_completer(self.old_completer)
except ImportError:
pass
def do_EOF(self, arg):
return True
do_eof = do_EOF
def clean(self, s):
"""cleans up a string"""
if self.caseInsensitive:
return s.strip().lower()
return s.strip()
def parseline(self, line):
"""Parse the line into a command name and a string containing
the arguments. Returns a tuple containing (command, args, line).
'command' and 'args' may be None if the line couldn't be parsed.
"""
line = line.strip()
if not line:
return None, None, line
shortcut = self.shortcuts.get(line[0])
if shortcut and hasattr(self, 'do_%s' % shortcut):
line = '%s %s' % (shortcut, line[1:])
i, n = 0, len(line)
while i < n and line[i] in self.identchars: i = i+1
cmd, arg = line[:i], line[i:].strip().strip(self.terminators)
return cmd, arg, line
def showParam(self, param):
param = self.clean(param)
if param in self.settable:
val = getattr(self, param)
self.stdout.write('%s: %s\n' % (param, str(getattr(self, param))))
def do_quit(self, arg):
return 1
do_exit = do_quit
do_q = do_quit
def do_show(self, arg):
'Shows value of a parameter'
if arg.strip():
self.showParam(arg)
else:
for param in self.settable:
self.showParam(param)
def do_set(self, arg):
'Sets a parameter'
try:
paramName, val = arg.split(None, 1)
paramName = self.clean(paramName)
if paramName not in self.settable:
raise NotSettableError
currentVal = getattr(self, paramName)
val = cast(currentVal, val.strip(self.terminators))
setattr(self, paramName, val)
self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
except (ValueError, AttributeError, NotSettableError), e:
self.do_show(arg)
def do_shell(self, arg):
'execute a command as if at the OS prompt.'
os.system(arg)
def do_history(self, arg):
"""history [arg]: lists past commands issued
no arg -> list all
arg is integer -> list one history item, by index
arg is string -> string search
arg is /enclosed in forward-slashes/ -> regular expression search
"""
if arg:
history = self.history.get(arg)
else:
history = self.history
for hi in history:
self.stdout.write(hi.pr())
def last_matching(self, arg):
try:
if arg:
return self.history.get(arg)[-1]
else:
return self.history[-1]
except:
return None
def do_list(self, arg):
"""list [arg]: lists last command issued
no arg -> list absolute last
arg is integer -> list one history item, by index
- arg, arg - (integer) -> list up to or after #arg
arg is string -> list last command matching string search
arg is /enclosed in forward-slashes/ -> regular expression search
"""
try:
self.stdout.write(self.last_matching(arg).pr())
except:
pass
do_hi = do_history
do_l = do_list
do_li = do_list
def do_ed(self, arg):
"""ed: edit most recent command in text editor
ed [N]: edit numbered command from history
ed [filename]: edit specified file name
commands are run after editor is closed.
"set edit (program-name)" or set EDITOR environment variable
to control which editing program is used."""
if not self.editor:
print "please use 'set editor' to specify your text editing program of choice."
return
filename = self.defaultFileName
buffer = ''
try:
arg = int(arg)
buffer = self.last_matching(arg)
except:
if arg:
filename = arg
else:
buffer = self.last_matching(arg)
if buffer:
f = open(filename, 'w')
f.write(buffer or '')
f.close()
os.system('%s %s' % (self.editor, filename))
self.do_load(filename)
do_edit = do_ed
def do_save(self, fname=None):
"""Saves most recent command to a file."""
if fname is None:
fname = self.defaultFileName
try:
f = open(fname, 'w')
f.write(self.history[-1])
f.close()
except Exception, e:
print 'Error saving %s: %s' % (fname, str(e))
def do_load(self, fname=None):
"""Runs command(s) from a file."""
if fname is None:
fname = self.defaultFileName
keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuationPrompt'))
try:
self.stdin = open(fname, 'r')
except IOError, e:
try:
self.stdin = open('%s.%s' % (fname, self.defaultExtension), 'r')
except IOError:
print 'Problem opening file %s: \n%s' % (fname, e)
keepstate.restore()
return
self.use_rawinput = False
self.prompt = self.continuationPrompt = ''
self.cmdloop()
self.stdin.close()
keepstate.restore()
self.lastcmd = ''
def do_run(self, arg):
"""run [arg]: re-runs an earlier command
no arg -> run most recent command
arg is integer -> run one history item, by index
arg is string -> run most recent command by string search
arg is /enclosed in forward-slashes/ -> run most recent by regex
"""
'run [N]: runs the SQL that was run N commands ago'
runme = self.last_matching(arg)
print runme
if runme:
runme = self.precmd(runme)
stop = self.onecmd(runme)
stop = self.postcmd(stop, runme)
do_r = do_run
def fileimport(self, statement, source):
try:
f = open(source)
except IOError:
self.stdout.write("Couldn't read from file %s\n" % source)
return ''
data = f.read()
f.close()
return data
class HistoryItem(str):
def __init__(self, instr):
str.__init__(self, instr)
self.lowercase = self.lower()
self.idx = None
def pr(self):
return '-------------------------[%d]\n%s\n' % (self.idx, str(self))
class History(list):
rangeFrom = re.compile(r'^([\d])+\s*\-$')
def append(self, new):
new = HistoryItem(new)
list.append(self, new)
new.idx = len(self)
def extend(self, new):
for n in new:
self.append(n)
def get(self, getme):
try:
getme = int(getme)
if getme < 0:
return self[:(-1 * getme)]
else:
return [self[getme-1]]
except IndexError:
return []
except (ValueError, TypeError):
getme = getme.strip()
mtch = self.rangeFrom.search(getme)
if mtch:
return self[(int(mtch.group(1))-1):]
if getme.startswith(r'/') and getme.endswith(r'/'):
finder = re.compile(getme[1:-1], re.DOTALL | re.MULTILINE | re.IGNORECASE)
def isin(hi):
return finder.search(hi)
else:
def isin(hi):
return (getme.lower() in hi.lowercase)
return [itm for itm in self if isin(itm)]
class NotSettableError(Exception):
pass
def cast(current, new):
"""Tries to force a new value into the same type as the current."""
typ = type(current)
if typ == bool:
try:
return bool(int(new))
except ValueError, TypeError:
pass
try:
new = new.lower()
except:
pass
if (new=='on') or (new[0] in ('y','t')):
return True
if (new=='off') or (new[0] in ('n','f')):
return False
else:
try:
return typ(new)
except:
pass
print "Problem setting parameter (now %s) to %s; incorrect type?" % (current, new)
return current
class Statekeeper(object):
def __init__(self, obj, attribs):
self.obj = obj
self.attribs = attribs
self.save()
def save(self):
for attrib in self.attribs:
setattr(self, attrib, getattr(self.obj, attrib))
def restore(self):
for attrib in self.attribs:
setattr(self.obj, attrib, getattr(self, attrib))
|