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