Argparse 帮助文本换行符插入指南：三种实用方法

python

2024-03-12 23:11:40

在 Argparse 的帮助文本中插入换行符

引言

Argparse 是 Python 中一款广泛使用的库，用于解析命令行参数。它提供了直观且可定制的界面来定义和处理参数。然而，在某些情况下，你可能希望在帮助文本中插入换行符以提高可读性和清晰度，比如当选项值是枚举或具有多行时。

问题

默认情况下，Argparse 会剥离所有换行符和连续空格，导致帮助文本中的多行被压缩成一行。这会降低可读性，尤其是在选项值较多或描述较长时。

解决方案

解决方法分为三类：

转义序列

Argparse 支持使用转义序列在帮助文本中插入换行符，例如：

parser.add_argument('-g', choices=['a', 'b', 'g', 'd', 'e'], default='a',
    help="Some option, where\\n"
         " a = alpha\\n"
         " b = beta\\n"
         " g = gamma\\n"
         " d = delta\\n"
         " e = epsilon")

自定义格式化程序类

你可以创建一个自定义格式化程序类，负责在帮助文本中插入换行符，例如：

class MyFormatter(argparse.HelpFormatter):
    def _fill_text(self, text, width, indent):
        # Insert newlines after each line break in the text
        text = '\n'.join(text.splitlines(True))
        return super()._fill_text(text, width, indent)

parser = argparse.ArgumentParser(formatter_class=MyFormatter)

`raw_description` 参数

Argparse 2.7 及更高版本提供了 raw_description 参数，它允许你指定帮助文本的原始格式，而无需转义或自定义格式化程序，例如：

parser.add_argument('-g', choices=['a', 'b', 'g', 'd', 'e'], default='a',
    raw_description="Some option, where\n"
         " a = alpha\n"
         " b = beta\n"
         " g = gamma\n"
         " d = delta\n"
         " e = epsilon")