00001 """\
00002 @file helpformatter.py
00003 @author Phoenix
00004 @brief Class for formatting optparse descriptions.
00005
00006 $LicenseInfo:firstyear=2007&license=mit$
00007
00008 Copyright (c) 2007-2008, Linden Research, Inc.
00009
00010 Permission is hereby granted, free of charge, to any person obtaining a copy
00011 of this software and associated documentation files (the "Software"), to deal
00012 in the Software without restriction, including without limitation the rights
00013 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00014 copies of the Software, and to permit persons to whom the Software is
00015 furnished to do so, subject to the following conditions:
00016
00017 The above copyright notice and this permission notice shall be included in
00018 all copies or substantial portions of the Software.
00019
00020 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00021 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00022 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00023 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00024 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00025 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00026 THE SOFTWARE.
00027 $/LicenseInfo$
00028 """
00029
00030 import optparse
00031 import textwrap
00032
00033 class Formatter(optparse.IndentedHelpFormatter):
00034 def __init__(
00035 self,
00036 p_indentIncrement = 2,
00037 p_maxHelpPosition = 24,
00038 p_width = 79,
00039 p_shortFirst = 1) :
00040 optparse.HelpFormatter.__init__(
00041 self,
00042 p_indentIncrement,
00043 p_maxHelpPosition,
00044 p_width,
00045 p_shortFirst)
00046 def format_description(self, p_description):
00047 t_descWidth = self.width - self.current_indent
00048 t_indent = " " * (self.current_indent + 2)
00049 return "\n".join(
00050 [textwrap.fill(descr, t_descWidth, initial_indent = t_indent,
00051 subsequent_indent = t_indent)
00052 for descr in p_description.split("\n")] )
