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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
|
"""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
Optional _onchange_{paramname} called when environment parameter changes
Parsing commands with `optparse` options (flags)
Redirection to file with >, >>; input from file with <
Easy transcript-based testing of applications (see example/example.py)
Note that redirection with > and | will only work if `self.stdout.write()`
is used in place of `print`. The standard library's `cmd` module is
written to use `self.stdout.write()`,
- Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
mercurial repository at http://www.assembla.com/wiki/show/python-cmd2
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, pyparsing, doctest
import unittest, string, datetime
from optparse import make_option
__version__ = '0.4.8'
class OptionParser(optparse.OptionParser):
def exit(self, status=0, msg=None):
self.values._exit = True
if msg:
print msg
def print_help(self, *args, **kwargs):
# now, I need to call help of the calling function. Hmm.
try:
print self._func.__doc__
except AttributeError:
pass
optparse.OptionParser.print_help(self, *args, **kwargs)
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.
"""
raise
def remainingArgs(oldArgs, newArgList):
'''
>>> remainingArgs('-f bar bar cow', ['bar', 'cow'])
'bar cow'
'''
pattern = '\s+'.join(re.escape(a) for a in newArgList) + '\s*$'
matchObj = re.search(pattern, oldArgs)
return oldArgs[matchObj.start():]
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_'))
optionParser._func = func
def newFunc(instance, arg):
try:
opts, newArgList = optionParser.parse_args(arg.split()) # doesn't understand quoted strings shouldn't be dissected!
newArgs = remainingArgs(arg, newArgList) # should it permit flags after args?
except (optparse.OptionValueError, optparse.BadOptionError,
optparse.OptionError, optparse.AmbiguousOptionError,
optparse.OptionConflictError), e:
print e
optionParser.print_help()
return
if hasattr(opts, '_exit'):
return None
if hasattr(arg, 'parser'):
terminator = arg.parsed.terminator
try:
if arg.parsed.terminator[0] == '\n':
terminator = arg.parsed.terminator[0]
except IndexError:
pass
arg = arg.parser('%s %s%s%s' % (arg.parsed.command, newArgs,
terminator, arg.parsed.suffix))
else:
arg = newArgs
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(*args):
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.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
xclipproc.stdin.write(teststring)
xclipproc.stdin.close()
xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
if xclipproc.stdout.read() == teststring:
can_clip = True
except (subprocess.CalledProcessError, OSError, IOError):
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()
# but we want it in both the "primary" and "mouse" clipboards
xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
xclipproc.stdin.write(txt)
xclipproc.stdin.close()
else:
def getPasteBuffer(*args):
raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"')
setPasteBuffer = getPasteBuffer
writeToPasteBuffer = getPasteBuffer
pyparsing.ParserElement.setDefaultWhitespaceChars(' \t')
class ParsedString(str):
pass
class SkipToLast(pyparsing.SkipTo):
def parseImpl( self, instring, loc, doActions=True ):
resultStore = []
startLoc = loc
instrlen = len(instring)
expr = self.expr
failParse = False
while loc <= instrlen:
try:
if self.failOn:
failParse = True
self.failOn.tryParse(instring, loc)
failParse = False
loc = expr._skipIgnorables( instring, loc )
expr._parse( instring, loc, doActions=False, callPreParse=False )
skipText = instring[startLoc:loc]
if self.includeMatch:
loc,mat = expr._parse(instring,loc,doActions,callPreParse=False)
if mat:
skipRes = ParseResults( skipText )
skipRes += mat
resultStore.append((loc, [ skipRes ]))
else:
resultStore,append((loc, [ skipText ]))
else:
resultStore.append((loc, [ skipText ]))
loc += 1
except (pyparsing.ParseException,IndexError):
if failParse:
raise
else:
loc += 1
if resultStore:
return resultStore[-1]
else:
exc = self.myException
exc.loc = loc
exc.pstr = instring
raise exc
def replace_with_file_contents(fname):
if fname:
try:
result = open(os.path.expanduser(fname[0])).read()
except IOError:
result = '< %s' % fname[0] # wasn't a file after all
else:
result = getPasteBuffer()
return result
class Cmd(cmd.Cmd):
echo = False
case_insensitive = True
continuation_prompt = '> '
timing = False
legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit # make sure your terminators are not in here!
shortcuts = {'?': 'help', '!': 'shell', '@': 'load' }
excludeFromHistory = '''run r list l history hi ed edit li eof'''.split()
noSpecialParse = 'set ed edit exit'.split()
defaultExtension = 'txt'
default_file_name = 'command.txt'
settable = ['prompt', 'continuation_prompt', 'default_file_name', 'editor', 'case_insensitive',
'echo', 'timing']
settable.sort()
editor = os.environ.get('EDITOR')
_STOP_AND_EXIT = 2
if not editor:
if sys.platform[:3] == 'win':
editor = 'notepad'
else:
for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
if not os.system('which %s' % (editor)):
break
def do_cmdenvironment(self, args):
'''Summary report of interactive parameters.'''
self.stdout.write("""
Commands are %(casesensitive)scase-sensitive.
Commands may be terminated with: %(terminators)s
Settable parameters: %(settable)s
""" %
{ 'casesensitive': (self.case_insensitive and 'not ') or '',
'terminators': str(self.terminators),
'settable': ' '.join(self.settable)
})
def do_help(self, arg):
try:
fn = getattr(self, 'do_' + arg)
if fn and fn.optionParser:
fn.optionParser.print_help(file=self.stdout)
return
except AttributeError:
pass
cmd.Cmd.do_help(self, arg)
def __init__(self, *args, **kwargs):
cmd.Cmd.__init__(self, *args, **kwargs)
self.history = History()
self._init_parser()
self.pystate = {}
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))
prefixParser = pyparsing.Empty()
commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment])
commentGrammars.addParseAction(lambda x: '')
commentInProgress = pyparsing.Literal('/*') + pyparsing.SkipTo(pyparsing.stringEnd)
terminators = [';']
blankLinesAllowed = False
multilineCommands = []
def _init_parser(self):
r'''
>>> c = Cmd()
>>> c.multilineCommands = ['multiline']
>>> c.case_insensitive = True
>>> c._init_parser()
>>> print c.parser.parseString('').dump()
[]
>>> print c.parser.parseString('/* empty command */').dump()
[]
>>> print c.parser.parseString('plainword').dump()
['plainword', '']
- command: plainword
- statement: ['plainword', '']
- command: plainword
>>> print c.parser.parseString('termbare;').dump()
['termbare', '', ';', '']
- command: termbare
- statement: ['termbare', '', ';']
- command: termbare
- terminator: ;
- terminator: ;
>>> print c.parser.parseString('termbare; suffx').dump()
['termbare', '', ';', 'suffx']
- command: termbare
- statement: ['termbare', '', ';']
- command: termbare
- terminator: ;
- suffix: suffx
- terminator: ;
>>> print c.parser.parseString('barecommand').dump()
['barecommand', '']
- command: barecommand
- statement: ['barecommand', '']
- command: barecommand
>>> print c.parser.parseString('COMmand with args').dump()
['command', 'with args']
- args: with args
- command: command
- statement: ['command', 'with args']
- args: with args
- command: command
>>> print c.parser.parseString('command with args and terminator; and suffix').dump()
['command', 'with args and terminator', ';', 'and suffix']
- args: with args and terminator
- command: command
- statement: ['command', 'with args and terminator', ';']
- args: with args and terminator
- command: command
- terminator: ;
- suffix: and suffix
- terminator: ;
>>> print c.parser.parseString('simple | piped').dump()
['simple', '', '|', ' piped']
- command: simple
- pipeTo: piped
- statement: ['simple', '']
- command: simple
>>> print c.parser.parseString('double-pipe || is not a pipe').dump()
['double', '-pipe || is not a pipe']
- args: -pipe || is not a pipe
- command: double
- statement: ['double', '-pipe || is not a pipe']
- args: -pipe || is not a pipe
- command: double
>>> print c.parser.parseString('command with args, terminator;sufx | piped').dump()
['command', 'with args, terminator', ';', 'sufx', '|', ' piped']
- args: with args, terminator
- command: command
- pipeTo: piped
- statement: ['command', 'with args, terminator', ';']
- args: with args, terminator
- command: command
- terminator: ;
- suffix: sufx
- terminator: ;
>>> print c.parser.parseString('output into > afile.txt').dump()
['output', 'into', '>', 'afile.txt']
- args: into
- command: output
- output: >
- outputTo: afile.txt
- statement: ['output', 'into']
- args: into
- command: output
>>> print c.parser.parseString('output into;sufx | pipethrume plz > afile.txt').dump()
['output', 'into', ';', 'sufx', '|', ' pipethrume plz', '>', 'afile.txt']
- args: into
- command: output
- output: >
- outputTo: afile.txt
- pipeTo: pipethrume plz
- statement: ['output', 'into', ';']
- args: into
- command: output
- terminator: ;
- suffix: sufx
- terminator: ;
>>> print c.parser.parseString('output to paste buffer >> ').dump()
['output', 'to paste buffer', '>>', '']
- args: to paste buffer
- command: output
- output: >>
- statement: ['output', 'to paste buffer']
- args: to paste buffer
- command: output
>>> print c.parser.parseString('ignore the /* commented | > */ stuff;').dump()
['ignore', 'the /* commented | > */ stuff', ';', '']
- args: the /* commented | > */ stuff
- command: ignore
- statement: ['ignore', 'the /* commented | > */ stuff', ';']
- args: the /* commented | > */ stuff
- command: ignore
- terminator: ;
- terminator: ;
>>> print c.parser.parseString('has > inside;').dump()
['has', '> inside', ';', '']
- args: > inside
- command: has
- statement: ['has', '> inside', ';']
- args: > inside
- command: has
- terminator: ;
- terminator: ;
>>> print c.parser.parseString('multiline has > inside an unfinished command').dump()
['multiline', ' has > inside an unfinished command']
- multilineCommand: multiline
>>> print c.parser.parseString('multiline has > inside;').dump()
['multiline', 'has > inside', ';', '']
- args: has > inside
- multilineCommand: multiline
- statement: ['multiline', 'has > inside', ';']
- args: has > inside
- multilineCommand: multiline
- terminator: ;
- terminator: ;
>>> print c.parser.parseString('multiline command /* with comment in progress;').dump()
['multiline', ' command /* with comment in progress;']
- multilineCommand: multiline
>>> print c.parser.parseString('multiline command /* with comment complete */ is done;').dump()
['multiline', 'command /* with comment complete */ is done', ';', '']
- args: command /* with comment complete */ is done
- multilineCommand: multiline
- statement: ['multiline', 'command /* with comment complete */ is done', ';']
- args: command /* with comment complete */ is done
- multilineCommand: multiline
- terminator: ;
- terminator: ;
>>> print c.parser.parseString('multiline command ends\n\n').dump()
['multiline', 'command ends', '\n', '\n']
- args: command ends
- multilineCommand: multiline
- statement: ['multiline', 'command ends', '\n', '\n']
- args: command ends
- multilineCommand: multiline
- terminator: ['\n', '\n']
- terminator: ['\n', '\n']
'''
outputParser = (pyparsing.Literal('>>') | (pyparsing.WordStart() + '>') | pyparsing.Regex('[^=]>'))('output')
terminatorParser = pyparsing.Or([(hasattr(t, 'parseString') and t) or pyparsing.Literal(t) for t in self.terminators])('terminator')
stringEnd = pyparsing.stringEnd ^ '\nEOF'
self.multilineCommand = pyparsing.Or([pyparsing.Keyword(c, caseless=self.case_insensitive) for c in self.multilineCommands])('multilineCommand')
oneLineCommand = (~self.multilineCommand + pyparsing.Word(self.legalChars))('command')
pipe = pyparsing.Keyword('|', identChars='|')
self.commentGrammars.ignore(pyparsing.quotedString).setParseAction(lambda x: '')
self.commentInProgress.ignore(pyparsing.quotedString).ignore(pyparsing.cStyleComment)
afterElements = \
pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \
pyparsing.Optional(outputParser + pyparsing.SkipTo(stringEnd).setParseAction(lambda x: x[0].strip())('outputTo'))
if self.case_insensitive:
self.multilineCommand.setParseAction(lambda x: x[0].lower())
oneLineCommand.setParseAction(lambda x: x[0].lower())
if self.blankLinesAllowed:
self.blankLineTerminationParser = pyparsing.NoMatch
else:
self.blankLineTerminator = (pyparsing.lineEnd + pyparsing.lineEnd)('terminator')
self.blankLineTerminator.setResultsName('terminator')
self.blankLineTerminationParser = ((self.multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(self.blankLineTerminator).setParseAction(lambda x: x[0].strip())('args') + self.blankLineTerminator)('statement')
self.multilineParser = (((self.multilineCommand ^ oneLineCommand) + SkipToLast(terminatorParser).setParseAction(lambda x: x[0].strip())('args') + terminatorParser)('statement') +
pyparsing.SkipTo(outputParser ^ pipe ^ stringEnd).setParseAction(lambda x: x[0].strip())('suffix') + afterElements)
self.singleLineParser = ((oneLineCommand + pyparsing.SkipTo(terminatorParser ^ stringEnd ^ pipe ^ outputParser).setParseAction(lambda x:x[0].strip())('args'))('statement') +
pyparsing.Optional(terminatorParser) + afterElements)
#self.multilineParser = self.multilineParser.setResultsName('multilineParser')
#self.singleLineParser = self.singleLineParser.setResultsName('singleLineParser')
#self.blankLineTerminationParser = self.blankLineTerminationParser.setResultsName('blankLineTerminatorParser')
self.parser = (
stringEnd |
self.prefixParser + self.multilineParser |
self.prefixParser + self.singleLineParser |
self.prefixParser + self.blankLineTerminationParser |
self.prefixParser + self.multilineCommand + pyparsing.SkipTo(stringEnd)
)
self.parser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
inputMark = pyparsing.Literal('<')
inputMark.setParseAction(lambda x: '')
fileName = pyparsing.Word(self.legalChars + '/\\')
inputFrom = fileName('inputFrom')
inputFrom.setParseAction(replace_with_file_contents)
# a not-entirely-satisfactory way of distinguishing < as in "import from" from <
# as in "lesser than"
self.inputParser = inputMark + pyparsing.Optional(inputFrom) + pyparsing.Optional('>') + \
pyparsing.Optional(fileName) + (pyparsing.stringEnd | '|')
self.inputParser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
def preparse(self, raw, **kwargs):
return raw
def parsed(self, raw, **kwargs):
if isinstance(raw, ParsedString):
p = raw
else:
raw = self.preparse(raw, **kwargs)
s = self.inputParser.transformString(raw.lstrip())
for (shortcut, expansion) in self.shortcuts.items():
if s.lower().startswith(shortcut):
s = s.replace(shortcut, expansion + ' ', 1)
break
result = self.parser.parseString(s)
result['command'] = result.multilineCommand or result.command
result['raw'] = raw
result['clean'] = self.commentGrammars.transformString(result.args)
result['expanded'] = s
p = ParsedString(result.clean)
p.parsed = result
p.parser = self.parsed
for (key, val) in kwargs.items():
p.parsed[key] = val
return p
def postparsing_precmd(self, statement):
stop = 0
return stop, statement
def postparsing_postcmd(self, stop):
return stop
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.
This (`cmd2`) version of `onecmd` already override's `cmd`'s `onecmd`.
"""
if not line:
return self.emptyline()
if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line):
return 0 # command was empty except for comments
try:
statement = self.parsed(line)
while statement.parsed.multilineCommand and (statement.parsed.terminator == ''):
statement = '%s\n%s' % (statement.parsed.raw,
self.pseudo_raw_input(self.continuation_prompt))
statement = self.parsed(statement)
except Exception, e:
print e
return 0
try:
(stop, statement) = self.postparsing_precmd(statement)
except Exception, e:
print str(e)
return 0
if stop:
return self.postparsing_postcmd(stop)
if not statement.parsed.command:
return self.postparsing_postcmd(stop=0)
statekeeper = None
if statement.parsed.pipeTo:
redirect = subprocess.Popen(statement.parsed.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
statekeeper = Statekeeper(self, ('stdout',))
self.stdout = redirect.stdin
elif statement.parsed.output:
statekeeper = Statekeeper(self, ('stdout',))
if statement.parsed.outputTo:
mode = 'w'
if statement.parsed.output == '>>':
mode = 'a'
try:
self.stdout = open(os.path.expanduser(statement.parsed.outputTo), mode)
except OSError, e:
print e
return self.postparsing_postcmd(stop=0)
else:
statekeeper = Statekeeper(self, ('stdout',))
self.stdout = tempfile.TemporaryFile()
if statement.parsed.output == '>>':
self.stdout.write(getPasteBuffer())
try:
# "heart" of the command, replace's cmd's onecmd()
self.lastcmd = statement.parsed.expanded
try:
func = getattr(self, 'do_' + statement.parsed.command)
except AttributeError:
return self.postparsing_postcmd(self.default(statement))
timestart = datetime.datetime.now()
stop = func(statement)
if self.timing:
print 'Elapsed: %s' % str(datetime.datetime.now() - timestart)
except Exception, e:
print e
try:
if statement.parsed.command not in self.excludeFromHistory:
self.history.append(statement.parsed.raw)
finally:
if statekeeper:
if statement.parsed.output and not statement.parsed.outputTo:
self.stdout.seek(0)
try:
writeToPasteBuffer(self.stdout.read())
except Exception, e:
print str(e)
elif statement.parsed.pipeTo:
for result in redirect.communicate():
statekeeper.stdout.write(result or '')
self.stdout.close()
statekeeper.restore()
return self.postparsing_postcmd(stop)
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)
if (self.echo) and (isinstance(self.stdin, file)):
self.stdout.write(line + '\n')
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
return stop
def do_EOF(self, arg):
return True
do_eof = do_EOF
def showParam(self, param):
any_shown = False
param = param.strip().lower()
for p in self.settable:
if p.startswith(param):
val = getattr(self, p)
self.stdout.write('%s: %s\n' % (p, str(getattr(self, p))))
any_shown = True
if not any_shown:
print "Parameter '%s' not supported (type 'show' for list of parameters)." % param
def do_quit(self, arg):
return self._STOP_AND_EXIT
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 cmd2 parameter. Accepts abbreviated parameter names so long as there is no ambiguity.
Call without arguments for a list of settable parameters with their values.'''
try:
paramName, val = arg.split(None, 1)
paramName = paramName.strip().lower()
hits = [paramName in p for p in self.settable]
if hits.count(True) == 1:
paramName = self.settable[hits.index(True)]
currentVal = getattr(self, paramName)
if (val[0] == val[-1]) and val[0] in ("'", '"'):
val = val[1:-1]
else:
val = cast(currentVal, val)
setattr(self, paramName, val)
self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
if currentVal != val:
try:
onchange_hook = getattr(self, '_onchange_%s' % paramName)
onchange_hook(old=currentVal, new=val)
except AttributeError:
pass
else:
self.do_show(paramName)
except (ValueError, AttributeError, NotSettableError), e:
self.do_show(arg)
def do_pause(self, arg):
'Displays the specified text then waits for the user to press RETURN.'
raw_input(arg + '\n')
def do_shell(self, arg):
'execute a command as if at the OS prompt.'
os.system(arg)
def do_py(self, arg):
'''Executes a python command'''
if arg.strip():
try:
result = eval(arg, self.pystate)
if result is None:
exec(arg, self.pystate)
else:
print result
except Exception, e:
print e
else:
print 'Now accepting python commands; end with `\\py`'
buffer = [self.pseudo_raw_input('>>> ')]
while not buffer[-1].strip().startswith('\\py'):
try:
buf = '\n'.join(buffer)
result = eval(buf, self.pystate)
if result is None:
exec(buf, self.pystate)
else:
print result
buffer = [self.pseudo_raw_input('>>> ')]
except SyntaxError:
buffer.append(self.pseudo_raw_input('... '))
except Exception, e:
print e
buffer = [self.pseudo_raw_input('>>> ')]
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 IndexError:
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.default_file_name
if arg:
try:
buffer = self.last_matching(int(arg))
except ValueError:
filename = arg
buffer = ''
else:
buffer = self.history[-1]
if buffer:
f = open(os.path.expanduser(filename), 'w')
f.write(buffer or '')
f.close()
os.system('%s %s' % (self.editor, filename))
self.do__load(filename)
do_edit = do_ed
saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") +
pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") +
pyparsing.stringEnd)
def do_save(self, arg):
"""`save [N] [filename.ext]`
Saves command from history to file.
N => Number of command (from history), or `*`;
most recent command if omitted"""
try:
args = self.saveparser.parseString(arg)
except pyparsing.ParseException:
print self.do_save.__doc__
return
fname = args.fname or self.default_file_name
if args.idx == '*':
saveme = '\n\n'.join(self.history[:])
elif args.idx:
saveme = self.history[int(args.idx)-1]
else:
saveme = self.history[-1]
try:
f = open(os.path.expanduser(fname), 'w')
f.write(saveme)
f.close()
print 'Saved to %s' % (fname)
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.default_file_name
fname = os.path.expanduser(fname)
keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuation_prompt'))
if isinstance(fname, file):
self.stdin = fname
else:
try:
self.stdin = open(os.path.expanduser(fname), 'r')
except IOError, e:
try:
self.stdin = open('%s.%s' % (os.path.expanduser(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.continuation_prompt = ''
stop = self.cmdloop()
self.stdin.close()
keepstate.restore()
self.lastcmd = ''
return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT
do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython
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(os.path.expanduser(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)
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))
class Borg(object):
'''All instances of any Borg subclass will share state.
from Python Cookbook, 2nd Ed., recipe 6.16'''
_shared_state = {}
def __new__(cls, *a, **k):
obj = object.__new__(cls, *a, **k)
obj.__dict__ = cls._shared_state
return obj
class OutputTrap(Borg):
'''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing.
Call `tearDown()` to return to normal output.'''
def __init__(self):
self.old_stdout = sys.stdout
self.trap = tempfile.TemporaryFile()
sys.stdout = self.trap
def read(self):
self.trap.seek(0)
result = self.trap.read()
self.trap.truncate(0)
return result.strip('\x00')
def tearDown(self):
sys.stdout = self.old_stdout
class Cmd2TestCase(unittest.TestCase):
'''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class
that will execute the commands in transcriptFileName and expect the results shown.
See example.py'''
CmdApp = None
transcriptFileName = ''
def setUp(self):
if self.CmdApp:
self.outputTrap = OutputTrap()
self.cmdapp = self.CmdApp()
try:
tfile = open(os.path.expanduser(self.transcriptFileName))
self.transcript = iter(tfile.readlines())
tfile.close()
except IOError:
self.transcript = []
def assertEqualEnough(self, got, expected, message):
got = got.strip().splitlines()
expected = expected.strip().splitlines()
self.assertEqual(len(got), len(expected), message)
for (linegot, lineexpected) in zip(got, expected):
matchme = re.escape(lineexpected.strip()).replace('\\*', '.*'). \
replace('\\ ', ' ')
self.assert_(re.match(matchme, linegot.strip()), message)
def testall(self):
if self.CmdApp:
lineNum = 0
try:
line = self.transcript.next()
while True:
while not line.startswith(self.cmdapp.prompt):
line = self.transcript.next()
command = [line[len(self.cmdapp.prompt):]]
line = self.transcript.next()
while line.startswith(self.cmdapp.continuation_prompt):
command.append(line[len(self.cmdapp.continuation_prompt):])
line = self.transcript.next()
command = ''.join(command)
self.cmdapp.onecmd(command)
result = self.outputTrap.read()
if line.startswith(self.cmdapp.prompt):
self.assertEqualEnough(result.strip(), '',
'\nFile %s, line %d\nCommand was:\n%s\nExpected: (nothing) \nGot:\n%s\n' %
(self.transcriptFileName, lineNum, command, result))
continue
expected = []
while not line.startswith(self.cmdapp.prompt):
expected.append(line)
line = self.transcript.next()
expected = ''.join(expected)
self.assertEqualEnough(expected.strip(), result.strip(),
'\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' %
(self.transcriptFileName, lineNum, command, expected, result))
# this needs to account for a line-by-line strip()ping
except StopIteration:
pass
# catch the final output?
def tearDown(self):
if self.CmdApp:
self.outputTrap.tearDown()
if __name__ == '__main__':
doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE)
#c = Cmd()
|