Python基礎1

Python「argparse」モジュール †

Python「argparse」モジュール
- ArgumentParser (argparse)
- 更新履歴
参考資料

※ 最終更新:2021/02/22　

ArgumentParser (argparse) †

　「argparse」はプログラム実行時にコマンドラインで引数を受け取る処理を簡単に実装できる標準ライブラリ。
　ArgumentParser (argparse)を使うと様々な形式で引数を指定することができる。

$ python program.py test.txt --alpha 0.01

↑

使い方の基本 †

　プログラムの冒頭に次のような処理を実行する。

argparseをインポートする
parserを作る
引数を設定する

解析する

test.py

# 1. argparseをインポート
import argparse

# 2. パーサを作る
parser = argparse.ArgumentParser(description='プログラムの説明（省略可')

# 3. parser.add_argumentで受け取る引数を追加していく
parser.add_argument('arg1', help='この引数の説明（省略可')  # 必須の引数を追加
parser.add_argument('arg2', help='foooo')
parser.add_argument('--arg3')                               # オプション引数（指定しなくても良い引数）を追加
parser.add_argument('-a', '--arg4')                         # よく使う引数なら省略形があると使う時に便利

# 4. 引数を解析
args = parser.parse_args()

print('arg1='+args.arg1)
print('arg2='+args.arg2)
print('arg3='+args.arg3)
print('arg4='+args.arg4)

実行例

$ python test.py input.txt output.txt --arg3 11111 -a 22222
arg1=input.txt
arg2=output.txt
arg3=11111
arg4=22222

引数を知りたい場合に -h または --help を指定してヘルプ表示もできる。 $ python test.py -h

usage: test.py [-h] [--arg3 ARG3] [-a ARG4] arg1 arg2

このプログラムの説明（省略可）

positional arguments:
  arg1                  この引数の説明（省略可）
  arg2                  foooo

optional arguments:
  -h, --help            show this help message and exit
  --arg3 ARG3
  -a ARG4, --arg4 ARG4

↑

必須引数 †

add_argumentで引数名を'arg'のように普通に指定するとこれになる。
実行時に引数を指定する順番が決まっているので指定し忘れるとエラーになる。
上の例の arg1 と arg2。

↑

オプション引数 †

引数名を'-a'とか'--alpha'のようにハイフン('-')を1～2個つけたものにするとこれになる。
ハイフンの数は，引数名が1文字のときは1つ，それ以上のときは2つ付ける。
実行時には指定してもしなくても良く（指定されなかった場合は None になる）指定する順番も自由。
正式名称と略称（？）をつけられるのでよく使う引数なら両方あると便利。
```
parser.add_argument('-i', '--input')
```
- この場合実行時には -i と --input のどちらを使っても指定できる。
- ただしプログラム中では正式名称でしか参照できない。
```
parser.add_argument('-i', '--input')
args = parser.parse_args()
print(args.input)    # OK
print(args.i)        # エラー
```

↑

応用編 †

デフォルト値を指定
　オプション引数で指定されなかった場合は None になるが，デフォルト値を指定することもできる。
```
parser.add_argument('--message', default='hello!')
```
- 上記の実行時に --message が指定されていない場合は None の代わりに'hello!'になる。
型指定
　コマンドライン引数で指定された値はデフォルトでは文字列型。
- 整数値や実数値を指定する場合
```
parser.add_argument('--number', type=int)                 # 整数値(int)
parser.add_argument('--alpha', type=float, default=0.01)  # 実数値(float)
```
  このようにすると，指定された値はintやfloatに自動で変換される。
- type 引数には文字列から所望の型に変換する関数を渡せば良いので他にもいろいろなことができる。
  例：ピリオド'.'区切りの数値を指定してリストで受け取る。
```
tp = lambda x:list(map(int, x.split('.')))
parser.add_argument('--address', type=tp, help='IP address')

args = parser.parse_args()
print(args.address)
```
  実行例
```
$ python test.py --address 192.168.31.150
[192, 168, 31, 150]
```
- フラグとして使う
  add_argument に action を指定するとフラグとして使える。
```
parser.add_argument('--flag', action='store_true')
args = parser.parse_args()
print(args.flag)
```
  実行例
```
$ python test.py
False
$ python test.py --flag
True
```
  実行時に --flag が指定されていると True そうでないときは False になる。
  引数として具体的な値を指定するのではなく、その引数を指定する or しないことに意味を持たせたい時に使える。
  action='store_false' とすると逆の指定したら False になる。
- 複数個（不定）受け取る
```
parser.add_argument('--colors', nargs='*')
args = parser.parse_args()
print(args.colors)
```
  実行例
```
$ python test.py --colors red green blue
['red', 'green', 'blue']
```
- オプション引数を必須指定にする
  required=True を指定すると必須指定のオプション引数を作ることができる。
  この方法だと好きな順序で指定できる。
```
parser.add_argument("-a", required=True)
args = parser.parse_args()
print(args.a)
```
  実行例
```
$ python test.py -a hoge
hoge
$ python test.py
usage: test.py [-h] -a A
test.py: error: argument -a is required
```

↑

更新履歴 †

2021/02/22 初版

↑

参考資料 †

ArgumentParserの使い方を簡単にまとめた

最新の20件