Python argparse参数帮助信息换行排版问题求助

argparse默认的HelpFormatter会自动重新格式化帮助文本，你手动添加的换行符\n和三引号里的格式会被覆盖，所以直接设置没用。要保留自定义的换行、编号列表这类格式，需要指定专门的格式化类。

方法一：使用RawTextHelpFormatter #

创建ArgumentParser时，通过formatter_class参数指定argparse.RawTextHelpFormatter，它会完全保留你在help参数里写的原始格式，包括换行、编号和缩进。

示例代码：

import argparse

# 初始化解析器时指定格式化类
parser = argparse.ArgumentParser(
    formatter_class=argparse.RawTextHelpFormatter
)

# 定义参数时直接编写带格式的帮助文本
parser.add_argument(
    "--input",
    help="输入文件路径，支持以下几种格式：\n"
         "1. CSV格式：逗号分隔的结构化文本文件\n"
         "2. JSON格式：标准键值对结构文件\n"
         "3. XML格式：带根节点的标记语言文件"
)

args = parser.parse_args()

运行脚本并加上--help参数，就能看到和你编写的完全一致的带编号换行格式。

方法二：使用RawDescriptionHelpFormatter #

如果你只需要让脚本的description和epilog保留原始格式，而参数的help文本仍用默认格式化逻辑，可以用RawDescriptionHelpFormatter。但如果要参数的帮助文本也自定义格式，优先用第一种方法。

注意事项 #

• 使用RawTextHelpFormatter后，所有帮助文本的格式需要手动控制，比如缩进、换行，避免出现排版错乱。
• 如果帮助文本里包含百分号%，需要用两个百分号%%转义，防止argparse解析时出错。

内容的提问来源于stack exchange，提问作者Amit Aizenman