Pythonのargparseモジュールは、コマンドラインインターフェースの作成を容易にします。このモジュールは、プログラムが必要とする引数を定義し、それらをsys.argvから解析する方法をargparseに伝えます。
argparseモジュールの一部として、add_argument
メソッドがあります。このメソッドは、個々の引数仕様をパーサーにアタッチします。
parser.add_argument('filename') # positional argument
parser.add_argument('-c', '--count') # option that takes a value
parser.add_argument('-v', '--verbose', action='store_true') # on/off flag
ここで、metavar
というパラメーターがあります。これは、ヘルプメッセージ内で引数を表示するために使用される代替名です。
parser.add_argument('--foo', metavar='YYY')
parser.add_argument('bar', metavar='XXX')
上記の例では、--foo
とbar
という引数がありますが、ヘルプメッセージではそれぞれYYY
とXXX
と表示されます。
このように、metavar
はヘルプメッセージをより理解しやすくするために使用されます。特に、引数名が長い場合や理解しにくい場合に有用です。
以上がPythonのargparseモジュールのmetavar
についての説明です。この情報がPythonのコマンドライン引数の理解に役立つことを願っています。