python中parser.add_argument（）⽤法实例（命令⾏选
项、参数和⼦命令解析器）
⽬录
⼀、argparse介绍
⼆、argparse使⽤——代码⽰例
1、创建⼀个解析器——创建 ArgumentParser() 对象
2、添加参数——调⽤ add_argument() ⽅法添加参数
3、解析参数——使⽤ parse_args() 解析添加的参数
四、python args parse_args() 报错解决
1、error: the following arguments are required: xxx
五、其他问题汇总（评论⼩伙伴问的）
1、下划线_和横线-的区别
2、debug怎么进⾏？
总结
⼀、argparse介绍
argparse 模块是 Python 内置的⼀个⽤于命令项选项与参数解析的模块，argparse 模块可以让⼈轻松编写⽤户友好的命令⾏接⼝。通过在程序中定义好我们需要的参数，然后 argparse 将会从 sys.argv 解析出这些参数。argparse 模块还会⾃动⽣成帮助和使⽤⼿册，并在⽤户给程序传⼊⽆效参数时报出错误信息。
⼆、argparse使⽤——代码⽰例
⼀个简单的⽰例。
import argparse
parser = argparse.ArgumentParser(description='test')
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
args = parser.parse_args()
print(args.sparse)
print(args.seed)
print(args.epochs)
三个步骤：
1、创建⼀个解析器——创建 ArgumentParser() 对象
2、添加参数——调⽤ add_argument() ⽅法添加参数
3、解析参数——使⽤ parse_args() 解析添加的参数
1、创建⼀个解析器——创建 ArgumentParser() 对象
使⽤ argparse 的第⼀步是创建⼀个 ArgumentParser 对象：
parser = argparse.ArgumentParser(description='test')parse error怎么解决
ArgumentParser 对象包含将命令⾏解析成 Python 数据类型所需的全部信息。
描述description
⼤多数对 ArgumentParser 构造⽅法的调⽤都会使⽤ description= 关键字参数。这个参数简要描述这个程度做什么以及怎么做。在帮助消息中，这个描述会显⽰在命令⾏⽤法字符串和各种参数的帮助消息之间。
2、添加参数——调⽤ add_argument() ⽅法添加参数
给⼀个 ArgumentParser 添加程序参数信息是通过调⽤ add_argument() ⽅法完成的。通常，这些调⽤指定 ArgumentParser
如何获取命令⾏字符串并将其转换为对象。这些信息在 parse_args() 调⽤时被存储和使⽤。例如
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
add_argument() ⽅法定义如何解析命令⾏参数
ArgumentParser.add_argument(name [, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
每个参数解释如下:
name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
action - 命令⾏遇到参数时的动作，默认值是 store。
store_const，表⽰赋值为const；
append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
append_const，将参数规范中定义的⼀个值保存到⼀个列表；
count，存储遇到的次数；此外，也可以继承 argparse.Action ⾃定义参数解析；
nargs - 应该读取的命令⾏参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使⽤default，对于 Optional argument 使⽤ const；或者是 * 号，表⽰ 0 或多个参数；或者是 + 号表⽰ 1 或多个参数。
const - action 和 nargs 所需要的常量值。
default - 不指定参数时的默认值。
type - 命令⾏参数应该被转换成的类型。
choices - 参数可允许的值的⼀个容器。
required - 可选参数是否可以省略 (仅针对可选参数)。
help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表⽰不显⽰该参数的帮助信息.
metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全⼤
写的参数名称.
dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.
3、解析参数——使⽤ parse_args() 解析添加的参数
ArgumentParser 通过 parse_args() ⽅法解析参数。它将检查命令⾏，把每个参数转换为适当的类型然后调⽤相应的操作。在⼤多数情况下，这意味着⼀个简单的 Namespace 对象将从命令⾏解析出的属性构建：
args = parser.parse_args()
在脚本中，通常 parse_args() 会被不带参数调⽤，⽽ ArgumentParser 将⾃动从 sys.argv 中确定命令⾏参数。
三、结果测试
import argparse
parser = argparse.ArgumentParser(description='test')
parser.add_argument('--sparse', action='store_true', default=False, help='GAT with sparse version or not.')
parser.add_argument('--seed', type=int, default=72, help='Random seed.')
parser.add_argument('--epochs', type=int, default=10000, help='Number of epochs to train.')
args = parser.parse_args()
print(args.sparse)
print(args.seed)
print(args.epochs)
显⽰帮助⽂档：
输错命令会告诉你usage⽤法：
使⽤命令修改参数：
action='store_true’的使⽤说明
action·- 命令⾏遇到参数时的动作，默认值是 store。
直接运⾏python test.py，输出结果False
运⾏python test.py --sparse，输出结果True
也就是说，action=‘store_true’，只要运⾏时该变量有传参就将该变量设为True。
四、python args parse_args() 报错解决
1、error: the following arguments are required: xxx
报错：
usage: test.py [-h] xxx
test.py: error: the following arguments are required: xxx
原因：
args分为可选参数（⽤--指定）和必选参数（不加--指定）。
如果你定义参数xxx时，没有⽤--指定，那么该参数为需要在命令⾏内⼿动指定。此时即使通过default设置默认参数，也还是会报错。
五、其他问题汇总（评论⼩伙伴问的）
1、下划线_和横线-的区别
Q1：请问博主，第⼀个位置参数假如说是--max_episode_len，然后也有⼈写是--max-episode-len，但是他在调⽤的时候仍然⽤的是args.max_episode_len，也没报错，请问这个下划线_和-的区别在哪⾥呢？
A1：没啥区别，在这⾥表⽰同⼀个意思，-对应_，代码⾥写的不⼀样或者都改成⼀样的都可以
2、debug怎么进⾏？
Q2：这种运⾏是不是脱离ide，那debug怎么进⾏啊？
A2：有linux下，命令⾏单点调试的⽅法，python -m pdb test.py，搜⼀搜，⽹上挺多
总结
到此这篇关于python中parser.add_argument()⽤法的⽂章就介绍到这了，更多相关python parser.add_argument()⽤法内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。