如何將說明手冊添加到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)