python学习之argparse模块的使用

argparse 使用

1. 创建 ArgumentParser() 对象
2. 调用 add_argument() 方法添加参数
3. 使用 parse_args() 解析添加的参数

eg

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()
print(args.integer)

将上面的代码保存为文件 argparse_usage.py，在终端运行，结果如下：

$ python argparse_usage.py
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: too few arguments
 
$ python argparse_usage.py abcd
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: argument integer: invalid int value: 'abcd'
 
$ python argparse_usage.py -h
usage: argparse_usage.py [-h] integer
 
positional arguments:
  integer     display an integer
 
optional arguments:
  -h, --help  show this help message and exit
 
$ python argparse_usage.py 10
10

可选参数

现在看下可选参数的用法，所谓可选参数，也就是命令行参数是可选的，废话少说，看下面例子:

# -*- coding: utf-8 -*-
 
import argparse
 
parser = argparse.ArgumentParser()
 
parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)
 
args = parser.parse_args()
 
if args.square:
    print(args.square**2)
 
if args.cubic:
    print(args.cubic**3)

将上面的代码保存为文件 argparse_usage.py，在终端运行，结果如下

$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
 
optional arguments:
  -h, --help       show this help message and exit
  --square SQUARE  display a square of a given number
  --cubic CUBIC    display a cubic of a given number
 
$ python argparse_usage.py --square 8
64
 
$ python argparse_usage.py --cubic 8
512
 
$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8
 
$ python argparse_usage.py  # 没有输出

混合使用

定位参数和选项参数可以混合使用，看下面一个例子，给一个整数序列，输出它们的和或最大值（默认）：

import argparse
 
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                   help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                   const=sum, default=max,
                   help='sum the integers (default: find the max)')
 
args = parser.parse_args()
print(args.accumulate(args.integers))
结果：
$ python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: too few arguments
$ python argparse_usage.py 1 2 3 4
4
$ python argparse_usage.py 1 2 3 4 --sum
10