Argarse教程

本教程旨在简要介绍Python标准库中推荐的命令行解析模块

Argparse教程

argparse是Python内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从sys.argv中解析出这些参数，并自动生成帮助和使用信息。

基础

让我们从一个简单的例子开始，这个例子没有进行添加参数：

import argparse  #导入模块
parser = argparse.ArgumentParser()   #创建对象
parser.parse_args()  #解析添加的参数  

#测试结果
E:\vscode\test>python test_2.py --help
usage: test_2.py [-h]

optional arguments:
  -h, --help  show this help message and exit

E:\vscode\test>python test_2.py --verbose
usage: test_2.py [-h]
test_2.py: error: unrecognized arguments: --verbose

E:\vscode\test>python test_2.py foo
usage: test_2.py [-h]
test_2.py: error: unrecognized arguments: foo

分析：

• 在没有任何选项的情况下运行脚本不会显示任何标准输出
• 打印帮助信息，该--help选项也可以缩短为-h，该项无需指定
• 无法识别的参数，因没有添加该参数项
• 同上

位置参数

一个例子：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")  #添加参数
args = parser.parse_args()
print(args.echo)

#测试
E:\vscode\test>python test_2.py
usage: test_2.py [-h] echo
test_2.py: error: the following arguments are required: echo

E:\vscode\test>python test_2.py --help
usage: test_2.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit

E:\vscode\test>python test_2.py bozhou
bozhou

分析：
我们添加了add_argument（）方法，这是我们用来指定程序愿意接受哪些命令行选项。将它命名为echo

• 该参数是必需的：echo
• parse_args()方法实际上从指定的选项中返回一些数据，在本例中为echo
• 可以看到这些操作不需要指定值保存在哪个变量中，而且还能根据参数名称和辅助信息来进行介绍

但请注意，虽然帮助显示屏看起来不错，但它目前并不像它那样有帮助。例如，我们看到我们得到了echo一个位置参数，但除了通过猜测或通过阅读源代码之外，我们不知道它的作用。所以，让我们更有用一点：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")  #对参数进行介绍
args = parser.parse_args()
print(args.echo)

#测试
E:\vscode\test>python test_2.py -h
usage: test_2.py [-h] echo

positional arguments:
  echo        echo the string you use here

optional arguments:
  -h, --help  show this help message and exit

进一步

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)

#测试
E:\vscode\test>python test_2.py 7
Traceback (most recent call last):
  File "test_2.py", line 6, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
#argarse将我们提供的值看作为字符串，所以报错

#所以需要指定参数类型
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)
#测试
E:\vscode\test>python test_2.py 10
100

可选参数

以上介绍的是位置参数，下面介绍一下如何添加可选参数：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")

#测试
E:\vscode\test>python test_2.py --verbosity 1
verbosity turned on

E:\vscode\test>python test_2.py -h
usage: test_2.py [-h] [--verbosity VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity  

E:\vscode\test>python test_2.py --verbosity
usage: test_2.py [-h] [--verbosity VERBOSITY]
test_2.py: error: argument --verbosity: expected one argument

• --verbosity作用是在写入程序时指定显示某些内容，如果没有使用可选参数，情况下args.verbosity，相关变量将None作为值给出
• 当使用参数时，必需指定一些值，否则报错

进一步：

#如上所述，当使用参数时，必需要指定一些值。但也可以通过action='store_true'设置，运行使用参数时，也可以不传入值
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

#测试
#不指定参数也不报错，请注意，我们现在指定一个新的关键字action，并为其指定值“store_true”。 这意味着，如果指定了该选项，则将值True指定给args.verbose。 不指定它意味着False。
E:\vscode\test>python test_2.py --verbose
verbosity turned on

#It complains when you specify a value, in true spirit of what flags actually are.
E:\vscode\test>python test_2.py --verbose 1
usage: test_2.py [-h] [--verbose]
test_2.py: error: unrecognized arguments: 1

短期选项

-+名称

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

#测试
E:\vscode\test>python test_2.py -v
verbosity turned on

结合位置参数和可选参数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print("the square of {} equals {}".format(args.square, answer))
else:
    print(answer)

#测试
E:\vscode\test>python test_2.py 10
100                                        #不指定--verbose时，为False

E:\vscode\test>python test_2.py 10 --verbose
the square of 10 equals 100

如何让程序拥有多个verbosity值，如下：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

#测试
E:\vscode\test>python test_2.py 10 -v 1
10^2 == 100

E:\vscode\test>python test_2.py 10 -v 2
the square of 10 equals 100

E:\vscode\test>python test_2.py 10 -v 3
100

可以看到最后一个是不严谨的，进一修改，让我们通过限制--verbosity选项可以接受的值来修复它：

#添加choices限制
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

#测试结果
E:\vscode\test>python test_2.py 10 -v 3
usage: test_2.py [-h] [-v {0,1,2}] square
test_2.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)

E:\vscode\test>python test_2.py 10 -h
usage: test_2.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

实现多个verbosity值的另一种方法实现，引入了另一个操作“count”来计算特定可选参数的出现次数，很有意思：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

#测试
E:\vscode\test>python test_2.py 10 -vv
the square of 10 equals 100

E:\vscode\test>python test_2.py 10 -v
10^2 == 100

E:\vscode\test>python test_2.py 10 --verbosity --verbosity
the square of 10 equals 100

default参数：

#没有default设置，示例
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count")
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print("Running '{}'".format(__file__))
if args.verbosity >= 1:
    print("{}^{} == ".format(args.x, args.y), end="")
print(answer)

#测试
E:\vscode\test>python test_2.py 10 2
Traceback (most recent call last):
  File "test_2.py", line 8, in <module>
    if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'
#当不使用-v可选参数时会报错，因为返回的时None，解决办法设置default=0

parser.parse_known_args()和parser.parse_args()的区别
使用parser.parse_known_args()时，在接受多余的命令行参数时不报错，并对多余的命令行参数信息和值进行保存

import argparse 
parser = argparse.ArgumentParser() 
parser.add_argument( 
    '--flag_int', 
    type=float, 
    default=0.01, 
    help='flag_int.' 
) 
FLAGS, unparsed = parser.parse_known_args() 
print(FLAGS) 
print(unparsed)
#输出
E:\vscode\test>python test_2.py --flag_int 0.02 --double 0.03 a 1
Namespace(flag_int=0.02)
['--double', '0.03', 'a', '1']

待续````````````````````````````````````````````有时间再整理