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