如何解开文档字符串的行

时间:2015-02-20 10:54:52

标签: python docstring docopt

我正在使用模块docopt,但需要在我的程序的主文档字符串中包含换行符。为了将这个换行的文档字符串传递给docopt,我希望以合理且健壮的方式“解开”我的文档字符串的行,以便docopt可以轻松地解释它。

我所拥有的文档字符串类型如下:

Usage:
    program [options]

Options:
    -h, --help                 display help message
    --version                  display version and exit
    -v, --verbose              verbose logging
    -u, --username=USERNAME    username
    -c, --configuration=FILE   file containing configuration
                               [default: 2015-02-06T1012Z_test.txt]
    -d, --data=FILE            file containing list of data files generated in
                               Run 1 of the LHC
                               [default: 2015-02-05T1012Z_data.root]

您可以看到我在右侧字段中包含了一些不错的文本:包含长描述,方括号中的默认值可以选择放在新行上以便清楚。我想处理这个文档字符串,使其成为以下内容:

Usage:
    program [options]

Options:
    -h, --help                 display help message
    --version                  display version and exit
    -v, --verbose              verbose logging
    -u, --username=USERNAME    username
    -c, --configuration=FILE   file containing configuration [default: 2015-02-06T1012Z_test.txt]
    -d, --data=FILE            file containing list of data files generated in Run 1 of the LHC [default: 2015-02-05T1012Z_data.root]

我想一种方法是检测“选项:”之后的行,这些行没有以“ - ”作为某个空格之后的第一个字符并将这些行拉回到上一行,但我不确定是否这是一个强大的应用程序,不知道如何有效地实现这一点。我会欢迎一些指导。

0 个答案:

没有答案