像在 python 上一样打印 linux man-help

Question

我正在尝试像 Linux man 那样为我的自定义应用程序构建帮助消息输出。我一直在使用 pprint、使用字典等。但是，我有点失落。我目前正在使用字典与打印命令相结合。到目前为止已经足够满足我的需求了，但我必须承认它还没有达到标准。

我想使用 flags 命令样式，我的意思是 -f 、 -t 等。我认为建立的目的是使用解析器或类似的东西提取数据。

那么，简而言之，你们如何构建帮助消息以正确使用基于命令的应用程序？

Answer 1

optparse 和 argparse 都支持打印使用详细信息。

Answer 2

有 optparse 模块及其后继 argparse （第一个自 Python 2.7 起已弃用）。这些模块自动生成如下所示的帮助输出（来自 Python 文档）：

$ prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
 N           an integer for the accumulator

optional arguments:
 -h, --help  show this help message and exit
 --sum       sum the integers (default: find the max)