web-dev-qa-db-ja.com

argparseのカスタム「使用」関数?

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
16
devav2

はい、デフォルトのメッセージは、次のようにusage =キーワード引数で上書きできます。

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

注:参照 ここ

引数の入力に基づいてカスタム関数を呼び出すこともできます singaction=キーワード引数:

>>> 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')
14
Syed Habib M

はい、 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
4
aquavitae