如何字符串格式OptionParser()帮助消息？

Question

如何字符串格式OptionParser()帮助消息？它似乎忽略了新的行字符？请看下面的代码。

parser = OptionParser()
parser.add_option("--s", dest="s", type="string", help="first line \n second line")

意图：

current output:
.... first line \n second line

expected output:
.... first line 
     second line

Answer 1

我可以建议argparse解析吗？

我不确定这是否在OptionParser中被支持，但我建议使用三重报价

即：

parser = OptionParser()
parser.add_option('--s',
                  dest='s'
                  type='string'
                  help='''
With triple quotes I can directly put in anything including line spaces.
\n will appear as a string rather than a newline.''')

argparse解析示例：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--s',
                  help='''first line
second line''')
args = parser.parse_args()
print args.s

Answer 2

查看Lib/optparse.py文件。

class HelpFormatter
    def format_option
    ...
    if option.help:
        help_text = self.expand_default(option)
        help_lines = textwrap.wrap(help_text, self.help_width)
        result.append("%*s%s\n" % (indent_first, "", help_lines[0]))
        result.extend(["%*s%s\n" % (self.help_position, "", line)
                       for line in help_lines[1:]])

换句话说，help字符串是通过textwrap.wrap传递的。对该函数的快速测试表明，它删除了嵌入式\n，并按其认为合适的方式分割行。

与argparse一样，您可以通过子类HelpFormatter和重写所选的方法来自定义帮助。例如，您可能需要将textwrap调用替换为help_lines = help_text.splitlines()。您松开了自动包装，但获得了对帮助外观的控制。

OptionParser接受一个formatter参数。IndentedHelpFormatter是自定义格式化程序类的一个示例。

argparse，RawTextHelpFormatter类就是这样做的，将wrap调用替换为splitlines()。