手把手教你用argparse打造专业级命令行帮助页

当你写完一个Python脚本准备分享给同事时，最尴尬的瞬间莫过于对方运行python script.py --help后皱起眉头："这个参数是必填的吗？默认值是多少？" 作为开发者，我们完全可以通过argparse的隐藏功能，让帮助页面从"勉强能用"升级为"专业文档"级别。

1. 为什么默认帮助页不够用

标准ArgumentParser生成的帮助页存在三个典型问题：

1. 默认值隐身：除非用户查看源码，否则无法知道--threads默认是4还是8
2. 参数堆砌：所有参数平铺展示，没有逻辑分组
3. 描述受限：多行说明会被压缩成单行，示例代码显示错乱

python复制# 典型的基础帮助页输出
optional arguments:
  -h, --help   show this help message and exit
  --name NAME  你的名字
  --age AGE    你的年龄

2. 让默认值一目了然

ArgumentDefaultsHelpFormatter是提升帮助页可用性的最快方式：

python复制from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter

parser = ArgumentParser(
    description='数据预处理工具',
    formatter_class=ArgumentDefaultsHelpFormatter  # 关键设置
)
parser.add_argument('--batch-size', type=int, default=32, 
                   help='训练批次大小')
parser.add_argument('--lr', type=float, default=0.001,
                   help='学习率')

输出效果显著改善：

code复制optional arguments:
  -h, --help       show this help message and exit
  --batc