Argparse：「オプションの引数」の下にリストされている必須の引数？

次の簡単なコードを使用して、いくつかの引数を解析します。そのうちの1つが必要であることに注意してください。残念ながら、ユーザーが引数を指定せずにスクリプトを実行すると、表示される使用法/ヘルプテキストは、オプションではない引数があることを示していません。引数がオプションではないことを示すようにpythonを取得するにはどうすればよいですか？

これがコードです：

import argparse
if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description='Foo')
    parser.add_argument('-i','--input', help='Input file name', required=True)
    parser.add_argument('-o','--output', help='Output file name', default="stdout")
    args = parser.parse_args()
    print ("Input file: %s" % args.input )
    print ("Output file: %s" % args.output )

必要な引数を提供せずに上記のコードを実行すると、次の出力が得られます。

usage: foo.py [-h] -i INPUT [-o OUTPUT]

Foo

optional arguments:
    -h, --help            show this help message and exit
    -i INPUT, --input INPUT
                          Input file name
    -o OUTPUT, --output OUTPUT
                          Output file name

-またはで始まるパラメーター--は、通常はオプションと見なされます。他のすべてのパラメーターは位置パラメーターであり、（位置関数の引数のように）設計上必要です。オプションの引数を要求することは可能ですが、これは設計に少し反します。それらは依然として非定位置引数の一部であるため、たとえそれらが必要な場合でも、混乱するヘッダー「オプション引数」の下に引き続きリストされます。ただし、使用法の部分に角括弧がないことは、それらが実際に必要であることを示しています。

ドキュメントも参照してください：

一般に、argparseモジュールは、-fや--barなどのフラグがオプションの引数を示していると想定しています。これは、コマンドラインでは常に省略できます。

注：ユーザーがオプションをオプションであることを期待しているため、必要なオプションは一般に不適切なフォームと見なされ、可能な場合は回避する必要があります。

つまり、ヘルプの「位置引数」と「オプション引数」のヘッダーは、引数が自動的に分離される2つの引数グループによって生成されます。これで、「ハックイン」してオプションの名前を変更できますが、はるかに洗練された解決策は、「必須の名前付き引数」（またはそれらを呼び出すもの）の別のグループを作成することです。

parser = argparse.ArgumentParser(description='Foo')
parser.add_argument('-o', '--output', help='Output file name', default='stdout')
requiredNamed = parser.add_argument_group('required named arguments')
requiredNamed.add_argument('-i', '--input', help='Input file name', required=True)
parser.parse_args(['-h'])

usage: [-h] [-o OUTPUT] -i INPUT

Foo

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output file name

required named arguments:
  -i INPUT, --input INPUT
                        Input file name

私はオプションの前に必要な引数をリストすることを好むので、私はそれをハックします：

    parser = argparse.ArgumentParser()
    parser._action_groups.pop()
    required = parser.add_argument_group('required arguments')
    optional = parser.add_argument_group('optional arguments')
    required.add_argument('--required_arg', required=True)
    optional.add_argument('--optional_arg')
    return parser.parse_args()

そしてこの出力：

usage: main.py [-h] [--required_arg REQUIRED_ARG]
               [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  --optional_arg OPTIONAL_ARG

オプションの引数グループに「ヘルプ」が表示されなくても私は生きることができます。

@Karl Rosaenの建物

parser = argparse.ArgumentParser()
optional = parser._action_groups.pop() # Edited this line
required = parser.add_argument_group('required arguments')
# remove this line: optional = parser...
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')
parser._action_groups.append(optional) # added this line
return parser.parse_args()

そしてこの出力：

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG

もう一度、@ RalphyZから構築します

これは公開されたAPIを壊しません。

from argparse import ArgumentParser, SUPPRESS
# Disable default help
parser = ArgumentParser(add_help=False)
required = parser.add_argument_group('required arguments')
optional = parser.add_argument_group('optional arguments')

# Add back help 
optional.add_argument(
    '-h',
    '--help',
    action='help',
    default=SUPPRESS,
    help='show this help message and exit'
)
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')

上記と同じように表示され、将来のバージョンでも存続するはずです。

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG