为python脚本编写帮助

Question

我试图使我的python脚本非常用户友好，因此我想为其提供某种帮助。您对此有何建议？我可以提出一些逻辑，即如果用户将帮助作为脚本的参数传递给他们，他们将获得帮助。是否有最佳实践或惯例？

Answer 1

使用argparse。

例如，使用 test.py ：

import argparse

parser=argparse.ArgumentParser(
    description='''My Description. And what a lovely description it is. ''',
    epilog="""All's well that ends well.""")
parser.add_argument('--foo', type=int, default=42, help='FOO!')
parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!')
args=parser.parse_args()

跑步

% test.py -h

产量

usage: test.py [-h] [--foo FOO] [bar [bar ...]]

My Description. And what a lovely description it is.

positional arguments:
  bar         BAR!

optional arguments:
  -h, --help  show this help message and exit
  --foo FOO   FOO!

All's well that ends well.