python-argparse模块使用

一、argparse

argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从 sys.argv 中解析出这些参数，并自动生成帮助和使用信息。当然，Python 也有第三方的库可用于命令行解析，而且功能也更加强大，比如 docopt，Click。

二、argparse 使用

   1、简单示例

            我们先来看一个简单示例。主要有三个步骤：

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

# -*- coding: utf-8 -*-
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

          add_argument() 方法

          add_argument() 方法定义如何解析命令行参数：

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default]
                                        [, type][, choices][, required][, help]
                                        [, metavar][, dest])


参数：
    以下参数：name or flags、nargs、default、type、choices、help比较常用

1、name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
2、action - 命令行遇到参数时的动作，默认值是 store。
    store_const，表示赋值为const；
    append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
    append_const，将参数规范中定义的一个值保存到一个列表；
    count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
3、nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，
    对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
4、const - action 和 nargs 所需要的常量值。
5、default - 不指定参数时的默认值。
6、type - 命令行参数应该被转换成的类型。
7、choices - 参数可允许的值的一个容器。
8、required - 可选参数是否可以省略 (仅针对可选参数)。
9、help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
10、metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
11、dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

    2、定位参数

         上面的示例，其实就展示了定位参数的使用，我们再来看一个例子 - 计算一个数的平方：

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

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

$ python argparse_usage.py 9
81

    3、可选参数

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

# -*- 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 # 没有输出

   4、混合使用

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

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

三、argparse 使用过程中的一些小问题

1、在windows终端中参数只能传输一部分，后面的参数无法传输？

     执行命令：

       问题：--max_imgNum 500 这个参数传输不到函数里面

       原因：通过notepad++记事本编写的命令如下：

python google_image_main.py "https://www.google.com/search?q=%E4%BA%94%E6%98%9F%E6%97%97%20%E6%8C%87%E7%94%B2&tbm=isch&hl=zh-CN&hl=zh-CN&tbs=rimg%3ACarqcr3KlympYfRARxyiujOy&sa=X&ved=0CAIQrnZqFwoTCLi6g8KG7-sCFQAAAAAdAAAAABAQ&biw=1903&bih=937" --keyword '国旗损坏侮辱与国旗商品' --max_imgNum 500 --head True

                  由于notepad++默认的编码格式为 utf-8，而windows默认编码为 gb2312，因此在解码 中文 时出现问题，导致后面的参数无法传入，因此需要将 notepad++的编码格式转化为 gb2312，且不能出现终端识别不了的字符，修改之后即可解决问题。

  2、argparse 无法传入 bool类型的参数

原因：终端始终会将 False True转化为字符串，因此无法传入该参数，解决方式，可以利用回调函数调用的方式解决

import argparse

def str2bool(v):
    if isinstance(v, bool):
        return v
    if v.lower() in ('yes', 'true', 't', 'y', '1'):
        return True
    elif v.lower() in ('no', 'false', 'f', 'n', '0'):
        return False
    else:
        raise argparse.ArgumentTypeError('Boolean value expected.')

def test_bool():
    parser = argparse.ArgumentParser(description="This code is used to test bool value.")
    parser.add_argument("--flag",
                        type=str2bool,
                        default=True,
                        help="Run or not.")
    args = parser.parse_args()

    if args.flag:
        print(f"# Flag: {True}")
    else:
        print(f"# Flag: {False}")

if __name__ == '__main__':
    test_bool()

 

Reference

        【Python】argparse模块