argparse添加例如使用

Question

我用argparse來處理輸入參數，它輸出與parser.print_help（）以下：

optional arguments: 
    -h, --help   show this help message and exit 
    -t TEMPLATES, --templates TEMPLATES 
        template names to make, should be defined as section 
        name in conf, and have related file in templates/ 
        folder 
    -c CONFPATH, --confpath CONFPATH 
        configuration path for template detail info 

我的代碼如下所示：

import argparse 
    parser = argparse.ArgumentParser(prog='base_maker', description='template maker') 
    parser.add_argument('-t', '--templates', help='template names to make, should be defined as section name in conf, and have related file in templates/ folder', type=str) 
    parser.add_argument('-c', '--confpath', help='configuration path for template detail info', type=str, default=os.path.join(basepath, 'conf/maker.conf')) 

然而，我想補充有關如何使用-t /一個詳細的例子 - 模板一樣（在例如添加部分）：

optional arguments: 
    -h, --help   show this help message and exit 
    -t TEMPLATES, --templates TEMPLATES 
        template names to make, should be defined as section 
        name in conf, and have related file in templates/ 
        folder 
    -c CONFPATH, --confpath CONFPATH 
        configuration path for template detail info 

example: 

    python test.py -t template/test.py 
    python test.py -t template/test -c conf/test.conf 
    python test.py -t test.py 

我不知道應該使用哪個屬性來添加「示例」部分，我檢查了Print program usage example with argparse modulen，但是當我檢查epilog in the official doc時，我不清楚和沒有詳細示例。

任何人都可以給我一個關於如何實現的例子嗎？謝謝

Answer 1

如果您希望在末尾打印示例（epilog）並保留空格/格式（formatter_class設置爲RawDescriptionHelpFormatter），則需要使用epilog和formatter_class參數到ArgumentParser。

通過修改你上面的例子舉例：

import argparse 

example_text = '''example: 

python test.py -t template/test.py 
python test.py -t template/test -c conf/test.conf 
python test.py -t test.py''' 

parser = argparse.ArgumentParser(prog='base_maker', 
           description='template maker', 
           epilog=example_text, 
           formatter_class=argparse.RawDescriptionHelpFormatter) 

parser.add_argument('-t', '--templates', help='template names to make, should be defined as section name in conf, and have related file in templates/ folder', type=str) 
parser.add_argument('-c', '--confpath', help='configuration path for template detail info', type=str, default=os.path.join(basepath, 'conf/maker.conf'))