python - 为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 is 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 is well that ends well.