如何将说明手册添加到python脚本

Question

什么是为python脚本记录或创建某种迷你手册的最佳方式。例如脚本-h来显示如何运行它。 任何模板？

Answer 1

Python有一个内置库来完成这个任务。如果你的目标是Python < = 2.7，那么你应该使用optparse，如果它是2.7+然后使用argparse。

optparse模块的工作原理如下。您可以指定脚本应接受的参数，然后致电parse_args。如果传入-h，则会为您处理参数并输出帮助消息。​​模块的工作方式与此类似。

from optparse import OptionParser 

parser = OptionParser() 
parser.add_option("-f", "--file", dest="filename", 
       help="write report to FILE", metavar="FILE") 
parser.add_option("-q", "--quiet", 
       action="store_false", dest="verbose", default=True, 
       help="don't print status messages to stdout") 

(options, args) = parser.parse_args() 

Answer 2

您可以使用处理程序选项的库;他们大多数已自动生成-help标志

例如argparse（在标准库中）为您做。

Answer 3

使用argparse模块。

Answer 4

如果你不介意外部的依赖关系，我发现http://pypi.python.org/pypi/plac是伟大的。

从the documentation：

def main(dsn): 
    "Do something with the database" 
    print(dsn) 
    # ... 

if __name__ == '__main__': 
    import plac; plac.call(main)