argparse python 文件 python中argparse

转载

mob6454cc6aeeaf 2023-07-05 23:08:57

文章标签 argparse python 文件 python 开发语言命令行可选参数 文章分类 Python 后端开发

文章目录

1.介绍
2.步骤

2.1 argparse.ArgumentParser()
2.2 .add_argument()
2.3 .parse_args()
2.4 命令行使用

1.介绍

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

2.步骤

三个步骤：

1、创建一个解析器——创建 ArgumentParser() 对象
2、添加参数——调用 add_argument() 方法添加参数
3、解析参数——使用 parse_args() 解析添加的参数
eg：

import argparse

parser = argparse.ArgumentParser()

#-ep（短参数）是--epochs（长参数）的缩写，指代的是同一个
parser.add_argument('-ep', '--epochs', type=int, default=10 , help = 'please input number')
parser.add_argument('-bs', '--batch_size', type=int, default=32 , help = 'please input number')
parser.add_argument('-lr', '--learning_rate', type=float, default=0.001 , help = 'please input number')

args = parser.parse_args()
print(args.epochs)   -----> 10
print(args.ep)       -----> 报错，执行不了

args2 = parser.parse_args(['-ep',"15"])
print(args2.epochs)  -----> 15
print(args2.ep)       -----> 报错，执行不了

args3 = parser.parse_args(['--epochs',"20"])
print(args3.epochs)  -----> 20
print(arg3.ep)       -----> 报错，执行不了

2.1 argparse.ArgumentParser()

大多数对 ArgumentParser 构造方法的调用都会使用 description= 关键字参数。这个参数简要描述这个程度做什么以及怎么做。在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

2.2 .add_argument()

给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。这些信息在 parse_args() 调用时被存储和使用。

ArgumentParser.add_argument(name or flags...[, 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 - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

这里介绍下action：

parser.add_argument(‘--is_train’, action=’store_true’, default=False)

其中“- -is_train”参数在调用时，如下：

python demo1.py 						#无参数传入时，使用默认值False 
python demo1.py --is_train 		#当使用此参数时，表示该参数是True, 注意在这里并没有对其赋值;其作用是作为开关使用，来控制action动作
#也就是说，action=‘store_true’，只要运行时该变量有传参就将该变量设为True

2.3 .parse_args()

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。
1.py文件写法

args = parser.parse_args()

2.jupyter写法

args = parser.parse_args([]) #不传值情况下
args = parser.parse_args(['--epochs',"20"]) #传值

3.note

import argparse

parser = argparse.ArgumentParser(description = 'TEST')
parser.add_argument ('--start-epoch', default = 0, type = int, help = 'please input number')

def main():
    global args
    args = parser.parse_args()

    print(args)
    print(args.start_epoch)

if __name__ == '__main__':
    main()

在参数解析时，参数中并不区分字符‘-’和‘_’；如上所述，在添加是使用的是’ --start-epoch’，但是在解析时使用的是args.start_epoch

2.4 命令行使用

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)

显示帮助文档：

argparse python 文件 python中argparse_开发语言