argparse模块学习笔记

argsparse是python的命令行解析的标准模块，我们可以直接使用该模块利用电脑的命令行运行相关程序

---

一、利用argparse模块传入参数

1、单个参数传入

新建一个python文件，命名为demo.py，我们输入以下代码：

# 导入模块
import argparse
# 创建一个解析对象
parser = argparse.ArgumentParser(description='命令行中传入一个数字', epilog='这是命令行的结尾文字')
# 向该对象中添加你要关注的命令行参数和选项
# type是要传入的参数的数据类型  help是该参数的提示信息
parser.add_argument('integers', type=str, help='传入的数字')
# 进行解析
args = parser.parse_args()
# 获得传入参数的解析实例
print(args)
# 获得传入的integers参数
print(args.integers)

保存后，打开命令行，运用cd命令将工作目录转移到demo.py所在文件夹中，我demo.py存放的路径为：
D:\pycharm\file\python36\tool_learning\argparse_master
命令行输入如下：

C:\WINDOWS\system32>D:

D:\>cd D:\pycharm\file\python36\tool_learning\argparse_master

D:\pycharm\file\python36\tool_learning\argparse_master>

在命令行中输入python demo.py -h或者python demo.py --help, 查看该文件的帮助：

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py -h
usage: demo.py [-h] integers

命令行中传入一个数字

positional arguments:
  integers    传入的数字

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

这是命令行的结尾文字

现在我们在命令行中给demo.py 传入参数8，

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 8
Namespace(integers='8')
8

发现参数已经传入程序中，结果：Namespace(integers=‘8’)，8。

2、多个参数传入

在传入参数的过程中，我们可以使用 nargs='+'这个传参设置多个参数的传入。
修改程序为

# 导入模块
import argparse
# 创建一个解析对象
parser = argparse.ArgumentParser(description='命令行中传入一个数字', epilog='这是命令行的结尾文字')
# 向该对象中添加你要关注的命令行参数和选项
# type是要传入的参数的数据类型  help是该参数的提示信息
parser.add_argument('integers', type=str, nargs='+', help='传入的数字')
# 进行解析
args = parser.parse_args()
# 获得传入参数的解析实例
print(args)
# 获得传入的integers参数
print(args.integers)

结果为：

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1 2 3 4
Namespace(integers=['1', '2', '3', '4'])
['1', '2', '3', '4']

二、可选参数、默认参数与必需参数的设置

1、可选参数设置

在传入参数的过程中，我们可以使用 '–name’这个传参设置多个参数的传入。
修改程序为

# 导入模块
import argparse
# 创建一个解析对象
parser = argparse.ArgumentParser(description='命令行中传入一个数字', epilog='这是命令行的结尾文字')
# 向该对象中添加你要关注的命令行参数和选项
# type是要传入的参数的数据类型  help是该参数的提示信息
parser.add_argument('integers', type=str, help='传入的数字')
parser.add_argument('--family', type=str, help='姓')
parser.add_argument('--name', type=str, help='名')
# 进行解析
args = parser.parse_args()
# 获得传入参数的解析实例
print(args)
# 获得传入的integers参数
print(args.integers)

输入数据，结果如下：

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1 张 三
usage: demo.py [-h] [--family FAMILY] [--name NAME] integers
demo.py: error: unrecognized arguments: 张 三

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1
Namespace(family=None, integers='1', name=None)
1

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1 --family=张 --name=三
Namespace(family='张', integers='1', name='三')
1

这说明可选参数必须注明对应的参数名，如果没有输入则默认为none。

2、默认参数设置

使用default设置默认参数。
修改程序为

# 导入模块
import argparse
# 创建一个解析对象
parser = argparse.ArgumentParser(description='命令行中传入一个数字', epilog='这是命令行的结尾文字')
# 向该对象中添加你要关注的命令行参数和选项
# type是要传入的参数的数据类型  help是该参数的提示信息
parser.add_argument('integers', type=str, help='传入的数字')
parser.add_argument('--family', type=str, default='张', help='姓')
parser.add_argument('--name', type=str, default='三', help='名')
# 进行解析
args = parser.parse_args()
# 获得传入参数的解析实例
print(args)
# 获得传入的integers参数
print(args.integers)

结果：

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1
Namespace(family='张', integers='1', name='三')
1

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1 --family=李 --name=四
Namespace(family='李', integers='1', name='四')
1

3、必需参数设置

使用default设置默认参数。
修改程序为

# 导入模块
import argparse
# 创建一个解析对象
parser = argparse.ArgumentParser(description='命令行中传入一个数字', epilog='这是命令行的结尾文字')
# 向该对象中添加你要关注的命令行参数和选项
# type是要传入的参数的数据类型  help是该参数的提示信息
parser.add_argument('integers', type=str, help='传入的数字')
parser.add_argument('--family', type=str, default='张', help='姓')
parser.add_argument('--name', type=str, required=True, default='三', help='名')
# 进行解析
args = parser.parse_args()
# 获得传入参数的解析实例
print(args)
# 获得传入的integers参数
print(args.integers)
#打印姓名
print(args.family+args.name)

结果：

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1
usage: demo.py [-h] [--family FAMILY] --name NAME integers
demo.py: error: the following arguments are required: --name

D:\pycharm\file\python36\tool_learning\argparse_master>python demo.py 1 --family=李 --name=四
Namespace(family='李', integers='1', name='四')
1
李四

因为可选参数name的required=True，所以必须要传入。如果我们将其更改为False，则为默认方式。

三、设置不可更改

如果想让命令行不能更改相关设定，使用：

args = parser.parse_args(args=[])

这样，就不能在命令行中对参数进行更改。

---

总结

参考资料：https://zhuanlan.zhihu.com/p/56922793