- bump version to 0.130.1
[opensuse:osc.git] / osc / cmdln.py
1 # Copyright (c) 2002-2005 ActiveState Corp.
2 # License: MIT (see LICENSE.txt for license details)
3 # Author:  Trent Mick (TrentM@ActiveState.com)
4 # Home:    http://trentm.com/projects/cmdln/
5
6 """An improvement on Python's standard cmd.py module.
7
8 As with cmd.py, this module provides "a simple framework for writing
9 line-oriented command intepreters."  This module provides a 'RawCmdln'
10 class that fixes some design flaws in cmd.Cmd, making it more scalable
11 and nicer to use for good 'cvs'- or 'svn'-style command line interfaces
12 or simple shells.  And it provides a 'Cmdln' class that add
13 optparse-based option processing. Basically you use it like this:
14
15     import cmdln
16
17     class MySVN(cmdln.Cmdln):
18         name = "svn"
19
20         @cmdln.alias('stat', 'st')
21         @cmdln.option('-v', '--verbose', action='store_true'
22                       help='print verbose information')
23         def do_status(self, subcmd, opts, *paths):
24             print "handle 'svn status' command"
25
26         #...
27
28     if __name__ == "__main__":
29         shell = MySVN()
30         retval = shell.main()
31         sys.exit(retval)
32
33 See the README.txt or <http://trentm.com/projects/cmdln/> for more
34 details.
35 """
36
37 __revision__ = "$Id: cmdln.py 1666 2007-05-09 03:13:03Z trentm $"
38 __version_info__ = (1, 0, 0)
39 __version__ = '.'.join(map(str, __version_info__))
40
41 import os
42 import re
43 import cmd
44 import optparse
45 from pprint import pprint
46 from datetime import date
47
48
49
50
51 #---- globals
52
53 LOOP_ALWAYS, LOOP_NEVER, LOOP_IF_EMPTY = range(3)
54
55 # An unspecified optional argument when None is a meaningful value.
56 _NOT_SPECIFIED = ("Not", "Specified")
57
58 # Pattern to match a TypeError message from a call that
59 # failed because of incorrect number of arguments (see
60 # Python/getargs.c).
61 _INCORRECT_NUM_ARGS_RE = re.compile(
62     r"(takes [\w ]+ )(\d+)( arguments? \()(\d+)( given\))")
63
64 # Static bits of man page
65 MAN_HEADER = r""".TH %(ucname)s "1" "%(date)s" "%(name)s %(version)s" "User Commands"
66 .SH NAME
67 %(name)s \- Program to do useful things.
68 .SH SYNOPSIS
69 .B %(name)s
70 [\fIGLOBALOPTS\fR] \fISUBCOMMAND \fR[\fIOPTS\fR] [\fIARGS\fR...]
71 .br
72 .B %(name)s
73 \fIhelp SUBCOMMAND\fR
74 .SH DESCRIPTION
75 """
76 MAN_COMMANDS_HEADER = r"""
77 .SS COMMANDS
78 """
79 MAN_OPTIONS_HEADER = r"""
80 .SS GLOBAL OPTIONS
81 """
82 MAN_FOOTER = r"""
83 .SH AUTHOR
84 This man page is automatically generated.
85 """
86
87 #---- exceptions
88
89 class CmdlnError(Exception):
90     """A cmdln.py usage error."""
91     def __init__(self, msg):
92         self.msg = msg
93     def __str__(self):
94         return self.msg
95
96 class CmdlnUserError(Exception):
97     """An error by a user of a cmdln-based tool/shell."""
98     pass
99
100
101
102 #---- public methods and classes
103
104 def alias(*aliases):
105     """Decorator to add aliases for Cmdln.do_* command handlers.
106
107     Example:
108         class MyShell(cmdln.Cmdln):
109             @cmdln.alias("!", "sh")
110             def do_shell(self, argv):
111                 #...implement 'shell' command
112     """
113     def decorate(f):
114         if not hasattr(f, "aliases"):
115             f.aliases = []
116         f.aliases += aliases
117         return f
118     return decorate
119
120 MAN_REPLACES = [
121     (re.compile(r'(^|[ \t\[\'\|])--([^/ \t/,-]*)-([^/ \t/,-]*)-([^/ \t/,-]*)-([^/ \t/,-]*)-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\-\2\-\3\-\4\-\5\-\6'),
122     (re.compile(r'(^|[ \t\[\'\|])--([^/ \t/,-]*)-([^/ \t/,-]*)-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\-\2\-\3\-\4'),
123     (re.compile(r'(^|[ \t\[\'\|])-([^/ \t/,-]*)-([^/ \t/,-]*)-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\2\-\3\-\4'),
124     (re.compile(r'(^|[ \t\[\'\|])--([^/ \t/,-]*)-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\-\2\-\3'),
125     (re.compile(r'(^|[ \t\[\'\|])-([^/ \t/,-]*)-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\2\-\3'),
126     (re.compile(r'(^|[ \t\[\'\|])--([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\-\2'),
127     (re.compile(r'(^|[ \t\[\'\|])-([^/ \t/,\|-]*)(?=$|[ \t=\]\'/,\|])'), r'\1\-\2'),
128     (re.compile(r"^'"), r" '"),
129     ]
130
131 def man_escape(text):
132     '''
133     Escapes text to be included in man page.
134
135     For now it only escapes dashes in command line options.
136     '''
137     for repl in MAN_REPLACES:
138         text = repl[0].sub(repl[1], text)
139     return text
140
141 class RawCmdln(cmd.Cmd):
142     """An improved (on cmd.Cmd) framework for building multi-subcommand
143     scripts (think "svn" & "cvs") and simple shells (think "pdb" and
144     "gdb").
145
146     A simple example:
147
148         import cmdln
149
150         class MySVN(cmdln.RawCmdln):
151             name = "svn"
152
153             @cmdln.aliases('stat', 'st')
154             def do_status(self, argv):
155                 print "handle 'svn status' command"
156
157         if __name__ == "__main__":
158             shell = MySVN()
159             retval = shell.main()
160             sys.exit(retval)
161
162     See <http://trentm.com/projects/cmdln> for more information.
163     """
164     name = None      # if unset, defaults basename(sys.argv[0])
165     prompt = None    # if unset, defaults to self.name+"> "
166     version = None   # if set, default top-level options include --version
167
168     # Default messages for some 'help' command error cases.
169     # They are interpolated with one arg: the command.
170     nohelp = "no help on '%s'"
171     unknowncmd = "unknown command: '%s'"
172
173     helpindent = '' # string with which to indent help output
174
175     # Default man page parts, please change them in subclass
176     man_header = MAN_HEADER
177     man_commands_header = MAN_COMMANDS_HEADER
178     man_options_header = MAN_OPTIONS_HEADER
179     man_footer = MAN_FOOTER
180
181     def __init__(self, completekey='tab',
182                  stdin=None, stdout=None, stderr=None):
183         """Cmdln(completekey='tab', stdin=None, stdout=None, stderr=None)
184
185         The optional argument 'completekey' is the readline name of a
186         completion key; it defaults to the Tab key. If completekey is
187         not None and the readline module is available, command completion
188         is done automatically.
189
190         The optional arguments 'stdin', 'stdout' and 'stderr' specify
191         alternate input, output and error output file objects; if not
192         specified, sys.* are used.
193
194         If 'stdout' but not 'stderr' is specified, stdout is used for
195         error output. This is to provide least surprise for users used
196         to only the 'stdin' and 'stdout' options with cmd.Cmd.
197         """
198         import sys
199         if self.name is None:
200             self.name = os.path.basename(sys.argv[0])
201         if self.prompt is None:
202             self.prompt = self.name+"> "
203         self._name_str = self._str(self.name)
204         self._prompt_str = self._str(self.prompt)
205         if stdin is not None:
206             self.stdin = stdin
207         else:
208             self.stdin = sys.stdin
209         if stdout is not None:
210             self.stdout = stdout
211         else:
212             self.stdout = sys.stdout
213         if stderr is not None:
214             self.stderr = stderr
215         elif stdout is not None:
216             self.stderr = stdout
217         else:
218             self.stderr = sys.stderr
219         self.cmdqueue = []
220         self.completekey = completekey
221         self.cmdlooping = False
222
223     def get_optparser(self):
224         """Hook for subclasses to set the option parser for the
225         top-level command/shell.
226
227         This option parser is used retrieved and used by `.main()' to
228         handle top-level options.
229
230         The default implements a single '-h|--help' option. Sub-classes
231         can return None to have no options at the top-level. Typically
232         an instance of CmdlnOptionParser should be returned.
233         """
234         version = (self.version is not None
235                     and "%s %s" % (self._name_str, self.version)
236                     or None)
237         return CmdlnOptionParser(self, version=version)
238
239     def get_version(self):
240         """
241         Returns version of program. To be replaced in subclass.
242         """
243         return __version__
244
245     def postoptparse(self):
246         """Hook method executed just after `.main()' parses top-level
247         options.
248
249         When called `self.values' holds the results of the option parse.
250         """
251         pass
252
253     def main(self, argv=None, loop=LOOP_NEVER):
254         """A possible mainline handler for a script, like so:
255
256             import cmdln
257             class MyCmd(cmdln.Cmdln):
258                 name = "mycmd"
259                 ...
260
261             if __name__ == "__main__":
262                 MyCmd().main()
263
264         By default this will use sys.argv to issue a single command to
265         'MyCmd', then exit. The 'loop' argument can be use to control
266         interactive shell behaviour.
267
268         Arguments:
269             "argv" (optional, default sys.argv) is the command to run.
270                 It must be a sequence, where the first element is the
271                 command name and subsequent elements the args for that
272                 command.
273             "loop" (optional, default LOOP_NEVER) is a constant
274                 indicating if a command loop should be started (i.e. an
275                 interactive shell). Valid values (constants on this module):
276                     LOOP_ALWAYS     start loop and run "argv", if any
277                     LOOP_NEVER      run "argv" (or .emptyline()) and exit
278                     LOOP_IF_EMPTY   run "argv", if given, and exit;
279                                     otherwise, start loop
280         """
281         if argv is None:
282             import sys
283             argv = sys.argv
284         else:
285             argv = argv[:] # don't modify caller's list
286
287         self.optparser = self.get_optparser()
288         if self.optparser: # i.e. optparser=None means don't process for opts
289             try:
290                 self.options, args = self.optparser.parse_args(argv[1:])
291             except CmdlnUserError, ex:
292                 msg = "%s: %s\nTry '%s help' for info.\n"\
293                       % (self.name, ex, self.name)
294                 self.stderr.write(self._str(msg))
295                 self.stderr.flush()
296                 return 1
297             except StopOptionProcessing, ex:
298                 return 0
299         else:
300             self.options, args = None, argv[1:]
301         self.postoptparse()
302
303         if loop == LOOP_ALWAYS:
304             if args:
305                 self.cmdqueue.append(args)
306             return self.cmdloop()
307         elif loop == LOOP_NEVER:
308             if args:
309                 return self.cmd(args)
310             else:
311                 return self.emptyline()
312         elif loop == LOOP_IF_EMPTY:
313             if args:
314                 return self.cmd(args)
315             else:
316                 return self.cmdloop()
317
318     def cmd(self, argv):
319         """Run one command and exit.
320
321             "argv" is the arglist for the command to run. argv[0] is the
322                 command to run. If argv is an empty list then the
323                 'emptyline' handler is run.
324
325         Returns the return value from the command handler.
326         """
327         assert isinstance(argv, (list, tuple)), \
328                 "'argv' is not a sequence: %r" % argv
329         retval = None
330         try:
331             argv = self.precmd(argv)
332             retval = self.onecmd(argv)
333             self.postcmd(argv)
334         except:
335             if not self.cmdexc(argv):
336                 raise
337             retval = 1
338         return retval
339
340     def _str(self, s):
341         """Safely convert the given str/unicode to a string for printing."""
342         try:
343             return str(s)
344         except UnicodeError:
345             #XXX What is the proper encoding to use here? 'utf-8' seems
346             #    to work better than "getdefaultencoding" (usually
347             #    'ascii'), on OS X at least.
348             #import sys
349             #return s.encode(sys.getdefaultencoding(), "replace")
350             return s.encode("utf-8", "replace")
351
352     def cmdloop(self, intro=None):
353         """Repeatedly issue a prompt, accept input, parse into an argv, and
354         dispatch (via .precmd(), .onecmd() and .postcmd()), passing them
355         the argv. In other words, start a shell.
356
357             "intro" (optional) is a introductory message to print when
358                 starting the command loop. This overrides the class
359                 "intro" attribute, if any.
360         """
361         self.cmdlooping = True
362         self.preloop()
363         if intro is None:
364             intro = self.intro
365         if intro:
366             intro_str = self._str(intro)
367             self.stdout.write(intro_str+'\n')
368         self.stop = False
369         retval = None
370         while not self.stop:
371             if self.cmdqueue:
372                 argv = self.cmdqueue.pop(0)
373                 assert isinstance(argv, (list, tuple)), \
374                         "item on 'cmdqueue' is not a sequence: %r" % argv
375             else:
376                 if self.use_rawinput:
377                     try:
378                         line = raw_input(self._prompt_str)
379                     except EOFError:
380                         line = 'EOF'
381                 else:
382                     self.stdout.write(self._prompt_str)
383                     self.stdout.flush()
384                     line = self.stdin.readline()
385                     if not len(line):
386                         line = 'EOF'
387                     else:
388                         line = line[:-1] # chop '\n'
389                 argv = line2argv(line)
390             try:
391                 argv = self.precmd(argv)
392                 retval = self.onecmd(argv)
393                 self.postcmd(argv)
394             except:
395                 if not self.cmdexc(argv):
396                     raise
397                 retval = 1
398             self.lastretval = retval
399         self.postloop()
400         self.cmdlooping = False
401         return retval
402
403     def precmd(self, argv):
404         """Hook method executed just before the command argv is
405         interpreted, but after the input prompt is generated and issued.
406
407             "argv" is the cmd to run.
408
409         Returns an argv to run (i.e. this method can modify the command
410         to run).
411         """
412         return argv
413
414     def postcmd(self, argv):
415         """Hook method executed just after a command dispatch is finished.
416
417             "argv" is the command that was run.
418         """
419         pass
420
421     def cmdexc(self, argv):
422         """Called if an exception is raised in any of precmd(), onecmd(),
423         or postcmd(). If True is returned, the exception is deemed to have
424         been dealt with. Otherwise, the exception is re-raised.
425
426         The default implementation handles CmdlnUserError's, which
427         typically correspond to user error in calling commands (as
428         opposed to programmer error in the design of the script using
429         cmdln.py).
430         """
431         import sys
432         exc_type, exc, traceback = sys.exc_info()
433         if isinstance(exc, CmdlnUserError):
434             msg = "%s %s: %s\nTry '%s help %s' for info.\n"\
435                   % (self.name, argv[0], exc, self.name, argv[0])
436             self.stderr.write(self._str(msg))
437             self.stderr.flush()
438             return True
439
440     def onecmd(self, argv):
441         if not argv:
442             return self.emptyline()
443         self.lastcmd = argv
444         cmdname = self._get_canonical_cmd_name(argv[0])
445         if cmdname:
446             handler = self._get_cmd_handler(cmdname)
447             if handler:
448                 return self._dispatch_cmd(handler, argv)
449         return self.default(argv)
450
451     def _dispatch_cmd(self, handler, argv):
452         return handler(argv)
453
454     def default(self, argv):
455         """Hook called to handle a command for which there is no handler.
456
457             "argv" is the command and arguments to run.
458
459         The default implementation writes and error message to stderr
460         and returns an error exit status.
461
462         Returns a numeric command exit status.
463         """
464         errmsg = self._str(self.unknowncmd % (argv[0],))
465         if self.cmdlooping:
466             self.stderr.write(errmsg+"\n")
467         else:
468             self.stderr.write("%s: %s\nTry '%s help' for info.\n"
469                               % (self._name_str, errmsg, self._name_str))
470         self.stderr.flush()
471         return 1
472
473     def parseline(self, line):
474         # This is used by Cmd.complete (readline completer function) to
475         # massage the current line buffer before completion processing.
476         # We override to drop special '!' handling.
477         line = line.strip()
478         if not line:
479             return None, None, line
480         elif line[0] == '?':
481             line = 'help ' + line[1:]
482         i, n = 0, len(line)
483         while i < n and line[i] in self.identchars: i = i+1
484         cmd, arg = line[:i], line[i:].strip()
485         return cmd, arg, line
486
487     def helpdefault(self, cmd, known):
488         """Hook called to handle help on a command for which there is no
489         help handler.
490
491             "cmd" is the command name on which help was requested.
492             "known" is a boolean indicating if this command is known
493                 (i.e. if there is a handler for it).
494
495         Returns a return code.
496         """
497         if known:
498             msg = self._str(self.nohelp % (cmd,))
499             if self.cmdlooping:
500                 self.stderr.write(msg + '\n')
501             else:
502                 self.stderr.write("%s: %s\n" % (self.name, msg))
503         else:
504             msg = self.unknowncmd % (cmd,)
505             if self.cmdlooping:
506                 self.stderr.write(msg + '\n')
507             else:
508                 self.stderr.write("%s: %s\n"
509                                   "Try '%s help' for info.\n"
510                                   % (self.name, msg, self.name))
511         self.stderr.flush()
512         return 1
513
514
515     def do_help(self, argv):
516         """${cmd_name}: give detailed help on a specific sub-command
517
518         usage:
519             ${name} help [SUBCOMMAND]
520         """
521         if len(argv) > 1: # asking for help on a particular command
522             doc = None
523             cmdname = self._get_canonical_cmd_name(argv[1]) or argv[1]
524             if not cmdname:
525                 return self.helpdefault(argv[1], False)
526             else:
527                 helpfunc = getattr(self, "help_"+cmdname, None)
528                 if helpfunc:
529                     doc = helpfunc()
530                 else:
531                     handler = self._get_cmd_handler(cmdname)
532                     if handler:
533                         doc = handler.__doc__
534                     if doc is None:
535                         return self.helpdefault(argv[1], handler != None)
536         else: # bare "help" command
537             doc = self.__class__.__doc__  # try class docstring
538             if doc is None:
539                 # Try to provide some reasonable useful default help.
540                 if self.cmdlooping: prefix = ""
541                 else:               prefix = self.name+' '
542                 doc = """usage:
543                     %sSUBCOMMAND [ARGS...]
544                     %shelp [SUBCOMMAND]
545
546                 ${option_list}
547                 ${command_list}
548                 ${help_list}
549                 """ % (prefix, prefix)
550             cmdname = None
551
552         if doc: # *do* have help content, massage and print that
553             doc = self._help_reindent(doc)
554             doc = self._help_preprocess(doc, cmdname)
555             doc = doc.rstrip() + '\n' # trim down trailing space
556             self.stdout.write(self._str(doc))
557             self.stdout.flush()
558     do_help.aliases = ["?"]
559
560
561     def do_man(self):
562         """${cmd_name}: generates a man page
563
564         usage:
565             ${name} man
566         """
567         self.stdout.write(self.man_header % {
568                 'date': date.today().strftime('%b %Y'),
569                 'version': self.get_version(),
570                 'name': self.name,
571                 'ucname': self.name.upper()
572                 }
573         )
574
575         self.stdout.write(self.man_commands_header)
576         commands = self._help_get_command_list()
577         for command, doc in commands:
578             cmdname = command.split(' ')[0]
579             text = self._help_preprocess(doc, cmdname)
580             lines = []
581             for line in text.splitlines(False):
582                 if line[:8] == ' ' * 8:
583                     line = line[8:]
584                 lines.append(man_escape(line))
585
586             self.stdout.write('.TP\n\\fB%s\\fR\n%s\n' % (command, '\n'.join(lines)))
587
588         self.stdout.write(self.man_options_header)
589         self.stdout.write(man_escape(self._help_preprocess('${option_list}', None)))
590
591         self.stdout.write(self.man_footer)
592
593         self.stdout.flush()
594
595     def _help_reindent(self, help, indent=None):
596         """Hook to re-indent help strings before writing to stdout.
597
598             "help" is the help content to re-indent
599             "indent" is a string with which to indent each line of the
600                 help content after normalizing. If unspecified or None
601                 then the default is use: the 'self.helpindent' class
602                 attribute. By default this is the empty string, i.e.
603                 no indentation.
604
605         By default, all common leading whitespace is removed and then
606         the lot is indented by 'self.helpindent'. When calculating the
607         common leading whitespace the first line is ignored -- hence
608         help content for Conan can be written as follows and have the
609         expected indentation:
610
611             def do_crush(self, ...):
612                 '''${cmd_name}: crush your enemies, see them driven before you...
613
614                 c.f. Conan the Barbarian'''
615         """
616         if indent is None:
617             indent = self.helpindent
618         lines = help.splitlines(0)
619         _dedentlines(lines, skip_first_line=True)
620         lines = [(indent+line).rstrip() for line in lines]
621         return '\n'.join(lines)
622
623     def _help_preprocess(self, help, cmdname):
624         """Hook to preprocess a help string before writing to stdout.
625
626             "help" is the help string to process.
627             "cmdname" is the canonical sub-command name for which help
628                 is being given, or None if the help is not specific to a
629                 command.
630
631         By default the following template variables are interpolated in
632         help content. (Note: these are similar to Python 2.4's
633         string.Template interpolation but not quite.)
634
635         ${name}
636             The tool's/shell's name, i.e. 'self.name'.
637         ${option_list}
638             A formatted table of options for this shell/tool.
639         ${command_list}
640             A formatted table of available sub-commands.
641         ${help_list}
642             A formatted table of additional help topics (i.e. 'help_*'
643             methods with no matching 'do_*' method).
644         ${cmd_name}
645             The name (and aliases) for this sub-command formatted as:
646             "NAME (ALIAS1, ALIAS2, ...)".
647         ${cmd_usage}
648             A formatted usage block inferred from the command function
649             signature.
650         ${cmd_option_list}
651             A formatted table of options for this sub-command. (This is
652             only available for commands using the optparse integration,
653             i.e.  using @cmdln.option decorators or manually setting the
654             'optparser' attribute on the 'do_*' method.)
655
656         Returns the processed help.
657         """
658         preprocessors = {
659             "${name}":            self._help_preprocess_name,
660             "${option_list}":     self._help_preprocess_option_list,
661             "${command_list}":    self._help_preprocess_command_list,
662             "${help_list}":       self._help_preprocess_help_list,
663             "${cmd_name}":        self._help_preprocess_cmd_name,
664             "${cmd_usage}":       self._help_preprocess_cmd_usage,
665             "${cmd_option_list}": self._help_preprocess_cmd_option_list,
666         }
667
668         for marker, preprocessor in preprocessors.items():
669             if marker in help:
670                 help = preprocessor(help, cmdname)
671         return help
672
673     def _help_preprocess_name(self, help, cmdname=None):
674         return help.replace("${name}", self.name)
675
676     def _help_preprocess_option_list(self, help, cmdname=None):
677         marker = "${option_list}"
678         indent, indent_width = _get_indent(marker, help)
679         suffix = _get_trailing_whitespace(marker, help)
680
681         if self.optparser:
682             # Setup formatting options and format.
683             # - Indentation of 4 is better than optparse default of 2.
684             #   C.f. Damian Conway's discussion of this in Perl Best
685             #   Practices.
686             self.optparser.formatter.indent_increment = 4
687             self.optparser.formatter.current_indent = indent_width
688             block = self.optparser.format_option_help() + '\n'
689         else:
690             block = ""
691
692         help_msg = help.replace(indent+marker+suffix, block, 1)
693         return help_msg
694
695     def _help_get_command_list(self):
696         # Find any aliases for commands.
697         token2canonical = self._get_canonical_map()
698         aliases = {}
699         for token, cmdname in token2canonical.items():
700             if token == cmdname: continue
701             aliases.setdefault(cmdname, []).append(token)
702
703         # Get the list of (non-hidden) commands and their
704         # documentation, if any.
705         cmdnames = {} # use a dict to strip duplicates
706         for attr in self.get_names():
707             if attr.startswith("do_"):
708                 cmdnames[attr[3:]] = True
709         cmdnames = cmdnames.keys()
710         cmdnames.sort()
711         linedata = []
712         for cmdname in cmdnames:
713             if aliases.get(cmdname):
714                 a = aliases[cmdname]
715                 a.sort()
716                 cmdstr = "%s (%s)" % (cmdname, ", ".join(a))
717             else:
718                 cmdstr = cmdname
719             doc = None
720             try:
721                 helpfunc = getattr(self, 'help_'+cmdname)
722             except AttributeError:
723                 handler = self._get_cmd_handler(cmdname)
724                 if handler:
725                     doc = handler.__doc__
726             else:
727                 doc = helpfunc()
728
729             # Strip "${cmd_name}: " from the start of a command's doc. Best
730             # practice dictates that command help strings begin with this, but
731             # it isn't at all wanted for the command list.
732             to_strip = "${cmd_name}:"
733             if doc and doc.startswith(to_strip):
734                 #log.debug("stripping %r from start of %s's help string",
735                 #          to_strip, cmdname)
736                 doc = doc[len(to_strip):].lstrip()
737             if not getattr(self._get_cmd_handler(cmdname), "hidden", None):
738                 linedata.append( (cmdstr, doc) )
739
740         return linedata
741
742     def _help_preprocess_command_list(self, help, cmdname=None):
743         marker = "${command_list}"
744         indent, indent_width = _get_indent(marker, help)
745         suffix = _get_trailing_whitespace(marker, help)
746
747         linedata = self._help_get_command_list()
748
749         if linedata:
750             subindent = indent + ' '*4
751             lines = _format_linedata(linedata, subindent, indent_width+4)
752             block = indent + "commands:\n" \
753                     + '\n'.join(lines) + "\n\n"
754             help = help.replace(indent+marker+suffix, block, 1)
755         return help
756
757     def _help_preprocess_help_list(self, help, cmdname=None):
758         marker = "${help_list}"
759         indent, indent_width = _get_indent(marker, help)
760         suffix = _get_trailing_whitespace(marker, help)
761
762         # Determine the additional help topics, if any.
763         helpnames = {}
764         token2cmdname = self._get_canonical_map()
765         for attr in self.get_names():
766             if not attr.startswith("help_"): continue
767             helpname = attr[5:]
768             if helpname not in token2cmdname:
769                 helpnames[helpname] = True
770
771         if helpnames:
772             helpnames = helpnames.keys()
773             helpnames.sort()
774             linedata = [(self.name+" help "+n, "") for n in helpnames]
775
776             subindent = indent + ' '*4
777             lines = _format_linedata(linedata, subindent, indent_width+4)
778             block = indent + "additional help topics:\n" \
779                     + '\n'.join(lines) + "\n\n"
780         else:
781             block = ''
782         help_msg = help.replace(indent+marker+suffix, block, 1)
783         return help_msg
784
785     def _help_preprocess_cmd_name(self, help, cmdname=None):
786         marker = "${cmd_name}"
787         handler = self._get_cmd_handler(cmdname)
788         if not handler:
789             raise CmdlnError("cannot preprocess '%s' into help string: "
790                              "could not find command handler for %r"
791                              % (marker, cmdname))
792         s = cmdname
793         if hasattr(handler, "aliases"):
794             s += " (%s)" % (", ".join(handler.aliases))
795         help_msg = help.replace(marker, s)
796         return help_msg
797
798     #TODO: this only makes sense as part of the Cmdln class.
799     #      Add hooks to add help preprocessing template vars and put
800     #      this one on that class.
801     def _help_preprocess_cmd_usage(self, help, cmdname=None):
802         marker = "${cmd_usage}"
803         handler = self._get_cmd_handler(cmdname)
804         if not handler:
805             raise CmdlnError("cannot preprocess '%s' into help string: "
806                              "could not find command handler for %r"
807                              % (marker, cmdname))
808         indent, indent_width = _get_indent(marker, help)
809         suffix = _get_trailing_whitespace(marker, help)
810
811         # Extract the introspection bits we need.
812         func = handler.im_func
813         if func.func_defaults:
814             func_defaults = list(func.func_defaults)
815         else:
816             func_defaults = []
817         co_argcount = func.func_code.co_argcount
818         co_varnames = func.func_code.co_varnames
819         co_flags = func.func_code.co_flags
820         CO_FLAGS_ARGS = 4
821         CO_FLAGS_KWARGS = 8
822
823         # Adjust argcount for possible *args and **kwargs arguments.
824         argcount = co_argcount
825         if co_flags & CO_FLAGS_ARGS:   argcount += 1
826         if co_flags & CO_FLAGS_KWARGS: argcount += 1
827
828         # Determine the usage string.
829         usage = "%s %s" % (self.name, cmdname)
830         if argcount <= 2:   # handler ::= do_FOO(self, argv)
831             usage += " [ARGS...]"
832         elif argcount >= 3: # handler ::= do_FOO(self, subcmd, opts, ...)
833             argnames = list(co_varnames[3:argcount])
834             tail = ""
835             if co_flags & CO_FLAGS_KWARGS:
836                 name = argnames.pop(-1)
837                 import warnings
838                 # There is no generally accepted mechanism for passing
839                 # keyword arguments from the command line. Could
840                 # *perhaps* consider: arg=value arg2=value2 ...
841                 warnings.warn("argument '**%s' on '%s.%s' command "
842                               "handler will never get values"
843                               % (name, self.__class__.__name__,
844                                  func.func_name))
845             if co_flags & CO_FLAGS_ARGS:
846                 name = argnames.pop(-1)
847                 tail = "[%s...]" % name.upper()
848             while func_defaults:
849                 func_defaults.pop(-1)
850                 name = argnames.pop(-1)
851                 tail = "[%s%s%s]" % (name.upper(), (tail and ' ' or ''), tail)
852             while argnames:
853                 name = argnames.pop(-1)
854                 tail = "%s %s" % (name.upper(), tail)
855             usage += ' ' + tail
856
857         block_lines = [
858             self.helpindent + "Usage:",
859             self.helpindent + ' '*4 + usage
860         ]
861         block = '\n'.join(block_lines) + '\n\n'
862
863         help_msg = help.replace(indent+marker+suffix, block, 1)
864         return help_msg
865
866     #TODO: this only makes sense as part of the Cmdln class.
867     #      Add hooks to add help preprocessing template vars and put
868     #      this one on that class.
869     def _help_preprocess_cmd_option_list(self, help, cmdname=None):
870         marker = "${cmd_option_list}"
871         handler = self._get_cmd_handler(cmdname)
872         if not handler:
873             raise CmdlnError("cannot preprocess '%s' into help string: "
874                              "could not find command handler for %r"
875                              % (marker, cmdname))
876         indent, indent_width = _get_indent(marker, help)
877         suffix = _get_trailing_whitespace(marker, help)
878         if hasattr(handler, "optparser"):
879             # Setup formatting options and format.
880             # - Indentation of 4 is better than optparse default of 2.
881             #   C.f. Damian Conway's discussion of this in Perl Best
882             #   Practices.
883             handler.optparser.formatter.indent_increment = 4
884             handler.optparser.formatter.current_indent = indent_width
885             block = handler.optparser.format_option_help() + '\n'
886         else:
887             block = ""
888
889         help_msg = help.replace(indent+marker+suffix, block, 1)
890         return help_msg
891
892     def _get_canonical_cmd_name(self, token):
893         c_map = self._get_canonical_map()
894         return c_map.get(token, None)
895
896     def _get_canonical_map(self):
897         """Return a mapping of available command names and aliases to
898         their canonical command name.
899         """
900         cacheattr = "_token2canonical"
901         if not hasattr(self, cacheattr):
902             # Get the list of commands and their aliases, if any.
903             token2canonical = {}
904             cmd2funcname = {} # use a dict to strip duplicates
905             for attr in self.get_names():
906                 if attr.startswith("do_"):    cmdname = attr[3:]
907                 elif attr.startswith("_do_"): cmdname = attr[4:]
908                 else:
909                     continue
910                 cmd2funcname[cmdname] = attr
911                 token2canonical[cmdname] = cmdname
912             for cmdname, funcname in cmd2funcname.items(): # add aliases
913                 func = getattr(self, funcname)
914                 aliases = getattr(func, "aliases", [])
915                 for alias in aliases:
916                     if alias in cmd2funcname:
917                         import warnings
918                         warnings.warn("'%s' alias for '%s' command conflicts "
919                                       "with '%s' handler"
920                                       % (alias, cmdname, cmd2funcname[alias]))
921                         continue
922                     token2canonical[alias] = cmdname
923             setattr(self, cacheattr, token2canonical)
924         return getattr(self, cacheattr)
925
926     def _get_cmd_handler(self, cmdname):
927         handler = None
928         try:
929             handler = getattr(self, 'do_' + cmdname)
930         except AttributeError:
931             try:
932                 # Private command handlers begin with "_do_".
933                 handler = getattr(self, '_do_' + cmdname)
934             except AttributeError:
935                 pass
936         return handler
937
938     def _do_EOF(self, argv):
939         # Default EOF handler
940         # Note: an actual EOF is redirected to this command.
941         #TODO: separate name for this. Currently it is available from
942         #      command-line. Is that okay?
943         self.stdout.write('\n')
944         self.stdout.flush()
945         self.stop = True
946
947     def emptyline(self):
948         # Different from cmd.Cmd: don't repeat the last command for an
949         # emptyline.
950         if self.cmdlooping:
951             pass
952         else:
953             return self.do_help(["help"])
954
955
956 #---- optparse.py extension to fix (IMO) some deficiencies
957 #
958 # See the class _OptionParserEx docstring for details.
959 #
960
961 class StopOptionProcessing(Exception):
962     """Indicate that option *and argument* processing should stop
963     cleanly. This is not an error condition. It is similar in spirit to
964     StopIteration. This is raised by _OptionParserEx's default "help"
965     and "version" option actions and can be raised by custom option
966     callbacks too.
967
968     Hence the typical CmdlnOptionParser (a subclass of _OptionParserEx)
969     usage is:
970
971         parser = CmdlnOptionParser(mycmd)
972         parser.add_option("-f", "--force", dest="force")
973         ...
974         try:
975             opts, args = parser.parse_args()
976         except StopOptionProcessing:
977             # normal termination, "--help" was probably given
978             sys.exit(0)
979     """
980
981 class _OptionParserEx(optparse.OptionParser):
982     """An optparse.OptionParser that uses exceptions instead of sys.exit.
983
984     This class is an extension of optparse.OptionParser that differs
985     as follows:
986     - Correct (IMO) the default OptionParser error handling to never
987       sys.exit(). Instead OptParseError exceptions are passed through.
988     - Add the StopOptionProcessing exception (a la StopIteration) to
989       indicate normal termination of option processing.
990       See StopOptionProcessing's docstring for details.
991
992     I'd also like to see the following in the core optparse.py, perhaps
993     as a RawOptionParser which would serve as a base class for the more
994     generally used OptionParser (that works as current):
995     - Remove the implicit addition of the -h|--help and --version
996       options. They can get in the way (e.g. if want '-?' and '-V' for
997       these as well) and it is not hard to do:
998         optparser.add_option("-h", "--help", action="help")
999         optparser.add_option("--version", action="version")
1000       These are good practices, just not valid defaults if they can
1001       get in the way.
1002     """
1003     def error(self, msg):
1004         raise optparse.OptParseError(msg)
1005
1006     def exit(self, status=0, msg=None):
1007         if status == 0:
1008             raise StopOptionProcessing(msg)
1009         else:
1010             #TODO: don't lose status info here
1011             raise optparse.OptParseError(msg)
1012
1013
1014
1015 #---- optparse.py-based option processing support
1016
1017 class CmdlnOptionParser(_OptionParserEx):
1018     """An optparse.OptionParser class more appropriate for top-level
1019     Cmdln options. For parsing of sub-command options, see
1020     SubCmdOptionParser.
1021
1022     Changes:
1023     - disable_interspersed_args() by default, because a Cmdln instance
1024       has sub-commands which may themselves have options.
1025     - Redirect print_help() to the Cmdln.do_help() which is better
1026       equiped to handle the "help" action.
1027     - error() will raise a CmdlnUserError: OptionParse.error() is meant
1028       to be called for user errors. Raising a well-known error here can
1029       make error handling clearer.
1030     - Also see the changes in _OptionParserEx.
1031     """
1032     def __init__(self, cmdln, **kwargs):
1033         self.cmdln = cmdln
1034         kwargs["prog"] = self.cmdln.name
1035         _OptionParserEx.__init__(self, **kwargs)
1036         self.disable_interspersed_args()
1037
1038     def print_help(self, file=None):
1039         self.cmdln.onecmd(["help"])
1040
1041     def error(self, msg):
1042         raise CmdlnUserError(msg)
1043
1044
1045 class SubCmdOptionParser(_OptionParserEx):
1046     def set_cmdln_info(self, cmdln, subcmd):
1047         """Called by Cmdln to pass relevant info about itself needed
1048         for print_help().
1049         """
1050         self.cmdln = cmdln
1051         self.subcmd = subcmd
1052
1053     def print_help(self, file=None):
1054         self.cmdln.onecmd(["help", self.subcmd])
1055
1056     def error(self, msg):
1057         raise CmdlnUserError(msg)
1058
1059
1060 def option(*args, **kwargs):
1061     """Decorator to add an option to the optparser argument of a Cmdln
1062     subcommand.
1063
1064     Example:
1065         class MyShell(cmdln.Cmdln):
1066             @cmdln.option("-f", "--force", help="force removal")
1067             def do_remove(self, subcmd, opts, *args):
1068                 #...
1069     """
1070     #XXX Is there a possible optimization for many options to not have a
1071     #    large stack depth here?
1072     def decorate(f):
1073         if not hasattr(f, "optparser"):
1074             f.optparser = SubCmdOptionParser()
1075         f.optparser.add_option(*args, **kwargs)
1076         return f
1077     return decorate
1078
1079 def hide(*args):
1080     """For obsolete calls, hide them in help listings.
1081
1082     Example:
1083         class MyShell(cmdln.Cmdln):
1084             @cmdln.hide()
1085             def do_shell(self, argv):
1086                 #...implement 'shell' command
1087     """
1088     def decorate(f):
1089         f.hidden = 1
1090         return f
1091     return decorate
1092
1093
1094 class Cmdln(RawCmdln):
1095     """An improved (on cmd.Cmd) framework for building multi-subcommand
1096     scripts (think "svn" & "cvs") and simple shells (think "pdb" and
1097     "gdb").
1098
1099     A simple example:
1100
1101         import cmdln
1102
1103         class MySVN(cmdln.Cmdln):
1104             name = "svn"
1105
1106             @cmdln.aliases('stat', 'st')
1107             @cmdln.option('-v', '--verbose', action='store_true'
1108                           help='print verbose information')
1109             def do_status(self, subcmd, opts, *paths):
1110                 print "handle 'svn status' command"
1111
1112             #...
1113
1114         if __name__ == "__main__":
1115             shell = MySVN()
1116             retval = shell.main()
1117             sys.exit(retval)
1118
1119     'Cmdln' extends 'RawCmdln' by providing optparse option processing
1120     integration.  See this class' _dispatch_cmd() docstring and
1121     <http://trentm.com/projects/cmdln> for more information.
1122     """
1123     def _dispatch_cmd(self, handler, argv):
1124         """Introspect sub-command handler signature to determine how to
1125         dispatch the command. The raw handler provided by the base
1126         'RawCmdln' class is still supported:
1127
1128             def do_foo(self, argv):
1129                 # 'argv' is the vector of command line args, argv[0] is
1130                 # the command name itself (i.e. "foo" or an alias)
1131                 pass
1132
1133         In addition, if the handler has more than 2 arguments option
1134         processing is automatically done (using optparse):
1135
1136             @cmdln.option('-v', '--verbose', action='store_true')
1137             def do_bar(self, subcmd, opts, *args):
1138                 # subcmd = <"bar" or an alias>
1139                 # opts = <an optparse.Values instance>
1140                 if opts.verbose:
1141                     print "lots of debugging output..."
1142                 # args = <tuple of arguments>
1143                 for arg in args:
1144                     bar(arg)
1145
1146         TODO: explain that "*args" can be other signatures as well.
1147
1148         The `cmdln.option` decorator corresponds to an `add_option()`
1149         method call on an `optparse.OptionParser` instance.
1150
1151         You can declare a specific number of arguments:
1152
1153             @cmdln.option('-v', '--verbose', action='store_true')
1154             def do_bar2(self, subcmd, opts, bar_one, bar_two):
1155                 #...
1156
1157         and an appropriate error message will be raised/printed if the
1158         command is called with a different number of args.
1159         """
1160         co_argcount = handler.im_func.func_code.co_argcount
1161         if co_argcount == 2:   # handler ::= do_foo(self, argv)
1162             return handler(argv)
1163         elif co_argcount >= 3: # handler ::= do_foo(self, subcmd, opts, ...)
1164             try:
1165                 optparser = handler.optparser
1166             except AttributeError:
1167                 optparser = handler.im_func.optparser = SubCmdOptionParser()
1168             assert isinstance(optparser, SubCmdOptionParser)
1169             optparser.set_cmdln_info(self, argv[0])
1170             try:
1171                 opts, args = optparser.parse_args(argv[1:])
1172             except StopOptionProcessing:
1173                 #TODO: this doesn't really fly for a replacement of
1174                 #      optparse.py behaviour, does it?
1175                 return 0 # Normal command termination
1176
1177             try:
1178                 return handler(argv[0], opts, *args)
1179             except TypeError, ex:
1180                 # Some TypeError's are user errors:
1181                 #   do_foo() takes at least 4 arguments (3 given)
1182                 #   do_foo() takes at most 5 arguments (6 given)
1183                 #   do_foo() takes exactly 5 arguments (6 given)
1184                 # Raise CmdlnUserError for these with a suitably
1185                 # massaged error message.
1186                 import sys
1187                 tb = sys.exc_info()[2] # the traceback object
1188                 if tb.tb_next is not None:
1189                     # If the traceback is more than one level deep, then the
1190                     # TypeError do *not* happen on the "handler(...)" call
1191                     # above. In that we don't want to handle it specially
1192                     # here: it would falsely mask deeper code errors.
1193                     raise
1194                 msg = ex.args[0]
1195                 match = _INCORRECT_NUM_ARGS_RE.search(msg)
1196                 if match:
1197                     msg = list(match.groups())
1198                     msg[1] = int(msg[1]) - 3
1199                     if msg[1] == 1:
1200                         msg[2] = msg[2].replace("arguments", "argument")
1201                     msg[3] = int(msg[3]) - 3
1202                     msg = ''.join(map(str, msg))
1203                     raise CmdlnUserError(msg)
1204                 else:
1205                     raise
1206         else:
1207             raise CmdlnError("incorrect argcount for %s(): takes %d, must "
1208                              "take 2 for 'argv' signature or 3+ for 'opts' "
1209                              "signature" % (handler.__name__, co_argcount))
1210
1211
1212
1213 #---- internal support functions
1214
1215 def _format_linedata(linedata, indent, indent_width):
1216     """Format specific linedata into a pleasant layout.
1217
1218         "linedata" is a list of 2-tuples of the form:
1219             (<item-display-string>, <item-docstring>)
1220         "indent" is a string to use for one level of indentation
1221         "indent_width" is a number of columns by which the
1222             formatted data will be indented when printed.
1223
1224     The <item-display-string> column is held to 15 columns.
1225     """
1226     lines = []
1227     WIDTH = 78 - indent_width
1228     SPACING = 3
1229     MAX_NAME_WIDTH = 15
1230
1231     NAME_WIDTH = min(max([len(s) for s,d in linedata]), MAX_NAME_WIDTH)
1232     DOC_WIDTH = WIDTH - NAME_WIDTH - SPACING
1233     for namestr, doc in linedata:
1234         line = indent + namestr
1235         if len(namestr) <= NAME_WIDTH:
1236             line += ' ' * (NAME_WIDTH + SPACING - len(namestr))
1237         else:
1238             lines.append(line)
1239             line = indent + ' ' * (NAME_WIDTH + SPACING)
1240         line += _summarize_doc(doc, DOC_WIDTH)
1241         lines.append(line.rstrip())
1242     return lines
1243
1244 def _summarize_doc(doc, length=60):
1245     r"""Parse out a short one line summary from the given doclines.
1246
1247         "doc" is the doc string to summarize.
1248         "length" is the max length for the summary
1249
1250     >>> _summarize_doc("this function does this")
1251     'this function does this'
1252     >>> _summarize_doc("this function does this", 10)
1253     'this fu...'
1254     >>> _summarize_doc("this function does this\nand that")
1255     'this function does this and that'
1256     >>> _summarize_doc("this function does this\n\nand that")
1257     'this function does this'
1258     """
1259     import re
1260     if doc is None:
1261         return ""
1262     assert length > 3, "length <= 3 is absurdly short for a doc summary"
1263     doclines = doc.strip().splitlines(0)
1264     if not doclines:
1265         return ""
1266
1267     summlines = []
1268     for i, line in enumerate(doclines):
1269         stripped = line.strip()
1270         if not stripped:
1271             break
1272         summlines.append(stripped)
1273         if len(''.join(summlines)) >= length:
1274             break
1275
1276     summary = ' '.join(summlines)
1277     if len(summary) > length:
1278         summary = summary[:length-3] + "..."
1279     return summary
1280
1281
1282 def line2argv(line):
1283     r"""Parse the given line into an argument vector.
1284
1285         "line" is the line of input to parse.
1286
1287     This may get niggly when dealing with quoting and escaping. The
1288     current state of this parsing may not be completely thorough/correct
1289     in this respect.
1290
1291     >>> from cmdln import line2argv
1292     >>> line2argv("foo")
1293     ['foo']
1294     >>> line2argv("foo bar")
1295     ['foo', 'bar']
1296     >>> line2argv("foo bar ")
1297     ['foo', 'bar']
1298     >>> line2argv(" foo bar")
1299     ['foo', 'bar']
1300
1301     Quote handling:
1302
1303     >>> line2argv("'foo bar'")
1304     ['foo bar']
1305     >>> line2argv('"foo bar"')
1306     ['foo bar']
1307     >>> line2argv(r'"foo\"bar"')
1308     ['foo"bar']
1309     >>> line2argv("'foo bar' spam")
1310     ['foo bar', 'spam']
1311     >>> line2argv("'foo 'bar spam")
1312     ['foo bar', 'spam']
1313     >>> line2argv("'foo")
1314     Traceback (most recent call last):
1315         ...
1316     ValueError: command line is not terminated: unfinished single-quoted segment
1317     >>> line2argv('"foo')
1318     Traceback (most recent call last):
1319         ...
1320     ValueError: command line is not terminated: unfinished double-quoted segment
1321     >>> line2argv('some\tsimple\ttests')
1322     ['some', 'simple', 'tests']
1323     >>> line2argv('a "more complex" test')
1324     ['a', 'more complex', 'test']
1325     >>> line2argv('a more="complex test of " quotes')
1326     ['a', 'more=complex test of ', 'quotes']
1327     >>> line2argv('a more" complex test of " quotes')
1328     ['a', 'more complex test of ', 'quotes']
1329     >>> line2argv('an "embedded \\"quote\\""')
1330     ['an', 'embedded "quote"']
1331     """
1332     import string
1333     line = line.strip()
1334     argv = []
1335     state = "default"
1336     arg = None  # the current argument being parsed
1337     i = -1
1338     while 1:
1339         i += 1
1340         if i >= len(line): break
1341         ch = line[i]
1342
1343         if ch == "\\": # escaped char always added to arg, regardless of state
1344             if arg is None: arg = ""
1345             i += 1
1346             arg += line[i]
1347             continue
1348
1349         if state == "single-quoted":
1350             if ch == "'":
1351                 state = "default"
1352             else:
1353                 arg += ch
1354         elif state == "double-quoted":
1355             if ch == '"':
1356                 state = "default"
1357             else:
1358                 arg += ch
1359         elif state == "default":
1360             if ch == '"':
1361                 if arg is None: arg = ""
1362                 state = "double-quoted"
1363             elif ch == "'":
1364                 if arg is None: arg = ""
1365                 state = "single-quoted"
1366             elif ch in string.whitespace:
1367                 if arg is not None:
1368                     argv.append(arg)
1369                 arg = None
1370             else:
1371                 if arg is None: arg = ""
1372                 arg += ch
1373     if arg is not None:
1374         argv.append(arg)
1375     if state != "default":
1376         raise ValueError("command line is not terminated: unfinished %s "
1377                          "segment" % state)
1378     return argv
1379
1380
1381 def argv2line(argv):
1382     r"""Put together the given argument vector into a command line.
1383
1384         "argv" is the argument vector to process.
1385
1386     >>> from cmdln import argv2line
1387     >>> argv2line(['foo'])
1388     'foo'
1389     >>> argv2line(['foo', 'bar'])
1390     'foo bar'
1391     >>> argv2line(['foo', 'bar baz'])
1392     'foo "bar baz"'
1393     >>> argv2line(['foo"bar'])
1394     'foo"bar'
1395     >>> print argv2line(['foo" bar'])
1396     'foo" bar'
1397     >>> print argv2line(["foo' bar"])
1398     "foo' bar"
1399     >>> argv2line(["foo'bar"])
1400     "foo'bar"
1401     """
1402     escapedArgs = []
1403     for arg in argv:
1404         if ' ' in arg and '"' not in arg:
1405             arg = '"'+arg+'"'
1406         elif ' ' in arg and "'" not in arg:
1407             arg = "'"+arg+"'"
1408         elif ' ' in arg:
1409             arg = arg.replace('"', r'\"')
1410             arg = '"'+arg+'"'
1411         escapedArgs.append(arg)
1412     return ' '.join(escapedArgs)
1413
1414
1415 # Recipe: dedent (0.1) in /Users/trentm/tm/recipes/cookbook
1416 def _dedentlines(lines, tabsize=8, skip_first_line=False):
1417     """_dedentlines(lines, tabsize=8, skip_first_line=False) -> dedented lines
1418
1419         "lines" is a list of lines to dedent.
1420         "tabsize" is the tab width to use for indent width calculations.
1421         "skip_first_line" is a boolean indicating if the first line should
1422             be skipped for calculating the indent width and for dedenting.
1423             This is sometimes useful for docstrings and similar.
1424
1425     Same as dedent() except operates on a sequence of lines. Note: the
1426     lines list is modified **in-place**.
1427     """
1428     DEBUG = False
1429     if DEBUG:
1430         print "dedent: dedent(..., tabsize=%d, skip_first_line=%r)"\
1431               % (tabsize, skip_first_line)
1432     indents = []
1433     margin = None
1434     for i, line in enumerate(lines):
1435         if i == 0 and skip_first_line: continue
1436         indent = 0
1437         for ch in line:
1438             if ch == ' ':
1439                 indent += 1
1440             elif ch == '\t':
1441                 indent += tabsize - (indent % tabsize)
1442             elif ch in '\r\n':
1443                 continue # skip all-whitespace lines
1444             else:
1445                 break
1446         else:
1447             continue # skip all-whitespace lines
1448         if DEBUG: print "dedent: indent=%d: %r" % (indent, line)
1449         if margin is None:
1450             margin = indent
1451         else:
1452             margin = min(margin, indent)
1453     if DEBUG: print "dedent: margin=%r" % margin
1454
1455     if margin is not None and margin > 0:
1456         for i, line in enumerate(lines):
1457             if i == 0 and skip_first_line: continue
1458             removed = 0
1459             for j, ch in enumerate(line):
1460                 if ch == ' ':
1461                     removed += 1
1462                 elif ch == '\t':
1463                     removed += tabsize - (removed % tabsize)
1464                 elif ch in '\r\n':
1465                     if DEBUG: print "dedent: %r: EOL -> strip up to EOL" % line
1466                     lines[i] = lines[i][j:]
1467                     break
1468                 else:
1469                     raise ValueError("unexpected non-whitespace char %r in "
1470                                      "line %r while removing %d-space margin"
1471                                      % (ch, line, margin))
1472                 if DEBUG:
1473                     print "dedent: %r: %r -> removed %d/%d"\
1474                           % (line, ch, removed, margin)
1475                 if removed == margin:
1476                     lines[i] = lines[i][j+1:]
1477                     break
1478                 elif removed > margin:
1479                     lines[i] = ' '*(removed-margin) + lines[i][j+1:]
1480                     break
1481     return lines
1482
1483 def _dedent(text, tabsize=8, skip_first_line=False):
1484     """_dedent(text, tabsize=8, skip_first_line=False) -> dedented text
1485
1486         "text" is the text to dedent.
1487         "tabsize" is the tab width to use for indent width calculations.
1488         "skip_first_line" is a boolean indicating if the first line should
1489             be skipped for calculating the indent width and for dedenting.
1490             This is sometimes useful for docstrings and similar.
1491
1492     textwrap.dedent(s), but don't expand tabs to spaces
1493     """
1494     lines = text.splitlines(1)
1495     _dedentlines(lines, tabsize=tabsize, skip_first_line=skip_first_line)
1496     return ''.join(lines)
1497
1498
1499 def _get_indent(marker, s, tab_width=8):
1500     """_get_indent(marker, s, tab_width=8) ->
1501         (<indentation-of-'marker'>, <indentation-width>)"""
1502     # Figure out how much the marker is indented.
1503     INDENT_CHARS = tuple(' \t')
1504     start = s.index(marker)
1505     i = start
1506     while i > 0:
1507         if s[i-1] not in INDENT_CHARS:
1508             break
1509         i -= 1
1510     indent = s[i:start]
1511     indent_width = 0
1512     for ch in indent:
1513         if ch == ' ':
1514             indent_width += 1
1515         elif ch == '\t':
1516             indent_width += tab_width - (indent_width % tab_width)
1517     return indent, indent_width
1518
1519 def _get_trailing_whitespace(marker, s):
1520     """Return the whitespace content trailing the given 'marker' in string 's',
1521     up to and including a newline.
1522     """
1523     suffix = ''
1524     start = s.index(marker) + len(marker)
1525     i = start
1526     while i < len(s):
1527         if s[i] in ' \t':
1528             suffix += s[i]
1529         elif s[i] in '\r\n':
1530             suffix += s[i]
1531             if s[i] == '\r' and i+1 < len(s) and s[i+1] == '\n':
1532                 suffix += s[i+1]
1533             break
1534         else:
1535             break
1536         i += 1
1537     return suffix
1538
1539
1540 # vim: sw=4 et