Argparse: 必須引数が「オプション引数」の下にリストされていますか?

PYTHON3 チュートリアル

argparse モジュールを使用する場合、必須引数とオプション引数のリスト順序は通常次のように表示されます。

  • 必須引数 は常に位置引数として定義されます。argparse では、位置引数はコマンドラインで指定しないといけない引数で、デフォルトの設定ではオプション引数よりも先にリストされます。
  • オプション引数 はハイフン(- または --)で始まり、ユーザーが指定するかどうか選択できる引数です。

しかし、argparse のデフォルトのヘルプメッセージでは、必須引数がオプション引数の下にリストされることがあります。ヘルプのセクションでは、optional arguments のセクションの後に位置引数(必須引数)が「positional arguments」として表示されるのが一般的です。

例:

import argparse

parser = argparse.ArgumentParser(description='Example script')
parser.add_argument('filename', help='The file to process')  # 位置引数(必須)
parser.add_argument('--verbose', action='store_true', help='Increase output verbosity')  # オプション引数

args = parser.parse_args()

これを実行して --help を表示すると、次のような順序になります。

usage: script.py [-h] [--verbose] filename

positional arguments:
  filename         The file to process

optional arguments:
  -h, --help       show this help message and exit
  --verbose        Increase output verbosity

このように、positional arguments(必須引数)は optional arguments の後にリストされています。

ArgparseはPythonの標準ライブラリで、コマンドライン引数を処理するためのモジュールです。Argparseを使用すると、スクリプトを実行する際に引数を指定して動作をカスタマイズできます。

Argparseでは、引数を定義する際に必須引数とオプション引数を区別することができます。必須引数はスクリプトの実行に必要な引数であり、省略することができません。一方、オプション引数は任意の引数であり、省略することができます。

Argparseでは、通常、必須引数がオプション引数の下にリストされます。これにより、ユーザーがスクリプトを実行する際に最初に必要な引数を指定することができます。必須引数がオプション引数の下にリストされることで、スクリプトの使用方法が明確になり、ユーザーが引数を正しく指定することが容易になります。

購読
通知
0 Comments
Inline Feedbacks
View all comments