Python Argparseの使い方 DefaultとStore_trueのExampleを解説

Python Argparseは、コマンドライン引数を簡単に扱うためのライブラリです。この記事では、ArgparseのDefaultとStore_trueという2つの機能について解説します。

Python Argparseとは

Python Argparseは、コマンドライン引数を簡単に扱うためのライブラリです。Argparseを使用することで、コマンドラインからプログラムを実行する際に必要なパラメータを簡単に指定できるようになります。

Defaultの設定方法

Defaultは、コマンドライン引数が指定されなかった場合に、自動的に設定される値を指定するための機能です。Defaultを設定するには、add_argument()メソッドにdefaultパラメータを指定します。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--input_file", help="入力ファイル名", default="input.txt")
args = parser.parse_args()
print(args.input_file)  # 引数が指定されなかった場合は、"input.txt"が表示される

Store_trueの設定方法

Store_trueは、引数が指定された場合に、Trueを設定するための機能です。Store_trueを設定するには、add_argument()メソッドにaction=”store_true”パラメータを指定します。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="冗長モード", action="store_true")
args = parser.parse_args()
if args.verbose:
    print("冗長モードが有効です")

DefaultとStore_trueの違い

DefaultとStore_trueの違いは、引数が指定されなかった場合の動作です。Defaultは、引数が指定されなかった場合に自動的に設定される値を指定することができます。一方、Store_trueは、引数が指定されなかった場合に、Falseが設定されます。

DefaultとStore_trueを使ったコード例の解説

以下のコード例は、DefaultとStore_trueを組み合わせた例です。–verboseオプションが指定された場合には、冗長モードが有効になります。また、–output_fileオプションが指定されなかった場合には、デフォルトの出力ファイル名を使用します。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="冗長モード", action="store_true")
parser.add_argument("--output_file", help="出力ファイル名", default="output.txt")
args = parser.parse_args()
if args.verbose:
    print("冗長モードが有効です")
print(args.output_file)  # 引数が指定されなかった場合は、"output.txt"が表示される

よくあるエラーとその対処法

    • エラー：error: argument -f/–file: expected one argument
    • 対処法：オプションの引数が必要な場合は、nargsパラメータに引数の数を指定します。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", help="ファイル名", nargs=1)
args = parser.parse_args()
print(args.file)  # 引数が指定されなかった場合は、Noneが表示される
  • エラー：error: unrecognized arguments: –verbose
  • 対処法：add_argument()メソッドで設定していないオプションが指定された場合には、エラーが発生します。指定するオプションがある場合には、add_argument()メソッドで設定してください。

まとめ

Python ArgparseのDefaultとStore_trueは、コマンドライン引数を簡単に扱うための機能です。Defaultを使用することで、引数が指定されなかった場合に自動的に設定される値を指定することができます。Store_trueを使用することで、引数が指定された場合にTrueを設定することができます。