argparse中的自定义'使用'功能?

时间:2014-01-17 12:02:10

标签: python argparse

是否可以添加自定义'usage'函数,而不是python argparse提供的默认用法消息。

示例代码:

parser = argparse.ArgumentParser(description='Sample argparse py')
parser.add_argument('-arg_1',type=int, custom_usage_funct('with_some_message'))
output = parser.parse_args()

def custom_usage_funct(str):
    print str
    print '''
       Usage: program.py
         [-a, Pass argument a]
         [-b, Pass argument b]
         [-c, Pass argument c]
         [-d, Pass argument d]
         comment
         more comment
        '''

如果传递的参数是字符串值而不是整数,则程序应调用自定义使用函数,并显示错误消息“请提供整数值”

有效参数

program.py -arg_1 123

无效的参数

program.py -arg_1 abc

       Please provide an integer value
       Usage: program.py
         [-a, Pass argument a]
         [-b, Pass argument b]
         [-c, Pass argument c]
         [-d, Pass argument d]
         comment
         more comment

2 个答案:

答案 0 :(得分:11)

是的,可以使用usage = keyword参数覆盖默认消息,如下所示,

def msg(name=None):                                                            
    return '''program.py
         [-a, Pass argument a]
         [-b, Pass argument b]
         [-c, Pass argument c]
         [-d, Pass argument d]
         comment
         more comment
        '''

并使用

import argparse
parser = argparse.ArgumentParser(description='Sample argparse py', usage=msg())
parser.add_argument("-arg_1", help='with_some_message')
parser.print_help()

以上输出是这样的,

usage: program.py
         [-a, Pass argument a]
         [-b, Pass argument b]
         [-c, Pass argument c]
         [-d, Pass argument d]
         comment
         more comment


Sample argparse py

optional arguments:
  -h, --help    show this help message and exit
  -arg_1 ARG_1  with_some_message

注意:请参阅here

Using action=关键字参数

>>> class FooAction(argparse.Action):
...     def __call__(self, parser, namespace, values, option_string=None):
...         print '%r %r %r' % (namespace, values, option_string)
...         setattr(namespace, self.dest, values)
...
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=FooAction)
>>> parser.add_argument('bar', action=FooAction)
>>> args = parser.parse_args('1 --foo 2'.split())
Namespace(bar=None, foo=None) '1' None
Namespace(bar='1', foo=None) '2' '--foo'
>>> args
Namespace(bar='1', foo='2')

答案 1 :(得分:3)

是的,请使用usage选项。来自文档:

>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
>>> parser.add_argument('--foo', nargs='?', help='foo help')
>>> parser.add_argument('bar', nargs='+', help='bar help')
>>> parser.print_help()
usage: PROG [options]

positional arguments:
 bar          bar help

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