如何让Python脚本的--help输出同时显示模块文档字符串与参数帮助？

当然可以实现，这里提供两种简洁可行的方案：

方案一：利用argparse的description参数（推荐） #

把模块的文档字符串直接传给ArgumentParser的description参数，同时使用RawDescriptionHelpFormatter保留文档字符串的原始格式，argparse会自动将文档内容整合到帮助信息的顶部。

示例代码：

#!/usr/bin/env python3
"""Plot multiple DOS/PDOS in a single plot
run python dplot.py -h for more usage"""

import argparse

def main():
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.RawDescriptionHelpFormatter
    )
    # 添加你的命令行参数
    parser.add_argument('--dos', help='指定DOS/PDOS文件路径')
    parser.add_argument('--label', help='为每组数据设置标签')
    parser.add_argument('--fermi', type=float, help='设置费米能数值')
    
    args = parser.parse_args()

if __name__ == '__main__':
    main()

执行python foo.py -h时，会先展示你的模块文档字符串，再输出argparse生成的参数帮助内容，整体格式统一规范。

方案二：手动检测帮助参数并打印文档字符串 #

通过检查命令行参数中是否包含-h或--help，提前打印模块文档字符串，再让argparse处理帮助请求。

示例代码：

#!/usr/bin/env python3
"""Plot multiple DOS/PDOS in a single plot
run python dplot.py -h for more usage"""

import argparse
import sys

def main():
    # 检测是否请求帮助
    if '-h' in sys.argv or '--help' in sys.argv:
        print(__doc__)
    
    parser = argparse.ArgumentParser()
    # 添加你的命令行参数
    parser.add_argument('--dos', help='指定DOS/PDOS文件路径')
    parser.add_argument('--label', help='为每组数据设置标签')
    parser.add_argument('--fermi', type=float, help='设置费米能数值')
    
    args = parser.parse_args()

if __name__ == '__main__':
    main()

这种方式会先输出你的文档字符串，再打印argparse的帮助信息，适合需要自定义输出顺序的场景。

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